Rational Programming Patterns for System z

-D Lines tab

This tab corresponds to the Data Element Description.

It is used to assign explanatory text to the Data Element, and values or ranges of possible values with their meaning.

It is also used to complement the description. It provides specific information which will be used where the Data Element is required (screen labels and format, relational database name...).

Each value or range of values is entered as a code and a label; this label it to be used in user documentation. The values or ranges can be used in the Data Element validation process in batch and online programs.

Characteristics specific to OnLine Systems Development:

When using a Data Element in a Screen, a short label, a column label, a sample value, and possibly a conversational format can be defined,

Delimiters of Data Element labels can be parameterized. The delimiter default value can then be overridden if it is used in the given label. A delimiter is required for the column label but optional for the short label.

In online programs, the format used for unprotected (variable) Data Elements is automatically calculated as an expanded version of the internal format. For protected fields, the output format is used. However you can override these formats by specifying a conversational format.

For dates, the symbolic date formats can be used.

The values of the operation and action codes, and the corresponding internal values, can be indicated here.

Error
This column displays a dot on all the existing description lines which are not empty.

Moreover, if this line is not correct, this column also displays an error or warning symbol, depending on the error gravity. A hover help indicates the source of the error.

Type of line
After clicking the Add button, you must select one of the possible types.
Table 1. General line types
Value Meaning
blank Value or description line.

With a blank line type, descriptive text is assigned to the Data Element. This text includes all possible values and what they mean.

D Data Element default value

One of the values entered can be referenced as the default value. When the value D is entered on the Segment -CE Lines tab, this value is assigned as the initial value.

Table 2. Special line types for the OnLine Systems Development, Pacbench C/S and Pactables functions
Value Meaning
P Data Element presentation value

The sample value is entered in the Description field. This value is used when simulating a Screen for information purposes.

L Data Element short label

This label is entered in the Description field.

Maximum length: 18 characters.
Note: This length can be shortened by explicitly entering a delimiter (see description of the Allowed values field). The default delimiter is '/'.
C Column label
The column label is defined on a single line but can use up to three lines. A delimiter in the column label indicates a line skip. The column label length is that of its longest line. The maximum length is 18 characters, including delimiters. A column label must be delimited by at least one delimiter (default = '/').
Note: To change the default delimiter, enter its value left-aligned in the Allowed values field (see the description of this field).
F Conversational format

For Data Elements used in input and output in online programs.

If no conversational format is defined, the extended internal format or the output format is recognized, depending on the nature of the Data Element in the Screen.

For Date Data Elements, enter the one-character symbolic value that represents the format, in the Allowed values field.

For other Data Elements, enter the output format in the Description field.

For numeric Data Elements, a Blank when zero clause can be obtained by entering Z after the format entered in the Description field (example: 9(4) Z).

O Declaration of the operation code values
Note: See also the More field (Skip or Action code), and see the 'OnLine Systems Development' manual and to the 'Pacbench C/S: Business Logic and TUI clients' manual (chapter about the TUI client)

http://www-01.ibm.com/support/docview.wss?rs=37&uid=swg27005477

I Declaration of the action code values
Note: See also the More field (Skip or Action code), and see the 'OnLine Systems Development' manual and to the 'Pacbench C/S: Business Logic and TUI clients' Manual (chapter about the TUI client)

http://www-01.ibm.com/support/docview.wss?rs=37&uid=swg27005477

Table 3. Special line types for relational databases
Value Meaning
R This value generates the relational name of the Data Element, on 18 characters. This name is entered in the Description field.
The relational name of a parent Data Element is not carried forward to the child Data Element.
Note: With TURBOIMAGE, this field generates an item name different from the Data Element code. In this case only the first 16 characters are recognized.
E With this value, you can enter a non-standard date format in the Description field.

The format indicated on the Data Element Definition tab must be X(n). n must be smaller than 28 (or 15 for an ORACLE database) for the automatic management of dates in the OnLine Systems Development function or the Pacbench C/S function.

This format is taken into account:
  • In the SQL generation to generate DATE for ORACLE, SYBASE and SQL SERVER, and DATETIME for NONSTOP SQL
  • In the OnLine Systems Development and Pacbench C/S generation for the SQL accesses (for example: by generating the TOCHAR and TODATE functions for ORACLE)
Non-standard dates are not controlled in the generated programs. Only standard dates (types C, D, E, G, I, M, S) are controlled. Furthermore the date operator (AD) cannot be applied to this non-standard format.

Only the elements of the format are controlled. The way you put them together is not controlled. For example, MD is rejected but MMMMMM and YY-DD/MM is accepted).

