v5 Worker/Listener Installation Guide

This page details how to install the Worker/Listener on a v5 Cinchy IIS platform.

Overview

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.

Prerequisites

1. SQL Service Broker Setup

  1. 1.
    Navigate to the Cinchy Releases table and download the create_queues script from the Script Artifacts column.
  2. 2.
    On a Windows Server machine, launch an instance of PowerShell as the Administrator.
  3. 3.
    To set up the worker queues and SQL Service Broker, make the following changes and run the create_queues script:
-- Change [cinchy] to match your database name
USE [cinchy];
-- Update the below @user, @password, @db, and @schema values to match your configuration
DECLARE @user NVARCHAR(100) = 'cinchytst';
DECLARE @password NVARCHAR(100) = 'test';
DECLARE @db NVARCHAR(100) = 'cinchy';
DECLARE @schema NVARCHAR(100) = 'dbo';

2. Downloading the Resources

  1. 1.
    Navigate to the Cinchy Releases table.

2.1 Event Listener

  1. 1.
    Download the latest Cinchy Event Listener.zip file from the Release Artifacts column.
  2. 2.
    Extract the .zip to the folder to <your event listener folder>
  3. 3.
    Execute the create-cinchy-event-listener-windows-service.ps1 PowerShell script. Pass in filePath parameter -filePath <Your Listener/Worker Path> to the agent.exe file. The script is in the installation directory.

2.2 Worker

  1. 1.
    Download the latest Cinchy Connections.zip file from the Release Artifacts column.
  2. 2.
    Extract the content of the Cinchy Worker folder to C:\<your cli worker folder>
  3. 3.
    Execute create-cinchy-cli-worker-windows-service.ps1 PowerShell script. Pass in filePath parameter. filePath = path to the Cinchy.CLI.exe file. The script is in the installation directory.

3. Event Listener Deployment

  1. 1.
    Navigate to the appSettings.json in your Event Listener directory and make the following configurations:

App Settings

Parameter
Value
URL
Private Cinchy web URL (ex. https://cinchy.net/Cinchy)
Password
The password for the user [email protected]
GetNewListenerConfigsInterval
(seconds) How often the listener polls for new configs in the [Cinchy].[Listener Configs] table. Default is 60.
path
Directory for storing the logs.
StateFileLocation
Location to store stream state files. This can be a shared UNC location or a mounted drive.

ConnectionStrings

Parameter
Value
SqlServer
Fill in the connection string to the SQL server hosting the Cinchy database.
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.

4. Worker Deployment

  1. 1.
    Navigate to the appSettings.json in your Worker directory and make the following configurations:

AppSettings

Parameter
Value
URL
Private Cinchy web URL (ex. https://cinchy.net/Cinchy)
AuthServiceDomain
Cinchy SSO URL (ex. https://cinchy.net/CinchySSO)
UseHttps
"true" or "false". This is the same as the --https flag in the CLI
Password
The password for the user [email protected]
Model
"Cinchy". This is the model for the CLI.
TempDirectory
Temp directory for the CLI to store files.

ConnectionStrings

Parameter
Value
SqlServer
Fill in the connection string to the SQL server hosting the Cinchy database.
2. To start the service, open the Run box (Windows + R) > services.msc
3. In the list of services, find the Cinchy Worker service. Right click on the service and click Start.