Controlling Recipients

This section explains how to add, update, remove, import and export a recipient user, and recipient group.

For background information related to recipients and recipients workspace, see Recipients.

 

Add a Recipient User

  1. In System Browser, select Application View.
  1. Select Applications > Notification > Recipients.
  1. Click Recipients.
  1. Click Edit .
  1. Click Add User .
  1. Configure the parameters in the General, Recipient User Devices, and Group Membership expanders.
  • The recipient user is added and configured.

 

Add a Recipient Group

  1. In System Browser, select Application View.
  1. Select Applications > Notification > Recipients.
  1. Click Recipients.
  1. Click Edit .
  1. Click Add Group .
  1. In the General section, specify the name of the recipient group.
  1. Open the Members expander and click Add to add recipients to the group. You can add maximum 1000 recipients in one recipient group.
  1. Open the Groups Membership expander and click Add.
  • The Groups Membership dialog box displays.
  1. Select the recipients to be associated with the group, and click to move the selected recipients to the text box on the right.
  1. Click OK.
  • The Members list is updated with the selected recipients.
  1. Open the Groups Membership expander and click Add.
  1. In the Groups Membership dialog box, associate a recipient user with the configured recipient groups.
  1. Click OK.
  1. Click Save .
  • The group is created and users are associated with the group.

 

Browse Recipients

  • System Manager is in Operating mode.
  1. In System Browser, select Application View.
  1. Select Applications > Notification > Recipients.
  • All the available individual users and recipient groups display.
  1. Select the Recipients tab and do the following:
    a. Click Filter , and select the user, or groups check boxes, depending on your specific search.
    b. Enter a keyword in the Search field to search a specific recipient.
    NOTE:     Search terms must not contain the word search (even as part of a word) or the _ (underscore) character.
  1. Select the recipient to be viewed.
  • The respective recipients’ details display. Further recipients can be added, updated and removed.

 

Update Recipients

  • The recipient profile to be updated is present in Applications > Notification > Recipients.
  • System Manager is in Operating mode.
  1. In System Browser, select Application View.
  1. Select Applications > Notification > Recipients.
  • A list of all the available recipients displays.
  1. Select the recipient profile to be updated. To narrow the search, do the following:
    a. Click Filter and select the User or Groups check boxes, depending on the search.
    b. Enter a keyword in the Search field to search a specific recipient.
  • The respective recipient details display. However, the Add and Remove buttons remain disabled.
  1. Click Edit to enable the Add and Remove buttons.
  1. Select the General expander and edit the required fields (see Add a recipient user section).
  1. Select the Recipient User Devices expander.
  1. Select a device type and click Edit to modify the information.
  1. Open the Groups Membership expander.
  1. Click Add to introduce a new group or click Remove to remove the existing group membership.
  1. Click Save .
  • The recipient details are updated.

 

Remove Recipients

  • A recipient profile to be removed is available under Applications > Notification > Recipients.
  • System Manager is in Operating mode.
  1. In System Browser, select Application View.
  1. Select Applications > Notification > Recipients.
  • A list of all the available recipients displays.
  1. Select the recipient profile to be removed.
  1. (Optional) To narrow your search, do the following:
    a. Click Filter and select the User or Groups check boxes, depending on the search.
    b. Enter a keyword in the Search field to search for a specific recipient.
  • The respective recipient details display. However, the Add and Remove buttons remain disabled.
  1. Click Edit to enable Add and Remove buttons.
  1. Click Remove .
  • A confirmation dialog box displays.
    NOTE 1: The deleted recipient user cannot be used for new messages and is removed from all existing message templates. However, the users are listed in the active and expired messages for an accurate historical view.
  1. Click Yes.
  • The recipient is deleted.

 

Import Recipients

You can import recipients using either of the following:

Import Recipients from XML

  • System Manager is in Operating mode.
  1. In System Browser, select Application View.
  1. Select Applications > Notification > Recipients.
  • The Recipients tab displays.
  1. Select the Import tab.
  1. Click Recipient import edit to enable import options.
  1. Open the Import from XML expander.
  • The Open dialog box displays.
  1. Click Browse.
  1. Select the location where the XML file is stored.
  1. Select the XML file.
  1. Click Open.
  • The path of the XML file is displayed in the Import file field.
  1. Click Import.
  • The selected XML file is imported.

Import Recipients from XML using Commands

  • System Manager is in Operating mode.
  1. In System Browser, select Application View.
  1. Select Applications > Notification > Recipients.
  • The Recipients tab displays.
  1. Select the Operation tab.
  1. Click Import XML link to enable the import options.
  • The File Path field and Send button display.
  1. In File Path field, enter the local XML file path of the server.
  1. Click Send.
  • The selected XML file is imported.

