Previous Topic: END

Next Topic: LISTC

EXTRACT/PRINT

These control statements select the SMF data that you want to be:

If this product detects duplicate or overlapping SMF data, it will by default not allow any records to be extracted or printed from the history file data set causing this condition. To allow duplicate or overlapping SMF data to be extracted or printed, specify the PERMIT parameter on the EXEC JCL statement. To have overlapping data automatically discarded during the EXTRACT/PRINT process, specify the NODUPS parameter on the EXEC JCL statement. For further information, see the Systems Programmer Guide.

EXTRACT and PRINT take the same operands with the exception of the EXIT and TODD parameters, which pertain only to EXTRACT. You may include more than one EXTRACT or PRINT control statement in the same execution of CA SMF Director.

By default, EXTRACT and PRINT requests will be satisfied from the primary pool of history files. You may use the SOURCE control statement to specify the Alternate pool.

Only those SMF records having a standard header section as defined in the IBM z/OS Systems Management Facilities Manual will be selected for processing. CA SMF Director does not extract SMF record types 2 and 3, which are dump header and trailer records written by the IBM SMF dump programs.

Special Characteristics of the EXTRACT Control Statements

CA SMF Director honors user-defined record formats and truncates or pads records, as required. During extraction, a message is issued indicating the number of records truncated if the logical record length (LRECL) is not large enough to accommodate the largest record encountered. If the DD statement for the output file does not specify a block size, record length, or record format, CA SMF Director uses default values of LRECL=32760 and RECFM=VBS.

In addition, the EXTRACT statement can also create entries in a split file index to facilitate the automated application processing of SMF data that would normally have been saved to a split file during the dump process. See the SPLIT control statement for more information on split files and the index.

Special Characteristics of the PRINT Control Statements

Data is printed in standard dump format (character and hex), with a formatted heading of the information in the standard SMF record header. The record descriptor word (RDW) of the SMF record is not printed.

Statement Format:

EXTRACT/PRINT

►►─┬─ EXTRACT ─┬─┬──────────────────────┬─────────────────────────────────────►
   └─ PRINT ───┘ ├─ SID(sid1 ... sidn) ─┤
                 └─ ALL ────────────────┘

 ►─┬──────────────────────────────────┬─┬─────────────────┬───────────────────►
   ├─ FROM(date time)TO(date time) ───┤ └─ COUNT(nnnnnn) ─┘
   ├─ JFROM(date time)JTO(date time) ─┤
   ├─ YEAR(yyyy) ─────────────────────┤
   ├─ MONTH(mmyy) ────────────────────┤
   ├─ WEEK(date) ─────────────────────┤
   ├─ DAY(date) ──────────────────────┤
   ├─ YESTERDAY ──────────────────────┤
   ├─ LWEEK ──────────────────────────┤
   ├─ LMONTH ─────────────────────────┤
   └─ TODAY ──────────────────────────┘

 ►─┬────────────────────────────────────────────────────┬──────────────────────►
   └─ WHEN( ─┬─ component,test,value,test,value. ─┬─ ) ─┘
             └─ aa,bb,cc. ────────────────────────┘

 ►─┬─────────────────┬────────────────────────────────────────────────────────►
   ├─ SELECT(list) ──┤
   └─ EXCLUDE(list) ─┘

 ►─┬─────────────────────────────────────┬────────────────────────────────────►
   └─ TAPEVOLCHG( ─┬─ NORELEASE ◄ ─┬─ ) ─┘
                   └─ RELEASE ─────┘

 ►─┬───────────────────────────────────────────────────────────────┬──────────►
   └─ INDEXDSN(dsname) ─┬────────────────────┬─┬─────────────────┬─┘
                        └─ INDEXDUP(ddname) ─┘ └─ INDEXLIM(nnn) ─┘

 ►─ EXIT(module) ─ TODD(ddname) ──────────────────────────────────────────────►

 ►─┬───────────────────────────────────────┬──────────────────────────────────►
   ├─ LSNAME( ─┬─ lsname lsname ... ─┬─ ) ─┤
   │           └─ NONE ──────────────┘     │
   └─ SUBNAME( ─┬ subname subname ... ─┬ ) ┘
                └ NONE ────────────────┘
 ►─┬────────────────────────────┬─┬─────────────────────────────┬─ . ─────────►◄
   └─ MANFILE( ─┬─ YES ◄ ─┬─ ) ─┘ └─ EXPAND110( ─┬─ NO ◄ ─┬─ ) ─┘
                └─ NO ────┘                      └─ YES ──┘

