Administration Guide

Local Navigation

BlackBerry Manuals & Help  >  Administrator Documentation  >  BlackBerry Enterprise Server Express 5  >  BlackBerry Enterprise Server Express for IBM Lotus Domino  >  Administration Guide BlackBerry Enterprise Server Express for IBM Lotus Domino - 5.0.3

Correcting calendar synchronization errors on devices

If you run corrective calendar synchronization on a BlackBerry® Enterprise Server Express instance, you can find and correct differences between the calendar entries on BlackBerry devices and the calendar entries on users' computers. You can specify a recurring day and time when the process can run and specific days when the process should check for calendar synchronization errors.

You configure corrective calendar synchronization using the BlackBerry Enterprise Trait Tool, which is located in the Tools folder of the BlackBerry Enterprise Server Express installation files.

If corrective calendar synchronization finds differences between the calendar entries on a device and the calendar entries on a computer, the process writes information about the differences to the BlackBerry Messaging Agent log file and, optionally, automatically corrects the calendar synchronization errors that it finds.

It is a best practice to schedule corrective calendar synchronization to occur during low-use periods. For example, you can schedule the process to begin in the early evening, before devices are scheduled to turn off automatically.

Configuration levels using the BlackBerry Enterprise Trait Tool

You can use the BlackBerry® Enterprise Trait Tool to specify whether corrective calendar synchronization checks calendar entries for a specific user, users on a specific BlackBerry® Enterprise Server Express, or all users. The tool uses a hierarchy to determine what calendar entries to check. Settings at the user level override settings at the server level, settings at the server level override settings at the global level, and settings at the global level override the default settings.

Level

Description

-global

The setting that you specify applies to all users.

-server <server_name>

The setting that you specify applies to all users on a specific BlackBerry Enterprise Server Express.

-user <smtp_address>

The setting that you specify applies to a specific user.

Turn on corrective calendar synchronization

By default, corrective calendar synchronization is turned off. You can turn on corrective calendar synchronization to find differences between calendar entries on BlackBerry® devices and calendar entries on users' computers.

  1. Copy the BlackBerry® Enterprise Server Express installation files to a computer that hosts a BlackBerry Enterprise Server Express instance.
  2. Extract the contents to a folder on the computer.
  3. At the command prompt, navigate to the folder that contains the TraitTool.exe file.
  4. Perform one of the following actions:
    • To turn on corrective calendar synchronization for a specific user account, type traittool -user <smtp_address> -trait DominoSmartSyncEnable -set true.
    • To turn on corrective calendar synchronization for all user accounts that are associated with a BlackBerry Enterprise Server Express, type traittool -server <server_name> -trait DominoSmartSyncEnable -set true.
    • To turn on corrective calendar synchronization for all user accounts, type traittool -global -trait DominoSmartSyncEnable -set true.
  5. Press ENTER.

Example: Turning on the process for all users 

 traittool -global -trait DominoSmartSyncEnable -set true
 traittool -user ian.dundas@blackberry.com -trait DominoSmartSyncEnable -set true
After you finish: To turn off corrective calendar synchronization, type traittool -<level> -trait DominoSmartSyncEnable -set false, where <level> is the SMTP address of a specific user account, the server name of a specific BlackBerry Enterprise Server Express for all user accounts that are associated with the specific BlackBerry Enterprise Server Express, or global for all user accounts.

View the current settings for corrective calendar synchronization

  1. Copy the BlackBerry® Enterprise Server Express installation files to a computer that hosts a BlackBerry Enterprise Server Express instance.
  2. Extract the contents to a folder on the computer.
  3. At the command prompt, navigate to the folder that the TraitTool.exe file is located in.
  4. Perform one of the following actions:
    • To view the calendar synchronization settings for a specific user account, type traittool -user <smtp_address> -list.
    • To view the calendar synchronization settings for all user accounts that are associated with a BlackBerry Enterprise Server Express, type traittool -server <server_name> -list.
    • To view the calendar synchronization settings for all user accounts, type traittool -global -list.
  5. Press ENTER.

Example: Viewing the global calendar synchronization settings 

 traittool -global -list

Permit corrective calendar synchronization to correct errors automatically

