Online Facilities

Overview

The Online facility is the basic means of communication between the user and Control-M/Tape.

Online definition facilities allow you to view the status of all parameters relating to a specific rule, pool, or vault definition, or a group of rules, pools or vault definitions.

The Inquiry/Update screen allows authorized users to view and modify information concerning all media managed by Control-M/Tape.

The following topics describe the main features available under the Online facility.

IOA Features

This section discusses the IOA features common to all INCONTROL products.

General IOA Features

General IOA features include:

Customization

IOA screens, constants, messages, colors, commands, and PFKey definitions can be site-modified to adapt them to local needs.

INCONTROL products can be customized globally, that is, for the whole site, using the INCONTROL Installation and Customization Engine (ICE), according to profile variables defined during installation.

In addition, INCONTROL products can be customized to respond differently to individual users if these profile variables are specified in user profile members.

For example, depending on the setting of a variable in a particular user profile member, upon exit from a screen in which changes have been requested, this INCONTROL product may either perform the requested changes automatically or display a confirmation window before performing the changes.

Customization issues are discussed in the INCONTROL for z/OS Installation Guide.

Due to customization, the screens and examples illustrated in this guide may differ from the ones used at your site.

Environment Support

The Online facility can be activated under the following environments:

  • TSO (native)

  • TSO/ISPF

  • ROSCOE/ETSO

  • CICS

  • VTAM

  • IMS/DC

  • IDMS/DC

  • COM-PLETE

Cross memory interfaces (to the Online monitor) are optional under native TSO, TSO/ISPF, and ROSCOE/ETSO. They are always used under the other environments.

There are slight differences in the operation of the Online facility under the different environments. Special notes are provided in this guide where applicable.

Terminal Support

IOA supports the following models of IBM 3270 terminals:

  • Model 2 – 24 lines, 80 columns

  • Model 4 – 43 lines, 80 columns

  • Model 3 – 32 lines, 80 columns

  • Model 5 – 27 lines, 132 columns

When using the IOA online facility under IMS/DC and IDMS/DC, all model types display 24 lines and 80 columns.

IOA adjusts to the screen size in order to use the maximum available data area on the screen.

Special Character Usage on Terminals

In certain cases, special keyboard characters, such as $, #, and @, are assigned special meanings. The characters specified appear on standard American terminals but may not be available on other keyboards. In addition, some special characters on your keyboard may be assigned different hexadecimal values than the ones recognized by IOA. Special keyboard mapping requirements, and a complete discussion of the conventions used in this guide, are shown in Conventions Used in This Guide.

Color Support

When INCONTROL products are activated from a screen with extended seven-color support, they make extensive use of the color attributes of the screen. The concept of management by color is emphasized in INCONTROL screens.

Like all screen attributes, the color attribute for each field is defined externally to the program and can be locally modified by the site.

IOA does not automatically recognize IMS/DC and IDMS/DC terminals as supporting extended color attributes. If your IMS/DC or IDMS/DC terminal supports extended color attributes and you want IOA to recognize this, refer to the INCONTROL for z/OS Administrator Guide for more information.

At this time, IOA does not support extended color attributes under COM-PLETE.

Due to ISPF characteristics, color changes cannot occur in adjacent columns but must be separated by an attribute byte without color, that is, black. Therefore, some IOA screens have a different appearance under ISPF than under other online environments, such as native TSO and CICS.

Prefixing

For fields that automatically support prefixing, selection strings are always treated as prefixes. Selection is made if a segment of the text beginning with the first letter, that is, any prefix, matches the selection criterion.

If a field supports prefixing, this fact is indicated in its description.

Assume the following names exist: A3, A4, M, M01, M03, M12, M13, M22, M23, M30, M33, M103, M135, M301.

Table 18 Prefixing Examples

Pattern

Matching Value

blank

All of the above values

A

A3, A4

M

M, M01, M03, M12, M13, M22, M23, M30, M33, M103, M135, M301

M1

M12, M13, M103, M135

M13

M13, M135

Character Masking

If a field supports masking, this fact is indicated in its description.

For fields that support masking, the following masking characters are available:

  • * represents any number of characters, including no characters

  • ? represents any one character

For fields that do not automatically support prefixing, a prefix value can be specified by ending the selection string with an asterisk.

Assume the following names exist: A3, M, M3, M01, M03, M13, M23, M33, M103, M435, M2243.

Table 19 Masking Examples

Pattern

Matching Values

*

All the above values

M?3

M03, M13, M23, M33

M?3*

M03, M13, M23, M33, M435

M??3

M103

M*3

M3, M03, M13, M23, M33, M103, M2243

M*

M, M3, M01, M03, M13, M23, M33, M103, M435, M2243

Since the last character in this example is *, M is treated as a prefix.

IOA Entry Panel

Enter the IOA Online facility according to the instructions of your INCONTROL administrator. Upon entering the IOA Online facility, the IOA entry panel may be displayed.

Display of the IOA Entry Panel is optional. If your INCONTROL administrator determined that the entry panel is bypassed, the IOA Primary Option menu, which is discussed in the following section, is displayed.

Figure 2 IOA Entry Panel

Copy
---------------------------  IOA ENTRY PANEL  -------------------------------




                +-----------------------------------------------------------+
                |                                                           |
                |          USER ID      ===>                                |
                |                                                           |
                |          PASSWORD     ===>                                |
                |                                                           |
                |          NEW PASSWORD ===>           ===>                 |
                |                                                           |
                +-----------------------------------------------------------+








            PLEASE FILL IN USER ID AND PASSWORD AND PRESS ENTER             18.30.18

Type your user ID and password and press Enter. If you enter a correct user ID and password, the IOA Primary Option menu is displayed.

The IOA Online facility allows three attempts to enter a valid user ID and password combination. After the third unsuccessful attempt, the program is terminated.

To change a password, type the new password twice: Once in the NEW PASSWORD field and once in the confirmation field.

IOA Primary Option Menu

The IOA Primary Option menu is the primary interface to functions available under the various INCONTROL products. The options displayed in the menu depend on the INCONTROL products installed at the site, and the functions and facilities that have been authorized to you.

If only Control-M/Tape is active at your site, and you are authorized to access all functions and facilities, the following screen is displayed:

When the Online facility is activated as an ISPF application, option 6 is displayed as: "6 UTILITIES Online Utilities." In this case, option 6 activates the Online Utilities under ISPF. When the Online facility is not activated under TSO or TSO/ISPF, option 6 is inactive.

Figure 3 IOA Primary Option Menu when Only Control-M/Tape is Installed

Copy
---------------------       IOA PRIMARY OPTION MENU      -----------------(1  )
                OPTION ===>                                             USER        N22A
                DATE        19.08.01




                4   COND-RES          IOA Conditions/Resources Display
                5   LOG               IOA Log Display
                6   TSO               Enter TSO Command
                7   MANUAL COND       IOA Manual Conditions Display
                8   CALENDAR DEF      IOA Calendar Definition
                IV   VARIABLE DATABASE IOA Variable Database Definition Facility
                TR   RULE DEFINITION   CTT Rule Definition
                TP   POOL DEFINITION   CTT Pool Definition
                TV   VAULT DEFINITION  CTT Vault Definition
                TI   INQ/UPD MEDIA DB  CTT Media Database Inquire/Update
                TC   CHECK IN EXT VOL  CTT External Volume Check-In





            COMMANDS:  X - EXIT, HELP, INFO  OR CHOOSE A MENU OPTION            18.05.34 

To select an option, type the option number or letters in the OPTION field and press Enter. Alternatively, for a number option, press the PFKey of the same number. For example, to select the LOG option, press PF05/PF17.

Your INCONTROL administrator can limit the options displayed on a user-by-user basis and can alter option numbers and customize option descriptions. Product supplied options are discussed in this guide.

Certain IOA commands, functions, and facilities (options) are shared by all INCONTROL products. These shared IOA commands, functions and facilities are described later in this chapter, and outlined in Table 20.

Table 20 INCONTROL Shared IOA Functions and Facilities

Option

Function

Description

4

COND/RES

Display and update the status of the IOA Conditions file and the Control-M Resources file.

5

LOG

View audit trail information about jobs, missions, and rules scheduled under the supervision of INCONTROL products.

6

TSOa

Perform TSO commands.

7

MANUAL COND

Display the list of prerequisite conditions that must be confirmed manually by operations personnel.

8

CALENDAR DEF

Define scheduling calendars.

X

EXIT

Exit the Online facility.

INFO

INFO

Display a window in the IOA Primary Option Menu. The window contains information about installed INCONTROL products. For more details on the information displayed by this command, see IOA Version Information.

Entering =1 in the command line of any other screen returns you to the IOA Primary Option Menu that is displayed at your site.

These shared functions and facilities are described in further detail in this chapter.

The following functions (options) are applicable to Control-M/Tape:

Table 21 Control-M/Tape Functions and Facilities

Option

Function

Description

TR

RULE DEFINITION

Rule Definition.

TP

POOL DEFINITION

Pool Definition.

TV

VAULT DEFINITION

Vault Definition.

TI

INQ/UPD MEDIA DB

Inquire/Update screen.

TC

CHECK IN EXT VOL

Check In External Volume.

The following IOA Primary Option Menu is displayed at sites supporting all currently available INCONTROL products (under ISPF).

When the IOA online facility is activated as an ISPF application, option 6 is displayed as "6 UTILITIES Online Utilities." In this case, option 6 activates the Online utilities under ISPF. When the online facility is not activated under TSO or TSO/ISPF, option 6 is inactive.

Figure 4 IOA Primary Option Menu when all INCONTROL Products are Installed

Copy
---------------------       IOA PRIMARY OPTION MENU       ------------------(1)
                OPTION ===>                                               USER        N06     
                                                                              
                IOA                         CONTROL-D/V                CONTROL-O              
                                                                              
                4  COND-RES                A  MISSION STATUS         OR  RULE DEFINITION    
                5  LOG                     M  MISSION DEF            OM  MSG STATISTICS     
                6  TSO                     R  REPORT DEF             OS  RULE STATUS        
                7  MANUAL COND             T  RECIPIENT TREE         OL  AUTOMATION LOG     
                8  CALENDAR DEF            U  USER REPORTS           OA  AUTOMATION OPTS    
                IV  VARIABLE DATABASE       F  PC PACKET STATUS       OC  COSMOS STATUS      
                DO  OBJECTS                OK  KOA RECORDER       
                                                                              
                                                                              
                CONTROL-M & CTM/Restart     CONTROL-M/Analyzer        CONTROL-M/Tape          
                                                                              
                2  JOB SCHEDULE DEF       BB  BALANCING STATUS       TR  RULE DEFINITION    
                3  ACTIVE ENV.            BM  MISSION DEF            TP  POOL DEFINITION    
                C  CMEM DEFINITION        BV  DB VARIABLE DEF        TV  VAULT DEFINITION   
                W  WORKLOAD MANAGEMENT    BR  RULE DEFINITION        TI  INQ/UPD MEDIA DB   
                BA  RULE ACTIVITY          TC  CHECK IN EXT VOL   
                                                                              
                                                                              
            COMMANDS:  X - EXIT, HELP, INFO  OR CHOOSE A MENU OPTION               16.20.21

Entering =1 in the command line of any other screen returns you to the IOA Primary Option Menu that is displayed at your site.

For a description of the options for other INCONTROL products, see the user guides of the respective products.

Additional options available on the IOA Primary Option menu when operating Control-M/Tape with other INCONTROL products are listed below:

Table 22 IOA Primary Option Menu Options

Option

Name

Description

IV

VARIABLE DATABASE

Define, display and update IOA Database variables used by Control-O and Control-M.

Option IV is available only at sites where Control-O or CMEM are installed.

2

JOB SCHEDULE DEF

Define or modify job production parameters.

3

JOB STATUS

Display and update status of jobs scheduled under Control-M.

C

CMEM DEFINITION

Define or modify CMEM rules.

W

WORKLOAD MANAGEMENT

Define or modify Workload Policies and Load-Indexes.

Options 2, 3, C, and W are available only at sites where Control-M is installed.

A

MISSION STATUS

Display and update active missions status.

M

MISSION DEF

Define migration, printing, backup, and restore missions.

R

REPORT DEF

Define decollating missions (including indexing).

T

RECIPIENT TREE

Display and update the Recipient Tree.

U

USER REPORTS

Display and update the status of user reports. View reports online.

F

PC PACKET STATUS

Display the status of reports (packets) scheduled for transfer from the mainframe to a PC.

DO

OBJECTS

Manage Control-D objects.

Options A, M, R, T, U, F, and DO are available only at sites where Control-D or Control-V are installed.

BB

BALANCING STATUS

Display and update the status of active balancing missions.

BM

MISSION DEF

Define balancing missions.

BV

DB VARIABLE DEF

Define, display and update Database variables.

BR

RULE DEFINITION

Define balancing rules.

BA

RULE ACTIVITY

Display rule activity and the result of invoking Control-M/Analyzer rules.

Options BB, BM, BV, BR, and BA are available only at sites where Control-M/Analyzer is installed.

OR

RULE DEFINITION

Define rules.

OM

MSG STATISTICS

View message statistics.

OS

RULE STATUS

View Rule Status screen.

OL

AUTOMATION LOG

Display commands, messages and/or traces.

OA

AUTOMATION OPTS

Display available operator productivity tools.

OC

COSMOS STATUS

Display or modify the status of COSMOS-controlled objects and databases.

OK

KOA RECORDER

Record VTAM scripts

Options OR, OM, OS, OL, OA, OV, OC, and OK are available only at sites where Control-O is installed.

IOA Version Information

Enter INFO (or I) in the OPTION Ffield of the IOA Primary Option menu to display the IOA Version Information window, as illustrated in Figure 5. This window lists the version and level of each INCONTROL product installed at the site, plus the CPU ID and current system date. The IOA Version Information window also identifies the unique IOA QNAME assigned to the site. For further information about the IOA QNAME, see the IOA operational parameters step, the IOAPLEX parameters step, and the adding IOA structures to the CFRM step, all in the INCONTROL for z/OS Installation Guide. Press Enter or END (PF03/PF15) to exit the window and return to the IOA Primary Option menu.

Figure 5 IOA Version Information

Copy
---------------------       IOA PRIMARY OPTION MENU       ------------------(1)
                OPTION ===>                                               USER        N06

                IOA                        CONTROL-D/V                CONTROL-O
                +----------------------------------------------+
                4  COND-RES   |             IOA VERSION INFORMATION          | EFINITION
                5  LOG        |                                              | ATISTICS
                6  TSO        |   IOA                  Version 6.1.00        | TATUS
                7  MANUAL CON |   IOAGATE              Version 6.1.00        | TION LOG
                8  CALENDAR D |   CONTROL-M            Version 6.1.00        | TION OPTS
                IV  VARIABLE D |   CONTROL-M/RESTART    Version 6.1.00        |  STATUS
                |   CONTROL-M/ANALYZER   Version 6.1.00        | CORDER
                |   CONTROL-M/TAPE       Version 6.1.00        |
                |   CONTROL-D            Version 6.1.00        |
                CONTROL-M & CTM |   CONTROL-V            Version 6.1.00        | ape
                |   CONTROL-O            Version 6.1.00        |
                2  JOB SCHEDU |                                              | EFINITION
                3  ACTIVE ENV |                                              | EFINITION
                C  CMEM DEFIN |   DATE  19.08.01  CPUID  02078D 7060         | DEFINITION
                |   IOA QNAME  IOAR610                         | D MEDIA DB
                |                                              | IN EXT VOL
                +----------------------------------------------+
            COMMANDS:  X - EXIT, HELP, INFO  OR CHOOSE A MENU OPTION               17.00.29

Multi-Screen Control

It is not necessary to return to the IOA Primary Option menu to move from one online facility to another.

To speed up transfer of control between screens of different facilities and to enable you to manage several online facilities at the same time, transfer control commands can be specified. Transfer commands take you directly from your current screen to the requested screen. Transfer commands can be used to reach any screen that can be accessed by the IOA Primary Option menu at your site.

Each transfer control command consists of an equal sign immediately followed by one of the options of the IOA Primary Option menu, which represents the target screen of the transfer. For example, from any screen, enter:

Table 23 IOA Transfer Control Commands

Command

Description

=5

to access the IOA Log screen

=4

to access the IOA Conditions/Resources screen

=1

to access the IOA Primary Option menu

If you use a transfer command to reach another screen, the state of the current screen remains unchanged when you return to it by another transfer command.

The INCONTROL administrator can globally deactivate any or all of the transfer commands.

Fast Exit from the IOA Online Facility

To exit immediately from the IOA Online facility, type =X on the command line and press Enter.

In most cases, the =X command has the same effect as pressing END (PF03/PF15) in all open screens and then entering X (Exit) in the IOA Primary Option menu. Any window, such as the Exit Option window, that would be displayed when exiting an open screen is displayed when the =X command is entered.

However, when the =X command is entered while definition screens such as the Calendar Definition screen are open, changes to the open definition screens are cancelled. Changes currently in definition facility list screens, for example, changes to previously closed definition screens, are not cancelled. Those screens and all other open screens are treated as if END (PF03/PF15) has been entered.

The =X command is intentionally not supported on certain screens.

Screen Layout

Most IOA screens are divided into four basic areas. The example used in this section is the IOA Log screen.

Table 24 Basic IOA Screen Areas

Screen Area

Description

Screen Description and Message Line

This line at the top of the screen describes the purpose of the screen (in the example screen, "IOA Log"). A screen identifier may appear in the upper right corner (in the example screen, 5). This line is also used to display messages.

Screen Header and Command Area

This area is used for online commands, and, where applicable, headings of the screen data.

Data Area

On some screens, the data area can be scrolled. For more information, see Scrolling Commands.

Screen Bottom

This area of the screen usually contains a list of available commands or options (In the example screen, SHOW, GROUP, CATEGORY, and SHPF), or a brief explanation about screen usage. The current time is displayed in the lower right corner.

Figure 6 IOA Log Screen

Copy
FILTER:            ---------------- IOA LOG  -------------------------------(5)
                COMMAND ===>                                                    SCROLL===> CRSR
                SHOW LIMIT ON ==>                                          DATE 291201 - 010102
                DATE   TIME   ODATE  USERID   CODE    ------ M E S S A G E --------------------
                311201 184915 311201 K48      SUB13AI JOB K48RUN1 / OID=005W9 SUBMITTER STARTED
                PROCESSING JOB ON SYSTEM: OS35         
                311201 184915 311201 K48      SUB133I JOB K48RUN1 K48RUN /27255 OID=005W9     
                SUBMITTED FROM LIBRARY (P) K48.LIB.JOB  
                311201 184918 311201 K48      SPY28GI JOB K48RUN1 K48RUN /27255 OID=005W9 TAPE
                DRIVE UNITS USED=00 00                  
                311201 184918 311201 K48      SPY281I JOB K48RUN1 K48RUN /27255 OID=005W9 START
                01365.1849 STOP 01365.1849 CPU 0MIN    
                00.05SEC SRB 0MIN 00.00SEC 0.00 4AOS35  
                311201 184918 311201 K48      SPY254I JOB K48RUN1 K48RUN /27255 OID=005W9     
                SCANNED                                 
                311201 184918 311201 K48      SEL216W JOB K48RUN1 K48RUN /27255 OID=005W9     
                UNEXPLAINED COND CODE 0015 STEP EXEC /  
                311201 184918 311201 K48      SEL214I JOB K48RUN1 K48RUN /27255 OID=005W9 RERUN
                NEEDED                                 
                311201 184918 311201 K48      SEL205I JOB K48RUN1 K48RUN /27255 OID=005W9 RERUN
                IN PROCESS USING MEM K48RUN1           
                311201 184918 311201 K48      SEL286I JOB K48RUN1 K48RUN /27255 OID=005W9     
                WAITING FOR CONFIRMATION                
                CMDS: SHOW, GROUP, CATEGORY, SHPF                                      08.57.11
            

Commands and PFKeys

Commands are entered by typing a command in the COMMAND field and then pressing Enter, or by pressing a predefined PFKey, or a combination of both.

It is not necessary to enter the full command name; the shortest unique abbreviation of the command is sufficient. If the abbreviation is ambiguous, an appropriate message is displayed in the message area.

IOA commands are flexible; you can change command syntax or provide aliases (synonyms) to suit your site. If you want to add or change a command syntax, consult BMC Customer Support. The examples provided in this chapter exhibit the original command syntax supplied with this INCONTROL product.

PFKey command assignments can be site-customized. It is possible to assign PFKeys differently for each screen. To change PFKey command assignments, see your INCONTROL administrator.

Supplied PFKey definitions are consistent throughout most of the screens. For example: PF08/PF20 is used to scroll down (forward) on all INCONTROL screens where scrolling is possible.

Table 25 Common PFKey Definitions

PFKey

Description

PF01/PF13

HELP

PF02/PF14

SHOW (where applicable)a

PF03/PF15

END – exit current screen and go back one level

PF04/PF16

RESET (where applicable)

PF05/PF17

FIND (where applicable)

PF06/PF18

=6 – transfer to TSO screen/application or to UTILITIES screenb

PF07/PF19

UP – scroll backward

PF08/PF20

DOWN – scroll forward

PF10/PF22

LEFT or PREV (where applicable)

PF11/PF23

RIGHT or NEXT (where applicable)

PF12

RETRIEVE – retrieves a sequence of commands and options entered by the user during the current session. These commands and options are displayed in reverse order on the command line of the current screen.

PF24

SHPF

To see the PFKey assignment of the screen with which you are working, type reserved command SHPF in the command line and press Enter. A window describing the current PFKey assignment appears on the screen. Press Enter again to close the window.

Figure 7 PFKey Assignment Window

