Cinchy Platform Documentation
Cinchy v5.6
Cinchy v5.6
  • Data Collaboration Overview
  • Release Notes
    • Release Notes
      • 5.0 Release Notes
      • 5.1 Release Notes
      • 5.2 Release Notes
      • 5.3 Release Notes
      • 5.4 Release Notes
      • 5.5 Release Notes
      • 5.6 Release Notes
  • Getting Help
  • Cinchy Glossary
  • Frequently Asked Questions
  • Deployment Guide
    • Deployment Installation Guides
      • Deployment Planning Overview and Checklist
        • Deployment Architecture Overview
          • Kubernetes Deployment Architecture
          • IIS Deployment Architecture
        • Deployment Prerequisites
          • Single Sign-On (SSO) Integration
            • Enabling TLS 1.2
            • Configuring ADFS
            • AD Group Integration
      • Kubernetes Deployment Installation
        • Disabling your Kubernetes Applications
        • Changing your File Storage Configuration
        • Configuring AWS IAM for Connections
        • Using Self-Signed SSL Certs (Kubernetes Deployments)
        • Deploying the CLI (Kubernetes)
      • IIS Deployment Platform Installation
    • Upgrade Guides
      • Upgrading Cinchy Versions
        • Cinchy Upgrade Utility
        • Kubernetes Upgrades
          • v5.1 (Kubernetes)
          • v5.2 (Kubernetes)
          • v5.3 (Kubernetes)
          • v5.4 (Kubernetes)
          • v5.5 (Kubernetes)
          • v5.6 (Kubernetes)
          • Upgrading AWS EKS Kubernetes Version
          • Updating the Kubernetes Image Registry
          • Upgrading AKS (Azure Kubernetes Service)
        • IIS Upgrades
          • v4.21 (IIS)
          • v4.x to v5.x (IIS)
          • v5.1 (IIS)
          • v5.2 (IIS)
          • v5.3 (IIS)
          • v5.4 (IIS)
          • v5.5 (IIS)
          • v5.6 (IIS)
      • Upgrading from v4 to v5
  • Guides for Using Cinchy
    • User Guides
      • Overview of the Data Browser
      • The Admin Panel
      • User Preferences
        • Personal Access Tokens
      • Table Features
      • Data Management
      • Queries
      • Version Management
        • Versioning Best Practices
      • Commentary
    • Builder Guides
      • Best Practices
      • Creating Tables
        • Attaching Files
        • Columns
        • Data Controls
          • Data Entitlements and Access Controls
          • Data Erasure
          • Data Compression
        • Formatting Rules
        • Indexing and Partitioning
        • Linking Data
        • Table and Column GUIDs
        • System Tables
      • Deleting Tables
        • Restoring Tables, Columns, and Rows
      • Saved Queries
      • CinchyDXD Utility
        • Building the Data Experience (CinchyDXD)
        • Packaging the Data Experience (CinchyDXD)
        • Installing the Data Experience (CinchyDXD)
        • Updating the Data Experience (CinchyDXD)
        • Repackaging the Data Experience (CinchyDXD)
        • Reinstalling the Data Experience (CinchyDXD)
      • Multi-Lingual Support
      • Integration Guides
    • Administrator Guide
    • Additional Guides
      • Monitoring and Logging on Kubernetes
        • Grafana
        • Opensearch Dashboards
          • Setting up Alerts
        • Monitoring via ArgoCD
      • Maintenance
      • System Properties
      • Enable Data At Rest Encryption
      • MDQE
      • Application Experiences
        • Network Map
          • Custom Node Results
          • Custom Results in the Network Map
        • Setting Up Experiences
  • API Guide
    • API Overview
      • API Authentication
      • API Saved Queries
      • ExecuteCQL
      • Webhook Ingestion
  • CQL
    • The Basics of CQL
      • CQL Examples
      • CQL Functions Master List
      • CQL Statements Overview
        • Cinchy DML Statements
        • Cinchy DDL Statements
      • Cinchy Supported Functions
        • Cinchy Functions
        • Cinchy System Values
        • Cinchy User Defined Functions
          • Table-Valued Functions
          • Scalar-Valued Functions
        • Conversion Functions
        • Date and Time Types and Functions
          • Return System Date and Time Values
          • Return Date and Time Parts
          • Return Date and Time Values From Their Parts
          • Return Date and Time Difference Values
          • Modify Date and Time Values
          • Validate Date and Time Values
        • Logical Functions
        • Mathematical Functions
        • String Functions
        • Geometry and Geography Data Type and Functions
          • OGC Methods on Geometry & Geography Instances
          • Extended Methods on Geometry & Geography Instances
        • Full Text Search Functions
        • Connections Functions
        • JSON Functions
  • Meta Forms
    • Introduction to Meta-Forms
    • Meta-Forms Deployment Installation Guide
      • Deploying Meta-Forms (Kubernetes)
      • Deploying Meta-Forms (IIS)
    • Forms Data Types
    • Meta-Forms Builders Guides
      • Creating a Dynamic Meta-Form (Using Tables)
      • Creating a Dynamic Meta-Form Example (Using Form Designer)
      • Adding Links to a Form
      • Rich Text Editing in Forms
  • Data Syncs
    • Getting Started with Data Syncs
    • Installation & Maintenance
      • Prerequisites
      • Installing Connections
      • Installing the Worker/Listener
      • Installing the CLI and the Maintenance CLI
    • Building Data Syncs
      • Types of Data Syncs
      • Common Design Patterns
      • Sync Behaviour
      • Columns and Mappings
        • Calculated Column Examples
      • Listener Configuration
      • Advanced Settings
        • Filters
        • Parameters
        • Auth Requests
        • Request Headers
        • Post Sync Scripts
        • Pagination
      • Batch Data Sync Example
      • Real-Time Sync Example
      • Scheduling a Data Sync
      • Connection Functions
    • CLI Commands List
    • Error Logging and Troubleshooting
    • Supported Data Sync Sources
      • Cinchy Event Broker/CDC
        • Cinchy Event Broker/CDC XML Config Example
      • Cinchy Table
        • Cinchy Table XML Config Example
      • Cinchy Query
        • Cinchy Query XML Config Example
      • Copper
      • DB2 (Query and Table)
      • Dynamics 2015
      • Dynamics
      • DynamoDB
      • File Based Sources
        • Binary File
        • Delimited File
        • Excel
        • Fixed Width File
        • Parquet
      • Kafka Topic
        • Kafka Topic Example Config
        • Apache AVRO Data Format
      • LDAP
      • MongoDB Collection
        • MongoDB Collection Source Example
      • MongoDB Collection (Cinchy Event Triggered)
      • MS SQL Server (Query and Table)
      • ODBC Query
      • Oracle (Query and Table)
      • Polling Event
        • Polling Event Example Config
      • REST API
      • REST API (Cinchy Event Triggered)
      • SAP SuccessFactors
      • Salesforce Object (Bulk API)
      • Salesforce Platform Event
      • Salesforce Push Topic
      • Snowflake
        • Snowflake Source Example Config
      • SOAP 1.2 Web Service
    • Supported Data Sync Destinations
      • Cinchy Table
      • DB2 Table
      • Dynamics
      • Kafka Topic
      • MongoDB Collection
      • MS SQL Server Table
      • Oracle Table
      • REST API
      • Salesforce Object
      • Snowflake Table
      • SOAP 1.2 Web Service
    • Supported Real-Time Sync Stream Sources
      • Cinchy Event Broker/CDC
      • Data Polling
      • Kafka Topic
      • MongoDB
      • Salesforce Push Topic
      • Salesforce Platform Event
  • Other Resources
    • Angular SDK
    • JavaScript SQK
