• <GetStart>
  • CSPro User's Guide
    • The CSPro System
    • Data Dictionary Module
    • The CSPro Language
    • Data Entry Module
    • Batch Editing Applications
    • Tabulation Applications
    • Data Sources
    • Synchronization
      • Services
        • Overview
        • Synchronization Connection String
        • CSWeb
        • Bluetooth
        • Dropbox
        • FTP
        • Local Files
        • Syncable Name
      • Messages
    • CSPro Statements and Functions
    • Text Templates
    • Templated Reporting System
    • HTML, Markdown, and JavaScript Integration
    • Action Invoker
    • Appendix
  • <CSEntry>
  • <CSBatch>
  • <CSTab>
  • <DataManager>
  • <TextView>
  • <TblView>
  • <CSFreq>
  • <CSDeploy>
  • <CSPack>
  • <CSDiff>
  • <CSConcat>
  • <Excel2CSPro>
  • <CSExport>
  • <CSIndex>
  • <CSReFmt>
  • <CSSort>
  • <ParadataConcat>
  • <ParadataViewer>
  • <CSCode>
  • <CSDocument>
  • <CSView>
  • <CSWeb>

Syncable Name

Overview
When defined, a dictionary's syncable name overrides its actual name when synchronizing data, sending or receiving cases, from a synchronization service. The dictionary name is associated with different databases or data sets on the synchronization service, and specifying a syncable name allows the same underlying dictionary to be used to access multiple sets of data.
For example, while preparing for a census, you might set the dictionary's syncable name to CENSUS_PILOT_DICT. Data synchronized during the preparation phase would be saved in databases with names based on CENSUS_PILOT_DICT. Prior to census enumeration, the syncable name would be cleared and then data synchronized after that would point would be saved in a database with a name based on the actual dictionary name, CENSUS_DICT.
Another use of syncable names is to separate different rounds of a survey into different databases. For example, you might use syncable names such as AI_USE_DICT_ESWATINI, AI_USE_DICT_LESOTHO, and so on.
Specifying a Syncable Name
There are two ways to specify the syncable name override, which is set on a per-dictionary basis. You can use the dictionary property panel to define a Syncable Name Override. This setting will be used by default in all instances that the dictionary interacts with a synchronization service, including during deployment.
When applicable, such as when using the CSWeb data source, the name can be overridden in the synchronization connection string using the property "dictionaryName". For example:
https://example.org/csweb/api|dictionaryName=AI_USE_DICT_ESWATINI
https://example.org/csweb/api|dictionaryName=AI_USE_DICT_LESOTHO
See also: Synchronization Overview