IMS Version 9

How to Enter an IMS Command

This topic describes the following:

IMS MFS 3270 Master Terminal Format

This topic describes how to use the IMS master terminal for messages, commands, and responses. The IMS master terminal consists of two components of the IBM(R) 3270 Information Display System:

All IMS system messages for the master terminal are sent to the display screen. Most system messages, commands and responses are also sent to the printer to provide a hard copy record.

The format of the display screen is normally divided into five areas:

Figure 1 is a screen that shows the format of the master terminal display screen.

Figure 1. Master Terminal Format
yy/mm/dd hh:mm:ss                                      IMS id
 
 
 
 
Message Area (9 lines)
 
  
 
--------------------------------------------------------------------------------
 
 
 
Display Area (10 lines) 
 
 
Warning Message Area (1 line)                         PASSWORD:
User Input Area (2 lines)
 

Figure 2 is a screen that shows the format of the master terminal display screen in an extended recovery facility (XRF) environment.

Figure 2. Master Terminal Format in XRF Environment
85/05/15 14:24:40  RSENAME: DFSRSENM   BACKUP  TRACKING IN PROGRESS   IMSA
 
 
 
Message Area (9 lines)
 
 
 
--------------------------------------------------------------------------------
 
 
 
Display Area (10 lines)
 
 
 
 
Warning Message Area (1 line)                         PASSWORD:
User Input Area (2 lines)

System Status Area

This area (line 1) displays the date, time, and IMS identifier:

Date
Current date
Time
Current time
IMS Identifier
IMS system ID

If the system is XRF capable, the following information is also displayed on the status line:

RSEname
Recoverable service element name
System
ACTIVE or BACKUP (field is completed following the initialization phase)
Phase
Blank or one of the following:
Initialization
Active or alternate system is in initialization phase
Synchronization
Alternate system processing SNAPQ checkpoint
Tracking in progress
Alternate system synchronized with active system and in the process of tracking active system
Takeover in progress
Alternate system in the process of taking over from active system
Awaiting I/O prevention
New active system is in I/O toleration mode and is awaiting completion of I/O prevention on the failing system prior to becoming a true active system

Message Area

This area (lines 2 through 10) displays IMS system messages, messages from other terminals and programs, and responses to IMS commands, except responses to a /DISPLAY command. If the message area is full and more output needs to be displayed, a warning message is sent. Press the PA1 key to receive more output. New data is displayed on the top line followed by a blank line to separate new data from old messages.

Display Area

This area (lines 12 through 21) displays the output from a /DISPLAY command. If the response to the command exceeds the size of the area, a warning message is sent.

Warning Message Area

This area (line 22) can contain one of the following warning messages:

MASTER LINES WAITING
A message being displayed in the message area has exceeded the available space and is only partially displayed.
MASTER MESSAGE WAITING
The message area is full, and a message from another terminal or program is waiting to be displayed.
DISPLAY LINES WAITING
The output of a /DISPLAY command exceeds the size of the display area.
USER MESSAGE WAITING
A message requiring the screen to be formatted differently is waiting to be displayed.

In all cases, press the PA1 key to receive the waiting output.

The literal PASSWORD is followed by an unprotected field with the nondisplay attribute at the end of line 22.

User Input Area

This area (lines 23 and 24) is used to enter IMS commands. It consists of two 79-character segments, so you can enter multisegment commands such as /BROADCAST, /CHANGE, /RMxxxxxx, and /SSR. For example, to send a message to all active terminals, enter /BROADCAST ACTIVE on line 23 and enter the message text on line 24. The cursor is initially positioned by IMS to line 23, your first input line.

Sometimes the screen can lose this special format (for example, if you have pressed PA1 and received a user message, or if you have pressed the Clear key). To restore the format, enter /FORMAT DFSM02. If the screen is currently formatted with an application display, this command can be entered on the command input line at the bottom of the screen and must be terminated with a period.

Using Multiple Console Support (MCS) Consoles

You can enter IMS commands from Multiple Console Support (MCS) or Extended Multiple Console Support (E-MCS) consoles. Use the CMDMCS keyword for the IMS, DBC, or DCC procedures during IMS system definition to allow commands to be entered from MCS or E-MCS consoles. See IMS Version 9: Installation Volume 2: System Definition and Tailoring for more information on the CMDMCS keyword.