Table 4. Line type specific to Data Elements coming from Reverse Engineering
Value Meaning
S The COBOL data names of the associated Reverse Data Elements are generated in the Description field.
Table 5. Line type for COBOL Copybooks
Value Meaning
A For Copybooks, when a variant Data Element is used as an alias-type Data Element, the Description field contains the Segment code of the Segment in which the parent Data Element is called.
Table 6. Line type for ADABAS databases
Value Meaning
A For a Data Element used in an ADABAS database. You can enter the values for the generation of the format buffer.
Table 7. Line type for the TURBOIMAGE class list
Value Meaning
T Values of the TURBOIMAGE class list.
More
This field is used to specify:
Table 8. Specification of a line or page skip
Value Meaning
blank or 1 New line
2 1 blank line + 1 new line
3 to 9 2 - 8 blank lines + 1 new line
* Only in user manuals: page skip
Table 9. Specification of a continuation of value
Value Meaning
+ This value indicates a continuation of a value range if it cannot fit on a single line
Table 10. Specification of an action code for the OLSD function and Pacbench C/S TUI clients (Type of line set to I)
Value Meaning
C Creation
M Modification
D Deletion
X Mod-4 (implicit update).
Table 11. Specification of an operation code for the OLSD function and Pacbench C/S TUI clients (Type of line set to O)
Value Meaning
A Display
M Update
S Next screen
E End of session
P Same page
O Call of another screen
Allowed values
This field is used to specify the authorized values of the Data Element.

These values undergo automatic validation if they are entered as either numeric or alphanumeric literals (quotation marks for the latter),

If the Data Element takes on a range of values, the range must be described as two values between parentheses and separated by at least a space. Inverted parentheses indicate that the given value is excluded from the range:
Examples:

('E' 'Z'): from E inclusive to Z inclusive,

)0 100(: from 0 exclusive to 100 exclusive.

If the description of a value calls for several lines, the value must be entered on the first line.

The values assigned to a parent Data Element are automatically assigned to each of its child Data Elements.

If the Type of line is set to:
  • C, you must enter the delimiter for the end of each column label line (left-aligned). The default value is /.
  • L, you must enter the delimiter for the end of the short label, (left-aligned). The default value is /.
  • O or I, you must enter the value that corresponds to the specific operation or action:
    Note: These values correspond to the internal operation and action codes as entered in the More field
There are other values for this field. They are specific to the OLSD and Pacbench C/S functions, and to the specification of a conversational format.
Table 12. Values specific to the OLSD and Pacbench C/S functions
Value Meaning
*9 Numeric Data Element. It generates a COBOL NOT NUMERIC control.
*B Numeric Data Element: Leading blanks are replaced with zeros.
*Z Numeric Data Element: All blanks are replaced with zeros.
*A Alphabetic Data Element: controls that all characters are alphabetic.
*L Alphabetic Data Element: controls that all characters are lowercase alphabetic.
*U Alphabetic Data Element: controls that all characters are uppercase alphabetic.
Table 13. Specification of a conversational format (Type of line set to F)
Value Meaning
I Without century (picture x(6)): YYMMDD
S With century (picture x(8)): CCYYMMDD
D Without century (picture x(6)): MMDDYY or DDMMYY depending on the value entered in the Generated date format field on the Library Definition tab.
C With century (picture x(8)): MMDDCCYY or DDMMCCYY depending on the value entered in the Generated date format field on the Library Definition tab.
G With century (picture x(10)): CCYY-MM-DD in a Gregorian format.
E Without century (picture x(8)): MM/DD/YY or DD/MM/YY
M With century (picture x(10)): MM/DD/CCYY or DD/MM/CCYY
T Time
TS Timestamp
Description
The value entered here depends upon the value of the Type of line field.
  • With ' ', D, O, I: Enter a descriptive comment (optional).
  • With L, C, or P: Enter the label (with delimiters as needed) or a presentation value.
  • With A: Enter the Segment code where the parent Data Element is called.
  • With R: Enter the relational column name.
  • With E: Enter the non-standard date format with one or several of the following elements:
    • YY: year (YYYY with the century)
    • MM: month
    • MON: first three characters of the month
    • DD: day
    • HH: hour 00 - 23, except for SQL ORACLE: 00 - 12
    • HHAM or HHPM: hour 00 - 12 + am/pm indicator
    • HH24: hour (00 - 23) for SQL ORACLE
    • MI: minutes
    • SS: seconds
    • FF: milliseconds
    • Delimiters / . : - blank
    For more information, see the DBMS documentation.
  • For NONSTOP SQL: input of start field and end field
  • With F (for Data Elements other than dates): Enter the output format (using standard COBOL syntax).
    Note: To generate a BLANK WHEN ZERO clause with numeric Data Elements, enter a blank and a Z after the format (Example: 9(4) Z).

Enter $OFF or $ON to exclude or include the Data Element from a print

When the Data Element description is to be printed in a Volume (with print option EO), the left-aligned $OFF command excludes the next description lines from this print. The explicit exclusion end command is $ON. It must also be left-aligned, just after the last line to exclude from printing.
Warning: This exclusion is not effective when the Data Element description lines are displayed in a generated online help. Only the lines which bear the $OFF and $ON commands are excluded. For more information about the $OFF and $ON commands, see the Personalized Documentation Manager manual at the following URL:

http://www-01.ibm.com/support/docview.wss?rs=37&uid=swg27005477


Terms of use | Feedback

This information center is powered by Eclipse technology. (http://www.eclipse.org)