Chat now with support
Chat with Support

Quick Connect Sync Engine 5.5 - Administrator Guide

One Identity Quick Connect Overview Deploying One Identity Quick Connect Sync Engine Getting started Connections to external data systems Synchronizing identity data Mapping objects Automated password synchronization Synchronization history Scenarios of use Appendices

Step 1: Create mapping pairs

Mapping objects > Steps to map objects > Step 1: Create mapping pairs

In this step, you create mapping pairs that specify the types of objects you want to map in two connected systems. You can create as many mapping pairs as necessary.

To create a mapping pair

  1. In the Quick Connect Administration Console, open the Mapping tab.
  2. Click the name of the connection for which you want to map objects.
  3. Click Add mapping pair.
  4. On the Specify source page, next to Connected system object type, click Select, and then select the type of object you want to map.
  5. Click Next.
  6. On the Specify target page, do the following:
    1. Next to Target connected system, click Specify, and then specify the other connected system where you want to map objects.
    2. Next to Connected system object type, click Select, and then select the type of object you want to map.
  7. Click Finish to create the mapping pair.

Repeat the above steps to create mapping pairs for as many object types as necessary.

Step 2: Create mapping rules

Mapping objects > Steps to map objects > Step 2: Create mapping rules

Once you have created a mapping pair, you can configure mapping rules for that pair. Mapping rules define the conditions where the objects that belong to the object types specified in the mapping pair will be mapped. One Identity Quick Connect Sync Engine maps objects only if all mapping rules specified for a mapping pair are met.

To add a new mapping rule

  1. In the Quick Connect Administration Console, open the Mapping tab.
  2. Click the name of the connection for which you want to create a mapping rule.
  3. Click the mapping pair for which you want to create a mapping rule.
  4. Click Add mapping rule.
  5. Use the Define Mapping Rule dialog box to define the condition where the objects in the connected systems are to be mapped. To do so, click the down arrow on the button next to each of the two provided options and select one of the following:
    • Attribute. Allows you to select an attribute in the connected system.
    • Rule. Allows you to set up a list of rules to generate a value for the connected system. For details, see Using value generation rules.
    • PowerShell Script. Allows you to type a Windows PowerShell script that generates a value for the connected system.
  6. When you are finished, click OK to create the mapping rule.

Step 3 (optional): Change scope for mapping rules

Mapping objects > Steps to map objects > Step 3 (optional): Change scope for mapping rules

Each mapping rule applies to a scope of objects. By default, this scope includes all objects that belong to the object types specified in the mapping rule. If necessary, you can narrow the scope specified for a particular mapping rule or you can revert to the default scope.

To change the scope of a mapping rule

  1. Go to the mapping pair that includes the mapping rule whose scope you want to change:
    1. In the Quick Connect Administration Console, open the Mapping tab.
    2. Click the name of the appropriate connection.
    3. Click the appropriate mapping pair entry.
  2. Locate the mapping rule whose scope you want to change. Use the following elements provided for each mapping rule entry:
    1. Mapping scope for system 1. Shows the mapping rule scope applicable to the data system shown on the left part of the mapping pair entry.
    2. Mapping scope for system 2. Shows the mapping rule scope applicable to the data system shown on the right part of the mapping pair entry.

    These elements can take one of the following values:

    1. Default. Indicates that the mapping rule applies to all objects of the specified type.
    2. Custom. Indicates that the mapping rule scope is narrowed down and only applies to some objects of the specified type.

  3. Change the mapping rule scope as necessary:
    1. Click the value displayed next to Mapping scope for system 1 or Mapping scope for system 2, and then specify the scope you want to use.
    2. When you are finished, click OK.

Step 4: Run map operation

Mapping objects > Steps to map objects > Step 4: Run map operation

Once you have created mapping rules for a mapping pair, you need to run the map operation in order to apply these rules and map objects that belong to the mapping pair. There are two methods to run the map operation: you can manually run the map operation once or you can create a recurring schedule to automatically run the map operation on a regular basis.

The latter method is recommended when you want to use Quick Connect to synchronize passwords from an Active Directory domain to other connected systems.

Running mapping rules on a recurring schedule allows you to properly map newly-created Active Directory user objects to their counterparts in the connected systems where you automatically synchronize passwords with the Active Directory domain. If you do not run mapping rules on a regular basis, some passwords may become out of sync because of the changes that inevitably occur to your environment.

For example, new user objects are created, some user objects are deleted, but Quick Connect cannot detect these changes and synchronize passwords for the newly-created users before you apply the mapping rules. In this scenario, the best way to ensure Quick Connect synchronizes all passwords is to apply your mapping rules on a regular basis. You can accomplish this task by creating a recurring schedule for applying your mapping rules.

To run the map operation once

  1. In the Quick Connect Administration Console, open the Mapping tab.
  2. Click the name of the connection for which you want to run the map operation.
  3. Click the mapping pair for which you want to run the map operation.
  4. Click Map now.
  5. In the dialog box that opens, click one of the following:
    • Full Map. With this option, One Identity Quick Connect Sync Engine retrieves the data required to map objects from the connected data systems.
    • Quick Map. With this option, One Identity Quick Connect Sync Engine first tries to map objects by using the data that is available in the local cache. If the local cache is missing or cannot be used to map objects, then One Identity Quick Connect Sync Engine retrieves the required data from the connected data systems.

    Wait for the map operation to complete.

    After the map operation completes, the Quick Connect Administration Console displays a report that provides information about the objects that participated in the map operation. At this stage, the application does not map the objects. To map the objects, you need to commit the map operation result.

    You can click the number that is provided next to an object category name in the report to view the details of objects that belong to that category.

  6. Review the report about the objects that participated in the map operation, and then click Commit to map the objects.

To automatically run the map operation on a recurring schedule

  1. In the Quick Connect Administration Console, open the Mapping tab.
  2. Click the name of the connection for which you want to create a recurring mapping schedule.
  3. Click the mapping pair for which you want to run the map operation on a recurring schedule.
  4. Click Schedule mapping.
  5. In the dialog box that opens, select the Schedule the task to run check box, and then specify a schedule for the map operation.

    It is recommended to schedule the map operation to run once in every 6 hours.

  6. If several One Identity Quick Connect Sync Engine instances are installed in your environment, under Run the task on, select the computer that hosts the instance you want to use for running the map operation.
  7. Click OK to activate the schedule.

    The results of a scheduled map operation always apply automatically, you do not need to commit the changes.

    When performing a scheduled map operation, One Identity Quick Connect Sync Engine always retrieves the required data from the connected data systems and never uses the data available in the local cache.

Related Documents