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

Was this helpful?

  1. Builder Guide
  2. Configuring a Data Sync
  3. Connections Experience & XML Config Reference

Source Config Reference

PreviousString EscapeNextSchema Columns

Last updated 2 years ago

Was this helpful?

The source always contains a schema, which is an array of elements and/or elements. Optionally you can also add a element and an actionTypeColumn attribute (details of this attribute are at the end of this page). Below is an example of the Source page where the data source is chosen as a :

On top of Cinchy Table, there are many other types of data sources and each data source type will have a different set of attributes supported.

If the data source is , , or then there is the option to load metadata using the dialog, which assists the user in loading the columns they want to sync.

Note: The Username/Password must belong to a non-Single Sign On Account which has access to the Source Table.

Attributes:

actionTypeColumn

(Optional) Specify a column from the schema that provides instructions on whether the record is an UPDATE, DELETE or INSERT, doing so will bypass the reconciliation process using the specified instruction.

  <Datasource actionTypeColumn="ExampleColumn">
    <Schema>
      <Column name="Source Column Name"/>
      <Column name="ExampleColumn"/>
      <CalculatedColumn name="Source Calculated Column Name" formula="CONCAT(a,b)" />
        ...
    </Schema>
    <Filter>filter condition</Filter>
  </DataSource>

More information on how to use the Load Metadata dialog can be found in the .

For all other data sources there is no Load Metadata dialog. The page has a full list of all data sources and their varying attributes.

Note: In the Connections experience, actionTypeColumn is on the page.

Below is an XML snippet using actionTypeColumn, and .

Connections Usage Example
Supported Data Sources
Sync Behaviour
Column
, Calculated Column
Filter
Column
Calculated Column
Filter
Cinchy Table
Cinchy Query
Cinchy Table
Delimited File
MS SQL Server