Objects, Fields and Mapping
On the Object, Fields and Mappings page, map the a attributes with source fields.
-
In the Sync Object Options, select an object type that you want to either create or update.
Object types vary depending on the destination provider.
Destination Provider Object Type Description Active Directory User An Active Directory user. Mail-enabled User An Active Directory user with an external e-mail address (requires Exchange 2013 or later). Mailbox-enabled User An Active Directory user with an Exchange mailbox (requires Exchange 2013 or later). Linked Mailbox A mailbox that is accessed by a user in a separate, trusted forest. Linked mailboxes may be necessary for organizations that deploy Exchange in a resource forest. Contact An Active Directory contact. Group An Active Directory group. Members of the group will be synced with, but not created at, the destination. Mail-enabled Contact An Active Directory contact with an external e-mail address (Exchange 2013 or later) Microsoft Entra ID User A Microsoft Entra ID user. Mailbox-enabled User A Microsoft Entra ID user with an external e-mail address (requires Exchange 2013 or later). Group A Microsoft Entra IDgroup. Generic LDAP inetOrgPerson inetOrgPerson is an object class found in standard Lightweight Directory Access Protocol (LDAP) implementations. Google Workspace User A Google Workspace user. Group A Google Workspace group. -
The Add Messaging Provider option is only available with the mail-enabled objects. Click Add Now to select a messaging system you want to use with this job. You need to select from the two options:
-
Configure with Destination Provider
It displays the messaging provider configured in the destination provider.
-
Add New Provider
It displays the following list of new providers that you can use to create a job.
-
Add connection details for Google Workspace.
-
Add Connection details for Office 365.
-
Add connection details for Exchange.
-
Others
Add details for any other provider that is not present in the list.
-
None
Select None if you not want to add any messaging provider.
-
-
-
In the Script Language section, specify the scripting language you want to use. Select one of the following language:
- Visual Basic .NET for GroupID
- Python for GroupID
-
The Global Script Editor allows the script author to extend the functionality of Synchronize by authoring scripts in Visual Basic .NET and Python. Before saving a script, the code must be verified by compiling the script. Click on **Edit Global Script,**and follow these steps:
-
Click on Edit option from the header of the screen to edit the script. You can perform the following action:
Actions Description Go To (Ctrl+G) Opens the Go To Line dialog box for jumping to a specific line in the editor Cut (Ctrl+X) Copies the current text selection to the clipboard and deletes the selection Copy (Ctrl+C) Copies the current text selection to the clipboard while keeping the selection. Paste (Ctrl+V) Inserts the copied or cut text from the clipboard in the workspace. Undo (Ctrl+Z Reverses the last change. Redo (Ctrl+Y Re-applies a change reversed using the Undo action. Insert Datetime Inserts the current date and time in the editor. Insert File As Text Opens the Select a text file dialog box that allows you to select a text file from which to insert text into the editor. -
Use the Tools > Add or remove references to display various components and DLL libraries included in your script.
-
Click Import to import the previously exported script to run the job.
-
To export the script, click Export to save it for future use.
-
You can also click the Plus icon to clear the scripting editor and then copy and paste the attached script in the global scripting editor.
-
To compile the script, click on Build and then click Compile Script.
Synchronize will review the code to determine if there are any errors which would prevent the code from loading or executing. While compiling your script will verify the code is free of syntactical errors, it does not guarantee that the code is free from logical errors. If the code is free of syntactical errors, a message box will appear informing the user that the code has been successfully compiled. In the event of one or more errors, the user can view any problems at the bottom of the screen in the Errors section. Double-clicking on a given error will position the cursor to the location of the error in the script.
-
The toolbar displays various actions that you can perform on your script:
Icon Description Reverses the last change. Re-applies a change reversed using the Undo action. Increases the indenting of the current text selection. Decreases the indenting of the current text selection. Comments the current text selection. Uncomments the current text selection. Converts the current text selection to uppercase. Converts the current text selection to lowercase. Switch the theme of the script editor to dark. Switch the theme of the script editor to light. Selects all the text in the editor. -
Click Save to save the changes made to the script.
-
-
On the Selected Fields for object types type section, click Add/Edit Fields. You can specify the action to take if the data or object being exported from the source does not exist at the destination.
-
Use the Map Field section to map the source and destination fields and to apply transformations:
-
In the Key column, select at least one field to be a unique identifier.
Do one of the following:
-
In the Source column of each destination item, select the source fields that contribute the data for the destination.
-
Apply a Transform
In the Transform column, click the More Options button to open the Transform [ field] dialog box and apply a transformation to the field value before it is saved at the destination.
-
-
If the source or destination field is multi-valued, set a delimiter from the Delimiter list.
This delimiter is used either to separate the values of a multi-valued field at the source, or to merge values of a multi-valued field at the destination, depending on the types of data sources.
-
In the New only column, select the check boxes for fields to be updated only when creating a new object. Fields that are not selected are continually updated. Key fields are selected by default as New Only fields as a requirement; you cannot change this selection.
NOTE: For Microsoft Entra ID objects, primary key fields are:
(1) UserPrincipleName attribute for “User/Mailbox” object
(2) DisplayName attribute for “Group” object. -
Select Show field reference check box to view a list of attributes from the schema of the source provider.
-
Click Next.
-
See Also