Rational Programming Patterns for System z

Dialog Complement tab

In this tab, you enter the information common to all of the Screens of the Dialog, and data related to the physical environment of the transaction.

The information common to all the Screens is:
  • The characteristics of the communication common area which conveys the information needed between the Screens of the Dialog,
  • The code of the first Screen. This Screen is displayed when the transaction is started.
  • The characteristics of the error message file of the Dialog.
Information can be entered in this tab, regardless of the type of TP monitor in use.

Other options are selected according to the environment and TP monitor in use at the site.

More than one values can be entered in the Options field. They must be separated with a 'blank' character. When the Screen is generated, warnings point out erroneous parameters, if any.

Common area

The communication common area constitutes the area of exchange between the various Screens of the Dialog.

Data Structure
By default, no common area is indicated and this field is titled No common area selected yet.

To specify the Data Structure which 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).

Complementary length
You must specify a number if the length of the common area exceeds 100 characters.
The length of the common area (5-xxnn-LENGTH in the generated programs) is determined by the combined lengths of:
  • The Screen code (six characters),
  • A common area Data Structure,
  • A field which stores the access keys of the Segments in display,
  • Technical information (not apparent).
When you calculate this length, you must take into account the fact that:
  • The length which corresponds to the access keys of each Segment in display is calculated by category.
    Example: if a Segment is used in the screen-top, repetitive, and screen-bottom categories, the length of the keys is calculated as follows:
    • the length of the key for the screen-top category,
    • + twice the length of the key for the repetitive category,
    • + the length of the key for the screen-bottom category.
  • If the MDT-OFF option or, for the BULL multiscreen variant and UNISYS A series, the DYNPRT option is specified in this tab, you must take into account the length of the longest Screen Segment of the Dialog to calculate the key length.
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.
First Screen of the Dialog
Here you indicate the code of the first Screen of the transaction.
According to the type of code to generate, the specifications of this field vary:
  • For CICS,

    If no first Screen is specified, the common area of each Screen of the Dialog is generated in the WORKING-STORAGE SECTION.

    If a first Screen is specified, the common area of each Screen of the Dialog is generated in the LINKAGE SECTION. However for the first Screen, it is generated in the WORKING-STORAGE SECTION.

  • For IMS,

    A monitor program is generated. It calls the selected Screen at the beginning of a Dialog and calls it again at the end of the Dialog. The external names of the first Screen and of its corresponding program must have been previously defined in the Screen Definition.

    The code is required, even when the MONITOFF option has been indicated.

  • For GCOS7 and GCOS8,

    This field is only used with multiterminal type transactions.

  • For DEC/VAX, MICRO FOCUS and HP3000,

    A branching monitor is generated. This monitor branches to the Screen at the beginning of the conversation.

  • For UNISYS-A,

    This field is used for the multiterminal type transactions.

  • For UNISYS-2200,

    This field is not used.

Options
Enter the options here, separating them with blanks. All these options can also be entered in the -GO Lines of the -G Lines tab.
Note: A synonym is sometimes associated with some options. This way you can enter all the necessary options.
Table 1 shows the overall options, available on all components. Table 2 shows the options available on servers only. Table 3 shows the options available on TUI clients and table 4 shows the options available on communication monitors.
Table 1. Overall options
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 Breakdown of 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 has been set to YES at the Library level.

This breakdown is effective:
  • For Programs: on the elementary Data Elements of the Segments called in the Call of Data Structures (-CD Lines tab) and in the work areas.
  • For Dialogs/Screens: on the elementary Data Elements of the Segments called in the Dialog Complement tab, in the -CS Lines tab and in the work areas.
  • on Data Elements called in the work areas.

    If you indicate the BREAKDATE=YES option, the Data Elements defined with a date format are generated as elementary fields which correspond to the year, month, and day. It also contains a separator if a separator is included in the date format

    Example of a date defined with an M-type format (MM/DD/YYYY):

    10 ffnn-date.
     11 ffnn-date-MMX.
      12 ffnn-date-MM PICTURE 99.
     11 ffnn-date-S1  PICTURE X.
     11 ffnn-date-DDX.
      12 ffnn-date-DD PICTURE 99.
     11 ffnn-date-S2  PICTURE X.
     11 ffnn-date-YYX.
      12 ffnn-date-YY PICTURE 9(4).
Notes:

A date is broken down only if the generated COBOL level of the date field is lower than or equal to 47.

