MEDIA
General User's Guide

Part 5
REPORT Reference

This part of the manual describes the use of the REPORT writer with the MEDIA program.

Part 6
APPENDICES

This part of the manual describes the Logical names used by the MEDIA program.

Appendix A
Logical names

A variety of logical names are used throughout the MEDIA and MCL systems . They are used to contain both file names and parameter values. In general if the logical is not explicitly defined, built-in default values are used. The complete list of logicals used by MEDIA is provided with the software in a file called "MEDIA_MCL_LOGICALS.COM". This file allows the user to either define or deassign the logicals based on an input parameter.

A.1 MCL MEDIA logicals

The following logicals are used by MEDIA in MCL to fill in values in forms. These logicals can either be defined in a COM file such as LOGIN.COM or from the command line.

A.1.1 MEDIA default logicals

For a complete explanation of all logicals in this section, see Section 7.2. The logicals associated with setting the defaults for MEDIA in MCL begin with the prefix MCL_MEDIA_DEFAULT appended to:

NBR_COLS - The number of columns used when displaying media information. Default is `4'
COL_WIDTH - The column width used when displaying media information. Default is `15'.
LOCATION - The rack or bin in which the media will be stored. Default is `LIBRARY'.
TYPE - Specifies the base TYPE category for a medium. All TYPES are defined in the parameter file. Default is `RX23'.
COMMENT - This is a text field into which any text data can be inserted. Default is `NONE'.
DENSITY - The recording density of the tape. Default is `NOT SET'.
CAPACITY - This is either the total length of a reel, in feet, or total disk space, in megabytes. Default is `NOT SET'.
INCLUDE - Those media to be included in the search. Wildcards are accepted. Default is `*'.
EXCLUDE - Those media to be excluded from the search. Wildcards are accepted.
SINCE - Standard VMS search facility designates the date that included media must have been created after. Default is `NOT SET'.
BEFORE - Standard VMS search facility designates the date that included media must have been created before. Default is `TODAY'.
MFG - This is the manufacturer of the medium. This field is optional and purely for identification purposes. Default is `*'.
FILE_INCLUDE - Those files to be included in a contents display. Default is `*'.
FILE_EXCLUDE - Those files to be excluded in a contents display.
FILE_SINCE - Standard VMS search facility designates the date that included files must have been created after. Default is `NOT SET'.
FILE_BEFORE - Standard VMS search facility designates the date that included files must have been created before. Default is `TODAY'.

A.1.2 MEDIA default job logicals

The following logicals are used in the form which appears when a user chooses to create a MEDIA job in MCL. See Section 7.2.12. .endif LAYEX The logicals associated with setting the defaults for the creation of MEDIA jobs in MCL begin with the prefix MCL_MEDIA_JOB_ appended to:

INIT_MEDIUM - Determines whether the medium will be initialized after mount.
HOLD - Places the job into a queue in the HOLD state. A subsequent SET QUEUE/ENTRY command is needed to release the job for execution.
PRIORITY - The queue priority to use when the job is submitted for execution. Default is `100'.
KEEP_LOG - Saves the log file after the completion of the job. Default is `X'.
MAIL_OWNER - VMS MAIL is sent as notification upon job completion.
MOUNT_ANSI - The standard VMS tape label. Default is `X'.
MOUNT_FOREIGN - Mount as foreign media.
MOUNT_VERIFY - Determines whether the medium will undergo verification after mount. Default is `X'.
NOTIFY - Causes the notification of the creator of the MEDIA job upon completion. Default is `X'.
NO_NOTIFY - Causes no notification of the creator of the MEDIA job upon completion.
PRINT_LOG - Prints the log file after the completion of the job.
READ_ONLY - Mount as read only media. Default is `X'.
RESTART_FLAG - Marks the created MEDIA job as restartable.
SUBMIT_AFTER - Causes the job to be held in the queue until after the specified time. Default is `NOW'.

A.1.3 MEDIA default contents display logicals

For a complete explanation of all logicals on this page see Section 7.2.11. The logicals associated with setting the defaults for the contents of media (Type 2) in MCL begin with the prefix MCL_MEDIA_T2_DISPLAY_ appended to:

BACKUP - The date of the last backup of the file.
BLOCKS - Size of the file, in blocks.
CREATED - The date the file was created.
DIRECTORY - The name of the directory in which the file resides.
EXPIRES - The expiration date of the file.
FILE - Determines whether the files are to be displayed. Wildcards are accepted. Default is `X'.
FORMAT - Format of the file.
FULL - Full info. on the file is displayed.
OWNER - Owner of the file.
PROTECTION - Level of protection of the file.
REC_FORMAT - The format of a record on the chosen medium.
REC_SIZE - The size of a record on the chosen medium.
REVISED - The date the last file was revised.
SAVE_SET - The name of the saveset that the file belongs to.

