Creation wizard
If the Create a derived entity box is checked, you can use the whole length of the edit field. The name of the derived instance can start with the name of its reference instance. The name can also include the generation Library. If you do not enter a name and specify a reference instance in the <Entity> to derive field, the name is automatically initialized with the name of the reference instance.
- Project
- Select a project in the list or enter the name of the project where the instance is to 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 that can be built, shared, or versioned.
A Rational® Programming Patterns project contains a subset of files that correspond to the design and the generated sources of an application.
- Package
- A package corresponds to a logical group of information in a project.
If you are maintaining a Pacbase application, selecting a package is not advised. The instance override mechanism is then made easier because the overriding instance is always in the same package as the overridden instance. You do not need to manage the presence of both the instances in the same package, which is the requirement of an override.
- 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 Browse.
- Generation parameters
- Generation parameters are specified in Libraries. These parameters
are related to the adaptation to the operating system in use.
Click Browse. In the selection wizard that opens, select a Library. You can also create a Library by clicking New Library.
- Label
- Enter the label that identifies the instance. It will constitute a search criterion upon a subsequent search.
- Open editor on finish
- Select this check box if you want to open the editor of the instance you are creating. The editor opens on the Overview tab. From there, you can access the other tabs to specify all the characteristics of the instance.
- Create a derived entity
- Select this check box if you want to create a derived entity instance
that points to a reference instance. The derived instance contains
a link to the reference instance and a link to a Library that contains
the generation parameters. From the derived instance, you can generate
the reference instance from a different Library, without duplicating
its design. The generation parameters of the derived instance Library
produce a COBOL source that is different from the source that is generated
from the reference instance Library.
If you select this box, the <Entity> to derive field is displayed. In the wizard, <Entity> is replaced by the actual entity (such as Program, Screen, or Data Structure). You must select the reference instance that contains the design for the derived instance.
- Internal format
- This format, which is 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 one of the following components:
- An application file (permanent file, database, temporary file).
- A Screen as a data-entry field, if no conversational format was specified. See the type of line field in the -D Lines tab of the Data Element editor.
You must ensure the compatibility between the input and internal formats.
The internal format must be coded like a COBOL picture (without print characters).Notes:- 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.
- For Unicode-type Data Elements, you must indicate N(n) or a signed or unsigned numeric format.
The INTERNAL USAGE clause is associated with this format.Note: If a Unicode-type Data Element has a signed numeric internal format, its internal usage must be X or 1.Data Elements that represent a date can be assigned a symbolic format.Table 1. Symbolic formats for dates Symbolic value Meaning D Without century (DDMMYY or MMDDYY) I Without century (YYMMDD) E Without century (DD/MM/YY or MM/DD/YY) S With century (CCYYMMDD) C With century (DDMMCCYY or MMDDCCYY) M With century (DD/MM/CCYY or MM/DD/CCYY) G Gregorian format (CCYY-MM-DD) T Time format (HH:MM:SS) TS Timestamp format Note: For the formats that include a separator (E, G, M, and T), you can specify a separator after the character that represents the format, if you do not want to use the separator included by default in the format. For example, a G/ format generates 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-01.ibm.com/support/docview.wss?rs=37&uid=swg27005477
Symbolic value | Meaning |
---|---|
D | Without century (DDMMYY or MMDDYY) |
I | Without century (YYMMDD) |
E | Without century (DD/MM/YY or MM/DD/YY) |
S | With century (CCYYMMDD) |
C | With century (DDMMCCYY or MMDDCCYY) |
M | With century (DD/MM/CCYY or MM/DD/CCYY) |
G | Gregorian format (CCYY-MM-DD) |
T | Time format (HH:MM:SS) |
TS | Timestamp format |
This wizard displays the three Data Element formats in the following order: internal format, input format, and output format.
You can select contiguous instances in the selection wizard. To select noncontiguous instances, check Multi-selection. Select each instance, with the help of the filtering pattern if necessary. Then, click Add to selection list. You can also double-click each instance to add it to the list. To remove an instance from the selection list, select the instance in the selection list and click Remove from selection list before you close the selection wizard.
Overview
Description of the tab
Three sections are not tabs. They are displayed in the Overview tab only: Alerts and Action Items, General information, and Generation parameters definition (on some entities).All the other sections provide links to the corresponding editor tabs.
- Click the information if it is displayed as a link. You automatically switch to where the information is specified.
- Click More to switch to the corresponding tab.
The sections of the tab
- Alerts and Action Items
- Any problem that is related to the current instance is displayed in this section as a link. If you click this link, you automatically switch to the Problems view, where the line that corresponds to the error is highlighted. The error is explained and you can correct it.
- Work context
- The work context is the project from which you open the editor of the current instance. This
project constitutes the starting point for the resolution of the dynamic links and references
between the instances of the various projects. The projects hierarchy that is declared in the design
build path is explored in an upward direction.
If you click Hierarchy, you can see a partial view of the design build path. In this view, the project that constitutes the work context is the lowest project of the hierarchy.
For more information, see The work context and The design build path.
- Name
- The instance name is displayed in read-only mode. It is entered when the instance is created, and it cannot be modified later.
- Generation parameters definition
- Generation parameters are specified in Libraries. These parameters are related to the adaptation
to the operating system in use.
The current instance is then associated with the generation parameters of the Library that is displayed here. You can click Change to select another Library.
-W Lines tab
- COBOL position
- Indicate the placement and the sequence according to which the lines that are entered in this
tab are to 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.
The value that you can enter in this field changes according to whether it is a COBOL position for a Program or a Screen.
Table 3. Values of the COBOL position for a Program Value Meaning AA to ZZ and 0A to 0Z The lines that are entered in this tab are generated at the beginning of the WORKING-STORAGE SECTION. These lines are generated:- Before the description of the 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 the Data Structures whose organization is L: Working with placement, and whose COBOL position matches this prefix or is greater than it.
00 to 09, 1A to 19, up to 9A to 99 The lines that are entered in this tab are generated in the WORKING-STORAGE SECTION, after all the Data Structures whose COBOL position is lower than this prefix. Table 4. Values of the COBOL position for a Screen Value Meaning AA to 0Z The description is generated in the WORKING-STORAGE SECTION. 00 to 99 The description is generated in the LINKAGE SECTION. AA and 00 These values are used for automatically generated data. 99 With a Line number = 999, this value is used for the PROCEDURE DIVISION statement. Therefore, you can use it to create a line with a sequencing number 99999, which replaces the PROCEDURE DIVISION line automatically generated. $n This value represents a parameterized value in a Macro.
- Line number
- This line number, constituted of three digits, is concatenated
with the two characters of the COBOL position.
The line number can be:
- 0 to 999: It is advised to number the lines, starting with 10, by intervals of 10, to facilitate any future insertion
- $n0 to $n9: In a Macro, only the first two characters of the Line number can be parameterized.
- Occurs
- You enter this field if the data name (entered in the Comment field
if you are viewing a comment call, or in the Text before field
if you are viewing a Data Element call) is repeated. You enter the
maximum number of occurrences. This value is numeric, on five characters
maximum. An entry in this field causes the generation of the following three indexes (ddss = Segment code):
- IddssM initialized to the value entered.
- IddssL initialized to zero. This index can be used to load the table. It tracks the actual table size
- IddssR initialized to zero. This index can be used for table searches.
In a Macro, you can parameterize it 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 is processed in the program.
When the Data Structure or Report is used only once in a program, it is advised to indicate the code that is entered as the Data Structure or Report name. This name is entered upon creation. However, if it is called more than once in a program, you can differentiate these calls.
You can parameterize this code in a Macro with $n.
- Format type
- You select the format of the Data Elements that are called in
the Segments of the Data Structure. You must select the format according to the usage of the Data Structure, which is specified in the -CD Lines tab of the Program editor. This field does not apply to the Data Structures whose usage is I: Direct printing or J: Indirect printing.Note: The Data Elements making up the Segments must not exceed 999 characters.
Table 5. Format types for Data Elements Value Comment E : Input Default value for Data Structures with a usage set to M: Transaction to be validated, N: Transaction not to be validated, or E: Transaction with error checking I: Internal Default value for Data Structures whose usage is not set to: M: Transaction to be validated, N: Transaction not to be validated, or E: Transaction with error checking S: Output
- Generated description type
- You select the type of record description to be used in the COBOL
program to allow different uses of the Segment description that is
stored in the Library.
Table 6. Values of the generated description types Value Meaning Redefined records No VALUE clause is generated 1: Records without initial values Records without initial values or occurs. These records contain the Segment common part, followed by the different specific parts. If the Data Structure description is included in the COBOL FILE SECTION, the COBOL record level field must be set to 2: COBOL 01 level for DS area and Segments at 02 level.
With this value, the specific Segments are described without redefines, at the COBOL level 02. Several Segment descriptions are grouped 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 can also default to blank or zero depending on the format. Initial values are also generated for the multiple occurrence fields if the Generated language of the Library is set to D: COBOL II, 85, LE. 3: Records with occurs (used with level 2) Records that incorporate the number of occurrences that are indicated in the Table size field of the Segment Definition tab. No VALUE clause is generated.
If the Data Structure description is included in the COBOL FILE SECTION, the COBOL record level field must be set to 2: COBOL 01 level for DS area and Segments at 02 level.
You cannot use this description type if the common part Segment of this Data Structure is assigned a value in the Table size field of the Segment Definition. In that case, set the Organization to W: File description in Working and the Usage to T: Table stored in memory.
4: Records with occurs (used with level 3) Records that incorporate the number of occurrences that are indicated in the Table size field of the Segment Definition tab. The associated COBOL record level must be set to 3: COBOL level varying with records description type
Comment specific to the OnLine Systems Development function: The index is not generated if the Generated description type is set to 4: Records with occurs (used with level 3), and the COBOL record level is set to 3: COBOL level varying with records description type,
The COBOL level 02 provides an access to the table that consists of the repetition of a record.
The COBOL level 01 consolidates all the Data Structure information (common part and specific parts that are repeated or not). A group level field that incorporates all the instances is generated.
You cannot use this description type 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, set the Organization to W: File description in Working, and the Usage to T: Table stored in memory.
- COBOL record level
- This option is used with the Generated description
type field. It defines the COBOL level number for the
descriptions of Data Structures, Segments, and Data Elements. In
the following descriptions, the expression "D.S. area" is meant
as the dd00 area (possibly 1-dd00, 2-dd00).
Table 7. Possible values for the COBOL record level Value Meaning 1: COBOL 01 level for DS area and Segments If the Data Structure description is included 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 is only included 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 are described at level 02. Preferably set the Organization to L: Working with placement and define the higher levels through work areas. 3: COBOL level varying with records description type Level 02 for D.S. area and 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 and level 03 for Segments if the Generated description type is set to 4: Records with occurs (used with level 3).
Level 03 for both the 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 the D.S. with an Organization set to L: Working with placement and a Usage set to D: Output file. Level 02 for group Data Elements or elementary Data Elements that are not part of a group. The elementary Data Elements that are part of a group are displayed but the D.S. area and Segment levels are not included.
Level 01 is to be defined in the work areas.
5: COBOL 01 level for Data Elements, DS areas and Segment levels disappear Organization set to L: Working with placement or W: File description in Working and a Usage set to D: Output file. Level 01 for the group Data Elements or elementary Data Elements that are not part of a group. The elementary Data Elements that are part of a group are displayed but the D.S. area and Segment levels are not included.
- Organization
- Select an organization value.
You can select 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 recognized by the Programs.
Table 8. Possible values for the organization Value Comment S: Sequential Only authorized value for a Report, a sequential file or a sort file Data Structure. V: VSAM, UFAS One of the two possible values for an indexed file Data Structure. This value generates the STATUS KEY IS clause. The corresponding field is declared in the File Status field of the -CD Line Definition of the -CD Lines tab (the part that can be viewed by clicking More).
I: Indexed 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 is generated in 3 work areas:- LE-FILE
- LE-DATA
- INVKEY
G: Table description This value generates the communication area with the Pactables function. L: Working with placement File descriptions are generated in the WORKING-STORAGE SECTION, in the location you indicate in the COBOL position field. W: File description in Working File descriptions are generated in the WORKING-STORAGE SECTION, before the WSS-BEGIN constant. Y: Pacbench C/S Call of the COPY clause that corresponds to the communication area between the client and the server (Business Components only). X: Comment Data Structure that is used as a comment, not used for generation. 2: DB2 Segments or VAX/SQL Generation and description of a DB2® or VAX/SQL Segment. Only the physical access levels are not generated. The structure of the variable indicators that correspond 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 (MICRO FOCUS). 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 IDMS A: ADABAS ADABAS T: TOTAL files TOTAL files O: ORACLE (< V6) ORACLE (< V6) C: INTEREL RDBC or RFM INTEREL RDBC or RFM R: RDMS RDMS 4: DB2/400 DB2/400® M: DATACOM DB DATACOM DB N: NONSTOP SQL NONSTOP SQL P: ORACLE V6 and V7 ORACLE V6 and V7 9: INFORMIX, SYBASE, INGRES/SQL, or SQL SERVER INFORMIX, SYBASE, INGRES/SQL, or SQL SERVER Z: Data Structure for SOCRATE/CLIO Data Structure for SOCRATE/CLIO F: Formal for SOCRATE/CLIO Formal for SOCRATE/CLIO
- Subschema
- A subschema is a group of Data Elements that are called in the
Segment.
This field is used with the Pactables function, to indicate which subschema is to be described. It is numeric, from 0 to 9 (0 corresponds to subschema 10).
The Segment level
The Segment level is nested in the Data Structure level. The first two characters of the Segment are constituted by the Data Structure and the last two characters are the Segment code in program.
The Segment level displays the Segment name in the first column and the Segment label in the second column.
If you expand this level, you see the Segment code in program, which is editable.
The composition of each Segment (equivalent to the -CE Lines tab) is displayed in the nested level, with one line for each called Data Element. If you expand the first line of a called Data Element, you can see and modify its name and label. Its Attributes level contains the same information as the Definition tab, except the inheritance, which can be specified in the tab only.
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.
Including a Report, Screen or Segment name in the Data Element name
is not necessary because it is automatically performed.
This name consists of alphabetic or numeric characters only. The following table lists the Data Element names that cannot be created:
Table 9. List of reserved Data Element names Name Reserved for FILLER Field alignment ENPR GRPR
ERUT
Data Element error check in transaction files Segment error check in transaction files
User-defined errors in transaction files
- Usage
- It corresponds to the COBOL USAGE clause.
With the USAGE clause of a COBOL numeric variable, you indicate the internal representation of its value. Different usages are available depending on the COBOL variants that are adapted to the material in use.
You select 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 that 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.
Example: The DELCO Data Element is defined in the HIG Library with a C usage. You use it in a LOW Library with a type of COBOL to generate for UNISYS 1100.The Data Element usage is automatically replaced with an equivalent that is compatible with the type of COBOL to generate. So when you view DELCO in LOW, the usage that is automatically displayed is H.Table 10. Possible values for the usage Value Meaning B COMPUTATIONAL-1 ICL 1900 BINARY-1 UNISYS 1100
C COMPUTATIONAL (binary) IBM or equivalent. BINARY IBM and COBOL II variant.
D DISPLAY (default option except for Unicode-type Data Elements). Required for date Data Elements.
F COMPUTATIONAL-1 IBM or equivalent. COMPUTATIONAL-9 GCOS7.
COMPUTATIONAL-11 GCOS8.
Floating point, simple precision for relational databases.
G COMPUTATIONAL SYNCHRONIZED RIGHT ICL 2900 COMPUTATIONAL-5 MICRO FOCUS.
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. 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 because 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.
Floating point, double precision for relational databases.
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 MICRO FOCUS
Z Reserved to batch applications. It is used only with an output format to generate a BLANK WHEN ZERO clause. 0 COMPUTATIONAL-7 GCOS8 1 DISPLAY SIGN LEADING SEPARATE for UNISYS 2200, GCOS8, IBM, TANDEM, GCOS7. NATIONAL SIGN IS LEADING SEPARATE CHARACTER for Unicode-type Data Elements (U type).
USAGE SQL TYPE IS BLOB (n/nK/nM/nG) for Large Object-type Data Elements (L type) that are used as columns in DB2 databases.
SQL-BLOB for Large Object-type Data Elements (L type) that are used as columns in ORACLE databases.
2 DISPLAY-2 GCOS8 = DISPLAY. Fields are compared in accordance with the commercial collating sequence and not in accordance with the standard BULL sequence. USAGE SQL TYPE IS CLOB (n/nK/nM/nG) for Large Object-type Data Elements (L type) that are used as columns in DB2 databases.
SQL-CLOB for Large Object-type Data Elements (L type) that are used as columns in ORACLE databases.
3 COMPUTATIONAL-3 IBM or equivalent. COMPUTATIONAL GCOS7
PACKED-DECIMAL UNISYS 2200 (COBOL 85)
USAGE SQL TYPE IS DBCLOB (n/nK/nM/nG) for Large Object-type Data Elements (L type) that are used as columns in DB2 databases.
SQL-BFILE for Large Object-type Data Elements (L type) that are used as columns in ORACLE databases.
4 USAGE SQL TYPE IS BLOB-LOCATOR for Large Object-type Data Elements (L type) that are used as columns in DB2 databases. 5 COMPUTATIONAL-1 GCOS7 GCOS8 USAGE SQL TYPE IS CLOB-LOCATOR for Large Object-type Data Elements (L type) that are used as columns in DB2 databases.
6 COMPUTATIONAL-2 GCOS7 GCOS8 USAGE SQL TYPE IS DBCLOB-LOCATOR for Large Object-type Data Elements (L type) that are used as columns in DB2 databases.
7 COMPUTATIONAL-5 ICL 2900. USAGE SQL TYPE IS BLOB-FILE for Large Object-type Data Elements (L type) that are used as columns in DB2 databases.
8 COMPUTATIONAL BULL 66 GCOS8 USAGE SQL TYPE IS CLOB-FILE for Large Object-type Data Elements (L type) that are used as columns in DB2 databases.
9 COMPUTATIONAL-3 GCOS7 and GCOS8. USAGE SQL TYPE IS DBCLOB-FILE for Large Object-type Data Elements (L type) that are used as columns in DB2 databases.
COBOL to generate
Segment call
- Occurs
- This field represents the OCCURS clause of an elementary Data Element, a group, or a filler. The restrictions of the COBOL OCCURS clause apply.
- Sort key
- This field identifies all the Data Elements that can be used as
control break sort keys, or as access keys to a file, a database or
a Pactables Table.Note: It is advised to dedicate a Segment to only one type of use. Each Data Element that can belong to a sort key must be referenced by a unique alphabetic or numeric character. It is advised to reference the indicators by a series (1, 2, 3 for example). The actual sort sequence is selected at the Program level (on the -CD Lines tab).You must not forget that the format of key group Data Elements must have been entered in the repository or at the Segment level.
Table 11. Possible values of the sort key for Pactables Value Comments U References the access key for a 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 subsystem. Table 12. Possible values of the sort key for DL/1 databases Values Comments U References a unique key for a DL/1 database. M References a multiple key for a DL/1 database. 1 - 9 Secondary index All other values designate a search field. Table 13. Possible values of the sort key for AS400 and relational databases Values Comments 0 - 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 authorized on Data Elements redefining other Data Elements.
- Redefines
- The Data Element that contains this option redefines the Data Element of the same COBOL level that precedes it in the Segment description. If a Data Element that 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 that are contained in a group (except for DL/1 database Segments).
- Place the cursor in the column and enter the name directly. To make the input easier, you can open a content assist wizard by clicking Ctrl and the space bar simultaneously. If you start entering a name, the content assist displays the instances that start with this input. If you enter the name of an instance that does not exist and if you validate, the input is discarded.
- Click the button that appears when you set your cursor in the column. In the selection wizard that opens, select an instance.
-G Lines tab
Error column
- Error
- This column displays a dot on all the existing description lines
that are not empty.
Moreover, if this line is not correct, this column also displays an error or warning symbol, depending on the severity of the error. A hover help indicates the source of the error.
You can also specify an instance directly from the Link column. To make the input easier, you can open a content assist wizard by clicking Ctrl and the space bar simultaneously. If you have started to enter a name, the content assist displays the instances that start with this input. If you enter the name of an instance that does not exist and if you validate, the input is discarded.
These lines are used for documentation purposes. You can write or edit text in relation to the selected instance. You can write, modify, move, or delete text lines by using the standard word-processing functions.
- Click Add or select this action in the contextual menu to add a comment line or an alias for a Segment. Then, click in the Type column to select the line type to be inserted. Enter the comment or the alias in the Description field.
- Click Add an Input Aid call or select this action in the contextual menu to insert
an Input Aid call. A selection box opens. It displays the available
Input Aids that have a C: Comments type. Select one of them and click OK.
The variable labels and the symbolic values that are indicated in the selected Input Aid -D Lines tab are then displayed in the Description column, in a read-only mode. The Input Aid name is displayed in the Input Aid column.
If you click the Input Aid name in the Input Aid column, a button is displayed. Click it to see all the Input Aid description lines in a detail window. In this window, you can modify the variable labels and the symbolic values.Note: The length of a variable label cannot exceed the length that is defined in the Input Aid -D Lines tab.
- Error
- This column displays a dot on all the existing description lines
that are not empty.
Moreover, if this line is not correct, this column also displays an error or warning symbol, depending on the severity of the error. A hover help indicates the source of the error.
- Type
- You can select one of the following values:
- No value or * to insert a standard documentation line,
- A on a Segment only, to insert an alias for the Segment name.
This column displays a value I on all the Input Aid insertions. This value cannot be selected directly.
- Description
- This column can be entered or not according to the inserted line
type:
- If you inserted a comment or an alias line, you must move your
cursor to this column and enter the required information:
- On a line without any line type or with a * line type, enter a free comment. You can use the standard word-processing shortcuts to copy, paste, and delete text content in the comment lines. Double-clicking a word selects the word.
- On an A line type, enter the Segment COBOL name.
- If you inserted an Input Aid call line, the variable labels and the symbolic values that are indicated in the selected Input Aid -D Lines tab are displayed.
- If you inserted a comment or an alias line, you must move your
cursor to this column and enter the required information:
- Input Aid
- This column contains the name of a called Input Aid. If you click the button that is displayed when you click in this column, you can see the Input Aid description in a detail window. In this window, you can modify the variable labels and symbolic values.
-GE section
- Link
- You use this column when you call a Text (T type line). Click the icon in
this field to display a selection wizard.
Click the Link column and the selection icon to display the available Texts. Select one of them and click OK. This instance is then displayed in the Link column.
You can also specify an instance directly from the Link column. To make the input easier, you can open a content assist wizard by clicking Ctrl and the space bar simultaneously. If you have started to enter a name, the content assist displays the instances that start with this input. If you enter the name of an instance that does not exist and if you validate, the input is discarded.
The Description field can be modified for a Text call to indicate generic codes.
The Text calls for the documentation are aligned according to a standard print layout.
All the Text calls are aligned (except if the non-alignment $$ parameter was used). The $n print windows that are indicated in the Text are respected. If they are not specified, the default print window ($0) is used.
All the text processing options are functional (underlining or negative indentation for example).
Line skips are specified in the Text, but limited to a three-line skip (line skips greater than three become three-line skips); page skips become three-line skips. By default, the skips are one line, except for print windows $0 and $1, where they are two lines.
Selection wizard
- Select instances to add
- You can see the names and labels of the instances that you can select.
If the list is large, you can reduce it by entering a string that is used as a filter. You can filter on the names or on the labels. You can also indicate the maximum number of instances that can be displayed in the wizard.
Select an instance and click OK to insert it.If you right-click anywhere in the list, a menu is displayed. It contains the following choices:- Sort to specify a new sort criterion.
- Display to display more information about each instance line in the list. You can combine the information. To remove information from the line, select it again in the menu.
- New
- Click to create an instance. When it is created, the instance is displayed in the list. You can then select it, like any other instances.
- No selected entity
- Select this option to delete the reference to an entity.
- If the reference is required, this button does not appear in the wizard.
-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 C/S organization, this field must contain the code of the COBOL COPY clause that represents the communication area of the Pacbench C/S application component that 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.
Table 14. Values of the external name Type of COBOL code Field value 1: IBM DOS/VSE This field can have 3 formats: - SYSnnn corresponds to the symbolic unit name.
- XXXnnn corresponds to the symbolic unit name SYSnnn and external name of the XXX file.
- XXXXXX corresponds to the external name. The symbolic unit is generated with SYSnnn. nnn is incremented by one for each Data Structure starting with SYS010.
X: IBM MVS/ESA OS/390 The ASSIGN clause (for sequential files, S: sequential organization) with a SYSnnn external name is generated as SYSnnn-UT-....-S-SYSnnn For OS/390®, it corresponds to the DDNAME.
4: BULL GCOS7 INTERNAL-FILE-NAME 5: BULL GCOS8 File-code (2 characters) F: TANDEM External name I: DEC/VAX VMS External name
- COBOL position
- This field can contain 2 characters. It applies to the main description of a Data Structure
(ddss) and not to the descriptions that 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 or LINKAGE SECTION) or at the beginning of the WORKING-STORAGE SECTION.
This field is reserved for Data Structures whose organization is W: File description in Working or L: Working with placement.
To obtain the description of a Data Structure in the WORKING-STORAGE SECTION, you are advised to indicate it in the work area lines of the COBOL code by inserting micropatterns.
Table 15. Values of the COBOL position Value Meaning 00 The description of the Data Structure is inserted after all the work areas. Alphabetic characters The description of the Data Structure is inserted after all the work areas whose COBOL position corresponds to this value. The description and work areas are found at the beginning of the WORKING-STORAGE SECTION of the generated program. These lines are displayed before the Data Structures whose organization is W: File description in Working and before the Data Structures whose code in the Program is greater than this alphabetic code.
Note: Do not select a COBOL position identical to the Data Structure 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 areas 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 the way the Data Structure is accessed by the Program.
Table 16. Values of the access mode Value Comment S: Sequential Sequential access. R: Direct / Random The read function is not automatically generated. 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 logical records of the file.
Table 17. Values of the recording mode 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
Table 18. Values of the input/output mode Value Comment I: Input Can be selected with a usage set to 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 Can be selected with a usage set to 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 Can be selected with a Types of Code to generate set to 4: BULL GCOS7, 5: BULL GCOS8, 0: IBM MVS/ESA OS/390, U: UNYSIS 2200 Series, F: TANDEM, I: DEC/VAX VMS, and K: ICL 2900. R: Input / Output Direct-access Data Structures only. T: Sort In input or output, depending on the 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 depend on the selected unit type.
- Break level
- For sequentially accessed, sorted files, you must enter the number of Data Elements (elementary
or group) on which a control break processing is specified for the Data
Structure.
O is the default value.
1 to 9 levels, according to the number of Data Elements to be used for control break processing. These Data Elements are identified as the Sort key composition field for this Data Structure.
When there is a control break processing on a Data Structure, two indicators store the status of the records that are being processed:- dd-IBn = 1 for the umpteenth key Data Element of the current record of the dd Data Structure contains a new value,
- dd-FBn = 1 for the umpteenth key Data Element of the current record of the dd Data Structure contains the last occurrence of the present value.
Note: The "umpteenth key Data Element" represents all the key Data Elements up to and including the umpteenth level:When these files are synchronized with others, the control breaks are kept synchronized through two more switches:- ITBn = 1 means that a new value in the umpteenth key Data Element has been detected. It signals the beginning processing on all synchronized Data Structures.
- FTBn = 1 means that the present value of the umpteenth key Data is occurring for the last time. It signals the end processing for the records in this iteration for all synchronized Data Structures.
- 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 Data Elements (elementary or group) on which a 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. However, for a transaction Data Structure, the control break level must be equal to or greater than the file synchronization level.
- The Data Elements that constitute the sort keys of a Data Structure must be sorted in ascending order.
- The Data Elements that constitute 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).
- dd-CFn indicates whether a file must be processed or bypassed in this iteration (1=process or 0=bypass).
- dd-OCn indicates the processing status 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.
Table 19. Values of the Data Structure usage Value Comment 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 Data Structure must be declared as an D: Output file). S: Selected Output file that is extracted from another file. It differs from the D: Output file usage because 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 occurrences that is indicated on each Segment Definition. The maximum number of selected Segments for each Data Structure 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 files. The generated functions range from 30 to 76. Note: Only one M: Transaction to be validated or N: Transaction not to be validated Data Structure is authorized in a Program.N: Transaction not to be validated Input file that can update other files. The generated functions are 30, 33, 39, 70 - 76. Note: Only one M: Transaction to be validated or N: Transaction not to be validated Data Structure is authorized in a Program.E: Transaction with error checking Output transaction file that contains a field that identifies records with errors. Generation of the fields to track the erroneous Data Elements and Segments, and the user-defined errors by using the reserved Data Elements ENPR, GRPR, and ERUT. Selected or not, the descriptions of these Data Elements are generated (by using the DE-ERR and ER-PRR Data Elements).
I: Direct printing Direct printing (or by SYSOUT in IBM MVS). Upon generation, the lines whose structure identifier is 00 in the Report are ignored.
J: Indirect printing Indirect printing to be processed by a spool program. The fields that are required to identify the lines and line skips for example are indicated in the structure identifier 00 in the Report.
Y: Internal codification table
- Sort key composition
- It is the group of the Data Elements that constitute the sort
key for control break processing.
They are identified by the value that is entered in the Sort key field on the Segment -CE Lines tab.
The order for sorting these key Data Elements can be entered here. To do so, you use the values that are assigned on the -CE Lines tab in the appropriate order, from major to minor.
If you do enter anything here, the Data Elements that are coded with value 1 - 9 are taken as the default.
Note: For transaction files, include the action code and record type Data Elements as a part of the key. The order in which these Data Elements are sorted determines 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. It corresponds to the block size (the size of the physical record). Spaces and zeros are equivalent.
The block size can be zero for the following operating systems:The BLOCK CONTAINS clause is not generated in the following cases:- 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.
- Sort Data Structure,
- Data Structure that is stored on a disk if no number is indicated,
- File whose Unit type is set to R: Slow device for IBM DOS (Type of COBOL code set to 1),
- Block 0 for UNISYS A Series (Type of COBOL code set to 8) and AS 400 (Type of COBOL code set to O).
- Block 0 for IBM VSE COBOL II and file whose Block type is set to N: Ignore block management.
- Block type
- Specify whether the block size that is entered in the Block factor field represents a number of records, characters, or whether it must be ignored for the block management.
- Result Data Structure code
If the Data Structure has a Usage set to P: Principal, you must enter the Code in program of the result output Data Structure (2 characters).
If the Data Structure has a Usage set to 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
- You must enter various information according to the value of the Data Structure
Usage:
- With 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 that contains the errors (Usage set to E: Transaction with error checking), if such a file has been called.
- With a Usage E: Transaction with error checking, you must enter the Code in program (on 2 characters) of the corresponding transaction file (Usage set to M: Transaction to be validated or N: Transaction not to be validated).
- With a Usage S: Selected, you must enter the Code in program (on 2 characters) of the input source. On the source Data Structure call line, you must enter the Code in program of the selected Data Structure.
- Transaction break level
- In a transaction file, you must enter the position of the Action code
(from the Segment Definition tab) within the sort key. Example: If the value of the Sort key is ABCDE and the Action code is D, enter 4.It is the most minor key of the sort key. It is used to differentiate one type of transaction from another in the same principal file. Duplicates are detected if any key elements after this one are found to match.By default, the value of this field is the value of the break level that is already entered in the previous window. The value must be one-character long.Note: All spaces are replaced with zeros.
- Physical unit type
- The possible unit type varies according to the Type
of COBOL code:
- If the Type of COBOL code is 1: IBM DOS/VSE, enter the model type (examples: 2314, 3330, 2400).
- If the Type of COBOL code is 3: UNIX, WINDOWS,
enter the following values:
- EXT for the generation of the EXTERNAL clause at the file FD level.
- LS for the generation of the LINE SEQUENTIAL clause.
- EXLS for the generation of the LINE SEQUENTIAL clause and of the EXTERNAL clause at the file FD level.
- If the Type of COBOL code is Q: ACUCOBOL, enter LS for the generation of the LINE SEQUENTIAL clause.
- If the Type of COBOL code is 4: BULL GCOS7, enter
the following values:
- SSF for the option WITH SSF in the SELECT clause.
- OUT for the option -SYSOUT suffix after the file name in the SELECT clause (WITH SSF is generated).
- If the Type of COBOL code is 5: BULL GCOS8, enter
the following values:
- PT for printer
- CR for card reader
- SSF for ORGANIZATION IS GFRC SEQUENTIAL SSF CODE SET IS GBCD
- IBM for ORGANIZATION IS IBM-OS SEQUENTIAL
- xxx for WITH xxx
- If the Type of COBOL code is 8: UNYSIS A Series,
enter the following values:
- DK or blank for disk
- DKS for sort disk (with T opening)
- DKM for merge disk (with T opening)
- RD for reader
- PT for printer
- PO for file
- TP for tape
- P for purge
- R for release
- L for lock
- S for save
- If the Type of COBOL code is U: UNYSIS 2200
Series, enter the following values:
- CR for card reader
- CP for card punch
- UN for UNISERVO
- TP for tape
- PN for printer with external name. If the Complement field contains a value, the RECORDING clause is also generated.
- PT for printer without external name
- PF for printer with external name and the following lines:
- VALUE OF PRINTER-FORMS 3-FF00-FORMS
- LINAGE IS 3-FF00-LINES
- TOP IS 3-FF00-TOP
- BOTTOM IS 3-FF00-BOTTOM
- If the Type of COBOL code is O: AS/400, enter the
following values:
- RD for reader
- CP for card punch
- DB for database
- PT for printer
- TP for tape
- DK or blank for disk
- Complement
- It is a complement to the Physical unit type field.
The purpose of this field varies according to the Type
of COBOL code.
Table 20. Values of the complement to the physical unit type Value Type of COBOL code R: reader 1: IBM DOS/VSE P: punch 1: IBM DOS/VSE S: EBCDIC set code 5: BULL GCOS8 and U: UNYSIS 2200 Series C: ASCII set code 5: BULL GCOS8 O: OPTIONAL option not to be generated 4: BULL GCOS7 and 5: BULL GCOS8 A: ALLOWING ALL file optioning option & REGARDLESS sequential reading I: DEC VAX VMS
- File status
- This field is optional.
If you specify it, you are advised to specify a character string, on 10 characters maximum, in the following format: ddsseeeeee. In this format, dd is the Data Structure, ss is the record (00 is advised), and eeeeee is the Data Element.
The use of this field varies according to the Type of COBOL code and to the Data Structure call Organization.- For non-VSAM files and all environments except BULL GCOS8, the nominal, symbolic, or actual key, is generated according to the Type of COBOL code. You must define the corresponding work area (for example 1-ddss-eeeeee). You must also specify, with specific code, the positioning of this key and the reading of the Data Structure.
- For VSAM files, the return code area of input/output operations is generated. The corresponding VALUE OF clause is generated only if it is defined as a work area and specified in specific code.
- For BULL GCOS8, the Data Structure is identified. The corresponding FILE STATUS IS clause is generated if it is defined as a work area and specified in specific code.
- Access key Data Element code
This code, on 6 characters, is required for indexed files.
A free reference is set when you indicate a Data Element in this field.
Content assist is available on this field, as shown by the symbol
in front of the field. To activate it, press Ctrl+Space. A subreference link is automatically created, even if the instance does not exist. From the target instance in the subreference results, you can start a super reference search.
- Record type Data Element code
Enter 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.
- Suffix in program
- The suffix is optional. When the Report is used only once in a Program, it is not relevant to indicate it. However, if it is called more than once, you can differentiate these calls by indicating a different suffix each time the Report is called.
Macro call
- Line number
- This field contains the line number, constituted of two numeric characters. When a Macro is parameterized, it is used to call it more than once into the same program.
- $A to $J parameters
- Initially, only the first 10 parameters ($n, with n= 1,2 to 9,0) are displayed. So you can click Add to add 10 more parameters.
- Parameters
- This table contains the replacement values of the parameters in
one of the following forms:
- A simple character string (or a blank) in the Value column. The number of characters that is used for each parameter value corresponds to the appropriate field length for the element being parameterized. For example, if $1 is used as a function code, the value must be 2 characters long.
- A Data Element, Data Structure, or Segment. In this case, the instance is selected in the Entity linked column. It is preceded, in the Value column, by E=DELCO, D=DD, or S=SEGT (where DELCO, DD, and SEGT represent the instance code). At the time of transformation, the parameter is replaced by DELCO, DD, or SEGT and cross-references are set up.
Data Element call
- Line type
- Select which format is 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 subfields:
- The Level or section, which is constituted of the first 17 positions of the field, In this subfield, you must enter the COBOL level number (such as 01 or 05) or the section name (such as LINKAGE SECTION) where this line is to be generated.
- The work area declaration, from position 18 to the end of the
field. You must declare the beginning of the data name, which is
to be concatenated with the Data Element name to constitute the actual
data name. So you must enter w-ddss- (without omitting the dashes), where:
- w = WORKING-STORAGE SECTION prefix (alphabetic or numeric),
- dd = Data Structure that contains the work area
- ss = Segment
Note: When a defined Data Element is called in a work and linkage area, you must enter the beginning of the data name in this field. Otherwise, the generated code is formatted: 03 DDSS-DELCO PICTURE X.
- Text after
- In this field, you must enter the characters that are to be inserted in the generated code after the data name. Most often, you enter a period (.) but you can also enter other values (for example: VALUE SPACE).
Pacbase COBOL in PDP
To see the content of this view, you must have generated a Program, Screen, or Server. Then, from the Design Explorer view or the result view of a local or server instance or reference search, open the generated file by right-clicking it and selecting the PDP COBOL editor. For example, for a Program generated file, select in the contextual menu of the generated Program. The editor must remain opened and currently selected.
Dialogs/Screens
- The long label (36 positions), which is entered on the Data Element Definition tab,
- The short label (18 positions), which is entered on the Data Element -D Lines tab,
- The relational label (18 positions), which is entered on the Data Element -D Lines tab,
- The column heading label, which is entered on the Data Element -D Lines tab.
The values of the field correspond to the association between the Data Element and the presentation characteristics for these labels.
Value | Comment |
---|---|
Default value | Defaults to the value specified in the Dialog. |
F: Data Element only | The Data Element is displayed without any label. |
L: Data Element with long label, left-aligned | The Data Element is preceded by the Data Element label, left-aligned, on 36 positions. |
M: Data Element with long label, right-aligned | The Data Element is preceded by the Data Element label, right-aligned, on 36 positions. |
N: Data Element with long label, left-aligned, trimmed right | The Data Element is preceded by the Data Element label, left-aligned with the deletion of blanks on the right. |
R: Data Element with long relational label, left-aligned | The Data Element is preceded by the relational label, left-aligned on 18 positions. |
S: Data Element with short label, left-aligned | The Data Element is preceded by the short label, left-aligned, on 18 positions. |
T: Data Element with short label, right-aligned | The Data Element is preceded by the short label, right-aligned, on 18 positions. |
U: Data Element with short label, left-aligned, trimmed right | The Data Element is preceded by the short label, left-aligned, with the deletion of blanks at the end of the string. |
1: Data Element topped by a single line column label | The Data Element is topped by the column label on one line. |
2: Data Element topped by a 2–line column label | The Data Element is topped by the column label on two lines. |
3: Data Element topped by a 3–line column label | The Data Element is topped by the column label on three lines. |
Position
- Position type
- In this field, you select one of the following positioning values for the Screen element:
- Relative positioning.The specified line and column numbers correspond to a move relatively to the Data Element that is located just before in the list. The positioning of the preceding Data Element is calculated according to the nature of this field.
- For a Data Element call (elementary or repeated Data Element, whatever its presentation), the starting point of the positioning is calculated from the upper right corner of the contents (and not the label) of the preceding Data Element.
- For a Screen call, the positioning is calculated from the lower right corner of the called Screen in the calling Screen.
- A: Absolute positioning. In this case, the line and column numbers correspond to the absolute address of the element on the Screen.
Notes on position: The position that is defined by the position type, line, and column numbers, is the position of the first character of the contents (if the presentation type is Data Element only, or Data Element with a column label), or of the label for the other presentations. - Relative positioning.
- Line
- Enter two numeric characters to specify the line number that determines the position of the
element.
- In a relative positioning, it is the number of lines between two elements. If the presentation type corresponds to a column heading, the number of lines in the column heading is automatically added, upon generation, to the indicated number.
- In an absolute positioning, it is the line number on the Screen.
Line overflow is automatically controlled.
If both the line and column numbers equal zero, the element is automatically moved to the next tabulation point available.
- Column
- Enter three numeric characters to specify the column number that determines the position of the
element.
- In a relative positioning, if the line number is zero, the column number corresponds to the number of spaces between two elements on the same line. If the line number is greater than zero, the column number corresponds to an absolute positioning.
- In an absolute positioning, the column number is the address of the element on the line. A zero value corresponds by default to column 2 upon generation (column 1 being reserved for the attribute). If the value is 1, the attribute is on the preceding line.
Any line length overflow and field overlapping are automatically detected. However, the presence of a space in front of each field is not verified.
If both the line and column numbers equal zero, the element is automatically moved to the next tabulation point available.
- Intensity
- Select its intensity attribute among the following values:
- Default value defaults to the Dialog Definition.
- N: Normal is the default value at the Dialog level.
- B: Bright means that it is highlighted.
- D: Dark means that it is hidden.
- Presentation
- Select its presentation attribute among the following values:
- Default value defaults to the Dialog Definition.
- N: Normal is the default value at the Dialog level.
- B: Blinking.
- R: Reversed video.
- U: Underlined.
- Color
- Select its color attribute among the following values:
- Default value defaults to the Dialog Definition.
- W: Normal is the default value at the Dialog level.
- B: Blue.
- R: Red.
- P: Pink.
- Y: Yellow.
- G: Green.
- T: Turquoise.
Screen/Dialog - Server/Server Dialog -CS lines
id
- Category
- This field indicates the category where the Segment is processed. The categories and the
Segments that they contain are processed in the following order:
- Blank: Top category
- R: Repetitive category
- Z: Bottom category
- Segment code
- It is required. It corresponds to the Segment or Logical View name in the generated COBOL code. It can be identical to the name that is stored in the repository. Its value is displayed in the Name column of the table.
- Segment code
- This code is required. It corresponds to the Segment or Logical View name in the COBOL code of the Business Component. It can be different from the name that is stored in the repository. Its value is displayed in the Name column of the table.
- Segment
- Specify the name of the Segment in the repository. To do so, click
Change. A selection wizard opens with the Segments that can be selected.
Select or create a Segment and click OK. In the table, it is displayed in the
Seg / LV column.
You can also specify the Segment directly from the Seg / LV column.
Two methods are possible:- Place the cursor in the column and enter the name directly. To make the input easier, you can open a content assist wizard by clicking Ctrl and the space bar simultaneously. If you start entering a name, the content assist displays the instances that start with this input. If you enter the name of an instance that does not exist and if you validate, the input is discarded.
- Click the button that appears when you set your cursor in the column. In the selection wizard that opens, select an instance.
- Database Block
- This field is available only if you select H: Relational database accessed with
SQL in the Organization field. Then, you can indicate the
Database Block that contains the called resource. To do so, click Change and
select or create an instance in the wizard that opens. In the table, the selected instance is
displayed in the D. Block column.
You can also specify the Database Block directly from the D. Block column.
Two methods are possible:- Place the cursor in the column and enter the name directly. To make the input easier, you can open a content assist wizard by clicking Ctrl and the space bar simultaneously. If you start entering a name, the content assist displays the instances that start with this input. If you enter the name of an instance that does not exist and if you validate, the input is discarded.
- Click the button that appears when you set your cursor in the column. In the selection wizard that opens, select an instance.
- Table or view
- This field is associated with the Database Block field. You use it to indicate a table or view call.
- Line number
- This field is numeric. Only one 00 line number (default) is authorized in a Segment. This 00 line is required to enter the physical characteristics of the Segment (external name, organization), the name of the Segment access key, and the Segment code in the repository.
Logical characteristics
- Generation limitation
- Select the generation limitation of the logical access level to Segments:
- Automatic.
The logical access is generated automatically, according to the use of the Segment.
- U: User-defined Segment.
The Segment access is described by the user (organization different from X).
- P: No description of Segment.
The Segment access is not described (organization different from X).
- Automatic.
- Generation limitation
- In the list, select the generation limitation of the logical accesses to Segments.
- Automatic.
The logical access is generated automatically, according to the use of the Segment.
- U: User-defined Segment.
The Segment access is described by the user (organization different from S).
- P: No description of Segment.
The Segment access is not described (organization different from S).
- Automatic.
- Control break
- You can indicate that a Data Element that belongs to the key in the repetitive part must remain
constant upon the display or selection of a list. Only the records that have this key value are
kept. You must then specify a control break.
Table 22. Possible values for the control break. Options Description No control break No control break is specified for the display or the selection. C: display break A control break is specified for the display or the selection. E: display break (SQL) For an SQL organization, it is a display control break. It generates an equal condition in the WHERE clause of the SQL DECLARE CURSOR statement. It replaces >=, which is generated otherwise. R: Large reading of the Folder (Server only) This option is available with Segments whose organization is H, D, or V. It must be selected to specify a large reading, such as the display of all the lines of all the orders, for each Segment that is associated with the Logical View. You must select the value R on each key Data Element that corresponds to a key Data Element of the Logical View. The Logical View must belong to the Folder root node if a Folder is implemented.
- Control break
- Select the control break indicator.
Table 23. Possible values for the control break. Options Description No control break. No control break for organizations different from S. It indicates that a Data Element that belongs to a key in the repetitive part must remain constant during the selection.
C: display break Display break for organizations different from S. It indicates that a Data Element that belongs to a key in the repetitive part must remain constant during the selection.
E: Selection for control break (SQL) For an SQL organization, it generates an equal condition in the WHERE clause of the SQL DECLARE CURSOR statement. R: Large read (Folder) This option is available with Segments whose organization is H, D, or V. It must be selected to specify a large reading, such as the display of all the lines of all the orders, for each Segment that is associated with the Logical View. You must select the value R on each key Data Element that corresponds to a key Data Element of the Logical View. The Logical View must belong to the Folder root node if a Folder is implemented.
- Subschema
- This field is used with the Pactables function to indicate which subschema is
to be described. You must select either All Data Elements or a description
from 0 to 9. The value 0 corresponds to subschema 10. A subschema is a group of Data Elements that
are present in the Segment composition.
- For the G-type (Table) or H-type (relational
database accessed through SQL) organizations, this field indicates the number of the Table
subdescription or subschema that the input/output area description corresponds to. If the called
Segment corresponds to a view and no subschema is specified, the value is specified on the Block
-DR Lines:
- All the Data Elements of the Segment
- Subdescription or subschema 0-9
- For the V-type (indexed) organization, it is the secondary access keys to
indexed files.
- The secondary key is specified with the value 2. The primary key must be indicated on the 00 line of the Segment without use in display or reception, even if it is not used, to generate the RECORD KEY clause. If the secondary key is a group field, the number of the subschema must be indicated for this group area only.
- The value 3 indicates that the secondary key is
DUPLICATE.Note: This specification is not implemented in the CICS® variant because the declaration of the secondary keys is performed at the VSAM definition.
- For the G-type (Table) or H-type (relational
database accessed through SQL) organizations, this field indicates the number of the Table
subdescription or subschema that the input/output area description corresponds to. If the called
Segment corresponds to a view and no subschema is specified, the value is specified on the Block
-DR Lines:
- Generate level
- In this field, you enter the levels of the generated subfunctions. For the values between 06 and 98, the processing that depends on the use (in reception and display) of the Segments that are used in this Screen is automatically generated in the Business Component that is associated with the client component. The default hierarchical level of these subfunctions is 10.
- Generate level
- Not used for a Business Component.
Access key filling
- Previous Segment code
- Enter the code of the Segment that is to be accessed before the Segment code in the program (see the Segment code field in the Id panel). Several Segments can be accessed in each category. Therefore, you can indicate a hierarchy to access the Segments of a category. This field contains the previous Segment in the access hierarchy. This Segment must belong to the same category. If several Segments have the same previous Segment, they are processed alphabetically.
- Each Segment must be linked directly or indirectly to the Logical View that it depends on. It
must include the code of a previous Segment or of its Logical View (S
organization).Exception: The Segment that is dedicated to the error messages must not include the previous Segment. A Logical View cannot have a previous Segment.
- Reception
- You specify the way that the Segment is used in the validation and update processing. Select an
option in the list.
Table 24. Values of the use of a Segment in the validation and update processing Options Description No value or N: Not used For an organization different from X, S, and 2, no access is generated for this Segment in the validation and update processing (default). For a 2 or X organization, no Server call is generated.
L: Read For an organization different from X, S, and 2, a simple read command is generated for the Segment. For a 2 or X organization, a Server is called for selection.
E: Existence validation For an organization different from X, S, and 2, an existence validation is run. A read command with the setting of an error code is generated (if it is not found). For a 2 or X organization, a Server is called for validation.
M: Update (modification) For an organization different from X, S, and 2, the Segment is updated (modification only). For a 2 or X organization, a Server is called for validation and update.
X: Update (creation and modification) For an organization different from X, S, and 2, the Segment is updated (creation and modification only). For a 2 or X organization, a Server is called for validation and selection.
S: Update Segment (deletion only) For an organization different from X, X, S, and 2, the Segment is updated (deletion only). C: Update Segment (creation only) For an organization different from X, X, S, and 2, the Segment is updated (creation only). T: Update (creation, modification, and deletion) For an organization different from X, S, and 2, the Segment is updated (creation, modification, and deletion). In these cases, the existence validations and the update statements that correspond to the selected options are generated. If the Segment is related to a previous Segment, regardless of the indicated use, only the update commands for modification and creation are generated.
For a 2 or X organization, a Server is called for validation, update, and selection.
U: Call of a user service For a 2 or X organization, a user service is called.
- Reception
- You specify the way that the Segment is used in the validation and update processing. Select an
option in the list. For an S
organization, no value is entered in this field (default value).
Table 25. Values of the use of a Segment in the validation and update processing Options Description No value or N For an organization different from X, S, and 2: No access statement is generated for this Segment in the validation and update processing (default). For an X or 2 organization: No Server call is generated.
L: For an organization different from X, S, and 2: A simple read command is generated for the Segment. For an X or 2 organization: Server call for selection.
E: For an organization different from X and 2: Existence validation to run. A read command with the setting of an error code is generated (if it is not found). For an X or 2 organization: Server call for validation.
M: For an organization different from X, S, and 2: Updated Segment (modification only). For an X or 2organization: Server call for validation and update.
X: For an organization different from X, S, and 2: Updated Segment (creation and modification only). For an X or 2 organization: Server call for validation and selection
S: For an organization different from X, S, and 2 only: Updated Segment (deletion only). C: For an organization different from X, S, and 2 only: Segment (deletion only) T: For an organization different from X, S, and 2: Updated Segment (creation, modification, and deletion). In these cases, the existence validations and the update statements corresponding to the selected options are generated. If the Segment is related to a previous Segment, regardless of the indicated use, only the update commands for modification and creation are generated.
For an X or 2 organization: Server call for validation, update, and selection.
U: For an X or 2 organization only: User defined logical accesses
- Display
- You specify the way that the Segment is used in the display processing. Select an option in the
list.
Table 26. Values of the use of a Segment in display Options Description No value or N: Nor used For an organization different fromX, S, and 2, no access is generated for the Segment in the display processing (default option). For a 2 or X organization, no Server call is generated.
A: Used in display For an organization different fromX, S, and 2, the access is generated for the display according to the type of logical access processing. If the previous Segment code is blank and the Segment is used, the key is saved in the conversation area. For a 2 or X organization, a Server is called for selection (not compatible with the L value in reception).
U: Call of a user service For a 2 or X organization, a user service is called.
- Display
- For a use in display, select one of the options in the list. For an S
organization, no value is entered in this field (default value).
Table 27. Values of the use of a Segment in display Options Description No value or N For organizations different from X, S, and 2: No order is generated for this Segment in the selection processing (default option). For an X or 2 organization: No Server call is generated.
A: For organizations different from X or 2: Used in selection. The access order is generated for the selection according to the type of logical access processing. If the previous Segment code is blank and the Segment is used, the key is saved in the conversation area. For an X or 2 organization: Server call for selection (not compatible with the L value in reception).
U: For an X or 2 organization only: Call of a User service
- Access key source
- In this field, you can indicate a Screen field, a literal, or a working area.Example:
- 0001-delco for a Screen field, or I-0001-delco for an input field (reception). In this example, 0001 is the Screen and delco is the Data Element.
- 02 for a literal.
- ww10-delco for a working area. In this example, delco is the Data Element.
A free reference is set when you indicate a Data Element in this field.
Content assist is available on this field, as shown by the symbol
in front of the field. To activate it, press Ctrl+Space. A subreference link is automatically created, even if the instance does not exist. From the target instance in the subreference results, you can start a super reference search.
If you put the cursor from the first to the fourth position of the field, the content assist wizard first displays the list of Segments. Select one of them, then click the field again and press Ctrl+Space again. The content assist then displays the list of Data Elements. Select one of them.
The content assist also displays the list of the Data Elements after a dash from the seventh position (I-ww10-delco for example).
- Access key source
- This field can be used as a working area (ww10-delco for example) or a
literal (02 for example).Note: The key loading for the lists must always be performed from the 1- area in the Servers if the key is in the repetitive category of the Logical View.
A free reference is set when you indicate a Data Element in this field.
Content assist is available on this field, as shown by the symbol
in front of the field. To activate it, press Ctrl+Space. A subreference link is automatically created, even if the instance does not exist. From the target instance in the subreference results, you can start a super reference search.
If you put the cursor from the first to the fourth position of the field, the content assist wizard first displays the list of Segments. Select one of them, then click the field again and press Ctrl+Space again. The content assist then displays the list of Data Elements. Select one of them.
Primary access key
You select a Data Element or you enter the name of a new Data Element that is to be used as the primary access key to the Segment. It is used to generate the RECORD KEY clause. For a VSAM file (V organization), it must be entered on the Segment 00 line. The Data Element that is specified in this field is considered as a group Data Element, except for SQL organizations where it is considered as an elementary Data Element.
- Data Element
- Specify the Data Element that is used as an access key to the Segment. You can select a Data
Element or change the called Data Element by clicking Change. A selection
wizard opens with the Data Elements that are called in the Segment. Select one of the Data Elements
and click OK. In the table, it is displayed in the Access
key column.
You can also specify the Data Element directly from the Access key column.
Two methods are possible:- Place the cursor in the column and enter the name directly. To make the input easier, you can open a content assist wizard by clicking Ctrl and the space bar simultaneously. If you start entering a name, the content assist displays the instances that start with this input. If you enter the name of an instance that does not exist and if you validate, the input is discarded.
- Click the button that appears when you set your cursor in the column. In the selection wizard that opens, select an instance.
- Undefined Data Element
- If the primary access key is a group Data Element, and if different values are given to the individual members of that group, enter the elementary Data Elements of the group in the Undefined Data Element field.
For a Table (G organization), you select a subsystem by indicating the value NUSSY in this field. The associated key (G-ddss-NUSSY) is generated.
For SQL database Segments, a key element must be entered on each line where the value of the Display field is not N.
In generated access level, the Segments are selected when the keys are equal for an update or a direct read. For a sequential read in the repetitive category, the Segments are selected when their keys are equal or greater.
A Segment cannot contain more than 10 key Data Elements.
If the error message Segment is an SQL/DS Segment or if it has a V or W organization, the Data Element key must be ERKEY.
- Conventional (fixed) (default value) for a Segment that might have a specific part. For example, it can be a Data Structure with a Segment.
- 1: Database Segments for a Segment without any common part. For example, it can be, for a database, various Segments that are defined in the same Data Structure.
- E: Table type for Table-type Segments. The input format of the Data Elements that are called in the Segment is taken into account.
- 2 : Conventional (variable) for a complete Segment with a variable length for an indexed organization (V). The generated description can vary according to the generation variant.
Options | Comments |
---|---|
V: Indexed | Segment with an indexed organization. |
G: Table type | Table type Segment. The generated access corresponds to the call of the general module of the Pactables function. |
H: Relational database accessed with SQL | Segment of a relational database that is accessed with SQL. The Segment description and the physical accesses are generated. The cursor declaration is generated for the Segments of the repetitive category. |
W: Managed by procedures, display keys positioned | The Segment access is managed by specific processing. The display keys are automatically filled in (functions F40 and F60). |
X: Server call for validation and selection | Server call for validation and selection. |
- External name
- The default value corresponds to the first 2 characters of the Segment in the program. The
content of the field depends on the organization.
- For a V (indexed) organization, its value varies according to the type of COBOL:
- For IBM CICS-VSAM, it is the DDNAME (1 - 8 positions).
- For GCOS8-TP8, it is the external name (4 characters), which is generated in the SELECT clause.
- The blocking factor (last 4 characters) is generated in the FD clause.
- For the other types of COBOL, it contains the logical name, which is generated in the SELECT clause.
- For an H (SQL) organization, it is the SQL Database Block where the table
is described.
At generation time, the external name of the table or view is searched for in the Block description. If it is not found, the external name is taken from the Segment Definition
- For a G organization, in CICS, it corresponds to the 4 characters of the DDNAMEs of the files that are managed by Pactables. These characters are the transaction code that is used to access Pactables files.
- For an X organization (Server call), it is the called Business Component.
- For a V (indexed) organization, its value varies according to the type of COBOL:
You can create call lines and remove or reorder the existing call lines from the contextual menu or the buttons that are associated with the table. From the contextual menu, you can also copy, paste, expand, or collapse the existing call lines.
You can enter the information on the call lines in the corresponding definition sections. For example, you enter the call information of a Segment in the -CS Lines - Segment call definition section.
You can also enter the information directly in the table. Some of the columns in the table display values in a list. When you move your cursor on a value of the list, the label that is associated with the value is displayed in a tooltip.
In the Access key, Seg / LV, D. Block, and Server columns, you can call an instance directly or replace a called instance.
-GO
Values | Meaning |
---|---|
ATTRE | UNISYS 2200: Definition of the default attributes at the Screen level. |
ATTRIB | UNISYS 2200: The display of the attributes dynamically specified
(Reverse video and Blink) is kept. This option applies
to F7020. CICS: The dynamic modification of the presentation attributes is taken into account. This option applies to F7020. |
BREAKDATE | Breaks down date Data Elements. The date Data Elements is broken down into elementary Data Elements upon generation. You can also inhibit this option by entering BREAKDATE=NO if it was set to YES at the Library level. This breakdown is effective in the following entities:
Notes:
A date is broken down only if the generated COBOL level of the date field is lower than or equal to 47. If a VALUE has been entered, it is generated in the group field. Any additional information (such as a VALUE) must be entered on the same line as the Data Element call on I, E, or S-type lines in the work areas. If a continuation line has been specified, the date is not broken down. The Data Elements that are called in SQL Segments cannot be broken down, except if these SQL Segments are DB2 Segments and if the DESCR=ALL option is entered on the DB2 Database Block. Since host variables cannot be group fields, the elementary fields are generated under a redefined group field in the following way: ffnn-date-BRK REDEFINES ffnn-date. |
CSSA | Memorizes all the SSAs upon a generated access to a database. This option is
valid for all the Screens of a Dialog. When this option is specified, all the Screens in the Dialog must be recompiled because the length of the communication area is increased. |
CVISION | GCOS6: Downloads the standard validations (presence validation, numeric validation, formatting of the initialization character) onto the CVISION screen manager, thus improving performances. |
DCPROC | Generates the DECLARE CURSOR of DB2, NONSTOP SQL, and DATACOM tables in the PROCEDURE DIVISION,
FOC function. If this option is not specified, the DECLARE CURSOR is generated in the WORKING-STORAGE SECTION. |
DFHAID | IBM CICS: Initializes the PF key table with the content of DFHAID. |
DYNAM | Calls Pactables Tables with a dynamic call. |
DYNPRT | Specifies the recognition of the variable field protection in the
DE-AT table (position 5) and the automatic processing of the protection in
F7020. Enter an F in position 5 of the DE-AT table for the Data Element. The Data Element then becomes protected and is received by the program (nature F). This option is unavailable with the IBM 36, UNISYS A series variant (SDF format). |
F10 | Processes each category (top, bottom, repetitive), if the category contains at least one variable field or access to a Segment. |
FOR | Formats the generated COBOL lines. The DATA DIVISION lines
are left-aligned, the PROCEDURE DIVISION lines are not aligned and there is one
COBOL command per line. This option can be entered on the Library Definition tab. In this case, the Dialog is generated in formatted COBOL even if the FOR option is not explicitly entered at this level. With this
option, up to 150 lines are possible in a COBOL paragraph (between two periods).
Warning: This option still exists but is no longer
maintained
|
HEXVAL | UNISYS A: Generates fields with an HEXADECIMAL value in PIC XX. |
HLPI | Generates the file access with the HLPI interface. |
HLPVAL | The values to be checked (indicated in the -D Lines of a Data Element) are sent to the error messages file. It is true even if this check has been removed from the Screen in which the Data Element is called. |
HPRT | Calls the documentation that is associated with the protected fields
(P or F type). It includes the documentation of the
Data Element and the associated Texts and comments in the Screen -GC Lines
section. In the help program, the screen flow is as follows: first the help on the variable Data Elements, then the help on the protected Data Elements (in the order of the -CE Lines tab). |
IMSME | Generates the multiscreen variant for IMS. |
INDEXS | DL/1: Generates the Segment access through secondary indexes. This option is not compatible with the NOP58 option if the target Segment code is different from the source Segment code and if the source Segment is not generated in the PSB field. |
LOGMES | With the CICS multiterminal and MICRO
FOCUS variants, this option generates a logical message. This message manages both the screen
display and the sending of messages to the communication monitor. This monitor is selected with the
MONIT option (if it is not a default value in the variant). AS400 and IMS: This option is used only for the internet. |
LPAGE or LPA | Manages the LOGICAL PAGING in implicit mode (with PA1
function key) or in explicit mode (with a logical paging operator on the Screen -CE
Lines tab). The LPAGE option is available with a monitor, a submonitor, or with MONITOFF. With the MONITOFF option, paging applies to the same Screen only. With a monitor or submonitor, paging applies
to several Screens if the Screen codes are entered on the Dialog work areas.
Note: If submonitors
are used, all the Screens that constitute a paging group must be in the same
submonitor.
The LPAGE and SWAP options are not compatible. If they are both indicated, only the LPAGE option is recognized. |
MONIT | IBM CICS and UNISYS A Series: Generation with a monitor. |
MONITOFF or MOFF | IMS: One transaction code per Dialog
Screen and no monitor generation. MONITOFF and NOTRAC are incompatible. If both are entered, only the MONITOFF option is recognized. |
NOATTR | IMS: Generates the protected fields in the MOD without their attributes (ATTR=YES). This option is valid for all the Screens of a Dialog. |
NOLOCK | AS400: Reads the Segments without update. It adds the WITH NO
LOCK clause in the read function when the file is open in OPEN I-O. This option does not work if several Segments of a same file are accessed, some with update, some without, because READ WITH NO LOCK removes the preceding lock. |
NOMAP | Generates or does not generate the map, according to the value of the option
in the Dialog and the Screen. The generation of the map also depends on the Generation with map check box in the Screen Definition. The value NOMAP is equivalent to NOMAP=YES. It inhibits the generation of the map. The value NOMAP=NO generates the map. The value of the option in the Dialog is automatically taken into account in the Screen. To keep this value in all the Screens of the Dialog, there is no need to enter this option in all the Screens. However, to modify the value of the option that is indicated in the Dialog in some
Screens, you must indicate it. The two following cases are possible:
|
NOOCF | The OCF variable is not set to value 1 upon the first program run (no F0160 function). |
NOOPEN | MICRO FOCUS and DEC: Optimizes the opening of the HE file (help file backup), the LE, OU, EM (error messages) files, and the CONNECT to ORACLE. |
NOOPENB | HP3000, TURBOIMAGE: Stops the opening of the TURBOIMAGE database. The OPEN is not generated in the program. |
NOPSB | Limits the Segment generation. In each Screen, only the Segments in use and their hierarchical parents are generated. In the monitor and submonitors, the PSB field is no longer generated and is not sent to the Screens. |
NORPT | No automatic processing of repeated Data Elements. |
NOSAV | With DEC/VAX, GCOS7, MICRO FOCUS, ICL, IBM 36 and 38, and BOS/TP: Avoids generating the description of, and the physical access to the HE help file. |
NOSDERR | UNISYS 2200: Recognizes the ERMSG Data Element in the message, which therefore is not sent by the SEND ERROR clause. |
NOTRAC | IMS: The transaction code is not generated in the MID of the first Screen of the Dialog. |
OCF | The OCF variable is set to value 1 upon the first program run (current default value). |
OFF | The programs and maps of the Dialog are generated with option MDT-OFF (default value for GCOS7 FORMS). |
ON | Default value (except for GCOS7 FORMS). The programs and maps of the Dialog are generated with the MDT-ON option. |
PACSQL | Recognizes the data that is entered in the Segment -GG Lines for the SQL statements. |
PSBINIT | CICS-DL/1 Screen with monitor option: Used for the connection to the PSB and its termination (SCHEDULE PSB and TERMINATE) on the submonitor and not on each Screen. |
REFER or REF | Generates the list of all the Data Elements that are used in a Dialog. This
list is formatted as comments in the WORKING-STORAGE SECTION. It includes the
following Data Elements:
|
REPET or RPT | Validation, transfer, and positioning of the attributes for the variable
fields that are repeated horizontally or vertically. When a repeated field is used in a Segment access, you must indicate the number of repeated uses in the Segment call of the Screen. |
SQLALL or SQA | SQL: All the table columns are listed in the Segment access
commands:
|
SQLCA or SQC | SQL: The INCLUDE SQLCA statement is generated in the WORKING-STORAGE SECTION if one or more DB2 or NONSTOP SQL Segments are called in the Screen (-CS Lines tab, Organization = S, Q, or N). |
SQLIND or SQI | The presence indicators are generated for the Data Element before it is updated or displayed. |
SQLREF or SQR | The indicators are generated for the new V-FFnn-DELCO structure. Cross-references are then automatically managed. |
SSMON | The PSB of the submonitor that each Screen belongs to is recognized. One PSB is then generated for each submonitor instead of one PSB for all the Screens in the Dialog (see the -GG Lines). |
SWAP | IMS: Option to be used with a monitor or
submonitor. The code of the Screen to branch to through a function key is indicated in the MFS map. In each map, a 10-character FUNC field is generated and includes the PF key value and the external name of the next Screen to branch to. For End-Of-Conversation, the external name of the Screen must not be entered. When using deferred branching, or setting OPER with the PF key, the external name is that of the generated map. The FUNC field is processed in the monitor or submonitor. The SWAP option improves performance as it avoids loading the program which processes the branching. Note: If the
MONITOFF or LPAGE option is selected, the
SWAP option is not taken into account.
|
TMF | TANDEM: With this option, the transactional mode is recognized by the generation of BEGIN-TRANSACTION and END-TRANSACTION in the requesters and of BEGIN-WORK and COMMIT-WORK orders in the Pacweb communication monitor. |
TS | CICS: The communication area is managed outside the LINKAGE SECTION. This area is described in WORKING and saved in TEMPORARY STORAGE by default. In addition, if MDTOFF and call of the help function, the Screen is saved in only one area. |
TZVAR | BULL: With this option, the reception and display areas are used in case of error. |
ZNUM | The transfer of the numeric fields to the message (F8145) is conditioned by the fact that no error was encountered (SCR-ER = 0). |
Values | Meaning |
---|---|
CALLSPG | Option possible on a Client Monitor or Server Monitor. Call type used by the Client or Server Monitors to call the associated Clients or Servers. The default value is CALL. If there is no Client Monitor, it is the call type of the Server by the Client. |
CALLTYPE | Option possible on a Client Monitor, Server Monitor,
Communication Monitor, Business Component, or Folder. Call type of the Server by the Client. For CICS, the 2 following values are possible: LINK and CALL. |
FORMAT | Format of the Logical View Data Elements. With the INTERNAL value, the Data Elements that are called in the Logical View are generated with their internal format and their usage is recognized. With the EXTENDED option, the format of the Data Elements is computed. Their usage is ignored and replaced by the DISPLAY usage. For signed numeric Data Elements, it is replaced by the SIGN IS LEADING usage. |
INICHECK | Check of the Data Element presence. Option for a TUI client Dialog. A buffer for the Data Element presence is generated and initialized to P (absent Data Element). When Data Elements are transferred (F30 function), the host variable indicator of each Data Element actually transferred is set to N. The transfers for display are also conditioned by the Data Element presence. |
INITSERV | Call of an Initialization and Termination Business Component
(IT type). A free reference is set when you indicate an Initialization and Termination Business Component. Content assist is available on this field, as shown by the symbol |
LGCOMZS | Option possible on a Client Monitor or Server Monitor. Length of the communication area between the Client and Server Monitors. Its value must be 5 characters long (default: 32000). |
LTHENATT | Length of the backup area of the DE-ATT table (default: 2000). |
LTHREPET | Length of the backup area of the repetitive category (default: 1000). |
LTHSCREEN | Length of the backup area of the screen message (default: 6000). |
NUVERS | Version management of the Business Component, the Folder or Folder
View proxy, and the TUI Client. This option is not used in Rational Programming Patterns. |
TERMSERV | Call of a Termination Business Component. |
Values | Meaning |
---|---|
ACCESERR | Maximum number of errors on Segment access that can be returned
to the Client. The value is on 3 characters (default value = 001). |
CALLSPG | Option possible on a Client Monitor or Server Monitor. Call type used by the Client or Server Monitors to call the associated Clients or Servers. The default value is CALL. If there is no Client Monitor, it is the call type of the Server by the Client. |
CALLTYPE | Option possible on a Client Monitor, Server Monitor,
Communication Monitor, Business Component, or Folder. Call type of the Server by the Client. For CICS, the 2 following values are possible: LINK and CALL. |
CHANGE | Specific to TUXEDO. CHANGE=NO (default value): The Business Component is called with the TPNOCHANGE parameter. CHANGE=NO (default value): The Business Component is called with the TPCHANGE parameter. You are advised to indicate the same option in the Business Component Dialog and in the Folder Dialog. |
CHECKSER | Logical View data check. CHECKSER=NO (default value): The Business Component does not check the Logical View data. CHECKSER=YES: The Business Component checks the Logical View data. The VECTPRES and CHECKSER options in the Business Components that call the same Logical Views must be identical. |
CONNECT | Management of the connections to and the disconnections from relational
databases. CONNECT=YES (default value): The connections and disconnections are generated in the Communication Monitor. For TUXEDO, the connections and disconnections are generated in the initialization and termination Business Components (SI or ST type). In this case, you must call one of the Table Segments from the database that you want to connect to or disconnect from. CONNECT=NO (value for TUI applications): The connections and disconnections are generated in the Business Component. |
CURSUFF | Suffix of cursor names. CURSUFF=NO: The cursor names are not suffixed. CURSUFF=YES: The SQL cursor names are suffixed with the corresponding Screen name. |
DATAERR | Maximum number of errors on the Logical View data that can be
sent to the Client. The value is two-character long. The default value is 01. Note: The
value of this option that is indicated in the Initialization and Termination Business Component must
be identical to the value of the option in all the Business Components of the Folder.
|
FORMAT | For graphic applications, you must indicate FORMAT=EXTENDED. |
INITSERV | Call of an Initialization and Termination Business Component
(IT type). A free reference is set when you indicate an Initialization and Termination Business Component. Content assist is available on this field, as shown by the symbol |
LGCOMM | Length of the communication area between the following components:
This option has a numeric value on 5 characters. It is required if several Business Components are associated with the Dialog. |
LGCOMZS | Option possible on a Client Monitor or Server Monitor. Length of the communication area between the Client and Server Monitors. Its value must be 5 characters long (default: 32000). |
LOCATION | To implement a Communication Monitor, this option must be
indicated in the Folder Dialog, or in the Business Component Dialog if no Folder is specified. You must enter the Communication Monitor name (on 6 characters), a dash, and the environment name (on 20 characters maximum): LOCATION=FMCODE-ENVIRNAME A free reference is set when you indicate a Communication Monitor. Content assist is available on this field, as shown by the symbol |
MONSER | Name of the Server Monitor for the TUI mode. By default, there is no Server Monitor. |
NULLMNGT | Presence management of the Logical View Data
Elements. NULLMNGT=NO (default value): The presence of the Logical View Data Elements is not managed at the proxy level. NULLMNGT=YES: The
presence of the Logical View Data Elements is managed at the proxy level.
Note: If
NULLMNGT=YES, then VECTPRES=YES is systematically
implemented.
|
NUVERS | Version management of the Business Component, the Folder or Folder
View proxy, and the TUI Client. This option is not used in Rational Programming Patterns. |
PACTABLE | Name of the Pactables access program to the CICS Business Component. Default value: PACTABLE |
PROCESS | Available for TANDEM PATHWAY only. This option can be indicated at the Business Component level only. Name of the process when the Business Component is called. 15 characters maximum without space. No lowercase and uppercase conversion. |
SEGMBUFF | This option can be indicated at the Business Component level only. This option is used for the server buffer. It selects Segments of the Data Structure that defines the server buffer. For example, if you enter SEGMBUFF=s1s2s3, then s1, s2, and s3 represent the first 2 characters of the Segments. 10 Segments can be selected by this option. A maximum of 10 SEGMBUFF options can be called in each Business Component. Selecting the 00 Segment is not necessary. It is systematically generated if it is present in the Data Structure. By default, all the Segments of the Data Structure are selected. |
SERVBUFF | Available only with the specification of a Folder. This option identifies the Data Structure that defines the server buffer. You indicate SERVBUFF=xx, where xx is the Data Structure on 2 characters. Some Segments of this Data Structure can be selected in each Business Component with the SEGMBUFF option (SEGMBUFF=s1s2s3 for example). |
TRAN | Specific to TUXEDO. TRAN=YES (default value): Use of the transactional mode for the TUXEDO variant. TRAN=NO: No use of the transactional mode. |
VECTPRES | Management of the presence of the Logical View Data
Elements. VECTPRES=NO (default value): No management of the presence of the Logical View Data Elements. VECTPRES=YES: Management of the presence
of the Logical View Data Elements.
Note: If CHECKSER=YES, the
VECTPRES=YES option is systematically implemented.
Contrary to the NULLMNGT option, this option cannot be used to check the presence of the Data Elements in the proxy. The VECTPRES and CHECKSER options in the Business Components that call the same Logical Views must be identical. |
Values | Meaning |
---|---|
BASE | Relational database code. This option is required if a relational table is a component of the Folder, even if it is only the work file. The value BASE=THREAD is reserved for UNISYS 2200 to indicate an SFS organization. |
BASELOC | Location of the relational database. This option is required if the relational database code is specified. The possible values are LOCAL (default) and REMOTE. |
CALLTYPE | Option possible on a Client Monitor, Server Monitor,
Communication Monitor, Business Component, or Folder. Call type of the Server by the Client. For CICS, the 2 following values are possible: LINK and CALL. |
SERVBUFF | Specification of the Data Structure that defines the server buffer. You enter SERVBUFF=xx, where xx is the Data Structure on 2 characters. Note: The same option must be entered in the Business Component Dialog of the
Folder.
|
WAITINT | Option specific to MQ Series. and TCP/IP Socket on MVS/CICS. Waiting time, in seconds, between two queries. Default value for WebSphere® MQ = 0001. Default value for TCP/IP Socket on MVS/CICS = 1800. |
WAITINT1 | Option specific to MQ Series. Waiting time, in seconds, before the first request starts (default value = unlimited). This default value can be modified by entering a four-character number. |
WORKFILB | This option is mandatory. Database Block for a work file with an H organization or external name for a work file with a V organization. For IBM CICS - VSAM, enter the DDNAME on 1 to 8 positions. For
GCOS8, the input depends on the blocking type:
For the other variants, enter the logical name, generated in the SELECT clause. |
WORKFILS | This option is mandatory. Segment that is associated with the work file. |
WORKFILO | This option is mandatory. Organization of the work file that is used by the
Communication Monitor:
|
Values | Meaning |
---|---|
CALLTYPE | Option possible on a Client Monitor, Server Monitor,
Communication Monitor, Business Component, or Folder. Call type of the Server by the Client. For CICS, the 2 following values are possible: LINK and CALL. |
CHANGE | Specific to TUXEDO. CHANGE=NO (default value): The Business Component is called with the TPNOCHANGE parameter. CHANGE=NO (default value): The Business Component is called with the TPCHANGE parameter. You are advised to indicate the same option in the Business Component Dialog and in the Folder Dialog. |
ERRLAB | Format of the errors that must be
returned. ERRLAB=YES (default): The Communications Monitor retrieves the key, gravity and error messages that are returned by the Business Component before it sends back the answer to the Client. ERRLAB=NO: Only the error key is returned. In that case, the error message is locally read by the client application. |
INITSERV | Call of an Initialization and Termination Business Component
(IT type). A free reference is set when you indicate an Initialization and Termination Business Component. Content assist is available on this field, as shown by the symbol |
LOCATION | To implement a Communication Monitor, this option must be
indicated in the Folder Dialog, or in the Business Component Dialog if no Folder is specified. You must enter the Communication Monitor name (on 6 characters), a dash, and the environment name (on 20 characters maximum): LOCATION=FMCODE-ENVIRNAME A free reference is set when you indicate a Communication Monitor. Content assist is available on this field, as shown by the symbol |
NULLMNGT | Presence management of the Logical View Data
Elements. NULLMNGT=NO (default value): The presence of the Logical View Data Elements is not managed at the proxy level. NULLMNGT=YES: The
presence of the Logical View Data Elements is managed at the proxy level.
Note: If
NULLMNGT=YES, then VECTPRES=YES is systematically
implemented.
|
PROCESS | Available for TANDEM PATHWAY only. This option can be indicated at the Business Component level only. Name of the process when the Business Component is called. 15 characters maximum without space. No lowercase and uppercase conversion. |
TRAN | Specific to TUXEDO. TRAN=YES (default value): Use of the transactional mode for the TUXEDO variant. TRAN=NO: No use of the transactional mode. |
Values | Meaning |
---|---|
ACCESERR | Maximum number of errors on Segment access that can be returned
to the Client. The value is on 3 characters (default value = 001). |
CALLTYPE | Option possible on a Client Monitor, Server Monitor,
Communication Monitor, Business Component, or Folder. Call type of the Server by the Client. For CICS, the 2 following values are possible: LINK and CALL. |
CHANGE | Specific to TUXEDO. CHANGE=NO (default value): The Business Component is called with the TPNOCHANGE parameter. CHANGE=NO (default value): The Business Component is called with the TPCHANGE parameter. You are advised to indicate the same option in the Business Component Dialog and in the Folder Dialog. |
DATAERR | Maximum number of errors on the Logical View data that can be
sent to the Client. The value is two-character long. The default value is 01. Note: The
value of this option that is indicated in the Initialization and Termination Business Component must
be identical to the value of the option in all the Business Components of the Folder.
|
PROCESS | Available for TANDEM PATHWAY only. This option can be indicated at the Business Component level only. Name of the process when the Business Component is called. 15 characters maximum without space. No lowercase and uppercase conversion. |
TRAN | Specific to TUXEDO. TRAN=YES (default value): Use of the transactional mode for the TUXEDO variant. TRAN=NO: No use of the transactional mode. |
-GG
In the -GG Lines tab, you can modify the generation lines that are associated with the Database Block description lines.
Depending on the type of description line, lines are automatically displayed to guide you when you enter the physical information of the Block.
These lines are identified by VIRT or GUID in the last field of the table of the -GG Lines tab. Collectively, these lines are called virtual lines. The lines that are identified by VIRT are generated. To modify these lines, you must override them and create new lines between beginning and end insertion lines. When you select a virtual line and click Override, the VIRT or GUID line is changed into a FromVIRT or FromGUID line. Then, it can be modified. You can also edit the FromGUID and FromVIRT lines by selecting them and pressing the F2 key. You can create lines anywhere in the table. However, if you want them to be taken into account at generation time, you must identify them with a G Type.
- Error
- This column displays a dot on all the existing description lines
that are not empty.
Moreover, if this line is not correct, this column also displays an error or warning symbol, depending on the severity of the error. A hover help indicates the source of the error.
- Type
- When you click a line in this column, a list is displayed. You
must select one of the following values:
- *: comment lines to be generated,
- V: lines generated before the automatically generated elements,
- G: line generated instead of the automatically generated elements,
- P: lines generated between the automatically generated elements and their descriptions,
- Z: lines generated after the automatically
generated elements.Note: P and Z types are available only on the -GG lines that are associated with CODASYL Blocks (Definition and -DC Lines tabs).
- Description
- This field must be used to enter the generation elements or comments to be generated. Its content depends on the selected Block type and line type.
- To override the predefined values of a column, you identify the
column by its Data Element code. After identifying the column, you
click Override and enter another value. The generated virtual lines indicate where to place the insertion lines with —> COLUMNS INSERTION BEGINNING<-- and --> COLUMNS INSERTION END <—. To override the predefined values of the column, you identify the column by its Data Element code that is indicated from the first position of the field, between < and > signs. These delimiters must be six positions apart. After identifying the column, you enter the appropriate values. To complete the generated data, you enter, after LIBFO a space and the ADD keyword, followed by the data of your choice. Enter the end mark on the column declaration line because it is not automatically generated.Example: Modification of a column format:In this case, the name is DO10LIBFO and the format is FLOAT. This method cannot be used to delete a column. For DB2, the comma (separator) is generated at the end of each line. To avoid this generation, a & must be inserted after the last non-blank character of the line.
G CREATE TABLE (EXTERNAL NAME) IN DATABASE-NAME G ---> COLUMN INSERTION BEGINNING <--- G LIBFO G DO10LIBFO FLOAT G ---> COLUMN INSERTION END <--- G IN DATABASE-TABLE SPACE
- Source columns: To insert a column into a table, the same technique is used. You must insert one or more lines between the beginning and the end of the insertion area, which is indicated on virtual lines. To override a source column of a column in a view, you must create a G-type line formatted as:
FFNNDELCO is the code that is entered in the SOURCE COLUMN field.FFNNDELCO
Example:
You must manage the Source table (after the FROM clause).G CREATE VIEW (VIEW NAME) G ---> COLUMN INSERTION BEGINNING <--- G <LIBFO> G DO10LIBFO FLOAT G ---> COLUMN INSERTION END <--- G AS SELECT ALL G ---> SOURCE COLUMN INSERTION BEGINNING <--- G <FFNN-DELCO> G 'X' G ---> SOURCE COLUMN INSERTION END <--- G FROM (SOURCE TABLES NAME)
Dialog Definition
- Type of COBOL to generate
- In this field, you specify the COBOL variant for the generated Screen.Note: Some variants are deprecated or not supported. Furthermore, the value 0 is forced to X upon the migration of Pacbase applications.
Table 35. Values of the COBOL to generate Value Meaning Default Value of the Generated language field in the Library Definition tab. N No generation. X IBM MVS COBOL II, IBM VSE COBOL II. 0 IBM MVS/ESA OS/390. 1 IBM DOS/VSE. 3 UNIX, WINDOWS. 4 BULL GCOS7 COBOL. 5 BULL GCOS8 COBOL. 6 BULL GCOS8 COBOL, TP8 Screens. 8 UNISYS A-SERIES COBOL. F TANDEM COBOL. I DEC/VAX VMS COBOL. K ICL 2900 COBOL. O IBM AS/400 COBOL. Q ACUCOBOL. R TUXEDO COBOL. U UNISYS 2200–SERIES COBOL. Z IBM AIX®.
- TP monitor variant
- In this field, you specify the variant of the TP monitor for
the generated Screen.
Table 36. Values of the TP monitor variant Value Meaning Default Retrieval of the default value. N No generation. 0 Variants 0, 1, X for CICS (IBM) (programs and BMS maps). Variant 3 for PC/MICRO FOCUS (MS/DOS).
Variants 4, 5, 6 for QUESTAR.
Variant 8 for UNISYS A-Series SDF format.
Variant I for DEC/VAX.
Variant Q for UNIX, Windows (ACUCOBOL).
Variant U for UNISYS 2200 (programs and FLDP maps).
Variant O for AS 400.
Variant Z for AIX (IBM).
1 Variants 0, X for IMS (IBM) (programs and MFS maps). Variant 3 for PC/MICRO FOCUS (OS2).
Variants 4, 5, 6 for VIP TYPE.
2 Variants 0, 1, X for CICS (IBM), BMS color map. Variant 3 for MICRO FOCUS (UNIX).
3 Variants 0, X for IMS (IBM), MFS map in color. 4 Variants 0, X for IMS (IBM) monitor. Variant 3 for IBM COBOL program.
5 Variants 0, X for CICS (IBM) monitor. C Variants 4, 5, 6, U for multiterminal. Variants 0, 1, X for CICS multiterminal.
Variant K for ICL.
Variant 8 for UNISYS A-Series logical screen.
F Variant 4 for TDS FORMS (BULL GCOS7). Variant R for a TPSVRINIT or TPSVRDONE service-type program.
R Variant F for a REQUESTER-type program or variant R for a CLIENT-type program. S Variant F for a SERVER-type program or variant R for a SERVICE-type program.
- Program external name
- It is the name of the file that is generated from this instance. The generated file name can then differ from the instance name.
- Transaction code
- Enter the transaction code in the following way:
- For a CICS variant, enter the four-character transaction code (Dialog default code).
- For an IMS variant, enter the transaction code that is associated with the Dialog. This field is displayed on all the Dialog Screens except if the MONITOFF option (one transaction code for each Screen, no generated monitor) is specified.
- Map external name
- This field is unavailable on a Dialog.
It is the name of the map file (.bms, .mfs, or .map) generated from this instance. The generated file name of the map can then differ from the instance name. If this field is not entered, the map name is the instance name.
For CICS, you indicate the map set name.
For IMS, you indicate the format name.
For TANDEM, you indicate the name of the associated server for an R-type Screen (REQUESTER).
- Dialog type
- In this field, you initialize the Dialog or Screen type as a standard online type or a TUI type.
- Dialog type
- In this field, you initialize the Server Dialog/Server type.
Table 37. Values of the Server Dialog or Server type Values Comments MS: server monitor For TUI applications S: Business Component For TUI and graphic applications IT: initialization/termination Business Component For graphic applications with the development of a Folder MV: communication monitor, simple mode No comment E: error message server For TUI and graphic applications SI: initialization server No comment ST: termination server No comment
Dialog Complement
- Data Structure
- By default, no common area is indicated and this field is titled No
common area selected yet.
To specify the Data Structure that constitutes the common area, click Modify and select a Data Structure in the selection box.
This Data Structure stores the information that is common to all of the Screens of a Dialog and the necessary Segment access keys.
If the selected Data Structure consists of more than one Segment, the Segments are redefined in the LINKAGE SECTION (WORKING-STORAGE SECTION if appropriate).
- PSB or Subschema code
- This field is reserved for DL/1 database Segments.
The PCB name of the error message file (external name) must belong to the PSB.
For HP3000, you must specify the ALLBASE/SQL Database Block code for a monitor generation with a database connection.
Error file
Enter the physical characteristics of the error message file. They must be specified to generate the file description and access.
The physical access levels are generated in function F8098. If you want to rewrite these access levels, you must overwrite this function.
- Organization
- Select the organization of the error message file:
- : None
- D: DL/1 database Segment
The description of the error message file and the access to it are automatically generated. In IMS, the description of the error message file is not automatically generated. You must describe it in a Segment called in a hierarchical Database Block.
- S: DB2 database
- U: Access by specific code
- V: Indexed organization
- Y : UNYSIS 2200 SFS indexed organization
Segments are declared in FD and the access levels are generated in function F80.
- External name
- Enter the external name of the error message file. Its value varies
according to the type of COBOL code to generate:
- For IBM CICS - VSAM, enter the DDNAME on 8 characters.
- For GCOS7 - UFAS, enter the file code on 2 characters.
- For GCOS8-TP8, enter the external name on the first 4 characters (generated in the SELECT clause) and the blocking factor on the last 4 characters (generated in the FD clause).
- For any other type of COBOL code, enter is the logical name, which is generated in the SELECT clause.
Logical View
- Redefines
- Redefinition is possible within a Segment or Logical View. It
generates the COBOL REDEFINES clause. The Data Element
that contains this option redefines the Data Element of the same COBOL
level that precedes it in the -CE lines. If a Data Element that 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 that are contained in a
group (except for DL/1 database Segments). Note: When Data Elements are redefined, their respective lengths are not taken into account. It is your responsibility. The redefined Data Element length is used for the address calculation. Redefined Data Elements are ignored when generating for the Database Description function. If the Redefines box is checked, no initial value can be entered.
- To redefine a Data Element, select the Redefines option. A Set of Redefines line is created in the -CE lines. It contains the redefined Data Element and the preceding Data Element of the same level in the tree structure. You must then define the Occurs option in the Set of Redefines section.
- Occurs
- In this field, you enter the number of occurrences on 3 numeric characters. It corresponds to the OCCURS clause. It is not possible to create a repeated group area apart from the repeated structure (see the Data Type field). Repeated Data Elements are not authorized in graphic applications.
Logical View attributes
- Data type
- When a client calls a selection service, this service can implement
an extraction method and its parameters by value. The Business Component
that answers the call must recognize the extraction method and its
parameters to correctly complete the service. The only way to send
this information is through the message that is sent by the client.
The extraction method is sent to the Business Component through the technical part of the message. Parameters must be described in the application part of the message, that is in the Logical View.
In the Data type field, you specify the parameters by value for all the extraction methods that can be used by the Logical View. To do so, you call defined Data Elements. For each parameter, you enter the E type, which indicates that it is a parameter. Each identifier Data Element (U type) is an implicit parameter. The other Data Elements that describe the contents of the Logical View cannot be used as parameters. The E-type Data Element does not belong to the description of a Logical View. If necessary, you can define and call a child Data Element.Table 38. Specification of the data type Options Description None Data Element that is not used as a parameter. For the Data Elements that describe the Logical View. U: identifier for paging Data Elements that are to be used as selection criteria or start key for the reading of data occurrences in the database. Identifier for the paging of a list for the client. As output from the server, it contains the selection criteria values of the next page. R: repeated structure There is only one repeated structure for a Logical View. A repeated structure is specified in the group Data Elements. This Data Element indicates the beginning of the repeated Data Elements. The end of the repeated Data Elements is deduced from the number of Data Elements in a group. The number of occurrences must be indicated in the Number of occurrences field in the Logical View definition. E: extraction parameter The Data Element is used as a parameter for an extraction method. The E type Data Elements must be entered in the -CE lines before the Data Elements that describe the Logical View contents. Each identifier Data Element (U type) is an implicit extraction parameter. The other Data Elements that describe the Logical View cannot be used as parameters. If necessary, you can define and call a child Data Element.
- Data Element presence
- For each called Data Element, select one of the following check
options in the list:
Table 39. Specification of the Data Element presence Options Description O: required Required Data Element. The check for its presence is generated in the client, and in the Business Component if CHECKSER=YES. Note: It includes checks in relation to the Data Element description.P: required Required Data Element. The check for its presence is generated only in the Business Component, if CHECKSER=YES. Note: It includes checks in relation to the Data Element description.Blank The checks that are specified in the Data Element description are generated in the client, and in the Business Component, if CHECKSER=YES. F: optional The checks that are specified in the Data Element description are only generated in the Business Components if CHECKSER=YES.
Product Name
PDPPacbaseRational Programming PatternsRational Developer for System z® (IBM Developer for z Systems™)
The beginning of this file reminds the parameters that were entered to run the Pacbase migration procedures.
Program's attributes
- COBOL program ID
- This code is the name of the file that is generated from this instance. The generated file name can then differ from the instance name.
- Type of COBOL code
- In this list, you select the COBOL variant for the generated program. The default value upon
creation is the value of the Type of COBOL code field in the Library
Definition tab. Note: Some variants are deprecated or not supported. Furthermore, the value 0 is forced to X upon the migration of Pacbase applications.
- Type and structure
- In the list, select one of the possible values:
- B: Batch structure
It is the default option. It provides the general structure of an iterative structure: beginning of loop (F05), end of run (F20), end of loop (F9099. GO TO F05).
- T: Online structure
This option does not provide an iterative structure: no beginning of loop (F05), no end of run (F20), no end of loop (F9099. GO TO F05).
- S: Suppress automatic structure generation
The COBOL divisions are removed. The Program is built with the beginning insertion lines, the WORKING-STORAGE SECTION lines, and the Data Structure call lines.
- F: Program composed of COBOL lines and -CD
With this option, the calls to file structure descriptions that are entered through the WF micropattern are generated with the characteristics of the corresponding Segment call line in the -CD Lines tab.
- D: Program composed of COBOL lines and -CD (automatic
generation of COBOL DIVISIONS)
The Program is constituted of the Data Structure call lines and the COBOL lines. The IDENTIFICATION DIVISION, ENVIRONMENT DIVISION, and DATA DIVISION are automatically generated. The PROCEDURE DIVISION lines are entered directly in COBOL.
- P: Program composed of COBOL lines and -CD (PROCEDURE
DIVISION written in COBOL source)
The Program is constituted of the Data Structure call lines and the COBOL lines. The IDENTIFICATION DIVISION, ENVIRONMENT DIVISION, and DATA DIVISION are automatically generated. The PROCEDURE DIVISION lines are entered directly in COBOL The code structure (hierarchy of subfunctions) is respected.
- B: Batch structure
- Type of presence validation
- In validation programs, the presence of numeric Data Elements
is determined according to this option:
- Present if not blank
It is the default value. The Data Element is present if its value is not blank.
- 0: Present if not zero
The Data Element is present if its value is not zero.
- L: Present if not low value
The Data Element is present if it does not contain low values. This option is available for alphabetic and numeric Data Elements.
- Present if not blank
- SQL indicators generation
- Generation of SQL indicators with -.
If you select this option, the SQL indicators will be generated as: V-XXNN-DELCO.
If you do not select this option, the SQL indicators will be generated as: VXXNNDELCO.
Generation project and package
COBOL target
By default, the generated COBOL files are stored with the design files in a root folder whose default name you can change. You can separate them from the design files or even change the generation project and folder.
In a Library, the default values of the COBOL project, COBOL folder, and Map folder (for Screens only) are the values of the current project. If the project and folders are not indicated, the default values in a Dialog are the values of the Library or current project, as applicable. In a Screen or Server, the default values are the values of the Dialog, Library or current project, as applicable.
- A library. It then constitutes the default value for all the Dialogs and Screens or Servers of this Library.
- A Dialog. It then constitutes the default value for all the Screens or Servers of this Dialog.
- A Screen or Server. It then applies to the instance only.
- COBOL project
- The files that are generated from this instance are stored in the project that is indicated in
this field.
The project of the corresponding design file is the default project. If it is kept, Default is displayed between parentheses next to the project. However, if it is explicitly changed in the instance, only the project is displayed in this field, without any other indication. If it is explicitly changed in the Dialog, Inherited from Dialog is then displayed between parentheses next to the project. If it is explicitly changed in the generation Library, Inherited from Library is then displayed between parentheses next to the project. In the instance, you can overwrite the value that is inherited from the Library.
You can select a new project in the list.
If you change the project, the COBOL folder and map folder (for Screens) are automatically set to the default value (rpp). The new project then applies to the next generation.
- COBOL folder
- The files that are generated from this instance are stored in the folder that is displayed in
this field, inside the project displayed in the previous field.
The folder of the corresponding design file is the default folder. If it is kept, Default is displayed between parentheses next to the folder. However, if it is explicitly changed in the instance, only the folder is displayed in this field, without any other indication. If it is explicitly changed in the Dialog, Inherited from Dialog is then displayed between parentheses next to the folder. If it is explicitly changed in the generation Library, Inherited from Library is then displayed between parentheses next to the folder. In the instance, you can overwrite the value that is indicated in the Library.
If the default folder is kept, you can specify a root path for the generated files in the Properties wizard (accessed by clicking Change project properties). This path is then automatically inserted in this field, at the beginning of the folder.
You can select a new folder in the drop-down list. Creating a folder is impossible at this stage. Folders must have already been created in the project, for example from the Resource perspective.
If you change the folder, it applies to the next generation.
- Change project properties
- Click to open the Properties wizard, where you can complete the following actions:
- Change the default folder. This folder contains the design files and is the default target of the generated and metadata files.
- Indicate a root path for the generated files, provided the default generation folder is kept.
- Indicate a root path for the metadata files, which are stored by default in the same folder as the other generated files.
Note: A detailed help is available from the Properties wizard of the project.
- A .cbl file that is nested under the Program, Screen, or Server instance in the Design Explorer view. If you right-click it and select , the instances that are involved in the generation are automatically displayed in the References view. For explanations on the generated constants, variables, and functions, see COBOL description of a generated Program, Screen, or Server.
- A map description file for a Screen (.map, .bms, or .mfs) that is nested under the Screen instance in the Design Explorer view.
- A metadata file of the generated design (.cblpdp) and a metadata file of the map for a Screen (.mappdp, .bmspdp, or .mfspdp). These files can be viewed in the Package Explorer view: They must not be edited but must be assigned the same version number as the other generated files.
COBOL target
By default, the generated COBOL files are stored with the design files in a root folder whose default name you can change. You can separate them from the design files or even change the generation project and folder.
In a Library, the default values of the COBOL project and of the COBOL folder are the values of the current project.
- COBOL project
- The files that are generated from this instance will be stored in the project displayed in this
field.
The project of the corresponding design file is the default project. If it is kept, Default is displayed between parentheses next to the project. However, if it is explicitly changed in the instance, only the project is displayed in this field, without any other indication. If it is explicitly changed in the generation Library, Inherited from Library is then displayed between parentheses next to the project. In the instance, you can overwrite the value that is inherited from the Library.
You can select a new project in the list.
If you change the project, the COBOL folder is automatically set to the default value (rpp). The new project then applies to the next generation.
- COBOL folder
- The files that are generated from this instance are stored in the folder displayed in this
field, inside the project from the previous field.
The folder of the corresponding design file is the default folder. If it is kept, Default is displayed between parentheses next to the folder. However, if it is explicitly changed in the instance, only the folder is displayed in this field, without any other indication. If it is explicitly changed in the generation Library, Inherited from Library is then displayed between parentheses next to the folder. In the instance, you can overwrite the value indicated in the Library.
If the default folder is kept, you can specify a root path for the generated files in the Properties wizard (accessed by clicking Change project properties). This path is automatically inserted in this field, at the beginning of the folder.
You can select a new folder in the list. Creating a folder is impossible at this stage. Folders must have already been created in the project, for example from the Resource perspective.
If you change the folder, it applies to the next generation.
- Change project properties
- Click to open the Properties wizard, where you can complete the following actions:
- Change the default folder. This folder contains the design files and is the default target of the generated and metadata files.
- Indicate a root path for the generated files, if the default generation folder has been kept.
- Indicate a root path for the metadata files, which are stored by default in the same folder as the other generated files.
Note: A detailed help is available from the Properties wizard of the project.
Generation target
By default, the generated files are stored with the design files in a root folder whose default name you can change. You can separate them from the design files or even change the generation project and folder.
- Generation project
- The files that are generated from this instance are stored in the project that is displayed in
this field.
The project of the corresponding design file is the default project. If it is kept, Default is displayed between parentheses next to the project. However, if it is explicitly changed in the instance, only the project is displayed in this field, without any other indication.
You can select a new project in the list.
If you change the project, the generation folder is automatically set to the default value (rpp). The new project then applies to the next generation.
- Generation folder
- The files that are generated from this instance are stored in the folder that is displayed in
this field, inside the project from the previous field.
The folder of the corresponding design file is the default folder. If it is kept, Default is displayed between parentheses next to the folder. However, if it is explicitly changed in the instance, only the folder is displayed in this field, without any other indication.
If the default folder is kept, you can specify a root path for the generated files in the Properties wizard (accessed by clicking Change project properties). This path is automatically inserted in this field, at the beginning of the folder.
You can select a new folder in the list. Creating a folder is impossible at this stage. Folders must have already been created in the project, for example from the Resource perspective.
If you change the folder, it then applies to the next generation.
- Change project properties
- Click to open the Properties wizard, where you can complete the following actions:
- Change the default folder. This folder contains the design files and is the default target of the generated and metadata files.
- Indicate a root path for the generated files, if the default generation folder has been kept.
- Indicate a root path for the metadata files, which are stored by default in the same folder as the other generated files.
- Type of COBOL and map to generate
- Only the COBOL type X : IBM MVS/ESA OS390 and the transactional monitor variant 0 (IBM/CICS) are available.
- Proxy
- The explanations of the COBOL target are relevant but they apply to the proxy that is generated from the Folder. This proxy has a .txt extension. It is used in a Client that was created in a graphical development tool. In this case, it contains the information that is required to interface the Client with the Server. You specify the generation project and folder of the Folder proxy. They default to the project and folder of the Folder design file.
- Lock option
- The upload and download mechanisms used in the management of Folders increase the time lapse
between the reading of the initial image of a Folder and the return of its updated image. In this
context, a lock process can adequately prevent simultaneous updates on the same Folder occurrence.
In this manner, the coherence of accumulated updates is ensured. The following values are available:
- N: No lock option: This option is selected by default.
- P: Lock option - Before update: This option creates an exclusive ownership of the Folder, which is locked to all other users during the update.
- O: Lock option - After update: This option is active only when the update is requested. It compares the Folder image that is initially loaded with the current image. If they are identical, the update is accepted.
If you select a lock option, you must write the lock and unlock processing in the Business Component that is associated with the Folder root node. You must then create a subfunction that depends on a function 05*C. To do so, open the function and subfunction creation wizard from the COBOL code editor. Select the Business Component model with an Insertion relative to the Logical View processing, then select the service LOCK or UNLOCK.
- Paging mode
- Two paging modes are available:
- N: Non-extend paging mode: This option makes it possible to page forward and backward through a predefined population. Each paging operation (forward or backward) runs a reading request and its result replaces the result of the previous reading.
- E: Extend paging mode: This option makes it possible to page forward through a predefined population. The result of each paging adds to the result of the previous reading. The reading of the previous pages is then handled by the graphic client.
- Error Server
- If you do not specify it in the Dialog, you must specify it in the Folder. It is required. It
must correspond to a Server with a type E: Error Message Server and must be
defined.
It is used to access the error message file.
micropatterns
- *! is the required start tag of the micropattern. The * must be entered in column 7, reserved for the comments in the COBOL code, and the ! must be entered in column 8.
- " " must frame the operands.
- xxxx are the operands of this micropattern.
Table
The Comments column is displayed in the table only. It does not correspond to a field of the call line definition section. It contains an asterisk on the call lines that have been assigned -G lines. These secondary-level -G lines were entered with the -G Lines button in the call line definition section. If you hover your cursor on the asterisk, the -G lines of the call line are displayed in a tooltip. If you click the button that is associated with the asterisk, the -G lines are displayed in their tabular editor, where you can modify them. You can also display and modify the -G lines from the Edit comments choice in the contextual menu of the call line.
The existence of a secondary-level -G line is automatically indicated as an asterisk in the Comments column of the table that contains the call lines.
nesting of segments
A called Segment can call another Segment. Four nesting levels maximum are possible.
Generation_shortcut
If you right-click anywhere in the view, you can select Generate the code in the contextual menu. If you have updated the design of a Program, Screen, or Server, the newly generated code will integrate the changes in the design, while keeping any specific changes in the code.
The preference Structure checking before generation management, which is available from , checks that the nesting of subfunctions in the COBOL code is correct before the generation. By default, it blocks the generation if structure errors are detected.
- Generate the instance. If you have updated the
design of a Program, Screen, or Server, the newly generated code will
integrate the changes in the design, while keeping any specific changes
in the code.
The preference Structure checking before generation management, which is available from , checks that the nesting of subfunctions in the COBOL code is correct before the generation. By default, it blocks the generation if structure errors are detected.
Free references
A free reference is set when you indicate a Data Element in this field.
Content assist is available on this field, as shown by the symbol in front of the field. To activate it, press Ctrl+Space. A subreference link is
automatically created, even if the instance does not exist. From the target instance in the
subreference results, you can start a super reference search.
If you put the cursor from the first to the fourth position of the field, the content assist wizard first displays the list of Segments. Select one of them, then click the field again and press Ctrl+Space again. The content assist then displays the list of Data Elements. Select one of them.
The content assist wizard opens if the cursor is placed at the beginning of the field or after a dash (ww00- for example). It displays the list of the Data Elements.
A free reference is set when you frame a Data Element by the symbols < and >, or enter a Data Element after a dash (<) in this field. This Data Element can be preceded by a Segment.
You can activate the content assist if you enter < in the first position. The content assist wizard then displays the list of the available Data Elements. You can also specify a Segment 00 and activate the content assist to select a Data Element (<xx00-delco>). The subreference link is created with the Data Element only. If you do not enter < in the first position, you can also activate the content assist after a dash (-) to select a Data Element.