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
  • 1. Connections UI Example
  • 2. XML Example
  • 2.1 Blank XML Example
  • 2.2 Populated XML Example

Was this helpful?

  1. Builder Guide
  2. Configuring a Data Sync
  3. Supported Data Sources
  4. Cinchy Query

Cinchy Query Data Source Example

This page outlines an example data sync using a Cinchy Query as a source

PreviousCinchy QueryNextCopper

Last updated 2 years ago

Was this helpful?

1. Connections UI Example

The following shows how the configuration of a Cinchy Query data source looks in the Connections UI (Image 1).

2. XML Example

This example XML uses the following values:

Value

Description

Example

DOMAIN

The domain where your Cinchy Query resides.

"Product"

QUERY NAME

The name of your synced query.

"TestQuery"

PARAMETERS

An XML-encoded JSON representation of any parameters and their corresponding values.

{"value1":"@value1"}

TIMEOUT

Timeout in number of seconds (the default is 30).

"100"

SOURCE_COLUMN_NAME

The name(s) of your source column(s)

"Age"

DATA_TYPE

The data type of your source column

"Number"

IS_MANDATORY

Whether the column is mandatory or not

"false"

VALIDATE_DATA

Whether the column data needs to be validated or not

"false"

2.1 Blank XML Example

<CinchyQueryDataSource 
    domain="DOMAIN" 
    name="QUERY NAME" 
    parameters="PARAMETERS"> 
  <Schema>
  <Column name="SOURCE_COLUMN_NAME" dataType="DATA_TYPE" isMandatory="IS_MANDATARY" validateData="VALIDATE_DATA"/>
  </Schema>
</CinchyQueryDataSource>

2.2 Populated XML Example

 <CinchyQueryDataSource 
 domain="Product"
 name="TestQuery"
 timeout="100"
 parameters="{&quot;value1&quot;:&quot;@value1&quot;}">
        <Schema>
            <Column name="Name" dataType="Age" isMandatory="false" validateData="false"/>
    </CinchyQueryDataSource>
Image 1: How the configuration of a Binary File source looks in the UI