Rational Developer for System z, Version 7.5

reuse

http://www-1.ibm.com/support/docview.wss?rs=37&context=SSEP67&uid=swg27005478

Creation wizard

Project
Choose a project in the dropdown list or enter the name of the project in which the instance will be saved.

A project represents the physical distribution of your instances in your workspace. It groups directories and files. It is used to organize resources which will be built, shared or versioned.

A Pacbase project contains a sub-set of files which correspond to the models and/or generated sources making up a Pacbase application.

There can be various projects for each location (a location is the equivalent of a database).

Package
Choose a package in the dropdown list or enter the name of a new package.

A package corresponds to a logical group of information.

The logical resources contained in a package can be distributed into various projects.

In the 'Navigator' view of the 'Design' perspective, you will see that the packages represent the branches of your projects. Each package contains its own instances.

For the resources transferred from Pacbase, the naming convention of a package will be {Repository Name}.{Library Path}.{Library Name} So respecting this naming when you create a package is a good idea. To reflect the library hierarchy, you can enter the library names (starting from the highest-level library), and separate each with a period (ex: 'COM.CIF') . This way, the 'Navigator' view will display a first-level branch, COM, with its instances, and a second-level branch, CIF, with its own instances.

Generation parameters
Generation parameters are specified in libraries. These parameters are related to the adaptation to the operating system in use.

You select the library by clicking the Browse... button.

Label
Enter the label, which identifies the new instance. It will then constitute a search criterion for a subsequent search.
Open editor on finish
Check this box if you want the editor of the instance you are creating to open up automatically. The editor will open up on the Overview tab. From there, you will be able to access the other tabs to specify all the characteristics of the instance.
Internal format
This format, displayed in the Overview tab, is required, except if the Data Element is a Property.

The internal format is used when the Data Element is called:

  • in an application file (permanent file, database, temporary file),
  • in a Screen as an input field, if no conversational format has been specified. (See the 'type of line' field in the '-D Lines' tab of the Data Element editor).
This format is automatically transferred into the Segments where the Data Element is called. But you eventually select the appropriate format in the -CD Lines tab of the Programs which call these Segments.

The internal format must be coded like a COBOL picture (without print characters).

Note: for ’Unicode’-type Data Elements (’U’ type in the Definition tab), you must indicate ’N(n)’ or a signed or unsigned numeric format

If the format of a numeric Data Element is more than 10 characters long, you must omit the ’9’ that would normally be entered after the ’V’ (for example: S9(10)V9(3) must be entered as S9(10)V(3)). This way of coding must not be used when the format is shorter than 10 characters.

Note: For ’Unicode’-type Data Elements, you must indicate ’N(n)’ or a signed or unsigned numeric format. The usage is always Display, except for ’Unicode’-type Data Elements, whose usage is ’N’ (default), ’X’ or ’1’.
The ’INTERNAL USAGE’ clause is associated with this format.
Note: if ’Unicode’-type Data Elements have a signed numeric internal format, their internal usage must be ’X’ or ’1’.
Data Elements that represent a date can be assigned a symbolic format:
Symbolic value Meaning
D Without century (DDMMYY or MMDDYY)
C With century (DDMMCCYY or MMDDCCYY)
I Without century (YYMMDD)
S With century (CCYYMMDD)
E Without century (DD/MM/YY or MM/DD/YY)
M With century (DD/MM/CCYY or MM/DD/CCYY)
G Gregorian format (CCYY-MM-DD)
T Timestamp format
Note: For the formats which include a separator (E, G, M and T), you can specify, after the character which represents the format, a separator if you do not want to use the separator included by default in the format (For example, A ’G/’ format will generate CCYY/MM/DD instead of CCYY-MM-DD, which is the default Gregorian format).

For details on the use of the formats with the various types of database blocks, see the summary tables in chapter 'Columns: Data Elements' of the 'Relational SQL Database Description' Manual at this URL:

http://www-1.ibm.com/support/docview.wss?rs=37&context=SSEP67&uid=swg27005478

Overview

Three sections are not tabs themselves and are displayed in the Overview tab only. These are the Alerts and Action Items section, the General Information section and the Generation Parameters section.

All the other sections provide links to the corresponding editor tabs.