Copy
FILTER:            ---------------- IOA LOG  -------------------------------(5)
                COMMAND ===>                                                    SCROLL===> CRSR
                SHOW LIMIT ON ==>                                          DATE 291201 - 010102
                DATE   TIME   ODATE  USERID   CODE    ------ M E S S A G E --------------------
                311201 184915 311201 K48      SUB13AI JOB K48RUN1 / OID=005W9 SUBMITTER STARTED
                PROCESSING JOB ON SYSTEM: OS35         
                311201 184915 311201 K48      SUB133I JOB K48RUN1 K48RUN /27255 OID=005W9     
                SUBMITTED FROM LIBRARY (P) K48.LIB.JOB  
                311201 184918 311201 K48      SPY28GI JOB K48RUN1 K48RUN /27255 OID=005W9 TAPE
                DRIVE UNITS USED=00 00                  
                311201 184918 311201 K48      SPY281I JOB K48RUN1 K48RUN /27255 OID=005W9 START
                +----------------------------------------------------------------------------+
                |                                                                            |
                |     ENTER ENTER                     PF13  HELP                             |
                |     PF01  HELP                      PF14  SHOW                             |
                |     PF02  SHOW                      PF15  END                              |
                |     PF03  END                       PF16  RESET                            |
                |     PF04  RESET                     PF17  FIND                             |
                |     PF05  FIND                      PF18  =6                               |
                |     PF06  =6                        PF19  UP                               |
                |     PF07  UP                        PF20  DOWN                             |
                |     PF08  DOWN                      PF24  SHPF                             |
                |     PF12  RETRIEVE                                                         |
            +----------------------------------------------------------------------------+

If you type text in the COMMAND field and press a PFKey, the text in the COMMAND field is treated as a subparameter of the command assigned to the PFKey.

Two additional key definitions are:

Table 26 Additional Key Assignments

Key

Description

PA1

ABORT – forced exit

If you press PA1 while in AutoRefresh mode (described in AutoRefresh Mode), AutoRefresh mode is canceled.

PA2

Under native TSO and ROSCOE, the first time you press this key, the screen is refreshed. The second consecutive time, a copy of the screen is sent to be printed, or to a file, using DD statement PRTDBG. For terminal models supporting PA3, the PA3 key is defined in exactly the same way as PA2.

When the IOA online facility is activated as an ISPF application, PA2 is controlled by ISPF, and only refreshes the screen. To print the screen, see IOA Under ISPF. Under other online environments, such as CICS and VTAM, PA2 serves as a refresh only. Usually one of the PA keys is assigned a local print function.

For information on changing IOA PFKey definitions, see the appendix in the INCONTROL for z/OS Administrator Guide, which deals with modifying IOA Online facility commands.

Scrolling Commands

Scrolling conventions are very similar to the ISPF conventions of IBM. Two basic commands are used for scrolling:  

Table 27 Scrolling Commands

Command

PFKey

Description

UP

(PF07/PF19)

Scroll up (backward).

DOWN

(PF08/PF20)

Scroll down (forward).

The commands can be entered by typing the command in the COMMAND field or by pressing the predefined PFKey.

The scrolling amount is determined by the content of the SCROLL field in the right corner of the screen header. Valid scrolling amounts are:

Table 28 Scrolling Amounts in the SCROLL Field

Scrolling Amount

Description

PAGE

Scroll a full page.

HALF

Scroll a half page.

CRSR

Scroll by cursor position. If the cursor is outside the data area, a full page is scrolled.

MAX

Scroll maximum available; for example, UP MAX scrolls to the top.

It is only necessary to type the first letter of the new amount in the SCROLL field in order to change the scrolling amount.

A scrolling amount other than that shown in the SCROLL field can be used by entering the amount directly after the scroll command itself, or by entering the scroll amount in the COMMAND field and pressing the appropriate scrolling PFKey. The scrolling amount in the SCROLL field remains unchanged.

If PAGE is the value in the SCROLL field, to scroll to the bottom, type M (MAX) in the COMMAND field and press PF08/PF20 (DOWN).

LOCATE Command

The LOCATE command, and its abbreviation, L, can be used to search for items in the NAME field in all "directory type" screens that contain scrollable data, such as the Calendar List screen. The syntax of the command is

LOCATE string

where string is the search string. Apostrophes (‘single quotes’) or quotation marks ("double quotes") are not required.

The search proceeds from the top of the list to the first item in the list that starts with the specified string. The cursor is positioned on the OPTION field at the beginning of the line containing the string, if found, or on the OPTION field of the alphabetically closest preceding value if the specified value is not found.

FIND Command

The FIND command, and its abbreviation, F, can be used in all screens that contain scrollable data to find and display the next occurrence of a character string. The syntax of the command is

Copy
FIND string [fromcol] [tocol] [PREV]

where

  • string is the search string
    Mandatory.

  • fromcol is the first column in the search range
    Optional.

  • tocol is the last column in the search range
    Optional.

  • PREV is the indicator that the search must move backward, instead of forward, from the current cursor position
    Optional.

General Rules

If the string contains blanks, enclose the string with apostrophes (‘single quotes’) or quotation marks ("double quotes"). For example:

FIND 'WAIT SCHEDULE'

The column range searched can be limited by entering fromcol or tocol values, or by entering both fromcol and tocol values.

The search for the string proceeds from the current cursor position forward, or backward if PREV is entered. If the string is found, the cursor is positioned at the start of the string.

To repeat the find, to the next or previous occurrence of the string, press PF05/PF17.

The following situations outline where the FIND command can, or should, be further modified to enhance its functionality.

  • Some screens enable the user to limit the number of lines searched by a FIND command. This is discussed in the relevant screen descriptions.

  • In some screens, the FIND command does not detect information that is to the right or left of the information displayed in the monitor. To ensure detection of the desired string, the screen must be displayed in wraparound mode, when available, before executing the FIND command.

Text String Searches

The FIND command can also be used to search for text strings, in which case the command will find all instances of the string, regardless of whether the characters within the string are lowercase, uppercase, or mixed case. To search for a text string, include the letter T immediately before a quoted string.

For example,

FIND T'WAIT SCHEDULE'

will find WAIT SCHEDULE, and it will also find wait schedule, and Wait Schedule, and any other case variant.

Text string searches are the default. If your system default is for text strings, You do not need to include the T if you perform a text string search. Your INCONTROL administrator can change the default to character string. In this case you do not need to include the C if you perform a character string search.

Character String Searches

The FIND command can be used to search for character strings, in which case the command will find all instances of the string, but only where the string contains characters that match the case specified. To search for a character string, include the letter C immediately before a quoted string.

For example,

FIND C'WAIT SCHEDULE'

will find WAIT SCHEDULE, but it will not find wait schedule, or Wait Schedule, or any other case variant.

CANCEL and RESET Commands

CANCEL and RESET commands are entered in the COMMAND field.

The CANCEL command cancels changes made in a definition screen, such as the IOA Calendar Definition screen, and exits the screen.

The RESET command (PF04/PF16) cancels Edit environment options specified in a definition screen. It does not cancel changes already made and it does not exit the screen or cancel Edit environment mode. For more information about the Edit environment, see Editing Rule Definitions in the IOA Edit Environment.

The RESET command (PF04/PF16) can also be used in most windows, for example, the Show Screen Filter window, to cancel changes and close the window.

Online Help

The following types of online help are available for INCONTROL screens:

Screen Help

Provides information about the entire screen. This help is available on all INCONTROL screens and is accessed by pressing the HELP key (PF01/PF13) while the cursor is positioned on the COMMAND field in the screen.

Line-Sensitive Help

Provides information about the fields on a particular line on a screen. This help is available on several INCONTROL screens. It is accessed by pressing the HELP key (PF01/PF13) while the cursor is positioned on the desired line of the screen.

Figure 8 IOA Help Screen

Copy
------------------------------ IOA HELP SCREEN --------------------- (CTMHDT2 )
                COMMAND ===>                                                    SCROLL===> CRSR
                                                                             
                Calendar List Screen                                                       
                ====================                                                       
                                                                             
                The Calendar List screen displays a list of calendars (members) in the     
                specified library. This screen can be entered directly from the entry      
                panel or upon exiting the Year List screen.                                
                                                                             
                By default, only calendar names are listed in the screen. However, if      
                the default has been modified at time of installation, statistical         
                information is displayed for each calendar name.                           
                                                                             
                Use the scrolling PFKeys to scroll forward (PF08/PF20) and backward        
                (PF07/PF19) on the Calendar List.                                          
                                                                             
                To return to the entry panel, press END (PF03/PF15).                       
                                                                             
                                                                             
                Options of the Calendar List Screen                                        
                -----------------------------------                                        
                To request one of the following options, specify the option in the OPT 
                ENTER END OR PF03/PF15 TO EXIT THE HELP SCREEN                         08.55.40
            

If line-sensitive help is not supported in a screen, pressing the HELP key (PF01/PF13) from anywhere in the screen displays the beginning of the Help panel.

Help can be scrolled using standard scrolling conventions.

To return to the original screen, use the END command (PF03/PF15).

The Help member name appears on the right in the Help screen header. Members containing the Help descriptions can be found in the IOA MSG library.

AutoRefresh Mode

Certain INCONTROL screens, as noted in this chapter where appropriate, support AutoRefresh mode. A screen display in AutoRefresh mode is automatically updated periodically with the most current data.

AutoRefresh mode can only be activated under native TSO or under ISPF. AutoRefresh mode is activated by the AUTO command. The format of the command is

AUTO n

where n is any number of seconds from 1 through 99.

The screen is updated when the AUTO command is issued, and then periodically updated according to the interval (in seconds) specified in the AUTO command. A counter at the top of the screen displays the number of times the screen has been refreshed.

The AUTO 5 command refreshes the screen every 5 seconds.

Cancelling AutoRefresh Mode

Under native TSO, the recommended method of cancelling AutoRefresh mode is as follows:

  • For short interval values – Press Enter. Whenever Enter is pressed, or a command is issued, AutoRefresh mode is automatically cancelled at the end of the current interval.

  • For long interval values – Press Attn (PA1) once.

Under ISPF, press Attn (PA1) or Esc once to cancel AutoRefresh mode.

When using a terminal emulation program, you must ensure that the Esc key is properly mapped and sent as an Attn (PA1) key.

IOA Under ISPF

The IOA Online facility can be activated as an ISPF application. As such, it can work in ISPF split screen mode like any other ISPF application.

WARNING: Multiple calls to the IOA ISPF interface can be performed in ISPF split screen mode as long as all invocations are for the same IOA environment. Otherwise, the results may be unpredictable.

The command line of the IOA Online facility is controlled by IOA. It is not possible to enter ISPF commands in an IOA screen. Two ISPF commands must be defined to PFKeys:

Table 29 ISPF Commands that must be defined for PFKeys

Command

PFkey

SPLIT

(usually PF02/PF14)

SWAP

(usually PF09/PF21)

The rest of the PFKeys are controlled by IOA PFKey definitions, which are in the IOA PARM library.

It is possible to assign TSO/ISPF commands such as PRINT to PFKeys, or to change PFKey definitions by performing the following steps:

  1. Exit from IOA and ISPF to the READY prompt.

  2. Type the following command and press Enter:

    Copy
    ISPSTART PANEL(ISR@PRIM) NEWAPPL(CTM)

    This command brings you to ISPF.

  3. Type the KEYS command and press Enter. A set of key definitions is displayed.

  4. Modify the key definitions as desired and exit from ISPF.

ISPF KEY definitions for the following ISPF commands take precedence over IOA PFKey definitions: SPLIT, SWAP, KEYS, PRINT, PFSHOW. For example, if PF02 is defined as SPLIT in ISPF, an IOA definition for PF02 is ignored in online screens.

For all other ISPF commands, such as UP or DOWN, the key definitions in ISPF are ignored and the PFKey is interpreted according to the definition in the IOA Online facility.

Under ISPF, IOA Option 6 activates the Online Utilities panel, which is described in IOA Online Utilities Menu. For more information about these utilities, see the INCONTROL for z/OS Utilities Guide.

For more information on changing IOA PFKey definitions, see the appendix in the INCONTROL for z/OS Administrator Guide that deals with modifying IOA Online Facility Commands.

IOA Editor

The IOA Editor enables you to edit members of a partitioned data set (PDS) using an editor similar to the ISPF editor. Enter EDMEM in the command line of any screen to display the Edit Entry Panel window, as shown in Figure 9.

Figure 9 IOA Editor Edit Entry Panel

Copy
---------------------       IOA PRIMARY OPTION MENU       ------------------(1)
                OPTION ===>                                               USER        N06     
                                                                              
                IOA                        CONTROL-D/V                CONTROL-O               
                                                                              
                4  COND/RES                A  MISSION STATUS         OR  RULE DEFINITION    
                5  +--------------------------------------------------------------+ICS      
                6  |                     EDIT ENTRY PANEL                         |         
                7  |                                                              |LOG      
                8  | LIBRARY ==>                                                  |OPTS     
                IV  |                                                              |US       
                | MEMBER  ==>                                                  |R        
                |                                                              |         
                | FILL IN PARAMETERS AND PRESS ENTER TO CONTINUE OR PF3 TO EXIT|         
                CONTR|                                                              |         
                +--------------------------------------------------------------+         
                2  JOB SCHEDULE DEF       BB  BALANCING STATUS       TR  RULE DEFINITION    
                3  ACTIVE ENV.            BM  MISSION DEF            TP  POOL DEFINITION    
                C  CMEM DEFINITION        BV  DB VARIABLE DEF        TV  VAULT DEFINITION   
                BR  RULE DEFINITION        TI  INQ/UPD MEDIA DB   
                BA  RULE ACTIVITY          TC  CHECK IN EXT VOL   
                                                                              
                                                                              
                COMMANDS:  X - EXIT, HELP, INFO  OR CHOOSE A MENU OPTION               19.12.05
            

To create a new member or edit an existing member, fill in the LIBRARY and MEMBER parameters and press Enter. The IOA Editor screen is opened for editing, as shown in Figure 10.

If the member already exists in the specified library, the member is displayed for editing in the IOA Editor. Similarly, if you accessed the IOA Editor screen from line option J in either screen 2 or screen 3, the member in the library referred to in the schedule definition member will be displayed for editing.

Figure 10 IOA Editor

Copy
----------------------------  I O A   E D I T O R   ------------------- (EDMEM)
                COMMAND ===>                                                    SCROLL===> CRSR
                ROW     PROD.V610.DEMO(TEST)                                        COL 001 072
                                                                              
                ......                                                                        
                ......                                                                        
                ......                                                                        
                ......                                                                        
                ......                                                                        
                ......                                                                        
                ......                                                                        
                ......                                                                        
                ......                                                                        
                ......                                                                        
                ************************ B O T T O M  O F  D A T A ************************** 
                                                                              
                                                                              
                                                                              
                                                                              
                                                                              
                                                                              
                                                                              
                                                                              
                OPTIONS:  I INSERT  D DELETE  R REPEAT  C COPY  M MOVE  UC/LC UPPER/LOWER CASE
            

IOA Editor PFKey Functions

While working within the IOA Editor, PFKeys perform the functions shown in Table 30:

Table 30 PFKey Functions Within the IOA Editor Screen

PFKey

Description

PF01/PF13

Activates online help.

PF02/PF14

Saves the current member.

PF03/PF15

Terminates the editing session. If the edited member has been changed the member will be saved automatically.

PF04/PF16

Cancels the editing session without saving changes.

PF05/PF17

Invokes the Find facility.

PF07/PF19

Scrolls forward.

PF08/PF20

Scrolls backward.

PF10/PF22

Scrolls left.

PF11/PF23

Scrolls right.

Commands of the IOA Editor Screen

Table 31 describes editing commands that can be executed by entering the command in the COMMAND line.

Table 31 IOA Editor Command Line Commands

Command

Description

SAVE

Saves all new data without terminating the edit session.

CANCEL

Terminates the edit session without saving new data.

COPY

Enables you to import a member from a specific library.

Table 32 describes editing commands that can be executed by entering the command in the leftmost position of the applicable row.

Table 32 IOA Editor Row Commands

Command

Description

I

Inserts a new line below the current line.
To insert more than one line for new data, enter Inn, where nn indicates the number of new lines to be inserted below the current line.

D

Deletes the current line.
To delete more than one line, enter Dnn, where nn indicates the number of lines to be deleted below the current line.
You can delete a block of lines by typing DD at the beginning of the first line of the block, and then entering DD at the beginning of the last line of the block.

R

Repeats the current line.
To repeat a single line one or more times, enter Rnn, where nn indicates the number of times the current line is to be repeated.
You can repeat a block of lines by typing RR at the beginning of the first line of the block, and then entering RR at the beginning of the last line of the block.

C

Identifies the source line for a copy operation.
To copy more than a single line, enter Cnn, where nn indicates the number of lines to be copied.
You can also copy a block of lines by typing CC at the beginning of the first line of the block, and then entering CC at the beginning of the last line of the block.

M

Identifies the source line for a move operation.
To move more than a single line, enter Mnn, where nn indicates the number of lines to be moved.
You can also move a block of lines by typing MM at the beginning of the first line of the block, and then entering MM at the beginning of the last line of the block.

A

Identifies the destination of a copy or move operation.
When a line or block of lines has been selected for copying or moving, enter A at the point after which the copied lines are to be inserted.

B

Identifies the destination of a copy or move operation.
When a line or block of lines has been selected for copying or moving, enter B at the point before which the moved lines are to be inserted.

LC

Changes text in a line from uppercase to lowercase.

To change text in more than a single line to lowercase, enter LCnn, where nn indicates the number of lines to be changed to lowercase.

UC

Changes text in a line from lowercase to uppercase.

To change text in more than a single line to uppercase, enter UCnn, where nn indicates the number of lines to be changed to uppercase.

IOA SET Command Panel

The IOA SET Command Panel enables you to set and stop TRACE levels, choose the language that is used in online screens and to set a dollar sign representation that will be used in online screens for system variables of type %%$VAR. Enter SET in the command line of any screen to display the SET Command Panel window, as shown in Figure 11.

Figure 11 IOA SET Command Panel

Copy
+-----------------------------------------------------------------------------------+
                |                        SET Command Panel                                          |
                |                                                                                   |
                |                                                                                   |
                |  TRACE level     , ON  (Trace level 001-512, ON or OFF)                           |
                |                                                                                   |
                |                                                                                   |
                |    LANGUAGE              ENG - English                                            |
                |                                      FRA - French                                 |
                |                                      GER - German                                 |
                |                                      JPN - Japanese                               |
                |                                                                                   |
                |                                                                                   |
                |    SPECIAL CHARACTERS: Dollar     Current representation is "$"(X'5B')            |
                |                                                                                   |
                |                                                                                   |
                | FILL IN PARAMETERS AND PRESS ENTER TO CONTINUE OR PF3 TO EXIT                     |
                |                                                                                   |
                +-----------------------------------------------------------------------------------+   
            

The process of setting TRACE levels and turning off a particular TRACE, and the process of setting language preferences for online screens and messages, begins in the SET Command Panel.

Using the SET Command Panel to set and end TRACE Levels

Setting the TRACE level can help you monitor certain IOA Online facility and INCONTROL functions, such as security checks.

The following steps explain how to set or turn off a TRACE level:

  1. Type a TRACE level number, from 1 through 256, in the TRACE level field of the SETCommand Panel.

  2. In the (Trace level 1-256, ON or OFF) field, type ON to set a TRACE level, or OFF to turn off a TRACE level.

  3. Press Enter to confirm the setting, in which case the following message is displayed:

    CTMA2AI TRACE LEVEL nnn WAS SET xxx

    where

    • nnn is the TRACE level number

    • xxx indicates whether the TRACE level was set ON or turned OFF

TRACE level settings take effect immediately.

Using the SET Command Panel to set a dollar sign representation

Setting the dollar sign representation influences how System variables are shown in online screens.

The following steps explain how to set the dollar sign representation:

  1. Type a $ character in the Dollar field using your keyboard.

  2. Press Enter to confirm the setting, in which case the following message is displayed:

    CTMA2DI THE NEW DOLLAR REPRESENTATION IS "c"(X'yy')

    where

    • c is $ character you set

    • yy is the EBCDIC hexadecimal code for $

There are differences in the EBCDIC hexadecimal code for the $ (dollar sign) character on keyboards that have been adapted to show local or national symbols.

Using the SET Command Panel to set Language Preferences

Setting the LANGUAGE influences the online screens and messages in subsequent sessions.

The following steps explain how to set language preferences:

  1. In the LANGUAGE field, type one of the following sets of characters to select a language preference:

    • ENG, to set English as the preferred language

    • FRA, to set French as the preferred language

    • GER, to set German as the preferred language

    • JPN, to set Japanese as the preferred language

  2. Press Enter to confirm the setting, in which case the following message is displayed:

Copy
CTMA27I THE NEW LANGUAGE WILL BE USED FROM THE NEXT LOGON TO IOA

Language preference settings do not take effect until your next logon to the system.

IOA TSO Command Processor Screen

The IOA TSO Command Processor screen can be entered only when the IOA Online facility is activated as a TSO application. It cannot be entered when the IOA Online facility is activated as an ISPF application or activated under a non-TSO environment.

The TSO screen enables activation of any TSO command without exiting the IOA Online facility. For example, a typical program activated under the TSO screen is ISPF. Therefore all ISPF/PDF facilities and functions, such as editing a member or scanning job output, can be activated while you are working under the IOA Online facility.

To activate a TSO command, type the command in the COMMAND field and press Enter.

Figure 12 IOA TSO Command Processor Screen

Copy
-------------------------- IOA TSO COMMAND PROCESSOR -----------------------(6)
                COMMAND ===> ISPF                                                              
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                PLEASE ENTER TSO COMMAND                                               15.32.52
            

CLISTs cannot be activated from the TSO screen. To activate a CLIST, first activate ISPF and then execute the CLIST under ISPF.

TSO commands can also be activated directly from any IOA online screen by typing TSO in the COMMAND field.

Transfer of Control Between the TSO Application and the IOA Online Facility

You can return to the IOA Online facility from the TSO application by simply exiting the TSO application in a normal manner. However, this method can be time consuming and inconvenient if an ISPF application or a similar TSO application is activated.

If the TSO application can issue a TSO command, it is possible to transfer control to the IOA Online facility, and vice versa, without exiting the TSO application.

While working under the TSO application, for example, under ISPF, issue the command:

TSO CTMTTRA {n | =n}

where n is the online screen number.

The requested screen is displayed as it was when you transferred from it.

To return to the TSO application, use the =6 command (PF06/PF18). The application remains in the same state as when you transferred from it.

It is recommended that you simplify transfer between screens by permanently assigning one of your PFKeys under ISPF (or SDSF, and so on) to the command TSO CTMTTRA. Once this key assignment is made, you no longer need to type the full transfer command. Instead, you merely type the IOA option number or code in the COMMAND field and press the assigned PFKey. You are transferred to the desired screen.

You must activate ISPF under the IOA Online facility if you want to use the control transfer feature.

Rule Definition Facility

The Control-M/Tape Rule Definition facility is composed of a series of screens that enable you to view, create, and modify rule definitions and parameters.

Rules are the main Control-M/Tape entities that manage media at your site. A rule is a user-defined list of instructions (parameters) whose execution is automatically triggered when specified media are accessed. Real-time media management processes and maintenance procedures can be tailored to meet your site’s needs through rule definitions.

Rule Definition

Rule definitions under Control-M/Tape are stored in libraries (partitioned data sets). A library contains rule tables (members), and each table contains rules (criteria) for media management functions. A rule table generally contains rules related to a specific topic, such as backups. Although most sites designate a primary rule definition library, the number of rule definition libraries you can use is unlimited.

The Control-M/Tape Rule Definition facility does not support members that have been compressed using the ISPF PACK option.a

rary, the number of rules in a table, and the size of each rule definition, are all calculated dynamically and are not dependent on parameter specification or optional ZAPs.

Accessing the Rule Definition Facility

The Rule Definition facility contains the following screens:

Table 33 Rule Definition Facility Screens

Screen

Description

Rule Definition Facility entry panel

Allows specification of parameters that determine which screen is displayed.

Table List screen

Displays the list of tables (members) in the specified Rule library.

Rule List screen

Displays the list of rules in the selected table.

Rule Definition screen

Displays the parameters of the selected rule definition. This is the main screen of the facility.

To enter the Online Rule Definition facility, select option TR in the IOA Primary Option menu. The Control-M/Tape Rule Definition Facility entry panel is displayed.

Creating Tables

Tables can be created in any of the following ways:

  • By specifying the new table name in the entry panel and pressing Enter.

  • By using the SELECT command (described later) to specify the new table name in the Table List screen and pressing Enter.

As a result of using either of the above methods, a skeletal rule definition (meaning, one with most fields left blank) is displayed in the rule definition screen.

Fill in the blanks and save the screen entries. The table is created and the rule definition is the first and only definition in the Rule list of the table. As additional rule definitions are created in the table (described below), they are added to the list.

Upon exiting the Rule List screen, if changes were made in at least one rule definition, an Exit Option window is displayed. One field of the window displays the table name. This value can be changed to a new table name that creates a new table in which the rule definitions are saved.

Creating Rule Definitions

Rule definitions can be created using either of two basic methods:

  • A skeletal rule definition can be created by specifying the name of a new rule definition in the entry panel. (The table specified in the entry panel can be either a new or an existing table.) In this case, virtually all fields of the rule definition are empty.

  • A copy of an existing rule definition can be created using the INSERT option (described later) in the Rule List screen. In this case, most fields of the new rule definition have the same values as the fields in the copied rule definition.

Performing Operations on Tables and Rules

Many operations can be performed on tables and on the rule definitions in them. These operations are performed using commands and options in the various screens of the Rule Definition facility.

Below is a brief summary of some of the major operations possible within the facility. Additional options and commands are explained following the summary.

Accessing (Editing or Browsing) a Table and its Rules

A table (meaning, the rule definitions in the table) can be browsed or edited.

When browsed, the table cannot be modified or updated. When the table is edited, new rule definitions can be added and existing rule definitions can be modified or deleted.

Browsing, however, has advantages:

  • Access and exit are quicker than in editing.

  • Rule list and rule definitions that are in use by another user can be viewed.

  • Access for browsing might be granted, even though access for editing might be denied due to site security requirements.

To browse a table (and its rule list and rule definitions), use the BROWSE option in the Table List screen.

Specifying the table name in the entry panel, or using the SELECT option in the Table List screen, provides edit access.

Depending on user profile definitions, if the table requested for editing is in use, access is either granted in Browse mode, or access will not be granted.

Copying a Rule to Another Table

Rules can be copied from one table to another using the COPY option in the Rule List screen. For more information, see Copying Rules to Another Table.

Deleting a Table or a Rule

Unneeded rules can be deleted using the DELETE option in the Rule List screen. For more information, see Options of the Rule List Screen. Unneeded tables can be deleted using the DELETE option in the Table List screen. For more information, see Deleting Rule Table.

Saving Modifications

All changes made to a table and its rule definitions are kept in memory until the table is exited. Upon exiting the table, the user can choose to save or cancel the changes. For more information, see Exiting the Rule Definition Screen.

Rule Definition Entry Panel

The Rule Definition Entry Panel is displayed upon entering the Rule Definition facility (option TR in the IOA Primary Option menu).

Figure 13 Rule Definition Entry Panel

Copy
------------------ CONTROL-M/Tape RULE DEFINITION ENTRY PANEL -------------(TR)
                COMMAND ===>                                                                  
                                                                               
                                                                               
                                                                               
                SPECIFY LIBRARY, TABLE NAME, RULE NAME                                        
                                                                               
                LIBRARY   ===> CTTP.PROD.RULES                                               
                TABLE     ===>                      (Blank for table selection list)         
                RULE      ===>                      (Blank for rule selection list)          
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                AUTOMATIC  RULE  SORTING ===> Y     (Y/N)                                    
                SHOW SCHEDULING CRITERIA ===> Y     (Y/N)                                    
                SHOW RULE DOCUMENTATION  ===> N     (Y/N)                                    
                AUTO-SAVE DOCUMENTATION  ===> N     (Y/N)                                    
                                                                               
                                                                               
                                                                               
                                                                               
                USE THE COMMAND "SHPF" TO SEE PFK ASSIGNMENT                           10.08.05
            

If you use the selection list fields, their values are not erased until you exit the entry panel by pressing END (PF03/PF15).

To open the desired display

Fill in the LIBRARY, TABLE, and RULE fields.

To display the list of tables in a library

  1. Type the library name.

  2. Either leave the table name blank, or type part of a table name together with mask characters (* and ?).

  3. Press Enter.

To display the list of rules of a specific rule

  1. Type the library name.

  2. Type the table name.

  3. Press Enter.

If the table does not exist, the screen for defining a new rule in the table is displayed.

To display the details of a specific rule (Rule Definition screen)

  1. Type the library name.

  2. Type the table name.

  3. Type the rule name.

  4. Press Enter.

If the table does not exist, or if the rule for the specified table does not exist, the screen for defining a new rule in the table is displayed.

If you enter the screen for defining a new rule and want to leave the screen without defining a rule, use the CANCEL command.

To display the Search window

  1. Type the library name.

  2. Type the rule name.

  3. Either leave the table name blank, or type part of a table name together with mask characters (* and ?).

  4. Press Enter.

To create a new table

  1. Type the library name.

  2. Type a new table name.

  3. Press Enter

The Rule definition screen, for defining the first rule in the new table, is displayed.

Rule Display Criteria

You can modify the way rules are displayed based on the display criteria you select in the AUTOMATIC RULE SORTING, SHOW SCHEDULING CRITERIA, SHOW RULE DOCUMENTATION, and AUTO-SAVE DOCUMENTATION LIBRARY, TABLE, and RULE fields of the entry panel, as described below:

  • Type Y or N in the AUTOMATIC RULE SORTING field to determine whether newly created rules are placed in correct sort order. For more information, see Rule Order.

  • Type Y or N in the SHOW SCHEDULING CRITERIA field to determine whether the Basic Scheduling parameters for the rule are displayed when the rule is displayed. For more information, see "Display and Non-Display of Scheduling Criteria" in Commands of the Rule Definition Screen.

  • Type Y or N in the SHOW RULE DOMENTATION field to determine whether rule documentation lines are displayed when the rule is displayed. For more information, see Rule Documentation.

  • Type Y or N in the AUTO-SAVE DOCUMENTATION field to determine whether changes made to documentation are automatically saved (meaning, without special prompting) when updating the rule. For more information, see Rule Documentation.

Search Window

The Search window allows you to search for the specified rule in tables in the specified library. Tables in which the rule have been found are then displayed in the Rule List screen.

Figure 14 Rule Definition Entry Panel Search Window

Copy
----------------- CONTROL-M/TAPE RULE DEFINITION ENTRY PANEL---------------(TR)
                COMMAND ===>



                SPECIFY LIBRARY, TABLE NAME, RULE NAME

                LIBRARY ===> CTT.PROD.RULES
                TABLE      ===>                      (Blank for table selection list)
                RULE       ===>                      (Blank for rule selection list)
                +-------------------------------------------+
                |                                           |
                |    PLEASE SELECT ONE OF THE FOLLOWING:    |
                |                                           |
                |    1  - STOP SEARCH IMMEDIATELY           |
                AUTOMATIC  RULE  SORTING ===>    |    2  - ASK AGAIN AFTER 000010 TABLES     |
                SHOW SCHEDULING CRITERIA ===>    |    3  - UNCONDITIONAL SEARCH              |
                SHOW RULE DOCUMENTATION  ===>    |                                           |
                AUTO-SAVE DOCUMENTATION  ===>    |    NUMBER OF TABLES IN LIBRARY:  000010   |
                |    NUMBER OF SEARCHED TABLES :   000000   |
                |    NUMBER OF SELECTED TABLES:    000000   |
                |                                           |
                +-------------------------------------------+
                USE THE COMMAND "SHPF" TO SEE PFK ASSIGNMENT                           18.12.28
            

To close the Search Window without performing any action, press END (PF03/PF15).

To perform a search, select one of the following choices and press Enter:

Copy
3 – UNCONDITIONAL SEARCH

Searches all tables in the specified library.

The search continues uninterrupted unless and until you select option 1 (Stop Search Immediately).

Copy
2 – ASK AGAIN AFTER number TABLES

Searches the specified number of tables in the specified library, and then pauses. The search number can be modified. Default:10.

  • Continue the search by pressing Enter.

  • Stop the search by selecting option 1 (Stop Search Immediately).

If any members are found, the Rule List is displayed listing those tables.

During the search, the following information is displayed at the bottom of the window:

  • Number of tables in library. Lists the total number of tables in the specified library.

  • Number of searched tables. Lists the cumulative number of tables searched. For example, if you perform three searches with a specified number of 10, the figure displayed is 30.

  • Number of selected tables. Lists the cumulative number of tables selected that contain the rule being searched.

If any tables are selected during the search, the Rule List is displayed listing those tables. If no tables are selected, the Search Window is closed and a message is displayed.

Table List Screen

The Rule Table List screen displays a list of rule tables (members) in the specified library. You can enter this screen using the entry panel or when returning from the Rule List screen.

By default, only rule table names are listed in the screen. However, if the default has been modified at time of installation, statistical information is displayed with the rule table name (as shown below).

Figure 15 Rule Definition Facility Table List Screen

Copy
TABLES OF LIBRARY CTT.PROD.RULES                               ------------(TR)
                COMMAND ===>                                                    SCROLL===> CRSR
                OPT  NAME ------------ VV.MM  CREATED     CHANGED     SIZE  INIT   MOD   ID
                ACCTBKP           01.01 00/08/08 00/08/08 08:05    70    70     0 M17A
                ACCTVLT           01.01 00/11/10 00/11/10 20:18     9     9     0 M17A
                ACCTRET           01.01 00/08/08 00/08/08 09:17    41    41     0 M43A
                ACCTTAPE          01.01 00/08/08 00/08/08 09:27     5     5     0 M13A
                ADSCRTCH          01.01 00/08/08 00/08/08 08:05   180   180     0 M17A
                ADMBKP            01.01 00/08/08 00/08/08 13:34    14    14     0 M65
                ADMVLT            01.01 00/11/10 00/11/10 21:03    14    14     0 M44A
                ADMRET            01.01 00/11/10 00/11/10 21:09    14    14     0 M44
                ADMTAPE           01.01 00/07/07 00/07/07 18:05     5     5     0 M65
                ADM0001           01.01 00/05/05 00/10/10 13:34     9     9     0 M17A
                ADM0002           01.01 00/05/05 00/10/10 15:31    70    70     0 M72
                CART1200          01.01 00/05/05 00/10/10 00:11     9     9     0 M17A
                CART1300          01.01 00/07/07 00/07/07 15:31    14    14     0 M17A
                MAINT             01.01 00/11/10 00/11/10 13:34    41    41     0 M17A
                MAINTTAP          01.01 00/07/07 00/07/07 00:14     5     5     0 M17A
                MAINTCAR          01.01 00/11/10 00/11/10 11:28    14    14     0 M17A
                ======= >>>>>>>>>>>>>>>> NO MORE TABLES IN THIS LIBRARY <<<<<<<<<<<<<<<<< ====



                OPTIONS:  S SELECT   B BROWSE   D DELETE                               12.48.05
            

To scroll down the Rule Table list, press PF08/PF20. To scroll up the Rule Table list, press PF07/PF19.

To return to the entry panel, press END (PF03/PF15).

Options of the Rule Table List Screen

To request one of the following options, specify the option in the OPT field to the left of the rule table name and press Enter.

Table 34 Options of the Table List Screen

Option

Description

S (SELECT)

Display the list of rules in the rule table for any purpose, including editing and modification. Only one rule table can be selected at a time.

 

If the S (Select) option is specified in the Rule Table List screen for a table that is currently in use (selected) by another user, then depending on User profile parameter SSCHBRO, either the Rule List screen is not displayed (meaning, the Rule Table List screen remains displayed; this is the default), or the Rule List screen is displayed in Browse mode. In either case, an appropriate message is displayed.

B (BROWSE)

Display a list of rules in a rule table for browsing. Only one rule table can be selected at a time.

D (DELETE)

Delete the rule table (member) from the library. Multiple rule tables can be selected. A confirmation window is displayed. For more information, see Deleting Rule Table.

Users whose access to options has been limited by the INCONTROL administrator can only access the Browse option.

Deleting Rule Table

To delete tables, specify option D in the OPT field by the rule table names and press Enter.

The following confirmation window is displayed, in sequence, for each rule table selected for deletion:

Figure 16 Rule Definition Facility Delete Table Confirmation Window

Copy
TABLES OF LIBRARY CTT.PROD.RULES                               ------------(TR)
                COMMAND ===>                                                    SCROLL===> CRSR
                OPT  NAME ------------ VV.MM  CREATED     CHANGED     SIZE  INIT   MOD   ID
                ACCTBKP           01.01 00/08/08 00/08/08 08:05    70    70     0 M17A
                ACCTVLT                +--------------------------+ 9     9     0 M17A
                ACCTRET                |   CONFIRM DELETE OPTION  | 1    41     0 M43A
                D   ACCTTAPE   <-----------|               (Y/N)      | 5     5     0 M13A
                ADSCRTCH               +--------------------------+ 0   180     0 M17A
                ADMBKP            01.01 00/08/08 00/08/08 13:34    14    14     0 M65
                D   ADMVLT            01.01 00/11/10 00/11/10 21:03    14    14     0 M44A
                ADMRET            01.01 00/11/10 00/11/10 21:09    14    14     0 M44
                ADMTAPE           01.01 00/07/07 00/07/07 18:05     5     5     0 M65
                ADM0001           01.01 00/05/05 00/10/10 13:34     9     9     0 M17A
                ADM0002           01.01 00/05/05 00/10/10 15:31    70    70     0 M72
                CART1200          01.01 00/05/05 00/10/10 00:11     9     9     0 M17A
                D   CART1300          01.01 00/07/07 00/07/07 15:31    14    14     0 M17A
                MAINT             01.01 00/11/10 00/11/10 13:34    41    41     0 M17A
                MAINTTAP          01.01 00/07/07 00/07/07 00:14     5     5     0 M17A
                MAINTCAR          01.01 00/11/10 00/11/10 11:28    14    14     0 M17A
                ======= >>>>>>>>>>>>>>>> NO MORE TABLES IN THIS LIBRARY <<<<<<<<<<<<<<<<< ====



                OPTIONS:  S SELECT   B BROWSE   D DELETE                               12.48.00
            

Type Y (Yes) in the window to confirm the delete request.

Type N (No) in the window to cancel the delete request.

If PDSMAN is operational at your site, $$$SPACE members are not deleted.

A message is written to the IOA Log file for each rule table deleted.

Rule List Screen

The Rule List screen displays the list of rules in a specified library. This screen can be entered directly from the Rule Definition entry panel or the Rule Table List screen, or upon exiting from the Rule Definition screen.

If the S (Select) option is specified in the Rule Table List screen for a table that is currently in use (selected) by another user, then depending on User profile parameter SSCHBRO, either the Rule List screen is not displayed (meaning, the Rule Table List screen remains displayed; this is the default), or the Rule List screen is displayed in Browse mode. In either case, an appropriate message is displayed.

Figure 17 Rule Definition Rule List Screen

Copy
RULES OF LIBRARY: CTT.PROD.RULES                                TABLE: ADM0002
                COMMAND ===>                                                    SCROLL===> CRSR
                OPT  RULE ----------------- DESCRIPTION ---------------------------------------
                ADMCLEAN   CLEAN-UP OF EXPIRED TAPES AND CARTRIDGES
                JOB0012    SET VAULT PATTERN OF JOB0012 VOLUMES
                JOB0013    SET VAULT PATTERN OF JOB0013 VOLUMES
                JOB0099    SET VAULT PATTERN OF JOB0099 VOLUMES
                M38SCRT    SCRATCH OF OUTDATED M38 TAPES
                M43SCRT    SCRATCH OF OUTDATED M43 TAPES
                MODRES     MODIFY RESOURCE COUNT
                MNTCHK     MOUNT CHECK - FORCE CERTAIN CONTROL-M JOBS
                SHOUTSCR   SHOUT ON SCRATCH OF CERTAIN JCL ACCOUNTS
                ======= >>>>>>>>>>>>>>>>> NO MORE RULES IN THIS TABLE <<<<<<<<<<<<<<<<<<< ====









                OPTIONS:  S SELECT   D DELETE   I INSERT   C COPY                      12.48.40
            

The Rule list is displayed either in sorted or unsorted order, depending on the value of the AUTOMATIC RULE SORT field in the Rule Definition entry panel. For more information about rule sorting, see Rule Order.

If the Rule list was previously displayed in unsorted order but is currently sorted (due to the setting of the AUTOMATIC RULE SORT field in the Rule Definition entry Panel), an appropriate message is displayed at the top of the screen as a reminder.

Use the scrolling PFKeys to scroll the Rule list forward (PF08/PF20) and backward (PF07/PF19).

To exit the Rule List screen, press END (PF03/PF15). For more information see Exiting the Rule List Screen.

Format of the Rule List Screen

Next to each rule name in the Rule list, certain information can be displayed. The type and format of this information depends on whether the screen is displayed in DATA format, DESC format, or STAT format:

  • In DESC format, the rule’s description, taken from the DESC field of the rule definition, is displayed. Default.

  • In DATA format, the rule’s application and group names, taken from the APPL and GROUP fields of the rule definition, are displayed.

  • In STAT format, the rule’s ISPF statistical information is displayed.

By default, the rule list is displayed in DESC format. To change formats, use the DESC, DATA or STAT commands, described below.

Commands of the Rule List Screen

The following commands can be specified in the COMMAND field of the Rule List screen.

Table 35 Commands of the Rule List Screen

Command

Description

DESC

Command DESC displays the rule description next to the rule name. The description is taken from the DESC field in the rule definition.

DATA

Command DATA displays the rule’s SEQUENCE PRIORITY (PRI), DATASET, and JOBNAME values from the rule definition, as well as the MORE field. If MORE is set to Y, then the rule definition contains ON parameters other than DATASET and JOBNAME. For more information on these and other fields in the Rule Definition Screen, see the description in General Rule Parameters.

STAT

Command STAT displays the following ISPF-like statistical information about the rule next to the rule name: version and modification numbers, creation date, last modification date, and user ID.

Options of the Rule List Screen

Specify one of the following rule processing options by marking the option to the left of the rule name and pressing Enter:

If the Rule List screen is displayed in Browse mode, options D (Delete) and I (Insert) are not available.

Table 36 Options of the Rule List Screen

Option

Description

S (SELECT)

Display the Rule Definition screen, that contains details of the selected rule.

If the Rule List screen is not displayed in Browse mode, the rule definition can be edited and updated. If the Rule List screen is displayed in Browse mode, the rule definition can only be browsed; it cannot be modified.

D (DELETE)

Delete a rule from the Rule list.

I (INSERT)

Insert a new rule in the Rule list. The Rule Definition screen appears with the same parameter values of the rule marked "I", but the RULE NAME and DESCRIPTION parameters are empty for you to fill in. The new rule is added after the rule marked "I" if Automatic Rule Sort is disabled. Otherwise, the rule is inserted in its correct place in the sort. For more information, see Rule Order.

C (COPY)

Copy the rule to another table (described later in this chapter). Multiple rules can be selected.

Deleting Rules

To delete rules, specify option D in the OPT field to the left of the rule names and press Enter.

The rule is removed. When you exit the Rule List screen, a confirmation window is displayed:

Figure 18 Delete Rule Confirmation Window

Copy
RULES OF LIBRARY: CTT.PROD.RULES                                TABLE: SYSTEM
        COMMAND -----------------------------------------------------------N ===> CRSR
          OPT   R |                  PLEASE SELECT EXIT OPTION             |  --------
                G |                                                        |
                U |     SAVE    CREATE                                     |
                U |                                                        |
                G |     LIBRARY CTT.PROD.RULES                             |
                B |     TABLE   SYSTEM                                     |
                B |                                                        |
                B D----------------------------------------------------------M            
                BACK2A     BACKUP WITH STACKING
     
     
     
     
     
     
                ======= >>>>>>>>>>>>>>>>> NO MORE RULES IN THIS TABLE <<<<<<<<<<<<<<<<<<< ====
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                OPTIONS:  S SELECT   D DELETE   I INSERT   C COPY                      11.09.51
            

Enter Y (Yes) in the SAVE field to delete the rules and exit the screen.

Enter N (No) in the SAVE field to cancel the deletion request and exit the screen.

