Guided Setup with Configurator

This tool allows you to set up your computer as a development environment to build robotic processes. Download the Configurator from the Robotic Processes tab in the Appian RPA Console.

rpa-configurator-icon.png

If you don't have access to the Console or your Nexus repository, contact your Appian RPA administrator before starting with this guide.

When running the application, some checks will be done to verify that the computer has the necessary software and configuration to develop with Appian RPA. If any element is not present, the tool will guide you to configure it.

These are the checks performed during this process:

  • Setting the JAVA_HOME environment variable.
  • Installing Maven.
  • Setting up the settings.xml configuration file in Maven.
  • Java Development Kit: Your computer needs to have JDK installed. This step helps you install it or select the installed folder manually.

This page describes each step in setup using Configurator. During execution, click Next any time the result of the check is successful. In each section we will describe the actions to perform if the check is not met (red button). If the check is successful, a screen with the message will be displayed (green button).

Starting Configurator

Once the application jidoka-configurator.exe has been downloaded, we must run it.

Java installation

Java must be installed. If it isn't, you'll see a pop-up message to alert you. After pressing the Accept button, you will be redirected to the Oracle website to install Java. Depending on your operating system, you have to choose the right version to download and install.

2235006.png

In Windows, for instance, you must download an executable file and run it following its steps.

Once Java Development Kit (JDK) is installed, you can restart the Configurator.

Java Development Kit

To compile robotic processes, the computer where we're developing needs to have JDK 1.8 or higher installed. If Java SE was already installed, but JDK wasn't, the Configurator suggests two options:

  1. Download and install it: In this case you will be redirected to the Oracle website to proceed as in the previous step.
  2. Select folder manually: In case the user knows that there is a JDK already installed, they can manually select the installation folder.

configurator-jdk-missing.png

Once the JDK is installed, click Retry after installation to check again.

If a JDK is installed, the Configurator will display a message showing the installation folder.

config-1.png

JAVA_HOME Variable

In the development environment, it is important to make sure that the JAVA_HOME variable is set to the installation just configured.

If it is not defined, you must click on the Define and Continue button, so the Configurator defines the variable. If it is defined, you must press the Next button.

config-2.png

Maven

Maven is a software tool for compiling, packaging, and deploying Java artifacts. Appian RPA uses this open-source tool as a link between the robots' code and the execution platform due to its power and simplicity, for both deploying binaries and making them available to the agent on the execution resource.

If Maven is not installed, the Configurator suggests two options:

  1. Download Maven.

  2. Select folder manually: If you know that Maven is already installed on the computer, you can manually select the installation folder. In this case, the Maven version must be 3.0.0 or higher.

configurator-maven-missing.png

If you choose to download Maven, the installation will be done automatically. All you have to do is to select the installation folder. Once downloaded and installed in the selected folder, the process will end.

If Maven was already installed or we installed it as described in the previous step, we can continue.

Maven Settings

Once Maven is downloaded and we acknowledge it works properly, we have to do a little configuration to develop robotic processes. To do so, we must create or modify the settings.xml configuration file, which is basic to work with Maven.

Refer to Maven reference for more information on configuration settings.

In order the development environment to be successfully configured, the settings.xml file must be located in the user's folder as follows: ${user.home}/.m2/settings.xml. This is the user settings. A global settings file also exists, located in the installation folder ${maven.home}/conf/settings.xml, but it is not taken into account by the Configurator.

If the user settings file is not present, the Configurator will create it. If it already exists, the Configurator will make the required modifications. To do so, we must press the Fix and continue button.

configurator-maven-settings-missing.png

The first thing the Configurator does is check if the file exists, since it is possible it already exists in the environment of the developer.

During this step, the Configurator will ask for our Nexus repository URL (not the console URL).

config-5.png

If the URL we provide isn't accurate, the Configurator will ask you to confirm.

If the URL is correct, but the credentials aren't, the message will prompt you to double-check the credentials. To fill in the URL or the credentials again, we must press on the Check URL and credentials button.

While this step is being executed, we'll see that the Configurator is working by configuring Maven.

configurator-maven-checking.png

Click on the View log button to see progress.

When this step is finished and no problems come up, the settings.xml file is created including the required configuration. After clicking on OK in the confirmation window, all Java and Maven related configuration is done, so we can finish by pressing the Finish button in Configurator.

configurator-maven-settings-success.png

The settings.xml file must contain:

  • A Maven profile (element <profile>) pointing at our Nexus repository.
  • A <server> entry with our credentials to Nexus. Remember that, if you don't have these credentials, you must contact your Jidoka administrator.

Internally, the last thing done to ensure Maven is correctly configured is to download a robot archetype from the configured Nexus repository. This way, both the access and the credentials are validated, and we know we can deploy our robotic processes successfully. This process is done automatically.

If the archetype download fails, it means that some configuration step was wrong.

In such a case, contact the Apppian RPA support team, attaching the whole message displayed by the Configurator, as well as the settings.xml configuration file located in the .m2 directory of the user.

Open in Github

On This Page

FEEDBACK