Cinchy Query Data Source Example

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

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>

Last updated