Chat now with support
Chat with Support

On Demand Migration Current - Active Directory User Guide

Template Options

General Option

Objects General Tab – Local Environment

  • Synchronize SID History –  Directory Sync will migrate SID-History when this option is enabled.

    LightbulbImportant Tip: Refer to the SID History Synchronization Quick Start Guide for additional information on how to migrate SID-History.

  • Allow Mailbox Update - You can configure Directory Sync to update mailbox-enabled target objects via Templates under the Objects and General tab. You should also review the mapping configuration to ensure mail attributes mappings are configured correctly per your project's need to avoid unwanted mail disruption.

  • Default Password for New Users – Define the default password for new users.

    LightbulbImportant Tip: The default password defined should meet the password complexity policy for your target environment.

 

Objects Users Option – Local Environment

  • Create New Users As

    • As-Is: Objects will be created just as they currently exist in the source. If the account was disabled in Active Directory in the source, it will be disabled in Active Directory when created in the target. If the account was enabled in Active Directory in the source, it will be created as enabled in Active Directory in the target.

    • Enabled: Objects will be created as enabled in the target Active Directory.

    • Disabled: Objects will be created as disabled in the target Active Directory.

    • Contact: Objects will be created as contact in the target Active Directory.

    • Skip: Objects will not be created in the target Active Directory.

LightbulbImportant Tip:  Source User’s UserAccountControl(UAC) setting can be synchronized to target as-is via attribute mapping in the template.

  • Update Created Users

    • Enabled: Object changes will be synchronized to the target during delta sync after the users were created by Directory Sync.

    • Disabled: Object changes will not be synchronized to the target during delta sync after the users were created by Directory Sync.

  • Update Matched Users

    • Enabled: Object changes will be synchronized to the target during delta sync after the users were matched by Directory Sync.

    • Disabled: Object changes will not be synchronized to the target during delta sync after the users were matched by Directory Sync.

  • If Target Address Exists

    • Overwrite Once: TargetAddress attribute will only synchronized once during the initial sync.

    • Overwrite Always: TargetAddress attribute will always synchronized during initial and delta sync.

    • Do Not Overwrite: TargetAddress attribute will not be synchronized.

 

Objects Groups Option – Local Environment

  • Create Groups As

    • Distribution Groups: Objects will be created just as Distribution Group in the target Active Directory.

    • Contacts: Objects will be created just as Contacts in the target Active Directory.

    • As-Is: Objects will be created just as they currently exist in the source.

  • Update Created Groups:

    • Enabled: Object changes will be synchronized to the target during delta sync after the groups were created by Directory Sync.

    • Disabled: Object changes will not be synchronized to the target during delta sync after the groups were created by Directory Sync.

  • Update Matched Groups

    • Enabled: Object changes will be synchronized to the target during delta sync after the groups were matched by Directory Sync.

    • Disabled: Object changes will not be synchronized to the target during delta sync after the groups were matched by Directory Sync.

  • Convert Group Options

    • Domain Local Groups

      • Domain Local:  Source Domain Local Groups will be created as Domain Local Groups in the target.

      • Universal:  Source Domain Local Groups will be created as Universal Groups in the target.

      • Skip:  Source Domain Local Groups will not be created.

    • Global Groups

      • Global:  Source Global Groups will be created as Global Groups in the target.

      • Universal:  Source Global Groups will be created as Universal Groups in the target.

      • Skip:  Source Global Groups will not be created.

    • Global Groups

      • Global:  Source Global Groups will be created as Global Groups in the target.

      • Universal:  Source Global Groups will be created as Universal Groups in the target.

      • Skip:  Source Global Groups will not be created.

    • Universal Groups

      • Universal:  Source Universal Groups will be created as Universal Groups in the target.

      • Domain Local:  Source Universal Groups will be created as Domain Local Groups in the target.

      • Skip:  Source Universal Groups will not be created.

 

Objects Contacts Option – Local Environment

  • Create New Contacts As

    • As-Is: Source contacts will be created just as they currently exist in the source.

    • Do Not Create: Source contacts will not be created in the target.

  • Update Created Contacts:

    • Enabled: Object changes will be synchronized to the target during delta sync after the contacts were created by Directory Sync.

    • Disabled: Object changes will not be synchronized to the target during delta sync after the contacts were created by Directory Sync.

  • Update Matched Contacts:

    • Enabled: Object changes will be synchronized to the target during delta sync after the contacts were created by Directory Sync.

    • Disabled: Object changes will not be synchronized to the target during delta sync after the contacts were created by Directory Sync.

 

