Headers and footers are also known as leading and trailing records and are used to provide additional data. They are generally used for processing and auditing an integration in a target system, such as client ID or a count of individual records. When you configure headers or footers in your integration, the header is shown once at the top of a file and the footer is shown once at the bottom of a file.
To configure a header or a footer in an integration:
- Click Create Integration in Integrations > Integration Studio.
- Select the connector you want to use to configure your integration.
- Click Add in the mapping step.
- Select Parent from the Type drop-down list in the Add Element dialog box.
- Important: Do not select the Is Array checkbox.
- Click Save.
- Put the data fields under the parent field you created to create a header or place the parent field at the bottom to create a footer.
You can configure an integration to have multiple headers or footers, if required. The image below illustrates a configuration that returns two headers. Client is the first header and it has the ID field nested underneath it. PayRun is the second header and it has the PayDate, PPStart, and PPEnd fields nested underneath it.
In the image above, the root, Client and PayRun fields are not arrays whereas, the Data field is an array. As a result, the fields that are under the Client and PayRun parent fields are shown once at the top of the file, and the fields under that Data parent field are repeated for every record in the source.
| Output Type | Description of Limitation |
|---|---|
|
JSON Segmented Character-Separated Values/Delimited Text File |
When the root field is an array, headers and footers are repeated for every record in a source. |
|
Fixed Width Text File Segmented Fixed Width File |
Each row in a file must have the same total width, including the headers and footers. |
Important: Headers and footers cannot be configured in integrations that use the Character-Separated Values/Delimited Text File output type. To use headers in a CSV file, you must configure your integration to use the Segmented Character-Separated Values/Delimited Text File output type.