Introducing the operations and control panels

You can use the WebSphere MQ operations and control panels to perform administration tasks on WebSphere MQ objects. You use these panels for defining, displaying, altering, or deleting WebSphere MQ objects. Use the panels for day-to-day administration and for making small changes to objects. If you are setting up or changing many objects, you should use the COMMAND function of the CSQUTIL utility program.

The operations and control panels support the controls for the channel initiator (for example, to start a channel or a TCP/IP listener), for clustering, and for security. They also enable you to display information about threads and page set usage.

The panels work by sending MQSC type WebSphere MQ commands to a queue manager.

Notes:

  1. A small number of system controls are not available through the panels. You must issue these explicitly using one of the other methods, see Issuing commands.

  2. You cannot issue the WebSphere MQ commands directly from the command line in the panels.

  3. To use the operations and control panels, you must have the correct security authorization; this is described in the WebSphere MQ for z/OS System Setup Guide.

Invoking the operations and control panels

If the ISPF/PDF primary options menu has been updated for WebSphere MQ, you can access the WebSphere MQ operations and control panels from that menu. For details about updating the menu, see the WebSphere MQ for z/OS System Setup Guide.

You can access the WebSphere MQ operations and control panels from the TSO command processor panel (usually option 6 on the ISPF/PDF primary options menu). The name of the exec that you run to do this is CSQOREXX. It has two parameters; thlqual is the high-level qualifier for the WebSphere MQ libraries to be used, and langletter is the letter identifying the national language libraries to be used (for example, E for U.S. English). The parameters can be omitted if the WebSphere MQ libraries are permanently installed in your ISPF setup. Alternatively, you can issue CSQOREXX from the TSO command line.

These panels are designed to be used by operators and administrators with a minimum of formal training. Read these instructions with the panels running and try out the different tasks suggested.

Note:
While using the panels, temporary dynamic queues with names of the form SYSTEM.CSQOREXX.* are created.

Rules for the operations and control panels

The WebSphere MQ Script (MQSC) Command Reference manual defines the general rules for WebSphere MQ character strings and names. However, there are some rules that apply only to the operations and control panels:

Blank fields

When you specify the Define action for a WebSphere MQ object, each field on the define panel contains a value. See the general help (extended help) for the display panels for information on where WebSphere MQ gets the values. If you type over a field with blanks, and blanks are not allowed, WebSphere MQ puts the installation default value in the field or prompts you to enter the required value.

When you specify the Alter action for a WebSphere MQ object, each field on the alter panel contains the current value for that field. If you type over a field with blanks, and blanks are not allowed, the value of that field is left unchanged.

Objects and actions

The operations and control panels offer you many different types of object and a number of actions that you can perform on them. The actions are listed on the initial panel and enable you to manipulate the objects and display information about them. These objects include all the WebSphere MQ objects, together with some extra ones. The objects fall into the following categories.

Queues, processes, authentication information objects, namelists, storage classes and CF structures

These are the basic WebSphere MQ objects. There can be many of each type. They can be defined and deleted, and have attributes that can be displayed and altered, using the DEFINE LIKE, MANAGE, DISPLAY, and ALTER actions.

This category consists of the following objects:

QLOCAL Local queue
QREMOTE Remote queue
QALIAS Alias queue for indirect reference to a queue
QMODEL Model queue for defining queues dynamically
QUEUE Any type of queue
QSTATUS Status of a local queue
PROCESS Information about an application to be started when a trigger event occurs
AUTHINFO Authentication information: definitions required to perform Certificate Revocation List (CRL) checking using LDAP servers
NAMELIST List of names, such as queues or clusters
STGCLASS Storage class
CFSTRUCT Coupling Facility (CF) structure
CFSTATUS Status of a CF structure

Channels

Channels are used for distributed queuing (not for the CICS mover). There can be many of each type, and they can be defined, deleted, displayed, and altered. They also have other functions available using the START, STOP and PERFORM actions. PERFORM provides reset, ping, and resolve channel functions.

This category consists of the following objects:

CHANNEL Any type of channel
SENDER Sender channel
SERVER Server channel
RECEIVER Receiver channel
REQUESTER Requester channel
CLUSRCVR Cluster-receiver channel
CLUSSDR Cluster-sender channel
SVRCONN Server-connection channel
CLNTCONN Client-connection channel
CHSTATUS Status of a channel connection

Cluster objects

Cluster objects are created automatically for queues and channels that belong to a cluster. The base queue and channel definitions can be on another queue manager. There can be many of each type, and names can be duplicated. They can only be displayed, using the DISPLAY action.

This category consists of the following objects:

CLUSQ Cluster queue, created for a queue that belongs to a cluster
CLUSCHL Cluster channel, created for a channel that belongs to a cluster
CLUSQMGR Cluster queue manager, the same as a cluster channel but identified by its queue manager name

Cluster channels and cluster queue managers do have the PERFORM, START and STOP actions, but only indirectly through the DISPLAY action.

Queue manager and security

Queue manager and security objects have a single instance. They have attributes that can be displayed and altered (using the DISPLAY and ALTER actions), and have other functions available using the PERFORM action.

This category consists of the following objects:

MANAGER Queue manager - the PERFORM action provides suspend and resume cluster functions
SECURITY Security functions - the PERFORM action provides refresh and reverify functions

System

A collection of other functions. This category consists of the following objects:

SYSTEM System functions
CONTROL Synonym for SYSTEM

The functions available are:

DISPLAY Display queue-sharing group, distributed queuing, thread, page set, or data set usage information.
PERFORM Refresh or reset clustering
START Start the channel initiator or listeners
STOP Stop the channel initiator or listeners

Actions

The actions that you can perform for each type of object are shown in the following table:

Table 2. Valid operations and control panel actions for WebSphere MQ objects

Object Alter Define like Manage (1) Display Perform(TM) Start Stop
AUTHINFO X X X X


CFSTATUS


X


CFSTRUCT X X X X


CHANNEL X X X X X X X
CHSTATUS


X


CLNTCONN X X X X


CLUSCHL


X X(2) X(2) X(2)
CLUSQ


X


CLUSQMGR


X X(2) X(2) X(2)
CLUSRCVR X X X X X X X
CLUSSDR X X X X X X X
CONTROL


X X X X
MANAGER X

X X

NAMELIST X X X X


PROCESS X X X X


QALIAS X X X X


QLOCAL X X X X


QMODEL X X X X


QREMOTE X X X X


QSTATUS


X


QUEUE X X X X


RECEIVER X X X X X X X
REQUESTER X X X X X X X
SECURITY X

X X

SENDER X X X X X X X
SERVER X X X X X X X
SVRCONN X X X X
X X
STGCLASS X X X X


SYSTEM


X X X X
Note:
  1. Provides Delete and other functions
  2. Using the Display action

Object dispositions

You can specify the disposition of the object with which you need to work. The disposition signifies where the object definition is kept, and how the object behaves.

The disposition is significant only if you are working with any of the following object types:

If you are working with other object types, the disposition is disregarded.

Permitted values are:

Q
QMGR. The object definitions are on the page set of the queue manager and are accessible only by the queue manager.

C
COPY. The object definitions are on the page set of the queue manager and are accessible only by the queue manager. They are local copies of objects defined as having a disposition of GROUP.

P
PRIVATE. The object definitions are on the page set of the queue manager and are accessible only by the queue manager. The objects have been defined as having a disposition of QMGR or COPY.

G
GROUP. The object definitions are in the shared repository, and are accessible by all queue managers in the queue-sharing group.

S
SHARED. This disposition applies only to local queues. The queue definitions are in the shared repository, and are accessible by all queue managers in the queue-sharing group.

A
ALL. If the action queue manager is either the target queue manager, or *, objects of all dispositions are included; otherwise, objects of QMGR and COPY dispositions only are included. This is the default.

Choosing a queue manager

While you are viewing the initial panel, you are not connected to any queue manager. However, as soon as you press Enter, you are connected to the queue manager, or a queue manager in the queue-sharing group named in the Connect name field. You can leave this field blank; this means you are using the default queue manager for batch applications. This is defined in CSQBDEFV (see the WebSphere MQ for z/OS System Setup Guide for information about this).

