Chat now with support
Chat with Support

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

Deprovisioning datasets

To deprovision datasets

  1. Navigate to the Workflows tab and select IBM RACF Datasets.

  2. Click Add synchronization step.

  3. Click Deprovision and then click Next.

  4. From the Source connected system section and click Specify.

  5. Select your Microsoft SQL Server Connector and click Finish.

  6. Select Source object is deleted or is out of synchronization scope option in the Deprovision target objects if section.

  7. Optionally, configure the Source object meets the following criteria.

  8. Click Next.

  9. In the Target connected system field, click Specify and then locate your IBM RACF connector and click Finish.

  10. The object type in the Target object system field is populated automatically by Synchronization Service to racfDataset.

  11. Click Next.

  12. Select Delete target object.

  13. Click Finish to complete the synchronization.

Working with TSO command

The IBM RACF connector can be used to run any command in the Time Sharing Option (TSO) environment on the target IBM mainframe. The LDAPX exit must be installed and configured for this functionality to be supported.

The TSO command is run using an Active Roles Synchronization Service synchronization step to create an object of type ldapxtsocmd on the target IBM RACF system and supplying the name of the TSO command or script to be run in the attribute racfprogrammername. When the step is run, the IBM RACF connector intercepts the create command and instead sends an LDAP search command with the required parameters via the LDAP protocol.

The LDAPX exit intercepts this request, extracts the TSO command information and runs the command. The LDAP response is constructed, containing the results obtained from running the command. The IBM RACF connector receives this LDAP response, extracts the results and saves them in a text file that can be examined later.

No object is created during the synchronization step so it can be run indefinitely, each time executing the TSO command stored in the racfprogrammername attribute from the same or any other synchronization step.

The following example shows a method of issuing a TSO command using synchronisation from Active Directory (AD).

  1. Using Active Directory Users and Computers, create a container in AD that can be filtered on by the ARSS. For example, create an organisational unit container called TSO Commands.

  2. Create a dummy computer object within this container with name TSOCMD and description field set to the string STATUS. The TSO command STATUS will return the current system status.

  3. Create a workflow called Run TSO Command.

  4. Within this workflow, create a synchronization step item as follows:

    1. Synchronization step type: Create

    2. Source object: Active Directory, specified container as created above, name starts with TSOCMD.

    3. Target connector: IBM RACF

    4. Object type: ldapxtsocmd

    5. Mapping: from AD Description attribute to IBM RACF racfprogrammername attribute

  5. Save the step.

  6. Run the synchronization step. There should be one item to be created with the following properties:

    • objecttype: ldapxtsocmd

    • racfprogrammername: STATUS

  7. Perform the synchronization step.

  8. The LDAP command will be sent and interpreted by the LDAPX exit to run the TSO command.

  9. Once complete, the synchronization step will show as being successful.

  10. The output from running the command can be found in the following text file:

    <ARSS installation folder>\SyncService\TSOCommandOutput\YYDDMM.txt, where, YYMMDD represents the date when the command was run.

  11. The text file will contain the output returned from IBM RACF having run the STATUS command.

  12. Multiple commands run on the same day will have their output appended to the same daily text file.

Working with MySQL database

This section describes how to create or modify a connection to a MySQL database so that Synchronization Service could work with data in that data system.

To create a MySQL database connection, use the MySQL Connector of the Active Roles Synchronization Service.

The MySQL Connector supports the following features:

Table 53: MySQL Connector – Supported features



Bidirectional synchronization

Specifies whether you can both read and write data in the connected data system.


Delta processing mode

Specifies whether the connection can process only the data that has changed in the connected data system since the last synchronization operation. This reduces the overall synchronization duration.


Password synchronization

Specifies whether you can synchronize user passwords from an Active Directory (AD) domain to the connected data system.


Creating a MySQL database connection

You can create a new MySQL database connection in theSynchronization Service Console.


Before configuring the connector, make sure that the Connector/NET fully-managed ADO.NET driver is installed on the machine running the Synchronization Service.

To create a new connection

  1. In the Synchronization Service Console, open the Connections tab.
  2. Click Add connection, then use the following options:
    • Connection name: Type a descriptive name for the connection.
    • Use the specified connector: Select MySQL Connector.

  3. Click Next.

  4. On the Specify connection settings page, use the following options:
    • MySQL server: Type the fully qualified domain name of the MySQL server that hosts the MySQL database that you want to participate in data synchronization operations.

    • Access MySQL server using: Type the user name and password of the account with which you want to access MySQL server. Ensure the account has sufficient permissions to perform operations (Read, Write) on objects in the database to which you want to connect.

    • Connect to database: Type the name of the database to which you want to connect on the MySQL server.

    • Advanced: Click this button to specify additional parameters you want to add to the connection string that will be used to access the MySQL server. In the dialog box that opens, click the Add Parameter button to specify the name and value of the parameter you want to add to the connection string.

    • To test the connection with the new parameters, click Test connection.
  5. Click Next.

  6. On the Specify how to select and modify data page, use the following options:

    • Use data from this table: Allows you to select a database table that includes the data you want to participate in the synchronization operations. You can click Preview to preview the database table you have selected.

    • Use an SQL query to specify data: Allows you to compose an SQL query that provides a more flexible way for specifying the data for synchronization. For example, you can use this option to specify multiple database tables.

    • Configure Settings: Click this button to specify settings for modifying data in the connected system during synchronization operations. For example, you can specify the database tables in which you want to insert, update, or delete data during synchronization operations.
  7. Click Next.

  8. On the Specify attributes to identify objects page, use the following options:
    • Available attributes: Lists the attributes that are available in the external data system. Use this list to select the attributes whose values you want to use to generate a unique identifier for each object in the external data system. You can filter attributes by typing in the text box at the top of this list. To select multiple attributes, hold down CTRL and click to select attributes in the list.

    • UniqueID attributes: Lists the attributes whose values are currently used to generate a unique identifier for each object in the external data system.

    • Add->: Moves the selected attributes from the Available attributes list to the UniqueID attributes list.

    • <-Remove: Moves the selected attributes from the UniqueID attributes list to the Available attributes list.

    • Constructed UniqueID: Displays a combination of the attributes whose values will make up a unique identifier for each object in the external data system.

  9. To complete the configuration of the MySQL database connection, click Finish.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating