What Are the XMLTracer Configuration Options?

By default, XMLTracer dumps the top-level OrderForm ("Order" dictionary). By setting special key values in the OrderForm dictionary, you can tell it to dump only a specific subdictionary of the OrderForm. You typically insert a Scriptor component into the pipeline before the XMLTracer component to set these values. However, you do not have to insert them; it is entirely optional.

The special keys are:

  • XMLTracer_DictionaryToDump. Specifies either a subdictionary of the OrderForm, or the special value Context. For example, use FilterRequire to dump out the Content Selection Framework (CSF) filters in a Content Selection pipeline. Using Context causes the Context dictionary to be dumped.

    Note

    Using Context may not work because the Context dictionary typically contains objects that cannot be serialized to XML.

  • XMLTracer_Comment. Specifies a comment to insert into the log file. This is useful for distinguishing multiple traces in the same or different pipelines, making it easy to search the log file.

The following is an example of using a Scriptor component to set these properties. When using a Scriptor component to set the configuration values, the Scriptor component should precede the XMLTracer component in the pipeline.

function MSCSExecute(config, orderform, context, flags)
    orderform.value("XMLTracer_DictionaryToDump") =  "_verify_with"
    orderform.value("XMLTracer_Comment") = "Debugging Comment"
    MSCSExecute = 1
end function

See Also

Other Resources

What Are the XMLTracer Trace Levels?

Using the XMLTracer Pipeline Component