Powered by GitBook
On this page
  • Step-by-Step Guide
  • 1. Overview
  • 2. Create a Data Sync Configuration
  • 2.1 Using the Connections UI
  • 2.2. Using a Config XML
  • 2.3. Set Up a Listener Config (Real-Time Syncs)
  • 3. Examples

Was this helpful?

Export as PDF
  1. Data Syncs

Building Data Syncs

PreviousInstalling the CLI and the Maintenance CLINextTypes of Data Syncs

Last updated 1 year ago

Was this helpful?

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

  1. Navigate to the Connections Experience in Cinchy (Image 1).

  1. In the experience, there are six tabs that you must or can input data for in order to define your connection (Image 2).

  1. 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.

  1. 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

  1. 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.

To set up a data sync using a config XML:

  1. In the Cinchy platform, navigate to the Data Sync Config table (Image 11).

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

  2. Define your group permissions in the applicable columns.

  3. 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.

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"

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

  2. Enter and execute the following into Powershell:

.\Cinchy.Connections.CLI.exe syncdata -s "pilot.cinchy.co/Training/Cinchy/" -u "admin" -p "DESuEGqmx55yl2PYxa4ncc+5+bLkoVIFpgs0Lq6hkcU=" -f "Data Sync Name"

2.3. Set Up a Listener Config (Real-Time Syncs)

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

  1. 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.

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;

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,

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,

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

is an optional field that utilizes 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.

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

To execute your Data Sync you will use the CLI. If you do not have this downloaded,

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

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

In a new row, add in your listener config configuration data. for more information.

Install any applicable components
Data Sync Type
Design Pattern
Data Sync Source
Data Sync Destination
Sync Behaviour
Event Stream source
please review the documentation here for more details on Parameters.
here.
here.
here.
The Post Sync tab
Cinchy Query Language (CQL)
here.
refer to the documentation here.
here.
Listener Config here.
Review the documentation here
Batch Data Sync Example
Real-Time Data Sync Example
Image 1: The Cinchy Connections Experience
Image 2: The Connections Tabs
Image 3: The Info Tab
Image 4: The Source Tab
Image 5: The Destination tab
Image 6: Sync Behaviour
Image 7: Post Sync Scripts
Image 8: Permissions
Image 9: The Jobs tab
Image 10: Execution Errors
Image 11: Data Sync Configurations table
Image 12: Config XML
Image 13: Listener Config table