The Worker and Event Listener are vital components for real-time Data syncs. Here's a brief overview of how the Worker/Event Listener operates:
The Event Listener, once successfully subscribed, awaits events from the streaming source.
Upon receiving a message from a streaming source, the Event Listener pushes it to the message queue.
The Worker then retrieves the message from the message queue.
The Worker fetches the corresponding record from the target based on the sync key.
If changes are detected, the Worker pushes them to the target system. Both successes and failures get logged in the worker's log file.
For a Kubernetes deployment of the Cinchy Platform, the Worker/Event Listener is automatically installed. The steps below are specific to an IIS deployment of the Cinchy Platform.
Windows Server 2012+
SQL Server 2012+
Service Broker enabled
Cinchy Platform
On a Windows Server machine, launch an instance of PowerShell as Administrator.
Enable the SQL Service Broker using the command:
Navigate to the Cinchy Releases table.
Download the latest Cinchy Event Listener.zip file from the Release Artifacts column.
Extract the .zip file to your designated directory. For example, C:\your event listener folder.
Run the create-cinchy-event-listener-windows-service.ps1 PowerShell script from the installation directory. Use the filePath parameter as -filePath <Path to your agent.exe file>.
Download the latest Cinchy Connections.zip file from the Release Artifacts column.
Unzip the content of the Cinchy Worker folder to, for example, C:\your CLI worker folder.
Run the create-cinchy-cli-worker-windows-service.ps1 PowerShell script from the installation directory. Pass the filePath parameter pointing to the Cinchy.CLI.exe file.
Open the appSettings.json file in your Event Listener directory and configure:
To start the Event Listener service:
Press Windows + R to access the Run box.
Type services.msc and press Enter.
From the services list, locate Cinchy Event Listener.
Right-click on it and select Start.
Open the appSettings.json file in your Worker directory and configure:
To start the Worker service:
Press Windows + R to open the Run box.
Input services.msc and hit Enter.
In the list of services, find Cinchy Worker.
Right-click on the service and select Start.
The Connections Experience facilitates 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.
Connections.zip has the following files:
Worker.zip
WebApi.zip
CLI.zip.
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:
The Command Line Interface (CLI) offers utilities to get data in and out of Cinchy.
The Maintenance CLI was packaged together with the CLI for versions 5.0 and lower. You can use it to perform maintenance tasks such as data erasure and data compression deletions. For a list of all commands,
Navigate to theand download the latest Cinchy Connections.zip file from the Release Artifacts column.
The Connections.zip file contains: Worker.zip, WebApi.zip, and CLI.zip.
Extract the CLI.zip.
Run the Cinchy.CLI.exe to deploy the CLI.
Navigate to theand 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.
| Parameter | Value |
|---|---|
| Parameter | Value |
|---|---|
| Parameter | Value |
|---|---|
| Parameter | Value |
|---|---|
| Parameter | Value |
|---|---|
| Parameter | Value |
|---|---|
Navigate to theand download the latest Cinchy Connections.zip file from the Release Artifacts column.
| Parameter | Description |
|---|
| Parameter | Description |
|---|
URL
Cinchy Web URL (e.g., https://cinchy.net/Cinchy)
Password
Password for the user: eventlistener@cinchy.com
GetNewListenerConfigsInterval
(seconds) Frequency at which the listener checks for new configs in the [Cinchy].[Listener Configs] table. Default is 60 seconds.
SqlServer
Connection string to the SQL server that hosts the Cinchy database.
URL
Cinchy Web URL (e.g., https://cinchy.net/Cinchy)
Password
Password for the user: connections@cinchy.com
Model
Cinchy. This specifies the model for the CLI.
TempDirectory
Temporary directory for the CLI to store files.
SqlServer
Connection string to the SQL server that hosts the Cinchy database.
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. If it's hosted on another URL path, this property must be populated with the relative path ( /dev-aurora-2/connections or / if deployed to the root) |
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://” |
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
