Historical data

CICSPlex® SM provides the ability to save and view data for completed tasks, that is historical task data.

When an active task completes, provided that CICS® performance class data monitoring is active, its data is stored in a historical data store. The data store is made up of a number of VSAM KSDS data sets. There must be a minimum of two data sets and a maximum of 26 data sets. See Using the CICS Monitoring Facility (CMF) with CICSPlex SM.

Support for historical task data builds upon CICSPlex SM resource monitoring. It uses all the same definitional entities, for example monitor specifications (MONSPEC objects), monitor definitions (MONDEF objects), and monitor groups (MONGROUP objects). In particular, it uses monitor definitions with a Monitoring resource class of MTRAN to specify the IDs of the transactions for which you want to save historical task data. Whereas, for example, with resource monitoring, monitor definitions with a Monitoring resource class of MTRAN and a resource name of FRED causes data to be accumulated and totalled for multiple instances of transaction FRED into one record, historical task data support provides the ability to separately save the entire CICS monitoring data for each instance of transaction FRED.

Existing users of CICSPlex SM monitoring can start using historical task data support. Simply define the history VSAM data sets, and allocate them to the MAS region by means of DD cards. CICSPlex SM will then start collecting historical task data for all transaction IDs named on installed monitor definitions.

For more information on how to define the CICSPlex SM history data sets refer to Preparing the MAS for history recording .

For those users who want only to collect historical task data without collecting CICSPlex SM monitoring data as well, an EYUPARM called HISTORYONLY is provided. This should be set to a value of YES. The default is HISTORYONLY(NO) which means that both CICSPlex SM monitoring data and history data will be collected, assuming the appropriate monitor definitions have been installed and the VSAM data sets have been allocated to the MAS region.

Historical task data saved in the historical data store can be viewed using the Web User Interface Completed tasks views or retrieved using the CICSPlex SM API on the HTASK resource table. The following parameters are supported for the GET operation:
STARTDATE
Retrieve information for all tasks that were completed on or after the date specified. The date must be in the form MM/DD/YYYY. The default is today's date. If you specify STARTDATE with the RECENT parameter on a GET operation, the request will fail with a TABLEERROR response and a DATAERROR reason. A FEEDBACK operation for the failing command will result in a FEEDBACK error code of INV_COMB_RECENT.
STARTTIME
Retrieve information for all tasks that were completed at or after the time specified. The time must be in the form HH:MM:SS. The default is the previous midnight (00:00:00). If you specify STARTTIME with the RECENT parameter on a GET operation, the request will fail with a TABLEERROR response and a DATAERROR reason. A FEEDBACK operation for the failing command will result in a FEEDBACK error code of INV_COMB_RECENT.
ENDDATE
Retrieve information for all tasks that were completed on or before the date specified. The date must be in the form MM/DD/YYYY. The default is today's date. If you specify ENDDATE with either of the RECENT or INTERVAL parameters on a GET operation, the request will fail with a TABLEERROR response and a DATAERROR reason. A FEEDBACK operation for the failing command will result in a FEEDBACK error code of either INV_COMB_RECENT or INV_COMB_INTV_ED.
ENDTIME
Retrieve information for all tasks that were completed at or before the time specified. The time must be in the form HH:MM:SS. The default is one second to midnight (23:59:59).

If you specify ENDTIME with either of the RECENT or INTERVAL parameters on a GET operation, the request will fail with a TABLEERROR response and a DATAERROR reason. A FEEDBACK operation for the failing command will result in a FEEDBACK error code of either INV_COMB_RECENT or INV_COMB_INTV_ET.

If you specify an earlier ENDDATE and ENDTIME than the specified STARTDATE and STARTTIME on a GET operation, the request will fail with a TABLEERROR response and a DATAERROR reason. A FEEDBACK operation for the failing command will result in a FEEDBACK error code of INV_COMB_START_END.

INTERVAL
Retrieve information for all tasks that were completed within n seconds of the STARTDATE and STARTTIME where n is the value specified for INTERVAL. The maximum value is 99,999,999. You can also use two special values for INTERVAL:
HISTSECS
Use the number of seconds specified by the HISTSECS EYUPARM.
NOLIMIT
Retrieve information for all tasks that were completed after STARTDATE and STARTTIME.

If you specify INTERVAL with any of the ENDDATE, ENDTIME, or RECENT parameters on a GET operation, the request will fail with a TABLEERROR response and a DATAERROR reason. A FEEDBACK operation for the failing command will result in a FEEDBACK error code of INV_COMB_INTV_ED, INV_COMB_INTV_ET, or INV_COMB_RECENT.

If you specify a value for the INTERVAL parameter which is not a numeric value or one of its special values, on a GET operation, the request will fail with a TABLEERROR response and a DATAERROR reason. A FEEDBACK operation for the failing command will result in a FEEDBACK error code of INV_INTERVAL.

RECENT
Retrieve information for all tasks that were completed within the last n seconds, where n is the value specified for RECENT. The maximum value is 99,999,999. You can also use three special values for RECENT:
HISTSECS
Use the number of seconds specified by the HISTSECS EYUPARM.
NOLIMIT
Retrieve information for all completed tasks that CICSPlex SM has recorded on its history data sets.
0
Retrieve history data that is being accumulated for tasks that are still active. This data has not yet been written to the VSAM history data sets. It is monitoring data that is being written to CICS performance records for active tasks, where monitoring options have been specified.

If you specify the RECENT parameter with any of the STARTDATE, STARTTIME, ENDDATE, ENDTIME, or INTERVAL parameters on a GET operation, the request will fail with a TABLEERROR response and a DATAERROR reason. A FEEDBACK operation for the failing command will result in a FEEDBACK error code of INV_COMB_RECENT.

If you specify a value for the RECENT parameter which is not a numeric value or one of its special values, on a GET operation, the request will fail with a TABLEERROR response and a DATAERROR reason. A FEEDBACK operation for the failing command will result in a FEEDBACK error code of INV_RECENT.

Note: The CICSPlex SM API requires the formats of STARTDATE, STARTTIME, ENDDATE and ENDTIME to be as given in the above definitions, but when these dates and times are displayed on the Web User Interface, or input directly via the Web User Interface, the DATEFORMAT, DATESEPARATOR, TIMESEPARATOR and DECIMALSEPARATOR EYUWUI parameters in force for the Web User Interface Server are used.