HDB Extract command

The HDB(EXTRACT) operand requests CICS PA to generate extract data sets from HDB data.

The command format is:
CICSPA HDB(EXTRACT(hdbname),
          [OUTPUT(ddname),]
          [DDNAME(ddname),]
          [STATISTICSLIST|STATISTICSSUMMARY,]
          [SUFACTOR(hdbname(nnnnn.nnn)),]
          [INTERVAL(hh:mm:ss),]
          [DELIMIT('field-delimiter'),]
          [STALTDEF(statistics-alert-definition),]
          [SEVERITY(CRITICAL|WARNING|INFO|ELIGIBLE|ALL),]
          [INCLUDESEV,]
          [TYPE(EOD,INT,USS,REQ,RRT),]
          [LABELS|NOLABELS,]
          [NOFLOAT|FLOAT,]
          [FIELDS(field1[(options)],...),]
          [SELECT(PERFORMANCE(INCLUDE|EXCLUDE(field1(values1),...),...)),]
          [SELECT2(PERFORMANCE(INCLUDE|EXCLUDE(field1(values1),...),...))])
The options are:
EXTRACT
The name of the HDB. The HDB must be defined in the Repository (DDname CPAHDBRG).
OUTPUT
DDname for the Recap report output. The CICS PA dialog assigns the default DDname HXTS0001.
DDNAME
DDname for the extract data set. The CICS PA dialog assigns the default DDname HDBX0001.
STATISTICSLIST|STATISTICSSUMMARY (statistics HDBs only)
Specifies that the extract is a Statistics List or Statistics Summary extract based on a form. If this option is specified, the FIELDS operand must also be specified, and the STATnnnn or HSTGnnnn operands are not used.
SUFACTOR

Specifies a CPU SU conversion factor to apply to the HDB records. The SUFACTOR operand includes two keywords to identify the HDB name and its associated conversion factor. The value must be a decimal number or integer in the range 1 - 999999999 (nine 9s).

INTERVAL
Applicable to Summary HDBs. Optionally, specify the time interval for summarizing transaction activity. The default is the Time Interval used to create the data (as defined in the Template).

You can specify any interval greater than or equal to the Template Interval in the range 00:00:01 (1 second) to 24:00:00 (24 hours). For example, if you are reviewing many days worth of data then you might specify 24:00:00 so that you can analyze the daily trend.

DELIMIT
The field delimiter used to separate each data field in the extract records. Note that the specified delimiter is enclosed in quotes. The default field delimiter is a semicolon (;).

CICS PA extracts the data values from the HDB records, formats them, and then adds a field delimiter after each field.

STATnnnn, HSTGnnnn (statistics HDBs only)
Specifies the DDname for the extract data set for each statistics report that you want to extract, where nnnn is the statistics ID. STATnnnn identifies a CICS® Transaction Server statistics report; HSTGnnnn identifies a CICS Transaction Gateway statistics report. For example, HSTG000A(TGCMCSV) instructs CICS PA to extract CICS Transaction Gateway Connection Manager statistics report data to the extract data set identified by the DDname TGCMCSV. Dialog default: DDname matches keyword; for example, STAT010A(STAT010A).
STALTDEF(statistics-alert-definition)
The alert definition containing the conditions used to select the records that you want to report. You must have already created this alert definition in the currently active repository.
SEVERITY (statistics HDBs and performance list HDBs only)
Determines the minimum severity level to be reported and the type of transactions reported.
CRITICAL
Only Critical transactions are reported.
WARNING
Only Critical and Warning transactions are reported.
INFO
All alerts are reported: Critical, Warning and Informational transactions.
ELIGIBLE (statistics HDBs only)
Only eligible transactions are processed and reported. Eligible transactions are those that have resource values that match resource values specified in the alert definition.

This option provides the means to filter out transactions that would never generate an alert because their resource values do not match resource values specified in the alert definition.

ALL or blank
All transactions are reported regardless of whether they are eligible or whether they generate an alert. This is the default value.
INCLUDESEV (statistics HDBs only)
This option is used to insert a Sev column in the list report, showing the highest severity encountered for each record. (No other information is shown regarding the alert such as the field or alert that caused it.) This option must be selected if Severity=ALL.
TYPE(...) (statistics HDBs only)
The types of statistics intervals to include in the report.
LABELS|NOLABELS
LABELS indicates that the first record to be written to the extract data set is to be a field labels record. This is the default.

NOLABELS indicates that you do not want field labels written.

FLOAT|NOFLOAT
Specify FLOAT format to write numeric fields to the extract data set in S390 FLOAT format. This is necessary if you plan to import the extract into a DB2® table. When the DB2 Load Utility is used, it will interpret all numerical fields reliably and consistently in FLOAT format.

If FLOAT is not specified, the numeric fields are written in a mixture of integer, real and exponential using character digits. This is the default and is suitable when importing the extract data into a PC spreadsheet tool.

FIELDS
Specifies which fields are exported to the extract data set, the order in which they appear in the extract record, and their summarization presentation. If any of the requested data fields were not collected in the HDB, a message is issued and the field in the extract record contains blanks (List HDB) or Missing (Summary HDB).
SELECT, SELECT2
Specifies what data to include or exclude from the extract based on data field values.

SELECT and SELECT2 can both be specified to perform record filtering. The CICS PA dialog generates SELECT2 statements in the command deck when you use a Report Form that has active Selection Criteria. If both SELECT and SELECT2 are specified, then the record must pass selection by both specifications for it to be included in the report.