Import Recipients from CSV

  • System Manager is in Operating mode.
  1. In System Browser, select Application View.
  1. Select Applications > Notification > Recipients.
  • The Recipients tab displays.
  1. Select the Import tab.
  1. Click Recipient import edit to enable import options.
  1. Open the Import from CSV expander.
  • The Open dialog box displays.
  1. Click Browse.
  1. Select the location where the CSV file is stored.
  1. Select the CSV file.
  1. Click Open.
  • The path of the CSV file is displayed in the Import file field.
  1. Select the Delete absent recipients check box to delete the recipients in the Notification application that are not present in the CSV file.
    NOTE 1: Recipients created manually through the recipient UI will never be deleted during CSV import.
    NOTE 2: The mapping name is used as one of the criteria to delete recipient users. Hence, when the user deletes the mapping, a warning message displays.
  1. Click Import.
  • The selected CSV file is imported.

NOTE:
If imported recipient users need to be updateable through subsequent imports, the unique ID property under Notification property should be mapped to a CSV column that contains values that uniquely identify recipient users, like an employee ID.

 

Import Recipients from CSV using Command

  • System Manager is in Operating mode.
  1. In System Browser, select Application View.
  1. Select Applications > Notification > Recipients.
  • The Recipients tab displays.
  1. Select the Operation tab.
  1. Click Import CSV link to enable the import options.
  • The Delete Users, Mapping, File Path fields and Send button display.
  1. Select the appropriate value (Yes or No) from the Delete Users check box.
  1. Enter the mapping to be used for the CSV import in the Mapping field.
  1. In File Path field, enter the local CSV file path of the server.
  1. Click Send.
  • The CSV file specified in the file path is imported.

Import Recipients from Active Directory

  • System Manager is in Operating mode.
  1. In System Browser, select Application View.
  1. Select Applications > Notification > Recipients.
  • The Recipients Editor tab displays.
  1. Select Import tab.
  1. Click Recipient import edit to enable import options.
  1. Open the Import from Active Directory expander.
  1. Enter the Active Directory server's address in the Server field.
  1. Click Connect.
  • The list of the departments available in the corresponding Active Directory displays in the Available departments section.
  1. Select the departments to be imported.
    NOTE: Search for the department by typing in the department’s name in the Search field.
  1. For importing departments, click to move the department to the Departments to import section.
  1. To move departments from the Departments to import section to the Available departments section, and click to move the department to the Available departments section.
  1. Select the Delete absent recipients check box to delete the recipients in the Notification application that are not present in the Active Directory.
    NOTE 1: Recipients created manually through the Recipient UI will never be deleted during Active Directory import.
    NOTE 2: The mapping name is used as one of the criteria to delete recipient users hence when user deletes the mapping, a warning message displays.
  1. Click Import.
  • The selected departments are imported.

NOTE:
If entries imported from the Active Directory match existing entries, details of the corresponding recipient users are updated according to the details specified in the corresponding department of the Active Directory.

Import Recipients from Active Directory using Command

  • System Manager is in Operating mode.
  1. In System Browser, select Application View.
  1. Select Applications > Notification > Recipients.
  • The Recipients Editor tab displays.
  1. Select the Operation tab.
  1. Click Import AD link to enable the import options.
  • The AD Server, Delete Users, Departments, Mapping fields and Send button display.
  1. Enter the Active Directory server address in the AD Server field.
  1. Select the appropriate value (Yes or No) from the Delete Users list to delete recipients from Notification that are not present in the Active Directory.
  1. Enter the department name to import. Multiple department names can be entered by using a comma separator.
  1. Enter the mapping to be used for the Active Directory import in the Mapping field.
  1. Click Send.
  • The selected departments are imported.

 

Export Recipients

You can export recipients using either of the following methods:

Export Recipients to XML

  • System Manager is in Operating mode.
  1. In System Browser, select Application View.
  1. Select Applications > Notification > Recipients.
  • The Recipients Editor tab displays.
  1. Select the Export tab.
  1. Click Recipient export edit to enable export options.
  1. Expand the Export to XML section and select the recipients to be exported and click to move the selection to the Selected for export text box.
  1. Click Export.
  • The Save dialog box displays.
  1. Select the location where the XML file must be saved.
  1. Enter a File Name and click Save.
  • The recipients are exported in XML format.

Export Recipients to XML using Command

  • System Manager is in Operating mode.
  1. In System Browser, select Application View.
  1. Select Applications > Notification > Recipients.
  • The Recipients tab displays.
  1. Select the Extended Operation tab.
  1. Click Export XML link to enable the export options.
  • The File Path field and Send button display.
  1. In File Path field, enter the local file path of the server where the XML file must be saved.
  1. Click Send.
  • The recipients are exported to the XML file specified in the file path.