Operands and Descriptions:

SID(sid1...sidn)

Specifies the identification of one or more (operating) systems for which data is to be extracted.

"(sid)" may identify up to 20 systems. You may code this part of the statement as follows: SID(sid1,sid2...). Either SID or ALL operand must be specified.

ALL

Causes data to be extracted for all the indexed systems, for which CA SMF Director has an entry, that fall within the specified time range. Either SID or ALL operand must be specified.

FROM (date time)

TO (date time)

Specifies the beginning and ending of the period for which SMF data is to be extracted. SMF records whose timestamps exactly match the FROM specification are considered to be inside the time range. SMF records whose timestamps exactly match the TO specification are considered to be outside the time range.

"date" is in Gregorian (mmddyy) format. (e.g., July 1, 2008 would be 070108.)

"time" is coded in hour/minute (hhmm) format. For EXTRACT, time can be coded in hour/minute/second (hhmmss) format.

JFROM(date time)

Specifies the beginning date and time for the SMF records to be extracted or printed. "Date" is in Julian date format (cyyddd), where "c" is 0 for 1960 through 1999 and 1 for 2000 and thereafter. Consequently, 098182 represents July 1, 1998, and 101001 represents January 1, 2001. "Time" is coded in hour, minute and second format (hhmmss or hhmm). Code either the JFROM keyword or the FROM keyword, but not both.

JTO(date time)

Specifies the ending date and time for the SMF records to be extracted or printed. "Date" is in the Julian format (cyyddd). "Time" is coded in hour, minute, and second format (hhmmss or hhmm). Code either the JTO keyword or the TO keyword, but not both.

Note: If an EXTRACT statement includes at least one FROM, TO, JFROM, or JTO parameter with a starting or ending time explicitly coded, the installation's logical day specification (the SDAY value defined on the OPTIONS statement) will be ignored. If only a starting time is coded, the ending time will default to midnight at the end of the TO/JTO date. If only an ending time is coded, the starting time will default to midnight at the beginning of the FROM/JFROM date.

YEAR(yy)

Specifies that the SMF data for an entire calendar year is to be processed. If "yy" is 59 or less, the year is treated as 20yy. If "yy" is 60 or greater, the year is treated as 19yy. Consequently, YEAR(2000) requests extraction of data beginning January 1 and ending December 31, 2000.

MONTH(mmyy)

Specifies that the SMF data for an entire calendar month is to be processed. For example, "(0408)" specifies April 2008.

WEEK(date)

Specifies that the SMF data for an entire calendar week (168 continuous hours) beginning with the specified date, is to be processed.

"Date" is in Gregorian (mmddyy) format.

DAY(date)

Specifies that the SMF data for one calendar day is to be processed.

"date" is in Gregorian (mmddyy) format.

YESTERDAY

Specifies processing of SMF data for yesterday's calendar day. "Yesterday" is the current logical date minus one, at the time the extract is run.

LWEEK

Specifies that SMF data is to be extracted or printed for the last calendar week, running Sunday through Saturday.

LMONTH

Specifies that SMF data is to be extracted or printed for the last calendar month. For example, if an EXTRACT LMONTH is run on July 2008, CA SMF Director will extract all data from June 2008.

TODAY

Specifies that SMF data is to be extracted or printed for the current logical day.

Note: In determining what is the current day, week, or month for the purpose of processing the YESTERDAY, LWEEK, LMONTH, or TODAY parameter, CA SMF Director takes into account the installation's system-wide SDAY option. For example, suppose that an installation's SDAY option is set to 0900 and an EXTRACT is run at 0800 on Sunday, July 1, 2008. In that case the LMONTH operand would result in extraction of all data between 0900 on May 1, 2008 and 0900 on June 1, 2008; LWEEK would result in extraction of all data between 0900 on Sunday, June 17 and 0900 on Sunday, June 24; YESTERDAY would cause all data between 0900 on June 29 and 0900 on June 30 to be extracted; TODAY would cause all data between 0900 on June 30 and 0900 on July 1 to be extracted. This is because the logical date would still be Saturday, June 30. Running EXTRACT an hour later would change the results of all three of these operands, as the logical date would become July 1 at 0900 on that date. Thus, the LMONTH, LWEEK, YESTERDAY, and TODAY operands would extract or print the data between:

In all cases, SMF records whose timestamps exactly match the beginning of the specified interval are selected, while SMF records whose timestamps exactly match the end of the specified interval are not selected.

COUNT(n)

Specifies the maximum number of records to be extracted.

"(n)" must be a postive integer.

WHEN(aa,bb,cc) or WHEN(component,test,value,test,value...)

Allows the specification of additional selection criteria for SMF records. The WHEN selection criteria can be based on either offsets or up to five components, but not both. For a description of component-based WHEN selection criteria, see the SPLIT statement. The offset-based WHEN selection criteria is described here.

A SMF record is selected for output processing when it meets all of the specified conditions. There may be up to four occurrences of 'aa,bb,cc'.

'aa' is the numeric offset within the SMF record relative to zero (column 1) that is to be checked. The offset can be any number from 14 up to 32767.

Note: If you are looking at a listing from an IDCAMS dump or SMF display from an earlier PRINT command, remember that neither of these methods displays the record descriptor word (RDW). Therefore, the WHEN offset must be coded as 4 greater than the apparent displacement of the field as shown in an IDCAMS dump or a CA SMF Director PRINT command listing.

'bb' is any one of the following two-character operators:

'cc' is the character or hexadecimal constant up to 32 bytes in length. It may be coded as a hexadecimal value in the format X'zz', where 'zz' is an even number of hexadecimal digits. For example:

EXTRACT ALL MONTH(0408)SELECT(14,15)WHEN(68,EQ,'SYS1')

results in the extraction of all SMF record type 14 and 15 records generated during April 2008 for data sets whose names begin with SYS1.

SELECT(list)|EXCLUDE(list)

Specifies selection of only certain record types for processing, or exclusion of certain record types for processing. If neither or these two operands is coded, CA SMF Director processes all stored SMF records that fall within the specified date and time range.

'list' may include any valid SMF record types and subtypes; the valid numbers being 0 through 255. They may be expressed as individual record types separated by a comma, and/or as a range separated by a colon. Subtypes, if specified, must be coded as three decimal places; e.g., 30.004. For example, SELECT(30.001:30.005) results in the retrieval of SMF record type 30, subtypes 1 through 5. EXCLUDE(99.02,99.1) causes the retrieval of all stored SMF records except for type 99, subtypes 20 and 100.

Some SMF records have subtypes of zero. To specify subtype zero, a value of zero must be placed to the right of the decimal point. For example, SELECT(116.000) indicates SMF Records of type 116, Subtype 0, while SELECT(116) indicates all type 116 records.

TAPEVOLCHG(NORELEASE|RELEASE)

Specifies whether CA SMF Director should release the history tape unit when it is about to call for the mount of a new history volume. The default is NORELEASE.

Note: TAPEVOLCHG does not apply to history files that reside on DASD.

INDEXDSN(dsn)

(For EXTRACT only.) Specifies the name of a split file index, where information about this extract is recorded. This is an optional parameter provided to facilitate processes that use the split file index to process data that has been archived by CA SMF Director. The parameter should contain the data set name of the split file index that is used in the automated process. For more information about split file indexes, see the description of the SPLIT control statement. For more information on setting up a split file index, see the Systems Programmer Guide.

A single, specific SID must be coded when using INDEXDSN. ALL is not supported.

INDEXDUP(ddname)

(For EXTRACT only.) Specifies the ddname in the extract JCL where a copy of the split file index will be written. This operand is valid only if the INDEXDSN operand is present; otherwise it is ignored.

INDEXLIM(nnn)

(For EXTRACT only.) Specifies the maximum number of entries that are kept in the split file index. This operand is valid only if the INDEXDSN operand is present; otherwise it is ignored.

EXIT(module)

(For EXTRACT only.) Specifies the module to be called as an exit to receive extracted SMF data for further processing. TODD must also be coded if this product is to write the extracted output file; otherwise it assumes that the exit module will process the extracted data as desired.

"(module)" is the 1 to 8-character name of a module to be dynamically loaded during the processing of this request. Refer to "Writing Extraction Exits" in Chapter 3 of the Systems Programmer Guide.

