Previous Topic: Using Split Files Generated with the TIME Operand

Next Topic: TAPEINIT

STREAMOPTIONS

This control statement can be used to override options indicated on the OPTIONS and DUMPOPTIONS statements for a particular logstream or substream within a configuration. The STREAMOPTIONS statements must be included in a COMPILE CONFIGURATION block between the BEGIN and END statements. The STREAMOPTIONS statement is optional for logstreams defined within a configuration, since all of the archival properties for a logstream can be defined in the OPTIONS and DUMPOPTIONS statement.

A STREAMOPTIONS statement is required for each substream so that the SMF record types for the stream can be indicated. For substreams, the record types that will be archived to the stream must be indicated in a SELECT operand or excluded in an EXCLUDE operand. Not all record types need to be accounted for as the traditional MAN file archives will still be produced for all records not defined to a stream, but a record type can be designated to only one substream.

Each STREAMOPTIONS statement applies to one logstream or substream that is defined within the configuration being compiled. SMF logstreams that are shared between systems (which is not recommended) that need specific settings must have a STREAMOPTIONS statement within each configuration for each system. Almost all of the operands in the STREAMOPTIONS statement are optional. If they are omitted, the values are taken from either the DUMPOPTIONS statement that is in effect for the configuration or the OPTIONS statement that contains the global options for the SCDS.

Statement Format:

STREAMOPTIONS

►►─ STREAMOPTIONS ─┬SUBNAME(subname)─────┬SELECT(list) ┬───┬──────────────────►
                   │                     └EXCLUDE(list)┘   │
                   └LSNAME(lsname) ────────────────────────┘

 ►─┬────────────────────────────┬─────────────────────────────────────────────►
   └COPIES( ─┬─ * ◄ ─┬─ ) ──────┘
             ├─ 1 ───┤
             └─ 2 ───┘     

 ►─┬──────────────────────────────────────────────────────────────────────────►
   ├─ UPCATLG ◄ ─┤ 
   ├─ NOCATLG ───┤
   └─ CATLG ─────┘

 ►─┬────────────────────────┬─────────────────────────────────────────────────►
   ├─ PREFIX(─┬──*◄ ───┬─)──┤
   ├─         └ prefix ┘    │
   └─ NOPREFIX ─────────────┘

 ►─┬─────────────────────────┬────────────────────────────────────────────────►
   ├─ APREFIX(─┬──*◄ ───┬─)──┤
   ├─          └ prefix ┘    │
   └─ NOAPREFIX ─────────────┘

 ►─┬──────────────────────┬───────────────────────────────────────────────────►
   ├─ RETPD(──┬──*◄ ─┬─)──┤
   ├─         └ nnnn ┘    │
   ├─ EXPDT(──┬──*◄ ───┬─)│
   └─         └ yyyddd ┘ ─┘ 

 ►─┬──────────────────────┬───────────────────────────────────────────────────►
   ├─ ARETPD(─┬──*◄ ─┬─)──┤
   ├─         └ nnnn ┘    │
   ├─ AEXPDT(─┬──*◄ ───┬─)│
   └─         └ yyyddd ┘  ┘ 

 ►─┬───────────────────────┬──────────────────────────────────────────────────►
   └─ TRTCH(──┬──*◄ ──┬─)──┘
              └ value ┘    

 ►─┬───────────────────────┬──────────────────────────────────────────────────►
   └─ ATRTCH(─┬──*◄ ──┬─)──┘
              └ value ┘    

 ►─┬────────────────────────────────┬─────────────────────────────────────────►
   └─ MAXFILESONVOL( ─┬─ * ◄ ─┬─ ) ─┘
                      └─ n ───┘

 ►─┬────────────────────────────┬─────────────────────────────────────────────►
   └─ DAYSTACK( ─┬─ * ◄ ──┬─ ) ─┘
                 ├─ YES ──┤
                 └─ NO ───┘
 ►─┬────────────────────────────┬─┬─────────────────────────────┬─────────────►
   └─ PDSNLARGE( ─┬─ * ◄ ──┬─) ─┘ └─ ADSNLARGE( ─┬─ * ◄ ──┬─ ) ─┘
                  ├─ YES ──┤                     ├─ YES ──┤
                  └─ NO ───┘                     └─ NO ───┘
 ►─┬─────────────────────┬────────────────────────────────────────────────────►
   └─ SDAY(──┬──*◄ ─┬─)──┘
             └ hhmm ┘    
 ►─┬──────────────────────┬───────────────────────────────────────────────────►
   ├─ PDEVN(──┬──*◄ ──┬─)─┤
   ├─         ├ dname ┤ ──┤
   ├─         └ NONE ─┘ ──┤
   ├─ PSTORC(─┬──*◄ ──┬─)─┤
   ├─         ├ class ┤ ──┤
   └─         └ NONE ─┘ ──┘
 ►─┬──────────────────────┬─────────────────────────────────────── . ─────────►◄
   ├─ ADEVN(──┬──*◄ ──┬─)─┤
   ├─         ├ dname ┤ ──┤
   ├─         └ NONE ─┘ ──┤
   ├─ ASTORC(─┬──*◄ ──┬─)─┤
   ├─         ├ class ┤ ──┤
   └─         └ NONE ─┘ ──┘

