Change the performance and configuration settings for the BlackBerry Directory Sync Tool

The BlackBerry Directory Sync Tool retrieves information from Microsoft Active Directory by reading standard property names for group names, email addresses, and user display names. If your organization uses property names that are not standard, you can edit the configuration file to specify the property names.

You can change the performance settings for the BlackBerry Directory Sync Tool if you want to change how the tool completes the synchronization process. It is a best practice to use the default performance settings for the tool. Changing the settings might have a performance impact on your organization's BlackBerry Device Service or Universal Device Service.

  1. On the computer that hosts the BlackBerry Directory Sync Tool, navigate to <drive>:\Program Files\Research In Motion\BlackBerry Resource Kit for BlackBerry Enterprise Service 10\BlackBerry Directory Sync Tool.
  2. In a text editor, open the DirectorySync.exe.config file.
    If your computer's operating system uses UAC and does not permit you to modify the configuration file at this location, open the virtualized copy of the DirectorySync.exe.config file in the application data folder for the current user (for example, <drive>\Users\<user_name>\AppData\Local\VirtualStore\Program Files (x86)\Research In Motion\BlackBerry Resource Kit for BlackBerry Enterprise Service 10).
  3. If your organization uses a property name for group names in Microsoft Active Directory that is not standard, in the <appSettings> section, type <add key="groupNameProperty" value="<group_property_name>"/>, where <group_property_name> is the required property name. The default value is "name".
  4. If your organization uses a property name for email addresses in Microsoft Active Directory that is not standard, in the <appSettings> section, type <add key="emailAddressProperty" value="<email_property_name>"/>, where <email_property_name> is the required property name. The default value is "mail".
  5. If your organization uses a property name for user display names in Microsoft Active Directory that is not standard, in the <appSettings> section, type <add key="displayNameProperty" value="<display_property_name>"/>, where <display_property_name> is the required property name. The default value is "displayName".
  6. To specify the maximum number of changes that you want the tool to synchronize to a group each time you run the tool, in the <appSettings> section, type <add key="maxNumberOfChanges" value="<max_changes>"/>, where <max_changes> is a value greater than zero. The default value is 0 (no limit). When you start the synchronization process, the tool counts the number of changes to be made to a group. If the number of changes exceeds the value that you specified, the tool does not make any changes to the group.
  7. To specify the maximum size of a BlackBerry Enterprise Service 10 group that the tool can synchronize changes to, in the <appSettings> section, change the value of <add key="maxNumberOfUsersInBasGroup" value="<max_users_group>"/>, where <max_users_group> is the maximum number of user accounts in a group. The tool does not synchronize changes to groups with more user accounts than the value that you specify. The default value is 2000.
  8. To specify how long you want the tool to wait before synchronizing each change (for example, assigning a user account to a group), in the <appSettings> section, change the value of <add key="changeDelay" value="<change_delay>"/>, where <change_delay> is a value greater than zero, in seconds. The default value is 1 second.
  9. To specify the maximum level of nested groups that the tool can synchronize, in the <appSettings> section, type <add key="maxNestingLevel" value="<max_nesting_level>"/>, where <max_nesting_level> is a value of 0 or greater. The default value is -1 (no limit).
  10. To specify the maximum number of errors that can occur before the tool stops performing actions, in the <appSettings> section, type <add key="maxNumberOfErrors" value="<max_errors>"/>, where <max_errors> is a value of 0 (no limit) or greater. The default value is 5.
  11. To specify the minimum number of assignments before the tool caches all of the users on a server instead of searching for the users individually, in the <appSettings> section, type <add key="bbUserCacheThreshold" value="<threshold>"/>, where <threshold> is a value of 0 (no cache) or greater. The default value is 100. If you want the tool to perform a large number of synchronization tasks, caching might improve the tool's performance.
  12. To change the level of logging information written to the BlackBerry Directory Sync Tool console, in the <appSettings> section, type <add key="consoleLogLevel" value="<log_level>"/>, where <log_level> is a value between 0 (no logging) and 5 (trace log level).
  13. To change the level of logging information written to the BlackBerry Directory Sync Tool log files, in the <appSettings> section, type <add key="fileLogLevel" value="<log_level>"/>, where <log_level> is a value between 0 (no logging) and 5 (trace log level).
  14. Save and close the DirectorySync.exe.config file.

Example appSettings section

<appSettings>
	<add key="groupNameProperty" value="GroupExample"/>
	<add key="emailAddressProperty" value="EmailExample"/>
	<add key="displayNameProperty" value="DisplayNameExample"/>
	<add key="maxNumberOfChanges" value="1000"/>
	<add key="maxNumberOfUsersInBasGroup" value="1000"/>
	<add key="changeDelay" value="2"/>
	<add key="maxNestingLevel" value="5"/>
	<add key="maxNumberOfErrors" value="10"/>
	<add key="bbUserCacheThreshold" value="150"/>
	<add key="consoleLogLevel" value="5"/>
	<add key="fileLogLevel" value="5"/>
</appSettings>


Was this information helpful? Send us your comments.