Robotic Processes

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


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.


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.


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


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.


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.


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.


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.


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 ).


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.


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.


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, 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.


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.


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.



In the toolbar, click the Credentials icon 2229111.png to manage credentials. Credentials are a secure way to store usernames and passwords that robotic processes might need to log in to external systems. You can use credentials to store, reference, and update this information securely in the Appian RPA console.

Like many Appian RPA objects, credentials are controlled through permissions. A robotic process or workflow library will only have access to credentials with at least one permission in common.

The List of credentials displays the credentials defined in the console, and allows you to perform different actions on them.


It includes the following information:

  • Application: The name of the application associated with the credentials.
  • Username: Username value stored with the credential.
  • Password: Password value stored with the credential (this will always appear as [PROTECTED] to ensure security).
  • Active: Shows whether a credential is active.
  • Use: How many times a specific credential is being used out of the maximum. Click the Update maximum use icon to add a limit to how often the credential can be used. A credential's use has no maximum limit unless you add one.
  • Actions: Delete a credential or modify its permissions.
  • Permissions: Permissions associated with the credential.

Click the Update password icon next to [PROTECTED] to update the password for a credential entry.

Credentials editor

In the Credentials editor, you can create new credentials.


Enter the Application, Username, Password, and Permissions for the credential. For more details on each of these components, see the list above.

Using credentials in a robotic process

If the credential has a maximum usage limit, the credential will be automatically reserved when it is first called during a robotic process execution. The credential will be released at the end of the robotic process. If using credentials from one of the Java methods, you will need to manage credential reservation and release explicitly.

Learn how to use credentials in a low-code robotic process.

Workflow libraries

A workflow library or nano-robot is a small piece of code that provides generic functionality. Libraries are useful because they provide actions that can be reused in a robotic process's workflow or source code to perform certain operations. For example, a library could establish a VPN or proxy connection.

Learn more about how libraries are used in Appian RPA.

On the Workflow libraries page, you can manage the libraries available for the robotic processes in the Console. Click the Workflow libraries icon 2236298.png in the toolbar.

Workflow libraries are protected by permissions. This means a robotic process can only use workflow libraries with common permissions.

List of workflow libraries

Here you'll see a list of the workflow libraries defined within the console, along with actions you can perform. Appian RPA comes with a local Maven repository where you'll deploy code, including libraries. You can add a workflow library in Appian RPA using the Workflow library editor.


The list contains multiple columns:

  • Repository: Maven repository where workflow libraries are located. If empty, the workflow library will be searched in the repository list defined for the console.
  • Group: Identifier for the group of the Maven artifact associated with the workflow library.
  • Artifact: Identifier of the Maven artifact associated with the workflow library.
  • Version: Version of the Maven artifact associated with the workflow library.
  • Main class: The main class to execute, or the input class to the workflow library.
  • Actions: Delete or update the workflow libraries (refreshing the Maven artifact from the repository).

Together, the Group, Artifact, and Version create the Maven coordinate for the library.

Workflow library editor

Using the Workflow library editor, you can add additional workflow libraries within the console or edit existing ones. When you deploy a new library, you'll need to add it to the List of workflow libraries. This is a necessary step before you can associate libraries with actions in the robotic process workflow.

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

To add a new workflow library, click New to clear the form. This ensures you don't edit an existing workflow library. Fill the fields with the new workflow library information.


Fill out the same fields as listed above, as well as any Notes about the workflow library. For example, you may want to include a description, the application or version on which it works, restrictions, etc.

Click Save to save your changes.


This option 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.


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 (2229125.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.

This version of the Appian RPA documentation was written for Appian 20.4, and does not represent the interfaces or functionality of other Appian versions.
Open in Github Built: Fri, Nov 19, 2021 (11:59:11 AM)

On This Page