Retrieving information about system initialization parameters

You can use the CICSPlex SM API to discover information about CICS system initialization parameters and system initialization parameter overrides. System initialization parameter retrieval is supported by the CICSPlex SM command-level interface, the CICS management client interface (CMCI), and the Web User Interface (WUI).

When you retrieve parameters you have the following options:
  • You can retrieve the current values of the system initialization parameters including any override values.
  • You can retrieve the original system initialization parameter values as specified at system startup.
  • You can retrieve the values from a single override source.

In common with many other CICSPlex SM operations, you can control which CICS regions the retrieval operates on by specifying context and scope.

System initialization parameter retrieval is implemented using the CICSPlex SM resource SYSPARM. The SYSPARM resource has two required parameters, PARMSRCE and PARMTYPE, associated with the GET operation. You use these parameters to specify which parameters to retrieve according to their source.

You can implement system initialization parameter discovery in the following ways:
  • In the CICS Explorer® SM Operations views > Regions view. Right-click a region and select Show SIT Parameters.
  • In an API program using the EXEC CPSM GET command operating on the SYSPARM object.
  • Using the CMCI GET method operating on the CICSSystemParameter external resource.
  • Using the WUI operations view based on the SYSPARM resource table linked from the CICS region view set.
When you use EXEC CPSM GET command or CMCI, you can define a parameter expression using PARMSRCE and PARMTYPE to specify which parameters to retrieve. In the WUI you can use PARMSRCE and PARMTYPE as filters to control the records displayed. Both of these parameters are mandatory. For PARMTYPE, you must specify a value of SIT. For PARMSRCE, specify one of the following options:
COMBINED
Combination of the original system initialization parameter definitions and any applied parameter overrides
CONSOLE
Override parameters as specified at startup on the system console
JCL
Override parameters provided through a JCL EXEC PGM statement
SYSIN
Override parameters from the startup job stream defined in the SYSIN data set
TABLE
The original system initialization table values extracted from the DFHSITxx load module

The parameters and override values are returned in the order of the KEYWORD attribute of the SYSPARM resource table irrespective of their order in the source, for example the SYSIN data set.

System parameter values can exceed 255 bytes. In these cases the parameter value is split into multiple records each containing a maximum of 255 bytes of parameter value. Each record has a unique segment number, which can be used to order the records correctly, a total segment number which contains the number of segments for this parameter value, and a total value length field, which contains the overall length of the segment lengths added together.

You must ensure that the system initialization parameters to be retrieved were valid for the CICS region at CICS startup. The retrieval operation can behave inconsistently if invalid parameter values have been corrected from the console at startup. Some parameters show the corrected values while others display their original values. Additionally for some corrected values, the system parameter source location might be returned as the console instead of the original source location.

The following CMCI request retrieves the values of the control tables suffixes set to for region REGION in the CICSplex MYPLEX.
/CICSSystemManagement/CICSSystemParameter/<MYPLEX>/<REGION>?PARAMETER=PARMSRCE(COMBINED)
%20PARMTYPE(SIT)&CRITERIA=KEYWORD%3D++T%20AND%20NOT%20KEYWORD%3DMXT


dfha2_retrieving_sysparms.html | Timestamp icon Last updated: Sunday, 4 June 2017