Real-Time Sync Example

1. Overview

This example will take you through the creation and execution of a real-time data sync where data will be synced between two Cinchy tables based on real-time changes.

Use Case: Your People table captures a view of various personnel information. Any time a new hire is added to the table, you want that information to be immediately synced into the New Employees table. We can solve this use case using the Cinchy Change Data Capture (CDC) function on our tables. This helps you to better keep track of all incoming people within your company.

Example Use Case:

2. Sample Files and Code

This section contains steps on how to:

• Create the People table.

• Create the New Employees table.

2.1 People Table Creation

1. Login to your Cinchy platform

2. From under My Network, click the create button

3. Select Table

4. Select From Scratch

5. Create a table with the following properties (Image 1):

6. Click Columns in the left hand navigation to create the columns for the table

7. Click the "Click Here to Add" button and add the following columns:

1. Click Change Notifications in the left hand navigation and ensure "Publish Change Notifications" is checked.

2. Click the Save button to save your table.

2.2 New Employees Table Creation

1. Within the Cinchy platform, from under My Network, click the create button

2. Select Table

3. Select From Scratch

4. Create a table with the following properties (Image 2):

6. Click Columns in the left hand navigation to create the columns for the table.

7. Click the "Click Here to Add" button and add the following columns:

1. Click the Save button to save your table.

3. Creating the Data Sync

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.

This example will walk you through both options.

3.1 Using the Connections UI

1. Within your Cinchy platform, navigate to the Connections Experience (Image 3).

1. In the Info tab, input the name of your data sync. For this example we are using "New Hires" (Image 4).

1. Navigate to the Source tab.

2. Under "Select a Source", choose "Cinchy Event Broker" (Image 5).

1. In the Schema section, input the columns from your source table (in this case the People table) that you will want to use in your data sync. In this example we are using the Name and Title columns, both of which are data type Text (Image 6). You may also choose to set any Aliases or add a Description.

1. Navigate to the Destination tab and select Cinchy Table from the drop down (Image 7).

2. In the Load Metadata pop-up, input the Domain and Table name for your destination. In this example, we are using the Sandbox domain and the People table.

3. Click Load.

1. Select the columns that you wish to use in your data sync (Image 8). These will be the columns that your source syncs to your target. In this example, we are using the Name and Title columns. Note that you will have many Cinchy system table available to use as well.

2. Click Load.

1. The Connections experience will attempt to automatically map your source and destination columns based on matching names. In the below screenshot, it has been able to correctly match the Name and Title columns (Image 9).

1. Navigate to the Sync Behaviour tab. There are two options for data syncs: Full File and Delta. In this example, select Full File.

1. Set the following parameters (Image 10):

1. Navigate to the Permissions tab. Here you will define your group access controls for your data sync. You can set this how you like. For this example, we are giving all users access to Execute, Write, and Read our sync (Image 11).

1. Click Save.

2. Navigate to the Cinchy Listener Config table and set up your configuration. Ensure it is set to Enabled. Your real-time data sync should now be listening to your People table ready to push updates to your New Employees table.

3. Test your data sync by adding a new row to your People table. Ensure that the data is then updated across to the New Employees table (Images 12 & 13).

3.2 Using a Data Sync 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.

Below is the completed batch data sync configuration for this example. Review the XMLs and then proceed to section 3.2.3 for further instructions.

3.2.1 Blank XML Example

The below XML shows what a blank data sync could look like for our Cinchy Event Broker/CDC to Cinchy Table real-time sync with full file synchronization.

<?xml version="1.0" encoding="utf-16"?>
<BatchDataSyncConfig name="" version="1.0.0" xmlns="http://www.cinchy.co">
    <CinchyEventBrokerDataSource runQuery="false">
        <Schema>
            <Column name="" dataType="" trimWhitespace="true" isMandatory="false" validateData="false"/>
        </Schema>
    </CinchyEventBrokerDataSource>
    <CinchyTableTarget reconcileData="true" domain="" table="" suppressDuplicateErrors="false" degreeOfParallelism="1">
        <ColumnMappings>
            <ColumnMapping sourceColumn="" targetColumn=""/>
        </ColumnMappings>
        <SyncKey readonly="false">
            <SyncKeyColumnReference name=""/>
        </SyncKey>
        <NewRecordBehaviour type=""/>
        <DroppedRecordBehaviour type=""/>
        <ChangedRecordBehaviour type=""/>
        <PostSyncScripts/>
    </CinchyTableTarget>
</BatchDataSyncConfig

3.2.2 Filled XML Example

The below filled XML example matches the Connections UI configuration we made in step 3.1. You can review the parameters used in the table below.

<?xml version="1.0" encoding="utf-16"?>
<BatchDataSyncConfig name="New Hires" version="1.0.0" xmlns="http://www.cinchy.co">
    <CinchyEventBrokerDataSource runQuery="false">
        <Schema>
            <Column name="Name" dataType="Text" trimWhitespace="true" isMandatory="false" validateData="false"/>
            <Column name="Title" dataType="Text" trimWhitespace="true" isMandatory="false" validateData="false"/>
        </Schema>
    </CinchyEventBrokerDataSource>
    <CinchyTableTarget reconcileData="true" domain="sandbox" table="New Employees" suppressDuplicateErrors="false" degreeOfParallelism="1">
        <ColumnMappings>
            <ColumnMapping sourceColumn="Name" targetColumn="Name"/>
            <ColumnMapping sourceColumn="Title" targetColumn="Title"/>
        </ColumnMappings>
        <SyncKey readonly="false">
            <SyncKeyColumnReference name="Name"/>
        </SyncKey>
        <NewRecordBehaviour type="INSERT"/>
        <DroppedRecordBehaviour type="DELETE"/>
        <ChangedRecordBehaviour type="UPDATE"/>
        <PostSyncScripts/>
    </CinchyTableTarget>
</BatchDataSyncConfig

3.2.3 Using the Data Sync XML

1. Once you have completed your Data Sync XML, navigate to the Data Sync Configurations table in Cinchy (Image 14).

1. In a new row, paste the Data Sync XML into the Config XML column.

2. Define your group permissions in the applicable columns. In our example, we have given All Users the Admin Access.

1. Navigate to the Cinchy Listener Config table and set up your configuration. Ensure it is set to Enabled. Your real-time data sync should now be listening to your People table ready to push updates to your New Employees table.

2. To execute your Data Sync you will use the CLI. If you do not have this downloaded, refer to the documentation here.

3. In this example we will be using the following Data Sync Commands, however, for the full list of commands click here.

1. Launch Powershell and navigate to the Cinchy CLI directory.

2. Enter and execute the following into Powershell:

.\Cinchy.CLI.exe syncdata -s "pilot.cinchy.co/Training/Cinchy/" -u "admin" -p "DESuEGqmx55yl2PYxa4ncc+5+bLkoVIFpgs0Lq6hkcU=" -f "Contact Import"

1. Test your data sync by adding a new row to your People table. Ensure that the data is then updated across to the New Employees table (Images 15 & 16).

4. Setting the Listener Config

Setting up a Listener Configuration is a required step when doing a real-time data sync. While this example shows how to configure the sync using the Cinchy Event Broker/CDC, Cinchy also supports other Event Stream Sources. You can review the full list here.

1. Navigate to the Listener Config table in Cinchy (Image 17).

1. In a new row, add in your listener config data using the below table as a guide:

4.1 JSON Topic Column

For the topic JSON, you need to provide the following:

4.2 Topic JSON Example

{
    "tableGuid": "3daba5da-5e07-4d35-8d7c-d451a2c9068e",
    "fields": [
        {
            "column": "Name"
        },
        {
            "column": "Title"
        }
    ],
}

5. Appendix

5.1 Password Encryption

Prior to executing the data sync command, let's encrypt the password using Powershell

To encrypt a password using Powershell, complete the following:

1. Launch Powershell and navigate to the Cinchy CLI directory (note, you can always type powershell in the windows explore path for the Cinchy CLI directory)

2. Enter the following into Powershell .\Cinchy.CLI.exe encrypt -t "password"

3. Hit enter to execute the command

4. Copy the password (e.g. notepad, Visual Studio Code, word etc.) so you have it accessible at batch execution time

5.2 Execution Logs

The Execution Log table is a system table in Cinchy that logs the outputs of all data syncs. You can always review the entries in this table for information on the progression of your syncs (Image 18).

5.3 Execution Errors

The Execution Errors table is a system table in Cinchy that logs any errors that may occur in a data sync (Image 19). Any data sync errors will also be logged in the temp directory outlined in the data sync execution command (e.g. -d "C:\Cinchy\temp")