How-tos: Orchestrator SaaS Troubleshooting
Logging
Studio Pro and Bot Runner can register logs about each workflow you run. Here are two options for you to collect and save this data with Orchestrator SaaS.
Collecting execution logs
Orchestrator SaaS can collect execution logs automatically. This data shows every execution of the bot. Follow these steps to enable this option:
- Navigate to the "Orchestrator SaaS" page of the User Portal.
- Open the "Workflows" tab.
- Select a workflow.
- In the list of parameters, enable the "Collect execution logs automatically" option.
- A confirmation window displays. Click "Confirm".
Checking results
If the option is enabled, you can see execution logs after running the bot. To do that:
- Navigate to the "Workflows" tab.
- Go to the list of workflows and click on the desired one.
- Go to the "Runs history" tab.
- Among the list of launches, choose one and press the "sheet" symbol to see its logs.
- Click on the "Automatic logs" tab.
To download logs as CSV files, click "Save to file".
Collecting console logs
Users can collect data obtained from the Console log activity in the workflow.
Prerequisite
Make sure the Console log activity is used in the workflow.
This Studio Pro activity allows you to see information such as time, warnings, success messages, errors, etc. From these details, you can check, for instance, if a business parameter fails and then a business owner with an Analyst role in Orchestrator SaaS can access the platform and see what happened.
Checking results
If the logging option is enabled, you can see bot logs after executing them. To do that:
- Navigate to the "Workflows" tab.
- Go to the list of workflows and click on the desired one.
- Go to the *"Runs history"* tab.
- Among the list of launches, choose one and press the "sheet" symbol to see its logs.
- There you see the "Console logs" tab.
Click the *"More information"* icon to see more details in a pop-up:
Bot Runner and workflow statuses
Introduction
There are sets of statuses for the workflows loaded into Orchestrator and the Bot Runners connected to them. The statuses state the work of algorithms and Bot Runner at the current moment, and may also indicate the need to perform certain actions. In this article we will look through the statuses of workflows and Bot Runners in more detail.
Bot Runner statuses
- Online - Bot Runner is connected to Orchestrator, but the user is not authorized in Bot Runner with rights to use Orchestrator at this time.
- Offline - Bot Runner was previously connected to Orhcestrator, but the user is not currently authorized in Bot Runner with the rights to use Orchestrator.
- Busy - Bot Runner is currently performing a workflow.
Workflow statuses
- Added - the workflow is loaded, but no Bot Runner is assigned to it.
- Ready - the workflow is loaded and ready to run on the available Bot Runner.
- In Progress - the workflow is currently in progress.
- Pending - the workflow is in the queue and waiting to be performed.
- No available Bot Runners - the workflow is loaded, but all the assigned Bot Runners are either offline or busy.
How to know a bot's error details
Introduction
There are two ways to know the details of errors that may occur in the bot's execution. Detailed information about errors allows you to handle them properly and debug the algorithms.
Message on the "Workflows" page
If an error occurs during the execution of the bot, the corresponding icon will be displayed on the "Workflows" page. Click this icon to see detailed information about the error. It will contain the date and time the error occurred, the file and activity where the error occurred, and the error message itself.
Error email
Orchestrator SaaS has the ability to send messages to users regarding bot failures. This feature is enabled by default and can be disabled on the Orchestrator page.
The email address of the user who published the bot is taken as the address to send messages to. If necessary, this address can be changed or more addresses can be added.
The error message will look like this:
The execution of the bot on Bot Runner {Bot name} is stopped due to: {Error message}
Date: {Date}, {Time}
Link: {Link to bot}