Operands and Descriptions:

LSNAME(lsname)|SUBNAME(subname)

Identifies the stream that this definition applies to, for the configuration being compiled. The name of the stream must be included either in a DUMPOPTIONS statement processed in this compilation or in a previous DUMPOPTIONS statement. Both logstream names and substream names can be up to 26 characters. Logstream names must also begin with IFASMF and can contain up to two additional 8-byte nodes. Substream names cannot begin with a first node that begins with the letter “I” or the three characters "SYS" and must contain at least two nodes.

SELECT(list)|EXCLUDE(list)

Determines which record types are included or excluded within a substream. The list may include any valid SMF record types, numbers 0 through 255, listed as individual record types separated by a comma and/or as a range separated by a colon.

One of these operands is required if SUBNAME is specified. If neither SELECT nor EXCLUDE is specified, the selection defaults to EXCLUDE(0:255), which effectively disables the substream.

If LSNAME is specified, an error is reported if SELECT or EXCLUDE is also specified.

Note: Multiple logstreams can archive the same records, but this is not allowed for substreams. A record type can only be assigned to one substream.

Records that are not assigned are dumped into the traditional MAN file archive.

COPIES(*|1|2)

Specifies whether the records should be saved in a single archive (the primary) or in two archives (primary and alternate). If this operand is not coded or the asterisk is coded, the default value is taken from the levels above the stream definition.

UPCATLG|NOCATLG|CATLG

Indicates whether the history files generated for this stream during the dump process should be cataloged:

PREFIX(*|prefix)|NOPREFIX

Sets the first 26 characters of the history file data set names (DSNs) for the primary archive. If this operand is not coded or the asterisk is coded, the default value is taken from the levels above the stream definition.

APREFIX(*|prefix)|NOAPREFIX

Sets the first 26 characters of the history file data set names (DSNs) for the alternate archive. If this operand is not coded or the asterisk is coded, the default value is taken from the levels above the stream definition.

EXPDT(*|yyyddd)|RETPD(*|nnnn)

Specifies the expiration date or retention period of the history file data sets within the primary pool. If the expiration date is specified, it must be in Julian date format. If this operand is not coded or the asterisk is coded, the default value is taken from the levels above the stream definition.

See Control Statement Language Rules for a description of two special expiration dates: 099000 and 099366.

We recommend that expiration dates or retention periods be used. They increase the integrity of the SMF data. If you use the AUTODEL feature, you must set either expiration dates or retention periods.

Note: If the PSTORC option is in effect, SMS may override the specified expiration date or retention period.

AEXPDT(*|yyyddd)|ARETPD(*|nnnn)

Specifies the expiration date or retention period of the history file data sets within the alternate pool. If the expiration date is specified, it must be in Julian date format. If this operand is not coded or the asterisk is coded, the default value is taken from the levels above the stream definition.

See Control Statement Language Rules for a description of two special expiration dates: 099000 and 099366.

We recommend that expiration dates or retention periods be used. They increase the integrity of the SMF data. If you use the AUTODEL feature, you must set either expiration dates or retention periods.

Note: If the ASTORC option is in effect, SMS may override the specified expiration date or retention period.

TRTCH(*|value)
ATRTCH(*|value)

Lets you use the z/OS JCL TRTCH parameter on dynamically allocated history files in CA SMF Director. The values of the TRTCH and ATRTCH operands are the same as the values allowed in z/OS JCL when writing an output file to tape. TRTCH is used to set the recording technique for the primary history file. ATRTCH is used to set the TRTCH for the alternate history file.

Valid values are as follows:

NOCOMP

For cartridge tapes, writes the history file without data compression.

COMP

For cartridge tapes, writes the history file with data compression.

C

Performs data conversion for history files on reel tapes.

E

Writes history files to reel tape with even parity.

ET

Writes history files to reel tape with even parity and performs EBCDIC translation.

T

Writes history files to reel tape and performs EBCDIC translation.

Note: Although CA SMF Director supports TRTCH options C, E, ET, and T, they are not recommended for history files.

If neither TRTCH nor ATRTCH is specified, the value is taken from the levels above the stream definition. If not specified at a higher level, the system default is used.

MAXFILESONVOL(*|n)

Lets you override the value set for MAXFILESONVOL. (See the description of MAXFILESONVOL on the DUMPOPTIONS and OPTIONS statements.)

If this operand is not coded or the asterisk is coded, the value is taken from the DUMPOPTIONS statement.

DAYSTACK(NO|YES|*)

