What is a Data Layout: A data layout is the schema or structure on a particular system. Data layouts are the format and structure required on the system side to be able to streamline data being processed into or out of the system. Data layouts can be simple; i.e. it can contain one endpoint or multiple endpoints for synchronization.
View the API portal notes on data layouts
To access endpoint’s data layout please refer to ‘Working with DSYNC’ section.
Every endpoint on the canvas must have a data layout defined to allow connection with other endpoints.
Data layout describes the structure of data as sent from external system to DSYNC (source endpoint data layout) and from DSYNC to target location (destination endpoint data layout).
The only time when you are not required to define a data layout for endpoint manually is when you add a system using the Wizard. All systems added on the canvas using the Wizard come with predefined endpoints with existing data layouts. All you need to do when you are connecting such two endpoints is create a link and define mapping. Any other endpoint will require you to define a data layout manually.
Endpoint data layout page consists of two separate sections: Data Format, and Data Structure (fields).
Each element/endpoint on the canvas must have a data layout defined to be linked and able to transfer data. Data layout defines the type and structure of the incoming or outgoing data.
Accessing Element's Data Layout
To access element's data layout settings, select the element on the canvas, and choose either 'New', 'Select', or 'Edit' existing data layout in the right sidebar.
Tip: double-click an element on the canvas to quickly access its data layout.
DSYNC can work with the following data types:
- JSON - objects
- XML - objects
- CSV - tabular (delimiter can be set to any symbol)
- XLS(x) - tabular
- ODS - tabular
- TXT - tabular/fixed width
Data structure can be modelled by adding and positioning fields on the data layout page. Depending on the Data Type selected you can either model flat data structure (tabular format such as CSV, XLS, ODS) or complex data structure with objects and arrays (JSON, XML). All fields on the data layout are draggable.
Drag-n-drop a field vertically to change its position within the data layout.
Drag-n-drop a field horizontally to nest fields (create parent-child relationships). Horizontal dragging is only available underneath fields of type 'object'.
Objects are available only with data type JSON and XML. Arrays can be configured using field's attribute 'Multiple'.