Building Data Syncs
Step-by-Step Guide
You can use this checklist in conjunction with the documentation below and elsewhere in this space to configure your data syncs in Cinchy.
1. Overview
Once you have installed all of your necessary components and decided upon which type of data sync you'd like to use, the next step is to configure your data sync. This involves a series of steps that are outlined in the sections below.
There are two options when you want to create a data sync in Cinchy.
You can input all of your necessary information through the intuitive Connections UI. Once saved, all of this data is uploaded as an XML into the Data Sync configurations table.
Or, you can bypass the UI and upload your XML config directly into the Data Sync configuration table yourself.
For real-time syncs only, you must also set up a listener configuration.
2. Create a Data Sync Configuration
Whether you are setting up a real-time or a batch sync, you will need to create your data sync configuration. The data sync configuration defines the source, the mapping to the target, and synchronization behavior.
To set up a data sync, you can use the Connections UI or manually input an XML into the Data Sync Configuration table in Cinchy.
2.1 Using the Connections UI
Navigate to the Connections Experience in Cinchy (Image 1).
In the experience, there are six tabs that you must or can input data for in order to define your connection (Image 2).
The Info tab is used to define some basic information about your data sync such as its name (Image 3). This tab is mandatory. You also have the optional ability to add in Parameters; please review the documentation here for more details on Parameters.
The Source tab is used to define important information about the source of your data sync (Image 4). This tab is mandatory. Cinchy supports many different source options including different file types and popular software systems. Each source will have different, and often unique, parameters that must be populated in the Source tab screen. You can review the full list of supported data sources, as well as their unique parameters and features, here.
The Destination tab is used to define important information about the target of your data sync (Image 5). This tab is mandatory. Like with sources, Cinchy supports many different destination options. Each destination must be properly mapped to its source, and some may have unique parameters that must be populated in the Destination tab. You can review the full list of supported destinations, as well as their unique parameters and features, here.
The Sync Behaviour tab defines what you want to happen to your data (Image 6). This tab is mandatory. There are two options on this page: Full File Sync and Delta Sync. You can review the differences between them here.
The Post Sync tab is an optional field that utilizes Cinchy Query Language (CQL) to perform actions on your resulting data (Image 7). For example, you could set up a post sync script to push retrieved data values into a specific Cinchy table.
The Permissions tab allows you to define various access controls for your data sync (Image 8). This is a role based access system where you can give specific groups read, write, execute, and/or all of the above with admin access.
The Jobs tab will appear when you are configuring a batch data sync (Image 9). This page allows you to start and track your batch jobs, and will show important info on any job successes or failures. You can also use this screen to download error logs for batch syncs.
By default, the job will run as whichever user is logged in (as long as you have authority to run the Job). You have the option to run it as another, non-SSO account if:
You have the credentials
The account has access to run the Job
You can configure this by clicking on Advanced > Run Job as a Different User
The Executions Error tab is a link to the Execution Errors table which will appear when you are configuring a real-time sync (Image 10). This table is useful for tracking any errors associated with your real-time sync. Since you don't need to click "Start a Job" in the UI for real-time syncs, a sync is considered active when your Listener Config is set up and turned to "enabled". You can see more on Error Logging here.
2.2. Using a Config XML
In lieu of using the Connections UI, you can also set up a data sync by uploading a correctly formatted XML into the Data Sync Configs table within Cinchy.
We recommend only doing so once you have a good grasp on how data sync work. Note that not all sources/targets follow the same XML pattern, but you can review a basic version that uses a Delimited File source into a Cinchy Table here.
To set up a data sync using a config XML:
In the Cinchy platform, navigate to the Data Sync Config table (Image 11).
In a new row, paste your Data Sync XML into the Config XML column.
Define your group permissions in the applicable columns.
Once you have completed your Data Sync XML, navigate to the Data Sync Configurations table in Cinchy (Image 12).
The Name and Config Version columns will be auto populated as they values are coming from the Config XML.
Tip: Click on the below image to enlarge it.
Be sure when you are pasting into the Config XML column that you double click into the column before pasting, otherwise each line of the XML will appear as an individual record in the Data Sync Configurations table.
To execute your Data Sync you will use the CLI. If you do not have this downloaded, refer to the documentation here.
In this example we will be using the following Data Sync Commands, however, for the full list of commands click here.
| Parameter | Description | Example |
|---|---|---|
-s (server) | Required. The full path to the Cinchy server without the protocol (e.g. cinchy.co/Cinchy). | "pilot.cinchy.co/Training/Cinchy/" |
-u (userid) | Required. The user id to login to Cinchy that has execution access to the data sync. | "admin" |
-p (password) | Required. The password of the above User ID parameter. This must be encrypted. For a walkthrough on how to use the CLI to encrypt the password, refer to the Appendix section. | "DESuEGqfffsamx55yl256hjuPYxa4ncc+5+bLkoVIFpgs0Lq6hkcU=" |
-f (feed) | Required. The name of the Data Sync Configuration as defined in Cinchy | "Data Sync Name" |
Launch Powershell and navigate to the Cinchy CLI directory.
Enter and execute the following into Powershell:
2.3. Set Up a Listener Config (Real-Time Syncs)
Setting up a Listener Configuration is a required step when doing a real-time data sync. You will configure your Event Stream Source with your data sync information. You can review an more on the Listener Config here.
Navigate to the Listener Config table in Cinchy (Image 13).
In a new row, add in your listener config configuration data. Review the documentation here for more information.
Ensure that it is set to Enabled in order for your real-time data sync to run successfully.
3. Examples
The following subsections provide basic examples of both batch and real-time data syncs. These simple use cases can be used as a jumping off reference point for learning the ropes of Cinchy daata syncs.
Last updated
