The options table parameters
The DFHNCOPT options table parameters are illustrated in the following figure.
DFHNCO [POOLSEL={(generic_values)|*},]
[JOBNAME={(generic_values)|*},]
[APPLID={(generic_values)|*},]
{POOL={YES|NO|name} | CALL=programname}
Terminate the last DFHNCO entry with the
following END statement:
END DFHNCOPT
- A single generic name
- A list of names in parentheses, the list containing two or more generic names, each name separated by a comma.
- POOLSEL={(generic1,generic2,…,…)∨* }
- Specifies that this options table entry applies only when the pool selection
parameter specified by the application program matches one of the generic
names specified on this parameter.
Specifying POOLSEL=, or POOLSEL=() is the equivalent of specifying 8 blanks.
If you omit the POOLSEL keyword, it defaults to *.
- JOBNAME={(generic1,generic2,…,…)∨* }
- Specifies that this options table entry applies only when the caller's
job name matches one of the generic names specified on this parameter.
If you omit the JOBNAME keyword, it defaults to *.
- APPLID={(generic1,generic2,…,…)∨* }
- Specifies that this options table entry applies only when the caller's
CICS APPLID matches one of the generic names specified on this parameter.
If you omit the APPLID keyword, it defaults to *.
- POOL={YES∨NO∨name}
- Specifies the pool name to be used. This parameter is mutually exclusive
with the CALL parameter. The options are:
- YES
- specifies that the server is to use the pool selection parameter specified by the application program as the actual pool name. An all-blank pool selection parameter means the server is to use the default pool name. For the call interface, the default name is DFHNC001. For the EXEC CICS API, the default name is specified by the NCPLDFT system initialization parameter.
- NO
- specifies that the server is not to use any pool and is to reject the request with an error.
- name
- specifies the actual pool name that the server is to use. If name is omitted, this indicates that the default pool is to be used. (For the CALL interface, the default pool is always DFHNC001, but for the EXEC CICS interface you can specify the default pool using the NCPLDFT system initialization parameter.)
- CALL=programname
- specifies the name of a user exit program to be called to determine the
actual pool name to be used. This parameter is mutually exclusive with the
POOL parameter. The program named can be link-edited with the options table, which generates a weak external reference (WXTRN), or it can be loaded dynamically the first time it is used. The program is called using standard MVS™ linkage in AMODE 31, with a standard save area and parameter list pointing to four fields, in the following order:
- The 8-byte actual pool name result field
- The 8-byte pool selection parameter.
- The 8-byte job name
- The 8-byte APPLID if running under CICS, otherwise blanks
The program should be reentrant and should be linked with RMODE ANY, so that it (and the option table if linked with the program) can be loaded above the line. Temporary working storage can be acquired and released using MVS GETMAIN and FREEMAIN. As this program is only called when a new pool selection value is used, the use of GETMAIN and FREEMAIN should not affect performance.
The exit program cannot use any CICS services. If it is used in a CICS region, it must avoid using any MVS services which could result in a long wait, as it will normally be executed under the CICS quasi-reentrant (QR) TCB.
The user exit program indicates its result by setting one of the following return codes in register 15:- 0
- Use the pool name that is successfully set, in the first field of the parameter list, by the user exit program.
- 4
- The program cannot determine the pool name on this invocation. Continue options table processing at the next entry, as for the case where selection conditions were not met.
- 8
- Reject the request (as if POOL=NO was specified).
The default options table, supplied in CICSTS54.CICS.SDFHLINK, contains the following entries:
DFHNCO POOLSEL=DFHNC*,POOL=YES
DFHNCO POOL=
END DFHNCOPT
With the default options table in use, any pool selector parameter that specifies a string beginning with DFHNC is taken to be an actual pool name, indicated by POOL=YES in the table entry. Any other value, including a value of all spaces, is assigned the default pool name, indicated by the POOL= table entry without a POOLSEL parameter.
The source for this default table is supplied in CICSTS54.CICS.SDFHSAMP.