In a DB/DC environment, if Multiple Console is enabled (CMDMCS other than 'n' specified), IMS commands can be entered from an MCS or E-MCS console by prefixing the command by either the CRC or IMSID. For example, if the CRC is '#' then a valid command would be #DIS A. If the IMSID is 'IMSP' then a valid command would be IMSPDIS A.

Each segment of an IMS command must begin with one of the following:

For multisegment commands, each segment, except the last, must end with the command recognition character or IMS ID followed by the ENTER key. The last segment must end with only the EOM (end-of-message, or ENTER) character.

Prior to IMS Version 9, the only method of sending a command to all IMS subsystems in a sysplex (hereafter called an IMSplex) was to issue the z/OS ROUTE *ALL command from an MCS or E-MCS console. See OS/390 MVS System Commands for more information on the ROUTE *ALL command.

As of IMS Version 9, you can send commands to all the IMSs in an IMSplex by using an automated operations single-point-of-control (SPOC) application that sends commands and receives the responses to those commands through the Operations Manager (OM) application programming interface (API).

Definition: An IMSplex is one or more IMS subsystems that work together in groups that share databases, message queues, or both. Additionally, this definition includes the idea of these IMSs being managed by components of the Common Service Layer (CSL), the Operations Manager (OM), the Resource Manager (RM), and the Structured Call Interface (SCI).

Related Reading: For more information about managing multiple IMSs in an IMSplex using SPOC application programs, see "Automated Operations" in the IMS Version 9: Operations Guide. For more information about the CSL components and the OM API, see the IMS Version 9: Common Service Layer Guide and Reference.

When you are using a Resource Manager (RM) structure in an IMSplex, it is best to issue commands to the Operations Manager (OM) through the TSO SPOC.

Outstanding Reply Numbers on z/OS Consoles

Outstanding reply numbers are used only on z/OS system consoles. They are used to pass input directly to IMS. Terminals defined to IMS do not use outstanding reply numbers.

As an example, IMS might display the following on the z/OS console:

*48 DFS996I *IMS READY*

To communicate with IMS through the z/OS system console, you must reply with the outstanding reply number (in this example, the number is 48). A reply might look like this:

R 48,/START DC

After IMS responds to the command, the next outstanding reply number is displayed with the DFS996I message, as follows:

DFS058I START COMMAND COMPLETED
*49 DFS996I *IMS READY*

Maximum Length of Command Input from z/OS Consoles

For single-segment commands that are entered from the z/OS console, the maximum character length (including command recognition characters), is 118. This limit is due to the current implementation of the WTOR macro.

Multisegment Command Input

Multisegment commands require an EOS (end-of-segment) indicator for all segments preceding the last segment, and an EOM (end-of-message) indicator for the last segment. EOS and EOM will vary depending on the type of terminal entering the command. For example, on the system console, EOS is indicated by the ENTER key and EOM is indicated by entering a period followed by the ENTER key. Refer to the IMS Version 9: Operations Guide for a discussion of multisegment input for various device types.

The following are multisegment commands:

The period is used both as a delimiter for comments on IMS commands and as an EOM indicator for some terminal types. The following four examples illustrate the use of the period in both contexts. Example 4 for Multisegment Commands shows this.

Example 1 for Multisegment Commands

System console entry:

24,/BRO MASTER. END OF DAY MESSAGE
25,I AM GOING HOME.  PLEASE TAKE OVER.

Response on master terminal:

I AM GOING HOME.  PLEASE TAKE OVER.

Explanation: The first input segment (reply 24) contains only the command and consists of a comment (END OF DAY MESSAGE) separated from the command itself (BRO MASTER) by a period. The second input segment (reply 25) consists of the data to be broadcast. The first period in segment 2 is part of the data and the second period in segment 2 is the EOM indicator for the system console.

Example 2 for Multisegment Commands

System console entry:

26,/CHANGE DIRECT
27,ORY MFS. MODIFICATION.

Explanation: MODIFICATION in segment 2 is a comment and is separated from the command by the first period. The second period in segment 2 is the EOM indicator for the system console.

