Skip to content

Design - XML File Definitions ​

Clicking Design, opens the XML Definition designer canvas. This area creates, maintains, and displays dataviews belonging to your XML Definition - regardless of whether they apply to Source or Destination files.

These dataviews tell Statelake what files and records are to be used, and how they are to be used.

INFO

Always create a highest level XML dataview for the entry point within the Schema file. And in that dataview, include all relevant elements at that level in the structural shape of the schema.

Create a new dataview for each set of elements that repeat under a higher level - such as where order lines repeat under the same order header or number.

The first time this is opened for your File Definition, this designer canvas will be blank.

image-20240418-024217.png

On the designer canvas there is a different dataview for each file type as selected - an XML File generates an XML Dataview.

Existing File Definition Dataview ​

If one or more XML Dataview already exists, then these will display here on the designer canvas, as illustrated below.

image-20240417-015854.png

A single existing Dataview

image-20240425-230043.png

Multiple existing linked Dataviews

Where a dataview exists and displays on the design canvas, the various tabs are accessible via the buttons on the dataview.

Dataview Tabs ​

Tab NameDescription
PreviewClick to see a preview of the data extracted by the query.
image-20240417-020954.png
RecordsClick to open the Records tab.
image-20240417-021053.png
FieldsClick to open the Fields tab.
image-20240417-021149.png
CalcsClick to open the Calcs tab.
image-20240417-021309.png
LinkClick to open the Link settings window. This will only be available to select where the dataview has a link to another dataview, or where there multiple dataviews but there are no links.
image-20240417-021706.png

New File Definition Dataview ​

To create the initial dataview on an empty canvas for a new XML Definition, or to add another dataview, select File and New (or Ctrl-N) to create a new dataview to configure.

While the following examples illustrate a XML Dataview, all dataviews are created in the same manner.

image-20240417-020336.png

Make sure to select the appropriate dataview - in this case it is an XML Dataview. Click on OK to continue.

image-20240417-020525.png

Buttons ​

Button NameDescription
OKClick to save any changes you have made. All changes will be lost if you do not click the OK button.
CancelClick to Cancel any changes you have made.