EXEC and DD statements for FP Stand-alone DB Sensor

You must include the EXEC statement and appropriate DD statements in your FP Stand-alone DB Sensor JCL.

Subsections:

EXEC statement
DD statement summary
DD statements for input
DD statements for output
DD statements for input and output

EXEC statement

The EXEC statement must be in the following format:

//STEP EXEC PGM=HFPSENSR,PARM='IMSPLEX=imsplex,DBRCGRP=dbrcgrp,GSGNAME=gsgname'

where:

PGM: Specifies the FP Stand-alone DB Sensor program, which is HFPSENSR.
PARM: Specifies the parameters. For information about specifying the PARM parameter, see IMS System Programming APIs.

DD statement summary

The following table summarizes the DD statements for FP Stand-alone Database Sensor.

Table 1. HFPSENSR DD statements
DD name	Use	Required or optional	Format
STEPLIB	Input	Required	PDS
HFPSYSIN	Input	Required	LRECL=80
`area ddname`	Input	Required	VSAM
IMSACB, IMSACBA, or IMSACBB	Input	Required when IMSCATHLQ=*NO	PDS
IMSDALIB	Input	Optional	PDS
MODSTAT	Input	Optional	PS
MODSTAT2	Input	Optional	PS
OLCSTAT	Input	Optional	PS
RECON`x`	Input	Optional	KSDS
HFPAPARM	Input	Optional	LRECL=80
HFPAUOWC	Input	Optional	LRECL=80
HFPSPRT	Output	Required	LRECL=133
HFPPRINT	Output	Required	SYSOUT
`ittt`SMSG	Output	Optional	LRECL=133
`ittt`WK`nn`	Input and output	Optional

DD statements for input

Specify the following input DD statements:

STEPLIB DD

This required DD statement specifies the following load module libraries. All of these libraries must be APF-authorized.

IMS Fast Path Solution Pack product load module library (including DB Sensor)
DB Sensor site default library
IMS RESLIB and DFSMDA members
SCI exit library for parallel RECON access
IMS Tools Base product library

HFPSYSIN DD

This required DD statement specifies the input data set that contains the input control statement to specify the DB Sensor runtime options.

For details about the control statement format, commands, and keywords, see the following topics:

area ddname DD

This required DD statement specifies the name of the area data set to process. The DD name must match the area name in the DBD.

You must specify this DD statement except when DBRC=Y is specified or when the DFSMDA member is included in the STEPLIB DD or the IMSDALIB DD library.

IMSACB DD

This optional DD statement specifies the library that contains the DMB for the database. The IMSACB DD statements (IMSACB, IMSACBA, IMSACBB, MODSTAT, MODSTAT2, and OLCSTAT) can be used to identify the active ACB library. When both OLCSTAT or MODSTAT and MODSTAT2 are found, FP Stand-alone DB Sensor checks the time stamp and determines which one is the latest.

DB Sensor determines the active IMSACB library according to the following rules:

Check the IMSACB DD statement in the JCL statement.
Check the OLCSTAT DD statement in the JCL statement.
Check the MODSTAT and MODSTAT2 DD statements in the JCL statement.
Allocate the OLCSTAT data set dynamically and check the OLCSTAT member.
Allocate the MODSTAT and MODSTAT2 data sets dynamically and check the MODSTAT and MODSTAT2 members.

If you specify the IMSCATHLQ keyword, IMSACB DD statements are not used. The IMS directory is used instead of the ACB library.

IMSACBA DD

This DD statement specifies the library that contains the DMB for the database. This statement must be provided if MODSTAT and MODSTAT2, or the OLCSTAT DD statement is specified.

IMSACBB DD

This DD statement specifies the library that contains the DMB for the database. This statement must be provided if MODSTAT and MODSTAT2, or the OLCSTAT DD statement is specified.

IMSDALIB DD

This optional DD statement specifies the DFSMDA member modules. Specify this DD statement only if you do not want to APF-authorize the DFSMDA members data set. If both IMSDALIB and STEPLIB contain the DFSMDA members, IMSDALIB is used.

MODSTAT DD

This optional DD statement specifies the MODSTAT data set. When this statement is specified, the IMSACBA and IMSACBB DD statements must be specified instead of the ACBLIB DD statement.

If this statement is not specified in the JCL statement when the data set is required, the data set is allocated dynamically by using a DFSMDA member. You can build the DFSMDA member for the MODSTAT library by using a TYPE=DATABASE statement of the DFSMDA macro.

