STREAMOPTIONS

This control statement can be used to override options that are 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 that are defined within a configuration. The logstreams are optional because all the archival properties for a logstream can be defined in the OPTIONS and DUMPOPTIONS statement.
smfd127
This control statement can be used to override options that are 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 that are defined within a configuration. The logstreams are optional because all 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 the substreams, the record types that are archived to the stream must be indicated in a SELECT operand or excluded in an EXCLUDE operand. Records that are not represented by the SELECT or EXCLUDE operands will be written to the MAN File archive which is also active during the dump process.  An SMF record type can be directed to only one substream.
Each STREAMOPTIONS statement applies to one logstream or substream that is defined within the configuration being compiled. The SMF logstreams that are shared between systems that need specific settings must have a STREAMOPTIONS statement within each configuration for each system. This procedure is
not
recommended. Almost all of the operands in the STREAMOPTIONS statement are optional. If the statements 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(──┬──*◄ ──┬─)─ PSTORC(─┬──*◄ ──┬─)─┤┤    ├─         ├ dname ┤ ──┤  ─     ├ class ┤ ──┤    ├─         └ NONE ─┘ ──┤        └ NONE ─┘ ──┘    └ ►─┬───────────────────────────┬──────────────────────────────────────────────►    ├─ ADEVN( ─┬─ dname ─┬─ ) ──┤└─ ASTORC( ─┬─ class ─┬─ ) ──┤    │          └─ NONE ──┘                   └─ 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 that is processed in this compilation or in a previous DUMPOPTIONS statement. Both logstream names and substream names can be up to 26 characters. The logstream names must also begin with IFASMF and can contain up to two more 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 can include any valid SMF record types, numbers 0 through 2047
, listed as individual record types separated by a comma or as a range separated by a colon, or both.
If SUBNAME is specified, one of these operands is required. If SELECT or EXCLUDE is not specified, the selection defaults to EXCLUDE(0:2047), which effectively disables the substream.
If LSNAME is specified, and SELECT or EXCLUDE is also specified an error is reported.
Note
: Multiple logstreams can archive the same records, but this procedure 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 can 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 can be cataloged:
  • If NOCATLG is specified, the history files are not cataloged.
  • If CATLG is specified, the history files are cataloged.
  • If the default UPCATLG is specified, the catalog value is taken from the levels above the stream definition.
Note:
When history files are written to DASD, the CATLG option is recommended. If DASD history files are not cataloged, there is a danger that a history file can be archived and then later restored to a different volume. This action causes a S213 ABEND in a subsequent EXTRACT that attempted to access the history file. The EXTRACT looks for the file on the volume on which it originally resided.
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 the 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, set either expiration dates or retention periods.
Note
: If the PSTORC option is in effect, SMS can 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 the 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, set either expiration dates or retention periods.
Note
: If the ASTORC option is in effect, SMS can 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.
The valid values are as follows:
NOCOMP
For cartridge tapes, writes the history file without a data compression.
COMP
For cartridge tapes, writes the history file with a 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 an EBCDIC translation.
T
Writes history files to reel tape and performs an EBCDIC translation.
Note:
Although CA SMF Director supports TRTCH options C, E, ET, and T, they are not recommended for history files.
If TRTCH or ATRTCH are not 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 that is set for MAXFILESONVOL. For more information, see the description of MAXFILESONVOL on the DUMPOPTIONS and OPTIONS statements.)
To set the value for this stream only, specify a number Specify.
Specify 0 to reset the value for this stream (the local value) so that the global value from the OPTIONS statement is used instead.
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 can 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.
Note:
When a history file (HISTORY1 or HISTcc1) DD statement with DSNTYPE=LARGE is present in the DUMP JCL, then the history file is allocated with the large format attribute regardless of the PDSNLARGE specification.
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.
Note:
When a history file (HISTORY2 or HISTcc2) DD statement with DSNTYPE=LARGE is present in the DUMP JCL, then the history file is allocated with the large format attribute regardless of the ADSNLARGE specification.
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, which is 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 that is 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. Specify NONE to reset the device name. If PDEVN or PSTORC are not specified, and the DYNAM option is enabled. Then the device name or storage class that is used is taken from the DUMPOPTIONS statement.
Note:
If you are changing the PDEVN operand from one tape unit name to another, 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.
Note:
When a history file (HISTORY1 or HISTcc1) DD statement with the UNIT parameter is present in the DUMP JCL, the UNIT parameter specification overrides the PDEVN option.
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. Specify NONE to reset the storage class. If PDEVN or PSTORC are not specified and the DYNAM option is enabled, the device name or storage class that is used is taken from the DUMPOPTIONS statement.
If using DASD for history files, this operand allocates files only to SMS-managed volumes.
Note:
Some issues can 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 be a temporary history file that is allocated in the JCL. This file indicates the history file size. SMS cannot allow the allocation on the storage class that is indicated in the PSTORC operand and indicates an allocation error for the history file. This error causes the dump process to end prematurely.
To avoid this issue, here are some remedies that you can:
    • Include a data set name on the HISTORY1 or HISTcc1 DD statement. This name can be any valid data set name that would be allocated in the storage class that is indicated in the PSTORC operand.
      Note:
      This remedy is the simplest and we recommend this remedy.
    • To assign no class to temporary data sets, alter the ACS routines in the SMS DASD allocation. Where the fourth node of the name is the same as the dump process JCL job name or procedure name.
      Note:
      These changes are only for DASD history files that are allocated with SMS. Non-DASD and non-SMS allocations are not affected by this option.