If information is displayed in each section, you can:
  • click on it if it is displayed as a link. You will automatically switch to where the information has been specified.
  • or click the More... button to switch to the corresponding tab.

If no information is displayed in the section, just click on the arrows located in front of the section name. This gives you access to the More... button. Click on it to access the corresponding tab.

Alerts and Action Items
Any problem related to the current instance (ex: if the instance calls another instance which has been deleted...) is displayed in this section as a link. If you click on this link, you automatically switch to the Problems view, where the line corresponding to the error is highlighted. The error will be clearly explained there to enable you to correct it.
The General Information section displays the instance name (in a read-only mode) and the label (in a read-write mode):
Name
The instance name is displayed in read-only mode. It is chosen when the instance is created and cannot be modified subsequently.
The Keywords section displays the keywords, if any, already assigned to the instance.

The Documentation section does not directly display the assigned documentation. You must access the Documentation tab to see it.

Generation parameters definition
Generation parameters are specified in libraries. These parameters are related to the adaptation to the operating system in use.

So the current instance is associated with the generation parameters indicated in the library displayed here. You can click the Change... button to select another library.

-W Lines tab

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.
Occurs
You enter here the maximum number of occurrences for the table. This is a pure numeric field, on 5 characters maximum.
An entry in this field causes the generation of the following three indices: IddssM, IddssL and IddssR (ddss = Segment code).
  • IddssM initialized to the value entered.
  • IddssL initialized to zero. This index may be used to load the table. It keeps track of the actual table size
  • IddssR initialized to zero. This index may be used for table searches.
The Data Structure and Segment codes are entered, prefixed with some work area prefix code in the following format: 'w-ddss' or 'w-ddss-eeeeee'.

In a Macro-Structure, it can be parameterized by assigning it a $n value

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.

Data Element Definition

Name
This name references the Data Element independently of any Data Structure, Report or Screen to which the Data Element might belong (there is no need to include a Report, Screen or Segment name in the Data Element name since the System does it automatically).

This name consists of alphabetic or numeric characters only. The following table lists the Data Element names that cannot be created:

Name Reserved for
FILLER Field alignment

ENPR

GRPR

ERUT

Error check fields on transaction files (options of the Batch Function)

Data Element error check

Segment error check

User-defined errors

Usage
This 'Usage' corresponds to the COBOL 'usage' clause.

The usage clause of a COBOL numeric variable allows you to indicate the internal representation of its value. Different USAGEs are available depending on the COBOL variants adapted to the material in use.

You should choose a Data Element usage according to the following elements:
  • The type of COBOL to generate associated with the library where you define the Data Element.
  • The internal representation you want.
    Example: if you generate for IBM, a C usage generates 'usage binary' and F generates 'usage comp-1'. For UNISYS 1100, an H usage generates 'usage comp'.
You can use this Data Element in a lower-level library whose type of COBOL to generate is different to the one of the higher library.
Example: You have defined the DELCO Data Element in the HIG library with C usage and you use it in a LOW library with a type of COBOL to generate for UNISYS 1100.
When this happens, the System automatically replaces the Data Element usage with an equivalent which is compatible with the type of COBOL to generate. So, when you visualize DELCO in LOW, the usage automatically displayed is H. This value will be used to generate. If there is no equivalent, or if the provided one does not suit you, you can modify the usage of the Data Element in the lower library to obtain the result you want.
Value Meaning
D DISPLAY (default option). Required for date Data Elements.
C COMPUTATIONAL (binary), IBM or equivalent; BINARY, IBM and COBOL II variant.
F COMPUTATIONAL-1 IBM or equivalent.

COMPUTATIONAL-9 BULL GCOS7. COMPUTATIONAL-11 GCOS8. Relational DBD : floating point, simple precision.

G COMPUTATIONAL SYNCHRONIZED RIGHT ICL 2900 COMPUTATIONAL-5 MICROFOCUS.
H COMPUTATIONAL UNISYS 2200. BINARY UNISYS 2200 (COBOL 85)
I DISPLAY-1 Unisys 2200
J COMPUTATIONAL-6 GCOS8. REAL UNISYS-A.
N COMPUTATIONAL-4 aligned on a half-byte. You must add the complement if the length is uneven.

or NATIONAL (default usage) for ’Unicode’-type Data Elements (’U’ type).