Copying Rules to Another Table

To copy one or more rules from the current table to another table, specify opinion C (Copy) by the rule names in the Rule List screen and press Enter. The following is displayed:).

Figure 19 Rule List Screen Copy Window

Copy
RULES OF LIBRARY: CTTP.PROD.RULES                               TABLE: $DEFRETN
                COMMAND ===>                                                    SCROLL===> CRSR
                OPT  RULE ----------------- DESCRIPTION ---------------------------------------
                C   N65        DEFAULT RETENTION FROM TMOOPTXX                               
                DEFRULE    DEFAULT RETENTION FROM TMOOPTXX                               
                ======= >>>>>>>>>>>>>>>>> NO MORE RULES IN THIS TABLE <<<<<<<<<<<<<<<<<<< ====
                                                                               
                E-----------------------------------------------------------N   
                |                                                           |   
                |     SPECIFY DESTINATION LIBRARY, TABLE AND RULE NAME      |   
                |                                                           |   
                |  LIBRARY :  CTTP.PROD.RULES                               |   
                |  TABLE   :                                                |   
                |  RULE    :  N65                                           |   
                |                                                           |   
                |  PRESS END/RESET TO CANCEL     ENTER TO PERFORM THE COPY  |   
                D-----------------------------------------------------------M   
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                OPTIONS:  S SELECT   D DELETE   I INSERT   C COPY                      10.58.50
            

The window contains the following fields (some fields contain default values that can be modified):

Table 37 Fields of the Rule List Screen Copy Window

Field

Description

LIBRARY

Library containing the table into which the rule should be copied. Must be an existing library. Default: the current library

TABLE

 

Name of the table into which the rule should be copied.

A rule can only be copied to another table. It cannot be copied to its own table (even if the rule is renamed).

If the specified table does not exist, the table is created when the request is performed.

RULE

Name of the rule to be copied. If multiple rules are selected, the window is first displayed with the first selected rule. As each request is preformed or canceled, the next requested rule name appears.

To preform a request, press Enter.

To cancel a request, press END (PF03/PF15) or RESET (PF04/PF16).

Rule Definition Screen

The Rule Definition screen is used to define, display, and modify rule parameters for management of volumes and data sets. This screen can be entered directly from the entry panel or from the Rule List screen. Updating parameters is not permitted in Browse mode.

Rule parameters can fill more than one screen. Therefore, they are organized like a sheet of paper that can be "stretched" to any desired length. Use the scrolling conventions to scroll the rule parameters forward and backward.

The rule parameters are divided into the following basic groups:

Basic Scheduling Parameters (optional, see the DAYS through CONFCAL fields in Table 41 in Basic Scheduling Parameters).

The groups are separated by a delimiter line.

Figure 20 Rule Definition Screen

Copy
RULE: JOB0099  LIB CTT.PROD.RULES                               TABLE: ADM0002
                COMMAND ===>                                                    SCROLL===> CRSR
                +-----------------------------------------------------------------------------
                RULE NAME   JOB0099   GROUP PRODUCTION                MODE PROD (Prod/Test)
                OWNER       M43       SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)      
                DESCRIPTION SET VAULT PATTERN OF JOB0099 VOLUMES                           
                DOCMEM      JOBDOCS   DOCLIB CTT.PROD.DOC                                  
                ===========================================================================
                ON DATASET   = *                                               And/Or/Not  
                ===========================================================================
                DO VAULT     = VAULTA                                                      
                UNTIL     DATE           0101 YEAR 1999                   And/Or    
                VAULT     = VAULTB                                                      
                UNTIL     DATE           0101 YEAR 2000                   And/Or
                VAULT     = MAINLIB                                                     
                UNTIL     DATE           0101 YEAR 2001                   And/Or      
                VAULT     =                                                             
                DO CONDITION = JOB0099_CHANGE_VAULT ODAT +                                 
                AT   CLOSE                                                        
                DO                                                                         
                ===========================================================================
                ===========================================================================
                DAYS                                                          DCAL        
                AND/OR 
                WDAYS   ALL                                                   WCAL        
                MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y    
                DATES                                                                     
                CONFCAL          SHIFT                                                    
                ======= >>>>>>>>>>>>>>> END OF RULE DEFINITION PARAMETERS <<<<<<<<<<<<<<< ====
                FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41
            

Each rule is composed of General parameters, followed by a group of ON statements called an ON block. Only one ON block can exist in each rule definition. The ON block, that is composed of media specifications, is followed by a group of DO statements (a DO block), that is used to specify rule processing instructions and actions to be performed by the rule. For more information about ON and DO block structure, see ON/DO Block Structures.

To delete a parameter on the screen, erase it (press the EOF key or blank it out). If additional operations are required, Control-M/Tape issues appropriate instructions.

The Rule Definition Screen can be exited in various ways. The most common is to press END (PF03/PF15). For more information see Exiting the Rule Definition Screen.

To implement newly defined or modified rules immediately, it is necessary to reload the Rule definitions using procedure CTTINIT. For more information, see CTTINIT procedure discussion in the Control-M/Tape chapter of the INCONTROL for z/OS Administrator Guide.

Rule parameters are described in detail in Chapter 3, "Rule Parameters." They are described briefly in the following topics.

The parameters marked with the symbol M can have many occurrences. Whenever you fill the last occurrence of the parameter on the screen, Control-M/Tape adds a new empty occurrence of that parameter that you can fill in. The only limit to the number of occurrences is the region size available for the application.

General Rule Parameters

General rule parameters provide basic information about a rule.

Figure 21 General Parameters

Copy
+-----------------------------------------------------------------------------+
                RULE NAME   JOB0099   GROUP PRODUCTION                MODE PROD (Prod/Test)
                OWNER       M43       SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)      
                DESCRIPTION SET VAULT PATTERN OF JOB0099 VOLUMES                           
                DOCMEM      CTTDOCS   DOCLIB CTT.PROD.DOC                                  
                ===========================================================================
            

Table 38 General Parameters

Parameter

Description

RULE NAME

Name of the rule.

GROUP

Group to which the rule is assigned.

MODE

Control-M/Tape operation mode for this rule.

OWNER

User ID of user who created the rule.

SEQUENCE PRIORITY

Internal Control-M/Tape rule scanning priority

CONTINUE SEARCH

Indicates whether to continue searching for additional rules if this rule meets the selection criteria.

DESCRIPTION

Description of the rule (free text).

DOCMEM

Name of the member in which rule documentation may reside.

DOCLIB

Name of the library in which rule documentation may reside.

Selection Parameters: ON Statement

Selection parameters specify selection criteria (ON statements) that must be fulfilled before Control-M/Tape performs designated actions.

A list of valid ON parameters can be alternately displayed or hidden on the screen by typing the command ONOPT (abbreviated O) in the COMMAND field and pressing Enter.

An ON statement is comprised of the ON field, and its corresponding parameters. The ON DATASET statement is required in each rule definition. If it is not specified, Control-M/Tape automatically adds ON DATASET = * (an unqualified ON DATASET statement) as the last ON statement.

An unlimited number of ON statements can be specified in an ON block, using the And/Or/Not parameter described below.

Character masking (described in Character Masking) can be used in any of the specified criteria described in Table 39, except ON MEDIA and ON VOLSER (if a range is specified)

Copy
===========================================================================
                ON DATASET   = *                                            And/Or/Not A
                ON ACCOUNT   = A001                                           And/Or/Not
                ===========================================================================
            

The syntax of the ON statement is

ON selection_criteria

When the selection_criteria of a volume and data set is accessed, they trigger the rule.

To add a selection condition to a rule, type a valid ON parameter in the ON field and press Enter. To delete a specified selection condition, delete the ON parameter keyword and press Enter.

Valid selection criteria options and their abbreviations are:

Table 39 ON Parameter Options

Option

Description

V (VOLSER)

Volume serial numbers or range of volume serial numbers. (If a range is specified, character masking is not supported.)

D (DATASET)

Data set specification.

J (JOBNAME)

Job names that created the data set.

A (ACCOUNT)

Job accounting information.

US (USERID)

Security user IDs assigned to the job that created the data set.

P (PGM)

Program that created the data set.

ME (MEDIA)

Media type (for example, cartridge, tape). Allowed values are specified in a table predefined by the user. Character masking is not supported.

MG (MGMTCLAS)

DFSMS Management Class (1 to 8 characters). Relevant only if the Control-M/Tape to DFSMS interface is active. For more information, see Control-M/Tape to DFSMS Interface.

UC (UCB)

Unit Control Block (UCB) device number or range of device numbers of the unit on which the data set is created.

Copy
     =====================================================================
                                ON DATASET   = DS303K.INF                                And/Or/Not A
                                ON ACCOUNT   = A001                                      And/Or/Not O
                                ON JOBNAME   = RT*                                       And/Or/Not
                                =====================================================================
                            

And/Or/Not

Conjunctional parameter for linking ON statements.

Specifying A (And), O (Or), or N (Not) opens a new ON statement and links the new statement to the line containing the A/O/N specification.

Action Parameters: DO Statement

The Control-M/Tape Action parameters (DO parameters) are used to specify processing instructions to be performed by the rule. The actions specified using the DO parameters are performed only after conditions specified in the ON block have been satisfied.

A list of valid DO parameters can be alternately displayed or hidden on the screen by typing the command DOOPT (abbreviated DOO) in the COMMAND field and pressing Enter.

The DO parameter specifies an action to be taken. An unlimited number of DO parameters are permitted. The combination of DO parameters specified in the rule form a DO block.

It is possible to create a rule without specifying any Action parameters. One use for a rule without a DO block is for changing the Control-M/Tape operation mode systematically, without performing other actions.

To specify Action parameters, type the parameter name next to the DO on the Rule Definition screen, and press Enter. Depending on the specified parameter, different subparameters are displayed on the screen.

It is usually not necessary to enter the full parameter name; the shortest unique abbreviation or code letter of the command is sufficient.

DOM Actions

The Action parameters are divided into the following categories:

Table 40 Action Parameter Categories

Category

Description

IOA-compatible

DO parameters that interface with, or are common to, the INCONTROL family of products. DO parameters in this category are DO SHOUT, DO RESOURCE, DO FORCEJOB, DO SET, and DO CONDITION.

Unique to Control-M/Tape

All remaining DO parameters are unique to Control-M/Tape.

The following are a description and example of each of the DO statement options:

DO ABENDRET – Specifies how long the data set should be retained if an abend or a system crash occurs while creating the data set (meaning, the data set is incomplete or unreliable). Only one DO ABENDRET statement can be specified per rule.

Copy
   ===========================================================================
                DO ABENDRET  = CYCLES             0010     PREFIX Y  (Y/N)     And/Or  A  
                DATE           0101 YEAR 2000                   And/Or  A  
                LAST ACCESS        0090                         And/Or     
                DO                                                             
            ===========================================================================

DO BYPASS – Indicates whether Control-M/Tape should bypass tape management activities for the data set.

Copy
  ===========================================================================
                DO BYPASS    = YES
                DO
            ===========================================================================

DO CONDITION – Adds or deletes a prerequisite condition. Prerequisite conditions are used to trigger events in other INCONTROL products.

Copy
   ===========================================================================
                DO CONDITION = TAPE-MOUNTED         ODAT +                                
                AT   M  (CHeck volumes /Mount /Open / CLose /Abend Close /Keep) 
            ===========================================================================

DO DYNDS – Indicates whether a data set should be dynamically added to the Media Database.

Copy
    ===========================================================================
                DO DYNDS     = YES
                DO
            ===========================================================================

DO DYNVOL – Indicates whether a volume should be dynamically added to the Media Database.

Copy
    ===========================================================================
                DO DYNVOL    = SPECIFIC REQUEST= Y    NON SPECIFIC REQUEST (SCRATCH)= E
                DO
            ===========================================================================

DO FASTPOS – Indicates whether Control-M/Tape should request Fast Positioning for a tape.

Copy
    ===========================================================================
                DO FASTPOS     = YES
                DO
            ===========================================================================

DO FORCEJOB – Force (schedule) a jobs under Control-M.

Copy
  ===========================================================================
                DO FORCEJOB  = TABLE   JOBCHECK     JOB PROD032              DATE  ODAT 
                LIBRARY CTM.PROD.SCHEDULE                                  
                AT   A  (CHeck volumes /Mount /Open / CLose /Abend Close /Keep) 
                DO                                                                        
            ==========================================================================

DO LABEL – Determines whether an external label is printed upon creation of the data set. Only one DO LABEL statement can be specified per rule.

Copy
   ===========================================================================
                DO LABEL     = Y  (Y/N)                                                    
                DO                                                                         
            ===========================================================================

DO OVERJCL – Indicates whether MVS retention attributes for the data set should be overridden by Control-M/Tape rules.

Copy
    ===========================================================================
                DO OVERJCL   = YES
                DO RETENTION = DAYS               00030                        And/Or
                DO
            ===========================================================================

DO OWNER – Assigns an owner to a volume. Only one DO OWNER statement can be specified per rule.

Copy
   ===========================================================================
                DO OWNER     = SUPV043                                                    
                DO                                                                        
            ===========================================================================

DO POOL – Indicates the pool from which scratch volumes should be taken. Only one DO POOL statement can be specified per rule.

Copy
   ===========================================================================
                DO POOL      = ACCOUNTING                                                 
                DO                                                                        
            ===========================================================================

DO RECREATE – Indicates whether an existing data set should be overwritten by the data set.

Copy
    ===========================================================================
                DO RECREATE  = YES
                DO
            ===========================================================================

DO RESOURCE – Modifies the quantity of a Quantitative resource.

Copy
   ===========================================================================
                DO RESOURCE  = TAPE1                0001 +                                 
                AT   CL (CHeck volumes /Mount /Open / CLose /Abend Close /Keep) 
            ===========================================================================

DO RETENTION – Specifies how long the data set should be retained. Only one DO RETENTION statement can be specified per rule.

Copy
   ===========================================================================
                DO RETENTION = PERMANENT                                       And/Or     
                DO                                                                        
            ===========================================================================

DO SET – Assigns a value to an IOA AutoEdit variable.

Copy
   ===========================================================================
                DO SET       = %%TAPEOK=0                                                 
                MEMBER TAPESTAT LIBRARY   CTT.PROD.STATS                               
                AT   A  (CHeck volumes /Mount /Open / CLose /Abend Close /Keep) 
            ===========================================================================

DO SHOUT – Issues a message (to a console, a TSO user ID, the IOA Log, ROSCOE user, or Info/Management).

Copy
   ===========================================================================
                DO SHOUT     = TO TSO-MRE           URGENCY  U                            
                MESSAGE   TAPE CLOSE DURING ABEND                                      
                AT   A  (CHeck volumes /Mount /Open / CLose /Abend Close /Keep) 
            ===========================================================================

DO STACK – Enables or disables stacking of data sets on existing volumes. Only one DO STACK statement can be specified per rule.

Copy
   ===========================================================================
                DO STACK     = N  (Y/N)   SCOPE VOL                                       
                DO                                                                        
            ===========================================================================

DO STKDEFSZ – Indicates a default size to use for calculating stacking statistics for the data set.

Copy
    ===========================================================================
                DO STKDEFSZ  = 0050  OVERRIDE STATISTICS YES
                DO
            ===========================================================================

DO STKGROUP – Indicates a stacking group for the data set.

Copy
    ===========================================================================
                DO STKGROUP  = STKGRP1
                DO
            ===========================================================================

DO STKMODE – Indicates a method to be used for stacking the data set.

Copy
    ===========================================================================
                DO STACK     = Y  (Y/N)  
                DO STKMODE   = ALL
                DO
            ===========================================================================

DO STKMXLBL – Indicates a maximum number of data sets with which the data set can be stacked on a volume or group of volumes.

Copy
   ===========================================================================
                DO STACK     = Y  (Y/N)  
                DO STKMXLBL  = 0005
                DO
            ===========================================================================

DO STKMXVOL – Indicates the maximum number of volumes in a chain on which the data set can be stacked.

Copy
   ===========================================================================
                DO STACK     = Y  (Y/N)  
                DO STKMXVOL  = 0002
                DO
            ===========================================================================

DO STKRULE – Indicates a stacking limitation for the data set.

Copy
   ===========================================================================
                DO STACK     = Y  (Y/N)
                DO STKRULE   = NOT WITH JOB JOB1
                DSN
                DO STKRULE   = NOT WITH JOB
                DSN DSN1
                DO STKRULE   = NOT WITH JOB JOB2
                DSN DSN2
                DO
            ===========================================================================

DO STKSRCHL – Indicates a maximum number of volumes to consider for stacking the data set.

Copy
   ===========================================================================
                DO STACK     = Y  (Y/N)  
                DO STKSRCHL  = 0300
                DO
            ===========================================================================

DO VAULT – Identifies vault names and retention specifications for storing volumes.

Copy
   ===========================================================================
                DO VAULT     = VAULTA                      BY BOX  (Y/N)             
                UNTIL     DATE           0101 YEAR 2000                   And/Or     
                VAULT     =                                                            
                ===========================================================================
            DO                                                                        

Basic Scheduling Parameters

Basic Scheduling parameters specify on what dates the rule is a candidate for activation (meaning, load during initialization).

Copy
   DAYS                                                          DCAL        
                AND/OR  
                WDAYS                                                         WCAL         
                MONTHS  1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
                DATES                                                                      
            CONFCAL          SHIFT                                                     

Table 41 Basic Scheduling Parameters

Parameter

Description

DAYS

Days of the month to activate the rule. A maximum of two lines can be specified.

WDAYS

Days of the week to activate the rule. A maximum of two lines can be specified.

MONTHS

Months to activate the rule.

DATES

Specific dates in the year to activate the rule.

CONFCAL

Name of a calendar used for rule activation confirmation.

SHIFT

Indicates if and when a rule should be activated when it fails confirmation by the CONFCAL calendar.

Editing Definitions in the Edit Environment

Definition parameters can be edited (moved, copied, deleted, or repeated) by performing INCONTROL Line Editing commands, similar to standard ISPF line commands, from within the IOA Edit environment.

The Edit environment of the Rule Definition screen is accessed by typing EDIT in the COMMAND field of a definition screen and pressing Enter.

Figure 22 Entering Editing Commands

Copy
 RULE: DBBKP1   LIB CTT.PROD.RULES                               TABLE: RULE2
                COMMAND ===>                                                    SCROLL===> CRSR
                +-----------------------------------------------------------------------------+
                __ RULE NAME   DBBKP1    GROUP DATABASE-BACKUP           MODE PROD (Prod/Test)
                __ OWNER       M09A      SEQUENCE PRIORITY    CONTINUE SEARCH Y    (Y/N)
                __ DESCRIPTION
                __ DOCMEM      DBBKP1    DOCLIB CTT.PROD.DOC
                __ ===========================================================================
                __ ON DATASET   = BKP.DB*                                         And/Or/Not
                __ ===========================================================================
                __ DO POOL      = DATABASE-BKP
                __ DO RETENTION = DAYS              00060                         And/Or
                __ DO VAULT     = MAINLIB                     BY BOX    (Y/N)     
                __      UNTIL     DAYS               0010                         And/Or
                __    VAULT     = VAULT2
                __      UNTIL     VAULT DAYS         0050                         And/Or
                __    VAULT     = VAULT3
                __      UNTIL     VAULT DAYS         0050                         And/Or
                D_    VAULT     = VAULT4
                __      UNTIL     VAULT DAYS         0050                         And/Or
                __    VAULT     = VAULT5
                __      UNTIL     VAULT DAYS         0050                         And/Or
                __    VAULT     =
                __ ===========================================================================
                __ ===========================================================================
            FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    10.03.47

A 2-character Line Editing command field, marked by underscores, is displayed for each line on the definition screen.

Editing commands are typed directly onto these underscores.

Specified Line Editing commands are processed when Enter is pressed.

For detailed information about and examples of editing definitions in the Edit environment, see Editing Rule Definitions in the IOA Edit Environment.

Commands of the Rule Definition Screen

The following commands can be specified in the COMMAND field of the Rule Definition screen:

Table 42 Commands of the Rule Definition Screen

Command

Description

EDIT

The EDIT command alternately activates or deactivates the Edit environment of the Rule Definition screen. The Edit environment provides ISPF-like line editing commands for this screen. For additional information, see Editing Rule Definitions in the IOA Edit Environment.

SCHED

The SCHED command alternately displays or hides scheduling parameters, independent of the value specified in the SHOW SCHEDULING CRITERIA field in the Rule Definition entry panel. For additional information, see Display and Non-Display of Documentation.

DOC

The DOC command alternately displays or hides documentation lines, independent of the value specified in the SHOW RULE DOCUMENTATION field in the Rule Definition entry panel. For additional information, see Rule Documentation.

DOOPT

The DOOPT command alternately displays or hides a list of valid DO action keywords.

ONOPT

The ONOPT command alternately displays or hides a list of valid ON selection criteria.

Display and Non-Display of Scheduling Criteria

Depending on the value of the SHOW SCHEDULING CRITERIA field in the entry panel, scheduling criteria are either displayed or hidden when you first enter the Rule Definition screen:

  • If the SHOW SCHEDULING CRITERIA field is set to Y (Yes), scheduling criteria are displayed upon entry to the Rule Definition screen.

  • If the SHOW SCHEDULING CRITERIA field is set to N (No), scheduling criteria are hidden upon entry to the Rule Definition screen.

Specifying the SCHED command (abbreviated SC) in the COMMAND field alternately displays or hides the rule’s scheduling parameters (independent of the Show Scheduling Criteria field).

Below is an example of the Rule Definition screen with scheduling parameters hidden.

Figure 23 Rule Definition Screen with Scheduling Parameters Hidden