Use the Target queue manager field to specify the queue manager where the actions you request are to be performed. If you leave this field blank, it defaults to the queue manager specified in the Connect name field. You can specify a target queue manager that is not the one you connect to. In this case, you would normally specify the name of a remote queue manager object that provides a queue manager alias definition (the name is used as the ObjectQMgrName when opening the command input queue). To do this, you must have suitable queues and channels set up to access the remote queue manager.

The Action queue manager allows you to specify a queue manager that is in the same queue-sharing group as the queue manager specified in the Target queue manager field to be the queue manager where the actions you request are to be performed. If you specify * in this field, the actions you request are performed on all queue managers in the queue-sharing group. If you leave this field blank, it defaults to the value specified in the Target queue manager field. The Action queue manager field corresponds to using the CMDSCOPE command modifier described in the WebSphere MQ Script (MQSC) Command Reference.

Queue manager defaults

If you leave any queue manager fields blank, or choose to connect to a queue-sharing group, a secondary window appears when you press Enter. This window confirms the names of the queue managers you will be using. Press Enter to continue. When you return to the initial panel after having made some requests, you find fields filled in with the actual names.

Queue manager levels

The Operations and Control panels work satisfactorily only with queue managers that are running on z/OS, and whose command level matches that of the panels, currently 520 or 530.

If these conditions are not met, it is likely that actions work only partially, incorrectly, or not at all, and that the replies from the queue manager are not recognized.

If the action queue manager is at command level 520, some fields are not displayed, and some values cannot be entered. A few objects and actions are disallowed. In such cases, a secondary window appears asking for you to confirm that you want to proceed.

Using the function keys

To use the panels, you must use the function keys or enter the equivalent commands in the command area. The function keys have special settings for WebSphere MQ. (This means that you cannot use the ISPF default values for the function keys; if you have previously used the KEYLIST OFF ISPF command anywhere, you must type KEYLIST ON in the command area of any operations and control panel and then press Enter to enable the WebSphere MQ settings.)

These function key settings can be displayed on the panels, as shown in Figure 2. If the settings are not shown, type PFSHOW in the command area of any operations and control panel and then press Enter. To remove the display of the settings, use the command PFSHOW OFF.

The function key settings in the operations and control panels conform to CUA(R) standards. Although you can change the key setting through normal ISPF procedures (such as the KEYLIST utility) you are not recommended to do so.

Note:
Using the PFSHOW and KEYLIST commands affects any other logical ISPF screens that you have, and their settings remain when you leave the operations and control panels.

Processing your actions

Press Enter to carry out the action requested on a panel. The information from the panel is sent to the queue manager for processing.

Each time you press Enter in the panels, WebSphere MQ generates one or more operator messages. If the operation was successful, you get confirmation message CSQ9022I, otherwise you get some error messages.

Displaying WebSphere MQ user messages

Press function key F10 in any panel to see the WebSphere MQ user messages.

Cancelling your actions

On the initial panel, both F3 and F12 exit the operations and control panels and return you to ISPF. No information is sent to the queue manager.

On any other panel, press function keys F3 or F12 to leave the current panel ignoring any data you have typed since last pressing Enter. Again, no information is sent to the queue manager.

Getting help

Each panel has help panels associated with it. The help panels use the ISPF protocols:

If the help information carries on into a second or subsequent pages, a More indicator is displayed in top right of the panel. Use these function keys to navigate through the help pages:

Using the command line

You never need to use the command line to issue the commands used by the operations and control panels because they are available from function keys, as described above. The command line is provided to allow you to enter normal ISPF commands (like PFSHOW).

The command line is initially displayed at the bottom of the panels, regardless of what ISPF settings you have. If you prefer it to be at the top, use the SETTINGS ISPF command from any of the operations and control panels to change it. The settings are remembered for subsequent sessions with the operations and control panels.



© IBM Corporation 1993, 2002. All Rights Reserved