Installing the Worker/Listener
Last updated
Was this helpful?
Last updated
Was this helpful?
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 Prerequisites 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:
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.
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:
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.
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