Rational Programming Patterns

-GO Lines

You use these lines to enter generation options.

You can add a line in the table in two ways:
  • Click Add or select this action in the contextual menu to indicate a generation option. Then, click in the Type column and select the O line type. Enter the option in the Description column. You can also add a comment line
  • 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 an O: Generation options 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:
  • O: Generation option line,
  • *: Line to insert a comment or an override. It will not be generated.

This column displays a value I on all the Input Aid insertions. This value cannot be selected directly.

Description
This column must contain the following information:
  • If you inserted an O type line, you must enter the option name followed by the equals sign (=) and the option name. To activate an option, enter OPTION=YES (OPTION is the option name). The options can be entered in the -GO Lines or in the Complement tab of the Dialog or Server Dialog.
  • If you inserted a * type line, you must enter the comment.
  • 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.
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.

List of the generation 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 was set to YES at the Library level.

This breakdown is effective:
  • For Programs: on the elementary Data Elements of the Segments that are 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 that are called in the Dialog Complement tab, in the -CS Lines tab and in the work areas.
  • on Data Elements that are called in the work areas.

    If you indicate the BREAKDATE=YES option, the Data Elements that are defined with a date format are generated as elementary fields that 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 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

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 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 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 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, because READ WITH NO LOCK removes the preceding lock.

NOMAP Generation or no generation of the map, according to the value of the option in the Dialog and the Screen.

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:
  • If the Dialog contains the value NOMAP or NOMAP=YES and if the Screen contains the value NOMAP=NO, the Screen map is generated.
  • If the Dialog contains the value NOMAP=NO and if the Screen contains the value NOMAP or NOMAP=YES, the Screen map is not generated.
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 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 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 found in the WORKING-STORAGE SECTION for documentation purposes. It includes the following Data Elements:
  • Data Elements from the Segments that are called in the -CS Lines,
  • Data Elements from the Segments that are called in the work areas, on F-type lines,
  • Data Elements that are directly called in the work areas on I-, E-, or S- type lines,
  • Data Elements that are directly called in the -CE Lines.
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:
(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 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).
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, severity, and error messages that are 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 to avoid inconsistency.

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

The PESSIMIST value creates an exclusive appropriation of the instance that 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: generation session

PACTABLE 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 the Business Component is called

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 that is 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 that 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 that are called in the Logical View are generated with 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 that is 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: 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 that are 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 that is associated with the work file.

WORKFILO

Required option for a graphical client

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

Terms of use | Feedback

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