Trace Process Object

The Integrator Trace process object can be used to debug Integrator scripts. This object will write intermediate column values either to standard output or trace files. The Trace object can limit the trace data to certain rows or columns of the input data. It is typically used as a sub-object.

NOTE: The format options "horizontal" and "column_header" will generate data that can then be processed by Integrator or Builder This provides a convenient way to snapshot an intermediate result of an Integrator script, for example, when there are calculated fields.

Trace Attributes

Attribute	Type	Description
process_type (required)	String	Identifies the object as a Trace process object. The value of this string is "trace".
input (required)	String	Defines the object from which the data flow is arriving.
disable	Boolean	Disables tracing for the Trace object. If this attribute is "true", then no tracing is performed. This allows a Trace object to remain in an Integrator script for later use, without any consequences.
filename	String	Defines the name of an output trace file. If this attribute exists, then the trace output is written to the named file. If this attribute does not exist, then the trace output is written to the command line.
append	Boolean	When set to "true", information will be appended to the end of an existing trace file instead of overwriting it. Some care should be taken to ensure that the columns of the appended data match the columns that already exist in the file.
start	Integer	Defines the starting row number for which to display trace information. This is based on rows that flow through the Trace object. The first row is row number one. Any rows before the start row will not be traced. If this attribute is not present, then tracing will start with the first row.
end	Integer	Defines the ending row number for which to display trace information. This is based on rows that flow through the Trace object. The first row is row number one. Any rows after the end row will not be traced. If this attribute is not present, then tracing will not be limited by an ending row number.
qual_str	String	Specifies a qualification string that is used to filter rows to be traced. Only rows between the start and end row number that match the given criteria will be traced. See Qual Process Object for the valid qualification string syntax. NOTE: This attribute is Qual Str in Visual Integrator.
limit	Interger	Defines the maximum number of rows that will be output as trace information. This attribute is applied after the qual_str attribute, and therefore works differently than the start and end attributes, i.e. the limit count applies to rows leaving the Trace object.
case_sensitive	Boolean	Controls whether string comparisons in the qualification string are case-sensitive. When set to "true", string comparisons are case-sensitive. When set to "false", comparisons are case-insensitive. The default is "true". NOTE: This attribute is Case Sensitive in Visual Integrator.
columns	Array of Strings	Defines the set of columns that are displayed in the trace output. If this attribute is omitted, then all columns that pass through the Trace object will be displayed. Note that this may be less than all possible columns in the flow, since Integrator only processes columns that are needed by the output object of a flow.
format (required)	String	Defines the format of the trace information. This attribute can have one of the following values: verticle—Indicates the trace output is written as labeled column values, one value per line. Multiple rows are separated with blank lines. (default) horizontal—Indicates the trace output is written as rows of values separated by delimiters. The columns are not labeled. column_headers—Indicates the trace output is written as rows of values separated by delimiters, with a single header row labeling the columns. This is similar to the "column_headers" file type in the Fileout output object.
verbose	Boolean	Controls whether or not trace rows are labeled with the Trace object name and row number. When set to "true" (default) trace rows are labeled. In horizontal or column_headers formats, the verbose data will appear in two column names: "Trace" and "Row number". When set to "false", the non-verbose horizontal or column_headers data formats will generate data that can be processed by Integrator or Builder. This is a convenient way to capture intermediate results.
delimiter	String	Defines the delimiter used for the horizontal or column_headers trace formats. It defaults to horizontal tab ("\t").
dictfile1	String	Similar to the dictfile1 attribute in the Fileout output object. If present, then this attribute contains the name of an old-style dictionary that is written with the format of the trace output. This attribute should only be used for non-verbose horizontal output. NOTE: This attribute is Dictionary File in Visual Integrator.
dictfile2	String	Similar to the dictfile2 attribute in the Fileout output object. If present, then this attribute contains the name of a new-style dictionary that is written with the format of the trace output. This attribute should only be used for non-verbose horizontal output. This attribute is preferred over dictfile1. NOTE: This attribute is Dictionary File in Visual Integrator.