You can specify whether corrective calendar synchronization adds calendar synchronization errors to the BlackBerry® Messaging Agent log file or adds and corrects calendar synchronization errors. By default, the process adds calendar synchronization errors to the BlackBerry Messaging Agent log file without correcting the errors.
  1. Copy the BlackBerry® Enterprise Server Express installation files to a computer that hosts a BlackBerry Enterprise Server Express instance.
  2. Extract the contents to a folder on the computer.
  3. At the command prompt, navigate to the folder that the TraitTool.exe file is located in.
  4. Perform one of the following actions:
    • To turn on automatic correction of calendar synchronization errors for a specific user account, type traittool -user <smtp_address> -trait DominoSmartSyncSendUpdate -set True.
    • To turn on automatic correction of calendar synchronization errors for all user accounts that are associated with a BlackBerry Enterprise Server Express, type traittool -server <server_name> -trait DominoSmartSyncSendUpdate -set true.
    • To turn on automatic correction of calendar synchronization errors for all user accounts, type traittool -global -trait DominoSmartSyncSendUpdate -set true.
  5. Press ENTER.

Example: Configuring the process to correct calendar synchronization errors for a specific user

 traittool -user ian.dundas@blackberry.com -trait DominoSmartSyncSendUpdate -set true
After you finish: To turn off calendar synchronization error correction, type traittool -<level> -trait DominoSmartSyncSendUpdate -set false, where <level> is the SMTP address of a specific user account, the server name of a specific BlackBerry Enterprise Server Express for all user accounts that are associated with the specific BlackBerry Enterprise Server Express, or global for all user accounts.

Configure the range of days to check for calendar synchronization errors

You can configure corrective calendar synchronization to check for calendar synchronization errors during a specific range of days in the calendar after the current date.
  1. Copy the BlackBerry® Enterprise Server Express installation files to a computer that hosts a BlackBerry Enterprise Server Express instance.
  2. Extract the contents to a folder on the computer.
  3. At the command prompt, navigate to the folder that the TraitTool.exe file is located in.
  4. Perform one of the following actions:
    • To check for calendar synchronization errors during a specific range of days in the calendar for a user account, type traittool -user <smtp_address> -trait DominoSmartSyncDays -set <value>, where <value> is a number from 1 to 365.
    • To check for calendar synchronization errors during a specific range of days in the calendar for all user accounts that are associated with a BlackBerry Enterprise Server Express, type traittool -server <server_name> -trait DominoSmartSyncDays -set <value>, where <value> is a number from 1 to 365.
    • To check for calendar synchronization errors during a specific range of days in the calendar for all user accounts, type traittool –global -trait DominoSmartSyncDays -set <value>, where <value> is a number from 1 to 365.
  5. Press ENTER.

Example: To configure corrective calendar synchronization to check calendar entries for the period of three days from the current date for all users, type:

 traittool -global -trait DominoSmartSyncDays -set 3

Configure when corrective calendar synchronization runs

You can configure corrective calendar synchronization to start running at a specific hour, on recurring days, or on only one recurring day. To specify more than one value for when corrective calendar synchronization runs, after you extract the BlackBerry® Enterprise Server Express installation files to the computer, you can create a list of values that are separated by commas (,) at the command prompt.

  1. Copy the BlackBerry Enterprise Server Express installation files to a computer that hosts a BlackBerry Enterprise Server Express instance.
  2. Extract the contents to a folder on the computer.
  3. At the command prompt, navigate to the folder that the TraitTool.exe file is located in.
  4. Perform one of the following actions:
    • To configure calendar synchronization to occur at a specific hour for a specific user account, type traittool -user <smtp_address> -trait DominoSmartSyncTriggerHour -set <value>, where <value> is a number from 0 to 23, 0 is 12:00 AM, and 23 is 11:00 PM. The default value is 0, which is 12:00 AM.
    • To configure calendar synchronization to occur at a specific hour for all user accounts that are associated with a BlackBerry Enterprise Server Express, type traittool -server <server_name> -trait DominoSmartSyncTriggerHour -set <value>, where <value> is a number from 0 to 23, 0 is 12:00 AM, and 23 is 11:00 PM. The default value is 0 0, which is 12:00 AM.
    • To configure calendar synchronization to occur at a specific hour for all user accounts, type traittool -global -trait DominoSmartSyncTriggerHour -set <value>, where <value> is a number from 0 to 23, 0 is 12:00 AM, and 23 is 11:00 PM. The default value is 0, which is 12:00 AM.
  5. Press ENTER.
  6. Perform one of the following actions:
    • To configure calendar synchronization to recur on specific days for all user accounts, type traittool -global -trait DominoSmartSyncSchedule -set <value>, where <value> is one or more of the following options: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Weekdays, Weekends, or Daily. The default value is Daily.
    • To configure calendar synchronization to recur on specific days for all user accounts that are associated with a BlackBerry Enterprise Server Express, type traittool -server <server_name> -trait DominoSmartSyncSchedule -set <value>, where <value> is one or more of the following options: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Weekdays, Weekends, or Daily. The default value is Daily.
    • To configure calendar synchronization to recur on specific days for a user account, type traittool -user <smtp_address> -trait DominoSmartSyncSchedule -set <value>, where <value> is one or more of the following options: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Weekdays, Weekends, or Daily. The default value is Daily.
  7. Press ENTER.

