Log viewer

This section details the log viewer and the main log sources in IBM Robotic Process Automation.

You can audit the script execution logs on the IBM RPA control center through the log viewer. The log viewer lists the set of execution logs by script, dividing the sets by execution date, execution status, or computer in which the execution occurred. The following steps show how to navigate to the log viewer in the IBM RPA control center:

Requirement: You must have an account created in the tenant.

  1. Log in to the IBM RPA control center.
  2. In the left side menu, click the Scripts menu.
  3. Locate the script.
  4. Click the vertical ellipsis button ⋮ > Details.
  5. Go to the Logs tab.
  6. Optional: Select the date interval of the logs.
  7. Optional: Select the status of the execution.
  8. Optional: Select the computers where the bot ran.
  9. Click the Search button.
  10. Locate the logs and click the vertical ellipsis button ⋮ > Details.
  11. Optional: Select the Log level to only display log messages with that level.
  12. Optional: Select the Log message that you want to find.
  13. Optional: Select the time interval of the log messages.
  14. Click the Search button.

Execution logs

Execution logs are generated locally and sent to the IBM Robotic Process Automation server when the bot execution is finished. In addition to the visualization in the IBM RPA control center, the execution logs can be viewed in local files.

Each execution of a script generates a local log file in:

C:\Users\[User]\AppData\Local\IBM Robotic Process Automation

The folders that store these files are created with the following nomenclature pattern:

[Year][Month][Day]

Example:

C:\Users\John Doe\AppData\Local\IBM Robotic Process Automation\20210311

The log files are named as follows:

[Component]-[Execution ID]

Example:

Bot-00659af4-7baa-4046-b59e-51b9558000af

The components are:

Bot
Component of Chatbot instances. The Bot files store messages registered by the bot and the chatbot interactions.

Host
Component of Bot Runtime. Bot Runtime is the application that executes bots. Host log files store messages registered by the bot.

Main applications logs

Different components of IBM Robotic Process Automation generate local log files to audit your activities. This section focuses on the IBM RPA Studio, Bot Agent, and IBM RPA Vault components. The following definition list describes the log messages generated by the components:

IBM RPA Studio
IBM RPA Studio activity data log. Executed bots in IBM RPA Studio using the command Log message (logMessage) also generate entries in this file. The path of the file is %localappdata%\IBM Robotic Process Automation\Studio.log.

Bot Agent
IBM Robotic Process Automation service data log named Bot Agent. The path of the file is %programdata%\IBM Robotic Process Automation\AgentService.log.

Vault
Activity log of IBM RPA Vault. The path of the file is %localappdata%\IBM Robotic Process Automation\Vault.log.

To view component logs in IBM RPA Studio:

  1. Log in to IBM RPA Studio.
  2. Click the Help ribbon.
  3. Click as following:
    • To view IBM RPA Studio logs, click the Studio button in the Logs section.
    • To view the Bot Agent logs, click the Agent button in the Logs section.
    • To view the IBM RPA Vault logs, click the Vault button in the Logs section.

Dashboard

You can view data about the script execution with dashboard on the IBM RPA control center. This data is stored in the Jobs data source, which can be integrated with a dashboard to display the following data:

Duration
Stores the duration of the script execution in seconds.

End Time
Stores the date and time of the script execution end.

Job Id
Stores the unique task ID that identifies the script execution.

Product Version
Stores the IBM RPA Studio version that the script was published.

Start Time
Stores the start date and time of the script.

Status
Stores the script execution status message.