SARBCH Control Statements (ADDJOB - DEFVIEW)

Control statements have the following general structure:
view
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
ADDJOB
  • The ADDJOB control statement creates control records that let users use JOB mode to access reports that were archived before JOB mode existed.
  • If the sysout dataset list contains 5 or fewer DD statements, the job records are created automatically.
  • If the sysout dataset list contains more than 5 DD statements and resides on tape, load the sysout index to disk before you enter the ADDJOB command. Statements are generated in the CTLCARDS DD to load the sysout index to disk.
  • JOB mode records are created only for jobs that contain reports that were processed by SARSTC, SARFSS text collector, SARXTD, or SARDBB.
  • JOB mode records are not created for jobs that contain binary, AFP, PDF, Xerox, or
    Deliver
    reports.
  • Some older database report control records may not contain dataset list information. These reports are not eligible for JOB mode processing and are bypassed.
Running ADDJOB creates index records, which requires sufficient free space in the
View
database. For example, adding 100,000 jobs via ADDJOB requires approximately 36,000 data blocks (400 cylinders) free in the master index.
Carefully monitor your database index utilization by using SARDBASE STATUS or the online ST command. 
Important! If your database index fills up while ADDJOB is running, the job terminates with RC=16. In addition to the job terminating, these events occur:
  • The following message appears: SARDBI07 No more index file space in database
  • Other archiving tasks (for example, SARSTC, SARFSS, and archival from
    Deliver
    ) are interrupted.
To avoid filling your index, consider using the ADDJOB parameters, including wildcard characters, to limit the number of jobs in a run.
If necessary, use SARDBASE ADDDS to add additional space to your database index and data areas.
  • Depending on the number of reports being scanned and the number of job records being created, ADDJOB may take a long time to complete and may generate a high amount of I/O’s. 
    Running ADDJOB with no parameters creates JOB mode records for all eligible reports on the database. 
    Omitting the ID parameter causes ADDJOB to read through all of the report index records in the database.
    For large databases, consider running ADDJOB in off hours when it does not conflict with online activity or backup cycle processing.
/ADDJOB JOBNAME=jobname DATE=mm/dd/yyyy | mm/dd/yyyy:mm/dd/yyyy GEN=number SEQ=number ID=id REDO
where:
  • JOBNAME=
    jobname
    Specifies the 1-8 character job name.
    To specify a generic job name, specify the jobname prefix, followed by an asterisk, for example, pay* or bld*.
  • DATE=
    mm/dd/yyyy | mm/dd/yyyy:mm/dd/yyyy
    Specifies either the date or the range of dates when the job was submitted.
    In a date range, use a colon (:) to separate the start and end dates.
  • Gen=
    number
    Specifies the generation number (1-65535) for the sysout.
  • Seq=number
    Specifies the sequence number (1-65535) for the sysout.
  • ID=
    id
    Specifies the specific or generic sysout id (1 to 32 characters).
    Default: blank (all sysouts)
  • REDO
    Re-creates the JOB mode data.
If you version a database back to
View
12.1 or earlier, the JOB mode data is removed. If you version the same database up to
View
12.2 or later again, to re-add JOB mode data, use the REDO command.
BPRINT
The BPRINT control statement reprints a
Deliver
bundle that is archived to the
View
database.
Syntax:
/BPRINT  BANNER=(
bundle-banner
,
dist-banner
,
report-banner
)          BCONT=(
dist-id
,((
report-id
,
gen,seq
),…),…)          BDIST=
dist-id
         BID=
bundle-id
where:
  • BANNER=(bundle-banner,dist-banner,report-banner)
    Specifies the model banner page names of the bundle, distribution, and report banner pages.
    The model banner page name can be omitted. If omitted, the model banner page name defined to the bundle in the
    Deliver
    database is used. An asterisk suppresses the printing of the model banner page.
    This parameter is optional.
  • BCONT=(dist-id,((report-id,gen,seq),…),…)
    Specifies the distribution identifiers and archived reports that comprise the bundle.
    • The bundle print is produced in the exact sequence as specified in this parameter.
    • One or more distribution identifiers can be specified, each followed by a complete list of report identifiers, generation number, and sequence number.
    • The generation number and sequence number can be specified as an absolute or a relative number.
    If a report in the bundle being reprinted utilizes the ARCHID alternate report name in the
    Deliver
    definition, specify this name for the report-id field.
    • If omitted, the most recently archived report is used.
    • This parameter is required.
    Note:
    If report-id or dist-id contains an embedded blank, parentheses, quotes, equal signs, or commas, it must be enclosed in single quotes.
  • BDIST=x
    Specifies the distribution identifier from which the distribution banner-page instructions are to be taken.
    If omitted, the bundle distribution identifier defined to the bundle in the
    Deliver
    database is used. If the bundle distribution identifier in the
    Deliver
    database is omitted, the first identifier defined in the BCONT parameter is used.
  • BID=bundle-id
    Specifies the name of the bundle to be printed.
    This parameter is required.
Note:
You can use the
View
OUTLIM initialization parameter to limit the number of printed lines.
CHANGE
The CHANGE control statement changes various attributes of a SYSOUT group, including the archival date, that has already been archived to the
View
database.
You can use this statement if a SYSOUT was archived with inappropriate print attributes, or if the tape it was backed up to has been destroyed, and its internal status must be changed to NOT BACKED UP.
You can modify the following attributes with SARBCH CHANGE:
  • All PRINT attributes
  • BACKUP
    Specifies whether the SYSOUT has been backed up to tape from disk.
  • USERDATA
    Contains a 20-byte user data field, typically accounting data.
  • USERFLD
    Contains any user comments to be displayed with the SYSOUT in the
    View
    selection lists.
Syntax:
/CHANGE ADDRESS=('
text
'…)         ARCHDATE=
mm/dd/yyyy
ARCHTIME
=hh:mm:ss
        BACKUP=OFF         BUILDING='
text
'         BURST=Y|N         CHARS=(
xxxx xxxx xxxx xxxx
)         CKPTLINE=
nnnnn
        CKPTPAGE=
nnnnn
        CKPTSEC=
nnnnn
        CLASS=
x
        COLORMAP=
xxxxxxxx
        COMPACT=
xxxxxxxx
        COMSETUP=
xxxxxxxx
        CONTROL=PROGRAM|SINGLE|DOUBLE|TRIPLE         COPIES=
nnn
        COPYG=(
nnn nnn nnn nnn nnn nnn nnn nnn
)         DATACK=BLOCK|UNBLOCK|BLKCHAR|BLKPOS         DEPT='
text
'         DEST=
dest.userid
        DPAGELBL=Y|N         DSK2VID=
nnn
        DUPLEX=NO|NORMAL|TUMBLE         FCB=
xxxx
        FLASH=(
xxxx nnn
)         FORM=
xxxxxxxx
        FORMDEF=
xxxxxx
        FORMLEN=
nn
[.
mmm
]IN|CM         FSSDATA='
data
'         GEN=
nnnnn
        ID=
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
        INTRAY=
nnn
        IPDEST=
ipdest
        LINECT=
nnn
        MODIFY=(
xxxx n
)         NAME='
text
'         NOTIFY=(
node.userid
 …)         OFFSETXB=
mmm
[.
nnn
]IN|CM|MM|PELS|POINTS         OFFSETXF=
mmm
[.
nnn
]IN|CM|MM|PELS|POINTS         OFFSETYB=
mmm
[.
nnn
]IN|CM|MM|PELS|POINTS         OFFSETYF=
mmm
[.
nnn
]IN|CM|MM|PELS|POINTS         OPTCDJ=Y|N         OUTBIN=
nnnnn
        OUTDISP=(ndisp,adisp) OVERLAYB=
xxxxxxxx
OVERLAYF=
xxxxxxxx
        OWNER=
userid
        PAGEDEF=
xxxxxx
        PGMRNAME=
name
        PIMSG=(Y|N,
nnn
)         PORTNO=
nnnnn
        PRMODE=
xxxxxxxx
        PRTERROR=DEFAULT|QUIT|HOLD         PRTOPTNS=
xxxxxxxxxxxxxxxx
        PRTQUEUE='
queue
'         PRTY=
nnn
        RESFMT=P240|P300         RESOURCE=
xxxxxx
        RETAINF=
hhhh:mm:ss
|FOREVER         RETAINS=
hhhh:mm:ss
|FOREVER         RETRYL=
nnn
        RETRYT=
hhhh:mm:ss
        ROOM='
text
'         SEQ=
nnnnn
        SYSAREA=Y|N         TAPECNT=
nnnnn
        TITLE='
text
'         UCS=
xxxx
        USERDATA=('
text
' …)         USERFLD='
text
'         USERINFO='
data
'         USERLIB=(
lib
 …)         WRITER=
xxxxxxxx
where:
  • ADDRESS=('text' …)
    Specifies deliver address lines for the SYSOUT You can specify one to four deliver address lines containing up to 60 text characters separated by blanks and/or commas and enclosed in parentheses.
  • ARCHDATE=mm/dd/yyyy
    Specifies the new archival date of the report.
    Note:
    • The report must be on 'disk' before the /CHANGE statement can be used. The report can be recently archived, retained, or reloaded to disk. The /CHANGE ARCHDATE function sets the report to 'Backup=Off' and the report is backed up during the next backup cycle.
    • The archival time can be specified with ARCHTIME. If ARCHTIME is not specified, the value defaults to twelve noon (12:00:00) to help identify archival date changes
    • If ARCHCHG baseyear is not specified, the sequencing of reports within a generation may not be ordered correctly.
    • If daily backup cycles are not run, a database generation can span multiple days. Reports within a database generation are assigned a sequential number beginning with 'one'. If a specific database generation has three daily reports numbered 1, 2, and 3, and a report is back-dated to the same date as sequence 2, but lower than sequence 3, the report appears in the SYSOUT Selection List behind report sequence 3. This happens because the existing reports cannot be re-sequenced.
    • Annotations and Book Mark are re-sequenced with the report's generation and sequence numbers.
    • Review report retention parameters prior to back-dating a report. Because it is possible that the age and generation of the report are beyond the control of the existing ERO or NGEND/NGENT settings, the report can be deleted during the next backup cycle. If using ERO, the parameters for the report are reset as part of the process. Set the EROPRO Initialization Parameter to YES so that back-dated reports are always evaluated for ERO Retention.
    • If using the SARINIT ARCHCHG=baseyear initialization parameter, the date specified in ARCHDATE must not precede the value specified for baseyear.
    A Subtype 35 (Archival Date Change) Metric SMF Record is created if the SMFTYPE Initialization Parameter is set to a valid SMF Record Type which enabled the Metrics Feature. This SMF record can be used as an Audit Trail to determine if report dates have been modified.
  • ARCHTIME =hh:mm:ss
    Specifies the new archival time of the report.
    Note:
    • The report must be on 'disk' before the /CHANGE statement can be used. The report can be recently archived, retained, or reloaded to disk. The /CHANGE ARCHDATE function sets the report to 'Backup=Off', and the report is backed up during the next backup cycle.
    • If ARCHTIME is not specified, the ARCHTIME defaults to twelve noon (12:00:00) to help identify archival date changes.
    • If using the SARINIT ARCHCHG=baseyear initialization parameter and if ARCHDATE is the current date, the time specified in ARCHTIME must not be greater than the current time.
  • BACKUP=OFF
    Specifies that the backup indicator for the SYSOUT is to be turned off.
    The indicator is turned on when a SYSOUT is backed up. If a SYSOUT is backed up to tape, and that tape is lost or destroyed, you must specify BACKUP=OFF, to cause the
    View
    backup cycle to back up the SYSOUT again.
  • BUILDING='text'
    Specifies the building identification for the SYSOUT.
    You can specify up to 60 text characters for building identification.
  • BURST=Y|N
    Specifies whether the paper is to be burst on the 3800 printer when printed.
  • CHARS=(xxxx xxxx xxxx xxxx)
    Specifies a set of character arrangement table names for the 3800 printer for the SYSOUT.
    You can specify a value of one to four names separated by one or more blanks and/or commas and enclosed in parentheses.
  • CKPTLINE=nnnnn
    Specifies the maximum lines in a logical page. You can specify a range of 0 to 32767.
  • CKPTPAGE=nnnnn
    Specifies the number of logical pages before JES checkpoints data. You can specify a range of 1 to 32767.
  • CKPTSEC=Nnnnn
    Specifies the number of seconds before JES checkpoints data. You can specify a range of 1 to 32767.
  • CLASS=x
    Specifies a class for the SYSOUT.
  • COLORMAP=xxxxxxxx
    Specifies the color translation resource object.
  • COMPACT=Xxxxxxxx
    Specifies the compaction table for sending SYSOUT to SNA terminal.
  • COMSETUP=xxxxxxxx
    Specifies the microfiche setup resource.
  • CONTROL=value
    Specifies line spacing.
    Valid values are:
    • PROGRAM
      Each logical record contains a carriage control character.
    • SINGLE
      Single spacing
    • DOUBLE
      Double spacing
    • TRIPLE
      Triple spacing
  • COPIES=nnn
    Specifies a number of copies to override the one used to print the SYSOUT. A range of 1 to 255 can be specified.
  • COPYG=(nnn nnn nnn nnn nnn nnn nnn nnn)
    Specifies an optional set of copy groups for the 3800 printer to override those used to print the SYSOUT.
    You can specify a range of one to eight copy groups separated by one or more blanks and/or commas and enclosed in parentheses. Each copy group value must be in the range of 1 to 255.
  • DATACK=value
    Specifies how printer errors are to be handled.
    Valid values are:
    • BLOCK
      Indicates errors are not reported.
    • UNBLOCK
      Indicates errors are reported.
    • BLKCHAR
      Indicates print errors are blocked.
    • BLKPOS
      Indicates data errors are blocked.
  • DEPT='text'
    Indicates department identification for the SYSOUT. You can specify up to 60 text characters for department identification.
  • DEST=dest.userid
    Specifies an optional destination and an optional user ID to override the one used to print the SYSOUT.
    You can specify up to eight characters for destination and up to eight characters for the user ID. The destination can be a synonym created using the online DEFine DEVice command.
  • DPAGELBL=Y|N
    Specifies whether a security label is to be output.
  • DSK2VID=nnn
    Specifies the secondary disk version number. A range of 0 to 255 can be specified.
  • DUPLEX=value
    Specifies whether the report is printed on one or both sides of paper.
    Valid values are:
    • NO
      Prints on one side only.
    • NORMAL
      Rotates the physical page about the Y axis, which allows for binding the long side of the sheet.
    • TUMBLE
      Rotates the physical page about the X axis, which allows for binding the short side of the sheet.
  • FCB=xxxx
    Specifies an optional forms control image to override the one used to print the SYSOUT.
  • FLASH=(xxxx nnn)
    Specifies an optional forms flash overlay name and flash count for the 3800 printer to override those used to print the SYSOUT.
    The forms flash overlay name and copy count are separated by one or more blanks and/or commas and are enclosed in parentheses.
  • FORM=xxxxxxxx
    Specifies an optional forms name to override the one used to print the SYSOUT.
  • FORMDEF=Xxxxxx
    Specifies a library member containing statements to control printing of the SYSOUT data on the 3800 printer
    The statements can specify overlay forms, page location for overlays, and page format suppressions that can be activated.
  • FORMLEN=nn[.mmm]IN|CM
    Specifies the length and unit of measurement of the form.
  • FSSDATA='data'
    Specifies Functional Subsystem data. You can specify up to 127 characters for functional subsystem data.
  • GEN=nnnnn
    Specifies the absolute or relative number of the generation for which SYSOUT is affected by the CHANGE statement. If omitted, the most recently archived SYSOUT group for the ID is affected.
  • ID=id
    Specifies the SYSOUT ID of the group to be affected by the CHANGE statement.
    You can specify 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".
    This parameter is required.
  • INTRAY=nnn
    Specifies the printer input tray. A range of 1 to 255 can be specified.
  • IPDEST=ipdest
    Specifies the TCP/IP routing designation. You can specify up to 124 characters of TCP/IP routing information.
  • LINECT=nnn
    Specifies the maximum number of lines to be printed on each output page.
  • MODIFY=(xxxx n)
    Specifies an optional copy modification module name and table reference character for the 3800 printer to override those used to print the SYSOUT.
    The copy modification module name and table reference character are separated by one or more blanks and/or commas and are enclosed in parentheses. The table reference character can have a range of 0 to 3.
  • NAME='text'
    Specifies the name to print on output separator pages. You can specify up to 60 text characters for the name.
  • NOTIFY=(node.userid …)
    Specifies a print notification message destination. You can specify up to four destinations for the print notification message.
  • OFFSETXB=mmm[.nnn]IN|CM|MM|PELS|POINTS
    Specifies an X offset of logical page origin for the back side of paper.
  • OFFSETXF=mmm[.nnn]IN|CM|MM|PELS|POINTS
    Specifies an X offset of logical page origin for the front side of paper.
  • OFFSETYB=mmm[.nnn]IN|CM|MM|PELS|POINTS
    Specifies a Y offset of logical page origin for the back side of paper.
  • OFFSETYF=mmm[.nnn]IN|CM|MM|PELS|POINTS
    Specifies a Y offset of logical page origin for the front side of paper.
  • OPTCDJ=Y|N
    Specifies an optional override as to whether the SYSOUT records contain table reference characters for the 3800 printer. Valid values are Y or N.
  • OUTBIN=nnnnn
    Specifies output bin ID. You can specify a range of 1 to 65535.
  • OUTDISP=(ndisp,adisp)
    Specifies the normal and abnormal output disposition.
    Valid values are:
    • HOLD
      Indicates SYSOUT is not printed until it is released.
    • KEEP
      Indicates SYSOUT is printed but not immediately purged.
    • LEAVE
      Indicates SYSOUT is not printed until it is released and not immediately purged once it is printed.
    • PURGE
      Indicates SYSOUT is deleted without printing.
    • WRITE
      Indicates SYSOUT is printed and purged.
  • OVERLAYB=xxxxxxxx
    Specifies medium overlay for the back side of paper.
  • OVERLAYF=xxxxxxxx
    Specifies medium overlay for the front side of paper.
  • OWNER=userid
    Specifies the user ID that created the report.
  • PAGEDEF=xxxxxx
    Specifies a library member containing statements to control printing of the SYSOUT data on the 3800 printer.
    The statements can specify logical page length, width, fonts, and page segments.
  • PGMRNAME=name
    Specifies the programmer name.
  • PIMSG=(Y|N,nnn)
    Specifies whether messages from a functional subsystem are to be printed and the message threshold at which the system is to cancel printing.
  • PORTNO=nnnnn
    Specifies TCP port number at which FSS connects to the printer. A range of 1 to 65535 can be specified.
  • PRMODE=xxxxxxxx
    Specifies the process mode required for printing the SYSOUT group.
  • PRTERROR=value
    Specifies an action for print error.
    Valid values are:
    • DEFAULT
      Indicates a standard action is taken when a terminating error occurs during printing
    • QUIT
      Indicates the SYSOUT is released when a terminating error occurs during printing
    • HOLD
      Indicates the SYSOUT is placed in held status when a terminating error occurs during printing
  • PRTOPTNS=xxxxxxxxxxxxxxxx
    Specifies named entity of print options for FSS.
  • PRTQUEUE='queue'
    Specifies a target print queue for FSS. You can specify up to 127 characters for print queue.
  • RESFMT=P240|P300
    Specifies the resolution used to format the print.
    Valid values are:
    P240
    Indicates 240 pels per inch resolution
  • P300
    Indicates 300 pels per inch resolution
  • RESOURCE=
    Specifies the name of an AFP RESOURCE rather than a Report ID.
    Do not specify ID= when using the RESOURCE parameter.
    This parameter along with the BACKUP=OFF parameter allow an AFP resource to be recreated on tape. This type of control statement is generated through SARTSLST.
  • RETAINF=hhhh:mm:ss|FOREVER
    Specifies the failed transmission retain time.
  • RETAINS=hhhh:mm:ss|FOREVER
    Specifies the successful transmission retain time
  • RETRYL=nnn
    Specifies the maximum number of transmission retries
  • RETRYT=hhhh:mm:ss
    Specifies the length of time to wait between retries
  • ROOM='text'
    Specifies a room identification. You can specify up to 60 text characters for room identification.
    • SEQ=nnnnn
      Specifies the absolute or relative SYSOUT sequence number of the SYSOUT group to be affected by the CHANGE statement
      • If omitted, the most recently archived SYSOUT group for the ID and generation specified is affected.
      • 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.
  • SYSAREA=Y|N
    Specifies whether the system is to reserve a system area on each page of output
  • TAPECNT=nnnn
    Specifies the number of tapes that the SYSOUT resides on. A range of 1 to 9999 can be specified.
  • TITLE='text'
  • Specifies a title identification. You can specify up to 60 text characters for title identification.
  • UCS=xxxx
    Specifies an optional special character set name to override the one used to print the SYSOUT
  • USERDATA=('text' …)
    Specifies user data for the SYSOUT
    You can specify 1 to 16 user data lines containing up to 60 text characters separated by blanks and/or commas and enclosed in parentheses.
  • USERFLD='text
    Specifies user comments to be displayed with this SYSOUT on the
    View
    selection lists
    To include any spaces within the comment, enclose the entire comment in quotes, as in USERFLD='THIS IS MY COMMENT'.
  • USERINFO='data'
    Specifies up to 20 characters of user information (typically accounting data)
  • USERLIB=(lib …)
    Specifies up to eight libraries containing APF resources
  • WRITER=xxxxxxxx
    Specifies an external writer name.
    Default:
If you specify a parameter without a value, that parameter is set to blanks. For example, if you specify the following, the PAGEDEF field is set to blanks:
PAGEDEF=
DBASE
The DBASE control statement is used to specify the high-level name of the
View
database. If omitted, the high-level name specified as the PARM parameter on the EXEC JCL statement, if any, is used. The DBASE control statement applies to all control statements that follow it until another DBASE control statement is encountered.
Syntax:
/DBASE NAME=
xxxxxxxxxxxx
xxxxx
where
xxxxxxxxxxxxxxxx
specifies the high-level name for the
View
database.
DEFDEV
The DEFDEV control statement creates or modifies a DEVICE. The syntax for DEFDEV is dependent on the type of device being defined.
The following types of devices are supported:
  • Spool
  • JES
  • EXTERNAL
  • VPO
DEFDEV TYPE=
Spool
Syntax:
/DEFDEV     ID= 
sname
        TYPE=   
Spool
        CNODE=  
nodename
        CSUBID= 
subid
        CEXIT=  
exitname
        CAUTODEL=Y|N             COUTLIM=    
nnnnnnnn
        CRETAIN=    
nnnn
        CSYSOUT=Y|N          CSARCLS=Y|N          CSARCOPY=Y|N             CSARFCB=Y|N          CSARFORM=Y|N             CSARHOLD=Y|N             CCLASS= 
c
        CCOPIES=    
nnn
        CFCB=   
cccc
        CFORM=  
cccc
        CHOLD=Y|N   
Where:
  • ID=sname
    Specifies the 1-12 character name for this device synonym.
  • TYPE=
    Spool
    Specifies the type of device being defined. Possible values are
    Spool
    , JES, EXTERNAL, and VPO.
  • CNODE=nodename
    Specifies the 1-8 characters
    Spool
    node name.
  • CSUBID=subid
    Specifies the 1-4 characters
    Spool
    subsystem name.
  • CEXIT=exitname
    Specifies the 1-8 characters user exit name.
  • CAUTODEL=Y|N
    Specifies whether to purge a file if it is empty when closed.
  • COUTLIM=nnnnnnnn
    Optionally, specifies the maximum number of lines which can be printed (1 to 16,777,215). This overrides the CMAMAX SARINIT parameter.
  • CRETAIN=nnnn
    specifies Optionally, the maximum number of hours
    Spool
    retains the file after printing. (1 to 4095).
  • CSYSOUT=Y|N
    Specifies whether to use the
    View
    SYSOUT id as the
    Spool
    filename.
  • CSARCLS=Y|N
    Specifies whether to use the CLASS specified on the
    View
    Print Attributes Panel.
  • CSARCOPY=Y|N
    Specifies whether to use the COPIES count specified on the
    View
    Print Attributes Panel.
  • CSARFCB=Y|N
    Specifies whether to use the FCB specified on the
    View
    Print Attributes Panel.
  • CSARFORM=Y|N
    Specifies whether to use the FORM specified on the
    View
    Print Attributes Panel.
  • CSARHOLD=Y|N
    Specifies whether to use the HOLD option specified on the
    View
    Print Attributes Panel.
  • CCLASS=c
    Specifies 1 character output print class.
  • CCOPIES=nnn
    Specifies the number of copies (1 to 255).
  • CFCB=cccc
    Specifies the 1-4 character FCB name.
  • CFORM=cccc
    Specifies the 1-4 character FORM name.
  • CHOLD=Y|N
    Specifies whether to place the file in hold status.
DEFDEV TYPE=JES
Syntax:
/DEFDEV     ID= 
sname
        TYPE=   
JES
        JDEST=  
destname
        JBANNER=Y|N          JCONNECT=Y|N             JRESONLY=Y|N             JDATONLY=Y|N    
Where:
  • ID=sname
    Specifies the 1-12 character name for this device synonym.
  • TYPE=JES
    Specifies the type of device being defined. Possible values are
    Spool
    , JES, EXTERNAL, and VPO.
  • JDEST=destname
    Specifies the 1-17 characters JES destination name (for example, "CPU2.RMT1").
  • JBANNER=Y|N
    Specifies whether to print the banner pages to this device.
  • JCONNECT=Y|N
    Specifies whether to print the banner pages to this device.
  • JRESONLY=Y|N
    Specifies whether to send only the AFP resources to a
    Connect
    node for the unattended download. YES inhibits banners (JBANNER=N) and forces the destination to
    Connect
    (JCONNECT=Y).
    (
    Connect
    is YES).
  • JDATONLY=Y|N
    Specifies whether to send only the AFP data to a
    Connect
    node for the unattended download. YES inhibits banners (JBANNER=N) and forces the destination to
    Connect
    (JCONNECT=Y).
DEFDEV TYPE=EXTERNAL
Syntax:
/DEFDEV     ID= 
sname
        TYPE=   
EXTERNAL
        EXTPRT= 
External Print Parameter
Where:
  • ID=sname
    Specifies the 1-12 character name for this device synonym.
  • TYPE=EXTERNAL
    Specifies the type of device being defined. Possible values are
    Spool
    , JES, EXTERNAL, and VPO.
  • EXTPRT=External Print Parameter
    Information to identify the appropriate EXTPRTn SARINIT initialization parameter along with the replacement attributes for the initialization parameter attributes.
    The format of the information is:
    >pid.attrs
    Where:
    • pid is the 3-character printer identifier that is used to identify the EXTPARMn initialization parameter.
    • attrs specifies one or more replacement attributes, separated by periods (.)
DEFDEV TYPE=VPO
Syntax:
/DEFDEV     ID= 
sname
        TYPE=   
VPO
        VNODE=  
nodename
        VEXIT=e 
xitname
        VLOGMODE=   
logmode
        VOUTLIM=    
nnnnnnnn
        VAUTONL=Y|N          VDRIVER=    
drivername
Where:
  • ID=sname
    Specifies the 1-12 character name for this device synonym.
  • TYPE=VPO
    Specifies the type of device being defined. Possible values are
    Spool
    , JES, EXTERNAL, and VPO.
  • VNODE=nodename
    Specifies the 1-17 characters node name.
  • VEXIT=exitname
    Specifies the 1-8 characters user exit name.
  • VLOGMODE=logmode
    Specifies the 1-8 characters VTAM LOGMODE name.
  • VOUTLIM=nnnnnnnn
    Optionally, specifies the maximum number of lines which can be printed (1 to 16,777,215). This overrides the VPRTMAXO SARINIT parameter.
  • VAUTONL=Y|N
    Specifies whether to add a new-line command at the end of lines which are 132 characters long.
  • VDRIVER=drivername
    Specifies 1-8 character device driver name that is required to print on this synonym.
DEFDIST
The DEFDIST control statement creates or modifies a list of SYSOUT IDs for a DIST ID.
Syntax:
/DEFDIST DISTID=
distid
         SYSOUT=
sysoutid
         SYSDESC=
description
         DIDDESC=
description
         RVIEW=Y|N          REPRT=Y|N          DEL=Y|N
where:
  • DISTID=distid
    Specifies the name of the distribution identifier to be processed.
    This value can be 1 to 32 characters.
    Note:
    If distid contains embedded blanks, parentheses, quotes, equal signs, or commas, enclose it in quotes (single or double). Any quote within the Dist-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 DESK, enter it as ‘JIM’’S DESK’ or "JIM’S DESK".
  • SYSOUT=sysoutid
    Specifies the name of the SYSOUT to be processed.
    This value can be 1 to 32 characters. If the SYSOUT does not exist in the
    View
    database, it is added. If it already exists, it is modified.
  • SYSDESC=description
    Specifies a description of the SYSOUT.
    This value can be 1 to 40 characters.
  • DIDDESC=description
    Specifies the description of the DIST ID.
    This value can be 1 to 40 characters.
  • RVIEW=Y|N
    Specifies whether logical view access for the associated SYSOUT is to be restricted to non-secured logical views.
  • REPRT=Y|N
    Specifies reprint capability; indicates whether the user can reprint SYSOUT.
  • DEL=Y|N
    Specifies the delete capability; indicates whether the DIST ID can delete SYSOUT.
DEFFILT
The DEFFILT control statement creates or modifies a FILTER.
Syntax:
/DEFFILT    ID= 
fname
        DESC=   
'Up to 40 characters'
        FILTERS=    
( (bline,eline,bcol,ecol,op,'text',type,show,clr,hlt,loc), ... )
Where:
  • ID=fname
    Specifies the 1-8 character name for this Filter.
  • DESC=
    Specifies the 1-40 character Filter description.
  • FILTERS=
    Filter specifications are defined by entries within a table.
    The FILTERS parameters are enclosed in parentheses.
    In addition, each entry (row) in the table is also enclosed by parentheses.
    Note: To update FILTERS= definitions for an existing filter, specify all FILTERS= definitions. All existing table entries are replaced with the new entries.
    Table entries have the following format:
(bline,eline,bcol,ecol,op,'text',type,show,clr,hlt,loc)
bline
The beginning line specifies the first line on the unfiltered report page that is to be searched for the data specified in the text column.
Note: If bline or eline is not specified, the entire page is searched. If only bline is specified, only that one line is searched. If both bline and eline are specified, only those lines specified (including all between) are searched.
  • eline
    The ending line specifies the last line on the unfiltered report page that is to be searched for the data specified in the text column. If eline is specified, bline must also be specified.
    See the previous note about bline and eline.
  • bcol
    The beginning column specifies the first column on the unfiltered report page that is to be searched for the data specified in the text column.
    Note
    : If bcol or ecol is not specified, the entire line is searched. If only bcol is specified, only that one column is searched. If both bcol and ecol are specified, only those columns specified (including all between) are searched.
  • ecol
    The ending column specifies the last column on the unfiltered report page that is to be searched for the data specified in the text column. If ecol is specified, bcol must also be specified.
    See previous note about bcol and ecol.
  • op
    Specifies the type of comparison to be performed:
    • EQ - equal to
    • NE - not equal to
    • LT - less than
    • LE - less than or equal to
    • GT - greater than
    • GE - greater than or equal to text
    • Specifies the text data that is being searched for on the unfiltered report page. Enclose the text in single quotes. The text searching is case-sensitive.
  • type
    Specifies the Boolean connectors: AND, OR, NOT
    The NOT connector must appear on its own line, and it refers to the line that follows it.
    When using AND, all comparisons must have the same line numbers.
  • show
    Specifies whether lines that match the specified filter criteria are displayed. If the comparison is successful, the character "Y" specifies to include the line for display or print, and the character "N" specifies to exclude the line from display or print.
    This can be omitted if you only want to emphasize with color or highlighting.
  • clr
    Specifies optional color to be applied when the comparison is successful:
    • B - blue
    • G - green
    • P - pink
    • R - red
    • T - turquoise
    • W - white
    • Y - yellow
  • hlt
    Specifies optional highlight to be applied when the comparison is successful:
    • B - blink
    • R - reverse video
    • U - underscore
  • loc
    Specifies optional location to which color, highlight, or both are applied when the comparison is successful:
    • A - all occurrences of the specified text string on the report line
    • F - the first occurrence of the specified text string on the report line
    • L - the entire report line
    If omitted when color, highlight, or both have been specified, "A" for all occurrences of the field is automatically inserted.