MODSTAT2 DD

This optional DD statement specifies the MODSTAT2 data set. When this statement is specified, the IMSACBA and IMSACBB DD statements must be specified instead of the ACBLIB DD statement.

If this statement is not specified in the JCL statement when the data set is required, the data set is allocated dynamically by using a DFSMDA member. You can build the DFSMDA member for the MODSTAT2 library by using a TYPE=DATABASE statement of the DFSMDA macro.

OLCSTAT DD

This optional DD statement specifies the OLCSTAT data set. When this statement is specified, the IMSACBA and IMSACBB DD statements must be specified instead of the ACBLIB DD statement.

If this statement is not specified in the JCL statement when the data set is required, the data set is allocated dynamically by using a DFSMDA member. You can build the DFSMDA member for the OLCSTAT library by using a TYPE=DATABASE statement of the DFSMDA macro.

RECONx DD

These DD statements specify the RECON1, RECON2, and RECON3 data sets when DBRC is used (DBRC=YES specification in HFPSYSIN DD). You can omit these DD statements if the DFSMDA member is included in the STEPLIB DD or the IMSDALIB DD.

HFPAPARM DD

This DD statement is an optional DD statement that contains execution control parameters.

If you want the Online Space Management utility to obtain values for the RBASEFS keyword, the RDOVFFS keyword, or both from the Sensor Data repository, specify a valid value for these keywords with this DD statement.

The HFPAPARM DD statement can be coded as a sequential data set or as a PDS member. LRECL=80 is required for the DCB of this data set. The HFPAPARM keywords must be written on one line. It can be coded as follows:

//HFPAPARM DD *
  ARDIGIT=5 RBASEFS=30 RDOVFFS=50 RGROUP=IMS1
