Skip to main content

Layout Builder

Layout Builder is a visual tool that lets you define the structure of data records for use in integrations, without writing code. By describing how your data is organized, you give the platform the information it needs to read, transform, and write data correctly as it moves between systems.

What Layout Builder does​

When data flows through an integration, the platform needs to understand the shape of that data: what fields exist, how records are grouped, and how sections relate to one another. Layout Builder is where you provide that description. The result is a reusable layout definition that can be attached to integration flows so the platform knows how to parse incoming data or produce outgoing data in the right format.

Supported data formats​

Layout Builder supports a range of data formats, each with its own dedicated creation experience:

FormatDescription
TextDelimited or character-separated flat files
PositionalFixed-width flat files where fields occupy defined character positions
Advanced PositionalPositional files with more complex record structures, including hierarchical records
ExcelSpreadsheet files, including multi-sheet workbooks
PDFPDF document layouts
XMLXML-structured data
JSONJSON-structured data
Advanced DatabaseDatabase table and query-based layouts

Creating a layout​

When you create a new layout, a guided form collects the basic information the platform needs before you begin defining records. Depending on the format you choose, you can provide a sample data file to let the platform pre-populate the record structure, import an existing layout definition file, or build the structure from scratch by defining records and fields manually.

The Layout Builder editor, with the record definition panel and section list visible side by side.
The Layout Builder editor, with the record definition panel and section list visible side by side.

Defining records and fields​

Once a layout is created, the main editor lets you build out the record structure. A layout is made up of one or more records, and each record contains fields. You can:

  • Add, edit, and remove records and fields
  • Reorder fields within a record by dragging them
  • Organize records into parent-child hierarchies for nested or relational data structures
  • Mark records as control total records, which are visually distinguished from standard table records

The editor is divided into two main areas: a record selection panel where you pick which record you are working on, and a definition panel where you configure the details of that record and its fields. Both panels can be resized, collapsed, or expanded to full screen so you can focus on the part of the work that matters most at any given moment.

Editing layout settings​

After a layout is created, you can revisit its top-level settings at any time using the Settings button in the header. This opens a panel where you can adjust format-specific options such as encoding, header presence, field separators, and other properties that govern how the platform interprets the data file as a whole.

You can also update the layout name and description directly from the header by clicking the edit icon next to the layout name. The name must be unique and follow the required naming rules.

Testing a layout​

The Test view lets you verify that your layout definition works correctly against real data before using it in a live integration. You upload a sample file, and the platform parses it using your layout definition and shows you the resulting output alongside any errors. This makes it straightforward to catch structural mismatches early.

For Excel layouts, if the test produces a spreadsheet output, you can download the resulting file directly from the test view.

XSD view​

For layouts that support it, an XSD View tab displays the generated schema definition that the platform derives from your record and field structure. You can download this file for reference or for use in external tools.

Saving and exiting​

The header provides three options for finishing your work:

ActionWhat it does
SaveSaves the current layout definition without closing the editor
Save & ExitSaves the layout and returns you to the previous screen
CloseExits the editor; any unsaved changes are not saved

The platform validates the layout before saving. If there are unresolved errors in the record or field definitions, it notifies you and prevents saving until those issues are addressed.

Copying a layout​

You can create a copy of an existing layout. You can then modify the copy independently without affecting the original.