Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

You can manage your trace templates in the Desktop.

Creating a Template

To create a conditional trace template in Desktop, click the New Configuration button in the upper left part of the  Desktop window, and then select Conditional Trace Template from the menu. You can add your template directly in the configuration dialog that appears.

When you create a trace template, you must give the template a unique name, and specify the following: 

  • Maximum number of hits per node (agent or route) - enter a value for "max_hits"
  • Automatic timeout of the trace in milliseconds - enter a value for "lifetime"
  • Workflow(s)
  • Route(s) and/or Agent(s)
  • Field(s)
  • Field description(s)

{ "name": "<template name>",
 "max_hits": <max number of hits>,
 "lifetime": <lifetime in ms>,
 "workflow": [{
  "name": { "expr" : "<name of workflow>" },
  "routes": [
      { "name" : { "expr": "<route name>" },
        "fields" : [
            { "name": { "expr" : "<field name>" }, "description": "<field description>" }
        ]
      }
  ]
 }]
}

If you want to use a regular expression in a trace template, you can indicate this by including "regex": "true" after the object for which you are using regular expression:

"<object>":{"expr": "<regular expression", "regex":"true"}

Adding a Trace to an Agent

You can also add a trace to the APL code of an Analysis agent so that you can trace which functions change a UDR. To make this addition, you must modify the APL code in the relevant Analysis agent and specify the details in the trace template.

Add the following to the APL code:

trace(<udr>, "<string>");

In addition to the specifications listed in the section Creating and Saving a Template, specify the following in the trace template:

"agents": [
      { "name": {"expr": "<agent name>"}, 
        "fields": [ 
            { "name": { "expr" : "<field name>" }, "description": " <field description>" } ] } ]

See the Example - A Trace Template in 3.2 Managing Trace Templates using cURL.

Saving a Template

To save the template you have created, click Save As. You must then select in which folder you want to save the template, and give the template a unique name. When you save the template, it is added to your list of templates.

Listing and Editing Templates

To list all of the templates that have been created, click the Open button. A dialog is displayed showing you the folders that contain trace templates, which you can expand to show all of the templates.

You can select a template from the Configuration Selection dialog and edit the template as required.

Deleting a Template

If you require to delete a template, you can select the configuration in the Configuration Navigator pane, right-click and select Delete. The template must be closed to be able to delete it.

  • No labels