PMGMTC(
*
|class|NONE)
'class' is the IBM DFSMS management class to be used when creating SMF history files for this stream in the primary pool. Up to eight characters can be specified. Specify NONE to reset the management class. If PMGMTC is not specified and the DYNAM option is enabled, the management class that is used is taken from the DUMPOPTIONS statement if present.If using DASD for history files, this operand allocates files only to SMS-managed volumes.
Note:
Some issues can 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 be a temporary history file that is allocated in the JCL. This temporary file indicates how large the history file can be. SMS cannot allow the allocation on the storage class that is indicated in the PSTORC operand and indicates an allocation error for the history file. This error causes the dump process to end prematurely.
To avoid this issue, here are some remedies that you can:
  • Include a data set name on the HISTORY1 or HISTcc1 DD statement. This name can be any valid data set name that would be allocated in the management class that is indicated in the PMGMTC operand.
    Note:
    This remedy is the simplest remedy and the one that we recommend.
  • Alter the ACS routines in the SMS DASD allocation. To assign no class to temporary data sets. The fourth node of the name is the same as the dump process JCL job name or procedure name.
    Note:
    These changes are only for DASD history files that are allocated with SMS. Non-DASD and non-SMS allocations are not affected by this remedy.
PDATAC(
*
|class|NONE)
'class' is the IBM DFSMS data class to be used when creating SMF history files for this stream in the primary pool. Up to eight characters can be specified. Specify NONE to reset the data class. If PDATAC is not specified and the DYNAM option is enabled, the management class that is used is taken from the DUMPOPTIONS statement if present. If using DASD for history files, this operand allocates files only to SMS-managed volumes.
Note
: Some issues can 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 be a temporary history file that is allocated in the JCL. This temporary file indicates how large the history file should be. SMS cannot allow the allocation on the storage class that is indicated in the PSTORC operand and indicates an allocation error for the history file, causing the dump process to end prematurely.
To avoid this issue, here are some remedies that you can:
  • Include a data set name on the HISTORY1 or HISTcc1 DD statement. This name can be any valid data set name that would be allocated in the data class that is indicated in the PDATAC operand.
    Note:
    This remedy is the simplest remedy and the one that we recommend.
  • Alter the ACS routines in the SMS DASD allocation to assign no class to temporary data sets. The fourth node of the name is the same as the dump process JCL job name or procedure name.
    Note:
    These changes are only for DASD history files that are allocated with SMS. Non-DASD and non-SMS allocations are not affected by this.
    When a history file (HISTORY1 or HISTcc1) DD statement is coded for the substream, any SMS construct parameters (STORCLAS, MGMTCLAS, or DATACLAS) that are coded in the DD statement or assigned by the operating system as defaults override the PSTORC, PMGMTC, and PDATAC specifications.
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. Specify NONE to reset the device name. If ADEVN or ASTORC are not specified and the DYNAM option is enabled, the device name or storage class that is used is taken from the DUMPOPTIONS statement.
Note
: If you are changing the ADEVN operand from one tape unit name to another, 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. If ADEVN or ASTORC are not specified and the DYNAM option is enabled, the device name or storage class that is used is taken from the DUMPOPTIONS statement.
If using DASD for history files, this operand allocates files only to SMS-managed volumes.
Note:
Some issues can 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 be a temporary history file that is allocated in the JCL. This temporary file indicates how large the history file should be. SMS cannot allow the allocation on the storage class that is indicated in the ASTORC operand and indicates an allocation error for the history file, causing the dump process to end prematurely.
To avoid this issue, here are some remedies that you can use:
    • Include a data set name on the HISTORY2 or HISTcc2 DD statement. This name can be any valid data set name that would be allocated in the storage class that is indicated in the PSTORC operand.
      Note:
      This remedy is the simplest and the one that we recommend.
    • Alter the ACS routines in the SMS DASD allocation to assign no class to temporary data sets. The fourth node of the name is the same as the dump process JCL job name or procedure name.
      Note:
      These changes are only for DASD history files that are allocated with SMS. Non-DASD and non-SMS allocations are not affected by this.
