The HDB(EXTRACT) operand requests CICS PA to generate
CSV extracts from HDB data.
The command format is:
CICSPA HDB(EXTRACT(hdbname),
[OUTPUT(ddname),]
[DDNAME(ddname),]
[STATnnnn(ddname),]
[HSTGnnnn(ddname),]
[DELIMIT('field-delimiter'),]
[LABELS|NOLABELS,]
[FLOAT,]
[INTERVAL(hh:mm:ss),]
[FIELDS(field1[(options)],...),]
[SELECT(PERFORMANCE(INCLUDE|EXCLUDE(field1(values1),...),...)),]
[SELECT2(PERFORMANCE(INCLUDE|EXCLUDE(field1(values1),...),...))])
The options are:
- EXTRACT
- Specifies the name of the HDB from which to extract data. The
HDB must be defined in the HDB Register (DDname CPAHDBRG).
- OUTPUT
- Specifies the DDname for the Recap report output. If not specified,
the CICS PA dialog
assigns a DDname in the format HXTS0001 to uniquely identify
the output.
- DDNAME (performance HDBs only)
- Specifies the DDname for the performance extract data set. Dialog
default: HDBX0001
- 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).
- DELIMIT
- Specifies the field delimiter, enclosed in quotes, to be used
to separate each data field in the extract data set. The default is
a semicolon DELIMIT(';').
- 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 CICS PA is not
to write a field labels record to the extract data set.
- FLOAT (performance HDBs only)
- Write numeric fields in the extract in S390 FLOAT format.
Specify FLOAT
format 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.
- INTERVAL
- This operand applies to Summary HDBs. It specifies a time interval
when the extract summarizes transaction activity over time. The interval
is in the range 1 second to 24 hours in the format hh:mm:ss for
hours, minutes, and seconds. The HDB Summary data is already summarized
by time. You can omit the INTERVAL operand to use the data's interval,
or specify an interval that is longer than the data interval. For
example, specify 00:15:00 if you want to summarize transaction activity
over 15 minute intervals.
A
time interval of less than one hour must fit evenly into the hour. CICS PA will
round it down to the nearest interval that aligns to the hour. For
example, 1.35 is reduced to 00:01:30 minutes which will produce 40
interval report lines for each hour of data.
A time interval of more than one hour
must fit evenly into the day. CICS PA will
round it down to the nearest interval that aligns to the day. For
example, 10.30.23 is reduced to 08:00:00 hours which will produce
3 interval report lines for each day of data.
Minutes take precedence for an abbreviated
entry. For example:
- 1
- becomes 00:01:00
- 1.1
- becomes 00:01:00 (rounded down from 00:01:01)
- 1.1.1
- becomes 01:00:00 (rounded down from 01:01:01)
- FIELDS
- Specifies which fields are extracted, the order in which they
appear in the extract, and their summarization presentation. Only
fields that are specified in the HDB Template can be specified. Fields
not contained in the HDB are written as Missing.
- SELECT, SELECT2
- Specifies
what data to include or exclude from the extract based on data field
values. See Using SELECT statements for an explanation
and examples.
Only fields that are specified in the HDB Template
can be specified. Select Fields not contained in the HDB will cause
selection to fail and extract will skip the record. 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 extract.