SARBCH Control Statements (LISTDEV - PERM)

Control statements have the following general structure:
view122
Control statements have the following general structure:
/
function parameters
  • Code a slash in column 1, followed immediately by the name of the function to be performed.
  • The function name must be followed by one or more blanks and be separated from the parameters.
  • Separate individual parameters by one or more blanks and/or commas.
  • A statement that exceeds 71 characters must be continued on additional statements. When continuing a statement, the statement can be interrupted only between complete parameters or subparameters.
  • Quoted parameters that flow onto additional statements can be continued in column 2 of subsequent statements.
  • Include a comment within the control statements by coding an asterisk in column 1 of the card image containing the comment.
Contents
2
2
LISTDEV
The LISTDEV control statement produces a listing of Device definitions. The listing is written to the REPORT DD statement.
To produce control cards that can be used to add or modify existing Device definitions on DEFDEV statements, code the CTLCARDS DD statement.
Syntax:
/LISTDEV    ID= 
sname
        USER=            TYPE=   
[
Spool
| JES | EXTERNAL | VPO]
Where:
  • ID=sname
    Specifies the 1-12 character synonym name for the device to be listed. A generic device ID can be specified by ending the device ID with an asterisk. If ID is omitted, all devices are listed.
  • USER=
    Specifies 1-8 character name of user who last updated the device definition. A generic user name can be specified by ending the user name with an asterisk. If USER is omitted, all devices matching ID are listed.
  • TYPE=[
    Spool
    | JES | EXTERNAL | VPO]
    Specifies 1-8 character device type
    Spool
    , JES, EXTERNAL, or VPO to be listed. If TYPE is omitted, all devices matching ID/USER are listed.
LISTDYND
The LISTDYND control statement produces a list of the dynamic distribution identifiers for a dynamic report. The report is output to the REPORT DD statement.
Syntax:
/LISTDYND ID=id GEN=nnnnn SEQ=nnnnn UNDEF
Where:
  • ID=id
    Specifies the SYSOUT identifier on the SYSOUT that a listing of distids is desired. This value can be 1 to 32 characters.
    Note:
     If the id contains embedded blanks, commas, parentheses, equal signs, or quotes, it must be enclosed in quotes (single or double). Any quotes in Report-id must be entered as a pair of quotes because a non-paired quote ends the ID. For example, if the value is JIM'S REPORT, it must be entered as 'JIM"s REPORT' or "JIM''s REPORT".
  • GEN=nnnnn
    Specifies the absolute or relative number of generations of the SYSOUT group to be listed.
  • SEQ=nnnnn
    Specifies the absolute or relative sequence number of the SYSOUT group to be listed.
    • If omitted, the most recently archive group for the ID and generation specified is listed.
    • If GEN is omitted and SEQ is specified as a negative number, the SYSOUT relative to the most recently archived SYSOUT is processed.
    • If GEN is omitted and SEQ is specified as a positive number, SEQ number is ignored and the most current SYSOUT is processed.
    Example: SEQ=-1
    The second most recently archive SYSOUT is processed regardless of its generation and sequence number.
    Example: SEQ=-2
    The third most recently archived SYSOUT is processed regardless of its generation and sequence number.
  • UNDEF
    Indicates that the output of the report is to only contain dynamic distribution identifiers that have not been defined to the Deliver database.
LISTFILT
The LISTFILT control statement produces a listing of FILTER definitions. The listing is written to the REPORT DD statement.
To produce control cards that can be used to add or modify existing FILTER definitions on DEFFILT statements, code the CTLCARDS DD statement.
Syntax:
/LISTFILT   ID= 
fname
        USER=   
Where:
  • ID=fname
    Specifies 1-8 character name for the filter to be listed. A generic filter ID can be specified by ending the filter ID with an asterisk. If ID is omitted, all filters are listed.
  • USER=
    Specifies 1-8 character name of user last updating filter. A generic user name can be specified by ending the user name with an asterisk. If USER is omitted, all filters matching ID are listed.
LISTVIEW
The LISTVIEW control statement produces a listing of Logical View definitions. The listing is written to the REPORT DD statement.
To produce control cards that can be used to add or modify existing logical views on DEFVIEW statements, code the CTLCARDS DD statement.
Logical View Listing
The listing of logical view definitions can be for an individual logical view, a group of logical views, or all logical views. In addition, if the CTLCARDS DD is present in the JCL, SARBCH DEFVIEW control statements are created for each view listed in the report. This allows you to clone the logical view definition which can be modified or added in batch. See the DEFVIEW statement for an explanation of the output format.
The following Logical View listing is generated by the LIST control statement:
11/10/2013 09:57:51 CA View Output Archival and Viewing (nn.n) Page 1 SARBCT Batch Processing Utility - Logical view Listing View Id Num Acc Userid Filter Description -------------------------------- --- --- -------- -------- ---------------------------------------- TESTVIEW1 001 PUB LOGICAL VIEW NUMBER 1 TESTVIEW2 001 PUB NBLK LOGICAL VIEW NUMBER 2 TESTVIEW9 001 PUB LOGICAL VIEW NUMBER 9
The following DEFVIEW statement is generated by the LISTVIEW control statement:
/DEFVIEW VIEW='TESTVIEW1'                                     NUM=1   USER=                                                FILTER=         SECURED=N                                    DESC='LOGICAL VIEW NUMBER 1                   '              DEFAULT=N LOCKLEFT=N DISPCC=Y                                EXCPAGES=1   EXCRECS=3   DISPRECS=                           ACL1=G AHL1=  ACL2=R AHL2=  ALINES=1                         HSCROLL=N                                                    HEADING=(('TEST PRIMARY HEADING',W,B))                       HED1=1   HED2=2   HED3=3   HED4=4   HED5=5   HED6=6          CLR1=R   CLR2=P   CLR3=G   CLR4=Y   CLR5=W   CLR6=T          HLT1=    HLT2=B   HLT3=    HLT4=U   HLT5=R   HLT6=           COLUMN=((1  ,10 , , , ),                                             (20 ,15 , , , ),                                             (50 ,8  , , , ))                                     CRINDEX=Y                                                    SEARCH=((1    ,     ,25     ,       ,EQ,                               'CHECK NUMBER'                            ,M,!),            (!+1  ,     ,!+1    ,       ,EQ,                              'REFERENCE'                               ,M,@),            (@+2  ,     ,@+2    ,       ,EQ,                              'TESTING'                                 ,M,#))    INDEX=((CHECK   ,!+0  ,!+13   ,8    ,ALL  ,YES,YES),                (REF-NO  ,@+0  ,@+11   ,9    ,ALL  ,NO ,YES),                (TEST    ,#+1  ,#+0    ,5    ,ALL  ,NO ,NO ),                (PAGE    ,1    ,130    ,3    ,ALL  ,NO ,YES),                (TRANDATE,2    ,1      ,8    ,ALL  ,NO ,YES),                (DIVISION,2    ,85     ,3    ,NBLK ,YES,YES))               
Syntax:
/LISTVIEW VIEW=vname NUM=vnum USER=userid FILTER=filter
  • VIEW=vname
    Specifies the name of the Logical View ID to be listed.
    The value can be 1 to 32 characters.
    A generic ID can be specified by appending an asterisk to the generic ID. If omitted, all Logical Views are listed.
    You cannot specify this parameter with the USER or ID parameter.
    Note
    : If the View id contains embedded blanks, commas, equal signs, parentheses, or quotes, it must be enclosed in quotes (single or double). Enter any quotes in the Report-id as a pair of quotes because a non-paired quote ends the ID. For example, if the value is JIM’S REPORT, enter it as ‘JIM’’S REPORT’ or "JIM’S REPORT".
  • NUM=vnum
    Specifies that only a specific view number is listed. If left blank or omitted, public and private views are listed.
  • USER=userid
    Specifies that only private views for this userid are to be listed. If left blank or omitted, public and private views are listed.
  • FILTER=filter
    Specifies 1 to 8 character filter name. A generic filter name can be specified by ending the filter name with an asterisk. Only logical views with matching filter names are listed.
LOAD
The LOAD control statement loads an archived SYSOUT group from disk or from tape to disk. The SYSOUT is either temporarily loaded to the
View
database or loaded to a user-defined data set.
If you use the expanded access server for tape and robotics, and the server becomes inactive when a report is selected online,
View
LOADs the report to disk. The report can then viewed without the server.
We recommend that LOAD jobs execute on the system with the TYPE=PRIMARY server. This method prevents all the data from having to be transmitted across systems using XCF or LSERV.
The following table indicates the destination of the SYSOUT group:
If the DDname parameter is
And if a SARLOAD DD statement is
Then the Product
Specified
Specified or not specified
Loads the SYSOUT group to the data set named with the ddname.
Not specified
Specified
Loads the SYSOUT group to the SARLOAD data set.
Not specified
Not specified
Temporarily loads the SYSOUT group to the
View
database, and you can view it online.
The SYSOUT is automatically be deleted by the backup cycle using the HOLDTEMP initialization parameter.
Syntax:
The syntax of the control statement is:
/LOAD  DDNAME=
xxxxxxxx
   GEN=
nnnnn
   ID=
id
RESOURCE=
xxx
   INDEX SEQ=
nnnnn
   TAPE
where:
  • DDNAME=xxxxxxxx
    Specifies the DD statement name to which the SYSOUT group is loaded.
    This parameter overrides the SARLOAD DD statement, if it is specified. If DCB attributes for the DD statement are omitted, the following are used:
    • A record format of VBM
    • A record size of the SYSOUT group record size plus four
    • A block size of 32760
  • GEN=nnnnn
    Specifies the absolute or relative number of the generation for which SYSOUT is loaded to disk.
    If omitted, the most recently archived SYSOUT group for the ID loaded to disk.
  • ID=id
    Specifies the SYSOUT identifier on the SYSOUT or the resource group to be loaded.
    This value can be 1 to 32 characters. This parameter is required.
    The SARTDR utility can also be used to reload an AFP resource to DISK.
    Note: If the id contains embedded blanks, commas, equal signs, parentheses, or quotes, it must be enclosed in quotes (single or double). Any quotes in Report-id must be entered as a pair of quotes because a non-paired quote ends the ID. For example, if the value is JIM’S REPORT, it must be entered as ‘JIM’’S REPORT’ or "JIM’S REPORT".
  • INDEX
    Specifies to LOAD any page indexes defined for the report to the disk database.
    Page indexes on disk are used by the
    View
    online cross report indexing capability. (The DDname parameter does not apply to page indexes.)
  • RESOURCE=
    Specifies the name of an AFP RESOURCE rather than a Report ID.
    Do not specify ID= when using the RESOURCE parameter.
    This parameter allows an AFP resource to be deleted. This type of control statement is generated through SARTSLST.
  • SEQ=nnnnn
    Specifies the absolute or relative sequence number of the SYSOUT group to be loaded to disk.
    • If omitted, the most recently archived group for the ID and generation specified is loaded to disk.
    • If GEN is omitted and SEQ is specified as a negative relative number, the SYSOUT relative to the most recently archived SYSOUT is processed.
    • If GEN is omitted and SEQ is specified as a positive number, SEQ number is ignored and the most current SYSOUT is processed.
    • EX: SEQ=-1
      The second most recently archived SYSOUT is processed regardless of its generation and sequence number.
    • EX: SEQ=-2
      The third most recently archived SYSOUT is processed regardless of its generation and sequence number.
  • TAPE
    Specifies to LOAD only from tape.
    This parameter can be used to bypass LOADing from optical disk.
PERM
The PERM control statement sets a SYSOUT group to permanent status (can be used for long term archiving) or removes it from permanent status.
When the SYSOUT group is set to permanent status, its period of retention and its location are dependent on the Expanded Retention Option initialization parameters and table statements. These parameters and statements are processed during the
View
started task backup cycle.
When the SYSOUT group is removed from permanent status, it no longer resides under the control of the Expanded Retention Option.
Note:
 Setting a SYSOUT to PERM when the ERO Initialization Option (EROOPT) is NO, causes the following:
  • All retention values (NGEND and/or NGENT) are ignored
  • The report stays permanent on the database
If the SYSOUT was on disk when it was set to PERM, the SYSOUT remains on disk indefinitely. If the SYSOUT was only on tape, it remains on tape indefinitely.
Syntax:
/PERM  DELETE        DISK        GEN=
nnnnn
       ID=
id
       SEQ=
nnnnn
       TAPE
where:
  • DELETE
    Specifies that the SYSOUT group is to be removed from permanent status.
  • DISK
    Specifies that the SYSOUT group is to be set to a permanent "on disk" status.
    When this keyword is specified, the SYSOUT group must currently reside in a disk or temporary disk status. This parameter cannot be specified with the DELETE and TAPE keywords. If the DELETE, DISK, and TAPE keywords are omitted, DISK is the default.
  • GEN=nnnnn
    Specifies the absolute or relative number of the generation of the SYSOUT group to be set to permanent status or removed from permanent status.
  • ID=id
    Specifies the SYSOUT ID of the SYSOUT group to be set to permanent status or removed from permanent status.
    The value can be 1 to 32 characters.
    Note: If the id contains embedded blanks, commas, equal signs, parentheses, or quotes, it must be enclosed in quotes (single or double). Any quotes in Report-id must be entered as a pair of quotes because a non-paired quote ends the ID. For example, if the value is JIM’S REPORT, it must be entered as ‘JIM’’S REPORT’ or "JIM’S REPORT".
  • SEQ=nnnnn
    Specifies the absolute or relative SYSOUT sequence number of the SYSOUT group to be set to permanent status or removed from that status.
    • If GEN is omitted and SEQ is specified as a negative relative number, the SYSOUT relative to the most recently archived SYSOUT is processed.
    • If GEN is omitted and SEQ is specified as a positive number, SEQ number is ignored and the most current SYSOUT is processed.
    • EX: SEQ=-1
      The second most recently archived SYSOUT is processed regardless of its generation and sequence number.
    • EX: SEQ=-2
      The third most recently archived SYSOUT is processed regardless of its generation and sequence number.
  • TAPE
    Specifies that the SYSOUT group is to be set to a permanent on tape status.
    This parameter cannot be specified with the DELETE and DISK keywords.