O COMPUTATIONAL-4 UNISYS 2200
P COMPUTATIONAL-1 GCOS8.
Q COMPUTATIONAL GCOS8.
R COMPUTATIONAL SYNCHRONIZED RIGHT, IBM or equivalent; This value is preferable to ’C’ when binary data is aligned on even addresses, since the corresponding COBOL statements are more efficient.
T COMPUTATIONAL-3 PACKED SYNC. GCOS8.
U COMPUTATIONAL-1 UNISYS 2200.
W COMPUTATIONAL-2 UNISYS 2200. COMPUTATIONAL-12 GCOS8. RELATIONAL DBD : floating point, double precision.
X DISPLAY SIGN IS TRAILING SEPARATE CHARACTER.

or NATIONAL SIGN IS TRAILING SEPARATE CHARACTER for ’Unicode’-type Data Elements (’U’ type).

Y DB-KEY GCOS8. POINTER IBM and MICROFOCUS
Z In batch mode only: this option, which is only used with an output format, allows for the generation of a ’BLANK WHEN ZERO’ clause with the Batch D.S. function.
0 COMPUTATIONAL-7 GCOS8
1 DISPLAY SIGN LEADING SEPARATE - UNISYS 2200, GCOS8, IBM, TANDEM, GCOS7.

or NATIONAL SIGN IS LEADING SEPARATE CHARACTER for ’Unicode’-type Data Elements (’U’ type).

2 DISPLAY-2 GCOS8 = DISPLAY, fields are compared in accordance with the ″commercial collating sequence″ and not in accordance with the standard BULL sequence.
3 COMPUTATIONAL-3 IBM or equivalent

COMPUTATIONAL GCOS7 PACKED-DECIMAL UNISYS 2200 (COBOL 85)

5 COMPUTATIONAL-1 GCOS7 GCOS8
6 COMPUTATIONAL-2 GCOS7 GCOS8
7 COMPUTATIONAL-5 ICL 2900.
8 COMPUTATIONAL BULL 66 GCOS8.
9 COMPUTATIONAL-3 GCOS7 and GCOS8.

Segment call

Occurs
Enter an occurs number in this field to generate an OCCURS COBOL clause. The COBOL restrictions on the OCCURS clause also apply here. You can indicate an occurs number on an elementary or a group Data Element or a Filler. The occurs number is limited to 99. , it is pure numeric field.
Sort key
This field identifies all data elements that might be used as control break sort keys, or as access keys to a file, a database or a Pactables table.

Note: It is highly recommended to dedicate a Segment to only one type of use. Each data element that may belong to a sort key must be referenced by a unique alphabetic or numeric character. It is recommended to reference the indicators by a series (1, 2, 3 ...). The actual sort sequence will be chosen at the program level (on the Call of Data Structures (-CD) screen) by sequencing the characters in the appropriate order.
Don't forget that the format of key group data elements must have been entered in the Dictionary or at the segment level.
Value Comments
U References the access key for a VisualAge Pacbase table. This value must be indicated on the group data element if it is a group key.
S Indicates that the data element belongs to at least one sub-system.
Values Comments
U References a unique key for an DL/1 database.
M References a multiple key for an DL/1 database.
1 to 9 Secondary index All other values designate a search field.
Values Comments
0 to 9 AS400 physical file key. Relational databases
V Variable length column
Blank Fixed length column
W For DB2 SQL, SQL/DS and ORACLE, generation of a variable length column (VARCHAR).
L For DB2 SQL, SQL/DS and ORACLE, generation of a LONG VARCHAR.
Note: Sort keys are not allowed on data elements redefining other data elements.
Redefines
The Data Element containing this option redefines the Data Element of the same COBOL level which precedes it in the Segment description. If a Data Element which redefines another Data Element is contained in a group, it is considered to be an elementary Data Element. It must be taken into account in the calculation of the number of Data Elements contained in a group (except for DL1 database Segments).

-G Lines tab

-GC Lines

These lines are used for documentation purposes. Comments are available with all entities and allow you to write, edit text in relation to the selected instance. This tab allows you to write, modify, move or delete text lines using basic word processing functions.

Type
In the Type input field of the -GC lines section, put your cursor and enter the type of line:
Value Comments
* or blank Standard documentation line.
A Alias for the Segment name.
Description
In the Description input field of the -GC lines section, put your cursor and enter your comment.

