×

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 RunMyProcess platform. The Logs Application provides a way of viewing these logs.

1 Overview

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

Log Categories
Access Log Holds details of logons to the platform.
Process Log Holds details of the processes that have run, including their status.
Composite API Log Records details of the Composite APIs that have run, including their status.
Custom Log Holds the log messages added to applications by the application developer.
API Call Log Records details on API calls made on the platform.
Version Log Records details on project versions.
Instance Deletion Log Records details on deleting Web interface and process instances.

2 Using the Logs Application

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

The interface is very straightforward. Tabs are used to separate the log categories. Clicking a category tab displays the related log information.

2.1 Searching

You can search for activities that occurred during a specific time frame.

LogSearch

The start and end date are mandatory but the time fields are optional.

For all log categories, apart from the access log, version log, and instance deletion log, you can select which environment you would like to consider - Test, Acceptance, or Live.

Click MagnifyingGlass to display the search results.

2.2 Filtering the Information

FilterMenu

You can use filters to locate specific entries or a group of entries that you are interested in. Use Filter to toggle the filter display.

To filter the log entries, choose a required filter type from the list and enter the criteria in the box beneath. The Logs Application provides the following filter types:

Filters
= Displays all records that are an exact match to the single value entered in the criteria field.
IN Allows you to enter more than one value, separated by commas. Displays the records that match any of the values you enter.
Contains Displays all records that contain the characters entered in the criteria field.

Click CancelFilter to remove the filters that are set and display all log entries again.

2.3 Navigation

Navigation

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

3 Log Information

3.1 Access Logs

This tab provides information on logons to the platform and authorization problems that have occurred. The following information is provided:

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 that is logged. This is either 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 which the event was initiated.

3.2 Process Logs

This tab displays information on every process instance initiated on the platform. The following information is provided:

Date
The date and time the process instance concluded.

Status
Filter The final status of the process instance. Possible values are:

  • Outdated: The process instance 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 instance was manually cancelled before it completed.
  • Aborted: The process instance could not complete due to a problem and was aborted.
  • Completed: The process instance completed successfully.

Project ID
Filter The unique identifier of the project that the process instance was part of.

Project Version ID
The unique identifier of the project version that the process instance ran under. Note that 0 is displayed for instances running in Test mode as long as no project version had been created.

Process ID
Filter The unique identifier of the process.

Last Step ID
The unique identifier of the final step in the process.

Iteration
If the final step was a loop task, this field shows the number of iterations completed. If the final step was not a loop task, this field is set to 0.

Request ID
Filter The unique identifier given to the request.

Parent Request ID
Filter The unique identifier of the process or Composite API that called the process.

Duration
The duration, in milliseconds, that the process instance ran for.

Trigger Method
Filter The 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.

3.3 Composite API Logs

This tab displays information on Composite APIs that have run on the platform. The following information is provided:

Date
The date and time the Composite API concluded.

Status
Filter The final status of the Composite API. Possible 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 was aborted.
  • Completed: The Composite API completed successfully.

Project ID
Filter The unique identifier of 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 ID
Filter The unique identifier of the Composite API.

Last Step ID
The unique identifier of the final step in the Composite API.

Iteration
If the final step was a loop task, this field shows the number of iterations completed. If the final step was not a loop task, this field is set to 0.

Request ID
Filter The unique identifier of the request.

Parent Request ID
Filter The unique identifier of the process or Composite API that called the Composite API.

Duration
The duration, in milliseconds, that the Composite API ran for.

Trigger Method
Filter The way in which the Composite API was launched. Possible values are:

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

3.4 Custom Logs

Details of errors that arise during execution are available on the Custom Logs tab. 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 P_log FreeMarker method. The following information is provided on the Custom Logs tab:

Date
The date and time of the event that is logged.

Log Level
Filter An indication of the type and severity of the log entry. Possible values are:

  • SEVERE
  • WARNING
  • INFO
  • CONFIG
  • FINE
  • FINER
  • FINEST

