How to use the BlackBerry Calendar Synchronization Tool (Traittool.exe)

Article ID: KB18548

Type: Support Content

Last Modified: 10-06-2011

 

Product(s) Affected:

  • BlackBerry® Enterprise Server for Microsoft® Exchange
Jump to: Overview | Environment
CollapseOverview

For BlackBerry Enterprise Server 4.1. SP6 and 5.0

How to enable the TraitTool for a single BlackBerry® smartphone user and verify the process was started and completed successfully:

TraitTool -user user01@example.com -trait SmartSyncEnable -set true
TraitTool -user user01@example.com -trait SmartSyncSchedule -set Daily
TraitTool -user user01@example.com -trait SmartSyncDays -set 30
TraitTool -user user01@example.com -trait SmartSyncTriggerHour -set 23
TraitTool -user user01@example.com -trait SmartSyncSendUpdate -set true

Note: If SmartSyncSendUpdateis set to false, the SmartSync will run in report only mode and not make any changes to the user's calendar.

Verify that settings are enabled:

TraitTool -user user01@example.com -list

To disable the TraitTool running globally, run the following command:

TraitTool -global -trait SmartSyncEnable -set false

Note: This will not disable the TraitTool for users who have been enabled individually.

For BlackBerry Enterprise Server 4.1. SP7, 5.0. SP1,  5.0 SP2 and 5.0 SP3

How to enable the TraitTool for a single user and verify the process was started and completed successfully:

TraitTool -user user01@example.com -trait ExchangeSmartSyncEnable -set true
TraitTool -user user01@example.com -trait ExchangeSmartSyncSchedule -set Daily
TraitTool -user user01@example.com -trait ExchangeSmartSyncDays -set 30
TraitTool -user user01@example.com -trait ExchangeSmartSyncTriggerHour -set 23
TraitTool -user user01@example.com -trait ExchangeSmartSyncSendUpdate -set true

To verify that the settings are enabled:

TraitTool -user user01@example.com -list

To disable the TraitTool running globally, run the following command:

TraitTool -global -trait ExchangeSmartSyncEnable -set false

Note: This will not disable the TraitTool for users who have been enabled individually


The following BlackBerry® Enterprise Server log files go over the expected results for a SmartSync of a user. Some of the log lines require level 15 logging to be enabled of the messaging agent.

[40000] (06/25 05:07:33.254):{0x1D20} mailto:%7Buser01@example.com%7D-UserControl::SlowSyncProcessCONFIG_UPDATE-Entering Old Sync State=0xb
[40000] (06/25 05:07:33.254):{0x1D20} mailto:%7Buser01@example.com%7D-UserControl::SlowSyncSaveSyncState-Entering
[40000] (06/25 05:07:33.254):{0x1D20} mailto:%7Buser01@example.com%7D-UserControl::SlowSyncSaveSyncState-Old state=b New state=b Reset=False
[40000] (06/25 05:07:33.254):{0x1D20} mailto:%7Buser01@example.com%7D-UserControl::SlowSyncSaveSyncState-Exits-Saved SyncState=0xb ACK return=Ok
[40000] (06/25 05:07:33.254):{0x1D20} mailto:%7Buser01@example.com%7D-UserControl::SlowSyncsendCICAL_CONFIG_ACK-Entering- ACK Result=0
[40000] (06/25 05:07:33.254):{0x1D20} mailto:%7Buser01@example.com%7D-UserControl::SlowSyncsendCICAL_CONFIG_ACK-Exits-result=OK
[40000] (06/25 05:07:33.254):{0x1D20} mailto:%7Buser01@example.com%7D-UserControl::SlowSyncProcessCONFIG_UPDATE-Exits - result=OK
[40000] (06/25 05:07:33.910):{0x1B10} mailto:%7Buser01@example.com%7D-UserControl::ProcessSLOW_SYNC-Entering
[150000] (06/25 05:07:33.926):{0x1B10} mailto:%7Buser01@example.com%7D-UserControl::SlowSyncFlushOutstandingCalMsgs-Entering
[150000] (06/25 05:07:33.926):{0x1B10} mailto:%7Buser01@example.com%7D-UserControl::SlowSyncFlushOutstandingCalMsgs-Exists Flushed Num outstanding Calendar=0
[40000] (06/25 05:08:01.988):{0x1B10} mailto:%7Buser01@example.com} UserControl::ProcessSLOW_SYNC - SmartSync Mode - Calendar entries on device and desktop are identical

Alternatively, if the TraitTool finds changes, they will be listed as follows (Level 15 Messaging Agent logging will provide additional details about the changes):

[40000] (06/25 00:18:25.615):{0x358} mailto:%7Buser02@example.com} UserControl::ProcessSLOW_SYNC - SmartSync Mode - Requesting 0 from device, sending 9 to device

[40000] (06/25 05:08:01.988):{0x1B10} mailto:%7Buser01@example.com} Sending CICAL_SLOW_SYNC_REQUEST_EVENTS with zero record count to device. SessionId=1245920837
[150000] (06/25 05:08:01.988):{0x1B10} mailto:%7Buser01@example.com%7D-UserControl::SlowSyncSendCAL_SLOW_SYNC_DONE-Entering
[150000] (06/25 05:08:01.988):{0x1B10} mailto:%7Buser01@example.com%7D-UserControl::SlowSyncSendCAL_SLOW_SYNC_DONE-Exits-result=OK
[40000] (06/25 05:08:01.988):{0x1B10} mailto:%7Buser01@example.com%7D-UserControl::SlowSyncComplete-Entering SessID=4a433e45
[40000] (06/25 05:08:01.988):{0x1B10} mailto:%7Buser01@example.com%7D-UserControl::SlowSyncComplete-Exits result=OK
[40000] (06/25 05:08:01.988):{0x1B10} mailto:%7Buser01@example.com%7D-UserControl::ProcessSLOW_SYNC-Complete Slow Sync-Purge received records
[40000] (06/25 05:08:01.988):{0x1B10} mailto:%7Buser01@example.com%7D-UserControl::ProcessSLOW_SYNC-Exits-bSuccess=OK

Note: Regardless of when the TraitTool is scheduled to run, it will not run on the user until they are reported as being in coverage. If the TraitTool is delayed by multiple hours, the log line immediately preceding the start of the SmartSync would be as follows:

[40913] (06/25 05:07:28.269):{0xC78} mailto:%7Buser01@example.com} Device 209545DD state: in coverage

CollapseEnvironment
  • BlackBerry® Enterprise Server 4.1 SP6 to 5.0 SP3 for Microsoft® Exchange

Disclaimer

By downloading, accessing or otherwise using the Knowledge Base documents you agree:

   (a) that the terms of use for the documents found at www.blackberry.com/legal/knowledgebase apply to your use or reference to these documents; and

   (b) not to copy, distribute, disclose or reproduce, in full or in part any of the documents without the express written consent of RIM.


Visit the BlackBerry Technical Solution Center at www.blackberry.com/btsc.