In order to use Cinchy Data Sync, there are some environmental configurations that will need to be set up. The following section contains the pre-requisites and server size required for setting up both a batch data sync and a real-time data sync.
Review the hardware, software, and server sizing prerequisites here.
Review the below documentation for installation instructions:
Installing Connections
Installing the Worker/Listener
Installing the CLI and the Maintenance CLI
The Worker and Listener are important components for using Real-Time Data syncs. At a high level, the Worker/Listener follows this process:
Once the Listener is successfully subscribed, it waits for events from streaming source.
The Listener receives a message from a streaming source and pushes it to SQL Server Broker.
The Worker then picks up message from SQL Server Broker.
The Worker fetches the matching record from the target based on the sync key.
If there are changes detected, the Worker pushes them to the target system. Successes and failures are logged in the worker's log file.
In a Kubernetes deployment of the Cinchy Platform, the Worker/Listener is automatically installed. The below steps refer only to an IIS deployment of the Cinchy Platform.
Before proceeding, ensure that you have read the section.
Windows Server 2012+
.NET Core 3.1 Hosting Bundle (click to download)
SQL Server 2012+
Service Broker enabled
Cinchy Platform
On a Windows Server machine, launch an instance of PowerShell as Administrator.
Set up the SQL Service Broker by executing the following command:
Download the latest Cinchy Event Listener.zip file from the Release Artifacts column.
Extract the .zip to the folder to <your event listener folder>
Execute the create-cinchy-event-listener-windows-service.ps1 PowerShell script that is located in the installation directory. Pass in filePath parameter -filePath <Your Listener/Worker Path> to the agent.exe file.
Download the latest Cinchy Connections.zip file from the Release Artifacts column.
Extract the content of the Cinchy Worker folder to C:\<your cli worker folder>
Execute create-cinchy-cli-worker-windows-service.ps1 PowerShell script that is located in the installation directory. Pass in filePath parameter filePath = path to the Cinchy.CLI.exe file.
Navigate to the appSettings.json in your Event Listener directory and make the following configurations:
2. To start the service, open the Run box (Windows + R) > services.msc
3. In the list of services, find the Cinchy Event Listener service. Right click on the service and click Start.
Navigate to the appSettings.json in your Worker directory and make the following configurations:
To start the service, open the Run box on your machine (Windows + R) > type in services.msc
In the list of services, find the Cinchy Worker.
Right click on the service and click Start.
Navigate to the
| Parameter | Value |
|---|
| Parameter | Value |
|---|
| Parameter | Value |
|---|
| Parameter | Value |
|---|
| Parameter | Value |
|---|
| Parameter | Value |
|---|
URL | Cinchy Web URL (ex. https://cinchy.net/Cinchy) |
Password | The password for the user eventlistener@cinchy.com. |
GetNewListenerConfigsInterval | (seconds) How often the listener polls for new configs in the [Cinchy].[Listener Configs] table. Default is 60. |
SqlServer | Fill in the connection string to the SQL server hosting the Cinchy database. |
URL | Cinchy Web URL (ex. https://cinchy.net/Cinchy) |
Password | The password for the user connections@cinchy.com. |
Model | "Cinchy". This is the model for the CLI. |
TempDirectory | Temp directory for the CLI to store files. |
SqlServer | Fill in the connection string to the SQL server hosting the Cinchy database. |
The Connections Experience is designed to facilitate the creation of data syncs through an easy to use Cinchy UI. Once installed, you can access Connections directly through your Cinchy platform using the applet (Image 1).
In a Kubernetes deployment of the Cinchy Platform, Connections is automatically installed. The below steps refer only to an IIS deployment of the Cinchy Platform.
Before proceeding, ensure that you have read the Prerequisites section.
Navigate to the Cinchy Releases table and download the latest Cinchy Connections.zip file from the Release Artifacts column.
The Connections.zip file contains: Worker.zip, WebApi.zip, and CLI.zip.
2. Extract the WebApi.zip to the folder where you want to host the applet.
We suggest to create the following path and extract it there: C:\Connections\
On a Windows Server machine, launch an instance of PowerShell as the Administrator.
Run the below commands to create the IIS application pool and set its properties.
Steps 4 and 5 are only needed if you deployed your Cinchy instance along a base path.
Within the Cinchy platform, navigate to the [Cinchy].[Integrated Clients] table (Image 2).
Navigate to the row where the Client ID column is "cinchy_connections_experience" (Image 3).
In that same row, update the columns “Permitted Login Redirect URLs” and “Permitted Logout Redirect URLs” to “<url>/connections” (Image 4).
Within the Cinchy platform, navigate to the [Cinchy].[Applets] table (Image 5).
Navigate to the row where the Name column is "Connections" (Image 6).
Update the column “Application URL” to “<baseurl>/connections” (Image 7).
Navigate to C:\Connections\appsettings.json and update the below properties to match your environment:
Navigate to C:\Connections\ClientApp\dist\assets\config.json update the below properties to match your environment:
Create the IIS Application by running the following command in an instance of Powershell:
| Parameter | Description |
|---|---|
"URL"
This is the private URL of your Cinchy environment.
“TempDirectory”
This should be a path pointing to an existing folder that will hold all of your log and error files.
"StorageType"
Select either Local, S3, or AzureBlobStorage.
"BasePathOverride"
(Optional) Connections should be hosted on "/connections". In the case that this is hosted on another url path, this property must be populated with the relative path (eg. "/dev-aurora-2/connections" or "/" if deployed to the root)
Parameter
Description
“authority”
Your public CinchySSO URL in lowercase (ex: <base-url>/cinchysso)
“cinchyRootUrl”
Your public Cinchy URL (ex: <base-url>/Cinchy)
“redirectUrl”
The applet’s public URL (ex: <base-url>/connections)
silentRefreshRedirectUri
The applet’s public URL plus the silent refresh path.
“model”
The model where your data sync configs are. Keep this as “Cinchy” if you don’t know.
“domain”
The model where your data sync configs are. Keep this as “Cinchy” if you don’t know.
“useHttps”
Should be true if your Cinchy platform is hosted on a secure environment
“server”
Your private Cinchy URL without “http://” or “https://”
In order to install the components necessary to run a Cinchy Data Sync, there are some environmental configurations that will need to be set up. The following section contains the prerequisites and server size required for setting up both a batch data sync and a real-time data sync.
In a Kubernetes deployment of the platform, both Connections and the Worker/Listener are deployed automatically upon first install of Cinchy.
Windows Server 2012+
.NET Core 3.1 Hosting Bundle (click here to download)
SQL Server 2012+
Service Broker enabled
Cinchy Platform
Server Sizing minimum requirements:
4GB of RAM
30GB of HDD space
2 CPU Cores
The Command Line Interface (CLI) offers utilities to get data in and out of Cinchy.
The Maintenance CLI was formerly (prior to v5) packaged together with the CLI. It can be used to perform maintenance tasks such as data erasure and data compression deletions. For a full list of CLI commands, review the documentation here.
Navigate to the Cinchy Releases table and download the latest Cinchy Connections.zip file from the Release Artifacts column.
The Connections.zip file contains: Worker.zip, WebApi.zip, and CLI.zip.
2. Extract the CLI.zip.
3. Run the Cinchy.CLI.exe to deploy the CLI.
Navigate to the Cinchy Releases table and download the latest Maintenance CLI.zip file from the Release Artifacts column.
Extract the Maintenance CLI.zip.
Run the Cinchy.Maintenance.CLI.exe to deploy the Maintenance CLI.