Output Response Message

Overview
Output Response Message Format
Header
Completion Code
Text Block (Response Line)
Configuring Values for Output Response Message
Configuring Completion Code
Configuring Response Line

Valid Responses
Error Responses

Modifying and Deleting Responses
Sending Response Messages using Jython Scripts

Overview

A TL1 output response message is the response to a TL1 input command message.

Output Response Message Format

The general structure of a TL1 output response message is of the form given below. It consists of a optional text block and all the other blocks are essential.

Header

The Header represents information common to all output response.

It contains System identifier <sid>, date, and time stamps.<sid> is restricted to 20 characters maximum and identifies the NE generating the message. The syntax of <sid> is any TL1 identifier or text string. The <year><month><day> construct represent the day in which the output response is generated. The <hour><minute> <second> construct represent the time at which the output response is generated.

Completion Code (Response Identification)

The form of the response identification is :

This construct consists of three components, namely the character M, a correlation Tag, and a completion code. The character M signifies that the message is the response to the input command. The ctag must be the same as that of the input message in order to associate the response with the proper input command. The various completion codes are described below.

COMPLD : Total successful execution of the input command.
DENY : Total denial of the input command.
PRTL : Partial successful execution of the input command.
DELAY : Successful lining of the input command submitted for delayed activation.
RTRY : Output response of a input retrieve command that retrieves extensive information from the NE and uses more time for processing.

The completion codes supported by TL1 Agent Simulator are Compld and Deny.

Text Block (Response Line)

The optional [<text block>] is used to represent information specific to the particular autonomous message. The format of the text block is as follows :

((<cr><lf>^^^<unquoted line>) | (<cr><lf>^^^<quoted line>) |(<cr><lf>^^^<comment>))

It consists of three components, namely unquoted line, quoted line, and comment. Both quoted and unquoted lines consists of text that is parsable, while comment is not. The most popular usage of unquoted line is for representing error code in some response messages. The quoted line consists of parsable text and shall be preceded and followed by double quotes. The comment line is used to allow free format text. It should be preceded by ( /* ) and followed by ( */ ).

The TL1 Agent Simulator, supports only quoted and unquoted response lines.

The semi-colon character (;) terminates a TL1 output message. The form of the terminator is :<cr><lf>( ; | > ) . This is required for all TL1 message types.

Configuring Values for Output Response Message

The TL1 Agent Simulator supports to configure the parameter values for the response message defined the TCS file.

Configuring Completion Code

The completion code supported by TL1 Agent Simulator are Compld and Deny. To configure completion code, do the following:

Select the required command code from the loaded command set file ( as .tcs file or .prp configuration file format ).
Select the Access ID and Message Payload value from the list, for which Completion code must be configured.
Select the required completion code from the values listed in the combo box. The default completion code is compld.

Note:

If Access ID and Message Payload are defined for a command, the Completion Code values in the combo box will be enabled only after selecting the Access ID and Message Payload value from the list.
The completion code supported by TL1 Agent Simulator are Compld and Deny

Configuring Response Line

A response line can be configured in the TL1 Agent Simulator, only if the Response message is defined in the TCS file for the TL1 command. The response message may be a valid response message or error response message or both.

To configure a Valid Response, do the following :

Select the required command code from the loaded command set file ( as .tcs file or .prp configuration file format ).
Select the Access ID and Message Payload value from the list, for which response text must be configured.
If a valid response message is defined in the tcs file, the Configure Valid Response text field is enabled.
Click the text field to display the Configure Valid Responses dialog with default response line.
Click Add to configure valid responses for the selected CC-AID-MPB combination.
The ConfigureParamValues dialog is displayed . The Response Line type displays the textblock type, as defined in the tcs file. The textblock type may be quoted or unquoted. The Parameter name and Parameter type defined for the response message is listed with default values.
Enter the required parameter values and click OK, to add the response to the list.
Click OK to exit from the Configure Valid Responses dialog.

To configure an Error Response, do the following :

Select the required command code from the loaded command set file ( as .tcs file or .prp configuration file format ).
Select the Access ID and Message Payload value from the list, for which response text must be configured.
If an error response message is defined in the tcs file, the Configure Error Response text field is enabled.
Click the text field to display the Configure Error Responses dialog.
Click Add to configure error responses for the selected CC-AID-MPB combination.
The ConfigureParamValues dialog is displayed . The Response Line type displays the textblock type, as defined in the tcs file. The textblock type may be quoted or unquoted. The Parameter name and Parameter type defined for the response message is listed with default values.
Enter the required parameter values and click OK, to add the response to the list.
Click OK to exit from the Configure Error Responses dialog.

Note:

Only quoted and unquoted response lines are supported.
Multiple Response lines can be configured.
If Completion Code is Compld, a valid response is sent. If Completion Code is Deny, an Error Response is sent.

Modifying and Deleting Responses

The TL1 Agent Simulator, supports to modify the response parameter values configured in the simulator or delete an existing response line.

To modify a response line, do the following :

Select the response line to be modified, in the Configure Valid/Error Responses dialog.
Click Modify. The ConfigureParamValues dialog is displayed. Enter the required parameter values and click OK, to add the modified response to the list.

To delete a response line, do the following :

Select the response line to be deleted, in the Configure Valid/Error Responses dialog.
Click Delete. The response line will be deleted from the list

Sending Response Messages using Jython Scripts

The script api method sendResponseMessage() in SNMP_TL1_SimScrIntf.html in < simulator home >/examples/javadocs directory, enables you to send different response messages for the same command code. Refer to the topic, Configuring Behavior to learn more about configuring scripts.