Objects Devices Option – Local Environment

  • Create New Devices As

    • As-Is: Source devices will be created just as they currently exist in the source.

    • Enabled: Source devices will be created as enabled in the source.

    • Disabled: Source devices will be created as disabled in the source.

    • Do Not Create: Source devices will not be created in the target.

  • Update Created Devices:

    • Enabled: Object changes will be synchronized to the target during delta sync after the devices were created by Directory Sync.

    • Disabled: Object changes will not be synchronized to the target during delta sync after the devices were created by Directory Sync.

  • Update Matched Devices:

    • Enabled: Object changes will be synchronized to the target during delta sync after the devices were created by Directory Sync.

    • Disabled: Object changes will not be synchronized to the target during delta sync after the devices were created by Directory Sync.

 

Cloud Environment Template Options

General Option

 

Objects General Tab – Cloud Environment

  • Allow Mailbox Update - You can configure Directory Sync to update mailbox enabled target objects via Templates under Objects and General tab. You should also review the mapping configuration to ensure mail attributes mappings are configured correctly per your project's need to avoid unwanted mail disruption.

  • Default Password for New Users – Define the default password for new users.

    LightbulbImportant Tip: The default password defined should meet the password complexity policy for your target environment.

 

Objects Users Tab – Cloud Environment

  • Create New Users As

    • As-Is: Objects will be created just as they currently exist in the source.

    • Contact: Objects will be created as contact.

    • Guest User: Objects will be created as a guest user.

    • Guest Invite: Objects will be created as a guest user with invite.

    • Skip: Objects will not be created in the target.

LightbulbImportant Tip:  For additional information related to Guest Objects synchronization, please refer to the Guest User How-To Guide in the help section.  

  • Update Created Users

    • Enabled: Object changes will be synchronized to the target during delta sync after the users were created by Directory Sync.

    • Disabled: Object changes will not be synchronized to the target during delta sync after the users were created by Directory Sync.

  • Update Matched Users

    • Enabled: Object changes will be synchronized to the target during delta sync after the users were matched by Directory Sync.

    • Disabled: Object changes will not be synchronized to the target during delta sync after the users were matched by Directory Sync.

 

Objects Groups Tab – Cloud Environment

  • Create New Users As

    • Office 365 Groups: Objects will be created as Office 365 Groups(Unified Groups) in the target.

    • Distribution Groups: Objects will be created as Distribution Groups.

    • Contacts: Objects will be created as contacts.

    • As-Is: Objects will be created just as they currently exist in the source.

    • Skip: Objects will not be created in the target.

LightbulbImportant Tip: If the source group is a security group, it will be created as security group when As-Is option selected. 

  • Update Created Groups

    • Enabled: Object changes will be synchronized to the target during delta sync after the groups were created by Directory Sync.

    • Disabled: Object changes will not be synchronized to the target during delta sync after the groups were created by Directory Sync.

  • Update Matched Groups

    • Enabled: Object changes will be synchronized to the target during delta sync after the groups were matched by Directory Sync.

    • Disabled: Object changes will not be synchronized to the target during delta sync after the groups were matched by Directory Sync.

 

Objects Teams Tab – Cloud Environment

  • Create Office 365 Groups and Teams As

    • Teams: Objects will be created Teams in the target.

    • As-Is: Objects will be created just as they currently exist in the source.

    • Skip: Objects will not be created in the target.

  • Update Created Office 365 Groups and Teams

    • Enabled: Object changes will be synchronized to the target during delta sync after they were created by Directory Sync.

    • Disabled: Object changes will not be synchronized to the target during delta sync after they were created by Directory Sync.

  • Update Matched Office 365 Groups and Teams

    • Enabled: Object changes will be synchronized to the target during delta sync after they were matched by Directory Sync.

    • Disabled: Object changes will not be synchronized to the target during delta sync after they were matched by Directory Sync.

 

Objects Contacts Tab – Cloud Environment

  • Create New Contacts As

    • As-Is: Source contacts will be created just as they currently exist in the source.

    • Do Not Create: Source contacts will not be created in the target.

  • Update Created Contacts:

    • Enabled: Object changes will be synchronized to the target during delta sync after the contacts were created by Directory Sync.

    • Disabled: Object changes will not be synchronized to the target during delta sync after the contacts were created by Directory Sync.

  • Update Matched Contacts:

    • Enabled: Object changes will be synchronized to the target during delta sync after the contacts were created by Directory Sync.

    • Disabled: Object changes will not be synchronized to the target during delta sync after the contacts were created by Directory Sync.