Copy
 RULE: JOB0099  LIB CTT.PROD.RULES                               TABLE: ADM0002
                COMMAND ===>                                                    SCROLL===> CRSR
                +-----------------------------------------------------------------------------
                RULE NAME   JOB0099   GROUP PRODUCTION                MODE PROD (Prod/Test)
                OWNER       M43       SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)      
                DESCRIPTION SET VAULT PATTERN OF JOB0099 VOLUMES                           
                DOCMEM      JOBDOCS   DOCLIB CTT.PROD.DOC                                  
                ===========================================================================
                ON DATASET   = *                                               And/Or/Not  
                ===========================================================================
                DO VAULT     = VAULTA                                                      
                UNTIL     DATE           0101 YEAR 1999                   And/Or    
                VAULT     = VAULTB                                                      
                UNTIL     DATE           0101 YEAR 2000                   And/Or
                VAULT     = MAINLIB                                                     
                UNTIL     DATE           0101 YEAR 2001                   And/Or      
                VAULT     =                                                             
                DO CONDITION = JOB0099_CHANGE_VAULT ODAT +                                 
                AT   CLOSE                                                        
                DO                                                                         
                ===========================================================================
                ===========================================================================






                ======= >>>>>>>>>>>>>>> END OF RULE DEFINITION PARAMETERS <<<<<<<<<<<<<<< ====
            FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

If you are not using the scheduling options of Control-M/Tape, you should work with N as the default.

Scheduling criteria apply to a rule even when they are hidden.

Rule Documentation

This item includes the following topics:

Display and Non-Display of Documentation

Depending on the value of the SHOW RULE DOCUMENTATION field in the entry panel, rule documentation (meaning, DOC lines) is either displayed or hidden when you first enter the Rule Definition screen.

  • If the SHOW RULE DOCUMENTATION field is set to Y (Yes), rule documentation is displayed.

  • If the SHOW RULE DOCUMENTATION field is set to N (No), rule documentation is hidden.

Specifying the DOC command in the COMMAND field alternately displays or hides the rule’s documentation.

Figure 24 shows an example of the Rule Definition screen with documentation (DOC lines) displayed.

Figure 24 Rule Definition Screen with Documentation (DOC) Lines Displayed

Copy
 RULE: JOB0099  LIB CTT.PROD.RULES                               TABLE: ADM0002
                COMMAND ===>                                                    SCROLL===> CRSR
                +-----------------------------------------------------------------------------+
                RULE NAME   JOB0099   GROUP PRODUCTION                MODE PROD (Prod/Test)
                OWNER       M43       SEQUENCE PRIORITY 01 CONTINUE SEARCH Y    (Y/N)      
                DESCRIPTION SET VAULT PATTERN OF JOB0099 VOLUMES                           
                DESCRIPTION                                                                
                DOCMEM      JOBDOCS   DOCLIB CTT.PROD.DOC                                  
                ===========================================================================
                DOC THIS SCREEN SHOWS WHERE THE DOCUMENTATION WILL APPEAR
                DOC WHEN YOU USE THE DOC COMMAND. AS YOU CAN SEE,
                DOC THE LINES FOLLOWING THE DOCUMENTATION WILL BE "PUSHED" DOWNWARD.
                DOC ENTER THE DOC COMMAND AGAIN TO MAKE THIS DOCUMENTATION DISAPPEAR.
                DOC
                ===========================================================================
                ON DATASET   = *                                               And/Or/Not  
                ===========================================================================
                DO VAULT     = VAULTA                                                      
                UNTIL     DATE           0101 YEAR 1999                   And/Or    
                VAULT     = VAULTB                                                      
                UNTIL     DATE           0101 YEAR 2000                   And/Or
                VAULT     = MAINLIB                                                     
                UNTIL     DATE           0101 YEAR 2001                   And/Or      
            FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

Users with DOCU/TEXT installed at their site can specify a DOCU/TEXT library and member with up to 132 characters per line. However, if more than the first 71 characters in a line are used, the line is truncated and Browse Mode is forced. Browse mode is also forced if a line has an unprintable character.

Editing Documentation

Documentation can be edited when the DOC lines of the Rule Definition screen are displayed. Modify the DOC lines as desired. When you fill in the last DOC line and press Enter, a new DOC line is displayed.

Rule documentation is written to the member or library specified in the DOCMEM and DOCLIB fields on the Rule Definition screen. Therefore, it is also possible to edit the documentation directly using ISPF edit of the member. This is recommended for extensive documentation, or if complex editing is required.

For CA-LIBRARIAN and CA-PANVALET users, the DOC command displays or hides rule documentation in Browse mode. Changes to the documentation are not permitted.

AutoSave and Saving Documentation

Documentation changes can be saved upon exiting the Rule Definition screen. A Save Documentation window can be displayed (if there are documentation changes) or not displayed, depending on the value of the AUTO-SAVE DOCUMENTATION field in the entry panel.

  • If the AUTO-SAVE DOCUMENTATION field was set to Y (Yes), documentation changes are automatically saved and the Save Documentation window is not displayed.

  • If the AUTO-SAVE DOCUMENTATION field was set to N (No), documentation changes are not automatically saved and the Save Documentation window is displayed. This window enables you to save or cancel the documentation changes.

Figure 25 Rule Definition Screen Save Documentation Window

Copy
 RULE: JOB0099  LIB CTT.PROD.RULES                               TABLE: ADM0002
                COMMAN +-----------------------------------------------------------+  ===> CRSR
                +----- |                                                           |  --------+
                RULE |    SAVE DOCUMENTATION ==> Y      (Y/N)                    |  d/Test)
                USER |                                                           |  )      
                DESC |    LIBRARY CTT.PROD.DOC                                   |       
                DESC |    MEMBER  JOBDOCS                                        |       
                DESC |                                                           |       
                DOCM +-----------------------------------------------------------+         
                ===========================================================================
                DOC THIS SCREEN SHOWS WHERE THE DOCUMENTATION WILL APPEAR ON THE SCREEN
                DOC WHEN YOU USE THE DOC COMMAND. AS YOU CAN SEE,
                DOC THE LINES FOLLOWING THE DOCUMENTATION WILL BE "PUSHED" DOWNWARD.
                DOC ENTER THE DOC COMMAND AGAIN TO MAKE THIS DOCUMENTATION DISAPPEAR.
                DOC
                ===========================================================================
                ON DATASET   = *                                               And/Or/Not  
                ===========================================================================
                DO VAULT     = VAULTA                                                      
                UNTIL     DATE           0101 YEAR 1999                   And/Or    
                VAULT     = VAULTB                                                      
                UNTIL     DATE           0101 YEAR 2000                   And/Or
                VAULT     = MAINLIB                                                     
            FILL IN RULE DEFINITION. CMDS: EDIT, SHPF, DOC, SCHED, DOOPT, ONOPT    15.49.41

You can change the name of the library or member name in the window.

  • Enter Y (Yes) in the SAVE DOCUMENTATION field to save the changes.

  • Enter N (No) in the SAVE DOCUMENTATION field to cancel the changes.

After you specify Y (Yes) or N (No) and press Enter, the Rule List screen is displayed.

Exiting the Rule Definition Facility

To exit the Rule Definition facility, the following screens must be exited in sequence:

Table 43 Exiting the Rule Definition Facility

Screen

Description

Rule Definition screen

How you exit this screen depends on whether changes made in the Rule Definition screen should be saved. Refer to Exiting the Rule Definition Screen.

Rule List screen

How you exit this screen depends on whether changes made to each rule should be saved. Refer to Exiting the Rule List Screen.

Rule Table List screen

Exit this screen by pressing END (PF03/PF15).

Entry panel

Exit this screen by pressing END (PF03/PF15).

Exiting the Rule Definition Screen

Use the following commands to exit the Rule Definition screen:

Table 44 Commands for Exiting the Rule Definition Screen

Command

Description

END

Keep the changes made to the rule parameters and return to the Rule List screen. If documentation changes have been made, the Save Documentation window may be displayed. If Automatic Rule Sorting is enabled, the current rule is immediately moved to its appropriate position in the sorted list. For more information see Exiting the Rule List Screen.

CANCEL

Do not keep the changes made to rule parameters and return to the Rule list screen. For more information see Exiting the Rule List Screen.

NEXTRULE

Keep the changes made to rule parameters and display the Rule Definition screen of the next rule in the Rule list. (PF11/PF23).

PREVRULE

Keep the changes made to rule parameters and display the Rule Definition screen of the previous rule in the Rule list. (PF10/PF22).

Changes made to parameters are initially only in memory. They are written to disk after you exit the Rule List screen.

Exiting the Rule List Screen

Press (PF03/PF15) END to exit the Rule List screen. If changes have been made in the Rule Definition screen and the Rule Definition screen was exited with (PF03/PF15) END, or if the Rule list was resorted, an Exit Option window is opened. Two exit options SAVE and CREATE are displayed.

Figure 26 Rule List Screen Exit Option Window

Copy
  RULES OF LIBRARY: CTT.PROD.RULES                                TABLE: AAEDTST1
                COMMAN +-----------------------------------------------------------+  ===> CRSR
                OPT  N |                 PLEASE SELECT EXIT OPTION                 |  ---------
                A |                                                           |
                J |     SAVE    CREATE                                        |
                J |                                                           |
                J |     LIBRARY CTT.PROD.RULES                                |
                M |     TABLE   JOB00012                                      |
                M |                                                           |
                M +-----------------------------------------------------------+
                M          MOUNT CHECK - FORCE CERTAIN CONTROL-M JOBS
                SHOUTSCR   SHOUT ON SCRATCH OF CERTAIN JCL ACCOUNTS
                ======= >>>>>>>>>>>>>>>>> NO MORE RULES IN THIS TABLE <<<<<<<<<<<<<<<<<<< ====
 
 
 
 
 
 
 
 
 
 
            OPTIONS:  S SELECT   D DELETE   I INSERT                               14.24.41

You can change the name of the library or the name of the rule in the window.

To save changes to all modified rules and return to the Rule Table List screen, enter Y (Yes) in the SAVE field if the table name exists in the specified library, or enter Y (Yes) in the CREATE field to create a new table name in the specified library.

To cancel the changes to all modified rules and return to the Rule Table List screen, enter N (No) in one of the exit options.

Press RESET (PF04/PF16) in the Exit Option window to cancel the exit operation and remain in the Rule List screen.

To save changes made to parameters in the rule table, the entire table must be saved by entering Y in one of the exit options of the Rule Table List screen.

Pool Definition Facility

Control-M/Tape Online Pool Definition screens enable you to view, create and modify pool definitions.

Pools are logical groups to which media are assigned (for example, a pool can be defined for each department in your organization). Pools can help in the accounting of media per department, in departmental security, and in managing multi-platform media. Pools can be particularly useful for allocating and budgeting removable media by department. Scratch volumes are generally allocated on a pool basis. Control-M/Tape tracks the number of scratch volumes per pool so that a scratch volume is always available when needed.

Pool definitions are stored in libraries (partitioned data sets). A library contains pool tables (members), and each table contains specifications for one or more pool definitions. Most sites designate a primary pool definition library (the default is member $$POOL in the PARM library).

Accessing the Pool Definition Facility

The Pool Definition facility contains the following screens:

Table 45 Pool Definition Facility Screens

Screen

Description

Pool Definition Facility entry panel

Allows specification of parameters that determine which screen is displayed.

Table List screen

Displays the list of tables (members) in the specified Pool library.

Pool List screen

Displays the list of pools in the selected table.

Pool Definition screen

Displays the parameters of the selected pool definition. This is the main screen of the facility.

To enter the Online Pool Definition facility, select option TP in the IOA Primary Option menu. The entry panel is displayed.

Creating Tables

Tables can be created in any of the following ways:

  • By specifying the new table name in the entry panel and pressing Enter.

  • By using the SELECT command (described later) to specify the new table name in the Table List screen and pressing Enter.

As a result of using either of the above methods, a skeletal pool definition (meaning, one with most fields left blank) is displayed in the pool definition screen.

Fill in the blanks and save the screen entries. The table is created and the pool definition is the first and only definition in the Pool list of the table. As additional pool definitions are created in the table (described below), they are added to the list.

Upon exiting the Pool List screen, if changes were made in at least one pool definition, an Exit Option window is displayed. One field of the window displays the table name. This value can be changed to a new table name that creates a new table in which the pool definitions are saved.

Creating Pool Definitions

Pool definitions can be created using either of two basic methods:

  • A skeletal pool definition can be created by specifying the name of a new pool definition in the entry panel. (The table specified in the entry panel can be either a new or an existing table.) In this case, virtually all fields of the pool definition are empty.

  • A copy of an existing pool definition can be created using the INSERT option (described later) in the Pool List screen. In this case, most fields of the new pool definition have the same values as the fields in the copied pool definition.

Performing Operations on Tables and Pools

Many operations can be performed on tables and on the pool definitions in them. These operations are performed using commands and options in the various screens of the Pool Definition facility.

Following is a brief summary of some of the major operations possible within the facility. Additional options and commands are explained following the summary.

Accessing (Editing or Browsing) a Table and its Pools

A table (meaning, the pool definitions in the table) can be browsed or edited.

When browsed, the table cannot be modified or updated. When the table is edited, new pool definitions can be added and existing pool definitions can be modified or deleted.

Browsing, however, has advantages:

  • Access and exit are quicker than in editing.

  • A pool list and rule definitions that are in use by another user can be viewed.

  • Access for browsing might be granted, even though access for editing might be denied due to site security requirements.

To browse a table (and its pool list and pool definitions), use the BROWSE option in the Table List screen.

Specifying the table name in the entry panel, or using the SELECT option in the Table List screen, provides edit access.

Depending on user profile definitions, if the table requested for editing is in use, access is either granted in Browse mode, or access will not be granted.

Copying a Pool to Another Table

Pools can be copied from one table to another using the COPY option in the Pool List screen. For more information, see Copying Pool Definitions to Another Table.

Deleting a Table or a Pool

Unneeded rules can be deleted using the DELETE option in the Pool List screen. For more information, see Options of the Pool List Screen. Unneeded tables can be deleted using the DELETE option in the Table List screen. For more information, see Deleting Pool Tables.

Saving Modifications

All changes made to a table and its pool definitions are kept in memory until the table is exited. Upon exiting the table, the user can choose to save or cancel the changes. For more information, see Exiting the Pool List Screen.

Pool Definition Entry Panel

Figure 27 Pool Definition Entry Panel

Copy
 ------------------ CONTROL-M/Tape POOL DEFINITION ENTRY PANEL -------------(TP)
                COMMAND ===>                                                                  
                                                                               
                                                                               
                                                                               
                SPECIFY LIBRARY, TABLE NAME, POOL NAME                                        
                                                                               
                LIBRARY   ===> CTTP.PROD.PARM                                                
                TABLE     ===>                      (Blank for table selection list)         
                POOL      ===>                      (Blank for pool selection list)          
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
            USE THE COMMAND "SHPF" TO SEE PFK ASSIGNMENT                           14.34.11

If you use the selection list fields, their values are not erased until you exit the entry panel by pressing END (PF03/PF15).

To open the desired display

Fill in entry panel fields LIBRARY, TABLE, and POOL as described below to open the desired display.   

To display the list of tables in a library

  1. Type the library name.

  2. Either leave the table name blank, or type part of a table name together with mask characters (* and ?).

  3. Press Enter.

To display the list of rules of a specific pool

  1. Type the library name.

  2. Type the table name.

  3. Press Enter.

If the table does not exist, the screen for defining a new pool in the table is displayed.

To display the details of a specific pool (Pool Definition screen)

  1. Type the library name.

  2. Type the table name.

  3. Type the pool name.

  4. Press Enter.

If the table does not exist, or if the pool for the specified table does not exist, the screen for defining a new pool in the table is displayed.

If you enter the screen for defining a new pool and want to leave the screen without defining a pool, use the CANCEL command.

Pool Table List Screen

The Pool Table List screen displays a list of pool tables (members) in the specified library. This screen can be entered directly from the entry panel or upon exiting from the Pool List screen.

By default, only table names are listed in the screen. However, if the default has been modified at time of installation, statistical information is displayed for each table name, as shown in Figure 28.

Figure 28 Rule Definition Facility Table List Screen

Copy
 TABLES OF LIBRARY CTT.PROD.PARM                                ------------(TP)
                COMMAND ===>                                                    SCROLL===> CRSR
                OPT  NAME ------------ VV.MM  CREATED     CHANGED     SIZE  INIT   MOD   ID
                $$POOL            01.01 00/03/03 00/03/03 09:11    41    41     0 M43A
                $$VAULT           01.01 00/03/03 00/03/03 11:11    70    70     0 M43A
                ======= >>>>>>>>>>>>>>>> NO MORE TABLES IN THIS LIBRARY <<<<<<<<<<<<<<<<< ====

















            OPTIONS:  S SELECT   B BROWSE   D DELETE                               14.43.14

To scroll down the Pool Table list, press PF08/PF20. To scroll up the Pool Table list, press PF07/PF19.

To return to the entry panel, press END (PF03/PF15).

Options of the Pool Table List Screen

To select one of the following options, specify the option in the OPT field to the left of the pool table name, and press Enter:

Table 46 Options of the Table List Screen

Option

Description

S (SELECT)

Display the list of pools in the pool table for any purpose. Only one pool table can be selected at a time.

If the S (Select) option is specified in the Pool Table List screen for a table that is currently in use (selected) by another user, then depending on User profile parameter SSCHBRO, either the Pool List screen is not displayed (meaning, the Pool Table List screen remains displayed; this is the default), or the Pool List screen is displayed in Browse mode. In either case, an appropriate message is displayed.

B (BROWSE)

Display the list of pools in the pool table for browsing. Only one pool table can be selected at a time.

D (DELETE)

Delete the table (member) from the library. Multiple tables can be selected. A confirmation window is displayed. For more information see Deleting Pool Tables.

The INCONTROL administrator can limit specific users to access of only the BROWSE option.

Deleting Pool Tables

To delete pool tables, specify option D by the pool table names and press Enter.

The following confirmation window is displayed, in sequence, for each pool table selected for deletion:

Figure 29 Pool Definition Facility Delete Table Confirmation Window

Copy
 TABLES OF LIBRARY CTT.PROD.PARM                                ------------(TP)
                COMMAND ===>                +--------------------------+        SCROLL===> CRSR
                OPT  NAME ---               |   CONFIRM DELETE OPTION  | E  INIT   MOD   ID
                D   $$POOL     <-----------|               (Y/N)      | 1    41     0 M43A
                $$VAULT                +--------------------------+ 0    70     0 M43A
                ======= >>>>>>>>>>>>>>>> NO MORE TABLES IN THIS LIBRARY <<<<<<<<<<<<<<<<< ====












            OPTIONS:  S SELECT   B BROWSE   D DELETE                               14.43.14

Specify Y (Yes) in the window to confirm the delete request.

Specify N (No) in the window to cancel the delete request.

If PDSMAN is operational at your site, $$$SPACE members cannot be deleted.

A message is written to the IOA Log for each pool table deleted.

Pool List Screen

This screen displays the List of pools in a pool table in a specified library. This screen can be entered directly from the entry panel or the Pool Table List screen, or upon exiting from the Pool Definition screen.

If the S (Select) option is specified in the Pool Table List screen for a table that is currently in use (selected) by another user, then depending on User profile parameter SSCHBRO, either the Pool List screen is not displayed (meaning, the Pool Table List screen remains displayed; this is the default), or the Pool List screen is displayed in Browse mode. In either case, an appropriate message is displayed.

Figure 30 Pool Definition Rule List Screen

Copy
 POOLS OF LIBRARY: CTT.PROD.PARM                                 TABLE: $$POOL
                COMMAND ===>                                                    SCROLL===> CRSR
                OPT  POOL ----------------- DESCRIPTION ---------------------------------------
                ACCT         ACCOUNTING DEPARTMENT TAPES
                ADMIN1       ADMINISTRATIVE TAPES FOR PERSONNEL
                ADMIN2       ADMINISTRATIVE TAPES FOR PAYROLL
                BACKUP1      DAILY BACKUP TAPE
                BACKUP2      MONTHLY BACKUP TAPE
                MANAGERS     MANAGERS SCHEDULES TAPES
                MARKETING    MARKETING DEPARTMENT TAPES
                MIS1         TAPES BELONGING TO MIS DEPARTMENT PROGRAMMERS
                MIS2         TAPES BELONGING TO MIS DEPARTMENT CONSULTANTS
                MIS3         TAPES BELONGING TO MIS DEPARTMENT ANALYSTS
                PERSONEL     TAPES FOR PERSONNEL DEPARTMENT
                QUALCONT     QUALITY CONTROL TAPE
                SECRETARIES  TAPES CONTAINING FILES USED BY SECRETARIES
                ======= >>>>>>>>>>>>>>>>> NO MORE POOLS IN THIS TABLE <<<<<<<<<<<<<<<<<<< ====






            OPTIONS:  S SELECT   D DELETE   I INSERT                               12.48.43

Standard scrolling conventions are supported in this screen.

To exit to the Pool List screen, press END (PF03/PF15). For more information see Exiting the Pool List Screen.

Format of the Pool List Screen

Next to each pool name in the Pool list, certain information can be displayed. The type and format of this information depends on whether the screen is displayed in DESC format or in STAT format.

  • In DESC format, the pool’s description, taken from the DESC field of the pool definition, is displayed. Default.

  • In STAT format, the pool’s ISPF statistical information is displayed.

By default, the pool list is displayed in DESC format. To change formats, use the DESC or STAT commands, as described below.

Commands of the Pool List Screen

The following commands can be specified in the COMMAND field of the Pool List screen:

Table 47 Commands of the Pool List Screen

Command

Description

DESC

Command DESC displays the pool description next to the pool name. The description is taken from the DESC field in the pool definition.

STAT

Command STAT displays the following ISPF-like statistical information about the pool next to the pool name: version and modification numbers, creation date, last modification date, and user ID.

Options of the Pool List Screen

Specify one of the following pool processing options by marking the option to the left of the pool name and pressing Enter:

If the Pool List screen is displayed in Browse mode, options D (Delete) and I (Insert) are not available.

Table 48 Options of the Pool List Screen

Command

Description

S (SELECT)

Display the Pool Definition screen with details of the specific pool.

If the Pool List screen is not displayed in Browse mode, the pool definition can be edited and updated. If the Pool List screen is displayed in Browse mode, the pool definition can only be browsed; it cannot be modified.

D (DELETE)

Delete a pool from the Pool list.

I (INSERT)

Insert a new pool in the list. The Pool Definition screen appears with the same details of the pool marked "I", but the POOL NAME and DESCRIPTION parameters are empty for you to fill in. The new pool is added after the pool marked "I".

