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).
Defining Data Format
Data format informs DSYNC about the format of incoming/outgoing data. You can select one of the supported data formats at the top of the data layout page by clicking on the data format icon. The supported data types are: JSON, XML, CSV, XLS, XLSX, ODS, and TXT.
- To select data format, simply click on one of the icons representing the format of your choice.
- Depending on your format selection, you may be presented with more options (eg. Delimiter for CSV, or character encoding). Make sure these are entered correctly.
Defining Data Layout Structure (Fields)
There are four ways to define data layout’s structure for an endpoint and you can combine these to simplify the workload:
- Fully Manual
- Using the Editor
- Using a Sample File Uploader
- Selecting Existing Data Layout
For simple data layouts, you may choose to create all fields manually. Adding fields manually one by one allows you to define every single attribute of each field.
- Under the ‘Fields’ section on the data layout page, click the ‘+ADD FIELD’ button.
- As a minimum, you must enter the fields ‘name’. Optionally, you may choose to check the field as mandatory or multiple, define the data type, or add different transformation and validation functions on the field etc.
- Click ‘OK’ to add your field onto the data layout.
- Repeat steps 1-3 until you have defined all fields for your endpoint.
The editor allows you to paste a sample XML or JSON formatted string into a modal window. The pasted string is then analysed by DSYNC which generates fields based on the structure of the string you have pasted in.
- Under the ‘Fields’ section on the data layout page, click the ‘EDITOR’ button.
- At the top of the editor window, select either XML or JSON.
- Paste a sample string into the main editor window and click ‘OK’.
- You should see all your fields generated from the sample string being appended to the end of your data layout structure.
Adding fields to data layout using the editor does not remove any of the pre-existing data layout fields you might have added manually or using a different method. You can combine the editor with manual field creation, sample file uploader, or template selector.
You should always review the automatically generated fields and adjust their data types and other attributes as necessary (eg. Required attribute).
Using Sample File Uploader
Sample file uploader is similar to the editor but is not limited to only JSON and XML. It allows you to upload a file in any of the supported data formats and generate fields based on the uploaded file.
- Under the ‘Fields’ section on the data layout page, click the ‘FILE’ button.
- Upload a sample file using the dropzone widget and click ‘OK’. Note: The file extension must match the file format selected (eg. JSON file format selected - file extension must be .json).
- You should see all your fields generated from the sample file appended to the end of your data layout structure.
As with the editor, all fields generated and added using the Sample File Uploader are appended to the end of your data layout. Existing fields are lost in the process and so you can combine the file upload with any other methods of adding fields on the data layout.
Selecting Existing Data Layout
All data layouts, both predefined data layouts on endpoints which come with systems you add using the Wizard and the data layouts you define manually, are automatically saved in your account as templates. You can reuse an existing data layout anywhere you see fit.
- Under the ‘Fields’ section on the data layout page, click the ‘TEMPLATE’ button.
- Select a data layout you want to use from the available data layouts list.
- All fields from the data layout you’ve selected should appear appended to the end of your data layout.
As with the editor and sample file uploader, using the template functionality is non-destructive. All fields from the data layout you’ve selected to use are appended to the end of your existing data layout. No pre-existing fields are removed.