Configuring TL1 Craft Interface

 



 

When a TL1 Craft Interface shows up, it always gets loaded with the default properties configured. These default properties can be changed based on your requirements. The Options Window allows you to do this. You can open this window by selecting the Options button from the Tools menu.

 

The Options Window is split into five categories: Session, Message, User Interface, and Log File. Each option has its own default properties. The default properties are stored into tl1craftinterface.config file present under <Simulator_Home>/conf directory.

 

After editing the default properties, click the OK or Apply button to save the changes. Click the Cancel button to discard the changes.

 

Session Option

 

The Session option will let you modify the parameters pertaining to the TL1 Session, such as Transport, Mode, Keep Alive, Connection Handler, etc.

 

Session Option

 

Parameter

Description

Mode

Normal or Craft. In Normal mode, messages are processed, queued up and sent to the application. But in Craft mode, messages are given without any processing.

Transport

Represents the connection parameters for each transport (i.e. TCP, Telnet, and Serial).

Connection Handler

Represents the interface ConnectionHandler. Users can perform any device-specific tasks by plugging in their own custom class that implements this interface. This interface is invoked while opening and closing the connection.

Keep Alive

This option if enabled helps you to maintain connection with the device by sending messages periodically. You can set the TL1 message and the time interval.

 

 

Message Option

 

The Message option will let you modify the default properties related to TL1 Message, such as Parser, Formatter, Rationalizer, Prefix and Suffix of each message, Timeout and Retries, etc. The default properties are shown in the image.

 

Message Option

 

Parameter

Description

Parser

Represents the interface TL1Parser. This interface parses the TL1 messages and generates message objects. By default, com.adventnet.tl1.parser.TL1MessageParser is implemented. You can also plug in your own parser implementation.

Formatter

Represents the interface MessageFormatter. This interface allows users to format specific TL1 messages. Users can plug in their own formatter by implementing this interface. By default, it's value is null.

Rationalizer

Represents the interface MessageRationalizer. This interface allows users to upgrade messages based on the XML message definitions (command set) or filter specific TL1 messages. Users can plug in their own rationalizer by implementing this interface. By default, it's value is null.

Prefix and Suffix

Append special strings at the start and end of each TL1 message. This is optional and may not be applicable for all devices. The default prefix is \r and the suffix is null.

Timeout

Represents the timeout value of each request. By default, the timeout is 5000.

Retries

Represents the retries value that session has to do for each request. By default, the retries is 0.

Partial Message Accumulation

Option to provide or accumulate partial messages received from the device. If set to true, all partial messages are accumulated and given only after receiving a response with proper terminator (;).

 

Note : The special characters, \r, \n, \f, \b, \t are supported for prefix and suffix fields. Other characters are interpreted as specified.

 

You can change the default properties by editing the appropriate fields.

 

User Interface Option

 

The User Interface option will let you modify the default properties of the Craft Interface, such as color, look and feel, etc. You can change the default properties by selecting the appropriate fields. You can also modify the default location of the files used by the Craft Interface, such as Help Documentation and Data files. You can modify the existing location by selecting the ... button.

 

UI Option

 

Log File option

 

The Log File option will let you modify the default log configuration, such as File Name pattern, Time Stamp enable, Rollover details, etc.

 

Log File Option

 

Parameter

Description

Pattern

Pattern indicates the order in which the log file name must exist.

%n represents the log file name.

%d represents the date at which the log file is generated.

%t represents the time at which the log file is generated.

%c represents the log file count generated for that particular connection.

The date and time are optional in pattern.

Time Stamp

Represents the time at which the log record is created.

Append

Appends the log information to the same log file that was previously used by this connection.

Rollover Size

Maximum size of a log file after which a new log file will be created. You can give a value of 0 if you do not want log files to be created based on size. The size should be given in bytes.

Rollover Time

Time that must be specified after which a new log file will be created. The time should be given in the hh-mm-ss format.

Rollover Count

Maximum number of log files to be created for a specific device connection.

Rollover Interval

Interval that must be specified after which a new log file will be created. The interval should be given in milliseconds

 

 



Copyright © 1996-2006, AdventNet Inc. All Rights Reserved.