Data Sync Tool datasource set up
Data Sync is purposely built to import data from outside systems into Blue. Manage which datasources are imported to Blue within the Datasources area of Data Sync.
Any change to the structure of a datasource (i.e. adding a field, removing a field, changing the data type of a field) in Blue must be synced in Blue at least once for the Data Sync tool to recognize the new schema. If the schema changes are not synced in Blue, the Data Sync tool import will fail.
Currently Data Sync can import data to the following datasource types:
- Object
- User
- Relationship
- Field Filter
- Hierarchy
Add Datasources
Follow these steps to add a datasource to the Data Sync tool:
- Navigate to Datasources.
- Click Add Datasources. A list of datasources will appear in a drop-down.
- Click Add to connect include a datasource in Data Sync.
- Add additional datasources as necessary.
Datasource Info
Datasource Info is a static page that displays basic information about the datasource. View the name, description and datasource type retrieved from the Blue database. It is also possible to remove a datasource from Data Sync by clicking Remove Datasource.
Datasource Data
Connect an external datasource with a Blue datasource, create field mappings, setup automatic import schedules and perform manual synchronizations. Connections, field mappings, and sync settings are automatically saved by Data Sync.
Data Blocks
The list of data blocks is displayed. Each data block has it's own connection information that must be configured and connected before the datasource can be imported. To configure the data block connection details click the edit icon beside the data block.
Establish the Datasource Connection
Follow these steps to establish a connection between an external datasource and a Blue datasource.
Mapped network drives are not supported when importing a datasource from a CSV or XLS file. The direct network path to the CSV or XLS file must be provided.
- Navigate to Datasources.
- Select one of the datasources that has been added to Data Sync.
- Navigate to Data for the selected datasource.
- Click Connection to display the connection settings.
- Select the Connection Type from drop-down list. The connection information will change depending on the datasource Connection Type selected.
- Fill out the necessary connection information.
- Click Connect. If the connection is successful, the Field Mapping will open, otherwise an error notification will appear.
To increase the speed of data imports, the attribute,
Map the Fields in Field Mapping
Follow these steps to set the field mappings for a datasource.
- Navigate to Datasources.
- Select one of the datasources that has been added to the Data Sync tool.
- Navigate to Data for the selected datasource.
- Establish a connection between the external datasource and the Blue datasource. Field Mapping will automatically display if the connection is successful.
- Map the fields in the external datasource to the appropriate field in the Blue datasource. Fields in the external datasource that are named identically to fields in the Blue datasource will be automatically mapped.
- Click Apply Field Mapping when finished. Sync Settings will open if the field mapping was successful, otherwise an error will appear.
Set the Sync Settings
Sync Settings contain a number of datasource import options which are identical to the Datasources - Import/Export - Importing options in the Blue Administration Console.
Remote Sync Settings
Remote sync settings are downloaded from Blue and provide only information about how the datasource is configured on the server. These settings cannot be changed from the Data Sync interface.
The Effect to data refers to the Import Option in Blue being either Overwrite or Update. Read more about the Import Option.
Local Sync Settings
- Replace Existing Blue User Types - (user datasource only) This option overwrites the existing type in Blue with the user type provided by the external datasource. If the Blue User Type field is not mapped in the Required Fields, then all users in the imported data will be given the Default user type.
- Replace Existing Datasource Access Key(s) - (user datasource only) All Access Keys will be replaced with access keys from the imported data.
- Replace Existing Language Preferences (always enabled) - (user datasource only) All language preferences will always be overwritten with the language preferences provided by the imported data, except when the user explicitly sets the preferred language in their Blue profile.
- Abort if Imported Data Table is Empty - The connection will terminate once Blue determines that the datasource being imported contains no data.
- Abort import if duplicate records are encountered - When enabled the entire datasource import will abort if a duplicate record is identified in the source data.
Sync Settings also contains a scheduler to set up recurring datasource imports, perform manual imports and view data changes since the last sync.
You may select Export if you wish to download a CSV file of the imported data.
Use View Changes to download a spreadsheet that contains two rows for every changed record. One row contains the old data while the other row contains the updated data. Review the spreadsheet periodically to make sure that the updates are correct.
Before leaving this page, click Start Synchronize whether performing a manual import or a scheduled import. Data Sync will not begin to import data until Start Synchronize has been clicked.
To perform a manual datasource import, the Scheduled Datasource Sync must first be turned off.
Datasource Sync History
The Datasource Sync History displays a complete history of all scheduled and manual syncs with Blue. Additional information can be found by clicking Details on a historical import entry to open a text file with a more detailed description of the synchronization activity.
InData sync tool (DST) guide
InData sync tool (DST) guide
InData sync tool (DST) guide
InData sync tool (DST) guide