5.0 Defining Data Set File

 


5.1 What is a Data Set File?

5.2 Creating a New Data Set File Using TL1 Message Builder

5.3 Selecting Command Code for Adding Data

5.4 Adding Staging Parameter Block

5.5 Adding General Block

5.6 Adding Message Payload Block

5.7 Saving the File


 

5.1 What is a Data Set File?

 

Data Set File will be useful when more than one set of values for a particular Command Code are to be sent to the TL1 Agent. Data set will be used in the manager side for querying the agent. The possible set of values for a particular command can be defined in the Data Set file. This eliminates the need to type in the values each time for querying during run time.

Data Set file has to be loaded in the TL1 Browser along with its TL1 Command Set file. When you load the Data Set file for a particular Command Set file in the TL1 Browser, the values given in the Data Set will get automatically filled up in the respective block of the Command Set file.

 

Data Set File for a particular TCS file can easily be defined using the Data Set Editor in the TL1 MessageBuilder bundled with the Agent Toolkit.

 

5.2 Creating a New Data Set File Using TL1 Message Builder

 

Follow the steps given below to create the new Data Set file:

  1. Open the TL1 Message Builder using TL1MessageBuilder.sh/ TL1MessageBuilder.bat file available in  the <Agent Toolkit Home>/bin Directory. You can also open the TL1 Message Builder from the Launcher

  2. Select New option from the File Menu.

  3. Select Data Set Editor from the dialog box that appears.

  4. Load the created Command Set file for which the Data Set file is to be created. Let us load the TCS created in the previous topic for explanation in this chapter.

  5. Enter the name of the Data Set file and click OK.

Now, you will see the Parent Node (your Data Set file name) added under the Data Set tree in the left frame. Only the Input Message Nodes will be displayed in the Data Set Editor and not the autonomous messages.

 

Now, you can start adding the data for the command codes as explained in the following sections.

 

5.3 Selecting Command Code for Adding Data Set

 

Follow the steps given below to set up the command code for which the data set values are to be added.

  1. Expand the file tree of the data set file.

  2. Select the Modifier2 "DATA" in the input message RD-MEM-DATA

  3. Right-Click on the Modifier2 "DATA" and choose the "Add" option.

The wizard interface  will be enabled on the right frame where you can begin adding the Data Set values for various blocks. Also the Data Set values Can be added only for the nodes which has "COMMAND-CODE=YES" in the TCS file.

 

5.4 Adding Staging Parameter Block

 

For the selected Command Code, new data for the Staging Parameter Block can be added or existing data can be modified. Each Staging Parameter Block contains a Target-Id, Access-Id, C-tag and a User-defined data as input. You can add either single entry or multiple entries in the Staging Parameter Block. The next two chapters teaches you how to add single and multiple entries in the Staging Parameter Block.

 

5.4.1 Adding Single Entry - No Index Option

 

When the No Index option (situated above the Staging Parameter Block) is enabled, only one block of data set can be added for the particular Command Code in the Staging Parameter Block. Follow the steps given below to add a single entry to the Staging Parameter Block for the Command Code RD-MEM-DATA. The Entry will have Target-Id as "Target1", Access-Id as "RamDevice", and C-Tag as "1".

    1. Choose the No Index from the Index Block on the right frame of the Data Set Editor after selecting the Command Code as explained in 5.3.

    2. Click the Add button from the Staging Parameter Block.  A dialog box for adding the data for the Staging Parameter Block will pop up.

    3. Enter the following details in the dialog box.

    4. Click OK.

You will find the new entry added to the Staging Parameter Block. If you try to add another block to the Staging Parameter Block by clicking the Add button, an error message "Second block is not allowed" will be displayed.

      Note: Target Identifier (TID): An input message associated with the management of a particular object may be directly addressed to an NE or it may be routed to or through one or more intermediate NEs. The Target Identification code ( TID ) parameter block provides the capability within the TL1 message format to perform network routing tasks.

5.4.2 Adding Multiple Entries - Using Index Option

 

In situations when you need more than one Staging Parameter Block for a single command code, you can use the Index option. This facilitates having more than one Staging Parameter Block for the same command code. Multiple blocks created for a single command code will be added to the table under the staging parameter. The index can be any one of the staging parameters, e.g., Access-Id, Target-Id, C-Tag, or you can set your own ID for the node.

 

Follow the steps given below to add multiple entries to the Staging Parameter Block for the Command Code RD-MEM-DATA

You will find the second entry added to the Staging Parameter Block. Any number of entries can be added to the Staging Parameter Block following the steps given above

 

5.5 Adding General Block

 

The General Block affect the way in which the input command is to be executed in the NE.

 

Parameters OrderNo, Date, and Time enable Delayed Activation function. The date and time, when the input command is to be executed, is mentioned in the parameters Date and Time respectively. The Order Number will uniquely identify the particular input command  for which the activation is delayed.

 

IDR Indicator (Indirect Data Retrieval Indicator)  is a functional capability by which information can be retrieved from more than one linked administrative view by a single RTRV command.

 

C-Flag (Contingency flag), If set to False, partial completion of the records in a multiunit input message gets completed with a report sent to the OS listing the operations that were not successfully completed. If set to True, partial completion of the records in a multi unit input message will not be completed.

 

For this example, let us add the following details in the General Block.

  1. Order No: 2

  2. IDR Indicator: 1

  3. C-Flag: True

  4. Date: 02-08-04(yy-mm-dd)

  5. Time: 06-50-40(hh-mm-ss)

5.6 Adding Message Payload Block

 

Follow the steps given below to add data for the parameters in the Message Payload Block.

  1. Select the block in the Message Payload Block for which Data Set is to be added.

  2. Click the "Modify" button.

  3. Enter the value for each parameter of that particular block in dialog box that appears. Enter the following details.
    StartAddr: 102345
    EndAddr  :  102800

  4. Click OK.

Values for the parameters in the Message Payload block has been successfully added now.  You can also modify the values of already existing Message Payload Block parameters.

 

5.7 Saving the File

 

After adding the values for the parameters of the command codes in the data set file, save the file using the File>>Save option in the Menu Bar or press CTRL+S. The new data set file created can be used in the TL1 Browser while querying the Agent.

 




Copyright © 2009, ZOHO Corp. All Rights Reserved.