Message formats

The following formats are described:

• Format of the commands for receiving operator commands

• Format for sending command results and additional command information

• Format for sending end-of-command messages

• Format for receiving additional command information

Format of the commands for receiving operator commands

[header]/{tsn | an | (mn)}:'BLANK''BLANK'cmd['BLANK'[operands]

header	For applications connected to $CONSOLE with protocol version 01 or 02, the format contains a message header n characters in length which is defined by means of the NBMHE macro.
/	Slash character indicating type of message.
tsn	Task sequence number of the user task by which the special operator command was entered.
on	Authorization name of the authorized user program, by which the command was entered (4 characters).
mn	Mnemonic device name of the physical console at which the command was entered (2 characters).
:	Colon as a separator
'BLANK'	Blank
cmd	Name of a command.
operands	Command operands

The task identification that an authorized user program is given in the header on receipt of the command is a unique task identification assigned by the system. It is not identical to the task number assigned when the command is entered.
The internal job identification is transparent for the authorized user program. The system manages the command on the basis of this task identification and ensures that the command results sent in connection with the command, the additional requests and the command termination message are always provided with the task identification entered by the person issuing the command and reach the person issuing the command.
A precondition is that the internal task identification and the task type (command result (+), additional command information request (&) or command termination (!)) are supplied correctly in the header.

Examples

1. without header

   /OPR1: SPECI OP1=VALUE1,OP2=VALUE2

2. with header

   <header>/OPR1: SPECI OP1=VALUE1,OP2=VALUE2

   For the header data format, see the NBMHE macro ("NBMHE macro" in section "Message formats").

Format for sending command results and additional command information

<header> text [<mapping-format>]

header	The corresponding task type must be identified in the header and the task identification field supplied with the task identification taken from the header of the command. The system ensures that the text appears at the place the command was entered, with the task identification contained in the command.
text	Free-format text or message text in MSG7X format
mapping-format
	If a $-CONSOLE application sends messages of type “+” or “&”, specifies a mapping format (see the NBMAP macro, "Message formats") and the sender of the command was a user tasks, the system ignores the specified message text for message output. However, the specified message text is included in the CONSLOG. It should therefore be in MSG7X format. Furthermore, internal checks (e.g. the message number at offset 4 in the message text) are performed which can generally only be successful when MSG7X format is used. The sender of the command receives a message containing the outputs created by the MSG7X macro with the parameters specified in the mapping format. The language valid for the environment of the sender of the command is used automatically. The purpose of this MSG7X macro is thus to output the message text in the language required.

Format for sending end-of-command messages

header maincode

header

The job type “!” must be entered in the heading and the fields RC1 and RC2 supplied with the subcode 1 or subcode 2 of the command result. The job identification field must also be supplied with the job identification taken from the header of the command. The system ensures that the message NBR0740 is output to the place where the command is received. NBR0740 COMMAND COMPLETED 'xxxx'; (RESULT:....); DATE:..... The message also contains the job identifier entered when the command was entered and is identified with an exclamation mark.

maincode

7-character maincode of the command result

Once a command termination indicator has been sent, it is no longer possible for an authorized user program to use the internal job identification. Jobs for commands whose termination has already been indicated or jobs with an incorrect job identification are rejected by the system with message REJ11.

 

Format for receiving additional command information

header :{tsn | an | (mn)}[-mid]:[text]

header	Header of length n characters, described by the NBMHE macro
:	Message type ID (colon)
on	Authorization name of the authorized user program delivering the response (4 characters)
mn	Mnemonic device name of the physical console delivering the response (2 characters).
tsn	Task serial number of the responding user task.
-	Hyphen
mid	Message job ID (A..Z, 0-9, @, #, $); filled to 3 characters with leading zeros. default value = 000
:	Colon as a separator
text	Arbitrary response text.