User manual

TL1 Commands and Messages

TL1 Overview

9-4 July 2004 Wide Bank 28 DS3 - Release 2.4

For example, consider the Retrieve-Header command syntax:

RTRV-HDR:tid::ctag;

In the Wide Bank system, the default target identifier <tid> is MULTIPLEXER-1. Using a

<ctag> value of 35 as an example, the resulting command would be:

RTRV-HDR:MULTIPLEXER-1::35;

In this example, the command parts are:

verb RTRV

modifier HDR

tid MULTIPLEXER-1

ctag 35

NOTE: For simplicity, examples and responses in this document will represent the tid

and ctag values by the lower-case letters tid and ctag.

Grouping Values as Lists and Ranges

Most Access IDs (aids) can be grouped together when sending commands:

 Lists – use & to enter lists, as in DS1-1&DS1-3&DS1-5

 Ranges – use && to specify a range of values, as in DS1-1&&DS1-5

Response Syntax

The general format of a command response is shown below:

^^^<sid>^<YYYY-MM-DD>^<HH:MM:SS><cr><lf>

M^^<ctag>^<Completion_Code><cr><lf>

[Text_Block<cr><lf>]*;

The symbol <cr> represents a carriage return, and <lf> a line feed. A space is represented by

the “^” symbol. The correlation tag will be the same as the one provided in the command. If the

correlation tag was omitted from the command, then the correlation tag in the response will be

zero (0). Completion codes are described in Completion Codes on page 9-87.

Finally, there may be zero or more Text_Blocks with each block containing a <cr><lf> at the

end of the response. The example below is the normal response without a text block. It is used

to signify that the command was received and executed.

tid 2001-08-04 10:42:22

M ctag COMPLD

;

NOTE: Normal responses are not shown in the command description unless they

provide more information than the basic completed (COMPLD) message.