C (COPY)

Copy the pool to another table. Multiple pools can be selected.

Pool Definition Screen

The Pool Definition screen is used to define, display and modify pool parameters. Pool parameters specify logical groups of volumes. This screen can be entered directly from the entry panel or from the Pool List screen. Update of parameters is not permitted in Browse mode.

The pool parameters may fill more than one screen.

Figure 31 Pool Definition Screen

Copy
--------------- POOL BACKUP1                    TABLE  $$POOL   ---------(TP.S)
                COMMAND ===>                                                    SCROLL===> CRSR
                +-----------------------------------------------------------------------------+

                POOL NAME   BACKUP1                                     OWNER  DP1        
                DESCRIPTION BACKUP POOL FOR DIVISION ONE                                   
                DESCRIPTION                                                                
                ===========================================================================
                VOLUMES     FROM  BKP1*     TO                                             
                FROM  CA0001    TO  CA1000                                     
                FROM  TP1000    TO  TP1545                                     
                FROM  TP2000    TO  TP2545                                     
                FROM            TO                                             
                ======= >>>>>>>>>>>>>>> END OF POOL DEFINITION PARAMETERS <<<<<<<<<<<<<<< =====









            FILL IN POOL DEFINITION. CMDS: EDIT, SHPF                               12.58.05

The pool parameters are divided into the following basic groups:

  • General Pool parameters

  • Volume Range list

The groups are separated by a delimiter line.

To delete a parameter on the screen, simply erase it (press the EOF key, or blank it out). If additional operations are required, Control-M/Tape issues appropriate instructions.

The Pool Definition screen can also be edited using ISPF-like editing commands (such as copy, move, repeat, after, before) in the Control-M/Tape Edit environment. For additional information, see Editing Rule Definitions in the IOA Edit Environment.

Pool definitions are automatically saved in a PDS member (a Pool table) that can be edited using a standard editor such as the ISPF Edit facility. Pools originally defined using a standard editor can also be displayed and edited in the Online Pool Definition screen. The pool table name is defined at time of installation (Default: $$POOL).

The Pool Definition screen can be exited in various ways. The most common is to press END (PF03/PF15). For more information, see Exiting the Pool Definition Facility.

To immediately implement newly defined or modified Pool definitions, reload them through procedure CTTINIT. For more information, see "Procedure CTTINIT" in the Control-M/Tape chapter of the INCONTROL for z/OS Administrator Guide.

The parameters marked with the symbol M can have many occurrences. Whenever you fill the last occurrence of the parameter on the screen, Control-M/Tape adds a new empty occurrence of that parameter that you can fill in. The only limit to the number of occurrences is the region size available for the application.

General Pool Parameters

General Pool parameters provide basic information about a pool.

Table 49 General Parameters

Parameter

Description

POOL NAMEM

Name of the pool (a maximum of 15 characters can be specified).

OWNER

User ID of the user who defined the pool.

DESCRIPTION

Description of the pool (free text).

Copy
 POOL NAME   BACKUP1                                     OWNER  DP1        
                DESCRIPTION BACKUP POOL FOR DIVISION ONE                                   
             DESCRIPTION                                          

Volume Range List

The Volume Range list specifies the volumes that are allocated to the pool.

Table 50 Volume Range List

Parameter

Description

VOLUMES

List of volume ranges associated with the pool. Each volume range must be listed on a separate line.

FROM/TOM

Starting and ending volume serial numbers for each volume range. Multiple volume ranges can be specified.

Character masking can be used in FROM fields. When a mask is specified, the corresponding TO field must be blank. For more information, see Character Masking.

Copy
   VOLUMES     FROM  BKP1*     TO                                              
                FROM  CA0001    TO  CA1000                                      
                FROM  TP1000    TO  TP1545                                      
                FROM  TP2000    TO  TP2545                                      
            FROM            TO                                              

Commands of the Pool Definition Screen

EDIT Command

The EDIT command alternately activates or deactivates the Edit environment of the Pool Definition screen. The Edit environment provides ISPF-like line editing commands for this screen. For additional information, see Editing Rule Definitions in the IOA Edit Environment.

Exiting the Pool Definition Facility

To exit the Pool Definition facility, the following screens must be exited in sequence:

Table 51 Pool Definition Facility Exit Screens

Screen

Description

Pool Definition screen

How you exit this screen depends on whether changes made in the Pool Definition screen should be saved. Refer to Exiting the Pool Definition Screen.

Pool List screen

How you exit this screen depends on whether changes made to each pool should be saved. Refer to Exiting the Pool List Screen.

Pool Table List screen

Press END (PF03/PF15) to exit this screen.

Entry panel

Press END (PF03/PF15) to exit this screen.

Exiting the Pool Definition Screen

Use the following commands to exit the Pool Definition screen:

Table 52 Pool Definition Exit Screen

Command

Description

END

Keep the changes made to the parameters of the pool and return to the Pool list. For more information, see Exiting the Pool List Screen.

CANCEL

Do not keep the changes made to the parameters of the pool and return to the Pool list. For more information, see Exiting the Pool List Screen.

NEXTPOOL

Keep the changes made to the parameters of the pool and display the next pool in the Pool list. (PF11/PF23).

PREVPOOL

Keep the changes made to the parameters of the pool and display the previous pool in the Pool list. (PF10/PF22).

Changes made to parameters are initially kept only kept in memory. They are written to disk after you exit the Pool List screen.

Exiting the Pool List Screen

Press (PF03/PF15) END to exit the Pool List screen. If changes have been made in the Pool Definition screen and the Pool Definition screen was exited with (PF03/PF15) END, an Exit Option window is opened.

It is possible to change the name of the library or the name of the pool in the window.

Figure 32 Pool List Screen Exit Option Window

Copy
 POOLS OF LIBRARY: CTT.PROD.PARM                                 TABLE:   $$POOL
                COMMAN +-----------------------------------------------------------+  ===> CRSR
                OPT  N |                 PLEASE SELECT EXIT OPTION                 |  ---------
                A |                                                           |
                A |     SAVE Y  CREATE                                        |
                B |                                                           |
                B |     LIBRARY CTT.PROD.PARM                                 |
                M |     TABLE   $$POOL                                        |
                M |                                                           |
                M +-----------------------------------------------------------+
                M
                MIS3
                PERSONNEL
                QUALCONT
                SECRETARIES
                ======= >>>>>>>>>>>>>>>>> NO MORE POOLS IN THIS TABLE <<<<<<<<<<<<<<<<<<< ====







            OPTIONS:  S SELECT   D DELETE   I INSERT                               12.48.45
  • To save the changes to all modified pools and return to the Pool Table List screen, enter Y (Yes) in the SAVE field if the table name exists in the specified library, or enter Y (Yes) in the CREATE field to create a new table name in the specified library.

  • To cancel the changes to all modified pools and return to the Pool Table List screen, enter N (No) in one of the exit options.

  • Press RESET (PF04/PF16) in the Exit Option window to cancel the exit operation, and remain in the Pool List screen.

  • To save changes made to pool parameters in the pool table, the entire table must be saved by entering Y in one of the exit options of the Pool List screen.

Copying Pool Definitions to Another Table

To copy one or more pool definitions from the current table to another table, specify option C (Copy) by the pool names in the Pool List screen and press Enter. The following window is displayed:

Figure 33 Pool List Screen Copy Window

Copy
POOLS OF LIBRARY CTT.PROD.PARM                                   POOL: PLRPT010
                COMMAND ===>                                                    SCROLL===> CRSR
                OPT  NAME ---------------------------------------------------------------------
                C   POOL1                  SCRATCH POOL1
                POOL2                  SCRATCH POOL2
                                                                             
                                                                             
                +-----------------------------------------------------------+
                |                                                           |
                |     SPECIFY DESTINATION LIBRARY,TABLE AND RULE NAME       |
                |                                                           |
                |  LIBRARY :   CTM.PROD.POOLS                               |
                |  TABLE :                                                  |
                |  POOL :      POOL1                                        |
                |                                                           |
                |  PRESS END/RESET TO CANCEL     ENTER TO PERFORM THE COPY  |
                +-----------------------------------------------------------+
                                                                             
                                                                             
                                                                             
                                                                             
                                                                             
                                                                             
            OPTIONS:  S SELECT   D DELETE   I INSERT                               12.48.45

The window contains the following fields (some fields contain default values that can be modified):

Table 53 Fields of the Pool List Screen Copy Window

Field

Description

LIBRARY

Library containing the table into which the pool definitions should be copied. Must be an existing library. Default is the current library.

TABLE

Name of the table into which the pool should be copied.

A table can only be copied to another table. It cannot be copied to its own table (even if the pool is renamed).

If the specified table does not exist, the table is created when the request is performed.

 

POOL

Name of the pool definition to be copied. If multiple pool definitions are selected, the window is first displayed with the first selected pool definition. As each request is performed or canceled, the next requested pool definition name appears.

To perform a request, press Enter.

To cancel a request, press END (PF03/PF15) or RESET (PF04/PF16).

Vault Definition Facility

Control-M/Tape Vault Definition screens enable you to view, create, and modify vault definitions.

Vaults are locations in which removable media can be stored as an alternative to the active library. A vault definition defines the vault name, location, and optionally the capacity of the vault.

Vault definitions are stored in libraries (partitioned data sets). A library contains vault tables (members), and each table contains specifications for one or more vault definitions. Most sites designate a primary vault definition library (the default is $$VAULT in the PARM library), but the number of vault definition libraries that you can use is unlimited.

Vault definitions are also stored in the Control-M/Tape Media Database. Modifications to existing Vault Definitions are only incorporated after a run of vault management utility CTTVTM. For more information about utility CTTVTM, see the INCONTROL for z/OS Utilities Guide.

Vault Definition Entry Panel

Figure 34 Vault Definition Entry Panel

Copy
 ----------------- CONTROL-M/Tape VAULT DEFINITION ENTRY PANEL -------------(TV)
                COMMAND ===>



                SPECIFY LIBRARY, TABLE NAME, VAULT NAME

                LIBRARY   ===> CTT.PROD.PARM
                TABLE     ===>                      (Blank for table selection list)
                VAULT     ===>                      (Blank for vault selection list)







                SHOW VAULT DOCUMENTATION ===> N     (Y/N)
                AUTO-SAVE DOCUMENTATION  ===> N     (Y/N)




            USE THE COMMAND "SHPF" TO SEE PFK ASSIGNMENT                           11.51.11

If you use the selection list fields, their values are not erased until you exit the entry panel by pressing END (PF03/PF15).

Fill in entry panel fields LIBRARY, TABLE, and VAULT as described below to open the desired display:

  • Type Y or N in the SHOW VAULT DOMENTATION field to determine whether vault documentation lines are displayed when the vault is displayed. For more information, see Vault Documentation.

  • Type Y or N in the AUTO-SAVE DOCUMENTATION field to determine whether changes made to documentation are automatically saved (meaning, without special prompting) when updating the rule. For more information, see Rule Documentation.

  • To display the list of tables in a library, do the following:

    1. Type the library name.

    2. Either leave the table name blank, or type part of a table name together with mask characters (* and ?).

    3. Press Enter.

  • To display the list of vaults of a specific rule, do the following:

    1. Type the library name.

    2. Type the table name.

    3. Press Enter.

If the table does not exist, the screen for defining a new vault in the table is displayed.

  • To display the details of a specific vault (Vault Definition screen), do the following:

    1. Type the library name.

    2. Type the table name.

    3. Type the vault name.

    4. Press Enter.

If the table does not exist, or the vault for the specified table does not exist, the screen for defining a new vault in the table is displayed.

If you enter the screen for defining a new rule and want to leave the screen without defining a rule, use the CANCEL command.

Vault Table List Screen

The Vault Table List screen displays a list of vault tables (members) in the specified library. You can enter this screen through the entry panel or when exiting the Vault List screen.

By default, only vault table names are listed in the screen. However, if the default has been modified at time of installation, statistical information is displayed with the vault table name, as shown in Figure 142.

Figure 35 Vault Definition Facility Table List Screen

Copy
  TABLES OF LIBRARY CTT.PROD.PARM                                ------------(TV)
                COMMAND ===>                                                    SCROLL===> CRSR
                OPT  NAME ------VV.MM  CREATED     CHANGED     SIZE  INIT   MOD   ID
                $$POOL     01.09 00/05/24 00/06/09 11:48   198    25     0 M09
                $$VAULT    01.05 00/06/08 00/06/13 15:39   864    40     0 M17A
                ======= >>>>>>>>>>>>>>>> NO MORE TABLES IN THIS LIBRARY <<<<<<<<<<<<<<<<< ====















            OPTIONS:  S SELECT   B BROWSE   D DELETE                               15.07.31

To scroll down the Vault Table list, press PF08/PF20. To scroll up the Vault Table list, press PF07/PF19.

To return to the entry panel, press END (PF03/PF15).

Options of the Vault Table List Screen

To request one of the following options, specify the option in the OPT field to the left of the vault table name, and press Enter:

Table 55 Options of the Table List Screen

Option

Description

S (SELECT)

Display the list of vaults in the vault table for any purpose, including editing and modification. Only one vault table can be selected at a time.

If the S (Select) option is specified in the Vault Table list screen for a vault that is currently in use (selected) by another user, then depending on User profile definition, either the Vault List screen is not displayed (meaning, the Vault Table List screen remains displayed; this is the default), or the Vault List screen is displayed in Browse mode. In either case, an appropriate message is displayed.

B (BROWSE)

Display the list of vaults in a vault table for browsing. Only one vault table can be selected at a time.

D (DELETE)

Delete the vault table (member) from the library. Multiple vault tables can be selected. A confirmation window is displayed. For more information, see Deleting Vault Tables.

The INCONTROL administrator can limit specific users to access only the BROWSE option.

Deleting Vault Tables

To delete vault tables, specify D to the left of the vault table names and press Enter.

The following confirmation window is displayed, in sequence, for each vault table selected for deletion:

Figure 36 Vault Definition Facility Delete Table Confirmation Window

Copy
  TABLES OF LIBRARY CTT.PROD.PARM                                ------------(TV)
                COMMAND ===>                                                    SCROLL===> CRSR
                OPT  NAME ---               +--------------------------+ E  INIT   MOD   ID
                $$POOL                 |  CONFIRM DELETE OPTION   |      0 M09
                D   $$VAULT    <-----------|              (Y/N)       |      0 M17A
                ======= >>>>>>>>>>>>>>>> NO +--------------------------+ <<<<<<<<<<<<<<<< ====

















            OPTIONS:  S SELECT   B BROWSE   D DELETE                               15.07.31
  • Specify Y (Yes) in the confirmation window to confirm the delete request.

  • Specify N (No) to cancel the delete request.

If PDSMAN is operational at your site, $$$SPACE members cannot be deleted.

A message is written to the IOA Log file for each vault table that is deleted.

Vault List Screen

The screen displays the list of vaults in a specified table. This screen can be entered directly from the entry panel or the Vault Table List screen, or upon exiting from the Vault Definition screen.

If the S (Select) option is specified in the Vault Table List screen for a table that is currently in use (selected) by another user, then either the Vault List screen is not displayed and the Vault Table List screen remains displayed (the default), or the Vault List screen is displayed in Browse mode (if User profile parameter SSCHBRO overrides the default). In either case, an appropriate message is displayed.

Figure 37 Vault Definition Rule List Screen

Copy
  VAULTS OF LIBRARY CTT.PROD.PARM                                 TABLE: $$VAULT
                COMMAND ===>                                                    SCROLL===> CRSR
                OPT  VAULT ---------------- DESCRIPTION ---------------------------------------
                VAULT_01   FOR DIVISION 1 MEDIA.
                VAULT_02   FOR DIVISION 2 MEDIA.
                VAULT_03   FOR DIVISION 3 MEDIA.
                VAULT_04   FOR DIVISION 4 MEDIA.
                ======= >>>>>>>>>>>>>>>>> NO MORE VAULTS IN THIS TABLE <<<<<<<<<<<<<<<<<< ====















            OPTIONS:  S SELECT   D DELETE   I INSERT   C COPY                      15.26.04

Standard scrolling conventions are supported on the Vault List.

To exit to the Vault List screen, press END (PF03/PF15). For more information, see Exiting the Vault List Screen.

Format of the Vault List Screen

Next to each vault name in the Vault list, certain information can be displayed. The type and format of this information depends on whether the screen is displayed in DESC format or in STAT format.

In DESC format, the vault’s description, taken from the DESC field of the vault definition, is displayed. Default.

In STAT format, the ISPF-like statistical information about the vault is displayed.

By default, the vault list is displayed in DESC format. To change formats, use the DESC or STAT commands, as described below.

Commands of the Vault List Screen

The following commands can be specified in the COMMAND field of the Vault List screen:

Table 56 Commands of the Vault List Screen

Command

Description

DESC

Command DESC displays the vault description next to the vault name. The description is taken from the DESC field in the vault definition.

STAT

Command STAT displays the following ISPF-like statistical information about the vault next to the vault name: version and modification numbers, creation date, last modification date, and user ID.

Options of the Vault List Screen

Specify one of the following vault processing options by marking the option to the left of the vault name and pressing Enter:

If the Vault List screen is displayed in Browse mode, options D (Delete) and I (Insert) are not available.

Table 57 Options of the Vault List Screen

Option

Description

S (SELECT)

Display the Vault Definition screen, with details of the specific vault.

If the Vault List screen is not displayed in Browse mode, the vault definition can be edited and updated. If the Vault List screen is displayed in Browse mode, the vault definition can be browsed, but it cannot be modified.

D (DELETE)

Delete a vault from the Vault list.

I (INSERT)

Insert a new vault in the list. The Vault Definition screen appears, with the same details of the vault marked "I", but the VAULT NAME and DESCRIPTION parameters are empty for you to fill in. The new vault is added after the vault marked "I".

C (COPY)

Copy the vault to another table. Multiple vaults can be selected.

Vault Definition Screen

The Vault Definition screen is used to define, display, and modify parameters of a vault. This screen can be entered directly from the entry panel or from the Vault List screen. Update of parameters is not permitted in Browse mode.

The vault parameters can take up more than one screen.

Figure 38 Vault Definition Screen

Copy
  VAULT MAINLIB  LIB CTT.PROD.VAULTS                              TABLE: $$VAULT
                COMMAND ===>                                                    SCROLL===> CRSR
                +-----------------------------------------------------------------------------+
                VAULT NAME  MAINLIB                                                       
                LOCAL       Y                                                             
                ===========================================================================
                DESC        BACK UP SITE                                                  
                DESC                                                                      
                OWNER       NMZ                                                           
                ADDRESS     1234 MAIN STREET                                              
                ADDRESS                                                                   
                PHONE       609-555-2684                                                  
                SCHEDULE    DAILY PROCESSING                                              
                SCHEDULE                                                                  
                DOCMEM  CTTDOCS    DOCLIB CTT.PROD.DOC                                 
                ============================= GLOBAL CAPACITY ==============================
                CAPACITY 00003000  TYPE SLOT   MEDIA CART           
                00000100  TYPE BOX    MEDIA TAPE      BOX ID BXA    BOX SIZE 000020
                00000045  TYPE BOX    MEDIA 3490      BOX ID BXB    BOX SIZE 000075
                00000500  TYPE SLOT   MEDIA 3490                               
                TYPE          MEDIA                                
                ======= >>>>>>>>>>>>>> END OF VAULT DEFINITION PARAMETERS <<<<<<<<<<<<<<< =====
 
            FILL IN VAULT DEFINITION. CMDS: EDIT, SHPF, DOC                        19.55.58

Vault parameters are divided into the following basic groups shown on the following screen:

  • General Vault Parameters
  • Global Capacity Parameters

The groups are separated by a delimiter line.

To delete a parameter on the screen, erase it (press the EOF key, or blank it out). If additional operations are required, Control-M/Tape issues the appropriate instructions.

The Vault Definition screen can also be edited using ISPF-like editing commands (such as copy, move, repeat, after, and before) in the IOA Edit environment. For additional information, see Editing Rule Definitions in the IOA Edit Environment.

The vault definition is automatically saved to a PDS member that can be edited using a standard editor such as ISPF Edit facility. Vaults originally defined using a standard editor can also be displayed and edited in the Vault Definition screen. The name of the PDS member that contains default vault definitions is $$VAULT.

The Vault Definition screen can be exited in various ways. The most common is to press END (PF03/PF15). For more information, see Exiting the Vault Definition Screen.

Newly-defined or modified Vault definitions become effective only after the next run of utility CTTVTM.

The parameters marked with the symbol M can have many occurrences. Whenever you fill the last occurrence of the parameter on the screen, Control-M/Tape adds a new empty occurrence of that parameter that you can fill in. The only limit to the number of occurrences is the region size available for the application.

General Vault Parameters

General Vault parameters provide basic information about a vault.

Figure 39 General Vault Parameters

Copy
  VAULT NAME  VAULT_01                                                        
                LOCAL       Y                                                              
                ===========================================================================
                DESC        FOR DIVISION 1 MEDIA.                                          
                DESC                                                                       
                OWNER       M43                                                            
                ADDRESS     1234 MAIN STREET                                               
                ADDRESS                                                                    
                PHONE       609-555-2684                                                   
                SCHEDULE    DAILY PROCESSING                                               
                SCHEDULE                                                                   
            DOCMEM  CTTDOCS       DOCLIB CTT.PROD.DOC                                  

Table 58 General Vault Parameters

Parameter

Description

VAULT NAME

Name of the vault.

LOCAL

Indicates whether the vault is local or remote (that is, on-site or off-site). Valid values are:

  • Y (Yes) — The vault is a local vault.
  • N (No) — The vault is a remote vault.

DESC

Description of the vault (free text).

OWNER

User ID of the user who owns this vault.

ADDRESS

Address of the vault (free text).

PHONE

Telephone number of the vault (free text).

SCHEDULE

Volume picking information (free text).

DOCMEM

Name of the member in which vault documentation resides.

DOCLIB

Name of the library in which vault documentation resides.

Global Capacity Parameters

Global Capacity parameters provide information about the capacity of the vault.

Figure 40 Global Capacity Parameters