The Data Elements 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

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.

CSSA Memorizes all the SSAs during 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: its content initializes the PF key table.
DYNAM Pactables Tables with a DYNAM 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 given 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 any category (top, bottom, repetitive), if it contains at least one variable field or access to a Segment.
FOR Formatting of the generated COBOL: Left-aligned DATA DIVISION, no alignment for the PROCEDURE DIVISION but 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 in this field.

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 associated with the protected fields (P or F type). It includes the documentation associated with the Data Element and the associated Texts and comments in the Screen -GC Lines section

In the help program, the screen flow is: 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 accesses 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 can be performed on the same Screen only.

With a monitor or submonitor, paging is possible on several Screens by entering the Screen codes on the Dialog work areas.
Note: If submonitors are used, all the Screens that make up 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

UNISYS A Series: generation with a monitor.

IBM CICS: 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 with 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, since READ WITH NO LOCK removes the preceding lock.

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 files (error messages) and the CONNECT to ORACLE.
NOOPENB HP3000, TURBOIMAGE: Stops the opening of the TURBOIMAGE database. The OPEN is not generated in the program.
NOPSB Segment generation limitation:

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 Takes into account the data 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 used in a Dialog. This list is found in the WORKING-STORAGE SECTION for documentation purposes. It includes the:
  • Data Elements from the Segments called in the -CS Lines,
  • Data Elements from the Segments called in the work areas, on F-type lines,
  • Data Elements directly called in the work areas on I-, E-, or S- type lines,
  • Data Elements directly called in the -CE Lines.
REPET or RPT Validation, transfer, and positioning of the attributes for the variable fields which 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:
(SELECT ALL COLDELCOn, ...  
        INTO   :FFNN-DELCOn)
SQLCA or SQC SQL: The INCLUDE SQLCA is generated in the WORKING-STORAGE SECTION if one or more DB2 or NONSTOP SQL Segments are called in the Screen: (-CE Lines tab, Organization = S, Q or N).
SQLIND or SQI 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 You can indicate one PSB 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 be left blank.

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).
Table 2. Options on servers (Server Dialogs and Servers)
Values Meaning
ACCESERR Maximum number of errors on Segment access that can be returned to the Client.

Three-character value (default value = 001)

This option must be entered in the Business Component or, for single-view developments, in the Server Dialog.

CALLTYPE Call type between the client and the server.

For CICS, there are 2 possible values: LINK (default) and CALL.

For IMS, there are 2 possible values: CALL (default) and CHNG (equivalent to a CALL CHANGE).

For GCOS8, there are 3 possible values: CALL, LINK (equivalent to a CALL .ILINK) and NTPR (equivalent to a NEXT TPR).

For TANDEM PATHWAY, the value is PATHSEND.

CHANGE Only with 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

CHECKSER The Business Component checks the data of the Logical View.

CHECKSER=NO (default): the Business Component does not check the Logical View data

CHECKSER=YES: the Business Component checks the Logical View data

CONNECT Management of the connections to and the disconnections from SQL databases

Default value: CONNECT=YES: 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 you want to be connected to or disconnected from.

CURSUFF Default value: 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 detected by a Server.

This option must be entered in the Business Component or, for single-view developments, in the Server Dialog.

ERRLAB For single-view development: This option specifies how the errors must be returned.

By default, ERRLAB=YES: the communication monitor retrieves the key, gravity, and error messages returned by the Business Component before sending back the answer to the client component.

But if the option value is set to NO, only the error key is returned. In that case, the error message is locally read by the client application.

This option must be entered in the Folder or, for single-view developments, in the Server Dialog.

ERRSERV For single-view development: name of the error server.

This option is required and must be indicated in the Server Dialog.

LGCOMM Length of the communication area of Business Components, I/T servers, error message servers.

Numeric value on 5 characters

LOCATION For single-view development: This option is required.
It represents the name of the communication monitor (on 6 characters) followed by the environment name (on 20 characters maximum).
Example: LOCATION=FMCODE-ENVIRNAME
LOCKMODE For single-view development: This option is used to specify the type of lock.

The lock process prevents the update of a set of data in order to avoid inconsistency.

If the value is NO (default) no lock is specified.

The PESSIMIST value creates an exclusive appropriation of the instance which is locked to all other users during updating.

The OPTIMIST value performs the lock only when the update is requested and compares the initially loaded image with its current image in the database. If they are identical, the update is accepted.

MONSER Name of the server monitor (default: no server monitor), for the TUI mode.
NULLMNGT NULLMNGT=NO (default value): No management of the presence of the Data Elements of the Logical Views at the Proxy level.
NULLMNGT=YES: Management of the presence of the Data Elements of the Logical Views.
Note: If NULLMNGT=YES, then VECTPRES=YES is systematically implemented.
NUVERS Version management of the Business Component and TUI client.

The versions of the TUI client and of the Business Component are transferred to the server through the technological buffer,

Default value for TUI clients only: Pacbase generation session

PACTABLE Pacbase name of the Pactables access program to the CICS Business Component.

Default value: PACTABLE

PAGEMODE For single-view development: paging mode.

The NOEXTEND value (by default) pages forward and backward through a predefined population. Each paging operation (forward or backward) runs a read request and its result replaces that of the previous read.

The EXTEND value pages forwards through a predefined population, and the result of each paging adds to the preceding read. The reading of the previous pages is then handled by the graphic client.

PROCESS Available for TANDEM PATHWAY only.

Name of the process when calling the Business Component

15 characters maximum without space. No lowercase/uppercase conversion

SEGMBUFF= s1s2s3s4… Available only with the specification of a Folder. This option must be entered in the Business Component.

Option used for the server buffer. It selects Segments of the Data Structure that defines the server buffer.

s1, s2, 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 must be entered in the Server Dialog or in the Business Component.

This option identifies the Data Structure which defines the server buffer: SERVBUFF=xx (where xx is the Data Structure on 2 characters).

Various Segments of this Data Structure can be selected in each Business Component with the SEGMBUFF= s1s2s3s4… option.

TRAN Only with 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: 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.
Table 3. Options for TUI clients (Dialogs and Screens)
Values Meaning
FORMAT Format of the Logical View Data Elements.

With the INTERNAL value, the Data Elements called in the Logical View are generated using their internal format; their usage is taken into account.

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 reserved to 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 the display are also conditioned by the Data Element presence (N).

INITSERV Call of an initialization server.
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 and TUI client.

The versions of the TUI client and of the Business Component are transferred to the server through the technological buffer.

Default value for TUI clients only: Pacbase generation session

TERMSERV Call of a termination server
Table 4. Options on communication monitors
Values Meaning
BASE The relational Database Block name is required when all the application components access the same database.

In this case, the connection orders are automatically generated in the communication monitors of the application.

BASELOC Location type of the relational database to access.

This information is mandatory especially when the connection Database Block name is specified.

The possible values are: LOCAL (default) or REMOTE.

CALLSPG Call type of the components associated with the monitor.

If there is no client monitor, it is the call type of the server component by the client component.

For GCOS8, this option must have the same value as the CALLTYPE option.

CALLTYPE Call type between the client and the server.

For CICS, there are 2 possible values: LINK (default) and CALL.

For IMS, there are 2 possible values: CALL (default) and CHNG (equivalent to a CALL CHANGE).

For GCOS8, there are 3 possible values: CALL, LINK (equivalent to a CALL .ILINK) and NTPR (equivalent to a NEXT TPR).

For TANDEM PATHWAY, the value is PATHSEND.

LGCOMZS Length of the communication area between the client and server monitors.

Its value must be 5 characters long (default: 32000).

WAITINT Option specific to WebSphere MQ 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 WebSphere MQ

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

Required option for a graphical client

Database Block for a work file with an H organization or external name for a work file with a V organization.

WORKFILS

Required option for a graphical client

Segment associated with the work file.

WORKFILO

Required option for a graphical client

Organization of the work file used by the associated monitor and Services Manager:
  • V: sequential indexed
  • H: relational
  • W: working

Error file

Here you specify the physical characteristics of the error message file, which are used to generate the file description and accesses.

The physical accesses are generated in function F8098. If you want to rewrite these accesses, 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 accesses 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 accesses 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, it is the DDNAME on eight characters,
  • For GCOS7 - UFAS, it is the file code on two characters,
  • For GCOS8-TP8: The external name is generated in the SELECT clause (first four characters); blocking factor (last four characters) (generated in the FD clause).
  • For any other type of COBOL code, it is the logical name, generated in the SELECT clause.
For DL/1, you must enter the mnemonic code of the PCB. This code must be in the list of PCBs for the PSB of this transaction.

Terms of use | Feedback

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