A.1.4 MEDIA default header display logicals

For a complete explanation of all logicals on this page, see Section 7.4.4. The logicals associated with setting the defaults for media header information (Type 1) in MCL begin with the prefix MCL_MEDIA_T1_DISPLAY appended to:

ACC_CNT - The number of times the medium has been mounted in MEDIA. Updated with each user.
ACC_CNT_PERM - The number of times the medium has been mounted in MEDIA. Not updated with each user.
ADDED - The date the medium was added to the library.
ATTACHED_TO - Indicates the medium is attached to a volume set.
BARCODE - A text field that can be used for information related to a bar code reader.
BLOCK_SIZE - This is the size of a block on the chosen medium.
CFILE - The name of the COM file used to perform an update.
COMMENT - This is a text field into which any text data can be inserted.
DENSITY - The recording density of the tape.
DEVICE - This field specifies the type of device suitable for the medium.
DIR_DONE_ON - The last time an update was made of the on-line directory information.
ERR_CNT_PERM - Lists the structural error count detected by the ANSI update procedure. Remains constant through life of the tape unless modified.
ERR_CNT_SDR - Lists the structural error count detected by the ANSI update procedure.
EXP_DATE - Indicates the expiration date of the media.
EXTERNAL_ID - The external name of the medium.
FIRST_USED - This is a date field indicating the first time that the medium owner obtained access to this medium. Default is `NOW'.
INC_RD_CHK - The time increment to use in scheduling the next automatic read check.
INTERNAL_ID - The name magnetically encoded on the medium.
LABEL - The type of label processing and checking to be done. Possible options are: ANSI, NONE, IBM_SL, DOS.
LAST_RD_CHK - Date of last read check.
LAST_USED - This is a date field indicating when the medium was last used. Default is `NOW'.
LENGTH - The length of a reel tape in feet.
LOCATION - The rack or bin in which the tape will be stored. Default is `Library'.
MFG - The manufacturer of the medium.
MOUNT - This controls how a medium is mounted. Possible options are: ANSI, Foreign and Read Only.
NEXT_RD_CHK - The date of the next scheduled read check.
NEXT_VOLUME - The next volume in a volume set.
OFF_DURATION - The length of time the medium will remain off-site.
OFF_LOCATION - The location of an off-site medium.
OFF_RETURN - The date an off-site medium will return on-site.
OFF_SEND - The date a medium is sent off-site.
ONLY_EXTERNAL - Use to display only the external ID of the medium and not the internal ID.
OPTION_(1) - A text field that may be used with auxiliary robotic devices.
OPTION_(2) - A text field that may be used with auxiliary robotic devices.
OPTION_(3) - A text field that may be used with auxiliary robotic devices.
POOL - The pool in which the medium resides. The three options are: ALLOCATED, AVAILABLE and RELEASED. Default is `AVAILABLE'.
PROTECTION - The protection of a file or medium. Default is RWID, RWID,,.
RECORD_SIZE - The size of a record on a medium.
SHADOW_TAPE - This is the external ID of a duplicate tape.
STATUS - Displays the various status flags that are associated with a medium.
STOR_SLOT - The data associated with auxilliary robotic devices related to the storage slot.
TESTED - Checks to see if a medium has been certified.
TYPE - Specifies the base TYPE category for a medium.
OWNER - User Identification Code of the owner of the medium.
UPDATE - Displays the update options in effect for a particular medium.
USERNAME - The user name of the owner of a medium. Default is `SYSTEM'.

A.1.5 MEDIA confirm and log logicals

The logicals associated with setting the defaults for confirmation and logging activity begin with MCL_MEDIA_ appended to:

CONFIRM_ACTIONS - Determines whether confirmation is required for activity within MEDIA.
LOG_ACTIONS - Determines whether a log message is displayed for activity within MEDIA. Default is `X'.