DEFSYS
The DEFSYS control statement creates or modifies a list of DIST IDs for a SYSOUT ID.
Syntax:
/DEFSYS  SYSOUT=
sysoutid
         DISTID=
distid
         SYSDESC=
description
         DIDDESC=
description
         RVIEW=Y|N          REPRT=Y|N          DEL=Y|N
where:
  • SYSOUT=sysoutid
    Specifies the name of the SYSOUT to be processed.
    This value can be 1 to 32 characters. If the SYSOUT does not exist in the
    View
    database, it is added. If it already exists, it is modified.
    Note: If the id contains embedded blanks, commas, 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".
  • DISTID=distid
    Specifies the name of the distribution identifier to be processed.
    This value can be 1 to 32 characters.
    Note: If distid contains an embedded blank, parenthesis, quote, or a comma, enclose it in quotes (single or double). Any quote within the Dist-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 DESK, enter it as ‘JIM’’S DESK’ or "JIM’S DESK".
  • SYSDESC=description
    Specifies a description of the SYSOUT.
    This value can be 1 to 40 characters.
  • DIDDESC=description
    Specifies the description of the DIST ID.
    This value can be 1 to 40 characters.
  • RVIEW=Y|N
    Specifies whether logical view access for the associated SYSOUT is to be restricted to non-secured logical views.
  • REPRT=Y|N
    Specifies reprint capability; indicates whether the user can reprint SYSOUT.
  • DEL=Y|N
    Specifies the delete capability; indicates whether the DIST ID can delete SYSOUT.
DEFUSER
The DEFUSER control statement adds
View
user IDs to the database or modifies existing user IDs.
Syntax:
/DEFUSER USER=
xxxxxxxx
         USERPSWD=
xxxxxxxx
         MASTER=Y|N          DISTMASK=
distmask
         DISTID=
distid
         ACC=
xxxxxx
         MODE=
xxxx
         BANNER=
xxxxxxxx
         JCL1=
xxxxxxxx
         JCL2=
xxxxxxxx
         JCL3=
xxxxxxxx
         JCL4=
xxxxxxxx
         LANGUAGE=
x
         PBANNER=
xxxxxxxx
         PCLASS=
x
         PDEST=
x
         PWRITER=
xxxxxxxx
         ABANNER=
xxxxxxxx
         ACLASS=
x
         ADEST=
x
         AWRITER=
xxxxxxxx          
JBANNER=xxxxxxxx          JPBANNER=xxxxxxxx          JABANNER=xxxxxxxx
where:
  • USER=xxxxxxxx
    Specifies the name of the user ID to be processed.
    If the user ID does not exist in the database, it is added. If it already exists, it is modified. This parameter is required.
  • USERPSWD=xxxxxxxx
    Specifies the password associated with the user ID for logging on to an online session.
    This value can be 1 to 8 characters with national and/or alphanumeric characters. This parameter is optional.
  • MASTER=Y|N
    Specifies whether the USER has master authority.
    If omitted, MASTER=N is used.
  • DISTMASK=distmask
    Specifies the generic distribution ID mask for users in EXP mode or SAR mode.
    This value can be 1 to 32 characters with any combination of asterisk, national, and alphanumeric characters.
    Note
    : If distmask contains an embedded blank, parenthesis, quote, or a comma, enclose it in quotes (single or double). Any quote within the distmask must be entered as a pair of quotes because a non-paired quote ends the mask; for example, if the value is JIM’S DESK, enter it as ‘JIM’’S DESK’ or "JIM’S DESK".
    If omitted, MASK=userid is used.
  • DISTID=distid
    Specifies the default DIST ID for users in EXP mode or SAR mode.
    This value can be 1 to 32 characters.
    Note: If distid contains an embedded blank, parenthesis, quote, or a comma, enclose it in quotes (single or double). Any quote within the Dist-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 DESK, enter it as ‘JIM’’S DESK’ or "JIM’S DESK".
    If omitted, DISTID=userid is used.
  • ACC=xxxxxx
    Specifies whether the user can access modes ALL, EXPO, EXP, SARO, SAR, and JOB, respectively
    This value is a 6 - character string of Ys and Ns.
    If omitted, the SARINIT parameter DEFMODE is used. Since at least one mode must be active, ACC=NNNNNN is not valid.
  • MODE=xxxx
    Specifies the mode in which the user automatically enters
    View
    .
    This value can be ALL, EXPO, EXP, SARO, SAR, or JOB.
    • If omitted, the mode for a new user is determined by the first D in the DEFMODE initialization parameter.
    • If there is no D, the mode corresponding to the first Y is used.
    • If there is no Y, ALL will be used.
    • If existing users change modes during a session, the changed mode is their mode when they start their next session.
  • BANNER=xxxxxxxx
    Specifies the default BANNER page for user.
    This value can be 1 to 8 characters with alphanumeric or national characters.
  • JCL1=xxxxxxxx through JCL4=xxxxxxxx
    The JCL job submit statements used by
    View
    J selection code printing.
    JCL statements that contain blank or special characters must be enclosed in single or double quotes. For example:
    JCL1="//AJOB JOB MSGCLASS=*"
  • LANGUAGE=x
    Specifies the system default language to be used when displaying online panels and messages.
    Possible values are R (or blank) for English, C for Canadian French, G for German, D for Danish.
  • PBANNER=xxxxxxxx
    Specifies the Primary BANNER to be used in the Print menu for a user in SAR or EXP mode.
  • PCLASS=x
    Specifies the Primary CLASS to be used in the Print menu for a user in SAR or EXP mode.
  • PDEST=x
    Specifies the Primary DEST to be used in the Print menu for a user in SAR or EXP mode.
  • PWRITER=xxxxxxxx
    Specifies the Primary DEST to be used in the Print menu for a user in SAR or EXP mode.
  • ABANNER=xxxxxxxx
    Specifies the Alternate BANNER to be used in the Print menu for a user in SAR or EXP mode.
  • ACLASS=x
    Specifies the Alternate CLASS to be used in the Print menu for a user in SAR or EXP mode.
  • ADEST=x
    Specifies the Alternate DEST to be used in the Print menu for a user in SAR or EXP mode.
  • AWRITER=xxxxxxxx
    Specifies the Alternate WRITER to be used in the Print menu for a user in SAR or EXP mode.
  • JBANNER=xxxxxxxx
    Specifies the default BANNER in the Print menu for a user in JOB mode.
  • JPBANNER=xxxxxxxx
    Specifies the Primary BANNER in the Print menu for a user in JOB mode.
  • JABANNER=xxxxxxxx
    Specifies the Alternate BANNER in the Print menu for a user in JOB mode.
