Appian RPA Connected System
This content applies solely to Appian RPA, which must be purchased separately from the Appian base platform.

Appian RPA works with other features such as BPM and AI to deliver a full stack automation solution in Appian.

Incorporate a robotic process into your overall business process by calling a connected system from within an Appian process model. Execute a robotic process or retrieve its results using the Appian RPA connected system. Conversely, if your robotic process needs to incorporate people, you can kick off a process using the Start Process action.

This page covers how to integrate RPA into your application by connecting process models and robotic processes. See Build an End-to-End Robotic Process to learn how to use the connected system in your applications.

About the Appian RPA connected system

Appian RPA Connected System provides an integrated solution to support full-stack automation in Appian. Build robotic processes to automate repetitive tasks to free up your workforce and ensure data accuracy. Appian RPA tightly integrates with BPM, AI, and case management so you can use the right automation technology for a given use case. Once the connected system is authenticated via API key, robotic processes automatically appear in the available operations based on permissions.

This connected system is only available for customers who have purchased Appian RPA.

Field Description
API Key This is the key generated when you create the service account.


When you create the service account to generate an API key for Appian RPA, you must adjust the User Type from Basic to Administrator within Appian. If the user type is set to Basic, the robotic process will not display in your list of available processes for the integration.


Name Description Type
Execute a robotic process Integration to execute a robotic process in Appian RPA. WRITE
Retrieve execution results Integration to retrieve results from an executed robotic process in Appian RPA. READ

When you set up either operation, you'll choose a robotic process from the list. The options appear based on the service account's permissions within Appian RPA.

Execute robotic process

Executes a robotic process in Appian RPA on the specified resource.


In the integration designer, configure the following settings:

  • Operation: Execute Robotic Process.
  • Robotic Process: Select the robotic process to execute in Appian RPA.
  • Resource: Select the resource to execute the robotic process. Choose First available resource to use any resource with proper permissions when it becomes available. You can also use the expression editor to configure this setting.
  • Description: Add an optional description for this robotic process execution. You can also use the expression editor to configure this setting.
  • Priority: Assign this execution a relative priority. Options include Highest, Higher, High, Normal, Low, Lower, and Lowest. If there are queued executions, Appian RPA uses priority to determine which robotic process to execute ahead of others. You can also use the expression editor to configure this setting.

Retrieve execution results

Retrieves results of a robotic process execution in Appian RPA through the execution ID.


In the integration designer, configure the following settings:

  • Operation: Retrieve Execution Results.
  • Execution ID: Enter the execution ID to retrieve all results and details for that specific execution. You can enter the value here or use the expression editor.


When retrieving the results, robotic process variables are automatically cast based on the data type you select during setup. The data will be passed back as a map called variables within the result dictionary. The data is structured as follows:

  • success true (Boolean)
  • result Dictionary
    • variables Dictionary
    • status "SUCCESS" (Text)
  • error null (Null)
Open in Github Built: Fri, Nov 04, 2022 (07:10:52 PM)

On This Page