Skip Navigation

Sync operation configuration

This section configures the data synchronizer.
<syncOperations> <hierarchy> <commonNameOfHierarchyToSync>Userbase_Hierarchy_Common_Name</commonNameOfHierarchyToSync> </hierarchy> <user> <allowPartialUpdate>TRUE</allowPartialUpdate> <syncExistingUserOnly>true</syncExistingUserOnly> <usersPerPackage>5000</usersPerPackage> <!—set it to 5000-> </user> <staticlist> <newListDefaultFolder>/folder_of_distribution_list_hierarchy/</newListDefaultFolder> </staticlist> <isFullSync>true</isFullSync> </syncOperations>
In this section, there are two possible subsections, <hierarchy> and <user>, that provide control information for hierarchy synchronization and user synchronization operations.
  • <hierarchy>
    : The <hierarchy> section has only one sub node, <commonNameOfHierarchyToSync>. This sub-node defines the common name of the target hierarchy in the current provider. This common name must be specified in the
    BlackBerry AtHoc
    system before synchronization.
    To find the common name, go to
    Settings
    >
    User Attributes
    and find the Path type attribute in the list. The default attribute is called "Organization Hierarchy" and has a common name of "ORGANIZATION HIERARCHY".
  • <user>
    : The <user> section has the following three sub nodes:
    • <allowPartialUpdate>
      : (Optional) Indicates if the user sync can be performed for partial updates.
    • <syncExistingUserOnly>
      : Indicates if the Web API should synchronize existing
      BlackBerry AtHoc
      users only. If this tag is missing, it defaults to “false”, meaning that all users are synchronized.
    • <usersPerPackage>
      : Because the number of users to be synchronized can be very large, the synchronization module synchronizes users into multiple packages of a web API request. This parameter controls the number of users placed in one package, which depends on the API server’s capacity. If this tag is missing, the number of users defaults to 5000.
  • <staticList>
    : The <staticList> section has the following sub node:
    • <newListDefaultFolder>
      : (Optional) Specifies the hierarchy folder to insert newly created lists into. Defaults to “root”. This is not applicable for .csv.
  • <isFullSync>
    : (Optional) Indicates a full synchronization of distribution lists and distribution list membership. The default value is "true."
    The value "true" is case-sensitive. If "TRUE" or "True" are entered instead of "true," the system treats the value as "false."
If you do not want to synchronize the hierarchy, remove the <hierarchy> section.
To test the configuration, execute only one or two of the three functional parts of the integrator. Remove the configuration section of the unwanted part.