Business-Document: Definition Tab

About the Definition tab

Using the icon bar

Business-Document field properties

About the Definition tab

The Business-Document Definition tab is illustrated schematically below.

Icon bar for manipulating the fields in the selected Business-Document
Tree structure of selected Business-Document Properties of each Leaf Element in the selected Business-Document:
Name Position Business-Field Class Data type Definition Label

Using the icon bar

Use the icon bar to perform the following actions on fields in the Business-Document tree structure:

The set of icons displayed in the icon bar depends on the type of field you select in the Business-Document tree structure in the left pane. Composer only displays the icons that apply to the selected field.

Adding fields

To add a field, first select the field above the point where you want to insert the new field. When you click one of the field icons, Composer adds a new field of the selected type, either directly below the selected field, or below the last field in the group (typically the last Child of the selected field).

The following table summarizes the icons you can use to add fields to the tree structure:

Click To

add a Leaf Element field after the selected field. By default the field added is of data type A256.

add a Filler field after the selected field. By default the Filler field added is of data type A1.

Note: A Filler field separates and groups sets of Leaf Elements

import a leaf element from a file.

For more information refer to the CSV Importer topic.

Deleting fields

To delete a field from the tree structure, select the field you want to delete and click .

Repositioning fields

Use the following icons to move fields inside the tree structure:

Click To move the selected field

up in the tree structure.

down in the tree structure.

out one level in the tree structure.

This icon converts the selected field into a sibling of the field where it previously nested

in one level in the tree structure.

Use this icon to redefine a field by nesting it within the field that precedes it in the tree structure. Composer automatically recalculates the total length of the parent field.

Copying and pasting fields

You can copy and paste fields in the tree structure in the left pane:

  • into the same Business-Document
  • into a different Business-Document

To copy a field, select it and click .

To paste the object:

  • as a child of the selected field, click
  • as a sibling of the selected field, click

If you copy and paste a parent field, you also copy and paste all the descendants of the selected field.

Searching for fields

To search for a specific field in the tree structure:

  1. To search:
    • The entire Business-Document, select the root of the Business-Document
    • A particular portion of the Business-Document, select the relevant parent field
  2. Click on the icon bar.
  3. Enter the field name in the Find window and click OK.

Composer runs the search and stops at the first occurrence it finds of the field name.

Business-Document field properties

Use the right pane to define the properties of each field. Each column name in the right pane corresponds to one field property. When you add a field in the left pane, Composer automatically adds a line to the right pane. In addition, Composer enters the appropriate default values in the added line. You cannot modify values that are displayed in gray cells. These are either values that Composer calculates automatically or they indicate that the Business-Document you are modifying is read-only ()

When you add a:

  • Filler: Define the name and length properties in the Name and Definition columns of the right pane.
  • Field: Define all the field properties in the right pane. To view and define all of the field properties, select the field in the tree structure, and the n click the column corresponding to the property you want to set.

Composer allows you to use either of the following methods to set the properties, depending on the column:

  • type in the value directly
  • select a value from a drop-down list

Defining Business-Document field properties

Define the following properties for the fields in the Business-Document:

Field Contents

Name

(Mandatory)

Enter the mandatory name for the selected field. Maximum length is ten characters. Respect the naming conventions.

Position

This column is displayed for information purposes only.

The Position column displays the position of the filed in the given segment. You cannot directly modify this attribute as Composer updates it automatically either when you change the Definition attribute of other fields in the Business-Document or you redefine the field.

Business-Field

To apply an existing Business-Field as a template definition to the field, select a Business-Field from the drop-down list. Composer automatically completes the other fields for this field with the values defined in the General and Definition tabs for the selected Business-Field.

You can overwrite the Label field.

Class

(Mandatory)

If you select a field as opposed to a filler, you must select the mandatory Data Class. The Data Class describes the data that can be contained in the selected field.

Composer sets the Type attribute with values that correspond to the Data Class that you select.

Type

(Mandatory)

Select the mandatory Data Type of the selected field. Composer only displays the Data Types that are appropriate for the Data Class that you selected in the Class field.

Definition

Set the maximum length for the selected field.

[FOR DETAILS: Data Type reference table]

Decimal definition

If Decimal Number Type is selected, this field is mandatory.

You can enter:

  • Either a value.
  • Or the name of a numeric field in the Business-Document that contains the value.

Label

You can enter an optional description of the type of data that the selected field will contain. This description appears only on this tab.

Back to top

Related Links