Export Recipients to CSV

  • System Manager is in Operating mode.
  1. In System Browser, select Application View.
  1. Select Applications > Notification > Recipients.
  • The Recipients Editor tab displays.
  1. Select the Export tab.
  1. Click Recipient export edit to enable export options.
  1. In the Export to CSV expander, do the following:
    a. Select the recipients to be exported.
    b. Click to move the selection to the Selected for export text box.
  1. Select a mapping configuration if present or create a mapping configuration. For more information, see Configuring Mappings for CSV Export in Configure Mappings from Controlling Recipients section.
  1. Click Export.
  • The Save dialog box displays.
  1. Select the location where the CSV file must be saved.
  1. Enter a file name and click Save.
  • The recipients are exported in CSV format.

Export Recipients to CSV using Command

  • System Manager is in Operating mode.
  1. In System Browser, select Application View.
  1. Select Applications > Notification > Recipients.
  • The Recipients Editor tab displays.
  1. Select the Extended Operation tab.
  1. Click Export CSV link to enable the export options.
  • The Mapping, File Path field and Send button display.
  1. Enter the mapping to be used for the CSV export in the Mapping field.
  1. In File Path field, enter the local file path of the server where the CSV file must be saved.
  1. Click Send.
  • The recipients are exported in CSV format.

 

Configure Mappings

You can configure mappings for importing or exporting CSV files or for an active directory import.

Create a New Import Mapping

  1. Click New.
  • The Create mapping as dialog box displays.
  1. Enter a name for the mapping in the Create mapping as dialog box.
  1. Click OK.
  • The Mapping field is populated with the name specified for the mapping.
  1. Select the Header row check box if the user wants to specify a title for the CSV file.
  1. Select a separator from the Delimiter drop-down list.
  1. In the Columns section, map a CSV column with a notification property.
  1. For mapping, select a CSV column option from the CSV Column drop-down list and select a notification property for the corresponding CSV column option from the Notification Property drop-down list. For example, Column 1(A) of CSV Column can be mapped to First Name of the Notification Property. Correlate the alphabet A from the mapping column with the Microsoft Excel column header A, if Microsoft Excel is used to view the CSV file.
  1. Assign an individual recipient to recipient group by selecting the appropriate CSV column from the CSV Column drop-down list and mapping it to the recipient group from the Notification Property drop-down list.

NOTE 1:
The recipient group to be used during import of CSV file must be first created in the Notification application.
NOTE 2:
The individual recipient will not be assigned to the recipient group if the corresponding value in the CSV is either of the given values—
"", " ", "0", "NO", or "FALSE"
For values other than those mentioned above, the individual recipient will be assigned to the recipient group.
NOTE 3:
To edit an existing mapping, select the mapping, perform the required edits and click Save. To save the mapping with a new name, click Save As and provide a new name for the mapping.

  1. Select a quotation type from the Quotations drop-down list.
  1. Click Save.
  • The mapping is configured and can be saved for future use.

Configure Mappings for an Active Directory Import

  1. Click New.
  1. In the Create mapping as dialog box that displays, enter a name for the mapping.
  1. Click OK.
  • The Mapping field is populated with the name specified for the mapping.
  1. In the Columns section, map an Active Directory Property with a Notification Property.
  1. Select an Active Directory Property from the drop-down list or enter manually in the Active Directory Property field.
    For example, First name of the Active Directory Property can be mapped to First Name of Notification Property.
    NOTE:     Each Active Directory property has a real name and a display name, for example, givenName is the real name of an Active Directory property with display name as First name. The properties listed in the Active Directory Property drop-down list are the display names of the real Active Directory properties. You can enter the real name of the Active Directory Property by checking for its corresponding display name. For example, a tool called Remote Server Administration Tools for Windows 7 shows the real Active Directory property name and its display name to be used.
  1. Click Save.
    NOTE: An error message displays if there are invalid entries in the Active Directory properties mapping. In such scenarios, click OK. Rectify the error and click Save again.
  • The mapping is configured.
  1. To edit an existing mapping, do the following.
    a. Select the mapping from the Mapping drop-down list.
    b. Edit the required fields.
    c. Click Save.
  • The mapping is updated.

Configure Mappings for CSV Export

  1. Click New.
  • The Create mapping as dialog box displays.
  1. Enter a name for the mapping and click OK.
  • The name is displayed under Mapping.
  1. Select the Header row check box if the exported CSV file must contain a header row.
  1. Select a separator from the Delimiter drop-down list.
  1. In the Columns section, to map a Notification Property with a CSV Column. Do the following:
    a. From the Notification Property drop-down list, select a notification property.
    b. In the CSV Column drop-down list, enter a CSV column option for the corresponding notification property.
  1. From the Quotations drop-down list, select a quotation type.
  1. Click Save.
  • The mapping configuration is saved.