The above 2 segments are combined and the following is input to the command processor:

/CHANGE DIRECTORY MFS. MODIFICATION

Example 3 for Multisegment Commands

System console entry:

28,/CHANGE LINK 1
29,2 3 FORCSESS.

Explanation: Certain forms of reply to the system console "outstanding reply" can compress out leading blanks from input segments. In example three, the command processed by the /CHANGE command processor would be: /CHANGE LINK 12 3 FORCSESS. To obtain the desired command, /CHANGE LINK 1 2 3 FORCSESS, one of the following forms of reply could be used:

R 29,'/CHANGE LINK 1'
R 30,' 2 3 FORCSESS.'

or

29,/CHANGE LINK 1
30, 2 3 FORCSESS

Example 4 for Multisegment Commands

LU2 or 3270 Display Terminal entry:

/FORMAT DFSM04
/BRO LTERM WTOR (eos)
this is segment 1 (eos)
this is segment 2 (eos)
this is segment 3 (eom)

Explanation: The remote terminal is first formatted by the/FORMAT command, where default format DFSMO4 supports the input of 4 segments.

For LU2 and 3270 display terminals, enter a /FORMAT DFSM04 command before entering the multisegment command.

Commands in a DBCTL Environment

In a DBCTL environment, there are no outstanding reply numbers for z/OS consoles, and therefore none should be entered. For a command, just enter the command recognition character (slash or other character preceding the verb) or IMS ID, followed by the command. DBCTL does not respond with the DFS996I outstanding reply number.

Examples for DBCTL Commands

System console entry for single-segment command:

¢DIS DB PAYROLL

Explanation: ¢ is the command-recognition character for the DBCTL subsystem.

IMS1DIS DB PAYROLL

Explanation: IMS1 is the IMS ID for the DBCTL subsystem.

System console entry for multisegment command:

/RMI DBRC='IC DBD(DEDBDD01) AREA (DD01AR0) ICDSN(FVT31.DEDBDD01.DD01
AR0.IC.DUMMY1) ICDSN2/
/(FVT31.DEDBDD01.DD01AR0.IC2.DUMMY1) HSSP'

Explanation: The first segment of the /RMI command has the command recognition character at the beginning of the segment and at the end of the segment, to indicate another segment follows. The last segment has the command recognition character at the beginning of the segment only.

Commands from an LU 6.2 Device

To enter a command from an LU 6.2 device, allocate a conversation using an IMS command verb as the TPNAME. The "/" must be included in the command word. The password option is not valid. (The password must be supplied as a part of the LU 6.2 ALLOCATE from the partner.) The normal LU 6.2 security provisions apply for this transaction.

Restriction:  The APPC synchronization level of CONFIRM is ignored for commands from LU 6.2 devices.

The following three examples show the sequence of steps used to issue commands by allocating a synchronous conversation on an LU 6.2 device:

Example 1 for Commands from an LU 6.2 Device

ALLOCATE
  -LUNAME=luname of IMS
  -TPNAME=/DISPLAY                    (Single segment command)
SEND
  -DATA=LTERM VA01 VA02.comments      (Data after period treated as comments)
PREPARE_TO_RECEIVE
RECEIVE                               (Get header)
RECEIVE                               (Get output for LTERM VA01)
RECEIVE                               (Get output for LTERM VA02)
RECEIVE                               (Get timestamp)
RC=DEALLOCATE

Example 2 for Commands from an LU 6.2 Device

ALLOCATE
  -LUNAME=luname of IMS
  -TPNAME=/CHANGE                     (Multisegment command)
SEND
  -DATA=NODE                          (Can spread over several SENDs)
SEND
  -DATA=VAT02 ASR OFF.comments        (Data after period treated as comments)
PREPARE_TO_RECEIVE
RECEIVE                               (Get DFS058 CHANGE COMMAND COMPLETED)
RC=DEALLOCATE

Example 3 for Commands from an LU 6.2 Device

ALLOCATE
  -LUNAME=luname of IMS
  -TPNAME=/BROADCAST
SEND
  -DATA=NODE VAT0*                    (1st SEND: the destination)