DEFVIEW
The DEFVIEW control statement adds or modifies logical view definitions:
Syntax:
/DEFVIEW  VIEW=vname NUM=vnum USER=userid        FILTER=fname    SECURED=N/Y DESC='Up to 40 characters'           DEFAULT=N/Y LOCKLEFT=N/Y DISPCC=Y/N                              EXCPAGES=nnn EXCRECS=nnn DISPRECS=nnn            ACL1=   AHL1=   ACL2=   AHL2=   ALINES=nn            HSCROLL=N/Y                                                          HEADING=( (rec,pos,len,clr,hlt), or ('text',clr,hlt), ...    )           HED1=   HED2=   HED3=   HED4=   HED5=   HED6=                            CLR1=   CLR2=   CLR3=   CLR4=   CLR5=   CLR6=                            HLT1=   HLT2=   HLT3=   HLT4=   HLT5=   HLT6=                            CRINDEX=N/Y          COLUMN=( (pos,len,clr,hlt,hdg),          or ('text',clr,hlt,hdg), ...  )          HDGn=( (rec,clr,hlt) or ('text',clr,hlt) ...) )          SEARCH=( (bline,eline,bcol,ecol,op,'text',type,symbol), ... )            INDEX=( (name,line,col,len,extract,leftjust,upper) ... ) 
Where:
  • VIEW=vname
    Specifies a 1-32 character name for this view. Using an ASTERISK as the last character makes this a GBL VIEW.
    If the VIEW ID (name + number + userid) does not exist in the database, it is added. If it already exists, it is modified. This parameter is required.
  • NUM=vnum
    Logical view number (1-255).
  • USER=userid
    Specify a 1-8 character userid to make this a private view.
    Omit this parameter if this is a public view.
  • FILTER=fname
    Name of a filter which is applied automatically whenever the view is selected. 1-8 characters. Valid filter characters are limited to alphanumeric, national, and limited special characters.
  • SECURED=N/Y
    Specify Y to prevent unsecured DISTIDs from accessing this view in EXP mode. (Secured DISTID access is defined in
    Deliver
    for each DISTID on the report distribution list)
    Default: N
  • DESC='Up to 40 characters'
    Description that is used to identify the logical view. 1-40 characters enclosed in quotes.
  • DEFAULT=N/Y
    This is the default view for this view name. It is used when a user selects a report through the online V command.
    Default: N
  • LOCKLEFT=N/Y
    The leftmost column of data (as specified as the first entry under the column definitions) can be locked on the display to prevent it from scrolling off during horizontal scrolling.
    Default: N
  • DISPCC=Y/N
    Determines whether carriage controls are included as position one of the online display.
    Default: N
  • EXCPAGES=nnn
    Specifies the total number of pages to be excluded at the top of the report (0-999).
    Default: 0
  • EXCRECS=nn
    Specifies the total number of records to be excluded at the top of the page. This lets you exclude the title and heading records detail is displayed (0-60). The combined value of EXCRECS and DISPRECS cannot exceed 254.
    Default: 0
  • DISPRECS=nnn
    Specifies the number of data records that are contained on a page (0-254). This lets you exclude report footing lines while viewing. Leave blank to display all lines on the page. The combined value of EXCRECS and DISPRECS cannot exceed 254.
  • ACL1=
  • ACL2=
    Specifies the primary and secondary colors to be used for two alternating groups of report lines. Blank uses default 3270 colors.
    B = Blue
    R = Red
    P = Pink
    G = Green
    T = Turquoise
    Y = Yellow
    W = White
  • ALINES=
    Number of lines in each group. (1 to 9).
  • AHL1 =
  • AHL2 =
    Specifies the primary and secondary highlight to be used for two alternating groups of report lines. Blank uses default 3270 highlight.
    B = Bold
    R = Reverse Video
    U = Underline
  • CRINDEX=N/Y
    Specifies that the index for this view is a cross-report index.
    Default: N
  • HSCROLL=N/Y
    Specifies whether the primary heading line is to remain fixed during left/right scrolling.
    Default: N
  • HEADING=
    Primary heading specifications are defined by entries within a table. The HEADING specifications are enclosed within parentheses. In addition, each row in the table is also enclosed by parentheses. Table rows have the following format:
    (
    (rec,pos,len,clr,hlt) or ('text',clr,hlt), Row-2, Row3, …
    )
    • Rec
      The number of the record where data is to be extracted.
    • Pos
      position within the record to start extraction.
    • Len
      Length of the data to be extracted.
    • Clr
      Color to be applied to the heading. See ACL1 for values.
    • Hlt
      Highlight to be applied to the heading. See AHL1 for values.
    • text
      Constant text to be included in the heading - This text is to be enclosed in quotes.
  • HED1=
  • HED6=
    Specifies the record number that is used for extracting DEFAULT column headings. (1-99).
  • CLR1=
  • CLR6=
    Specifies the color attribute for the corresponding heading line. See ACL1 for values.
  • HLT1=
  • HLT6=
    Specifies the highlight attribute for the corresponding heading line. See HL1 for values.
  • COLUMN=
    Data column specifications are defined by the entries within a table. The COLUMN parameter is enclosed in parentheses. In addition, each entry in the table is also enclosed by parentheses.
    Table entries have two formats:
    (
    (pos,len,clr,hlt,hdg#) or
    ('text',clr,hlt,hdg#), …
    )
    • Pos
      position within the record extraction the column.
    • Len
      Length of the data column to be extracted.
    • Clr
      Color to be applied to the column.
    • Hlt
      Highlight to be applied to the column.
    • Text
      Constant text to be included in the column - This value must be enclosed in quotes.
    • HDG#
      Indicates whether an explicitly heading has been defined for the data column. Zero (the default) indicates the column headings will be extracted from the records as specified by the DEFAULT column headings (HED1, HED2, ..). Specify a number between 1 and 99 to identify the HDGn parameter that defines the heading.
      Note
      : To update COLUMN or HDGn definitions for an existing view, you must specify both COLUMN and HDGn definitions.
  • HDG1=
  • HDG99=
    An explicit column heading for an entry referenced in the COLUMN table. The HDGn parameter is enclosed in parentheses. In addition, each entry in the table is also enclosed by parentheses. Table entries have two formats:
  • (
  • (rec,clr,hlt),
  • or ('text',clr,hlt), …
  • )
    • Rec -
      The number of the record where the heading is extracted.
    • Clr -
      Color to be applied to the heading.
    • Hlt -
      Highlight to be applied to the heading.
    • text -
      Constant text to be included in the heading - This value must be enclosed in quotes.
Note:
The DEFVIEW facility is limited to 99 explicit column headings. If more than 99 are needed, they must be added through the online interface.
To update COLUMN or HDGn definitions for an existing view, you must specify both COLUMN and HDGn definitions.
SEARCH=
Specifies the index search specifications.
Index search specifications are defined by entries within a table. The SEARCH specifications are enclosed within parentheses. In addition, each row in the table is also enclosed by parentheses.
Note
: To update SEARCH= definitions for an existing view, specify all SEARCH= definitions. All existing table entries are replaced with the new entries.
Table rows have the following format:
( (bline,eline,bcol,ecol,op,'text',type,symbol), (row-2), (row-3),
)
  • bline -
    The beginning or only line to be searched for text. The beginning line can be a specific line number from 1 to 255 or a relative line number in the form r+n where r is the reference symbol from an earlier search specification and n is the number of lines from the search specification in the range of 0 to 255.
    Note: This is a line number, not a record number. Carriage controls are to be taken into account when specifying a line number.
  • eline -
    The last line to be searched for text. The ending line can be a specific line number from 1 to 255 or a relative line number in the form r+n where r is the reference symbol from an earlier search specification and n is the number of lines from the search specification in the range of 0 to 255. If omitted, the beginning line is the only line searched.
    Note
    : This is a line number, not a record number. Also, the beginning and ending line fields cannot reference a different search specification.
  • bcol -
    The beginning or only column to be searched for text. The beginning column can be a specific column number from 1 to 32760 or a relative column number in the form r+n or r-n where r is the reference symbol from an earlier search specification and n is the number of columns from the search specification in the range of 0 to 32760.
    Note
    : The line and column fields cannot reference a different search specification.
  • ecol -
    the last column to be searched for text. The ending column can be a specific column number from 1 to 32760 or a relative column number in the form r+n or r-n where r is the reference symbol from an earlier search specification and n is the number of columns from the search specification in the range of 0 to 32760. If omitted, the beginning column is the only column searched. The beginning and ending column are to be large enough to op - specifies one of the following values to indicate the type of comparison to be performed:
    • "EQ" - search line(s) for data matching the specified text.
    • "NE" - search line(s) for data NOT matching the specified text.
    • "LK" - search line(s) for data that matches a pattern.
  • text -
    Search text. This is to be enclosed in quotes. The text is maintained as upper case characters but matches lower case page data. For the LK comparison operator, the text can specify a special matching character or any other character to specifically match that character. The special matching characters are:
    • = - any character
    • ! - alphanumeric character
    • ? - any character
    • ¬ - non blank character
    • # - numeric character
    • < - lowercase character
    • @ - alphabetic character
    • > - uppercase character
  • type -
    Indicates whether multiple occurrences of the text can be found on a report page. This field can be specified as follows:
    • " " - indicates that after the text has been located on a report page no other lines in the report page is searched.
    • "M" - indicates that multiple occurrences of the text can be found on a report page. Note: Only the first occurrence of the search text is found on an individual line of the report.
    • "C" - indicates that multiple occurrences of the text can be found on a report page. This is like a TYPE "M" except entries can span from one page to the next.
  • symbol -
    Defines the reference symbol that is associated with the search specification. The reference symbol can be any non-blank character. This character is to be unique within the search specifications. Define a reference symbol only if a subsequent search or extraction of data is based on the location of the search text.
INDEX
Specify the index field names and locations.
Index field specifications are defined within a table. The INDEX specifications are enclosed within parentheses. In addition, each row in the table is also enclosed by parentheses.
Note
: To update INDEX= definitions for an existing view, specify all INDEX= definitions. All existing table entries are replaced with the new entries. To create a page index for an existing SYSOUT, the INDEX control statement must be issued on that SYSOUT before viewing.
Table rows have the following format:
(
(name,line,col,len,extract,leftjust,upper), ...
)
  • Name
    Identifies the index data being extracted. Index names are required for a cross report index. In all cases, the use of index name is recommended because changes to line, column, and length does not affect the selection of old indexes. Each index name is to be unique and cannot be reused within the index. 1-8 Characters.
  • Line
    Specifies the line where indexing data is to be extracted. The line number can be a specific line number from 1 to 255 or a relative line number in the form r+n where r is the reference symbol of a search specification and n is a number of lines from the search specification in the range of 0 to 255.
    Note
    : This is a line number, not a record number. Carriage controls are to be taken into account when specifying a line number.
  • Col
    Specifies the beginning column where indexing data is to be extracted. The column number can be a specific column number from 1 to 32760 or a relative column number in the form r+n or r-n where r is the reference symbol of a search specification and n is a number of columns from the search specification in the range of 0 to 32760.
    Note:
    The first column of data (after the carriage control) is column 1. Also, the line and column fields cannot reference a different search specification.
    Len - specifies the length of the field to be extracted and indexed.
  • Extract
    Specifies as ALL (or blank), FIRST, or NBLK to indicate whether index data is to be extracted from all pages, whether index data is to be extracted from the first page of a group of pages (in other words, only extract data when previous index values have changed), or whether new index data is to be extracted when the index data is not blank.