3.3 Managing Trace Templates in Web UI

Owned by Jenni Wallin
Last updated: Jul 25, 2023 by Former user (Deleted)
4 min read

You can manage your trace templates from the  Web UI: http://<platform host>:<web interface port>/mz/.

Conditional Trace in the Web UI

Creating and Saving a Template

To create a filter, select the New Template option from Conditional Trace.

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

  • Maximum Hits
  • Lifetime
  • Workflow(s)
  • Route(s) and/or Agent(s)
  • Field(s)
  • Field description(s)

Example of how to create a new template in the Web UI

FieldDescription
Template Name

Enter a unique template name, which consists of the  folder in which you want to save the template and a template name, separated by a dot: <folder name>.<template name>. If you do not determine in which folder you want to save a template, the Default folder is used, which is reflected in the template name when saved, e g the template shown in the image above becomes 'Default.wfbr'.

Max HitsEnter the maximum number of hits you want to see for the trace per node (agent or route).
LifetimeEnter the automatic timeout of the trace in milliseconds
Workflow NameEnter the name of the workflow to which you want to apply a trace. If you want to use a regular expression, select the check box to the right. To remove this field, click the minus symbol.
RouteEnter the name of the route in the workflow to which you want to apply a trace. If you want to use a regular expression, select the check box to the right. To remove this field, click the minus symbol to the right. If you enter a route, you must also enter a Field, see below.
AgentEnter the name of the agent in the workflow to which you want to apply a trace. If you want to use a regular expression, select the check box to the right. To remove this field, click the minus symbol to the right. For further information on adding a trace to an Analysis agent, see the section below, Adding a Trace to an Agent. If you enter an agent, you must also enter a Field, see below.
FieldEnter the field name of the UDR type to which you want to apply a trace. You must also enter a description of the field. If you want to use a regular expression, select the check box to the right. To remove this field, click the minus symbol to the right.

You can add several workflows, routes, agents and fields to a trace template by clicking the corresponding green buttons.

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>");

Saving a Template

When you have completed all the information required to create a template, click Save. When you create and save a template in the Web UI, the template is saved in the  folder that you determine in the template name, as described above. If you have not determined in which folder the template is to be saved, it is automatically added to the Default folder in the Desktop as a Conditional Trace Template configuration. For further information, see 3.1 Managing Trace Templates in Desktop. 

Listing, Editing and Deleting a Template

To list all of the templates that have been created, select the Templates option from Conditional Trace. All of the templates are displayed as shown in the image below. 

Note!

Irrespective of how you create a template, whether it is in the Web UI, the Desktop, or using the cURL commands, all of the templates are listed.


List of all the templates created

If you require to edit a template, click the relevant template from the list. You can then make changes as required, and click Update to save your changes.

If you require delete a template, select the relevant template from the list. To delete the template, click Remove. 

How to edit or delete a template


Next:

4. Managing Trace Filters