Trace Metaconnector Properties

The Trace Metaconnector options and their corresponding LotusScript® Extensions (LC LSX) properties are described as follows.

Field

Description

Name

Specifies a unique name that identifies this connection. The maximum number of characters allowed is 255.

Connection to Use

Names the underlying connection to be traced. Enter the name of another connection or metaconnection document in the HCL Enterprise Integrator (HEI) Administrator database.

In LC LSX, use the ConnectorName property (string). This specifies the name of the external system connection that you want to trace. A sample entry is "db2". In the LSX, you must use the name of a connector, not the name of an HEI connection document.

Trace is displayed on screen

Specifies whether to write trace data to the HEI console window.

In LC LSX, use the OutputRecord property (integer) with a value of 4 if trace output is to be written to the display.

Trace is written to a file

Allows you to capture trace data to a text file. All output captured to a log file is appended to the end of the file. If the output file does not exist, it will be created. If the log file cannot be opened, a message indicating this will be sent to the activity log.

The log file can grow quite large. You can delete the log file when the trace data is no longer needed.

The default log file name is trace.log. If you specify some other name (using the Log Filename option), such as "c:\foo\mytrace.log" on Microsoft Windows, then the initial output, up to the point where the file name parameter is read, will be sent to "trace.log", and trace output after that point will be logged to the "c:\foo\mytrace.log" file.

In LC LSX, use the OutputRecord property (integer) with a value of 2 if trace output is to be written to the file.

Log Filename

User-specified log file name -- allows you to specify a log file name. This option can provide more control over the trace output destination.

When a trace is started, initialization occurs followed by a series of LCXSetProperty calls based on information from the connection document. It is only after this point that trace data can be logged to a user-specified file: the initial trace output is lost.

In LC LSX, this is LogFilename (string).

Trace is written to the activity log

Determines whether or not output will be written into the activity log.

In LC LSX, use the OutputRecord property (integer) with a value of 1 if trace output is to be written to an activity log.

Record time stamp with each logged entry

Records a timestamp with each entry that is captured in the log file.

In LC LSX, use the OutputRecord property (integer) with a value of 8 if timestamps are to be included.

Note: The LC LSX property BreakpointRecord (integer) is for Internal use only and causes code to break for debugging.

As with other metaconnectors, when using the LC LSX you must also assign all properties needed by the underlying base connection type, such as Database, Metadata, UserID, and so on.