Kourier Integrator Online Help

REST Export Fields Line Item

Purpose

To define the fields to be included in the REST Export Specification data export file, the SQL column headings to use, and any data conversions or formulas required.

Available Toolbar Commands

Click the Done icon in the toolbar to save the current line item and return to the export specifications main page.

Click the Add icon in the toolbar to save the current line item, clear all fields and keep the window open so that you can add another line item, which will be the last line number available.

Click the Remove icon in the toolbar to delete the current line item, close the window and return to the export specifications page.

Click the Up icon in the toolbar to move the line item up in the line item list relative to the other line items, thereby decreasing the current line item number. Click Done or Add to save your change.

Click the Down icon in the toolbar to move the line item down in line item list relative to the other line items, thereby increasing the current line item number. Click Done or Add to save your change.

Click the Help balloon to open the help for this page.

To save any changes you make after creating or editing Export Line Items you must save your changes using either the New, Save, or Save As toolbar commands.

File/Key Field

KT_EXPORTS/Export Name

Prerequisites

If an export contains user-defined literals, they should be entered using Substitution Literals.

Line Item Fields

Field Name

Description - Usage - Notes

Line

The order sequence this field should appear in the export.

Field/Position

Enter a valid A, D, I, S or V type dictionary item. You can also click the Search icon  to select a data defining or virtual field from the Selected Data File. This field may also contain substitution tags.

It is acceptable to reference a field simply by entering its attribute number (0, 1, 2...). This feature is quite useful when you want to isolate the data you are extracting from a defined dictionary and its format or when you are exporting items from a temporary file.

Column Heading

Enter the SQL column heading for this exported field. This field is used when building SSIS Packages in order to update the SQL table. If the DDL button is used, the column heading will be used for the SQL table column names.

Conversion

Enter any valid dictionary conversion code, substitution parameter, or a literal string. This code will override the conversion code in the dictionary item. Multiple conversions may be separated by the | (pipe) character.

Formula

Enter a user-defined formula for this field using standard UniBASIC syntax and commands. The results of the formula will determine the final output value for this field. A formula icon will be displayed in the list view if there is a formula defined for a field. Hover your mouse over the icon to see the note.

Field Type

Select a field type from the Field Type drop-down menu. A detailed list of Field Types and their example usage can be found here.

Format

This field is only used when an export is generated in FIXED format. It is used to over-ride the length of the output and the justification of the output (e.g. 10L for 10 characters, left justified).

Association

Depending upon the export format or the command used, this column is used in different ways.
If the export is generated in XML format, it is used to group repeating values or line items by including the association name as a tag in the XML document. Up to two levels of tags can be specified (corresponding to associated values and sub-values) by separating them by the | character. The association name may not contain any white space. See Association Detail .

Comments

Enter any comments you wish to describe or document this export field. A note icon will be displayed in the list view if there is a formula defined for a field. Hover your mouse over the icon to see the note.