TODD(ddname)

(For EXTRACT only.) Specifies the name of the DD statement defining the file to which the extracted SMF records are to be written.

"(ddname)" must be a 1 to 8-character ddname, corresponding to a DD statement in the execution JCL for the job.

More than one EXTRACT request may be coded for the same DD. If the TODD parameter is omitted, CA SMF Director will use a default ddname of EXTRACT.

LSNAME(NONE|lsname lsname ...)

Specifies a subset of logstream names that CA SMF Director will include in the search to satisfy an EXTRACT or PRINT request. If this operand is not included, all of the logstreams being managed will be included in the requests. LSNAME(NONE) means that none of the logstreams should be included when searching for records to satisfy a request.

SUBNAME(NONE|subname subname ...)

Specifies a subset of substream names that CA SMF Director will include in the search to satisfy an EXTRACT or PRINT request. If this operand is not included, all of the substreams being managed will be included in the requests. SUBNAME(NONE) means that none of the substreams should be included when searching for records to satisfy a request.

MANFILE(YES|NO)

Specifies whether the MAN file archives should be searched to find records to satisfy an EXTRACT or PRINT request. The default value of YES includes the MAN files in the search. NO limits the request to search only the logstreams and substreams.

EXPAND110(YES|NO)

Indicates whether or not compressed SMF type 110 records should be expanded before they are either written to the extract file or printed. If the value of the operand is YES, CA SMF Director will expand any compressed type 110 records that are to be written to the output file or printed. The default value is NO, meaning that no expansion of type 110 records will be performed.

Sample EXTRACT Statements:

Obtain SMF records from systems XE21, XAE1 and XAE4 from December 16, 2008 at 8:00 a.m. to December 16, 2008 at 5:30 p.m. Exclude SMF record types: 14,15,70,71,72,73,74,75,76,77,78,79:

EXTRACT SID(XE21,XAE1,XAE4)
     FROM(121608 080000) TO(121608 173000)
        EXCLUDE(14:15,70:79).

Obtain RMF records from all systems for the first quarter of the year 2008, January 1 2008 to March 31 2008:

EXTRACT SID(ALL) JFROM(108001 000000) JTO(108091 240000)
     SELECT(70:79).

Obtain all SMF records for system XE96 and XE74 from April 16, 2008 at 4:00 p.m. to September 27, 2008 at 12:30 p.m. Place all records in the data set referenced in the JCL by ddname SMFOUT:

EXTRACT SID(XE96,XE74)  JFROM(108107 1600) JTO(108271 1230)
     TODD(SMFOUT).

Obtain RMF records from 10 a.m. to 4 p.m. on January 17, 2008, but only include data from logstreams IFASMF.LSTRM1 and IFASMF.LSTRM2 and only from system XFF1:

EXTRACT SID(XFF1) FROM(011708 100000) TO(011708 160000)
     SELECT(70:79) MANFILE(NO) TODD(SMFOUT)
     LSNAME(IFASMF.LSTRM1 IFASMF.LSTRM2).

Extract any records from the last month on system XFF1 that were not captured in a logstream:

EXTRACT SID(XFF1) LMONTH TODD(SMFOUT) LSNAME(NONE).

EXTRACT statement output:

CA HERNDON AUDIT TRAIL REPORT SMFD PAGE 1 CA SMF Director 12.6 SYSA 20 SEP yyyy 8:50:57 EXTRACT SID(XE96,XE74) JFROM(107100 1600) JTO(107270 1230) TODD(SMFOUT). CAF1010I REQUEST ACCEPTED CAF2218I SMF DATA USING CONFIGURATION XE96 IS BEING PROCESSED CAF2221I SMF DATA USING CONFIGURATION XE96 IS BEING PROCESSED WITH LOGSTREAM IFASMF.ALL CAF2221I SMF DATA USING CONFIGURATION XE96 IS BEING PROCESSED WITH LOGSTREAM IFASMF.RMF CAF2221I SMF DATA USING CONFIGURATION XE96 IS BEING PROCESSED WITH LOGSTREAM IFASMF.T30 CAF2218I SMF DATA USING CONFIGURATION XE74 IS BEING PROCESSED CAF2221I SMF DATA USING CONFIGURATION XE74 IS BEING PROCESSED WITH LOGSTREAM IFASMF.SMFDATA CAF2221I SMF DATA USING CONFIGURATION XE74 IS BEING PROCESSED WITH LOGSTREAM IFASMF.WHISTLE CAF3100I 15669 RECORDS WRITTEN TO SMFOUT FILE CAF3105I 6954 RECORDS PROCESSED FROM: 08/01/2008 9:33:37 TO: 09/19/2008 10:13:33 FOR SYSID XE96 CAF3105I 8715 RECORDS PROCESSED FROM: 07/23/2008 10:52:36 TO: 07/24/2008 11:14:03 FOR SYSID XE74 SUMMARY OF RECORDS EXTRACTED FROM: 07/23/2008 (107.204) 10:52:36.56 TO: 09/19/2008 (107.262) 10:13:33.83 TYPE AVGL MAXL TOTAL ................................ SUBTYPE COUNTS ................................ 0 60 60 1 4 238 319 71 5 148 154 33 8 624 624 1 14 359 632 356 15 333 344 134 17 100 100 20 19 72 72 1,425 20 95 101 35 22 302 302 1 23 134 134 24 26 443 451 52 30 1062 3773 2,418 1 - 104 2 - 1,485 3 - 128 4 - 127 5 - 64 6 - 510 32 399 548 14 1 - 4 2 - 3 3 - 4 4 - 3 34 700 703 3 35 154 154 3 40 219 546 84 41 136 212 104 1 - 2 3 - 102 42 472 20972 771 5 - 51 6 - 720 43 32 32 1 50 164 242 50 52 62 62 10 60 516 600 104 61 615 3648 11 62 188 188 92 64 458 458 88 65 316 381 12 80 256 256 1,851 88 222 308 109 1 - 55 11 - 54 89 2363 4478 100 1 - 50 2 - 50 90 326 596 32 92 213 276 1,245 1 - 9 10 - 26 11 - 1,210 99 907 2996 3,323 1 - 373 2 - 1,848 3 - 370 6 - 372 9 - 360 119 236 644 63 5 - 2 6 - 2 7 - 1 10 - 58 231 292 292 3 255 760 760 3,025 2 - 3,025 ALL 624 20972 15,669 CAF2900I RUN COMPLETE

The following list gives an explanation of the fields contained in the Summary of Records Extracted section of the report.

TYPE

SMF record type (numeric 0-255).

AVGL

Average record length of records for this type.

MAXL

Maximum record length of records for this type.

TOTAL

Number of records for this type successfully written to output.

SUBTYPE COUNTS

A list of SMF record subtypes and how many records for each subtype were successfully written. The first number shown is the numeric SMF record subtype, followed by the number of records. Counts for records with no subtype (zero) are not shown on the report. However, they are included in the total number of records.

ALL

Indicates the grand total line for all SMF record types written.

Sample PRINT Statement:

PRINT SID(XE44) FROM(041698 131500)  TO(041698 132000)
           COUNT(5).

PRINT statement output:

CA AUDIT TRAIL REPORT SMFD PAGE 1 CA SMF Director 12.6 SYSA 27 JUL yyyy 11:45:24 SOURCE PRIMARY. CAF2800I SOURCE OPTION SET PRINT SID(XE44) FROM(041698 131500) TO(041698 132000) COUNT(5) . CAF1010I REQUEST ACCEPTED CAF3200I SMF RECORD TYPE 21 BUFFER DATE 04/16/2008 ( 98/106) TIME 13:16:44 0000 1E150048 F1980098 106FE7C5 F4F40036 F3F0F5F0 F9F00752 78048081 00000033 *....1.....XE44..305090..........* 0020 00000000 00000000 00000000 00000000 00000000 00000100 00000000 00000000 *................................* 0040 00000000 *.... * CAF3200I SMF RECORD TYPE 21 BUFFER DATE 04/16/2008 ( 98/106) TIME 13:16:56 0000 1E150048 F6700098 106FE7C5 F4F40036 F3F0F3F3 F0F2074D 78048081 00000049 *....6.....XE44..303302..........* 0020 00000000 00000000 00000000 00000000 00000000 00037800 00000000 00000000 *................................* 0040 00000000 *.... * CAF3100I 2 RECORDS WRITTEN TO SYSPRINT FILE CAF2900I RUN COMPLETE