Example: Configuring corrective calendar synchronization to run at 10:00 PM for all users on the BlackBerry Enterprise Server Express that is named SERVER01

 traittool -server SERVER01 -trait DominoSmartSyncTriggerHour -set 22
 traittool -server SERVER02 -trait DominoSmartSyncTriggerHour -set 23
 traittool -global -trait DominoSmartSyncSchedule -set Weekdays
 traittool -user greg.stark@blackberry.com -trait DominoSmartSyncSchedule -set Monday,Wednesday,Friday

Configure throttling for corrective calendar synchronization

You can throttle corrective calendar synchronization by specifying a period of time, in minutes, that calendar synchronization sessions are randomly distributed in. The time period starts at the time that you specify for the DominoSmartSyncTriggerHour trait.
  1. Copy the BlackBerry® Enterprise Server Express installation files to a computer that hosts a BlackBerry Enterprise Server Express instance.
  2. Extract the contents to a folder on the computer.
  3. At the command prompt, navigate to the folder that the TraitTool.exe file is located in.
  4. Perform one of the following actions:
    • To configure the time period that corrective calendar synchronization sessions are randomly distributed in for a specific user account, type traittool -user <smtp_address> -trait DominoSmartSyncStartWindow -set <value>, where <value> is a number, in minutes, from 20 to 1440. The default value is 60.
    • To configure the time period that corrective calendar synchronization sessions are randomly distributed in for all user accounts that are associated with a BlackBerry Enterprise Server Express, type traittool -server <server_name> -trait DominoSmartSyncStartWindow -set <value>, where <value> is a number, in minutes, from 20 to 1440. The default value is 60.
    • To configure the time period that corrective calendar synchronization sessions are randomly distributed in for all user accounts, type traittool -global -trait DominoSmartSyncStartWindow -set <value>, where <value> is a number, in minutes, from 20 to 1440. The default value is 60.
  5. Press ENTER.

Example: Configuring corrective calendar synchronization to distribute calendar synchronization sessions randomly for all user accounts on a BlackBerry Enterprise Server Express in a two-hour time period

 traittool -server SERVER01 -trait DominoSmartSyncStartWindow -set 120
 traittool -global -trait DominoSmartSyncStartWindow -set 720

Logging information for corrective calendar synchronization

Corrective calendar synchronization writes the following information to the BlackBerry® Messaging Agent log file:

Item

Description

DIF

specifies that a calendar item is different on the BlackBerry device than it is in the email application

MOD

specifies that a calendar item is missing on the device

MON

specifies that a calendar item is missing in the email application

SAM

specifies that a calendar item is the same on the device and in the email application

SmartSyncFireOff

specifies that the calendar synchronization process was initiated using the BlackBerry® Enterprise Trait Tool instead of the standard calendar synchronization process

Delete a setting for corrective calendar synchronization

If you delete a setting for corrective calendar synchronization, the calendar synchronization process uses the setting that you specified at the next highest level of the hierarchy. For example, if you delete a setting at the user level, the process uses the setting that is specified at the server level because the server level is the next highest level. If you do not specify any values, the default value is used.
  1. Copy the BlackBerry® Enterprise Server Express installation files to a computer that hosts a BlackBerry Enterprise Server Express instance.
  2. Extract the contents to a folder on the computer.
  3. At the command prompt, navigate to the folder that the TraitTool.exe file is located in.
  4. Perform one of the following actions:
    • To delete a setting for a specific user account, type traittool -user <smtp_address> -trait <name> -erase, where <name> is the setting you want to delete.
    • To delete a setting for all user accounts that are associated with a BlackBerry Enterprise Server Express, type traittool -server <server_name> -trait <name> -erase, where <name> is the setting you want to delete.
    • To delete a setting for all user accounts, type traittool –global -trait <name> -erase, where <name> is the setting you want to delete.
  5. Press ENTER.

Example: To delete the setting for the hour that corrective calendar synchronization begins on the BlackBerry Enterprise Server Express that is named SERVER01, type:

 traittool -server SERVER01 -trait DominoSmartSyncTriggerHour -erase
Next topic: Start corrective calendar synchronization manually for a user account
Previous topic: Managing calendars

Was this information helpful? Send us your comments.