/*

You can specify the keywords that are listed in the following table.

Table 2. HFPAPARM keywords
Keyword	Description
ARDIGIT	This keyword specifies the digit of the area number field for the UOW group definition records that are defined in the HFPAUOWC file. The value can be 3 or 5. The default value is 3. If the HFPAUOWC file is not specified in the JCL statement, this keyword is ignored.
RBASEFS	This keyword defines the value for data element DB_THRESHOLD_RBASEFS. The defined value is read by the Online Space Management utility and used as the RBASEFS keyword value in the reorganization process during the Online Expert Reorganization utility process. The value specifies the criterion to select UOWs to reorganize. It specifies the percentage of free space in each RAP CI. If a RAP CI contains free space that is greater than the specified percentage, and the RAP CI also uses overflow CIs, the UOW is selected as a candidate for the reorganization. Specify an integer value in the range of 0 - 100. The maximum value 100 has a special meaning; if RBASEFS=100 is specified, the RBASEFS condition is not used to select an initial set of UOWs.
RDOVFFS	This keyword defines the value for data element DB_THRESHOLD_RDOVFFS. The defined value is read by the Online Space Management utility and used as the RDOVFFS keyword value in the reorganization process during the Online Expert Reorganization utility process. The value specifies the criterion to select UOWs to reorganize. It specifies the percentage of free space in the dependent overflow area in each UOW. If the free space percentage in the dependent overflow area in a UOW is greater than the specified percentage, and the UOW also uses IOVF CIs, the UOW is selected as a candidate for the reorganization. Specify an integer value in the range of 0 - 100. The maximum value 100 has a special meaning; if RDOVFFS=100 is specified, the RDOVFFS condition is not used to select an initial set of UOWs.
RGROUP	This keyword sets the group identifier for the statistics that are collected and stored in a sensor data record set. The keyword value is set for the DB_SENSOR_DATA_GROUP_ID data element. This keyword has no default value. If this keyword is not specified, the DB_SENSOR_DATA_GROUP_ID data element is not included in the sensor data record set.

HFPAUOWC DD

This DD statement is optional. Each record in the data set specifies a range of UOW numbers of an area, which defines a UOW group of the area. The information about the UOW group is recorded in a sensor data record set in the order that is specified in the HFPAUOWC data set, even if the UOW ranges overlap or are in reverse order. When you specify UOW ranges of multiple areas, the records must be in ascending order of their area number.

The data set can reside in the JCL input stream. The data set can also be defined as a sequential data set or as a member of a partitioned data set. If a data set is specified, the data set must have the following attributes: DSORG = PS, RECFM = FB, LRECL = 80, BLKSIZE = a multiple of 80.

If the data set is empty and SENSOR_UOW=YES is specified, all UOWs of the area are regarded as the target UOW range. If SENSOR_UOW=NO is specified, this DD statement is ignored.

The following two types of records are supported:

ARDIGIT=3 (default): The area number is specified by a 3-digit decimal number.
ARDIGIT=5: The area number is specified by a 5-digit decimal number.

You must use one of these record types for all records in the data set. The type of the record must match the specification of the ARDIGIT parameter for the utility that uses the data set. The number of digits of the area number field ("AREA# IN DBD") in the record must have the same number of digits as the ARDIGIT value.

The ARDIGIT parameter is specified in the HFPAPARM data set.

The following table summarizes the UOW group definition record layout when the ARDIGIT parameter is 3.

Table 3. UOW group definition record layout when ARDIGIT is 3
Field description	COBOL usage
AREA number defined in DBD	9(3)
Start UOW number	9(7)
Stop UOW number	9(7)

The following table summarizes the UOW group definition record layout when the ARDIGIT parameter is 5.

Table 4. UOW group definition record layout when ARDIGIT is 5
Field description	COBOL usage
AREA number defined in DBD	9(5)
Start UOW number	9(7)
Stop UOW number	9(7)

Area number defined in DBD: Is the area number of the DEDB database that contains the target UOW range. This field contains a right-aligned 3- or 5-digit number, with leading zeros if necessary.
Start UOW number: Specifies the UOW number that is used to start processing. This field contains a right-aligned 7-digit number, with leading zeros if necessary.
Stop UOW number: Specifies the UOW number that is used to stop processing. This field contains a right-aligned 7-digit number, with leading zeros if necessary.

The following examples show the UOW group definition records:

UOW group definition records when ARDIGIT is 3:

00100000000000001 UOW 0-1
00100000020000003 UOW 2-3

UOW group definition records when ARDIGIT is 5:

0000100000000000001 UOW 0-1
0000100000020000003 UOW 2-3

DD statements for output

Specify the following output DD statements:

HFPSPRT DD: This required DD statement specifies the output data set for the FP Stand-alone DB Sensor reports. You can specify NULLFILE or DUMMY for this data set.; If you omit this DD statement, it is allocated dynamically with SYSOUT=* and the reports are printed in the SYSOUT data set.; For details about the FP Stand-alone Database Sensor reports that are generated in the HFPSPRT data set, see Output from FP Stand-alone DB Sensor.
HFPPRINT DD: This required DD statement specifies the processing log output data set, which contains the processing messages that are issued by FP Stand-alone DB Sensor. You can specify NULLFILE or DUMMY for this data set.; If you omit this DD statement, it is allocated dynamically with SYSOUT=* and the reports are printed in the SYSOUT data set.
itttSMSG DD: These optional DD statements specify an output data set for storing DFSORT messages. For the naming rules for the DD names, see the description of the itttWKnn DD.; When this statement is not specified in the JCL statement, FP Stand-alone DB Sensor dynamically allocates the data set by using SYSOUT=*.

DD statements for input and output

Specify the following input and output DD statement:

itttWKnn DD

These optional DD statements specify intermediate storage data sets that are used by DFSORT. For more information about coding the SORTWKnn DD statements, see the DFSORT Application Programming Guide. Allocating twice the space that is used by the SORTIN data set is usually adequate for each work data set.

The naming rules for the ddnames conform to the following rules:

i:

A, B, and C: If SENSOR_DBREC=YES is specified.; The thousands digit of the area number of the area to be analyzed, or the thousands digit of n for n-th input thread subtask.
A, D, G, and J:: If the number of areas to be processed or n is 999 or less.
B, E, H, and K:: If the number of areas to be processed or n is 1000 - 1999.
C, F, I, and L:: If the number of areas to be processed or n is 2000 - 2048.

Note: When a subtask ends processing an area, it starts processing the next area. For this reason, the n-th input thread subtask does not always process the n-th input data set.

ttt

The hundreds, tenths, and units digits of the area number of the area to be processed, or those of n.

nn

The number of the SORT work data sets. This value must be 01 - 03.

If this statement is not specified in the JCL statement when these data sets are necessary, FP Stand-alone Database Sensor allocates them dynamically.