Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).

<trace>

Write a message to the foreground Terminal window.

Syntax

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

Details

Attribute or Element Description Value
value attribute Required. This is the text for the trace message. It can be a literal text string or an expression to be evaluated. A string of one or more characters. May be an expression or a literal string. If this is an expression, it must use the scripting language specified by the containing <process> element. You can also use virtual property syntax using the {} convention.
name, disabled, xpos, ypos, xend, yend attributes See “Common Attributes and Elements.”  
<annotation> element

Description

The <trace> element writes a message to the Terminal window. <trace> messages appear only if the BPL business process that generates them 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 by configuring a production from the Ensemble,Productions page in the Management Portal. If a BPL business process 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 BPL <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 “Adding Trace Elements” in the chapter “Programming in Ensemble” in Developing Ensemble Productions.

Feedback