A.2 MCL BCKMGR logicals

The following logicals are used by BCKMGR in MCL to fill in values in forms. These logicals can either be defined in a COM file such as LOGIN.COM or from the command line.

A.2.1 BCKMGR logicals

The logicals associated with setting the defaults for BCKMGR in MCL begin with the prefix MCL_BCKMGR_ appended to:

VERIFY - The verify option toggles the VMS verify option. If on, the results of the backup will be compared after the backup. Default is ` '.
CRC - Toggles CRC data recording. Default is `X'.
BLOCKSIZE - Specifies the output block size in bytes for data records. Default is `0'.
RECORD - Toggles the recording of date and time in the BACKUP date fields. Default is `X'.
OPTIONS - Field to designate any VMS BACKUP utility options. Default is ` '.
HISTORY - Selects the method of backup (See field descriptions\smallcaps). Default is `1'.
ONLINE - When set, additional information about each file added to the VAULT database is obtained from the on-line copy of the file. Default is `X'.
VAULTING - Specifies whether or not to add to the VAULT database. Default is `X'.
START_AT - Specifies the timing of the VAULT operation in relation to the backup job. Default is `NOT SET'.

A.3 MCL Report Writer logicals

The following logicals are used by the Report Writer in MCL to fill in default values in forms. These logicals can either be defined in a COM file such as LOGIN.COM or from the command line.

A.3.1 Set execution mode logicals

For a complete explanation of these logicals see the field descriptions in Section 7.15.2.2. The logicals associated with setting the execution mode of a report job begin with the prefix MCL_RPT_ appended to:

DISPLAY_WIDTH_80 - An X indicates that the display width will be 80. Default is `X'.
EXEC_MODE - The mode of execution of the report. The choices are: 1. Submit to batch, output to file, 2. Submit to batch, output to print queue, 3. Do not submit to batch, output to file, 4. Do not submit to batch, output to print queue, 5. Do not submit to batch, output to screen. Default is `1. Submit to batch, output to file'.
OUTPUT - This is the file name for output if `submit to file' is chosen in execute mode. Default is `sys$login:.lis'.

A.3.2 Set print parameters logicals

For a complete explanation of these logicals see the field descriptions beginning in Section 7.15.2.4. The logicals associated with setting the print parameters of a report job begin with the prefix MCL_RPT_PRINT_ appended to:

AFTER - The time, after which the job will be executed. The default is the current date and time.
BURST_PAGE - Flag designating print burst page at beginning of report.
DELETE_FILE - Flag indicating to delete the print file after job execution.
FLAG_PAGE - Flag indicating print flag page after execution.
FORM_FEEDS - Flag indicating insert form feeds into a report.
FORM_NAME - The name of the form used in printing the report.
HOLD_JOB - Flag indicating place the job in pending state.
JOB_NAME - Defines the job name in the queue.
LOWERCASE - Flag indicating some characters in the form are lowercase.
NOTE - The note that will be printed on the banner page.
NOTIFY_USER - Flag indicating notify the user when done.
NUM_COPIES - The number of copies of the report to be printed. Default is `1'.
PRIORITY - The queue priority to be assigned to the job.
QUEUE_CHAR - This is a single known characteristic name that is to be associated with the job when it is printed.
QUEUE_NAME - This defines the job name that is to be assigned this report generation job when it is in the print execution queue. Default is `sys$print'.
TRAILER_PAGE - Flag indicating print trailer page at end of report.

