Chat now with support
Chat with Support

Active Roles 8.1.4 - 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

Gear icon

In the upper right corner of the Synchronization Service Console, you can click the gear icon.

The Gear icon provides the following commands:

  • Configure Sync Service: Starts a wizard that helps you change the configuration settings of the current Synchronization Service instance.

  • Import Configuration: Starts a wizard that helps you to import configuration settings from a configuration file created by another instance of Synchronization Service.

  • Export Configuration: Starts a wizard that helps you to save the configuration profile of the current Synchronization Service instance to a file. You can use this file to apply the saved configuration to other instances of Active Roles Synchronization Service deployed in your environment.

  • Mail Profiles: Allows you to add, edit, or delete mail profiles for sending notification emails about sync workflow runs. For more information on how to use the email notification, see Using sync workflow alerts.

  • Diagnostic Logging: Allows you to specify settings for writing Synchronization Service diagnostic data to the Synchronization Service log file or Windows Event Log.

  • Communication Port: Allows you to change the communication port number used by the Synchronization Service.

  • Configure Azure BackSync: Allows you to configure back synchronization operation in Azure with on-premises Active Directory objects.

Sync Workflows tab

The Sync Workflows tab allows you to manage data sync workflows for connected data systems. A sync workflow can include a number of synchronization steps, each performing a specific data synchronization operation (creation, deprovision, or update). For more information on sync workflows and their steps, see Synchronizing identity data.

You can also use this tab to manage email notification settings for each existing sync workflow. For more information, see Using sync workflow alerts alerts.

On the Sync Workflows tab, you can use the following elements (some of these elements become available only after you create at least one sync workflow with one or more synchronization steps):

  • Add sync workflow: Creates a new sync workflow.

  • Filter by: Allows you to filter existing sync workflows by the letters or text you type in the text box. The filter applies to the sync workflow names.

  • Sort by: Allows you to sort existing sync workflows by workflow name, last run time, or the number of synchronization steps.

  • <Workflow Name>: Represents a sync workflow. You can click the workflow name to view and add, delete, or modify synchronization steps in that workflow.

  • Schedule: Allows you to create a schedule for running the sync workflow.

  • Manage alerts: Allows you to add, delete, or edit alerts for a sync workflow. An alert allows you to automatically send notification emails about the completion of the sync workflow run to specified recipients.

  • Rename: Allows you to rename the sync workflow.

  • Delete: Deletes the sync workflow.

Sync History tab

The Sync History tab allows you to view and selectively clean up the synchronization history. This is the history of sync workflow runs and object mapping operations. For more information, see Synchronization history.

On the Sync History tab, you can use the following elements:

  • Clean up now: Allows you to selectively clean up sync history entries by specifying the age of the entries that you want to clean up.

  • Schedule cleanup: Allows you to schedule a recurring cleanup operation for the sync history.

  • Sync Workflow History: Allows you to view a list of completed sync workflow runs and the details of objects that participated in a particular sync workflow run.

  • Mapping History: Allows you to view a list of completed map and unmap operations and the details of objects that participated in those operations.

  • Search: Allows you to search the Synchronization Service synchronization history for completed creation, deprovision, update, and sync passwords operations. You can search by a number of criteria, such as the target connected data system and object type on which the operation was performed and the time period during which the operation completed.

  • Usage Statistics: Allows you to view usage statistics for each connector i.e. a number of processed objects, sync runs, and so on.

Connections tab

The Connections tab allows you to manage connections between the Synchronization Service and the external data systems you want to use for data synchronization operations.

For more information on creating connections to external data systems supported out of the box, see External data systems supported with built-in connectors.

On the Connections tab, you can use the following elements (some of these elements become available only after you create at least one connection):

  • Add connection: Allows you to create a new connection to an external data system.

  • Filter by: Allows you to filter existing connections by the letters or text you type in the text box. The filter applies to the connection names.

  • Sort by: Allows you to sort existing connections by connection name, name of the connector used, or the frequency of usage in sync workflow steps.

  • <Connection Name>: Represents a connection to an external data system. You can click a connection name to view or modify the corresponding connection settings.

  • Connection settings: Allows you to view or modify settings for the connection.

  • Synchronization scope: Allows you to view or modify synchronization scope for the connection.

  • Delete connection: Deletes the connection.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating