Chat now with support
Chat with Support

Active Roles 8.1.5 - Synchronization Service Administration Guide

Synchronization Service overview Deploying Synchronization Service Deploying Synchronization Service for use with AWS Managed Microsoft AD Getting started Connections to external data systems
External data systems supported with built-in connectors
Working with Active Directory Working with an AD LDS (ADAM) instance Working with Skype for Business Server Working with Oracle Database Working with Oracle Database user accounts Working with Exchange Server Working with Active Roles Working with One Identity Manager Working with a delimited text file Working with Microsoft SQL Server Working with Micro Focus NetIQ Directory Working with Salesforce Working with ServiceNow Working with Oracle Unified Directory Working with an LDAP directory service Working with an OpenLDAP directory service Working with IBM DB2 Working with IBM AS/400 Working with IBM RACF Working with MySQL database Working with an OLE DB-compliant relational database Working with SharePoint Working with Microsoft 365 Working with Microsoft Azure Active Directory Configuring data synchronization with the SCIM Connector Configuring data synchronization with the Generic SCIM Connector
Using connectors installed remotely Creating a connection Renaming a connection Deleting a connection Modifying synchronization scope for a connection Using connection handlers Specifying password synchronization settings for a connection
Synchronizing identity data Mapping objects Automated password synchronization Synchronization history Scenarios of use Developing PowerShell scripts for attribute synchronization rules Using PowerShell script to transform passwords

Creating or editing a sync workflow alert

You can create or edit email-based alerts for existing sync workflows, allowing you to send notifications about key synchronization events, such as completing sync workflow runs or detecting errors.

To create or edit an alert

  1. In the Synchronization Service Console, open the Sync Workflows tab.

  2. Click the Manage alerts link below the sync workflow for which you want to create or edit an alert.

    NOTE: The Manage alerts link is only available on sync workflows that include one or more synchronization steps.

  3. In the Manage Sync Workflow Alerts dialog, do one of the following:

    • If you want to create a new alert, click Add under the Sync workflow alerts list.

    • If you want to edit an existing alert, select that alert in the Sync workflow alerts list, and then click Edit under the list.

  4. To specify alert settings, use the following options in the dialog that opens, and click OK:

    • When this event occurs: Select an event that will trigger the alert. You can select one of the following:

      • Sync workflow run completes (with or without errors): Triggers the alert upon the sync workflow run completion regardless of any errors encountered in the run.

      • Sync workflow run completes with errors: Triggers the alert only when the sync workflow run completed with errors.

    • Send email to: Enter the email addresses of the recipients to which you want to send a notification email message when the selected event occurs. When specifying multiple email addresses, use a semicolon as a separator.

    • Email message subject: Enter the text you want to include in the subject of the notification email.

    • Ignore mapping errors: Select this check box if you want the alert to skip mapping errors in sync workflow runs. This check box is only available when you select Sync workflow run completes with errors in the When this event occurs option.

    • Ignore non-fatal errors in: Select this check box if you want this alert to skip non-fatal errors in sync workflow runs. A non-fatal error causes a sync workflow run to partially succeed. A fatal error causes a sync workflow run to fail. If you select this check box, you must also select one of the following options:

    • All sync workflow steps: Causes the alert to skip non-fatal errors in all steps of the sync workflow.

    • The specified sync workflow steps: Causes the alert to skip non-fatal errors only in the sync workflow steps you specify. To specify multiple steps, either enter the step numbers separated by commas (for example, 1, 3, 5), or specify a range of steps using dash as a separator (for example, 1, 3, 5-8).

      NOTE: This check box is only available if you select Sync workflow run completes with errors in the When this event occurs option.

  5. Use the Send email using this outgoing mail profile list to select the settings to be used for sending notification emails generated by the alerts in the Sync workflow alerts list.

    To configure the current outgoing mail profile, click Properties. For more information, see Managing outgoing mail profiles.

  6. When you are finished, click OK to close the Manage Sync Workflow Alerts dialog.

Deleting a sync workflow alert

You can delete existing sync workflow alerts in the Synchronization Service Console. This is useful for housekeeping purposes, for example when a sync workflow is modified, and its original alarms are no longer applicable.

To delete an alert

  1. In the Synchronization Service Console, open the Sync Workflows tab.

  2. Click the Manage alerts link below the sync workflow for which you want to delete an alert.

    NOTE: The Manage alerts link is only available on sync workflows that include one or more synchronization steps.

  3. In the Sync workflow alerts list, select the alert you want to delete, and then click Delete under the list.

Managing outgoing mail profiles

To create, edit, or delete an outgoing mail profile, in the Synchronization Service Console, click Settings > Mail Profiles in the upper-right corner. Then, follow the appropriate procedure below.

To create a profile

  1. Click Add below the list of profiles, then specify the settings you want to use. For the descriptions of the settings you can specify, see Outgoing mail profile settings.

  2. When you are finished, click OK.

To edit a profile

  1. In the list, select the outgoing mail profile you want to edit.

  2. Click Edit below the list of profiles, then specify the settings you want to use. For the description of the settings you can specify, see Outgoing mail profile settings.

  3. When you are finished, click OK.

To delete a profile

  1. In the list, select the outgoing mail profile you want to delete.

  2. Click the Delete button below the list of profiles.

Outgoing mail profile settings

In each outgoing mail profile, you can use the following settings:

  • Profile name: Enter a descriptive name with which you want to identify the profile.

  • Outgoing SMTP server: Enter the fully qualified domain name of the SMTP mail server you want to use for sending notification emails.

  • This server requires an encrypted connection (SSL): Select this check box if the specified mail server requires an encrypted connection.

  • This server requires authentication: Select this check box if the specified mail server requires authentication, then specify the user name and password with which you want to access the server.

  • Sender email address: Specify the email address you want to use as the originating address in the notification emails.

  • Sender name: Specify the sender name you want to display in the From field to the recipients of the notification emails.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating