Page tree
Skip to end of metadata
Go to start of metadata

The System Log provides a comprehensive view of all events in Usage Engine to browse or to purge.


All events are saved in the System Log by default. The System Log handles duplicate events within a specific time frame. Therefore every event has a first and last occurred date, as well as information on how many times the event was repeated.

The log entries, or messages, can originate from three areas of the system:

  • System - logs in this category are generated by the Platform or EC.

  • Workflow - logs in this category  are generated by workflows or agents embedded in workflows.

  • User - logs in this category are generated by user actions such as logins, importing, or exporting configurations.

For instance, if a workflow aborts, the reason is tracked through the System Log.


Get started:

  1. To open the System Log, click the Tools button in the upper left part of the Desktop window, and then double-click on System Log in the menu.
  2. To populate the System Log, click Search in the toolbar. See the section below, Searching the System Log.

Toolbar

OptionDescription

Search

Displays the Search System Log dialog where search criteria are defined to limit the log entries in the list. For further information, see the section below, Searching the System Log.

Select AllSelects all log entries in the table currently displayed. A group is selected from the Show Entries list, see Show Entries option below.

Refresh

Refreshes the system log based on the Search criteria.

DeleteDeletes the selected row or rows.
PrintPrints the selected row or rows.
Show Entries

Log entries matching the search criteria are displayed in groups of 500. Show Entries contains a list of all groups of 500, from which one is selected.

The full content of the log messages for a group is fetched from the database once the group is selected, for performance reasons.

Table Fields

Sort the messages by clicking on any table column header. Clicking a third time returns the original sort order.
FieldDescription
Sev

The severity of the message. It can be any of the following:

  • I (information) - An informative message. For instance, when a workflow is activated or a user logs in.

  • W (warning) - A warning message is also informative, but is considered to be slightly more serious than an information message. A warning message is logged, for instance, when a workflow sends data to Data Veracity.

  • E (Error) - An error is logged when any part of the system fails, for instance, when a workflow aborts. Double-clicking an error message displays the Stack Trace Viewer. This information must always be included when contacting DigitalRoute Support, in cases involving error messages.

  • D (Disaster) - Usually never used, other than possibly for user defined agents.

Last Occurred

The date when this message last occurred.

Repeated

Shows how many times this message has occurred.

Area

Shows from where in the system the message originates; from a User, from the System, or from a Workflow.

Workflow

The name of the workflow or agent from which the message originates.

Workflow GroupThe workflow group from which the message originates.

Message

The message itself. Select an entry in the list to display its full contents in the message area at the bottom.

First Occurred

The date when the message first occurred.

Note!

Double-click on an error message to open the Stack Trace Viewer dialog. The information in the Stack Trace Viewer must always be included when contacting Usage Engine Support in cases involving error messages.

Searching the System Log

In order to more easily track down specific messages, the Search System Log dialog lets you constrain the number of messages displayed.

  • Select Search in the toolbar to display the Search System Log dialog.

The search result is restricted to a maximum of 500 000 entries. To modify the maximum number of entries, add the Platform property mz.systemlog.maxresults to the platform.conf and modify the value. For further information, see Platform Properties[hide]2.0[/hide].

For an entry to be displayed in the list, it has to pass all of the following filters.

FieldDescription

Log Area

The area of the system that reported the log entry. At least one must be enabled.

Severity Type

Type of severity, see Sev above, in Table Fields. At least one type must be enabled.

Period

The time period within which log entries are viewed. Predefined options are available in the drop-down list. If none is selected, all are considered. The default period is Today.

From

If User Defined is selected in the Period drop-down list, all entries reported after the selected date will match. If not, all entries before the To date will match.

To

If User Defined is selected in the Period drop-down list, all entries reported before the selected date will match. If not, all entries after the From date will match.

If neither From nor To is selected, all entries will match.

Workflow Group

Includes messages from the workflow group that you select from the drop-down list.

Workflow

Includes specific workflows or agents from the drop-down list. If disabled, all workflows and agents will match.

Agent

Includes messages from the agent that you select from the drop-down list.

Note!

To have the system log present agent-related messages you need to configure an agent event from the Event Notification Configuration. For further information, see Add Event in Event Notifications Configuration[hide]2.0[/hide].

Username

Includes messages originating from the user selected in the drop-down list. If disabled, all user activities will match.

Note!

This setting applies to events invoked by users, such as inserting, updating, or deleting data in the system. It does not apply to workflow ownership and can therefore not be used to filter out a specific user's workflows.

Log Message

Use this field to search for occurrences of specific messages. Use all lower case letters in the text field to perform a case insensitive search. If upper case letters are used anywhere in the text field the search will be case sensitive.

Printing the System Log

Use the Print System Log dialog to print detailed information, or a brief description, of one or many log entries.

  1. Click Print in the toolbar to display the Print System Log dialog.
  2. Select the log entries of interest, before selecting Print.

Selections are made in one of the following ways:

  • Single select - An individual row is selected by clicking on it.

  • Browse select - Select many rows by clicking on the first row to be included, then, while holding down the <Shift> key, click the last row to be included in the selection.

  • Extended select - Select several individual rows by clicking them while holding down the <Ctrl> key.

FieldDescription

Headers Only

Prints a short summary of each selected log entry. The printed information is the same as displayed on each message row.

Full Details

Prints detailed information about each selected log entry, one page for each. The information printed is the same as displayed in the message area of the System Log window.

Include Stacktrace

Includes stack traces for the log entries where available (that is, Error type messages).

  • No labels