On a blank-type line, you enter a free comment.

On an A-type line, enter the COBOL Segment name.

Note: A double click on a word selects the word, clicking in the left margin selects the entire line.

-GE Lines

In the -GE lines section, you specify error messages and online help for the current entity.
Type
Enter in this field, one of the following values:
Values Comments
T Call of a text section.
* Line which will not be generated. It is used to insert a comment or an override.
S Replacement of an automatic error message.

Automatic messages can be replaced by specific messages such as: ’THE ORDER NUMBER IS REQUIRED These messages are indicated on ’S’ type lines assigned to data element call lines (-CE lines tab) in the Segments.

F Data Element call
U Error message
C Comment
D Documentary messages.
Description
You can modify the error messages which are generated for the current entity and generate documentation messages of the same format.
Type Description
D

Column 1:

  • 0 : Message before Element Description.
  • A: Message after Element Description.
  • 2–5 Message after an error message of type 2 to 5.

Column 2: blank

Column 3:
  • blank = a documentary message
  • T = the call of a text

Column 4: blank

Column 5: Begin the documentary message or Enter the text and paragraph code being called. Two asterisks (**) for the paragraph code is a permitted value, it will call all the paragraphs of the text.

S

Column 1: ERROR TYPE (2, 3, 4 or 5)

Column 2: blank

Column 3: ERROR GRAVITY (E, C or W)

Column 4: blank

Column 5: enter the message beginning here.

Selection wizard

Select instances to add
The instances listed here belong to the current location. Select one and click OK to insert it.
If you right-click anywhere in the list, and select:
  • Sort, you can specify a new sort criterion: by name, package, project or generation parameters.
  • Display, you can specify a new display criterion: by package, project, label or generation parameters.
  • Filter, you can specify whether:
    • The selection list is to display all the instances of the location (equivalent to a database), by turning the filter off,
    • Or the selection list is to display only the instances located in the current package (library) and in the packages (libraries) above, by turning the filter on.
This new setting will then automatically be saved and associated with this wizard, until you change it again.
New...
Clicking this button enables you to create an instance. Once created, the instance will be displayed in the list. You will then be able to select it, like any other instances.

-CD line Def/File parameters

External name
This field is optional, on 6 characters maximum. Its contents vary according to the Data Structure type and organization.

For the ’Y: Pacbench’ organization, this field must contain the code of the COBOL COPY clause which represents the communication area of the Pacbench C/S Application Component which accesses the Logical View.

For an SQL Database Data Structure, this field must contain the code of the SQL block.

For any other Data Structure, the contents of this field depend on the value of the 'Type of COBOL code' in the Program Definition tab

Type of COBOL code Field value
IBM OS/390 (COBOL type X) DDNAME
IBM DOS (COBOL type 1) This field may take three forms:
  • SYSnnn Symbolic unit name
  • xxxnnn: Symbolic unit name SYSnnn and external name of the XXX file
  • xxxxxx External name: The symbolic unit is generated with SYSnnn, nnn being incremented by one for each Data Structure starting with SYS010.
COBOL II IBM z/VSE (COBOL type X) The ASSIGN clause (for sequential files, ’S’ organization), with SYSnnn as external name, is generated in the following form: SYSnnn-UT-....-S-SYSnnn
BULL Gcos7 (COBOL type 4) INTERNAL-FILE-NAME
BULL Gcos8 (COBOL type 5) File code (2 characters)
TANDEM (COBOL type F) External name
DEC/VMS (COBOL type I) This field must contain LUnn (nn = 00 to 99).
COBOL position
This field can contain 2 characters. It concerns the main description of a Data Structure (ddss) and not the descriptions which are preceded by a prefix (1-ddss or 2-ddss).

