×

Please give details of the problem

Docs

Find

Logs Application

Logs are essentially a record of events that have occurred in a system. Viewing log entries enables you to monitor activities on the platform. The Logs Application provides a way of viewing the logs that have been produced by the RunMyProcess platform.

1 Overview

As certain events occur on the RunMyProcess platform, their details are recorded in logs. The Logs Application gives you the ability to view these records. There are four categories of logs:

Log Categories
Access Log Contains details of logons to the platform.
Process Log Holds details of all processes that have run, including their status.
Composite API Log Records details of all Composite APIs that have run, including their status.
Custom Log Holds the log messages added to applications by the application developer.

2 Accessing the application

The Logs Application can be found in the 'Administration Applications' section of your RunMyProcess homepage.

3 Using the application

LogsApplication

The Logs Application interface is very straightforward. Tabs are used to separate the log categories, clicking on a category tab will display the log information. The logs available are:

Log Categories
Access Log Contains details of logons to the account.
Process Log Holds details of all processes that have run, including their status.
Composite API Log Records details of all Composite APIs that have run, including their status.
Custom Log Holds the log messages added to applications by the application developer.

3.1 Searching

It is possible to search for activities that occurred during a specific time frame. Using the search facility enables you to view only these log entries.

LogSearch

Entering a start and end date is compulsory but the time fields are optional.

For all logs, apart from the access log, it is possible to choose which environment you'd like to consider - Test, Acceptance or Live.

Click on MagnifyingGlass to display the results of the search.

3.2 Filtering the information

FilterMenu

Filtering the log entries enables you to locate specific log entries or group of log entries that you are interested in. Clicking on Filter toggles the filters; clicking it once makes the toggle fields visible while clicking on it a second time removes them.

To filter the log entries, choose the type of filter you require from the list provided and enter the criteria in the box beneath. The Logs Application makes use of two types of filter:

Filters
= All records that are an exact match to the single value entered in the criteria field will be displayed.
IN Allows the user to enter more than one value, separated by commas. Records that match any of the values entered will be displayed.

Clicking on CancelFilter removes all set filters and all log entries are displayed.

3.3 Navigation

Navigation

Twenty log entries are displayed per page. Use the navigation bar to navigate through the pages.

4 Log Information

4.1 Access Log

The access log provides information on logons to the platform and any authorization problems that have occurred.

The following information is provided:

Field Description
Date The date and time the access attempt occurred.
User Filter The user name responsible for the access attempt.
Scheme The authentication method used for user logon e.g. HTTP Basic.
User Agent Details of the platform from where the access was attempted.
Event Filter The event being logged. This will either be a successful logon to the platform or an authorization problem - the user has attempted to access a resource for which he does not have access rights.
IP Filter The IP address from where the event was initiated.

4.2 Process Log

The process log displays information on every process that has run on the platform.

The log provides the following information:

Field Description
DateThe date and time the process concluded.
StatusFilter The final status of the process. Possible status values are:

  • Outdated: The process failed to complete in the required time frame. This status can only be achieved if the application developer has made a call to P_set_request_status within the application.
  • Cancelled: The process was manually cancelled before it completed.
  • Aborted: The process could not complete due to a problem and so was aborted.
  • Completed: The process completed successfully.
Project IdFilter The unique identifier for the project that the process was part of.
Project Version Id The version of the project that the process ran under.
Process IdFilter The unique identifier of the process.
Task Id The unique identifier of the final task that ran in the process.
Iteration If the final task was a loop task, this field shows the number of iterations completed. If the final task was not a loop task, this field is set to 1.
Request Id The unique identifier given to the request.
Duration The duration, in milliseconds, that the process ran for.
Trigger MethodThe way in which the process was launched. Possible values are:

  • APPLI: The process was launched manually from an application.
  • LISTENER: The process was launched automatically from an application using a process listener.
  • MESSAGE: The process was launched by sending an email to the platform.
  • TIMER: The process launch was scheduled.
  • WS: The process was launched by a Web Service (usually a connector).
  • PROCESS: The process was launched by another process.

4.3 Composite API Log

The Composite API log displays the log information for the Composite APIs that have run on the platform.

The information provided in the Composite API log is:

Field Description
DateThe date and time the Composite API concluded.
StatusFilter The final status of the Composite API. Possible status values are:

  • Outdated: The Composite API failed to complete in the required time frame. This status can only be achieved if the application developer has made a call to P_set_request_status within the application.
  • Cancelled: The Composite API was manually cancelled before it completed.
  • Aborted: The Composite API could not complete due to a problem and so was aborted.
  • Completed: The Composite API completed successfully.
Project IdFilter The unique identifier for the project that the Composite API is part of.
Project Version Id The version of the project that the Composite API ran under.
Composite API IdFilter The unique identifier of the Composite API.
Task Id The unique identifier of the final task that ran in the Composite API.
Iteration If the final task was a loop task, this field shows the number of iterations completed. If the final task was not a loop task, this field is set to 1.
Duration The duration, in milliseconds, that the Composite API ran for.
Trigger Method All Composite APIs are essentially launched using a Web Service so this field will take the value WS

4.4 Custom Log

Details of any errors that arise during execution are available to view in the custom log. Application developers can also develop their application so that information is written to the custom log when events occur. This is accomplished by a call to the FreeMarker method P_log.

The information available from the log is:

Field Description
DateThe date and time of the event being logged.
Log LevelFilter This provides an indication of the type and severity of the log. Possible values are:

  • SEVERE
  • WARNING
  • INFO
  • CONFIG
  • FINE
  • FINER
  • FINEST
MessageA message which explains the purpose of the log entry.
LoginFilter The email address of the user that launched the process that the event occurred in.
Process Id / Composite API IdFilter This is the unique identifier of the process or composite API that was the source of the logged event.
Project Id The unique identifier for the project that is the source of the log event.
Request IdFilter This is the unique identifier of the request from where the log was issued.

5 Logs retention policy

The RunMyProcess logs are available for the current and the previous year.