XML definitions for a template

BASE
IMS

Values:

• COBOL
• PLI
• ASM

Values:

• BASE
• IMS™
• IMSVIEW
• IMSCRIT
• Db2®
• DYNAMIC

Values:

• 0
• 1
• true
• false

IMS
IMSVIEW
IMSCRIT

IMS
IMSVIEW
IMSCRIT

IMS
IMSVIEW
IMSCRIT

max="nnn" Integer

Enter a number to be used as the default maximum number of target database records to be selected per source database record for the listed logical and application relationships.

If you do not specify, there is no default maximum selections per database record.

Values:

1

Selected

0

Not selected

Values:

1

Selected

0

Not selected

Enter a number to be used as the maximum number of target database records to be selected per source database record for the listed logical and application relationships.

If you do not specify, the relcrit max value is used if specified. If both are unspecified then there is no limit. It is recommended that a value of 2 or 3 is used for bidirectional logical relationships.

Values:

1

Selected

0

Not selected

BASE
IMS

This is a COBOL ONLY option which changes the way the level value (specified below) is processed. If you set this option then every occurrence of the specified level value is changed to 01 before the compile step, irrespective of whether the data item has a redefines clause. This option should be used with care as it may result in incorrect offsets to data items, or compile errors as the structure is changed from its intended programmable form.

This value is used when you have a structure that has defined multiple layouts using COBOL redefines or PL/I unions. File Manager creates a separate record layout or each redefines clause at the given level. After the first matching redefines is found, File Manager creates new layouts for the next and subsequent redefines for the same level and start location. Header and trailing data items are included in each record layout. This field is ignored for Assembler copybooks.

File Manager uses this value to determine the redefines, union or org statements that are to be represented in a new layout. This is an alternative way of identifying redefines, union and org statements that require new layouts to be generated. You can specify both Level and Field name values and File Manager checks both when generating new layouts.

BASE
IMS

<cbladdop>compiler options</cbladdop>

BASE
IMS

<pliaddop>compiler options</pliaddop>

BASE
IMS

<asmaddop>compiler options</asmaddop>

BASE
IMS

IMS
IMSVIEW
IMSCRIT

IMS
IMSVIEW
IMSCRIT

type="ID"

Identification criteria

type="SEL"

Selection criteria

type="RID"

Related identification criteria

<exp><![CDATA[ my expression]]></exp>

<oper><![CDATA[ < ]]></oper>

As operators generally contain special XML characters it is advisable to specify using CDATA as follows:

<oper2><![CDATA[ <]]></oper2>

It must not exceed 255 characters.

For example, width="10" sets a display width of 10.

Specify this value to provide a key sequence number used to define the composite key field for data set comparison.

This is a sequence number for Db2® templates that indicates how to order the data based on the data values for the column, when the data is retrieved from Db2®.

This is only valid when db2ord is specified and indicates whether the data retrieved from Db2® is to be in A(ascending) or D(descending) order.

This is the field or column reference number and is used to identify the field.

<heading>Myfield name</heading>

If not specified or 0 then the length of the segment is the length value provided in this field.

Specifies the initial value you want a field to contain, before being adjusted by the increment you specify. The value must be a number that, when converted to the appropriate numeric data type, the field can hold, and, for a field with decimal places, must not specify more decimal integers than the number of decimal places in the field definition.

If you specify a negative number, the sign is honored, even if the field is unsigned.

If the field is a floating-point field, the start value can be specified as a floating-point number consisting of a mantissa and an exponent (such as -1.14579E01). The mantissa consists of an optional sign (+ or -) followed by 1 to 16 digits. The mantissa can also contain a decimal point. The exponent consists of the letter E, an optional sign (+ or -), and 1 or 2 digits.

Specifies the maximum value (if the increment is a positive number) or minimum value (if the increment is a negative number) you want a field to contain. See rules for start attribute in specifying the number.

Specifies a positive or negative number by which you want the value in the field adjusted for each record (or cycle of records). See rules for start attribute in specifying the number.

Specifies the number of output records that are to be generated before the increment value is applied to the field value. For example, if you specify a field start value of 100, an increment value of 10, and a cycle value of 3, the field in the first three records contains 100, 110 in next three records, 120 in the next three records, and so on.

If cycle is zero, the value in the field is always set to the start value.

Specify a date value to be used when creating a new row. The creation attribute is only used for those functions where FM/Db2 is to create rows, for example the create utility. You can specify a date value in the same format shown in the Format field. You can specify an = to indicate that the current date is to be used. When you specify this the current value is retrieved and replaces the = in the field. The value retrieved is a constant, so that if a create utility is run later, the same value is always used to populate the column.

