Skip to main content

Objects, Fields and Mapping

On the Object, Fields and Mappings page, map the a attributes with source fields.

  1. 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 ProviderObject TypeDescription
    Active DirectoryUserAn Active Directory user.
    Mail-enabled UserAn Active Directory user with an external e-mail address (requires Exchange 2013 or later).
    Mailbox-enabled UserAn Active Directory user with an Exchange mailbox (requires Exchange 2013 or later).
    Linked MailboxA 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.
    ContactAn Active Directory contact.
    GroupAn Active Directory group. Members of the group will be synced with, but not created at, the destination.
    Mail-enabled ContactAn Active Directory contact with an external e-mail address (Exchange 2013 or later)
    Microsoft Entra IDUserA Microsoft Entra ID user.
    Mailbox-enabled UserA Microsoft Entra ID user with an external e-mail address (requires Exchange 2013 or later).
    GroupA Microsoft Entra IDgroup.
    Generic LDAPinetOrgPersoninetOrgPerson is an object class found in standard Lightweight Directory Access Protocol (LDAP) implementations.
    Google WorkspaceUserA Google Workspace user.
    GroupA Google Workspace group.
  2. 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.

  3. In the Script Language section, specify the scripting language you want to use. Select one of the following language:

  4. 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:

    1. Click on Edit option from the header of the screen to edit the script. You can perform the following action:

      ActionsDescription
      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+ZReverses the last change.
      Redo (Ctrl+YRe-applies a change reversed using the Undo action.
      Insert DatetimeInserts the current date and time in the editor.
      Insert File As TextOpens the Select a text file dialog box that allows you to select a text file from which to insert text into the editor.
    2. Use the Tools > Add or remove references to display various components and DLL libraries included in your script.

    3. Click Import to import the previously exported script to run the job.

    4. To export the script, click Export to save it for future use.

    5. 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.

    6. 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.

    7. The toolbar displays various actions that you can perform on your script:

      IconDescription
      undoReverses the last change.
      redoRe-applies a change reversed using the Undo action.
      indentIncreases the indenting of the current text selection.
      outdentDecreases the indenting of the current text selection.
      commentComments the current text selection.
      uncommentUncomments the current text selection.
      uppercaseConverts the current text selection to uppercase.
      lowercaseConverts the current text selection to lowercase.
      darkthemeSwitch the theme of the script editor to dark.
      lightthemeSwitch the theme of the script editor to light.
      selectallSelects all the text in the editor.
    8. Click Save to save the changes made to the script.

  5. 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.

  6. Use the Map Field section to map the source and destination fields and to apply transformations:

    1. In the Key column, select at least one field to be a unique identifier.

      Do one of the following:

      • Map Fields

        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.

    2. 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.

    3. 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.

    4. Select Show field reference check box to view a list of attributes from the schema of the source provider.

    5. Click Next.

See Also