Copy
============================= GLOBAL CAPACITY ==============================
                CAPACITY 00003000  TYPE SLOT  MEDIA CART
                00000100  TYPE BOX   MEDIA TAPE      BOX ID BXA    BOX SIZE 000020
            TYPE       MEDIA                                        

Table 59 Global Capacity Parameters

Parameter

Description

CAPACITYM

List of capacities for various types of removable media. Each line of the list contains the following parameters:

  • Quantity – Maximum number of units of the media type.
  • TYPE – Type of media storage (SLOT, BOX).
  • MEDIA – Type of media (for example, cartridge, 3400 tape, 3490).

The following fields are only shown if the vault name is MAINLIB and the storage type is BOX.

  • BOX ID – Name or prefix of the box. The full name cannot exceed six characters.
    The capacity indicates the number of boxes to define.
    If the capacity is 1, one box is defined, and this field indicates the full name of the box.
    If the capacity exceeds 1, this field indicates a prefix, and a sequentially assigned serial number for each box completes the name (the prefix and serial number combined cannot exceed six characters).
  • BOX SIZE – If TYPE is equal to BOX, maximum number of media per box.

Commands of the Vault Definition Screen

The following commands can be specified in the COMMAND field of the Vault Definition screen:

Table 60 Commands of the Vault Definition Screen

Command

Description

EDIT

The EDIT command alternately activates or deactivates the Edit environment of the Vault Definition screen. The Edit environment provides ISPF-like line editing commands for this screen. For more information, see Editing Rule Definitions in the IOA Edit Environment.

DOC

The DOC command alternately displays or hides documentation lines (independent of the SHOW VAULT DOCUMENTATION field). For additional information, see Vault Documentation.

Vault Documentation

This item includes the following topics.

Display and Non-Display of Documentation

Depending on the value of the SHOW VAULT DOCUMENTATION field in the entry panel, vault documentation (meaning, DOC lines) is either displayed or hidden when you first enter the Vault Definition screen:

  • If the SHOW VAULT DOCUMENTATION field is set to Y (Yes), vault documentation is displayed.
  • If the SHOW VAULT DOCUMENTATION field is set to N (No), vault documentation is hidden.

Specifying the DOC command in the COMMAND field alternately displays or hides the vault’s documentation.

The following is an example of the Vault Definition screen with documentation (DOC lines) displayed.

The DOC command alternately displays or hides documentation lines (independent of the SHOW VAULT DOCUMENTATION field).

Figure 41 Vault Definition Screen with Documentation

Copy
  VAULT VAULT_01 LIB CTT.PROD.VAULTS                              TABLE: $$VAULT
                COMMAND ===>                                                    SCROLL===> CRSR
                +-----------------------------------------------------------------------------+
                VAULT NAME  VAULT_01                                                       
                LOCAL       Y                                                              
                ===========================================================================
                DESC        FOR DIVISION 1 MEDIA.                                          
                DESC                                                                       
                OWNER       M43                                                            
                ADDRESS     1234 MAIN STREET                                               
                ADDRESS                                                                    
                PHONE       609-555-2684                                                   
                SCHEDULE    DAILY PROCESSING                                               
                SCHEDULE                                                                   
                DOCMEM  CTTDOCS       DOCLIB CTT.PROD.DOC                                  
                ===========================================================================
                DOC THIS SCREEN SHOWS WHERE THE DOCUMENTATION WILL APPEAR ON THE SCREEN    
                DOC WHEN YOU USE THE DOC COMMAND. AS YOU CAN SEE, THE LINES FOLLOWING      
                DOC THE DOCUMENTATION WILL BE "PUSHED" DOWNWARD. ENTER THE DOC COMMAND 
                DOC AGAIN TO MAKE THIS DOCUMENTATION DISAPPEAR.       
                DOC                                                             
                ============================== GLOBAL CAPACITY ==============================
                CAPACITY 00001000      TYPE   SLOT     MEDIA 3400 
            FILL IN VAULT DEFINITION. CMDS: EDIT, SHPF, DOC                        09.00.26       

Users with DOCU/TEXT installed at their site can specify a DOCU/TEXT library and member. However, only files with an 80 character record length can be used, and only the first 71 characters are displayed.

Editing Documentation

Documentation can be edited when the DOC lines of the Vault Definition screen are displayed. Modify the DOC lines as desired. When you fill in the last DOC line and press Enter, a new DOC line is displayed.

Vault documentation is written to the member or library specified in the DOCMEM and DOCLIB fields in the Vault Definition screen. Therefore, it is also possible to edit the documentation directly through ISPF edit of the member; this is recommended for extensive documentation, or if complex editing is required.

For CA-LIBRARIAN and CA-PANVALET users, the DOC command displays or hides vault documentation, but changes to the documentation are not stored. A warning message is not issued.

AutoSave and Saving Documentation

Documentation changes can be saved upon exiting the Vault Definition screen. When there are documentation changes, a Save Documentation window can be displayed depending on the value of the AUTO-SAVE DOCUMENTATION field in the entry panel:

  • If the AUTO-SAVE DOCUMENTATION field was set to Y (Yes), documentation changes are automatically saved and the Save Documentation window is not displayed.
  • If the AUTO-SAVE DOCUMENTATION field was set to N (No), documentation changes are not automatically saved, and the Save Documentation window is displayed as shown below. This window enables you to save or cancel the documentation changes.

Figure 42 Vault Definition Save Documentation Window

Copy
 VAULT VAULT_01 LIB CTT.PROD.VAULTS                              TABLE: $$VAULT
                COMMAN +-----------------------------------------------------------+  ===> CRSR
                +----- |                                                           | --------+
                VAUL  |   SAVE DOCUMENTATION ==> Y      (Y/N)                     |      
                LOCA  |                                                           |      
                ====  |   LIBRARY CTT.PROD.DOCS                                   | =======
                DESC  |   MEMBER  CTTDOCS                                         |      
                DESC  |                                                           |      
                OWNE  +-----------------------------------------------------------+         
                ADDRESS                                                                    
                PHONE       609-555-2684                                                   
                SCHEDULE    DAILY PROCESSING                                               
                SCHEDULE                                                                   
                DOCMEM  CTTDOCS       DOCLIB CTT.PROD.DOC                                  
                ===========================================================================
                DOC THIS SCREEN SHOWS WHERE THE DOCUMENTATION WILL APPEAR ON THE SCREEN    
                DOC WHEN YOU USE THE DOC COMMAND. AS YOU CAN SEE, THE LINES FOLLOWING      
                DOC THE DOCUMENTATION WILL BE "PUSHED" DOWNWARD. ENTER THE DOC COMMAND 
                DOC AGAIN TO MAKE THIS DOCUMENTATION DISAPPEAR.       
                DOC                                                             
                ============================== GLOBAL CAPACITY ==============================
                CAPACITY 00001000      TYPE   SLOT     MEDIA 3400
            FILL IN VAULT DEFINITION. CMDS: EDIT, SHPF, DOC                        09.00.26

You can change the name of the library or member in the window.

  • Enter Y (Yes) in the SAVE DOCUMENTATION field to save the changes.
  • Enter N (No) in the SAVE DOCUMENTATION field to cancel the changes.

After specifying Y or N, the Vault List screen is displayed.

Exiting the Vault Definition Facility

To exit the Vault Definition facility, the following screens must be exited in sequence:

Table 61 Exiting the Vault Definition Facility Screen

Screen

Vault

Vault Definition screen

How you exit this screen depends on whether changes made in the Vault Definition screen should be saved. For more information, see Exiting the Vault Definition Screen.

Vault List screen

How you exit this screen depends on whether changes made to each vault should be saved. For more information, see Copying Vault Definitions to Another Table.

Vault Table List screen

Exit this screen by pressing END (PF03/PF15).

Entry panel

Exit this screen by pressing END (PF03/PF15).

Exiting the Vault Definition Screen

Use the following commands to exit the Vault Definition screen:

Table 62 Commands for Exiting the Vault Definition Screen

Command

Description

END

Keep the changes made to the parameters of the vault and return to the Vault List screen. If documentation changes have been made, the Save Documentation window may be displayed. For more information, see Exiting the Vault List Screen.

CANCEL

Do not keep the changes made to the parameters of the vault and return to the Vault List screen. For more information, see Exiting the Vault List Screen.

NEXTVLT

Keep the changes made to the parameters of the vault and display the next vault in the Vault list (PF11/PF23).

PREVVLT

Keep the changes made to the parameters of the vault and display the previous vault in the Vault list (PF10/PF22).

Changes made to Vault Definition parameters are initially only in memory. They are written to the disk after you exit the Vault List screen.

Exiting the Vault List Screen

Press END (PF03/PF15) to exit the Vault List screen. If changes have been made in the Vault Definition screen and the Vault Definition screen was exited with END (PF03/PF15), an Exit Option window is opened.  

Figure 43 Vault List Screen Exit Option Window

Copy
  VAULTS OF LIBRARY CTT.PROD.PARM                                 TABLE: $$VAULT
                COMMAN +-----------------------------------------------------------+  ===> CRSR
                OPT  N |                PLEASE SELECT EXIT OPTION                  |  ---------
                $ |                                                           |
                $ |    SAVE Y  CREATE                                         |
                ===== |                                                           |  <<<< ====
                |    LIBRARY CTT.PROD.PARM                                  |
                |    TABLE   $$VAULT                                        |
                |                                                           |
                +-----------------------------------------------------------+













            OPTIONS:  S SELECT   D DELETE   I INSERT                               11.14.37

It is possible to change the name of the library or the name of the vault in the window.

  • To save the changes to all modified vaults and return to the Vault Table List screen, enter Y (Yes) in the SAVE field if the table name exists in the specified library, or enter Y (Yes) in the CREATE field to create a new table name in the specified library.
  • To cancel the changes to all modified vaults and return to the Vault Table List screen, enter N (No) in one of the exit options.
  • Press RESET (PF04/PF16) in the Exit Option window to cancel the exit operation, and remain in the Vault List screen.
  • To save changes made to vault parameters in the vault table, the entire table must be saved by entering Y in one of the exit options of the Vault List screen.

Copying Vault Definitions to Another Table

To copy one or more vault definitions from the current table to another table, specify option C (Copy) by the table names in the Vault List screen and press Enter. The following window is displayed:

Figure 44 Window for Copying Vaults to Another Table

Copy
VAULTS OF LIBRARY CTT.PROD.PARM                                 VAULT: PLRPT010
                COMMAND ===>                                                    SCROLL===> CRSR
                OPT  NAME ---------------------------------------------------------------------
                C   VAULT1                 MAIN LIBRARY
                VAULT2                 BACKUP LIBRARY
                                                                             
                                                                             
                +-----------------------------------------------------------+
                |                                                           |
                |     SPECIFY DESTINATION LIBRARY,TABLE AND RULE NAME       |
                |                                                           |
                |  LIBRARY :   CTM.PROD.VAULTS                              |
                |  TABLE :                                                  |
                |  VAULT :     POOL1                                        |
                |                                                           |
                |  PRESS END/RESET TO CANCEL     ENTER TO PERFORM THE COPY  |
                +-----------------------------------------------------------+
                                                                             
                                                                             
                                                                             
                                                                             
                                                                             
                                                                             
                                                                             
            

The window contains the following fields (some fields contain default values that can be modified):

Table 63 Fields in the Window for Copying Vaults to Another Table

Field

Description

LIBRARY

Library containing the table into which the vault definitions should be copied. Must be an existing library. Default is the current library.

TABLE

Name of the table into which the vault should be copied.

A table can only be copied to another table. It cannot be copied to its own table (even if the vault is renamed).

If the specified table does not exist, the table is created when the request is performed.

VAULT

Name of the vault definition to be copied. If multiple vault definitions are selected, the window is first displayed with the first selected vault definition. As each request is performed or canceled, the next requested vault definition name appears.

  • To perform a request, press Enter.

  • To cancel a request, press END (PF03/PF15) or RESET (PF04/PF16).

Inquiries and Updates

The Media Database list describes volumes and data sets that are selected according to selection criteria specified in the Inquire/Update entry panel.

The information displayed in the Media Database list is obtained from volume and data set records in the Media Database.

The Media Database list is displayed in the Media Database List screen. From this screen, you can perform the following operations on the Media Database list:

  • Request additional information for any volume or data set.

  • List all data sets on a given volume, or all volumes where a specific data set resides.

  • List all volumes of a multi-volume chain to which a specific volume belongs.

  • Update displayed information.

  • Expire a volume or data set.

  • Extend the expiration date of a volume or data set.

  • Unscratch a volume or data set.

  • Check out a volume.

  • Reenter a volume that was checked out.

  • Recall a volume from a vault.

  • Send a volume to a vault.

  • Indicate that a volume was cleaned.

  • Print labels.

  • Delete or Undelete a volume.

To maintain synchronization between the Control-M/Tape database and the Robotic tape library database, similar operations are automatically invoked on the Robotic tape library database.

To enter the Inquire/Update screen, specify option TI (INQ/UPD MEDIA DB) in the IOA Primary Option menu. The Inquire/Update entry panel is displayed.

As of version 6.0.00, information from the Media Database can also be displayed from operating system consoles. This feature is designed for operations personnel, for whom the console is often more readily available than a TSO/E session. For more information, see Displaying Media Database Information on a z/OS Console.

Inquire/Update Entry Panel

The Inquire/Update entry panel is the main user interface to Control-M/Tape removable media management information.

Figure 45 Inquire/Update Entry Panel

Copy
 ----------------  CONTROL-M/Tape - INQUIRE/UPDATE ENTRY PANEL  ------------(TI)
                COMMAND ==>                                                                   
                SELECT BY:                                                                    
                MEDIA        ===>                        Media type                        
                DSNAME       ===>                                                          
                VOLSER       ===>          TO            Volser/Mask                       
                SL-NAME      ===> *        TO            SL-Name/Mask                      
                POOL         ===>                        Pool name/Mask                    
                LOCATION     ===>                        Location name/Mask                
                                                                               
                SELECT BY DATE:                                                               
                CREATE FROM  ===>          TO            Creation date range               
                EXPIRE FROM  ===>          TO            Expiration date range             
                ACCESS FROM  ===>          TO            Last access date range            
                                                                               
                SELECT BY STATUS:                                                             
                ACTIVE       ===> Y                      VAULTED only ===> N               
                SCRATCH      ===> Y                      EXTERNAL     ===> Y               
                EDM CONTROL  ===> Y                      ATL/VTS only ===> N               
                                                         WORM only    ===> N               
                DISPLAY OPTIONS:                                                              
                DISPLAY TYPE ===> V                      RECORD TYPE  ===>                 
                                                                               
                                                                               
            FILL IN THE SELECTION CRITERIA, AND PRESS ENTER                       16.01.59

The entry panel allows you to specify selection criteria and display options for volumes and data sets. Fill in the selection criteria and display options, and press Enter. A list of all volumes and data sets that conform to the selection criteria is displayed in the Media Database list in the Media Database List screen.

The entry panel enables you to request different combinations of information. For example, you can list data set information, volume information, volume information for the selected data sets, and data set information for selected volumes. For additional information, see "DISPLAY OPTIONS" in Fields of the Inquire/Update Entry Panel.

Press END (PF03/PF15) to exit the entry panel to the IOA Option menu.

Fields of the Inquire/Update Entry Panel

From the entry panel you can specify any of the following selection criteria to control which volumes and data sets appear in the list:

The relationship between each category is AND – meaning, all specified criteria in each category must be satisfied for a volume or data set to appear in the list.

SELECT BY

SELECT BY selection criteria that are marked below with the H symbol permit character masking. For more information, see Character Masking.

Table 64 Inquire/Update Entry Panel SELECT BY Selection Criteria

Criterion

Description

MEDIA

Type of volume media.

DSNAMEM

Data set name.

To indicate a specific generation of a GDG data set, specify the generation number in parentheses after the data set name.

DB.LOG96(-1).

If a mask is specified for the data set name, Control-M/Tape displays the specified generation of all GDG data sets matching the specified mask.

For more information, see Control-M/Tape Handling of Data Set Generations.

VOLSER from/toM

Lowest and highest volume serial numbers.

SL-NAME from/toM

Lowest and highest standard label name values.

POOLM

Volumes of the specified pools.

LOCATIONM

Volumes in the specified locations (for example, VAULTA, VAULTB, MAINLIB).

SELECT BY DATE

Table 65 Inquire/Update Entry Panel SELECT BY DATE Selection Criteria

Criterion

Description

CREATE from/to

Earliest and latest data set creation dates to be included in the list.a

EXPIRE from/to

Earliest and latest volume and data set expiration dates to be included in the list.a

ACCESS from/to

Earliest and latest volume and data set last access dates to be included in the list.a

SELECT BY STATUS

Only volumes and data sets that meet the selected status criteria are displayed:

Table 66 Inquire/Update Entry Panel SELECT BY STATUS Selection Criteria

Criterion

Description

ACTIVE

Volumes that contain data sets (meaning, non-scratch), including volumes that are currently out of the library (checked out), vaulted, and volumes pending scratch.

SCRATCH

Volumes that have been scratched, including those that are pending scratch or deleted.

EDM CONTROL

Volumes under EDM control, including EDM volumes that are currently out of the library (checked out) and EDM volumes that are vaulted.

VAULTED only

Vaulted volumes and volumes that are pending vault only.

EXTERNAL

External volumes that are currently out of the library (checked out) and external volumes that are vaulted.

ATL/VTS only

Volumes that currently reside in a robotic tape library.

WORM only

Active WORM volumes, including EDM WORM volumes.

DISPLAY OPTIONS

Table 67 Inquire/Update DISPLAY OPTIONS

Option

Description

DISPLAY TYPE

Display type (or format) of the Media Database list. Valid values:a

  • D – Data set format.
  • V – Volume format.
  • B – Format that lists both volumes and data sets.
  • S – System programmer format.

Examples of these formats are provided later in this chapter.

While in the Inquire/Update screen, the display type can be changed using the DISPLAY command.

RECORD TYPE

Identifies whether Media Database information from data set records, volume records or both should be displayed. Valid values are:

  • Blank – The type of record to display is determined by specifications in the SELECT BY criteria fields. If data set criteria are specified (meaning, DSNAME), data set records are displayed (record type =D). If volume criteria are specified (meaning, MEDIA, VOLSER, SL-NAME, POOL, and LOCATION), volume records are displayed (record type =V). This is the recommended value.
  • D – Data set record information.
  • V – Volume record information.
  • DV – Data set record information, followed by corresponding volume record information.
  • VD – Volume record information, followed by corresponding data set record information.

The records are displayed in the format specified by field DISPLAY TYPE (see above).

A blank value for the RECORD TYPE field is recommended because:

  • When Control-M/Tape anticipates the desired record type, it is guaranteed that the volumes and data sets are listed in a logical, meaningful order.

  • The record type also determines the search method used by Control-M/Tape when listing the volumes and data sets. Leaving the RECORD TYPE field blank ensures that Control-M/Tape uses the optimal search method for a faster response time and best performance.

Control-M/Tape automatically selects an appropriate record type depending on the display type. The automatically selected record type can be overridden through a value specified in the RECORD TYPE field. This field should only be used when a sophisticated display is needed.

Choosing a record type that does not match the selection criteria forces Control-M/Tape to scan the database record by record, instead of retrieving records through the index. This can cause considerable delay in retrieval of relevant records.

Display of Date Fields

Date fields are displayed with either 2-character or 4-character years, depending on the value of the IOA profile parameter PDATELTH.

Media Database List Screen

The Media Database list displays the list of volumes and/or data sets that meet the selection criteria.

Information for the Media Database List screen is obtained from the following types of records in the Media Database:

Table 68 Media Database Record Types

 

 

Record

Description

Volume records

Contain volume information, such as VOLSER, SL-NAME, LOCATION, and FILES (total number of files on the volume).

Data set records

Contain data set information, such as DATASET NAME, RETENTION, and CR-DATE.

Volumes that are part of a group of volumes (meaning, when a data set spans multiple volumes) are displayed with an asterisk suffix.

Header Line

The Media Database list has a header line at the top of the screen indicating display types specified in the entry panel.

Copy
  DATABASE LIST < B / DV > --------------------------------------------------(TI)
                COMMAND ===>                                                    SCROLL===> CRSR
            O VOLSER/DATASET NAME                            CR-DATE   RETENTION     STATUS

Table 69 Media Database List Header Line Display Types

Type

Value

Display type

Valid values are:

  • V – Volume
  • D – Data set
  • B – Both
  • S – System programmer

Record type

Valid values are:

  • V – Volume
  • D – Data set
  • VD – Volumes followed by data sets
  • DV – Data sets followed by volumes

Display Types and Fields

For each kind of Media Database list, a number of predefined display types are available.

While in the Media Database List screen, the display type can be changed through the DISPLAY command. Format of the command is:

Copy
DISPLAY x

where x is the identifying letter for the desired type. DISPLAY can be abbreviated to DI.

Copy
DI D

displays the data set format.

Predefined values are:

  • D – Data set format.

  • V – Volume format.

  • B – Format that lists both volumes and data sets.

  • S – System programmer format.

These display types, and the fields they contain, are described in the following topics.

You can modify display types and define new display types to suit the your needs. For information, see the IOA administration chapter of the INCONTROL for z/OS Administrator Guide.

Copy
Display Type V (Volume)

Figure 46 through Figure 49 show examples of display type V (Volume) for record type specifications D, V, DV, and VD. This display type presents volume and data set information in volume format. Fields are discussed below.

If the record type is D (Data set) when the display type is V (Volume), Control-M/Tape presents the volume information found in the data set records. (for example, VOLSER and FILE NUMBER).

Figure 46 Inquire/Update Display Type V (Volume), Record Type V (Volume)