AMGMTC(
*
|class|NONE)
'class' is the IBM DFSMS management class to be used when creating SMF history files for this stream in the alternate pool. Up to eight characters can be specified. Specify NONE to reset the storage class. If AMGMTC is not specified and the DYNAM option is enabled, the management class that is used is taken from the DUMPOPTIONS statement if present. If using DASD for history files, this operand allocates files only to SMS-managed volumes.
Note:
Some issues can 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 be a temporary history file that is allocated in the JCL. This temporary file indicates how large the history file should be. SMS cannot allow the allocation on the storage class that is indicated in the ASTORC operand and indicates an allocation error for the history file, causing the dump process to end prematurely.
To avoid this issue, here are some remedies you can:
  • Include a data set name on the HISTORY1 or HISTcc1 DD statement. This name can be any valid data set name that would be allocated in the management class that is indicated in the AMGMTC operand.
    Note:
    This remedy is the simplest and the one that we recommend.
  • Alter the ACS routines in the SMS DASD allocation to assign no class to temporary data sets. The fourth node of the name is the same as the dump process JCL job name or procedure name.
    Note:
    These changes are only for DASD history files that are allocated with SMS. Non-DASD and non-SMS allocations are not affected by this.
ADATAC(
*
|class|NONE)
'class' is the IBM DFSMS data class to be used when creating SMF history files for this stream in the alternate pool. Up to eight characters can be specified. Specify NONE to reset the data class. If ADATAC is not specified and the DYNAM option is enabled, the management class that is used is taken from the DUMPOPTIONS statement if present. If using DASD for history files, this operand allocates files only to SMS-managed volumes.
Note:
Some issues can 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 be a temporary history file that is allocated in the JCL. This temporary file indicates how large the history file should be. SMS cannot allow the allocation on the storage class that is indicated in the ASTORC operand and indicates an allocation error for the history file, causing the dump process to end prematurely.
To avoid this issue, here are some remedies that you can:
  • Include a data set name on the HISTORY1 or HISTcc1 DD statement. This name can be any valid data set name that would be allocated in the data class that is indicated in the ADATAC operand. 
    Note:
    This remedy is the simplest and the one that we recommend.
  • Alter the ACS routines in the SMS DASD allocation to assign no class to temporary data sets. The fourth node of the name is the same as the dump process JCL job name or procedure name.
    Note:
    These changes are only for DASD history files that are allocated with SMS. Non-DASD and non-SMS allocations are not affected by this.
When a history file (HISTORY2 or HISTcc2) DD statement is coded for the substream, any SMS construct parameters (STORCLAS, MGMTCLAS, or DATACLAS) that are coded in the DD statement or assigned by the operating system as defaults override the ASTORC, AMGMTC, and ADATAC specifications.
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).