v5.0 - v5.5 Data Sync Documentation
  • Overview
  • Release Notes
    • V4.5
    • V4.6
    • v4.7
    • v4.8
    • v4.9
    • v4.10
    • v4.12
    • v4.13
  • v4 Connections Installation Guide
    • v5 Connections and CLI Installation Guide
  • v4 Worker/Listener Installation Guide
    • v5 Worker/Listener Installation Guide
  • Upgrades & Config Changes
  • Builder Guide
    • Overview
    • Types of Data Syncs
    • Subscribing to Event Streams
      • Supported Stream Sources
        • Amazon Simple Queue Service (SQS)
        • Cinchy Change Data Capture
        • Data Polling
        • Kafka Topic
        • MongoDB
        • Salesforce
          • Push Topic
          • Platform Event
    • Configuring a Data Sync
      • Connections Experience & XML Config Reference
        • Info
          • Parameters
            • String Escape
        • Source Config Reference
          • Schema Columns
            • Calculated Column Examples
          • Auth Requests
          • Request Headers
          • Pagination
          • Source Filter
        • Target Destination Config Reference
          • Column Mappings
          • Target Destination Filter
        • Sync Behaviour
        • Post Sync
        • Permissions
        • Jobs
        • Connections Usage Example
      • Data Validation
      • Transformations
        • StringReplacement
      • Supported Data Sources
        • File Based Source
          • Binary File
            • Binary File Data Source Example
          • Delimited File
            • Delimited File Data Source XML Example
          • Fixed Width File
          • Excel
            • Excel Source XML Example
        • Cinchy Event Broker/CDC
          • Cinchy Event Broker/CDC XML Config Example
        • Cinchy Table
          • Cinchy Table XML Config Example
        • Cinchy Query
          • Cinchy Query Data Source Example
        • Copper
        • DB2
        • Dynamics 2015
        • Dynamics
        • DynamoDB
        • Kafka Topic
          • Apache AVRO Data Format
          • Kafka Topic Source Example
        • LDAP
        • MongoDB Collection
          • MongoDB Collection Source XML Example
        • MongoDB Collection (Cinchy Event Triggered)
        • MS SQL Server Query
        • MS SQL Server Table
        • ODBC Table
        • ODBC Query
        • Oracle Table
        • Oracle Query
        • Parquet
        • Polling Event
          • Polling Event Example
        • REST API (Cinchy Event Triggered)
        • REST API
          • REST API XML Example
        • SAP SuccessFactors
        • Salesforce Object (Bulk API)
        • Salesforce Platform Event
        • Salesforce Push Topic
        • Snowflake
          • Snowflake Source XML Example
        • SOAP 1.2 Web Service
      • Supported Sync Targets
        • Cinchy Table
        • DB2 Table
        • Dynamics
        • Kafka Topic
        • MongoDB Collection (Column Based)
        • MS SQL Server Table
        • Oracle Table
        • REST API
        • Salesforce
        • Salesforce Object
        • Snowflake Table
          • Snowflake Table Target XML Example
        • SOAP 1.2 Web Service
    • Common Design Patterns
    • Testing a Data Sync
    • Promoting a Data Sync
    • Scheduling a Data Sync
    • CLI Command List
    • Connections Functions
    • Monitoring
  • Cinchy Platform Documentation
Powered by GitBook
On this page
  • Overview
  • Prerequisites
  • 1. SQL Service Broker Setup
  • 2. Downloading the Resources
  • 2.1 Event Listener
  • 2.2 Worker
  • 3. Event Listener Deployment
  • 4. Worker Deployment

Was this helpful?

  1. v4 Worker/Listener Installation Guide

v5 Worker/Listener Installation Guide

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

Previousv4 Worker/Listener Installation GuideNextUpgrades & Config Changes

Last updated 2 years ago

Was this helpful?

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

  • Windows Server 2012+

  • SQL Server 2012+

    • Service Broker enabled

  • Cinchy Platform

1. SQL Service Broker Setup

  1. On a Windows Server machine, launch an instance of PowerShell as the Administrator.

  2. 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

2.1 Event Listener

  1. Download the latest Cinchy Event Listener.zip file from the Release Artifacts column.

  2. Extract the .zip to the folder to <your event listener folder>

  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. Download the latest Cinchy Connections.zip file from the Release Artifacts column.

  2. Extract the content of the Cinchy Worker folder to C:\<your cli worker folder>

  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. Navigate to the appSettings.json in your Event Listener directory and make the following configurations:

Client Settings

URL

Your Cinchy URL

Password

For Cinchy v5, this should be the password for the user eventlistener@cinchy.com.

App Settings

Parameter
Value

URL

Private 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.

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. Navigate to the appSettings.json in your Worker directory and make the following configurations:

Client Settings

URL

Your Cinchy URL

Password

For Cinchy v5, this should be the password for the user connections@cinchy.com.

AppSettings

Parameter
Value

URL

Private Cinchy web URL (ex. https://cinchy.net/Cinchy)

AuthServiceDomain

Cinchy SSO URL (ex. https://cinchy.net/CinchySSO)

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.

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.

Navigate to the and download the create_queues script from the Script Artifacts column.

Navigate to the

Install .net core Hosting bundle Version 6.0
Cinchy Releases table
Cinchy Releases table.