Rational Developer for System z, Version 7.5

Data Structure call Definition

To display the content of the Data Structure Call Definition section, you must select a Data Structure call in the left area of the tab. In the Data Structure Call Definition, you must give the Data Structure its name and location in the generated Program, as well as some physical characteristics. You must also select which of its Segments are to be taken into account. This section gives you access to the Data Structure editor tabs.

Data Structure
The called Data Structure is displayed here. You can change it by clicking the Change... button. The values already entered in the call Definition are kept and automatically apply to the new Data Structure.
Segment selection
Rather than describing all the Segments belonging to the Data Structure, you may select those that are required, to avoid unnecessary description lines and wasted work area space.
  • If you select all Segments, the Data Structure call will include all the Segments but will not display their codes.
  • If you select Specified Segments, all the Data Structure Segments will be displayed in parentheses on the Data Structure call level, and they will all be displayed under the Data Structure call. To remove a Segment, select it and click the Remove button.
  • In the Parameterized selection field, you specify the Segment codes if these codes have been parameterized in a Macro.
COBOL position
This field enables you to indicate the placement and the sequence in which the lines entered in this tab will be generated. These characters form the first two characters of a sequencing number, with the value in the line number as the last three digits.
Value Meaning
AA to ZZ and 0A to 0Z These values cause the lines entered in this tab to be generated at the beginning of the Working-Storage Section.
Relatively to the Data Structures called in the -W Lines tab, these lines will be generated as follows:
  • Before the description of Data Structures whose organization is 'W: file description in Working' and whose 'code in program' matches this prefix or is greater than it,
  • Before the description of Data Structures whose organization is 'L: Working with placement' or 'D: DL/1,IDS I and II', and whose 'COBOL position' matches this prefix or is greater than it.
00 to 09, 1A to 19... 9A to 99 The lines entered in this tab will be generated in the Working-Storage Section, after all the Data Structures whose ' COBOL position' is lower than this prefix
$n This represents a parameterized value in a Macro-Structure
Line number
This line number, constituted of three digits, will be concatenated with the two characters of the 'COBOL position'. The line number can be:
  • 0 to 999: As a recommendation, you should number the lines, starting with 10, by intervals of 10, to facilitate any future insertion
  • $n0 to $n9: In a Macro-Structure, only the first two characters of the Line number can be parameterized.
Code in program
This code is 2 characters long. The first character must be alphanumeric and the second character must be either numeric or alphabetic.

It sets the sequence in which the Data Structure or Report will be processed in the Program/Macro.

When the Data Structure or Report is used only once in a Program, it is recommended to indicate the same code as the one entered as the Data Structure/Report name (chosen upon creation). However if it is called more than once in a Program, you may differentiate these calls. You can parameterize this code in a Macro-Structure with $n.

Format type
You choose here the format of the Data Elements called in the Segments of the Data Structure.

You should select the format according to the usage of the Data Structure, specified in the 'Usage definition' group of the 'Data Structure Line Definition' section, in the '-CD Lines' tab of the Program editor.

Generated description type
This field enables you to select the type of record description to be used in the COBOL program to allow different uses of the Segment description stored in the Library.
Value Meaning
Redefined records No VALUE clause is generated
1: Records without initial values Records without initial values or occurs. These records are presented with the Segment common part followed by the different specific parts.

If the Data Structure description appears in the COBOL File Section, the 'Level' field must be set to 2. With this value, the specific Segments are described without redefines, at the COBOL level 02. Several Segment descriptions are grouped together under the same I/O area.

2: Records with initial values Records with the specific initial values indicated in the Segment -CE Lines tab. These values may also default to blank or zero depending on the format. Initial values are also generated for the occursed fields if the 'Generated language' of the Library is set to COBOL II, 85, or 370.
3: Records with occurs (used with level 2) Records which incorporate the occurs number indicated in the 'Table size' field of the Segment Definition tab.

No VALUE clause will be generated.

If the description of the Data Structure appears in the COBOL File Section, the 'Level' field must set to 2. This type of description cannot be used if the common part Segment of this Data Structure is assigned a value in the 'Table size' field of the Segment Definition tab. (In that case, use the 'W: File description in Working' Organization and the 'T: Table stored in memory' Usage).

4: Records with occurs (used with level 3) Records which incorporate the occurs number indicated in the 'Table size' field of the Segment Definition tab. The associated 'Level' field must be set to 3.

A COBOL level 02 is used to access the table made up of occurs of the same record (ddssT). A COBOL level 01 is used to group the whole D.S. together - common or specific parts, whether occurred or not. A group level field that incorporates all instances is generated.

This type of description cannot be used if the common part Segment of this Data Structure is assigned a value in the 'Table size' field of the Segment Definition tab. (In that case, use the 'W: File description in Working' Organization and the 'T: Table stored in memory' Usage).

COBOL record level
This option, used in conjunction with the 'Generated description type' field, defines the COBOL level number for the descriptions of Data Structures, Segments and Data Elements. In the following descriptions, the term 'D.S. Area' is meant as the 'dd00' area (possibly 1-dd00, 2-dd00).
Value Meaning
1: COBOL 01 level for DS area and segments If the Data Structure description appears in the COBOL File Section, the Segments must be redefined.

