DSTOPTS

Purpose

The DSTOPTS statement defines the run time options for the data store.

DSTOPTS is defined in the member of the EQQPARM library as specified by the DD statement in the JCL.

Parameters

CINTERVAL(interval time|0)

Defines the cleanup task wake-up interval time, expressed in minutes. Valid values are from 0 to 1440. 0 is the default and means that the Data Store CleanUp subtask is started at data store initialization, but never runs.

CLNPARM(member name|EQQCLNPA)

Defines the parameter member name that will contain the CleanUp task criteria. The default is EQQCLNPA.

This parameter is meaningful only if CINTERVAL is greater than 0; nevertheless it is required at data store startup because the data store loads the information contained in the member only at startup time and, even if you initially set CINTERVAL(0), you might later modify this value with an operator command.

CTLLUNAM(LU Name)

Defines the VTAM® application LU name that identifies the controller in the SNA connection between the controller and data store. It is mandatory if the SNA connection is used between the controller and data store, and must be the same as that specified in the controller FLOPTS CTLLUNAM statement.

CTLMEM(XCFMemName)

XCF member name, identifying the controller in the XCF connection between controller and data store. It is mandatory if XCF connection is used and must be the same specified in the controller FLOPTS CTLMEM statement.

CTLHOSTNAME(hostname|IP address)

The host name or IP address of the remote controller. Valid values are fully-qualified names, up to 52 characters.

CTLPORTNUMBER(TCPIP port|423)

The TCP/IP port number used to communicate with the remote controller. Valid values are from 0 to 65535. The default is 423.

DELAYTIME(nn|1)

Delay time, expressed in minutes, used to decide when to discard/store incomplete sysout. Valid values are from 0 to 1440. 1 is the default.

DSTGROUP(XCFGroupName)

Defines the XCF group name that identifies the data store in the XCF connection with the controller. It is mandatory if XCF connection is used.

The XCF group defined to connect the data store to the controller must be different from the one defined in the XCFOPTS group to connect the controller to the z/OS® tracker.

DSTLUNAM(LU Name)

Defines the VTAM® application LU name that identifies the data store in the SNA connection between controller and data store. It is mandatory if SNA connection is used between the controller and the data store.

DSTMEM(XCFMEMName)

The XCF member name, that identifies the data store in the XCF connection between the controller and the data store. It is mandatory if XCF connection is used.

FAILDEST(destination|FAILDEST)

Defines a destination where the jobs that could not be archived will be requeued so that they can be examined.

If the JES2 DESTDEF statement specifies NODENAME=REQUIRED, the destination specified in the FAILDEST parameter must be defined to JES2. using the following command:

$ADD DESTID(xxxxxxxx),DEST=xxxxxxxx

where xxxxxxxx is the destination specified in the DSTDEST parameter.

If the JES2 DESTDEF statement specifies NODENAME=OPTIONAL, you do not need to specify a destination in the FAILDEST parameter.

HDRJOBNAME(value|JOBNAME)

The jobname identifier for the STEPTABLE HEADER in the JESMSGLG sysout. JOBNAME is the default value used by HCL Workload Automation for Z. You can specify any other value up to eight characters, according to the EQQACTR1 exit customization.

HDRSTEPNAME(value|STEPNAME)

The stepname identifier for the STEPTABLE HEADER in the JESMSGLG sysout. STEPNAME is the default value used by HCL Workload Automation for Z. You can specify any other value up to eight characters in length, according to the EQQACTR1 exit customization.

HDRPROCNAME(value|PROCSTEP)

The procstep identifier for the STEPTABLE HEADER into the JESMSGLG sysout. PROCSTEP is the default value used by HCL Workload Automation for Z. You can specify any other value up to eight characters in length, according to the EQQACTR1 exit customization.

HDRJOBLENGTH(length|21)

The start position of the jobname in the STEPTABLE. You can specify any other length according to the EQQACTR1 exit customization. The ASA character is not included.

HDRSTEPLENGHTH(length|30)

The start position of the STEPNAME in the STEPTABLE. The default value is 30. You can specify any other length according to the EQQACTR1 exit customization. The ASA character is not included.

HDRPROCLENGTH(length|39)

The start position of the PROCNAME in the STEPTABLE. The default value is 39. You can specify any other length according to the EQQACTR1 exit customization. The ASA character is not included.

HDRSTEPNOLENGTH(length|120)

The start position of the STEPNO in the STEPTABLE. The default value is 120. You can specify any other length according to the EQQACTR1 exit customization. The ASA character is not included.

HOSTCON(SNA|XCF|TCP)

Defines the type of connection used when transmitting data to the controller. It is mandatory (no default exists).

MAXMVSPAGES(nnnn|4096)

Defines the maximum size (in number of pages) allowed for the z/OS part of a job log (JESJCLIN, JESJCL, JESMSGLG, JESYSMSG) to be managed by the process. If the z/OS part of the job log exceeds this value, the job log is not stored, parser processing is not performed, and the job log is queued again to the failure destination, as set by the FAILDEST keyword.

For example, if Tot_Rec is the number of records in the job log, the number of pages for the job log is calculated as (Tot_Rec*135)/4096. Valid values are from 0 to 4096. The default value is 4096.

MAXSTOL(nnnnn|0)

Defines the maximum number of user sysout (not lines of sysout) the data store can store for a single job. Valid values are from 0 to 10000. If 0 is specified no user sysout is stored. 0 is the default. User sysout information is not required for restart and cleanup processing.

