Skip to main content

DTL <trace>

Write a message to the foreground Terminal window.

Syntax

<trace value='"The time is: " & Now' />

Attributes

Attribute Description Value
value Required. This is the text for the trace message. It can be a literal text string or an expression to be evaluated. If an expression, it must use the scripting language specified by the containing <transform> element: "basic" or "objectscript". If not specified, the default is "objectscript". MVBasic is not supported. A string of one or more characters. May be a literal string or an expression.

Elements

Element Purpose
<annotation> Optional. A text string that describes the <trace> element.

Description

The <trace> element writes a message to the Terminal window. <trace> messages appear only if the business host that invokes the DTL data transformation has been configured to Run in Foreground mode.

Trace messages may be written to the Ensemble event log as well as to the console. A system administrator controls this behavior from the Management Portal Configuration page. If the business host that invokes the DTL data transformation has the Log Trace Events option checked, it writes trace messages to the event log as well as displaying them at the console. If a trace message is logged, its event log entry type is Trace.

The DTL <trace> element generates trace message with User priority; the result is the same as calling the $$$TRACE utility from ObjectScript or the WriteTrace("user") utility from Basic.

Note:

For details, see the sections “Adding Trace Elements” in the “Programming in Ensemble” chapter of Developing Ensemble Productions.

FeedbackOpens in a new tab