Specifies whether the daystacking feature should be turned on or off. NO turns daystacking off. See Features for a description of the daystacking feature. If this operand is not coded or the asterisk is coded, the default value is taken from the levels above the stream definition.

PDSNLARGE(*|YES|NO)

Allocates the primary history file with the DSNTYPE=LARGE operand. This operand is only used for DASD history files when the DYNAM operand is specified; otherwise it is ignored. If this operand is not coded or the asterisk is coded, the default value is taken from the levels above the stream definition.

ADSNLARGE(*|YES|NO)

Allocates the alternate history file with the DSNTYPE=LARGE operand. This operand is only used for DASD history files when the DYNAM operand is specified; otherwise it is ignored. If this operand is not coded or the asterisk is coded, the default value is taken from the levels above the stream definition.

SDAY(*|hhmm)

Specifies the hour (hh) and minute (mm) that CA SMF Director is to treat as the logical start of a day. If this operand is not coded or the asterisk is coded, days start at the value indicated in the DUMPOPTIONS statement for this configuration. If no value is set, the value defaults to midnight, coded as SDAY(0000).

Note: The global SDAY value is used to determine the starting and ending times for all EXTRACT and PRINT requests, except when the FROM, JFROM, TO, or JTO operand gives a specific starting or ending time. The value specified here is used for the daystacking feature only.

PDEVN(*|dname|NONE)

'dname' is the esoteric device name to be used when creating SMF history files for this stream in the primary pool. Up to eight characters can be specified. It is mutually exclusive with PSTORC. Specify NONE to reset the device name. If neither PDEVN nor PSTORC is specified and the DYNAM option is enabled, the device name or storage class used is taken from the DUMPOPTIONS statement.

Note: If you are changing the PDEVN operand from one tape unit name to another, you must immediately run a TAPEINIT command indicating this stream.

If using DASD for history files, this operand must only be used for non-SMS managed volumes.

PSTORC(*|class|NONE)

'class' is the IBM DFSMS storage class to be used when creating SMF history files for this stream in the primary pool. Up to eight characters can be specified. It is mutually exclusive with the PDEVN keyword. Specify NONE to reset the storage class. If neither PDEVN nor PSTORC is specified and the DYNAM option is enabled, the device name or storage class used is taken from the DUMPOPTIONS statement.

If using DASD for history files, this operand will allocate files only to SMS-managed volumes. Note that some issues may arise with DASD history file allocations based on how SMS is set up at your data center. For DASD history allocations with the DYNAM option set, there must still be a temporary history file allocated in the JCL that indicates how large the history file should be. SMS may not allow the allocation on the storage class indicated in the PSTORC operand and will indicate an allocation error for the history file, causing the dump process to end prematurely.

To avoid this issue, here are some remedies you can:

ADEVN(*|dname|NONE)

'dname' is the esoteric device name to be used when creating SMF history files for or this stream in the alternate pool. Up to eight characters can be specified. It is mutually exclusive with ASTORC. Specify NONE to reset the device name. If neither ADEVN nor ASTORC is specified and the DYNAM option is enabled, the device name or storage class used is taken from the DUMPOPTIONS statement.

Note: If you are changing the ADEVN operand from one tape unit name to another, you must immediately run a TAPEINIT command against this stream.

If using DASD for history files, this operand must only be used for non-SMS managed volumes.

ASTORC(*|class|NONE)

'class' is the IBM DFSMS storage class to be used when creating SMF history files for this stream in the alternate pool. Up to eight characters can be specified. It is mutually exclusive with the ADEVN keyword. Specify NONE to reset the storage class. If neither ADEVN nor ASTORC is specified and the DYNAM option is enabled, the device name or storage class used is taken from the DUMPOPTIONS statement.

If using DASD for history files, this operand will allocate files only to SMS-managed volumes. Note that some issues may arise with DASD history file allocations based on how SMS is set up at your data center. For DASD history allocations with the DYNAM option set, there must still be a temporary history file allocated in the JCL that indicates how large the history file should be. SMS may not allow the allocation on the storage class indicated in the ASTORC operand and will indicate an allocation error for the history file, causing the dump process to end prematurely.

To avoid this issue, here are some remedies you can use:

Sample STREAMOPTIONS Statement:

COMPILE CONFIGURATION STORE. 
  BEGIN CONFIG(002) SID(XE96) NAME('C.A. XE96'). 
    DUMPOPTIONS COPIES(2) NOCATLG SCRATCH NOVERIFY 
	RETPD(60) ARETPD(365) PREFIX(SYSPROG.CASMF.XE96) 
	LSNAME(IFASMF.ALL,IFASMF.T30,IFASMF.RMF) 
	TCH(NOCOMP) ATRTCH(COMP). 
    STREAMOPTIONS LSNAME(IFASMF.RMF) RETPD(90) PREFIX(SYSPROG.CASMF.XE96RMF)
	COPIES(1).
  END CONFIG(002).