A nonzero value should only be specified if it is necessary to view user sysout data when a job log is retrieved using the "L" row command (for example if a user sysout contains information needed by operations to determine how to rerun a job). Specifying a nonzero value could cause a large amount of data to be written to the data store UDF files, so you might need to increase the size or the number of UDF files.

Note: The User Sysout field in the Restart and Cleanup Operation Details (EQQAMRCL) panel for an operation must be set to Y, otherwise the user sysout will not be written to the data store for that operation.

MAXSYSL(nnnn|0)

Defines the maximum number of user sysout (not lines of sysout) the data store can send back to the controller. Valid values are from 0 to 10000. If 0 is specified no user sysout is sent back to the controller. 0 is the default.

User sysout information is NOT required for restart and cleanup processing. A nonzero value should only be specified if it is necessary to view user sysout data when a job log is retrieved using the "L" row command (for example if a user sysout contains information needed by operations to determine how to rerun a job).

Specifying a nonzero value could cause a large amount of data to be written to the data store UDF files, so you might need to increase the size or the number of UDF files.

MAXUNPAGES(nnnn|4096)

Defines the maximum size (in terms of number of pages) allowed for a job log to be stored. When the size of a job log is greater than this value, the job log is not stored. The structured data, instead, is stored regardless of the STORESTRUCMETHOD specified.

If Tot_Rec is the number of the records of a job log, the number of pages for a job log is (Tot_Rec*135) / 4096. Valid values are from 0 to 4096. The default is 4096.

If MAXUNPAGES is set too low, more CPU is used by the data store, because a large number of job logs will be parsed. If MAXUNPAGES is set too high, a lot of time might be spent writing large job logs.

NWRITER(nn|1)

Defines the number of writer tasks to be activated by the data store. Valid values are from 1 to 16. 1 is the default. The number of the writer tasks must be less than or equal to the number of the data store VSAM files. For details, see Using the data store.

RETRYCOUNTER(nn|1)

Defines the maximum number of times that data store will retry job archival within the specified delay time, before it removes the job from the reserved queue. This number corresponds to the maximum number of 'archiving in progress' messages that will be issued before the job is removed from the reserved queue and requeued to the failure destination (the one specified with the FAILDEST parameter). As troublemaking jobs can cause performance degradation to the data store, you are recommended to use low values or the default (1).

SMSMODDELTE(YES|NO)

This parameter is valid only for the Cleanup actions that EQQCLEAN performs for SMS data sets allocated with DISP=(MOD, CATLG, CATLG) in the previous run of the job. If the SMS data set existed before the previous run of the job, it is not deleted, regardless of the value you set in this parameter.

Specify NO to prevent EQQCLEAN from deleting the SMS data sets that were created in the previous run of the job. Specify YES to have EQQCLEAN delete the SMS data sets at restart. The default value is NO.

QTIMEOUT(nnnnn|15)

Defines the maximum time that the data store can take to satisfy a job log retrieval request issued from the controller when the sysout is not yet stored in the VSAM database, because the archiving process for that job log is in progress. If this QTIMEOUT time expires and the request has not been satisfied, then message EQQFSR5I is issued. After this message, there is no other attempt to get the job log. Therefore, you must issue another request to receive that job log. It is expressed in seconds and the allowed values are from 1 to 10000. 15 is the default.

STORESTRUCMETHOD(DELAYED|IMMEDIATE)

Defines when to archive the structured data.

If you specify IMMEDIATE, data store immediately parses and archives the job logs found at its reserved destination. This means that structured data is always generated for all the job logs handled by data store.

If you specify DELAYED, data store immediately archives the job logs found on its reserved destination, but parses and then archives the created structured information using the unstructured job log previously archived.

When you specify DELAYED, the structured data is stored even for job logs bigger than the value set for MAXUNPAGES or bigger than 4096 pages, if MAXUNPAGES is not specified.

STOUNSD(YES|NO)

The default value is NO. Select YES to store unstructured data in the data store database and to enable the job log retrieval function for the z/OS® job log.

Note: If you set STORESTRUCMETHOD to DELAYED you must also set STOUNSD to YES. In this way the method for archiving can extract the structured data from the job log.

SYSDEST(OPC|destination)

Defines the destination used to capture the sysout from the job entry subsystem. It must be equal to the value of the RCLOPTS DSTDEST parameter.

If the JES2 DESTDEF statement specifies NODENAME=REQUIRED, the destination specified in the SYSDEST parameter must be defined to JES2. using the following command:

$ADD DESTID(xxxxxxxx),DEST=xxxxxxxx

where xxxxxxxx is the destination specified in the DSTDEST parameter.

If the JES2 DESTDEF statement specifies NODENAME=OPTIONAL, you do not need to specify a destination in the SYSDEST parameter.

WINTERVAL(nnnn|30)

Defines the maximum time interval that can occur before the data store scans again the reserved destination. To better explain how this value is used, consider that:

• JESQUEUE is the task that reads the JES spool to get the job logs to be handled by data store using as filter criterion the "reserved destination"
• From this reading, the JESQUEUE builds a linked list of JOBIDs to be handled (the maximum number of JOBIDs read from the JES spool each time is 3N+1 where N is the number of writers tasks defined)
• Once this linked list has been built, the JESQUEUE task checks it until it is emptied by the WRITERS tasks
• At this point, before rebuilding the linked list again, JESQUEUE task waits the time interval specified into WINTERVAL.

It is expressed in seconds and the allowed values are from 0 to 3600. The default is 30.