A.3.3 Set submit parameters logicals

For a complete explanation of these logicals see the field descriptions beginning on Section 7.15.2.3. The logicals associated with setting the submit parameters of a report job begin with the prefix MCL_RPT_SUBMIT_ appended to:

AFTER - The time, after which the job will be executed. The default is the current date and time.
CREATE_LOG - Flag indicating create a log file using the specified name or a default name. Default is `X'.
DELETE_COM - Flag indicating delete the job temporary COM file on completion. Default is `X'.
HOLD_JOB - Flag indicating place the job in the PENDING state on entering into the batch queue.
JOB_NAME - This defines the job name that is to be assigned this report generation job when it is in the batch execution queue.
KEEP_LOG - Flag indicating keep the log file on line after the job finishes. Default is `X'.
LOG_FILE - This indicates where to place and what to name the the report log file that is created during report generation.
NOTIFY_USER - Flag indicating notify you, by beep and message, when the submit job is completed.
PRIORITY - This specifies what queue priority to assign this job when it is inserted into the batch queue for execution.
QUEUE_CHAR - This is a single known characteristic name that is to be associated with the job when it is submitted.
QUEUE_NAME - This defines what batch queue the report generation job is to be placed in for execution. Default is `sys$batch'.
SUBMIT_LOG - Flag indicating print the log file after the job finishes.
WORK_DEFAULT - This defines for a batch job a working set default, the default number of physical pages that the job can use.
WORK_EXTENT - This defines for the batch job a working set extent, the maximum amount of physical memory that the job can use.
WORK_QUOTA - This defines for the batch job a working set quota, the amount of physical memory that the job is guaranteed.

A.4 MCL workstation logicals

A series of logicals are used by MCL system when used on a workstation. Some of these are established in the file MCL_LIBRARY:MCL_DECW_START.COM. The various logicals are listed below:

MCL_DECW_FONT_FIXED_MEDIUM - This defines the font to use for all medium fixed pitch displays.
MCL_DECW_FONT_FIXED_BOLD - This defines the font to use for all bold fixed pitch displays.
MCL_DECW_FONT_VARIABLE_MEDIUM - This defines the font to use for all medium variable pitch displays.
MCL_DECW_FONT_VARIABLE_BOLD - This defines the font to use for all bold variable pitch displays.
MCL_DECW_FONT_COLOR_MEDIUM - This defines the color to use with the medium font.
MCL_DECW_FONT_COLOR_BOLD - This defines the color to use with the bold font.
MCL_DECW_COLOR_MAIN_FORE[_N] - This defines the color to use in the foreground of each window.
MCL_DECW_COLOR_MAIN_BACK[_N] - This defines the color to use in the background of each window.
MCL_DECW_COLOR_MAIN_HIGH[_N] - This defines the color to use for highlighting in a window.
MCL_DECW_COLOR_BUT_FORE[_N] - This defines the color to use in the foreground of a button.
MCL_DECW_COLOR_BUT_BACK[_N] - This defines the color to use in the background of each button.
MCL_DECW_COLOR_BUT_HIGH[_N] - This defines the color to use for highlighting in a button.
MCL_DECW_COLOR_BW_BACK[_N] - This defines the color selections on a monochrome workstation. This logical can one of two values "black" or "white".
MCL_DECW_KEYBOARD - This defines the keyboard translation table to use when using a workstation. The MCL system is capable of mapping all keys on the keyboard to any letter or function. The default value for this logical is "ENGLISH_TP_KEYBOARD". If a SYS_$LANGUAGE logical is found the equivalence is used to replace the word ENGLISH.

In some of the above logicals the sym "_n" has been added on the right. The MCL system has the ability to startup multiple sessions inside of one process (just enter [Ctrl] [C] or [F6]). Each session can have its own color definitions. For example, by adding ``_2'' to the logicals they then define the attributes for session 2.

Contents

Index

MEDIA General User's Guide

Part 5REPORT Reference

Part 6APPENDICES