5️⃣
Cinchy Platform Documentation
Cinchy v5.8
Cinchy v5.8
  • Data Collaboration Overview
  • Release notes
    • Release notes
      • 5.9 release notes
      • 5.8 Release Notes
      • 5.7 Release Notes
      • 5.6 Release Notes
      • 5.5 Release Notes
      • 5.4 Release Notes
      • 5.3 Release Notes
      • 5.2 Release Notes
      • 5.1 Release Notes
      • 5.0 Release Notes
  • Support
  • Glossary
  • FAQ
  • Deployment guide
    • Deploying Cinchy
      • Plan your deployment
        • Deployment architecture
          • Kubernetes architecture
          • IIS architecture
        • Deployment prerequisites
          • Single Sign-On (SSO) integration
            • Enable TLS 1.2
            • Configure ADFS
            • AD Group Integration
      • Kubernetes
        • Disable your Kubernetes applications
        • Change your file storage configuration
        • Configure AWS IAM for Connections
        • Use Self-Signed SSL Certs (Kubernetes)
        • Deploy the CLI (Kubernetes)
      • IIS
  • Upgrade guide
    • Upgrade Cinchy
      • Cinchy Upgrade Utility
      • Kubernetes upgrades
        • v5.1 (Kubernetes)
        • v5.2 (Kubernetes)
        • v5.3 (Kubernetes)
        • v5.4 (Kubernetes)
        • v5.5 (Kubernetes)
        • v5.6 (Kubernetes)
        • v5.7 (Kubernetes)
        • v5.8 (Kubernetes)
        • Upgrade AWS EKS Kubernetes version
        • Update the Kubernetes Image Registry
        • Upgrade Azure Kubernetes Service (AKS)
      • IIS upgrades
        • v4.21 (IIS)
        • v4.x to v5.x (IIS)
        • v5.1 (IIS)
        • v5.2 (IIS)
        • v5.3 (IIS)
        • v5.4 (IIS)
        • v5.5 (IIS)
        • v5.6 (IIS)
        • v5.7 (IIS)
        • v5.8 (IIS)
      • Upgrading from v4 to v5
  • Guides for using Cinchy
    • User Guide
      • Data Browser overview
      • The Admin panel
      • User preferences
        • Personal access tokens
      • Table features
      • Data management
      • Queries
      • Version management
        • Versioning best practices
      • Commentary
    • Builder Guide
      • Best practices
      • Create tables
        • Attach files
        • Columns
        • Data controls
          • Data entitlements
          • Data erasure
          • Data compression
        • Formatting rules
        • Indexing & partitioning
        • Linking data
        • Table and column GUIDs
        • System tables
      • Delete tables
        • Restore tables, columns, and rows
      • Saved queries
      • CinchyDXD
        • Overview
        • DXD workflow
        • Package the data experience
        • Install the data experience
        • Release package
        • Changelog
        • References
          • Cinchy DXD CLI reference
          • Data Experience Definitions table
          • Data Experience Reference table
      • Multilingual support
      • Integration guides
    • Administrator Guide
    • Additional guides
      • Monitor and Log on Kubernetes
        • Grafana
        • OpenSearch dashboards
          • Set up Alerts
        • Monitor via ArgoCD
      • Maintenance
      • Cinchy Secrets Manager
      • GraphQL (Beta)
      • System properties
      • Enable Data At Rest Encryption (DARE)
      • Application experiences
        • Network map
          • Custom node results
          • Custom results in the Network Map
        • Set up experiences
  • API Guide
    • API overview
      • API authentication
      • API saved queries
      • ExecuteCQL
      • Webhook ingestion
  • CQL
    • Overview
      • CQL examples
      • CQL statements overview
        • Cinchy DML statements
        • Cinchy DDL statements
      • Cinchy supported functions
        • Cinchy functions
        • Cinchy system values
        • Cinchy User Defined Functions (UDFs)
          • Table-valued functions
          • Scalar-valued functions
        • Conversion functions
        • Date and Time types and functions
          • Return System Date and Time values
          • Return Date and Time parts
          • Return Date and Time values from their parts
          • Return Date and Time difference values
          • Modify Date and Time values
          • Validate Date and Time values
        • Logical functions
        • Math functions
        • String functions
        • Geometry and Geography data type and functions
          • OGC methods on Geometry & Geography instances
          • Extended methods on Geometry & Geography instances
        • Full Text Search functions
        • Connections functions
        • JSON functions
    • CQL functions reference list
  • Meta-Forms
    • Introduction
    • Install Meta-Forms
      • Deploy Meta-Forms (Kubernetes)
      • Deploy Meta-Forms (IIS)
    • Forms data types
    • Meta-Forms Builder Guide
      • Create a dynamic meta-form with tables
      • Create a dynamic meta-form example with Form Designer
      • Add links to a form
      • Rich text editing in forms
  • Data syncs
    • Get started with data syncs
    • IIS installation
      • Install Connections
      • Install the Worker/Listener
      • Install the Connections CLI
    • Build data syncs
      • Data sync types
      • Design patterns
      • Sync actions
      • Columns and mappings
        • Calculated column examples
      • Advanced settings
        • Filters
        • Variables
        • Auth requests
        • Request headers
        • Post sync scripts
        • Pagination
      • Batch data sync example
      • Real-time sync example
      • Schedule a data sync
      • Connection functions
    • Data sync sources
      • Cinchy Event Broker/CDC
        • Cinchy Event Broker/CDC XML config example
      • Cinchy Table
        • Cinchy Table XML config example
      • Cinchy Query
        • Cinchy Query XML config example
      • Copper
      • DB2 (query and table)
      • Dynamics 2015
      • Dynamics
      • DynamoDB
      • File-based sources
        • Binary file
        • Delimited file
        • Excel
        • Fixed width file
        • Parquet
      • Kafka Topic
        • Kafka Topic example config
        • Apache AVRO data format
      • LDAP
      • MongoDB collection
        • MongoDB collection source example
      • Mongo event
      • MongoDB collection (Cinchy event)
      • MS SQL Server (query and table)
      • ODBC Query
      • Oracle (query and table)
      • Polling event
        • Polling event example config
      • REST API
      • REST API (Cinchy event)
      • SAP SuccessFactors
      • Salesforce Object (Bulk API)
      • Salesforce platform event
      • Salesforce push topic
      • Snowflake
        • Snowflake source example config
      • SOAP 1.2 web service
      • SOAP 1.2 web service (Cinchy Event Triggered)
    • Data sync destinations
      • Cinchy Table
      • DB2 table
      • Dynamics
      • Kafka Topic
      • MongoDB collection
      • MS SQL Server table
      • Oracle table
      • REST API
      • Salesforce
      • Snowflake table
      • SOAP 1.2 web service
    • Real-time sync stream sources
      • The Listener Config table
      • Cinchy Event Broker/CDC
      • Data Polling
      • Kafka Topic
      • MongoDB
      • Salesforce Push Topic
      • Salesforce Platform Event
    • CLI commands list
    • Troubleshooting
  • Other Resources
    • Angular SDK
    • JavaScript SQK