If a Data Structure has no common part with a non- redefined description, the D.S. Area will only appear when the 'Generated description type' is set to 'Redefined records'.

2: COBOL 01 level for DS area and segments at 02 level If the 'Generated description type' is set to 'Redefined records', the D.S. Area and Segments will be described at level 02 (Preferably use a 'L: Working with placement' Organization and define the higher levels through Work Areas).
3: COBOL level varying with records description type Level 02 for D.S. Area & level 03 for Segments if the 'Generated description type' is set to '1: Records without initial values', '2: Records with initial values' or '3: Records with occurs (used with level 2)'.

Level 01 for D.S. Area & level 03 for Segments if the 'Generated description type' is set to '4: Records with occurs (used with level 3)'.

Level 03 for both D.S. and Segments if the 'Generated description type' is set to 'Redefined records'.

4: COBOL 02 level for Data Elements, DS Areas and Segment levels disappear Reserved for D.S. with an Organization set to 'L: Working with placement' or 'W: File description in Working'.

Level 02 for group Data Elements or elementary Elements that are not part of a group. Elementary Elements that are part of a group appear but the D.S. Area and Segment levels disappear.

Level 01 is to be defined in the -W Lines tab.

5: COBOL 01 level for Data Elements, DS Areas and Segment levels disappear Reserved for D.S with an Organization set to 'L: Working with placement' or a Usage set to 'D: Output file'.

Level 01 for group Data Elements or elementary Elements that are not part of a group. Elementary elements that are part of a group appear but the D.S. Area and Segment levels disappear.

Organization
Select a line in the dropdown list.

You can choose whether the Data Structure must be generated in the Working Storage Section, or as the description of a Pactables Table.

You can also use this field to specify Database descriptions when the Database Description function is not used. These values are taken into account by application Programs.

Value Comment
S: Sequential This is the only authorized value for a Report, a Sequential file or a Sort file Data Structure.
V: VSAM, UFAS This is one of the two possible values for an Indexed file Data Structure

This value generates the STATUS KEY IS clause and the corresponding field is declared in the 'File Status' field of the Data Structure call Definition section of the '-CD Lines' tab (the part which can be viewed by clicking the More... button).

I: Indexed This is the other possible value for an Indexed file Data Structure.

This value corresponds to an indexed sequential organization (ISP for GCOS8 BCD). An ISP file coded 'LE' will be generated in three work areas: LE-FILE, LE-DATA and INVKEY. The VALUE of LE-DATA will be the external file name which must be the file code in the preceding $ DATA line. In the job control lines, the ISP lines give the physical characteristics of the file.

G: Table description This value generates the communication area with the Pactables access function.
L: Working with placement This is the only possible value for a Linkage Data Structure. File descriptions are generated in the Working Storage Section, but in a location you indicate in the 'COBOL position' field.
W: File description in Working This is the only possible value for a Working Storage Data Structure. File descriptions are generated in the Working Storage Section, before the 'WSS-BEGIN' constant.
Y: Pacbench C/S Call of the COPY clause which corresponds to the communication area between the client and the server (Pacbench C/S Business Components only).
X: Comment Data Structure used as a comment, not used for generation.
2: DB2 segments or VAX/SQL Generation-Description of a DB2 or VAX/SQL Segment. Only physical accesses are not generated. The structure of the variable indicators corresponding to the columns of the DB2 or VAX/SQL table is always generated.
Q: DB2 or ALLBASE/SQL Reserved for the description of SQL/DS, DB2/2 or DB2/6000 Databases (IBM), or ALLBASE/SQL Databases (HP3000), or DB2/2 or DB2/600 Databases (MICROFOCUS).
D: DL/1, IDS I and II Reserved for the description of Segments or records of the IMS (DL/1), IDS I or IDS II databases, in the generation of DBD, SYSGEN, schemas or application programs
B: IDMS  
A: ADABAS  
T: 'TOTAL' files  
O: ORACLE (< V6)  
C: INTEREL RDBC or RFM  
R: RDMS  
4: DB2/400  
M: DATACOM DB  
N: NONSTOP SQL  
P: ORACLE V6 and V7  
9: INFORMIX, SYBASE, INGRES/SQL, or SQL SERVER  
2: Data Structure for Socrate/Clio  
F: Formal for Socrate/Clio  
Sub-schema
This field is used with the Pactables function, to indicate which sub-schema is to be described. It is numeric, from 0 to 9 (0 corresponds to sub-schema 10). This field is used in conjunction with the 'COBOL record level' field.

A sub-schema is a group of Data Elements called in the Segment.

Group segments by Data Structure
If this box is checked, all the Segments of the same Data Structure will be grouped in the generated code.
If you click the buttons in the bottom part of the section, you open the corresponding Data Structure tabs:
Related tasks
Describing the internal resources of a Program/Macro
Related reference
-W Line Comment Definition
Data Element Call Definition
Segment Call Definition

Terms of use | Feedback

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