You can specify * to indicate that the current date when the row is created should be used to populate the column. Specifying * indicates a variable value for the column when a create utility is run, since the value is the date on which the create utility is executed.

Specify an increment value to be used when creating multiple rows. Valid values are integers. A value of 1 indicates that each subsequent row should have a date value one day later than the previous date value. A value of -1 indicates that each subsequent row should have a date value one day earlier than the previous date value.

Repeat user pattern. Specify YES if you have provided a user-supplied pattern that is shorter than this field and you want the pattern to be repeated as many times as necessary to fill the field. By default, File Manager uses the fill character to pad the receiving field when the user-supplied pattern is shorter than the field. This option has no effect when the RA action is specified.

IBM®-supplied patterns are always repeated in a field, as necessary.

<filler>cccc</filler>

Specifies a value that is to be placed in each byte of the field before any other operation in the construction of the field. Can be one of:

char

A character such as 0 to be written in each byte.

X'cc'

A hexadecimal value, such as X'FF' to be written in each byte.

Start character

Sets the starting character to be used when you specify an IBM®-supplied pattern (AL, AN, or CO) or a user-supplied pattern (with the exception of RO, WV, and FX). The specified character must be one of the characters in the IBM®-supplied pattern or user-supplied pattern.

Default: First character in IBM®-supplied pattern or user-supplied pattern.

Specifies the pattern to be used when generating data for this field. You can specify either an IBM®-supplied pattern indicator or a user-supplied pattern. The user-supplied pattern can be either a character string or a hexadecimal string. A character string must be enclosed in quotation marks, while a hexadecimal string must be enclosed in quotation marks and be preceded by a X. The hexadecimal string must contain an even number of valid hexadecimal characters. The IBM®-supplied patterns you can specify are:

AL

Alphabetic - characters A-Z, inclusive.

AN

Alphanumeric - characters A-Z, 0-9 inclusive.

AX

Alphanumeric displayed in long hexadecimal.

CO

Collating sequence - all printable characters in the range X'40' - X'F9'.

If you provide a user-supplied pattern that is longer than the field, for actions other than RA and RP the pattern is first truncated on the right to fit the receiving field before the specified action is performed. For the RA action, characters are randomly selected from the entire user-supplied pattern. For the RP action, the entire pattern is rippled for each record before it is truncated to fit the receiving field. If you provide a user-supplied pattern that is shorter than the field, you can specify that you want the pattern to be repeated to fill the field.

Default: None

Blank

No scrambling is performed.

Value or range specifications are saved but ignored for the associated function.

1 (Random)

Performs random scrambling.

The same input value produces different output values on subsequent invocations.

2 (Repeatable)

Performs repeatable scrambling.

The same input value produces the same output value on subsequent invocations.

3 (Translate)

Performs translation.

The value data set is searched to find a matching input value. If a match is found, then the output value is taken from the output column of the matching record.

4 (Exit)

Invokes a scrambling user exit.

5 (ODPP)

If you set this value then you must provide the ODPP command using the ODPP attribute described below.

Defines the start location of the input field value on the value data set, and is used when the translate process is run during a copy operation to match the input field with a value on the value data set. The length of the field is set to the length of the input field that is mapped to this field during the copy process.

Defines the start location of the output field value on the value data set, and is used as follows during a copy operation:

For scramble type Translate

If an input field value is matched on the value data set, then the corresponding output value is used.

For scramble types Random or Repeatable

The input value is used to randomly or repeatably select an output value from the value data set.

The length of the field is the current field length as displayed on this panel.

This value is required when you select the scramble type Translate. If you select Random or Repeatable, and also select Value, then the start location defaults to 1 if a value data set name (Dsn) has been provided.

Defines the value data set. It can be any catalogued sequential, partitioned or VSAM data set containing data that is used to determine the output field value during a copy process.

Defines the start location of the output field value on the value data set, and is used as follows during a copy operation:

For scramble type Translate

If an input field value is matched on the value data set, then the corresponding output value is used.

For scramble types Random or Repeatable

The input value is used to randomly or repeatably select an output value from the value data set.

Defines the value data set. It can be any cataloged sequential, partitioned or VSAM data set containing data that is used to determine the output field value during a copy process.

The values you provide are randomly or repeatably selected depending on your scrambling option to populate the output field during the scrambling operation. The field value must be valid data for the associated parent symbol.