Advanced Mapping

 

How is the advanced mapping info accessed?  

Click on a mapping and choose the Advanced button. You can then customize the mapping behavior.

 

What are the components of an Advanced Mapping?  

There are several components in an advanced mapping. Please review the advanced mappings guide before making any changes to an existing mapping.

  • The first component is the value. This is single value, or, it could be a formula that will be used to determine the final written value. This can be a combination of functions, text and/or operations to construct the final value.

    There are some default values that already exist. If you do not have experience with advanced mappings, we suggest that you do not change the default values.

  • The condition is a formula that must result in a True statement in order for the attribute to be mapped. It is a qualifier that acts like an on-off switch. If the condition sections is empty, as in this example the switch is On by default.
  • The target attribute is the userprincipal name. The value that will be written, will be calculated by is called a Function. In this case, it is the replacedomain function. This function will take the userprincipal name from the source, and will replace the domain portion with the target domain that is selected in the StageData step of your workflow, referred to as profile, in this function. Please note that some functions are specific to the workflow type, such as local to local.

 

Additional Information  

Reset Mappings

Reset Mappings

How do you reset the mappings?  

You can undo all of any changes that you have made by clicking the advanced button resetting to the default mappings. This is going to set all mappings back to the factory default. Any mappings that you have manually added and any advanced customization that you have made to a particular mapping will be lost. With that in mind, before you choose reset mapping, it would be a best practice to choose export all, to save your customizations to a file. This file contains all current mappings.

 

Additional Information  

Templates

Advanced Mapping

Agents

What is the Directory Sync agent?  

The Directory Sync agent is the key component that communicates between a local Active Directory environment and the Directory Sync service.

 

Where do you install the agent?  

The agent must be installed in every forest that you plan to include as a Directory Sync environment. We suggest that you create a virtual machine exclusively for this purpose. Review the Directory Sync Requirements for the minimal hardware and software requirements.

 

How do I download and install the agent?  

First, choose the environment that the agent will be associated with.

You will be able to download the latest version of the agent from the Directory Sync agent screen. Copy the URL and the access key that will be needed during the install of the agent. The downloadable executable is the same for all projects, it is the Registration URL and Registration Key that makes the agent unique when it is installed.

To install of the agent enter credentials that have read or read\write access to the domain, depending on the direction of synchronization.

Copy and paste the information from the Directory Sync agent screen.

No further action is needed on the workstation. A look at services confirms that the Directory Sync agent is running.

A list of agents appears on summary screen, including status information as well as the registration URL and access keys should you need them again in the future.

Please Note: If using the agent Auto-Upgrade feature and deployment software that uses MSI ProductCode based detection, the Auto-upgrade feature should be disabled after initial deployment or the detection method should verify via a folder path.

 

Where do I manage agents?  

To manage agents, simply open the left navigation menu and click Agents, located under Setup, see figure 1.

Figure 1: Directory Sync Setup and Settings Menu

Figure 1: Directory Sync Setup and Settings Menu

 

How do I manage the agents?  

On the Agents page, you can check the current status of your current agents or add new ones. Select an agent for additional options. You have the option to copy the Registration URL or the Registration Key if you need to reinstall the agent for any reason. The History button will give you details on the run history. When the agent is updated, any agent using the old version will offer you the upgrade option so that you can update your current agent installation.

 

Do I need to configure a Local Directory Sync agent if my tenant is a hybrid with local Active Directory attached?

A Local Directory Sync agent is only required when working with Hybrid MailUsers (a mailuser object synced with a local active directory object). A Directory Sync agent is used to configure the mail-forwarding rule on the local AD object when working with Hybrid MailUsers. A Directory Sync agent is not required when working with Mailbox and Cloud Only Objects as mail-forwarding rules are configured via EXO PowerShell.

 

How do I uninstall an agent?  

If you need to uninstall an agent from any machine, in order to reinstall on the same machine, you must first delete the registry folder located at HKEY_LOCAL_MACHINE> SOFTWARE> Quest > Agent and then uninstall.

Afterwards, simply create a new agent (with a new access key) under Agents managements from the left navigation menu before re-installing on the same machine.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating