Install the Worker/Listener
Overview
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.
Prerequisites
Windows Server 2012+
SQL Server 2012+
Service Broker enabled
Cinchy Platform
SQL Service Broker setup
On a Windows Server machine, launch an instance of PowerShell as Administrator.
Enable the SQL Service Broker using the command:
Download the resources
Navigate to the Cinchy Releases table.
Event Listener
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 thefilePath
parameter as-filePath <Path to your agent.exe file>
.
Worker
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 thefilePath
parameter pointing to the Cinchy.CLI.exe file.
Event Listener deployment
Open the
appSettings.json
file in your Event Listener directory and configure:
ClientSettings
AppSettings
ConnectionStrings
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.
Worker Deployment
Open the appSettings.json file in your Worker directory and configure:
ClientSettings
AppSettings
ConnectionStrings
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.
Known issues: Warning messages during listener deployment
During the deployment of the listener, you may encounter specific warning messages. These warnings are currently expected and can be safely ignored. Proceed with the installation as usual.
Last updated