Cinchy Query

1. Overview
Cinchy queries are commonly used data sync sources that leverage the platform's Saved Query functionality. For more on creating Saved Queries, please review the documentation here.​
Example Use Case: You want to set up batch sync between a Cinchy Query and a Cinchy Table. You query polls for any unapproved timesheets, out of office requests, or sick hours and, if found, adds them to an "Open Approval Tasks" table. 
​
2. Info Tab
You can review the parameters that can be found in the info tab below (Image 1).
Values
Parameter
Description
Example
Title
Mandatory. Input a name for your data sync
Open Approval Tasks
Version
Mandatory. This is a pre-populated field containing a version number for your data sync. You can override it if you wish.
1.0.0
Parameters
Optional. Review our documentation on Parameters here for more information about this field.
​
Image 1: The Info Tab
3. Source Tab
The following table outlines the mandatory and optional parameters you will find on the Source tab (Image 2).
Source Details
Schema
The following parameters will help to define your data sync source and how it functions.
Parameter
Description
Example
Source
Mandatory. Select your source from the drop down menu.
Cinchy Query
Domain
Mandatory. The domain where your source query resides.
Compliance
Table Name
Mandatory. The name of you source query.
Open Tasks
Timeout
Optional. The timeout, in number of seconds, for your source query. If not entered this value will default to 30.
120
Parameters
Optional. Review our documentation on Parameters here for more information about this field.
​
The Schema section is where you define which source columns you want to sync in your connection. You can repeat the values for multiple columns.
Parameter
Description
Example
Name
Mandatory. The name of your column as it appears in the source query.
Owner Cinchy ID
Alias
Optional. You may choose to use an alias on your column so that it has a different name in the data sync.
​
Data Type
Mandatory. The data type of the column values. 
Text
Description
Optional. You may choose to add a description to your column.
​
​
There are other options available for the Schema section if you click on Show Advanced.
Parameter
Description
Example
Mandatory
If both Mandatory and Validated are checked on a column, then rows where the column is empty are rejected
If just Mandatory is checked on a column, then all rows are synced with the execution log status of failed, and the source error of "Mandatory Rule Violation"
If just Validated is checked on a column, then all rows are synced.
​
Validate Data
If both Mandatory and Validated are checked on a column, then rows where the column is empty are rejected
If just Validated is checked on a column, then all rows are synced.
​
Trim Whitespace
If your data type was chosen as "text", you can choose whether to trim the whitespace (that is, spaces and other non-printing characters).
​
Max Length
Optional. You can input a numerical value in this field that represents the maximum length of the data that can be synced in your column. If the value is exceeded, the row will be rejected (you can find this error in the Execution. Log).
​
Image 2: Define your Source
4. Next Steps
Configure your Destination​
Define your Sync Behaviour.
Add in your Post Sync Scripts, if required.
Define your Permissions.
Click Jobs > Start a Job to begin your sync.

Parameter	Description	Example
Title	Mandatory. Input a name for your data sync	Open Approval Tasks
Version	Mandatory. This is a pre-populated field containing a version number for your data sync. You can override it if you wish.	1.0.0
Parameters	Optional. Review our documentation on Parameters here for more information about this field.

Parameter	Description	Example
Source	Mandatory. Select your source from the drop down menu.	Cinchy Query
Domain	Mandatory. The domain where your source query resides.	Compliance
Table Name	Mandatory. The name of you source query.	Open Tasks
Timeout	Optional. The timeout, in number of seconds, for your source query. If not entered this value will default to 30.	120
Parameters	Optional. Review our documentation on Parameters here for more information about this field.

Parameter	Description	Example
Name	Mandatory. The name of your column as it appears in the source query.	Owner Cinchy ID
Alias	Optional. You may choose to use an alias on your column so that it has a different name in the data sync.
Data Type	Mandatory. The data type of the column values.	Text
Description	Optional. You may choose to add a description to your column.

Parameter	Description	Example
Mandatory	If both Mandatory and Validated are checked on a column, then rows where the column is empty are rejected If just Mandatory is checked on a column, then all rows are synced with the execution log status of failed, and the source error of "Mandatory Rule Violation" If just Validated is checked on a column, then all rows are synced.
Validate Data	If both Mandatory and Validated are checked on a column, then rows where the column is empty are rejected If just Validated is checked on a column, then all rows are synced.
Trim Whitespace	If your data type was chosen as "text", you can choose whether to trim the whitespace (that is, spaces and other non-printing characters).
Max Length	Optional. You can input a numerical value in this field that represents the maximum length of the data that can be synced in your column. If the value is exceeded, the row will be rejected (you can find this error in the Execution. Log).

Cinchy Table XML Config Example

Cinchy Query XML Config Example

Last modified 3mo ago