The selection and sort criteria and also the specifications for print editing can be defined individually and saved. The information to be output is output to a file in MAREN format. The file can also be created in CSV format to permit spreadsheet processing. It can also be specified that an file should be output on a printer or sent by email after it has been created.
Information from the MAREN catalog to SYSOUT or in S variables is provided by the SHOW-VOLUME-ATTRIBUTES statement, see "SHOW-VOLUME-ATTRIBUTES Output information from the MAREN catalog".
Format
PRINT-VOLUME-ATTRIBUTES Alias: PR / PRVA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Operands
VOLUME =
Archive numbers of tapes about which information is required.
VOLUME = *ALL
All tapes are processed.
VOLUME = *INTERVAL(...)
All tapes whose archive number lies within the range specified below are processed.
FROM = *FIRST
All tapes are processed, starting with the lowest available archive number.
FROM = <vsn>
Archive number. All tapes whose archive number is greater than or equal to the specified archive number are processed.
TO = *LAST
All tapes are processed up to the highest existing archive number.
TO = <vsn>
Archive number. All tapes whose archive number is less than or equal to the specified archive number are processed.
FROM-FSEQ = 1 / <integer 1..9999>
File sequence number of the FROM operand. Specifies the precise file sequence number at which processing is to begin. This operand is relevant only if the statement is issued via the MAREN program interface.
SELECT =
Specifies which catalog entries are to be added to the list. Preselection may already have been carried out using the VOLUME parameter.
SELECT = *NO
No selection criteria.
SELECT = *YES (...)
PARAMETER-SET =
Specifies the selection criteria to be used.
PARAMETER-SET = STD
All records are output.
PARAMETER-SET = <name 1..15>
Name of the parameter set containing the selection criteria.
PARAMETER-FILE = *STD / <filename 1..54>
See notes on "PRINT-VOLUME-ATTRIBUTES Create list with information from the MAREN catalog".
UPDATE =
Specifies whether the parameter set is to be modified before it is used.
UPDATE = *NO
The parameter set is not modified.
UPDATE = *PERMANENT
The parameter set is modified before use. The modified parameter set is written to the parameter file. If the parameter set does not yet exist, it is created.
UPDATE = *TEMPORARY
Relevant only in connection with BATCH-PROCESSING=*NO.
The parameter set is modified before use. It is not written to the parameter file.
SORT =
Specifies whether sort criteria are to be used.
SORT = *NO
No sort criteria.
SORT = *YES(...)
PARAMETER-SET =
Specifies which sort criteria are to be used.
PARAMETER-SET = STD
The default sort criteria are used.
PARAMETER-SET = <name 1..15>
Name of the parameter set containing the sort criteria.
PARAMETER-FILE = *STD / <filename 1..54>
See notes on "PRINT-VOLUME-ATTRIBUTES Create list with information from the MAREN catalog".
UPDATE =
Specifies whether the parameter set is to be modified before it is used.
UPDATE = *NO
The parameter set is not modified.
UPDATE = *PERMANENT
The parameter set is modified before use. The modified parameter set is written to the parameter file. If the parameter set does not yet exist, it is created.
UPDATE = *TEMPORARY
Relevant only in connection with BATCH-PROCESSING=*NO.
The parameter set is modified before use. It is not written to the parameter file.
LAYOUT-CONTROL =
Specifies whether the file is to be edited for printing, which parameter files are to be used, and in what way.
LAYOUT-CONTROL = *YES(...)
The output file is to be edited for printing with printer control characters, headers, page numbers, etc.
PARAMETER-SET =
Specifies the layout to be used.
PARAMETER-SET = STD
The default layout is to be used.
PARAMETER-SET = <name 1..15>
Name of the parameter set containing the layout.
PARAMETER-FILE = *STD / <filename 1..54>
LMS library for saving the parameter sets. See notes on "PRINT-VOLUME-ATTRIBUTES Create list with information from the MAREN catalog".
UPDATE =
Specifies whether the parameter set is to be modified before it is used.
UPDATE = *NO
The parameter set is not modified.
UPDATE = *PERMANENT(...)
The parameter set is modified before use. The modified parameter set is written to the parameter file. If the parameter set does not yet exist, it is created.
UPDATE-HEADER =
Specifies if the display of headers 2 and 3 is to be recalculated by MAREN or if the existing headers in the mask “Entering the layout parameters (structure of header lines):” are to be suggested.
UPDATE-HEADER = *STD
Headers 2 and 3 will be created by MAREN.
UPDATE-HEADER = *OLD
Headers 2 and 3 are taken from an existing parameter record. If there is no parameter record, then the response is the same as when UPDATE-HEADER=*STD is used.
UPDATE = *TEMPORARY(...)
Relevant only in connection with BATCH-PROCESSING=*NO.
The parameter set is modified before use. It is not written to the parameter file.
UPDATE-HEADER =
Specifies if the display of headers 2 and 3 is to be recalculated by MAREN or if the existing headers in the mask “Entering the layout parameters (structure of header lines):” are to be suggested.
UPDATE-HEADER = *STD
Headers 2 and 3 will be created by MAREN.
UPDATE-HEADER = *OLD
Headers 2 and 3 are taken from an existing parameter record. If there is no parameter record, then the response is the same as when UPDATE-HEADER=*STD is used.
START-PRINT =
Specifies whether the output file is to be printed immediately.
START-PRINT = *YES(...)
Specifies that the output file is to be automatically printed immediately.
As output files in CSV format cannot be printed out, START-PRINT=*NO is assumed in this case.
SPOOLOUT-NAME = *NONE / <alphanum-name 1..8>
Job name to be assigned to the spoolout task. This name will also appear on the header page.
SPOOLOUT-NAME = *NONE
No special job name. If a job name was assigned to the job that issued the spoolout job, this name is used.
DELETE-FILE = *YES / *NO / *DESTROY
Specifies whether the output file is to be deleted after it has been printed.
If this entry contradicts the DELETE-FILE operand in SEND-BY-MAIL=*YES(...), DELETE-FILE=*NO is assumed implicitly.
TO-PRINTER =
Specifies which printer is to be used for printing.
TO-PRINTER = *STD
The printout will be output on the standard system printer.
TO-PRINTER = *PRINTER-NAME(...)
The printout will be output on a specific printer.
PRINTER-NAME = <alphanum-name 1..8>
Name of the printer used for printing.
TO-PRINTER = *PRINTER-POOL(...)
The print job will be sent to a printer pool.
PRINTER-POOL = <alphanum-name 1..8>
Name of the printer pool to which the print job was sent.
FORM-NAME =
Specifies which form will be used for printing. Standard forms must be defined for all printer types in the SPOOL parameter file.
FORM-NAME = *STD
The standard form is used for printing.
FORM-NAME = <alphanum-name 1..6>
Name of the form used when printing.
START-PRINT = *NO
Specifies that the output file is not to be printed automatically.
LAYOUT-CONTROL = *NO
Specifies that the output file is not to be edited for printing, i.e. all selected catalog entries are transferred unformatted to the output file.
OUTPUT =
Determines the name of the output file and, if required, other details regarding the output format and transfer by email.
OUTPUT = *STD(...)
Output takes place to a file with the name MAREN.PRINT.yyyymmdd.hhmmss
.
FORMAT =
Determines the format of the output file.
FORMAT = *MAREN-STRUCTURE
Output takes place in MAREN format.
FORMAT = *CSV(...)
START-PRINT=*NO is always assumed for files in CSV format.
Output takes place in CSV (comma separated value) format. Files in CSV format can be read in so that the columns are retained, and they can be processed further with a spreadsheet program (e.g. EXCEL).
SEPARATOR = *SEMICOLON / *COMMA
Determines the separator which is to be set between the various output values. The default separator is a semicolon (;). Optionally a comma (,) can be used as the separator.
HEADER-LINE = *YES / *NO
Specifies whether a header line should be output to name the output columns. The default is *YES, i.e. the header line is output. The header line contains the names of the attributes.
SEND-BY-MAIL = *NO / *YES(...)
Specifies whether the output file should be sent by email. The default is *NO, i.e. it is not sent by email. Transfer by email takes place only if the file to be sent contains at least one entry.
SEND-BY-MAIL = *YES(...)
The output file should be sent as an email attachment. The recipient is addressed by means of his/her user ID, i.e. the email address is taken from the user entry concerned.
TO = *USER(...)
Details of transfer by email:
USER-IDENTIFICATION = *OWN / <name 1...8>
Specifies the user ID. The recipient’s email address is taken over from this user entry. If the user entry contains more than one email address, all the addresses are taken over as recipients. The default is *OWN, i.e. the caller’s user ID.
SUBJECT = *STD / <c-string 1...256>
Determines the content of the email’s “Subject” field. The default is *STD, i.e. MAREN uses a standard text.
DELETE-FILE = *YES / *NO / *DESTROY
Specifies whether the file should be automatically deleted after it has been sent. *YES (default) causes the file to be deleted after it has been sent. *DESTROY also causes it to be deleted, and the memory space is overwritten with binary zeros.
If this entry contradicts the DELETE-FILE operand in START-PRINT=*YES(...), DELETE-FILE=*NO is assumed implicitly.
OUTPUT = <filename 1..54>
Only for specifying a file generation.
Output is directed to the specified file generation in MAREN format.
OUTPUT = <filename 1..54 without-gen-vers>(...)
Output is directed to the specified file.
FORMAT = *MAREN-STRUCTURE / *CSV(...)
Determines the format of the output file. The default is output in MAREN format. Output in CSV format is described under the OUTPUT=*STD(...) operand on "PRINT-VOLUME-ATTRIBUTES Create list with information from the MAREN catalog".
SEND-BY-MAIL = *NO / *YES(...)
Specifies whether the output file should be sent by email. The default is *NO, i.e. it is not sent by email.
Transfer by email is described under the OUTPUT=*STD(...) operand on "PRINT-VOLUME-ATTRIBUTES Create list with information from the MAREN catalog".
BATCH-PROCESSING =
This option allows the output file to be created in a separate batch task, thus avoiding long wait times at the terminal.
BATCH-PROCESSING = *YES(...)
The output file is to be created in a batch task.
CPU-LIMIT = 500 / <integer 1..32767 seconds >
Maximum CPU time in seconds allocated for the batch task.
BATCH-PROCESSING = *NO
Specifies that no separate batch task is to be started.
Notes
The layout of a list and the way in which the selected catalog entries are sorted are determined by specifying parameter sets. These parameter sets can be freely defined by the user by means of screen masks, and can be re-used at a later date.
The layout, selection, and sort parameters are combined to form a parameter set, which is assigned a name of 6 characters in length. The parameter sets are stored as S elements in the LMS library specified in the PARAMETER-FILE operand. Querying of the table of contents, deleting or copying parameter sets, etc. can only be performed with the LMS program (see the “LMS” manual [8]).
In MAREN, the parameter set with the highest version number is used. A parameter set of the current version is always written. Modifications made to a parameter set of an earlier version are not saved, even when it is initially used as a template. A modified parameter set of an earlier version is therefore stored in the current version and the relevant parameter set in the earlier version remains unchanged.
In a batch task, the parameter sets are not modified before use. In interactive mode, the records can be modified temporarily (for the current printout only) or permanently (saved to a separate parameter file). The creation and modification of parameter sets are only possible if a print file is subsequently created (unless creation of the print file is aborted).
For each parameter set, the user can specify the parameter file to be used for reading or writing. If no file is specified, the file MAREN.PARAMETER-FILE is used under the calling user ID. If this file is not available or does not contain the specified record, the file $SYSMAREN.MAREN.PARAMETER-FILE
is used or, if IMON is available, the file linked with the logical ID SYSPAR.PRINT
. If neither of these files exist, the default parameters are used.
The following applies to the individual parameters:
Select parameters
A comparison string and a comparison operator (EQ,NE,LT,GT,LE,GE,=,<,>,<=,>=) can be defined for each catalog entry field. Only those catalog entries for which all comparison criteria are fulfilled are selected. Partially qualified comparison strings are permitted. The end of a partially qualified string is indicated by an asterisk (*). Partial qualification is not permitted for numeric catalog entry fields. Leading zeros can be ignored.
Two formats are permitted for date fields:
Absolute date in the format “
yyyy-mm-dd
”. The minimum entry is the year specification and the following hyphen.Relative date of up to four digits with a positive (optional) or negative sign. The absolute date is calculated from the relative date and the current date when the PRINT-VOLUME-ATTRIBUTES statement is executed. The absolute date thus calculated is used for comparison.
The number of catalog entries can be further restricted by means of the parameter VOLUME = *INTERVAL(...) .
Catalog entry fields which do not appear in the list can also be used for selection purposes. The catalog entry fields selected are labeled with “s” in the follow-on masks SORT and LAYOUT.
Sort parameters
The user can specify up to ten catalog entry fields which are to be used for sorting. The sort hierarchy (if more than one sort field is specified) and sort direction (“A”: ascending/”D”: descending) can be specified.
Catalog entry fields which do not appear in the list can also be used for sorting purposes. The catalog entry fields selected are labeled with “o” in the follow-on mask LAYOUT.
Layout parameters
One line (of max. 240 characters) can be output for each catalog entry. The mask allows the user to define which catalog entry fields are to be used in the output line, together with the sequence and length (shorter or longer than the catalog entry) in which they are to be output. The separators between columns can be freely defined.
A follow-on mask suggests a two-line header based on the selected column structure. It can be changed as required. The line length is determined by the sum of the catalog entry field lengths together with the separators. A page header can also be freely defined.
The following variables can be used in the header:
&DATE
&TIME
&PAGEDate of creation of the list
Time
Page numberDefault parameter sets
A default layout parameter set is stored in the MAREN user program.
This default layout has no effect if a layout parameter set with the name STD is contained in the parameter file under the calling user ID or in the global parameter file (see the “Notes”). This allows the data center or user to define individual default parameters.
Examples
Example 1
//print-volume-attributes
|
If the statement is entered without operands, MAREN first searches for the default parameter set for creating a print file under the calling user ID. If the default parameter set is not available there, it searches under the user ID SYSMAREN or, if IMON is used, the file with the logical name SYSPAR.PRINT
.
If a default own parameter set has been defined, this layout is used when generating the list.
If neither the caller nor the MAREN administrator has defined a default parameter set, a list is generated using the default layout defined in MAREN. This list contains all tapes of the caller's user ID and is sorted according to archive number.
The private parameter sets are stored in the MAREN.PARAMETER-FILE
file under the calling user ID.
A|MAREN <version> <date> <time> PAGE 1| |----------------------------------------------------------------------------------------------------------------------------------| |VOLUME|FSEQ|DEV-TYPE| REMARK |U|P|ACC-|VOLUME- |FILE/DIR-NAME (SHORTENED) |CREATION |LAST-ACC |HOME- |E| | | | | |A|W|CNT |FREEDATE | |-DATE |-DATE |LOCATION|X| |----------------------------------------------------------------------------------------------------------------------------------| | | | | | | | | | | | | | | |C0725K| 1|TAPE-U4 |SF-INVESTIGATION |A|Y| 24|<date> |SYSIMPL.SDF.SYSTEM.SYNTAX.M10 |<date> |<date> |HALLE46 | | |G5110K| 1|TAPE-U4 |IMON BLZ ENGL. D017ZE17 |A| | 45|<date> | | |<date> |HALLE46 | | |G6013K| 1|TAPE-U4 |IMON BLZ D017ZE17 |A|Y| 10|<date> | | |<date> |HALLE46 | | |M4696K| 1|TAPE-U4 | |F| | 17|<date> |ARCHIVE.SAVE.FILE(990222-133704|<date> |<date> |ROBOTER2| | |M5632K| 1|TAPE-U4 | |A| | 0|<date> |:2OSG:$USER1.ULF.ARCHIVE.DIR | | |ROBOTER2| | | | | | | | | | | | | | | | |M5633K| 1|TAPE-U4 | |A| | 0|<date> |:2OSG:$USER1.ULF.ARCHIVE.DIR | | |ROBOTER2| | |M5634K| 1|TAPE-U4 | |A| | 0|<date> |TAPE.FILE.1 | | |ROBOTER2| | |M5635K| 1|TAPE-U4 | |A| | 3|<date> |TAPE.FILE.1 |<date> |<date> |ROBOTER2| | |M5636K| 1|TAPE-U4 | |A| | 0|<date> |:2OSG:$USER1.ULF.ARCHIVE.DIR | | |ROBOTER2| | |M5637K| 1|TAPE-U4 | |A| | 8|<date> |TAPE.FILE.2(1) |<date> |<date> |ROBOTER2| | | | | | | | | | | | | | | | |M5637K| 2|TAPE-U4 | |A| | 1|<date> |TAPE.FILE.2(2) |<date> |<date> |ROBOTER2| | |M5637K| 3|TAPE-U4 | |A| | 3|<date> |TAPE.FILE.2(4) |<date> |<date> |ROBOTER2| | |M5638K| 1|TAPE-U4 | |A| | 3|<date> |TAPE.FILE.X(*0002) |<date> |<date> |ROBOTER2| | |M5639K| 1|TAPE-U4 | |A| | 1|<date> |TAPE.FILE.X(*0002) |<date> |<date> |ROBOTER2| | |M5640K| 1|TAPE-U4 | |A| | 0|<date> |TAPE.FILE.2 | | |ROBOTER2| | | | | | | | | | | | | | | | |M5655K| 1|TAPE-U4 | |O| | 0|<date> |TAPE.FILE.3 | | |ROBOTER2| | |----------------------------------------------------------------------------------------------------------------------------------| | TOTAL 16 MAREN CATALOG ENTRIES FOR USERID USER1 | |----------------------------------------------------------------------------------------------------------------------------------| | | | THIS LIST WAS CREATED BY MAREN (1100) USING FOLLOWING PARAMETERS: | | INTERVAL : FROM=*FIRST TO=*LAST FROM-FSEQ=0001 | | SELECT : N | | SORT : N | | LAYOUT : PARAMETER-SET =STD UPDATE=NO | | -FILE=*STD | |----------------------------------------------------------------------------------------------------------------------------------|
Example 2
A list containing all tapes whose expiration dates will fall in the next 10 days is to be generated. The list is to be sorted in descending order according to the date each volume was last accessed, and then in ascending order according to file names.
It is to contain the following information:
FREE-DATE |
In order to ensure that the list can be generated again in the future with a minimum of effort, the information on selection, sorting, and layout is to be stored permanently in the default parameter file. The name of the parameter set should be “free10” for all three types (selection, sorting and layout).
Statement used to create the parameter set and the first list:
//print-volume-attributes sel=*yes(par-set=free10,update=*permanent),sort=*yes(par-set=free10,update=*permanent),layout-contr=*yes(par-set=free10,update=*permanent),batch-proc=*no
|
The following masks are displayed in the sequence shown. When the shaded values are entered, the next screen is displayed.
Entering the selection parameters:
SELECT-PAR-SET: FREE10 FILE: |
Entering the sort parameters:
SORT-PAR-SET: FREE10 FILE: |
Entering the layout parameters (structure of individual lines):
LAYOUT-PAR-SET: FREE10 FILE: |
Entering the layout parameters (structure of header lines):
LAYOUT-PARAMETER-SET: FREE10 FILE: |
The generated list looks like this:
A|Freigabe in 10 Tagen bzw. weniger <date> 1 | |
After the statement has been executed, the generated list is output to a printer.
The list can be generated again at a later point in time (without having to fill out masks) with the same format, e.g. with the statement below in a batch task:
/print-volume-attributes select=*yes(par-set=free10),sort=*yes(par-set=free10),layout-contr=*yes(par-set=free10)
|