This field is used to obtain a Data Structure description in a particular area (communication area with DBMS's or LINKAGE SECTION that you must define in the -W Lines tab) or at the beginning of the WORKING-STORAGE SECTION.

This field is reserved for Data Structures whose organization is 'W: File description in Working', 'L: Working with placement' or 'D: DL1, IDS1 or II'. It places the I/O area in the WORKING-STORAGE SECTION.

To obtain the description of a Data Structure in the WORKING STORAGE SECTION, you should preferably use the -W Lines tab.

Value Meaning
00 The description of the Data Structure is inserted after all the Work Area lines
Alphabetic characters The description of the Data Structure is inserted after all the Work Area lines whose COBOL position corresponds to this value.

The description and Work Area lines are found at the beginning of the WORKING-STORAGE SECTION of the generated Program. These lines are displayed before Data Structures whose organization is W: 'File description in Working' and before those whose DS code in the Program is greater than this alphabetic code.

Note: Do not choose a COBOL position identical to the DS code in the Program for a Data Structure with a 'W: File description in Working' organization.
Alphanumeric characters The description of the Data Structure is inserted after all the Work Area lines whose COBOL position corresponds to this value.

The Work Area lines and the description can be found in the generated Program, at the end of the WORKING-STORAGE SECTION among the user areas.

Note: With Oracle, you must use numeric values so that the DECLARE SECTION is correctly generated (with data fields and indicators included in it).
Access mode
You specify here the way the Data Structure is accessed by the Program
Value Meaning
S: Sequential Sequential access
R: Direct / Random The Read function is not generated automatically
D: Dynamic This value is reserved for VSAM files.
Recording mode
This field generates the RECORDING MODE IS clause, which indicates the nature of the file's logical records.
Value Comment
F: Fixed At generation time, the lengths of the different records are aligned with the length of the longest record.
V: Variable  
U: Undefined
S: Spanned This value is reserved for IBM MVS and DOS variants.
Input/Output mode
Select a value in the dropdown list.
Value Can be selected with:
I: Input The following usages: 'C: Consultation', 'T: Table stored in memory', 'X: Table partially stored in memory', 'M: Transaction to be validated', 'N: Transaction not to be validated' and 'P: Principal'
O: Output The following usages: 'D: Output file', 'S: Selected', 'R: Result', 'E: Transaction with error checking', 'I: Direct printing' and 'J: Indirect printing'.
E: Output plus OPEN EXTEND clause The following 'Type of Code to generate': GCOS7, GCOS8, IBM 36 or 38, IBM MVS VS, Unisys 2200, Tandem, Dec/Vax, Control Data Corp., Perkin Elmer, ICL 2900, SFENA or DPPX.
R: Input / Output A direct access Data Structure
T: Sort An Input or Output usage
Unit type
The value of this field is important in the 'Types of COBOL code' for which the ASSIGN clause, the FD level and the WRITE statements are dependent on the chosen unit type.
Break level
For sequentially accessed, sorted files, you must enter the number of Elements (elementary or group) on which there is to be a control break processing for the Data Structure.

O is the default value.

1 to 9 levels, according to the number of Elements to be used for control break processing. These Elements are identified as the sort keys for this Data Structure.

When there is a control break processing on one or more Data Structures, two indicators keep track of the status of the records being processed

Below, the term ’nth key Data Element’ includes all the key Data Elements up to and including the nth level. .
  • dd-IBn = ’1’: the nth key Data Element of the current record of the dd Data Structure contains a new value
  • dd-FBn = ’1’: the nth key Data Element of the current record of the dd Data Structure contains the last occurrence of the present value.
When these files are synchronized with others, the control breaks are kept synchronized via two additional switches: .
  • ITBn = ’1’: a new value in the nth key Data Element has been detected. This signals the beginning processing on all synchronized D.S’s.
  • FTBn = ’1’: the present value of the nth key Data is occurring for the last time. This signals the end processing for the records in this iteration for all synchronized D.S’s.
For output files (Usage set to ’D: Output file’): A value other than zero will create a duplicate file layout to be generated in the Working Strorage area, prefixed by ’1-’. However, this should preferably be done in the -W Lines tab.
Synchronization level
For sequentially accessed files, this field is used to set the synchronization of two or more files

O is the default value.

1 to 9 levels. Enter the number of Elements (Elementary or Group) on which file matching is to be synchronized for this Data Structure. This number identifies the number of the key fields (identified in the Sort key composition field) that are involved in the synchronization.

For an automatic synchronization, the following conditions must be met:
  • The Data Structure control break level must be equal to the synchronization level - 1, except for a transaction Data Structure, whose control break level must be equal to or higher than the file synchronization level.
  • The Data Element(s) which constitute(s) the sort keys of a Data Structure must be sorted in ascending order.
  • The Data Element(s) which constitute(s) the sort keys of a Data Structure must have the same length for the same level.
  • These Data Elements must have a display format (if they are numeric, they must be whole numbers and unsigned).
The switches generated to control file synchronization are:
  • dd-CFn: which indicates whether a file should be processed or bypassed in this iteration, (1 = process, 0 = bypass).
  • dd-OCn: which indicates the status of processing on a record of a principal file (Data Structure with a 'P: Principal' Usage.)
  • For sequentially accessed files:
    • 1 = WRITE to the principal file
    • 0= do not WRITE
  • For direct access files:
    • 1 = CREATE or REWRITE
    • 0 = DELETE
Usage
This code defines the role of the Data Structure in the Program and determines the generated functions.
Value Meaning
C: Consultation Any input file
D: Output file Any output file
P: Principal Input file, likely to be updated by a transaction file (whose usage is 'M: Transaction to be validated' or ’N: Transaction not to be validated’)
R: Result Updated principal file in sequential access mode. (When the Data Structure contains an ’Occurs depending on’ clause, the output/result D.S must be declared as ’D: Output file’).
S: Selected Output file extracted from another file.

It differs from the 'D: Output file' usage since the generated description in the output area is not detailed. For Data Elements with an ’Occurs depending on’ clause, the usage must be ’D: Output file’.

T: Table stored in memory A file to be fully stored in memory. The table is generated according to the number of occurs indicated on each Segment Definition. The maximum number of selected Segments per D.S. is 50.
X: Table partially stored in memory A file to be partially stored in memory.

Fillers included in the Segment composition are not stored. Elementary Data Elements other than fillers are limited to 10 (in addition to the 'Record type Element') for the ’00’ Segment and to 29 for each specific non-00 Segment.

M: Transaction to be validated Input file to be validated which can update other file(s). The generated functions range from 30 to 76.
Note: Only one ’M’ or ’N’ Data Structure is allowed per Program.
N: Transaction not to be validated Input file which can update other files. The generated functions are: 30, 33, 39, 70 to 76.
Note: Only one ’M’ or ’N’ Data Structure is allowed per Program.
E: Transaction with error checking Output transaction file containing a field identifying records with errors.

The system will generate the field(s) to track the erroneous Elements, erroneous Segments and user-defined errors using the reserved Data Elements ENPR, GRPR and ERUT. (The option is selected in the RESERVED ERROR CODES IN TRANS. FILE field). Selected or not, the descriptions of these Elements are generated (using the Data Elements DE-ERR and ER-PRR).

I: Direct printing Direct printing (or by SYSOUT in IBM MVS).

Upon generation, the lines whose 'Structure Identifier' is 00 in the Report will be ignored.

J: Indirect printing Indirect printing to be processed by a spool Program.

The fields required to identify the lines, line skips... are indicated in the 'Structure Identifier' 00 in the Report.

Y: Internal codification table  
Sort key composition
This is the group of Data Elements making up the sort key for control break processing.

They are identified by the value entered in the 'Sort key' field on the Segment -CE Lines tab.

The order for sorting these key Data Elements may be entered here using the values assigned on the -CE Lines tab in the desired order from major to minor - left to right.

If no explicit entry is made here, Elements coded with value 1 to 9 will be taken as the default.

Note: For transaction files, include the 'Action code' and 'Record type' Elements as a part of the key. The order in which these Elements are sorted will determine the sequence in which the transactions update the principal file, and the policy for duplicate record detection.
Block factor
This field, on 5 characters, is required for the generation of the BLOCK CONTAINS clause.

It must contain a numeric value, which corresponds to the block size, i.e. the size of the physical record. Spaces and zeroes are equivalent.

The block size can be zero for:
  • IBM OS, except for indexed data structures.
  • IBM MVS. The BLOCK CONTAINS clause is generated for a VSAM file only if the library is in COBOL II.
The BLOCK CONTAINS clause is not generated in the following cases:
  • Sort Data Structure,
  • Data Structure stored on a disk if no number is indicated,
  • File with a 'Block type' = ’R: Records’ for IBM DOS (Type of COBOL code = '1'),
  • Block 0 for UNISYS A Series (Type of COBOL code = '8') and AS 400 (Type of COBOL code = 'O').
  • Block 0 for IBM VSE COBOL II and file with 'Block type' = ’N: Ignore Block management’.
Block type
Here you select whether the block size entered in the 'Block factor' field represents a number of records, characters, or whether it should be ignored for the block management.
Result Data Structure code

If the Data Structure has a 'Usage' = 'P: Principal', you must enter the 'code in program' of the result output Data Structure (2 characters).

If the Data Structure has a 'Usage' = 'R: Result' or 'D: Output file', you must enter the 'code in program' of the principal input Data Structure (2 characters).

Source Data Structure code

If the Data Structure has a 'Usage' = 'M: Transaction to be validated' or 'N: Transaction not to be validated', you must enter the 'code in program' (on 2 characters) of the transaction file containing the errors ('Usage' = 'E: Transaction with error checking'), if such a file has been called.

If the Data Structure has a 'Usage' = 'E: Transaction with error checking', you must enter the 'code in program' (on 2 characters) of the corresponding transaction file ('Usage' = 'M: Transaction to be validated' or 'N: Transaction not to be validated').

Transaction break level
By default, the value of this field is that of the 'Break level' entered in the 'Usage definition' section. The value must be one-character long.
Note: All spaces are replaced with zeros.
In a transaction file, you must enter the position, within the sort key, of the 'Action code' (entered on the Segment Definition tab).
Example: if the value of the 'Sort key' is ABCDE and the 'Action code' is ’D’, enter ’4’ here.
This is the most minor key of the sort key and the one used to differentiate one type of transaction from another in the same principal file. Duplicates are detected if any key elements below this one are found to match.
Physical unit type
The possible unit type varies according to the Type of COBOL code.
Value Meaning
  IBM DOS (Type of COBOL code = '1'):

Enter the model type (examples: 2314, 3330, 2400).

.

EXT

LS

EXLS

MICROFOCUS, COBOL II, IBM VISUAL SET (Type of COBOL code = '3'):

Generation of the EXTERNAL clause at the file FD level

Generation of the LINE SEQUENTIAL clause

Generation of the LINE SEQUENTIAL clause and of the EXTERNAL clause at the file FD level

.

LS

ACU COBOL (Type of COBOL code = 'Q') :

Generation of the LINE SEQUENTIAL clause

.

SSF

OUT

Gcos7 (Type of COBOL code = '4'):

Option WITH SSF in the SELECT clause

Option -SYSOUT suffix after the filename in the SELECT clause (WITH SSF is generated).

.

PT

CR

SSF

IBM

xxx

..V

Gcos8 ASCII (Type of COBOL code = '5'):

Printer

Card reader.

ORGANIZATION IS GFRC SEQUENTIAL SSF CODE SET IS IS GBCD.

ORGANIZATION IS IBM-OS SEQUENTIAL.

WITH xxx.

A ’V’ in the 4th position generates the clause ’VALUE OF FILE-ID is 3-FF00-IDENT’ (FF is the program Data Structure code being called). You must define the 3-FF00-IDENT field in the -W Lines tab.

.

DK or blank

DKS

DKM

RD

PT

PO

TP

...

..P

..R

..L

..S

..V

BURROUGHS large system (Type of COBOL code = '8') UNISYS A Series:

Disk

Sort Disk (with T opening).

Merge Disk (with T opening).

Reader

Printer

File

Tape

For the 2-character codes, a third character can specify a particular final disposition:

Purge

Release

Lock

Save

A ’V’ in the 4th position generates the clause ’VALUE OF D.S. NAME IS 3-FF00-IDENT’.

.

CR

CP

UN

TP

PN

PT

PF

UNISYS 2200 (Type of COBOL code = 'U'):

Card reader.

Card punch.

Uniservo.

Tape

Printer with external name. If the 'Complement' field contains input, the RECORDING clause is also generated.

Printer without external name.

Printer with external name and
VALUE OF PRINTER-FORMS 3-FF00-FORMS
LINAGE IS 3-FF00-LINES
TOP IS 3-FF00-TOP
BOTTOM IS 3-FF00-BOTTOM

These 4 data-names are to be declared in Work Areas (-W lines) with their appropriate values.

.

DB

RD

CP

PT

TP

DK or blank

AS 400 (Type of COBOL code = 'O'):

Database

Reader

Card Punch

Printer

Tape

Disk

Complement
This is a complement to the 'Physical unit type' field. The purpose of this field varies according to the 'Type of COBOL code'.
Value Type of COBOL code
R: Reader IBM DOS (Type of COBOL code = '1')
P: Punch IBM DOS (Type of COBOL code = '1')
S: EBCDIC set code BULL Gcos8 (Type of COBOL code = '5') and UNISYS 2200 (Type of COBOL code = 'U')
C: ASCII set code BULL Gcos8 (Type of COBOL code = '5')
O: OPTIONAL option not to be generated BULL Gcos7 (Type of COBOL code = '4') and Gcos8 (Type of COBOL code = '5')
A: ALLOWING ALL file optioning option & REGARDLESS sequential reading DEC VAX VMS (Type of COBOL code = 'I')
File status
This field is optional.

If you fill it in, it is recommended to specify a character string, on 10 characters maximum, in the following format:

ddsseeeeee, where:
  • dd = Data Structure
  • ss = Record (00 is recommended)
  • eeeeee = Data Element
The use of this field varies according to the 'Type of COBOL code' you indicate in the Program Definition tab and to the Organization of the Data Structure call:
  • For VSAM files, the 'FILE STATUS IS' clause is generated using 1-ddss-eeeeee (declared as a two byte field).
  • For non-VSAM files, NOMINAL, SYMBOLIC or ACTUAL KEY are generated, according to the 'Type of COBOL code'. You must define the corresponding work area, i.e. 1-ddss-eeeeee. You must also specify, in specific code, the positioning of this key as well as the reading of the Data Structure.
Access key Data Element code

This code, on 6 characters, is required for indexed Data Structures.

Record type Data Element code

You enter here the code (6 characters) of the Data Element whose values identify the different record types of a Data Structure.

This Data Element must belong to the common part Segment (00 Segment).

This name can also be specified in the 'Structure code' field of the Segment Definition tab.

Macro call

Line number
Enter two numeric characters in this field. When a Macro is parameterized, it is used to call it into the same program several times.
Parameters
Up to 20 parameters can be used in a Macro. They are formatted as '$n' (n=1,2,...,9,0) and '$x' (n=A,B,...J) and are listed in the 'Parameter' column.

You must specify the replacement values of the respective parameters in the form of character strings. Each occurrence of the parameter in the original Macro is then replaced by the value entered for this particular Program.

The number of characters used for each parameter value must correspond to the appropriate field length for the element being parameterized. For example, if $1 is being used as a Function code, the value must be two characters.

Data Element call

Line type
Here you must select which format is going to be used for the Data Element call:
  • E’: Input format,
  • I’: Internal format,
  • S’: Output format.
Text before
This field is divided into two sub-fields:
  • The 'Level or Section', constituted of the first 17 positions of the field, In this sub-field, you must enter the COBOL level number (01, 05...) or the Section name (LINKAGE SECTION,...) in which this line will be generated.
  • The 'Work area declaration', which starts from position 18, to the end of the field. You must declare the beginning of the data-name, which will be concatenated with the Data Element code to constitute the actual data-name.
    So you must enter w-ddss- (without omitting the dashes), where:
    • w = Working-storage prefix (alpha or numeric),
    • dd = Data Structure code, including the work area,
    • ss = Segment code,
    Once concatenated with the Data Element code, the data name will be: w-ddss-eee (with eeeeee as the Data Element code). Cross-references between the Data Element and the Program will be established automatically.
    Note: When a Data Element existing in the Repository is called in a work and link area, you must enter the beginning of the data-name in this field. Otherwise, the generated code will be formatted this way:
    03 DDSS-DELCO PICTURE X.
Text after
In this field, you must enter the characters which will be inserted in the generated code, after the data-name. Most often, you just enter a period ('.') but you can also enter other values (ex: 'VALUE SPACE').

Pacbase Cobol in PDP

To see the content of this view, you must have generated a program. Then, in the Design explorer view of the Design perspective, right-click on the corresponding .cbl file, which contains the generated Cobol, and select Open with > Pdp Cobol System z LPEX Editor in the popup menu. The Cobol editor must remain open and currently selected.
Tip: You must be familiar with the concepts explained in Generating the Pac COBOL and modifying it: the various steps before reading this help.

Terms of use | Feedback

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