Message
A message which explains the purpose of the log entry.

Login
Filter The email address of the user who launched the process in which the event occurred.

Process ID/Composite API ID
Filter The unique identifier of the process or Composite API that is the source of the logged event.

Project ID
The unique identifier of the project that is the source of the logged event.

Request ID
Filter The unique identifier of the request from which the logged event was issued.

3.5 API Call Logs

This tab displays the log information for all API calls made on the platform, including those for direct composite API calls which are also displayed in a separate log category (see above). The following information is provided:

Date
The date and time the API call was made.

Status Code
Filter The response status code received depending on the protocol.

Project ID
Filter The unique identifier of the project in which the API call is made.

Request ID
Filter The unique identifier of the request in which the API call is made.

Protocol
Filter The protocol used for the call. Possible values for internal protocols supported by the platform are:

  • MAIL for a mail from a task of type Email.
  • PUSH_MESSAGE for a push notification to a mobile from a task of type Email.
  • PUSH_NOTIFICATION for a push notification to a mobile from a task of type Manual.
  • USER_MESSAGE for administration mails sent by the platform.
  • NOTIFICATION for a mail from a task of type Manual.
  • JAVASCRIPT for a task of type Script that executes a Javascript file.
  • FREEMARKER for a task of type Script that executes a FreeMarker file.
  • DOC2PDF for a task of type Script that generates a PDF.

Provider
Filter The URL of the provider associated with the connector.

Connector
The URL of the connector. The URL of the provider concatenated with this URL results in the full URL of the connector.

Attempt No.
Provided the retry option is set for the connector, a maximum of 3 attempts can be logged, one line per attempt.

Call Type
External for a call to an external service, or Internal for a call to the platform.

Duration
Duration of the API call in milliseconds.

3.6 Version Logs

This tab displays version information for all projects existing on the platform. The following information is provided:

Project ID
Filter The unique identifier of the project to which the version belongs.

Version ID
Filter The unique identifier of the version.

Updated Mode
Filter The execution mode to which the version was changed: TO_LIVE, TO_ACCEPTANCE, or TO_TEST.

Date
The date and time the current execution mode was set.

User
Filter The email address of the user who set the current execution mode.

Version Title
Filter The name of the version.

3.6 Instance Deletion Logs

This tab displays information on delete operations for Web interface and process instances. The following information is provided:

Date
The date and time the instance was deleted.

User
The email address of the user who deleted the instance.

Instance ID
Filter The ID of the instance that was deleted.

Type
Filter The type of delete operation that was executed: APP_DELETION for a Web interface instance or PROCESS_DELETION for a process instance.

IP
The IP addresses of the client and Proxy servers involved in the delete operation.

Title
Filter The name of the Web interface or process instance that was deleted.

State
The reference number and the name of the Web interface screen (e.g. Ref = 1, Title = Launch) as well as the status of the deleted Web interface instance. Possible status values are:

  • CREATED(0) for a request that has not yet been triggered.
  • START(1) for a request that is pending.
  • END(2) for a request that completed successfully.
  • CANCEL(3) for a request that was manually cancelled by a user.
  • OUTDATED(4) for a request that failed to complete in the required time frame.

Status
The status of the deleted process instance. Possible values are:

  • NONE(0) for a process that is in a queue for processing. The process has not yet started.
  • READY(100) for a process for which the first step is being processed. The process has not yet started.
  • ACTIVE(101) for a process that is under execution.
  • WAITING(102) for a process that is waiting for an external action (e.g. a manual task).
  • WAITING_RESUME(103) for a process that is waiting to be resumed.
  • COMPLETED(201) for a process that completed successfully.
  • ABORTED(301) for a process that was aborted.
  • KILLED(302) for a process that was stopped by the platform.
  • CANCELLED(400) for a process that was cancelled by a user.
  • OUTDATED(401) for a process that failed to complete in the required time frame.

User Agent
Details on the browser launching the request.

Reason
Only relevant for process instances. The reason why the instance was deleted.

4 Logs Retention Policy

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