Chat now with support
Chat with Support

Directory Sync Pro for Notes 20.13 - User Guide

Matching Advanced Settings

Directory Sync Pro for Notes looks for selected object attributes that you have chosen to match objects between the source and target. This screen allows you to control several Directory Sync Pro for Notes parameters for this process.

Matching Level Method

Choose the scope in which Directory Sync Pro for Notes should search for matching objects. If you choose Forest, Directory Sync Pro for Notes will examine the entire AD forest to match objects. If you choose domain, Directory Sync Pro for Notes will only check for matching objects at the domain level for those domains within the scope of this profile.

Matching Action

This is perhaps the most important parameter on this page. What do you want Directory Sync Pro for Notes to do if it finds a match based on your chosen mapping parameters? The default is Create or Update. This means that if Directory Sync Pro for Notes does not find a match, it will create a new object in the target. If a match is found, Directory Sync Pro for Notes will update the attribute values on the target object using the values from the attributes of the source object.

If you choose Create Only, then Directory Sync Pro for Notes will create a new object in the target for any unmatched objects. It will not update any attributes for those objects that have been matched.

Choose Update Only to update the attributes from source objects to matched target objects. No new objects will be created if a match is not found. A scenario in which you might choose this would be when the users have been pre-created in the target manually, and you just want to keep changes synchronized.

And finally, Match Only, No update (option not available for Exchange Intra-Forest Profiles) will make no changes to any objects. This is only chosen when you are using another product other than Active Directory Pro for AD synchronization. It will import the values that are needed when Active Directory Pro performs the ReACL and Cutover actions.

Matching Object Types

There may be the rare occasion where an object of one type in the source has a matching value for an object of another type in the target. Since these are not the same type, you may want Directory Sync Pro for Notes to be more precise in deciding if an object is a match. Check this box to require the type of object to be a final matching criterion.

For example, suppose CN or Common name is one of your matching criterion. And in the source we have a user with a Common Name of Cheryl in the source. In the target, we have a contact with the Common name of Cheryl. Directory Sync Pro for Notes would normally match these objects because they have the same Common name. If you check this box, it will consider that the object class is not the same, and therefore these objects do not match after all.

Relink Objects

The relink option only comes in to play in the rare occasion that you have reset a profile thereby removing the objects created by this profile from the SQL database. But you did not delete the actual target objects created by Directory Sync Pro for Notes. Without the relink option, when this profile is synced again, Directory Sync Pro for Notes would not recognize the objects that it may have already migrated to the target as created by itself. This could cause unwanted behavior, depending on your Matching Action choices. This may also cause problems if you had chosen the rename option for collisions, as the rename could be appended or prepended twice due to an already existing renamed target object. We suggest that you leave this box checked. This will allow Directory Sync Pro for Notes to look for a special attribute that is populated by Directory Sync Pro for Notes in the target so that it knows that this object was created by Directory Sync Pro for Notes.

Restore Ready-to-Sync

This option works in conjunction with the relink option. If Directory Sync Pro for Notes finds an target object that it had previously created based on the special relink attribute, it will mark the matching source object as Ready to Sync. This means the object will be included and updated during the next sync cycle, as long as Update is part of one of your Matching Action choices. We suggest that you leave this box checked.

Mapped Fields Advanced Settings

The mappings page controls where and how the values of a source attribute should be placed in the target attribute. By default this is a one-to-one mapping, but you can change it. For example, whatever the value is for company name for all objects in the source that have that value will be used to the fill the company name value for all objects that have that attribute in the target. However, you can edit and customize the mappings to fit any special needs.

As an example, suppose that you are doing an inter-forest migration where the target company has acquired the source company. The source company uses the Employee Number field as a unique identifier. However, the target company uses the Employee ID for this same purpose. We can modify the mappings to make this adjustment. First, we will make sure that the Employee ID field in the source does NOT get mapped to the EmployeeID field in the target as we plan to have a different source field mapping to that. We can just empty it out, or we could remove the entire mapping.

Now we will map the Employee Number source field to the employee ID target field. If you need to get more granular, you can specify the source and target object types that this should only occur with. Such as just user target objects. In my example, there is no need because this attribute is only found on user objects anyway.

You can control the number of items included in the window here. You can search for a particular mapping with the search box. You can filter the attributes by object type to narrow your listing.

Click on the advanced button for more options, including the ability to reset everything.

Exceptions Advanced Settings

The exceptions screen allow you to make exceptions to guide Directory Sync Pro for Notes in matching and or mapping particular attributes when you know there is an exception to normal behavior. For example, suppose that a company had pre-created some users in their target Active Directory environment whose attributes are not an exact match for one of Directory Sync Pro for Notes Matching attributes. In the source, we have a user whose sAMAccountName is Fred. They have already made an account in the target for Fred, but the sAMAccountName is Frederick in the target. Directory Sync Pro for Notes would not find a match, and would consider Fred and Frederick to be different users. Directory Sync Pro for Notes would create a new account called Fred in the target, not knowing they were supposed to be the same. You can let Directory Sync Pro for Notes become aware of this by making a manual exception.

Choose the source field, in this case sAMAccountName, and the source value of Fred, the target field will be the same, only the value will be Frederick. Next,choose the exception type, Map Only, Match Only, or Map and Match. In this example, you would choose Match Only, because you want Directory Sync Pro for Notes to consider these mismatched attributes as a match for matching purposes. Choose Map only if you just want to change the value of a particular target attribute based on the specific value of a source attribute. For example, the source company has a department call Information Technology, but they have been acquired by a target company that calls that department Business Technology. Just enter the appropriate values , and choose Map only. You can also do both by choosing Map and Match.

If you have a lot of exceptions, you can create a CSV file and import it on this screen. A sample template file is provided for download.

Overrides Advanced Settings

An override is used to transform data as it is migrated from source to target. If it can be done with a SQL statement, you can make an override to perform the task. A full SQL Select statement is not required as Directory Sync Pro for Notes generates portions of the statement for you. For example, if the target company requires a five digit employee number and the source company has no requirements, you could create an override to add those leading zeros

Click Add Override and then tell Directory Sync Pro for Notes if this override affects people or groups. Choose a valid internal field name that will be transformed by this override. You can see a list on the mapping screen.

For Field value, this is where you would enter a correctly formatted SQL statement.

We recommend that you add a comment to describe this override.

Double click on an override if you need to edit it. You cannot change the View or Field Name of an existing override.

Please use caution as Overrides are global. Once you create an override in a profile, it affects all profiles in Directory Sync Pro for Notes. You can import and export your Overrides, or choose reset overrides to return DirSync to the default profile settings.

See the help topic called Customizing Overrides for more details and more examples.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating