| This content applies solely to Appian RPA, which must be purchased separately from the Appian base platform.
After you plan and build your robots and robotic tasks, you're ready to use them in your business processes. You can integrate them with a new or existing process model in Appian. This way, you can choose how and when the robotic task starts in the context of a broader business process.
Although there are multiple ways to execute a robotic task, this page focuses on how to use the Execute Robotic Process smart service in a process model.
To use a robotic task in your application, complete the following steps.
- Create a service account.
- Create the Appian RPA connected system.
- Configure the integration.
- Create or update a process model.
- View the results.
Create a service account
Before you get started, you'll need to create a service account and generate an API key.
- Go to the Appian Admin Console.
- In the Authentication menu, select API Keys.
- Click Create.
- Enter a description for the API key.
- Select the service account to associate with the API key. Click Create Service Account to create a new one and associate it here.
- Click Create.
- Copy the API key. You'll use this when you create the Appian RPA connected system.
Create the Appian RPA connected system
Next, create the connected system to establish a connection with Appian RPA.
- Go to the Appian Designer.
- Open your application.
- Click NEW > Connected System.
- Select Appian RPA as your template.
- Give the connected system a name and description.
- Enter the API key associated with the service account.
- Click Use in New Integration.
- In the Create Integration dialog, choose Execute Robotic Task in the Operation field.
- Enter a name and description for the integration.
- Click Create.
Configure the integration
The Execute Robotic Task integration can be called from the smart service in the process model. Configure the integration after you create the connected system object:
- In the integration designer, configure these execution details:
- Robotic task: Select the robotic task to execute. This list contains robotic tasks you have permission to see in Appian RPA.
- Robot: Select the robot where the robotic task should execute. Choose First available robot if you don't need to use a specific one.
- Description: Enter an optional description to be sent to the execution log in the Appian RPA console.
- If your robotic task expects parameters to execute, create rule inputs and map them to the parameters in the robotic task configuration.
- To test your integration, click Test Request.
- Observe the results to verify if the connection was successful.
- When you've finished, click Save Changes.
Create or update a process model
Now that you've set up the connection, it's time to put it to use:
- Create a process model object or find and open an existing process model.
- In the Process Modeler, drag the Execute Robotic Process smart service to the Process Model canvas.
- Open the smart service to configure it.
- Click the Setup tab and choose the integration you set up earlier.
- Click the Data tab to configure the input and output:
- If the integration uses rule inputs, configure the smart service inputs to pass the appropriate value for each rule input.
- The smart service lists
variables as an output. If a robotic task variable is a CDT, you can reference a specific field using dot notation.
- Click OK to save the smart service configuration.
- Continue designing or updating the process model. If you're using the robotic task results in other nodes, be sure to update those properties appropriately.
- To save the robotic task results in your Appian datastore, add and configure a write to data store node.
- Publish the process model.
View the results
Finally, you'll want to consider how to display or use the results of the robotic task. How you display the results is determined by your goal. If you're sharing a set of this information with others, an Appian record in your application could be a good option. Alternatively, if you're looking to troubleshoot or optimize your robotic task (notably in the development phases), you might want to take a look at the Execution Details in the Appian RPA console.
This section describes both approaches. Learn how to create a record type and populate it with details from a CDT, and how to create a record-powered grid.
Create a record
Appian records aggregate and display your data to provide users with information they need, whether to act or be informed. When a robotic task execution concludes and sends information back to Appian, it's time to use it in your application.
See Create a Record Type to learn how to display robotic task results alongside your other Appian data.
View the execution details
Sometimes it's more helpful to view all information about a robotic task, including metadata about the execution. All of these details are available in the Appian RPA console.
To view execution details:
- Go to the Robotic tasks tab in the Appian RPA console.
- Click the robotic task you're interested in.
- On the List of executions, click an execution to view its details.
- Three tabs appear:
- Workflow: This tab shows you the actions the robotic task went through. The robotic task definition appears just as it does in the robotic task configuration. See the Robotic Task Definition for more information about how to set this up.
- Results: If your robotic task acts on items, the results tab displays information about each execution cycle, as well as a summary of the robotic task overall. This tab uses color-coding to show items by their status.
- Execution log: This tab shows the most technical information for the robotic task. Each time the robotic task starts or completes an action, or encounters an issue, it sends a message to this log with a timestamp. The execution log is valuable for troubleshooting and debugging. You can configure your robotic task to send custom messages to the log as well.