Common

Monitor Application Activity

All application activity is monitored and can be viewed through the console on the Monitor Overview page.

NOTE: Stewardship Tier components are monitored, with the exception of the CranSoft and System Administration WebApps.

This use case includes the following topics:

View Activity

Activity for each component is grouped by monitor status.

To view component activity:

  1. Click Job Monitor in Navigation pane.
  2. Click an icon to view all jobs with the selected monitor status for the application. The Monitor Overview page is sorted with the most recent job first.

Options:

  • All – Displays count for number of monitored jobs in the component. Click to view all jobs monitored for the application.
  • Ready – Displays count for number of jobs ready for processing, but processing has not started. Click to view ready jobs.
  • Initializing – Displays count for number of jobs that are scheduled to start, but have not started yet. Click to view initializing jobs.
  • Processing – Displays count for number of jobs that have started, but not finished. Click to view processing jobs.
  • Completed – Displays count for number of jobs successfully completed (i.e., that finished with no errors or failure). Click to view completed jobs.
  • Cancelled – Displays count for number of jobs cancelled while processing. Click to view cancelled jobs.
  • Failed – Displays count for number of jobs that failed to complete processing. Click to view failed jobs.
  • Error – Displays count for number of jobs where an unexpected error occurred while processing. Click to view jobs with errors.

Delete Monitored Records

Users have the ability to delete records from the Monitor page, which helps de-clutter the page when following a single process.. By deleting individual records, users can focus on the desired process(es). Clearing the entire monitor log allows users to follow particular processes as they enter the monitor log.

To clear all monitored job records for a component:

  1. Click Job Monitor in Navigation pane.
  2. Select an application record.
  3. Click Clear Monitor on Page toolbar.

To delete a single record from monitor log:

  1. Click Job Monitor in Navigation pane.
  2. Click a processing status icon for an application.
  3. Click Delete for a monitored record; a confirmation message displays.
  4. Click Ok.

Configure Debug Logs Settings

The Debug Logs page allows users to configure debug logs at the application level.

To configure debug log settings:

  1. Select Job Monitor > Debug Logs in Navigation pane.
  2. Click Edit for the component.

    View the field descriptions for the Debug Logs page

  3. Select a debugging level from TRACE LEVEL list box, which corresponds to the severity of the message logged. Values are:

    • Disabled - Debugging is disabled.

    • Debug - All logs returned during execution of the process display on the debug log.

    • Information - Only Information messages display on the debug log.

    • Warning - Warning, Error and Fatal messages display on the debug log.

    • Error - Error and Fatal messages display on the debug log.

    • Fatal - Fatal messages display on the debug log.

  4. Enter a value in RETENTION INTERVAL  field to control the number of days data is retained in the debug log.
  5. Click Save.

NOTE: To help debug or locate a process causing an error, click Clear Debug Logs to delete all debug logs for the application and re-run the process to view only the debug log for that process. 

View Debug Logs

A debug log is available for each component of the Stewardship Tier. These logs are used when debugging processes and when working with Support.

To view the debug log for a component of the Stewardship Tier:

  1. Select Job Monitor > Debug Logs in Navigation pane.
  2. Click View Debug Log for the Stewardship Tier component.

View the field descriptions for the Debug Log page

Add a Debug Log to a Custom WebApp

Debug logs display information, such as error messages and the date and time errors occurred to assist in troubleshooting issues with a component. The Stewardship Tier is installed with debug logs for delivered applications.

After a custom WebApp has been added to the Stewardship Tier, a user can add a debug log to it.

After the log has been added, the Stewardship Tier creates:

  • Table:  ttDebugLog
  • Page:  Debug Log
  • Views:
    • webTraceLevelSel
    • webDebugLogHor
    • webDebugLogVer

To view the debug log from within the custom WebApp, the user must add the debug log as a page to the custom WebApp. The log can also be viewed in the table ttDebugLog.

To add a debug log:

  1. Select Common > Job Monitor > Debug Logs in Navigation pane.
  2. Click Add.

    View the field descriptions for the Debug Logs page.

  3. Select the name of the custom WebApp from the COMPONENT list box.

    NOTE: A component can have only one debug log.

  4. Select an option in the TRACE LEVEL list box to designate the type of messages to be displayed in the debug log.

    Options are:

    • Disabled – Debugging is disabled.
    • Debug – All logs returned during execution of the process display on the debug log.
    • Information – Only Information messages display on the debug log.
    • Warning – Warning, Error and Fatal messages display on the debug log.
    • Error – Error and Fatal messages display on the debug log.
    • Fatal – Fatal messages display on the debug log.
  1. Enter a value in RETENTION INTERVAL field to control the number of days data is retained in the debug log. After the number of days has passed, the data is deleted.

    To clear all logs regardless of the retention interval, click the Clear Debug Log icon in the Page toolbar. This icon is not active if the Trace Level for a component is Disabled.

  2. Click Save.