Copy
 DATABASE LIST < V / V  > --------------------------------------------------(TI)
                COMMAND ===>                                                    SCROLL===> CRSR
                O VOLSER    VOLSEQ MEDIA      RETENTION  L-ACCESS  FILES LOCATION ---STATUS----
                BSTK01           3490       21/11/01   22/11/00   0000 MAINLIB  EDM Control 
                BSTK03           3490       15/07/01   22/11/00   0000 MAINLIB  Scratch     
                CTTCTT           TAPE         ***      16/07/01   0000 MAINLIB  Scratch     
                DFP001           CART       15/07/01              0000 MAINLIB  Scratch     
                EXT003           3590       07/11/01              0000 MAINLIB  Ext-Scratch 
                FD3726           3490       15/07/01   22/11/00   0000 MAINLIB  Scratch     
                FD3861           3490       15/07/01   22/11/00   0000 MAINLIB  Scratch     
                L14789           CARTL        ***                 0000 MAINLIB  Scratch     
                TI0001           3490       15/07/01   22/11/00   0000 MAINLIB  Scratch     
            UE0277           3490       15/07/01   22/11/00   0000 MAINLIB  Scratch

Figure 47 Inquire/Update Display Type V (Volume), Record Type D (Data Set)

Copy
 DATABASE LIST < V / D  > --------------------------------------------------(TI)
                COMMAND ===>                                                    SCROLL===> CRSR
                O ---DATASET NAME----------------------------- FILE NUMBER        DS STATUS   
                K27.TEST.LBI                                        0001        Active      
                K27.TEST.T005                                       0005        Scratch     
                K28.TEST.T001                                       0001        Active      
                LIXT01                                              0001        Scratch     
                LIXT02                                              0002        Scratch     
                LIXT03                                              0003        Active      
                M04.JOB1                                            0001        Scratch     
                M04.JOB2                                            0001        Scratch     
                M04.JOB3                                            0001        Scratch     
            N65.CHECK.VAULT.AB1                                 0001        Active      

Figure 48 Inquire/Update Display Type V (Volume), Record Type VD (Volume/Data Set)

Copy
 DATABASE LIST < V / VD > --------------------------------------------------(TI)
                COMMAND ===>                                                    SCROLL===> CRSR
                O VOLSER    VOLSEQ MEDIA      RETENTION  L-ACCESS  FILES LOCATION ---STATUS----
                AAAAA5*      001 3490         ***                 0000 MAINLIB  Scratch     
                M04.JOB1                                           0001        Scratch     
                M04.JOB5                                           0001        Scratch     
                AAAAA6           3490         ***                 0001 MAINLIB  Pend-Vault  
                AAAAA7*      002 3490         ***                 0000 MAINLIB  Scratch     
                M04.JOB2                                           0001        Scratch     
                AAAAA8*      003 3490         ***                 0000 MAINLIB  Scratch     
                M04.JOB3                                           0001        Scratch     
                AAAAA9*      004 3490         ***                 0000 MAINLIB  Scratch     
            M04.JOB4                                           0001        Scratch    

Figure 49 Inquire/Update Display Type V (Volume), Record Type DV (Data Set/Volume)

Copy
 DATABASE LIST < V / DV > --------------------------------------------------(TI)
                COMMAND ===>                                                    SCROLL===> CRSR
                O ---DATASET NAME----------------------------- FILE NUMBER        DS STATUS   
                M04.JOB1                                            0001        Scratch     
                AAAAA5*     001 3490         ***                 0000 MAINLIB  Scratch     
                M04.JOB2                                            0001        Scratch     
                AAAAA7*     002 3490         ***                 0000 MAINLIB  Scratch     
                M04.JOB3                                            0001        Scratch     
                AAAAA8*     003 3490         ***                 0000 MAINLIB  Scratch     
                M04.JOB4                                            0001        Scratch     
                AAAAA9*     004 3490         ***                 0000 MAINLIB  Scratch     
                M04.JOB5                                            0001        Scratch     
            AAAAA5*     001 3490         ***                 0000 MAINLIB  Scratch     

Table 70 Fields in Display Type V (Volume) for Volume Records

Field

Description

VOLSER

Volume serial number.

VOLSEQ

Sequential number of the volume within a multi-volume chain.

MEDIA

Media type.

RETENTION

Volume retention period.  A value of *** in the TI screen indicates that a specific expiration date cannot be determined because the retention is controlled by one of the following retention types:

  • MVS CATALOG
  • EDM
  • CYCLES
  • SMS MGMTCLAS
  • PERMANENT

L-ACCESS

Last access date of the volume.

FILES

Number of data sets stored on the volume.

LOCATION

Location of the volume.

STATUS

Status of the volume. For more information, see Statuses of Volumes and Data Sets.

Table 71 Fields in Display Type V (Volume) for Data Set Records

Field

Description

DATASET NAME

Name of the data set.

FILE NUMBER

Positional number of the data set on the volume.

DS STATUS

Status of the data set. For more information, see Statuses of Volumes and Data Sets.

Display Type D (Data Set)

Figure 50 through Figure 53 show examples of display type D (Data set) for record type specifications D, V, DV, and VD. This display type presents volume and data set information in data set format. Fields of this display type are discussed on the following page.

If the record type is V (Volume) when the display type is D (Data set), Control-M/Tape presents the volume information found in the data set records. (for example, VOLSER and FILE NUMBER).

Figure 50 Inquire/Update Display Type D (Data Set), Record Type V (Volume)

Copy
 DATABASE LIST < D / V  > --------------------------------------------------(TI)
                COMMAND ===>                                                    SCROLL===> CRSR
                O VOLSER     VOLSEQ                                                           
                AAAAA3                                 Files: 0000                          
                AAAAA4                                 Files: 0000                          
                AAAAA5*      001                       Files: 0000                          
                AAAAA6                                 Files: 0001                          
                AAAAA7*      002                       Files: 0000                          
                BSTK01                                 Files: 0000                          
                BSTK03                                 Files: 0000                          
                CTTCTT                                 Files: 0000                          
                DFP001                                 Files: 0000                          
            EXT003                                 Files: 0000                          

Figure 51 Inquire/Update Display Type D (Data Set), Record Type D (Data Set)

Copy
 DATABASE LIST < D / D  > --------------------------------------------------(TI)
                COMMAND ===>                                                    SCROLL===> CRSR
                O ---DATASET NAME-----------------------------   VOLSER  RETENTION  STATUS    
                M04.ALL                                        UUUUU7  CATALOG    Active    
                M04.ALL                                        UUUUU9  03/02/02   Active    
                M04.ALL.O                                      UUUU11  03/02/02   Active    
                M04.JOB1                                       AAAAA5  CATALOG    Scratch   
                M04.JOB2                                       AAAAA7  CATALOG    Scratch   
                M04.JOB3                                       AAAAA8  CATALOG    Scratch   
                M04.JOB4                                       AAAAA9  CATALOG    Scratch   
                M04.JOB5                                       BBBB10  29/11/01   Scratch   
                M04.JOB5                                       AAAAA5  CATALOG    Scratch   
            M04.OOO                                        UUUUU6  CATALOG    Active    

Figure 52 Inquire/Update Display Type D (Data Set), Record Type VD (Volume/Data Set)

Copy
 DATABASE LIST < D / VD > --------------------------------------------------(TI)
                COMMAND ===>                                                    SCROLL===> CRSR
                O VOLSER     VOLSEQ                                                           
                AAAAA3                                 Files: 0000                          
                AAAAA4                                 Files: 0000                          
                AAAAA5*      001                       Files: 0000                          
                M04.JOB1                                      AAAAA5  CATALOG    Scratch   
                M04.JOB5                                      AAAAA5  CATALOG    Scratch   
                AAAAA6                                 Files: 0001                          
                BBBB03                                 Files: 0001                          
                K28.TEST.T001                                 BBBB03  06/12/01   Active    
                BBBB04                                 Files: 0001                          
            K27.TEST.LBI                                  BBBB04  14/11/01   Active    

Figure 53 Inquire/Update Display Type D (Data Set), Record Type DV (Data Set/Volume)

Copy
 DATABASE LIST < D / DV > --------------------------------------------------(TI)
                COMMAND ===>                                                    SCROLL===> CRSR
                O ---DATASET NAME-----------------------------   VOLSER  RETENTION  STATUS    
                K27.TEST.LBI                                   BABA04  14/11/01   Active    
                BABA04                                Files: 0001                          
                M04.ALL                                        UUUUU7  CATALOG    Active    
                UUUUU7                                Files: 0001                          
                M04.ALL                                        UUUUU9  03/02/02   Active    
                UUUUU9                                Files: 0001                          
                M04.ALL                                        UUUUU9  03/02/02   Active    
                UUUUU9                                Files: 0001                          
                M04.ALL.O                                      UUUU11  03/02/02   Active    
            UUUU11*     001                       Files: 0001                          

Table 72 Fields in Display Type D (Data Set) for Data Set Records

Field

Description

DATASET NAME

Name of the data set.

VOLSER

Volume serial number of the volume on which the data set is located.

RETENTION

Retention period for the data set.

STATUS

Status of the data set. For more information, see Statuses of Volumes and Data Sets.

Table 73 Fields in Display Type D (Data Set) for Volume Records

Field

Description

VOLSER

Volume serial number.

VOLSEQ

Sequential number of the volume within a multi-volume chain.

Files:

Number of data sets stored on the volume.

Display Type B (Both)

Figure 54 through Figure 57 show examples of display type B (Both) for record type specifications D, V, DV, and VD. This display type presents volume and data set information in a format for both volumes and data sets. Fields are discussed on the following page.

Figure 54 Inquire/Update Display Type B (Both), Record Type V (Volume)

Copy
 DATABASE LIST < B / V  > --------------------------------------------------(TI)
                COMMAND ===>                                                    SCROLL===> CRSR
                O VOLSER/DATASET NAME                            CR-DATE   RETENTION   STATUS 
                AAAAA3                                                    21/11/01   EDM-Expo
                AAAAA4                                                    04/12/01   Act-Expo
                AAAAA5*      001                                            ***      Scratch
                AAAAA6                                                      ***      Pend-Vau
                AAAAA7*      002                                            ***      Scratch
                AAAAA8*      003                                            ***      Scratch
                AAAAA9*      004                                            ***      Scratch
                BSTK01                                                    21/11/01   EDM Cont
                BSTK03                                                    15/07/01   Scratch
            CTTCTT                                                      ***      Scratch

Figure 55 Inquire/Update Display Type B (Both), Record Type D (Data Set)

Copy
 DATABASE LIST < B / D  > --------------------------------------------------(TI)
                COMMAND ===>                                                    SCROLL===> CRSR
                O VOLSER/DATASET NAME                            CR-DATE   RETENTION   STATUS 
                K27.TEST.LBI                                   30/08/01   14/11/01   Active 
                K27.TEST.T005                                  23/01/01   07/12/01   Active 
                K28.TEST.T001                                  01/02/01   06/12/01   Active 
                LIXT01                                         19/11/01   21/11/01   Scratch
                LIXT01                                         03/12/01   CATALOG    Active 
                LIXT02                                         19/11/01   21/11/01   Scratch
                LIXT03                                         19/11/01   21/11/01   Scratch
                M04.ALL                                        04/12/01   CATALOG    Active 
                M04.ALL                                        05/12/01   03/02/02   Active 
            M04.ALL.JOB9                                   05/12/01   PERMANENT  Active 

Figure 56 Inquire/Update Display Type B (Both), Record Type VD (Volume/Data Set)

Copy
 DATABASE LIST < B / VD > --------------------------------------------------(TI)
                COMMAND ===>                                                    SCROLL===> CRSR
                O VOLSER/DATASET NAME                            CR-DATE   RETENTION   STATUS 
                AAAAA3                                                    21/11/01   EDM-Expo
                AAAAA4                                                    04/12/01   Act-Expo
                AAAAA5*      001                                            ***      Scratch
                M04.JOB1                                      02/08/01   CATALOG    Scratch
                M04.JOB5                                      02/08/01   CATALOG    Scratch
                AAAAA6                                                      ***      Pend-Vau
                BBBB03                                                    06/12/01   Act-ATL
                K28.TEST.T001                                 01/02/01   06/12/01   Active 
                BBBB04                                                    14/11/01   Act-Out
            K27.TEST.LBI                                  30/08/01   14/11/01   Active 

Figure 57 Inquire/Update Display Type B (Both), Record Type DV (Data Set/Volume)

Copy
 DATABASE LIST < B / DV > --------------------------------------------------(TI)
                COMMAND ===>                                                    SCROLL===> CRSR
                O VOLSER/DATASET NAME                            CR-DATE   RETENTION   STATUS 
                K27.TEST.LBI                                   30/08/01   14/11/01   Active 
                BABA04                                                   14/11/01   Act-Out
                K28.TEST.T001                                  01/02/01   06/12/01   Active 
                BABA03                                                   06/12/01   Act-ATL
                LIXT01                                         03/12/01   CATALOG    Active 
                RETEN                                                      ***      Ext-Acti
                M04.ALL                                        04/12/01   CATALOG    Active 
                UUUUU7                                                     ***      Ext-Acti
                M04.ALL                                        05/12/01   03/02/02   Active 
            UUUUU9                                                   03/02/02   Ext-Acti

Table 74 Fields in Display Type B (Both) for Volume and/or Data Set Records

Field

Description

VOLSER/DATASET NAME

Volume serial number or data set name (depending on the record being displayed).

CR-DATE

Retention period for the volume or data set.

RETENTION

Expiration date of the volume or data set. A value of *** in the TI screen indicates that a specific expiration date cannot be determined because the retention is controlled by one of the following retention types:

  • MVS CATALOG
  • EDM
  • CYCLES
  • SMS MGMTCLAS
  • PERMANENT

STATUS

Status of the volume or data set. For more information, see Statuses of Volumes and Data Sets

Display Type S (System Programmer)

Figure 58 through Figure 61 show examples of display type S (System Programmer) for record type specifications D, V, DV, and VD. This display type displays the same volume and data set information (in the same format) as display type B. This display type differs from display type B in that when additional information is requested (discussed in this chapter), this display type adds additional information fields that are relevant only to system programmers. Fields are discussed on the following page.

Figure 58 Inquire/Update Display Type S (System Programmer), Record Type V (Volume)

Copy
 DATABASE LIST < S / V  > --------------------------------------------------(TI)
                COMMAND ===>                                                    SCROLL===> CRSR
                O VOLSER/DATASET NAME                            CR-DATE   RETENTION   STATUS 
                AAAAA3                                                    21/11/01   EDM-Expo
                AAAAA4                                                    04/12/01   Act-Expo
                AAAAA5*      001                                            ***      Scratch
                AAAAA6                                                      ***      Pend-Vau
                AAAAA7*      002                                            ***      Scratch
                AAAAA8*      003                                            ***      Scratch
                AAAAA9*      004                                            ***      Scratch
                BSTK01                                                    21/11/01   EDM Cont
                BSTK03                                                    15/07/01   Scratch
            CTTCTT                                                      ***      Scratch

Figure 59 Inquire/Update Display Type S (System Programmer), Record Type D (Data Set)

Copy
 DATABASE LIST < S / D  > --------------------------------------------------(TI)
                COMMAND ===>                                                    SCROLL===> CRSR
                O VOLSER/DATASET NAME                            CR-DATE   RETENTION   STATUS 
                K27.TEST.LBI                                   30/08/01   14/11/01   Active 
                K27.TEST.T005                                  23/01/01   07/12/01   Active 
                K28.TEST.T001                                  01/02/01   06/12/01   Active 
                LIXT01                                         19/11/01   21/11/01   Scratch
                LIXT01                                         03/12/01   CATALOG    Active 
                LIXT02                                         19/11/01   21/11/01   Scratch
                LIXT03                                         19/11/01   21/11/01   Scratch
                M04.ALL                                        04/12/01   CATALOG    Active 
                M04.ALL                                        05/12/01   03/02/02   Active 
            M04.ALL.JOB9                                   05/12/01   PERMANENT  Active 

Figure 60 Inquire/Update Display Type S (System Programmer), Record Type VD (Volume/Data Set)

Copy
 DATABASE LIST < S / VD > --------------------------------------------------(TI)
                COMMAND ===>                                                    SCROLL===> CRSR
                O VOLSER/DATASET NAME                            CR-DATE   RETENTION   STATUS 
                AAAAA3                                                    21/11/01   EDM-Expo
                AAAAA4                                                    04/12/01   Act-Expo
                AAAAA5*      001                                            ***      Scratch
                M04.JOB1                                      02/08/01   CATALOG    Scratch
                M04.JOB5                                      02/08/01   CATALOG    Scratch
                AAAAA6                                                      ***      Pend-Vau
                BSTK01                                                    21/11/01   EDM Cont
                BSTK03                                                    15/07/01   Scratch
                CTTCTT                                                      ***      Scratch
            DFP001                                                    15/07/01   Scratch

Figure 61 Inquire/Update Display TypeS (System Programmer), Record Type DV (Data Set/Volume)

Copy
 DATABASE LIST < S / DV > --------------------------------------------------(TI)
                COMMAND ===>                                                    SCROLL===> CRSR
                O VOLSER/DATASET NAME                            CR-DATE   RETENTION   STATUS 
                K27.TEST.LBI                                   30/08/01   14/11/01   Active 
                BABA04                                                   14/11/01   Act-Out
                K28.TEST.T001                                  01/02/01   06/12/01   Active 
                BABA03                                                   06/12/01   Act-ATL
                LIXT01                                         03/12/01   CATALOG    Active 
                RETEN                                                      ***      Ext-Acti
                M04.ALL                                        04/12/01   CATALOG    Active 
                UUUUU7                                                     ***      Ext-Acti
                M04.ALL                                        05/12/01   03/02/02   Active 
            UUUUU9                                                   03/02/02   Ext-Acti

Table 75 Fields in Display Type S (System Programmer) for Volume and/or Data Set Records

Field

Description

VOLSER/DATASET NAME

Volume serial number or data set name (depending on the record being displayed).

CR-DATE

Creation date of the volume or data set.

RETENTION

Retention period for the volume or data set. A value of *** in the TI screen indicates that a specific expiration date cannot be determined because the retention is controlled by one of the following retention types:

  • MVS CATALOG
  • EDM
  • CYCLES
  • SMS MGMTCLAS
  • PERMANENT

STATUS

Status of the volume or data set. For more information, see Statuses of Volumes and Data Sets.

Additional Information Option and Fields

Specifying A (Additional Info) in the OPTION field of any volume or data set listed in the Media Database list alternately displays or hides additional information about the selected volume or data set.

The set of Additional Info fields displayed depends on whether you specified A on a volume line or on a data set line. For a volume line, fields relating to volume information are displayed. For a data set line, fields relating to data set information are displayed.

The type of line on which you specified A, not the screen display type, determines whether data set or volume information is displayed.

For display type S, Additional Info fields relevant to system programmers are displayed along with the standard Additional Info fields for the current line.

Descriptions of Additional Info fields are provided in the following topics for:

  • Volume Additional Info fields for all display types

  • Data set Additional Info fields for all display types

  • Volume Additional Info fields unique to display type S

  • Data set Additional Info fields unique to display type S

Additional Info for Volumes

Figure 62 Additional Information for Volumes Display

Copy
DATABASE LIST < V / V > ------------------------------------------------ (TI)
                COMMAND ===>                                                  SCROLL===> CRSR
                O VOLSER   VOLSEQ MEDIA      RETENTION L-ACCESS FILES LOCATION ---STATUS-----
                K02002      002 REEL       06/06/00             001 MAINLIB   Vaulted
                GENERAL INFORMATION:
                Media Desc:     REEL-TAPE               Unit Name:       TAPE
                SL-Name:        K02002                  Pool Name:       $$NOPOOL
                Location:       MAINLIB                 Owner:           M27A
                Description:                            Vendor Name:
                Label Type:     NL                      Density:         3490
                Capacity Used:  00800KB 100%            Ret-Dataset:     0001
                Data Uncomp:    00800MB                 Physical vol:
                Use Count:      00000                   EXCP Count:      00000000
                Last Access:                            By Job:
                Last Modified:  06/06/01                By User: M27A
                Move Date:                              Return Date:
                Check-In Date:  05/05/01                Clean Date:
                Scratch Date:                           Last Label:
                ATL Interface:                          Tape Library:
                Stk Group:
                MULTI-VOLUME:
                Volume Seq:     002                     First Volume:    KO2001
                Next Volume:                            Prev Volume:     KO2001
                I/O ERRORS:
                Read Temp:      002                     Read Perm:       000
                Write Temp:     000                     Write Perm:      000
                VAULTING INFORMATION:                   V-Dataset:       001
                Slot Num:       000                     Return Date:
                Box Id
                Vault Name:     VAULT1                  Entry Date:      06/06/01
                Retention:      VLT DAYS 0010
                ----------------------------- END OF RECORD --------------------------------
            USE OPT COMMAND TO DISPLAY/HIDE OPTION LIST                            18.01.59

Additional Info Fields for Volumes

The Additional Info fields for volumes are divided into the following categories:

  • General Information — General information about the volume

  • Multi-volume Information — Information about volumes that are part of a chain

  • I/O Errors — Total number of I/O errors for this volume.

  • Vaulting Information — Information about the vault pattern of the volume.

Not all categories are necessarily displayed. The categories displayed depend on information available for the selected volumes.

Table 76 Additional Info Fields for Volumes – General Information Fields

Field

Description

Media Desc

Description of the media (as specified in member CTTPARM).

A WORM volume is indicated with [WORM] after the description.

Generic Unit

MVS generic unit name.

SL-Name

Standard label name. Logical name of the volume.

Pool Name

Name of the pool with which the volume is associated (for scratch purposes).

Location

Current location of the volume.

Owner

Owner of the volume.

Description

Description of the volume.

Vendor Name

Name of the vendor.

Label Type

Type of the label.

Density

For 3400 unit types: Tape recording density.
For other tape devices: Tape recording technique.

Capacity Used

Combined size of all active data sets on the volume, and the percentage of the volume that is occupied by these data sets.

Ret-Dataset

Data set that determines the retention period of the volume.

Data Uncomp

Uncompressed size of all active data sets on the volume.

Use Count

Number of times the volume has been "used" (for example, accessed).

EXCP Count

Number of EXCPs performed on this volume since it was last scratched.

Last Access

Date of last access of the volume.

By Job

Name of the job that last accessed the volume.

Last Modified

Date of last modification of the volume record.

By User

User who last modified the volume record.

Move Date

Last date the volume was moved.

Return Date

Date the volume should return to the active library.

Check-In Date