Robotic Processes

This page describes what you can see and do on the Robotic processes tab in the Appian RPA Console.

rpa-robotic-processes.png

In the List of robotic processes, you can see the robotic processes you have access to.

Click on any robot to views its executions log, where detailed information about all executions performed so far is available.

Looking to create a robotic process? Head to the Developer page for more information.

Robotic process information

This screen displays all the information regarding the selected robot. For example, you can see the "Payroll" robotic process's information, which is in charge of salary payment to every employee in a company.

rpa-rps-executions-list.png

You can start a new execution of this robot by clicking on the Execute button rpa-execute-icon.png in the toolbar. By doing so, you will access the Robot execution screen.

Also in the toolbar, you can see the Configure button 2236505.png, where you can access the Robot setup screen.

Results of executions

The results section includes metrics for the results obtained by the robotic process while processing items since its first execution.

Click on the Charts icon to view the results.

rpa-rps-chart.png

The values displayed here correspond to all the executions performed by the robot, including:

  • Total items: The sum of all processed items, employees in this case, as well as the sum of all robots' executions.
  • OK: Number of items successfully processed and the percentage of the total items processed.
  • Warnings: Number of items that have shown any defect during their execution, including those exceptions not covered by the robot, that must be done manually, as well as the percentage with respect to the total.
  • Execution time: Cumulative time of the robot's execution, and average execution time per item.

List of executions

8028494.png

This list displays specific information about each execution and lets you act on each one.

The information shown is as follows:

  • Execution: Number or identifier assigned to that execution.
  • Description: Information about the execution, always including the resource used. Depending on who starts the execution, the information may vary:
    • If the execution was manually started by a user, the information provided by that user at that moment is included.
    • If it was started via API, the information entered in the corresponding parameter is included, according to the pattern:

      <message> @ <resource> by <user> (api)

    • If it was started by an application, it will follow this pattern:

      Schedule on <date> @ <resource> by <user> (cron)

    • If it was started by another robot ("executing robot"):

      Schedule from robot <robot_name>#<num_execution> running on <executing_robot_name> @ <executed_robot_resource_name> by <user> (robot)

    • In addition, when an execution is canceled, the following information is shown here. For this, the existing message will be displayed with additional text, as follows:

      <previous_message > canceled by <user>

  • Start: Date when the robot was executed (no value means the robot has failed to start, was canceled by a user before it started, or has not started its execution yet).
  • Result: this column shows information about two types of results:
    • Execution: success or failure
    • Items processed: OK ( 2236536.png ) or WARN ( 2236520.png ). Additional classifications include:
      • CHOCOLATE ( 2236517.png ).
      • CORAL ( 2236514.png ).
      • CYAN ( 2236529.png ).
      • DARK_GRAY ( 2236511.png ).
      • INDIGO ( 2236523.png ).
      • LIGHT_GRAY ( 2236528.png ).
      • LIME ( 2236533.png ).
      • MAGENTA ( 2236526.png ).
      • OLIVE ( 2236521.png ).
      • RED ( 2236531.png ).
  • Output: Inventory of the output files of the process (which can be downloaded by the corresponding icon).
  • Actions: If the executions are running or they have ended, it is possible to perform different actions upon them. To perform actions on multiple executions, check the boxes in the Sel column.
Icon Description
8028488.png Deletes the execution and all the associated files
8028490.png Download of the execution's trace as a plain text file
8028489.png Change the execution from Test to Non Test and the other way around
8028491.png Blocks / Unblocks the execution so it can't be deleted. Blocked executions are shown in bold font.
2237070.png Pause a running execution
2236515.png Resume a paused running execution
2236527.png Cancel an execution

All string values in tag symbols are dynamic.

Click an execution to access the Execution information screen, which includes the process workflow and the execution log.

It is also important to highlight that executions labeled as tests will be displayed using a specific style with a different background.

Execution log

The Execution log tab shows the execution trace in detail. It is very useful information for both users and development teams when debugging a robotic process.

With the execution log, you can follow the robotic process's progress through its workflow. The log shows its activity, informational messages, exceptions, and errors. Developers can code robotic processes so they display information in the execution log at certain points in the execution.

rpa-execution-log.png

Learn more about how to read the execution log.

Robots' execution

Another feature provided by the console is the execution of a robot that you have registered. You can set up a robot to include execution parameters, that is, information that will guide robot's behavior during its operation.

Click the Configure icon to set up a robot from the console's Robotic Processes tab.

rpa-configuration-icon.png

On the setup page, you can enter the parameters you need to guide the process's behavior as you want it to be during its operation.

Charts

Click on the Charts icon 2236509.png in the toolbar to view a graphical representation of the results obtained by the robot from processing items each month.

rpa-monthly-chart.png

The values displayed correspond to all executions performed by the robot during the selected month (by default, current month), with the following details:

  • Total items: the sum of all items processed in the different executions of the robot (in the selected month).
  • OK: number of items successfully processed and the percentage of the total (in the selected month).
  • Warnings: number of items that have shown any defect during their execution, and the percentage of the total (in the selected month).

You can browse previous months to analyze the evolution of the data.

Executions running

This dynamic chart shows aggregated information about all the items being processed in current executions of the robot. On the Robot executions page, click on the Executions running icon ( 2236522.png ).

2236530.png

The information shown is divided in three groups:

  • Duration (by execution): average time by execution, cumulative time of executions, and maximum time took by an execution.
  • By item: average time by item, cumulative time of items, and the maximum time taken by an item.
  • ETC (estimated time to completion): estimations about average time, cumulative time, and maximum time values by execution at the end.

Enable or disable a robotic process

This option is only available for Administrators.

In the toolbar on the List of robotic processes page, you'll see a Enable/disable execution of robotic processes icon rpa-lock-processes.png that allows you to enable or disable all robots' execution. This option is useful if you need to perform any task without robotic processes running at the same time.

When you click this icon, you'll need to confirm the action. You can also optionally add a customized message. When you confirm, a red alert will display so you know that all robotic processes' execution is disabled.

rpa-disable-execution-banner.png

Robots currently running are not canceled, but new executions are prevented in every resource.

Toolbar options

From the Robotic processes page, you have access to a number of other options in the toolbar.

Documenter

This screen allows you to manage the different sessions saved with the documenter tool. Click the Documenter icon 951026.png in the toolbar to get started.

Record a session

To start working with the Documenter, first download and run its executable. After you launch the file, you will know Documenter is running by the icon 951028.png shown in the taskbar.

Documenter captures the actions performed by both the keyboard and the mouse. Each time an action is performed, such as a mouse click or pressing the "Enter" key, the icon highlights: 951029.png. All these actions are automatically saved into a file using the filename format session-from-DATEFROM-to-DATETO.zip, which is stored with the executable itself. DATEFROM and DATETO are the initial date and the session date in YYYYMMDD_HHMMSS format.

When you have finished your session recording, right-click on the documenter icon and select Quit.

Upload a session

To upload a session previously recorded with the Documenter, click on the icon rpa-upload-icon.png located on the upper right hand corner.

To access all captured actions, upload the ZIP file into the Documenter section. Once uploaded you can access the documented session where you can watch all captured images together with their associated events.

List of documenter sessions

This section shows the list of sessions uploaded to the console and allows you to perform different actions on them.

rpa-documenter-sessions.png

The information shown is as follows:

  • Session: start and end date of the session
  • Keyboard: the number of actions performed using the keyboard
  • Mouse: the number of actions performed using the mouse
  • Total steps: the total of actions performed
  • Actions: sessions that can be deleted

Click on any row to see that session's details.

Documentation session

On this screen, you can find each action performed during the session.

documenter1.png

The information shown is as follows:

  • Timestamp: date when the action was performed
  • Reason: the event that triggered the action
  • Data: the output data
  • Title of active window: title of the window where the action was performed
  • Actions: delete the sessions

By clicking on any row, you can access to the action's details screen. In this window, you can find a summary of the action and all its data.

You can also access any of the other actions within the session by clicking on the list located on the right side.

documenter2.png

Credentials

This screen allows you to manage the credentials available for the robotic processes in the console. You can access this section by clicking on the Credentials icon 2229111.png.

It is important to highlight that credentials are controlled through permissions, therefore a robotic process or library will have access only to those credentials with at least one permission in common with it. Learn more about permissions.

List of credentials

This section displays the list of credentials defined in the console, and allows you to perform different actions on them.

rpa-credential-list.png

It includes the following information:

  • Application: name given to the credentials
  • Username: the user stored in the credentials
  • Password: the password stored in the credentials (not shown on screen, instead the literal [PROTECTED] is displayed)
  • Active: indicates whether a credential is active or not
  • Use: indicates how many times a specific credential is being used of a maximum defined. Click on the Update maximum use icon to specify this maximum, otherwise it can be used as many times as wanted. For instance, 2/4, means that the credential is being used by robots 2 times of a maximum of 4.
  • Actions: you can delete a credential, and you can modify its permissions
  • Permissions: list of permissions applied to the credentials

The Update password icon that appears next to the literal [PROTECTED], allows you to update the password. By clicking on that icon, you will be asked to enter the new password and confirm its value.

Credentials editor

In the Credentials editor, you can create new credentials inside the console.

rpa-credential-editor.png

Fill these fields to create new credentials:

  • Application: name defined for the credentials, which can be repeated in different credentials.
  • Username: username to be used with this credential.
  • Password: the password for the username defined in the "username" field, to be used in this credential.
  • Permissions: List of permissions associated with the credentials. It will delimit what users will have these credentials available.

Libraries

A library or nano-robot is a little piece of code that provides a generic functionality to the different robots defined within the Appian RPA console. The library can provide actions that can be reused from a robot's workflow to perform certain operations, or even could be invoked from the robot's code itself. For example, a library would be the robot that provides a VPN or proxy connection.

A Maven dependency is close equivalent to an Appian RPA library, since it is a piece of code that can be reused in other Maven artifacts. However, by doing so, we are introducing some coupling between our code and that library in some extent. The main difference between a Maven dependency and a library is that our Maven artifact does not need external references to it, but still it can interact with it, either invoking actions from our robot's workflow, or by direct calls using the methods provided by the Appian RPA API.

On the Libraries page, you can manage the libraries available for the robots in the console. Click the Libraries icon 2236298.png in the toolbar.

Libraries are protected by permissions. This means a robot can only use libraries with common permissions.

List of libraries

This section displays a list containing all the libraries defined within the console, and allows you to perform several actions on them.

2236301.png

The information shown in this list is as follows:

  • Repository: Maven repository where libraries are deployed. In case it is empty, the library will be searched in the repository list defined for the console.
  • Username: Maven username of the developer who uploaded the library
  • Group: identifier for the group of the Maven artifact associated with the nanorobot
  • Nano-robotic process: identifier of the Maven artifact associated with the nanorobot
  • Version: version of the Maven artifact associated with the nanorobot
  • Main class: the main class to execute
  • Actions: you can delete or update the libraries (refreshing the Maven artifact from the repository)

Library editor

You can create new library definitions within the console or edit existing ones.

To edit a library definition, click on it in the List of libraries. Its data will appear in the form.

rpa-libraries-editor.png

These are the fields you should fill in here:

  • Repository: Maven repository where the code of the nanorobot is located.
  • Username: Username to access the Maven repository where the code of the nanorobot is located.
  • Password: Password to access to the Maven repository where the code of the nanorobot is located.
  • Group: Identifier for the group of the Maven artifact of the nanorobot.
  • Robotic process: Identifier for the Maven artifact of the nanorobot.
  • Version: Version of the Maven artifact of the nanorobot.
  • Main class: the main class to execute, that is, the input class to the nanorobot.
  • Notes: Field to add notes about the library, such us a description, the application or version on which it works, restrictions, etc.

There two buttons to work with library definitions:

  • The Save button will save the changes made on a library, either if it is new or one in edition.
  • The New button will clear the form, ensuring you don't edit an existing library when we want to add a new one.

Repositories

This options is only available for Administrators.

The Repositories screen allows you to manage the Maven repositories that will be used by the robots to download the dependencies needed to execute.

Click on the Repositories icon 951046.png in the toolbar.

The recommendation here is to sort the repositories to show the specific ones in first place and then the generic ones:

  1. Specific repository for the instance
  2. Appian RPA repository (where applicable)
  3. Central Maven repository

This way you ensure that robots can download everything they need to execute. An incorrect setting of the repositories can result in executions with errors, or a robot unable to execute, since the resource is not installed properly.

List of repositories

This section shows a list with all the repositories defined within the console, and allows you to perform different actions on them.

The information displayed is as follows:

  • Order: determines the precedence order of the repositories. Dependencies are resolved in order. If the dependency is not found in the first repository subsequent repositories are tried top-down, the one with the lowest cardinality first. You can change the order using the arrow icons. The recommended order is to put specific repositories first and then the general ones.
  • URL: web address of the repository.
  • User: username for the authentication of the repository.
  • Password: password for the authentication of the repository.
  • Actions: you can delete repositories.

Repository editor

In this section, you can add new repositories within the console.

rpa-repo-editor.png

The information you should provide here is:

  • URL: web address of the repository
  • Username: username to authenticate in the repository
  • Password: password to authenticate in the repository

Removed robotic processes

In the console, you can view details about deleted robotic processes.

  1. From the Robotic Processes tab, click the View removed elements (2229133.png) icon.
  2. You'll see a list with the information of the robots that were removed.
  3. From this list, you can view the configuration of the removed robots, although you can not restore them, since history is read-only.
Open in Github

On This Page

FEEDBACK