Configure the Advanced Configuration Tab
This content applies solely to Appian RPA, which must be purchased separately from the Appian base platform.

Overview

Required role: Developer or Administrator

In the Advanced Configuration tab of the robotic task configuration page, you can configure the following settings:

Execution settings

In this section, you can choose how this robotic task behaves when executions are launched consecutively from an Appian process model. Options include:

  • Run setup and clean up for each execution: Each consecutive robotic task execution includes the actions specified in the setup and clean up sections.
  • Skip setup and clean up for consecutive executions: Setup actions only occur at the start of the first execution, and clean up actions only occur at the end of the final execution.

If the robotic task doesn't require a robot to be reset before the next execution occurs, you can choose Skip setup and clean up for consecutive executions. This option speeds up each execution, and the compounded time savings can make the overall set of consecutive executions much faster.

Learn more about the Setup and Clean Up sections.

In some scenarios, setup and cleanup sections are still run even if you choose to skip them for consecutive executions. These sections run when the:

  • Next execution is for a different robotic task
  • Execution runs into an unexpected exception
  • Definition of the robotic task changes
  • Robot does not have any further pending executions to pick up

Certain components of the robotic task configuration may behave differently when setup and clean up are skipped:

  • Variables: When setup and clean up are skipped, any robotic task variable that isn't a parameter is reset to the value it had at the end of the last setup. Any robotic task variable that is a parameter will be set to the value defined as part of the execution request. When you choose to skip setup and clean up, avoid updating any variables used in the setup section.
  • Credentials: If you use credentials in a setup section, the credentials are reserved and won't be released until the clean up section successfully completes. This means that if the robotic task executes consecutively and the configuration is set to Skip setup and cleanup, then the credentials won't be released until the final execution's clean up section completes. Credentials used in the main section are released at the end of that specific execution.

If you choose to skip setup and clean up for consecutive executions, be sure to design the robotic task workflow in the main section so it executes reliably in this manner. For example, if the robotic task is meant to submit a form multiple times with different data, be sure to add an action toward the end of the workflow for the robotic task to navigate back to the starting form. This way, each consecutive execution occurs smoothly and predictably.

Environment variables

rpa-env-variables.png

You can define environment variables, which are sent to the robot as "key-value" pairs. The difference is that they are sent in all the executions but they are not requested in each execution. To modify them, it is necessary to modify robot settings. This facilitates having different configurations in different robot environments (for example, development and production).

To add an environment variable:

  1. Go to the Advanced Configuration tab of the robotic task configuration page.
  2. Find the Environment variables area.
  3. Click Add variable. A new row displays.
  4. Configure the following fields:

    Field Description
    Name The name that serves as the key in the key-value pair.
    Value The value for the environment variable.
  5. Click SAVE CHANGES in the toolbar.

To edit an environment variable:

  1. Go to the Advanced Configuration tab of the robotic task configuration page.
  2. Find the variable you want to change in the Environment variables area.
  3. Edit the Name and Value parameters.
  4. Click SAVE CHANGES in the toolbar.

To delete an environment variable:

  1. Click the Advanced Configuration tab.
  2. Find the variable you want to delete in the Environment variables area.
  3. Click the Delete variable icon 950863.png in the variable row.
  4. Click SAVE CHANGES in the toolbar.

Sub-results description

rpa-sub-results.png

Sub-results are used to categorize the items results, making it possible to differentiate items already classified as OK or WARNING. The colors and statuses appear in the results column on the list of executions.

This items categorization is shown in the following table:

Icon Color name
2236517.png CHOCOLATE
2236514.png CORAL
2236529.png CYAN
2236511.png DARK_GRAY
2236523.png INDIGO
2236528.png LIGHT_GRAY
2236533.png LIME
2236526.png MAGENTA
2236521.png OLIVE
2236531.png RED

For example, for a specific WARNING, you could assign a sub-result color to indicate different causes such as technical problems (sub-result CORAL) or data problems (sub-result CYAN).

Support files

Support files help you avoid having to add files in a robot's code, so the code is leaner and deploys much faster. Working this way also allows you to change the files' content (neither adding nor removing them) without affecting the robot's deployment.

In the Support files area of the configuration, you can upload support files to be either used by this robotic task only or shared globally among your robotic tasks.

If you upload a ZIP containing an internal folder structure of support files and enable the Unzip on server option, Appian automatically creates the corresponding folder structure on the server. If you don't immediately see the unzipped contents of the file, but instead see the name of the ZIP file in the Root tree, refresh your browser.

To support methods in the Browser low-code module, the browser driver files must be stored in a specifically named folder in the Root tree. You must manually add this folder, and then unzip the driver files into that folder. For more information, see Using the Browser Module.

browser-module-support-files.png

Task-specific support files

To manage support files to be used by this robotic task only, use the following icons within the Support files area of the workflow:

Icon Description
rpa-preview-icon.png Preview the image support files.
rpa-upload-icon.png Upload a new file to the server.
2232696.png Download the file or folder from the server. When downloading a folder, Appian RPA creates a ZIP file for the folder and its contents.
rpa-rename-icon.png Rename a file/folder on the server.
2232700.png Create a new folder on the server.
2232735.png Delete a file or folder on the server.

In addition, by dragging and dropping any folder or file, you can move the folder or file across different locations in the folder structure on the server.

When you upload a ZIP file, you can specify if you want it to unzip on the server, thus creating the corresponding folder structure it contains upon upload completion.

Global support files

If you want to share files between different robots, you can access the global support files. To do so, click on the Support files icon 2232759.png located in the Support files toolbar.

Essentially, this window is the same as the one displayed on the namesake area in robot setup, and hence their behavior is very similar regarding the uploading, downloading, moving, and renaming operations for files and folders.

From a visual point of view, the difference lies in how you define which robots can access which files.

For administrators, this structure contains support files for all robotic tasks in your Appian RPA environment. For developers, this structure contains support files for robotic tasks for which you have permissions. Files and folders display in alphabetic order. The folders are sorted first and then the files.

rpa-global-support-files.png

As you can see, there is a folder with files. To give a robot access to the global support files, it should have a permission with the same name as the folder it is trying to access. This folder will contain the folder structure and files the robot can use.

The table below shows the robots, their permissions, and the folders and files they can access, according to the previous picture:

Permission Folder Access Robot
app07 shared-folder-1 shared-folder-1 nodes.png
app08 shared-folder-1 shared-folder-1 nodes.png
  shared-folder-2 shared-folder-2 shared-subfolder-2.1 (D) robot-file-2-1.png robot-file-2.png robot-file-1.png
app12 shared-subfolder-2-1 shared-subfolder-2.1 robot-file-2.1.png robot-file-2.png

Robots app07 and app12 can access the content of only one folder of the global support files since each of them has the proper permission. Remember that you cannot use the period character . in a permission tag, but you can use the hyphen character -. So to access the folder shared-subfolder-2.1 you should specify the permission shared-subfolder-2-1.

Robot app08, on the other hand, can access both folders. One of them contains only one file, whereas the other one contains one file (robot-file-1.png) and one folder (shared-subfolder-2.1). The latter contains, in turn, two files.

Access support files in code

The following shows an example of how we could obtain the path to access a file uploaded in this section.

1
2
3
4
5
Path path = Paths.get(
    server.getCurrentDir(),
    "folder",
    FILE_NAME).
        toRealPath(LinkOption.NOFOLLOW_LINKS);

In the previous code snippet, we assume that we have a folder called "folder", and a file whose name is defined in the constant FILE_NAME.

Technical information

This section is relevant to custom code development only. If you're using low-code modules, you can ignore this section.

At the end of the page, you can see the definition of the repository where the project has been automatically deployed. To make this link work properly, it is necessary to have previously deployed the robot binaries in the defined Maven repository. This is done using the following instruction:

mvn clean deploy

rpa-technical-info.png

In this section, you can find the technical information contained in the robot setup:

  • Technology: Technology in which the robot has been built: Java, AutoHotkey or Autoit. If you choose the latter, the form will only have fields for Executable and Version.
  • Repository: Maven repository where the robotic task code is located.
  • Group: Identifier for the group of the robot's Maven artifact.
  • Robotic task: Identifier for the Maven artifact.
  • Version: Version of the robot's Maven artifact.
  • URL: Complete URL to the robot's Maven artifact, only necessary if previous fields are not specified.
  • Main class: The main class to be executed, that is, the input class for the robot.

It is possible to select the robot's main class if the Maven artifact's information has been setup properly. To do so, click on the Select main class icon 2232766.png and select the main class from the list of all classes available in the Maven artifact.

In case some of the fields of the Maven coordinates associated with the artifact are not correct, an error message will show up as a warning. If no classes are shown, check that the artifacts successfully deployed to Maven, as well as the Maven configuration is correct.

Use the Check dependencies rpa-dependency-icon.png button to validate that the configuration of the robot is correct in terms of dependencies and the versions of these dependencies. A window appears that shows the artifacts that have a different version in the robot and in the agent.

rpa-dependency.png

Open in Github Built: Wed, Aug 16, 2023 (04:37:39 PM)

On This Page

FEEDBACK