SEND
  -DATA=HELLO, HOW ARE YOU ALL?       (Subsequent SENDs: message to broadcast)
PREPARE_TO_RECEIVE
RECEIVE                               (Get DFS058 BROADCAST COMMAND COMPLETED)
RC=DEALLOCATE

Qualifying Network LU Names and Commands

Qualifying LU names gives the system administrator the liberty of using the same name for LUs on different systems by adding the network identifier. This eliminates the necessity to have unique names for every LU on every system in your complex.

A network-qualified LU name consists of a network identifier of the originating system that is 1 to 8 characters long, a period, and then the LU name, which is 1 to 8 characters long. IMS commands that include network-qualified LU names must be enclosed in single quotes. For example: 'NETID001.LUAPPC02'. No blanks are allowed in a network-qualified LU name.

The parameter ALL for either the network identifier or the LU name cannot be substituted in a command for a network-qualified LU name. ALL cannot represent all of the LU names or all of the networks.

The LU name in the LU 6.2 descriptors can be network-qualified.

The network-qualified LU name is optional on commands that support the LUNAME keyword.

TSO SPOC Format

|The |TSO SPOC is an IBM-supplied application that can issue operator |commands in an IMSplex. The TSO SPOC application uses an ISPF panel |interface and communicates with an Operations Manager (OM) address |space. OM then communicates with all of the other address spaces |in the IMSplex (for example, IMS) as required for operations.

There can be more than one TSO SPOC in an IMSplex. However, it is optional in an IMSplex. The TSO SPOC provides the following functions to an IMSplex:

The TSO SPOC has integrated online help which can be accessed by the PF1 key. There are three ways to issue commands in the IMS TSO SPOC application:

These three methods can be used in any combination at any time. See the IMS TSO SPOC Online Tutorial, for more information about using the TSO SPOC application. For more IMSplex information, see IMS Version 9: Common Service Layer Guide and Reference.

Figure 3 is a screen that shows the format of the TSO SPOC screen.

Figure 3. TSO SPOC Screen Format
File     Display    View    Options    Help
------------------------------------------------------
PLEX1                            IMS Single Point of Control
Command ==> ___________


-------------------------- Plex .    Route .     Wait .
Response for:


CSLM000I (C) Copyright IBM Corp. 2000. All rights reserved.
F1=Help     f3=Exit    F4=Showlog    F6=Expand     F9=Retrieve     F12=Cancel

|You |can enter both IMS classic commands and IMSplex commands using the |TSO SPOC interface. The command is entered next to the command prompt |(Command ==> in the figure). Enter the IMSplex name in the Plex field. Enter the list of IMSs to which to route the command, |if applicable, in the Route field. After you type the command, press Enter. The command |issued is shown in the Response for: field and the actual command response is shown below the Response for: field.

Entering Comments from a TSO SPOC

For classic IMS commands, a period ends a command and anything after it is a comment. The following example shows a classic IMS command with a comment.

/DISPLAY ACT .a test comment

For IMSplex commands, the comment must be enclosed in a slash and asterisk. At the end of the last parameter of the command, type a forward slash followed by an asterisk, then the comment text, followed by an asterisk and slash. The comment text must not have an embedded asterisk slash in it. The following is an example of a command with a comment:

QUERY TRAN NAME(PART) SHOW(QCNT)/*Show queue count for tran part*/

| | |

Control Center Format

|

The IMS Control Center, included in the IBM DB2 Universal |Database Control Center, uses the IMS Single Point of Control (SPOC) |functions to enable IMS systems management from a Windows workstation.

|

You can issue and view IMS type-1 and type-2 commands from the |IMS Control Center. There are online wizards that help you build |and issue commands. The Control Center command output is similar |to the output displayed from the TSO SPOC. The same information |is provided, but formatted in a windows-based graphical interface.

|

For more information about the IMS Control Center, go to the |IMS website at www.ibm.com/ims and link to the IMS Control Center.

Go to the previous page Go to the next page

IBM Confidential

Downloads | Library | Support | Support Policy | Terms of use | Feedback
Copyright: IBM Corporation 1974, 2004 Copyright IBM Corporation 1974, 2004  timestamp Last updated: March, 2004