Cinchy Platform Documentation
Cinchy v5.8
Search
K
Comment on page

The Listener Config table

Overview

The Listener Configuration table lets you set up your stream source configurations for real-time syncs via the Connections UI, and you can find that information on the relative Data Sync Source page.. It's also important to track your real-time syncs. As of Cinchy v5.7, you can now set up your listener configuration on the Sources tab under the Listener section of the Connections experience. If your data sync requires more than one listener, you must set up additional configurations via the Listener Config table on your Cinchy platform.
You can also use this table to manage and review all the configurations currently set up on your system (Image 1). Most of the columns within the Listener Config table persist across all Stream Sources, however exceptions will be noted. You can find all of these parameters and their relevant descriptions in the tables below.
Image 1: The Listener Config table

Configure the listener

General Parameters
Topic
Connections Attributes
The following column parameters can be found in the Listener Config table:
Parameter
Description
Example
Name
Mandatory. Provide a name for your listener config.
CDC Real-Time Sync
Event Connector Type
Mandatory. Select your Connector type from the drop down menu.
Cinchy CDC
Topic
Mandatory. This field is expecting a JSON formatted value specific to the connector type you are configuring.
See the Topic tab.
Connection Attributes
Mandatory. This field is expecting a JSON formatted value specific to the connector type you are configuring.
See the Connection Attributes tab.
Status
Mandatory. This value refers to whether your listener config/real-time sync is turned on or off. Make sure you keep this set to Disabled until you are confident you have the rest of your data sync properly configured first.
Disabled
Data Sync Config
Mandatory. This drop down will list all of the data syncs on your platform. Select the one that you want to use for your real-time sync.
CDC Data Sync
Subscription Expires On
This value is only relevant for Salesforce Stream Sources. This field is a timestamp that's auto populated when it has successfully subscribed to a topic.
Message
Leave this value blank when setting up your configuration. This field will auto populate during the running of your sync with any relevant messages. For example, **Cinchy listener is running**, or **Listener is disabled**.
Auto Offset Reset
Earliest, Latest or None. In the case where the listener is started and either there is no last message ID, or when the last message ID is invalid (due to it being deleted or it's just a new listener), it will use this column as a fallback to determine where to start reading events from.
Earliest will start reading from the beginning on the queue (when the CDC was enabled on the table). This might be a suggested configuration if your use case is recoverable or re-runnable and if you need to reprocess all events to ensure accuracy. Latest will fetch the last value after whatever was last processed. This is the typical configuration. None won't read start reading any events. You are able to switch between Auto Offset Reset types after your initial configuration through the process outlined here.
Latest
Information about setting up your Topic JSON can be found on the individual real-time sync stream source configuration pages.
Information regarding setting up your Connection Attribute(s) can be found on the individual real-time sync stream source configuration pages. - Cinchy Event Broker/CDC - Data Polling Source - Kafka Topic - MongoDB (Event Triggered) - Salesforce Push Topic - Salesforce Platform Event