Powered by GitBook
On this page
  • Overview
  • Prerequisites
  • SQL Service Broker setup
  • Download the resources
  • Event Listener
  • Worker
  • Event Listener deployment
  • Worker Deployment
  • Known issues: Warning messages during listener deployment
  1. Data syncs
  2. IIS installation

Install the Worker/Listener

PreviousInstall ConnectionsNextInstall the Connections CLI

Last updated 1 year ago

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

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

  2. Enable the SQL Service Broker using the command:

ALTER DATABASE [Your Cinchy Database Name] SET ENABLE_BROKER WITH ROLLBACK IMMEDIATE;

Download the resources

Event Listener

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

  2. Extract the .zip file to your designated directory. For example, C:\your event listener folder.

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

Worker

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

  2. Unzip the content of the Cinchy Worker folder to, for example, C:\your CLI worker folder.

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

Event Listener deployment

  1. Open the appSettings.json file in your Event Listener directory and configure:

ClientSettings

Parameter
Value

URL

Cinchy Web URL (e.g., https://cinchy.net/Cinchy)

Password

Password for the user: eventlistener@cinchy.com

AppSettings

Parameter
Value

GetNewListenerConfigsInterval

(seconds) Frequency at which the listener checks for new configs in the [Cinchy].[Listener Configs] table. Default is 60 seconds.

ConnectionStrings

Parameter
Value

SqlServer

Connection string to the SQL server that hosts the Cinchy database.

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

  1. Open the appSettings.json file in your Worker directory and configure:

ClientSettings

Parameter
Value

URL

Cinchy Web URL (e.g., https://cinchy.net/Cinchy)

Password

Password for the user: connections@cinchy.com

AppSettings

Parameter
Value

Model

Cinchy. This specifies the model for the CLI.

TempDirectory

Temporary directory for the CLI to store files.

ConnectionStrings

Parameter
Value

SqlServer

Connection string to the SQL server that hosts the Cinchy database.

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

Warning! The maximum key length for a clustered index is 900 bytes. The index 'PK_Conversations' has maximum length of 1768 bytes. For some combination of large values, the insert/update operation will fail.
Nonqualified transactions are being rolled back. Estimated rollback completion: 0%.
Nonqualified transactions are being rolled back. Estimated rollback completion: 100%.

Navigate to the .

.NET Core 3.1 Hosting Bundle
Cinchy Releases table