Setting up the RAP Agent

RAP Agent

The RAP Agent is the key driver for your automation tasks. This acts as your worker, continuously monitoring the RAP execution queue for jobs that it can action. Once a job is picked up it will report that it is busy until that execution has completed and its results reported back to the RAP.

Setup

The RAP Agent is a small Java application. Its pre-requisites are simply Java and a network connection to the RAP Server.

The Java files can be extracted, from the supplied zip archive, and saved at your preferred chosen location.


For Windows, if you prefer to have the Agent launch automatically on system startup please follow these steps:

  1. Create a shortcut to the agent-systray.bat (right click the file and select create shortcut)
  2. Move the generated "agent-systray.bat - Shortcut" into the "C:\Users\[user]\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup" dirctory

Launch

The agent can be launched manually or it can be setup to launch on system boot up (as above).

To lunch the Agent manually simply run the “agent.bat” or the "agent-systray.bat" from the file browser or CLI. These can also be initiated via a system schedule/task.


Once running, the Agent will save its application logs to the following directory:

C:\Users\<username>\AppData\Local\Temp\rapagentlogs

It will also store the executed payload to the users temp directory:

C:\Users\<username>\AppData\Local\Temp\<jobname>

Finally, the Agent configuration settings are stored in the users home directory:

C:\Users\<username>\rapagent.cfg

The RAP Agent should have access to a T-Plan Robot installation as it is this which actually performs the automated actions.

Configuration

RAP Parameters

The RAP Agent must be firstly configured to connect to your RAP instance. This is achieved within the “RAP Params” tab.

RAP Address: This represents the RAP API address on which the Agent can communicate. For Docker setups this may typically be represented as https://<IP/Host Name>:5000.

Proxy: If you are running the Agent behind a proxy then you can add the relevant server credentials here to allow the Agent communications to pass.

User: This is a valid username to access the RAP application.

Password: A valid password for the above user account.

Agent Name: This is the reference by which you want this Agent to be recognized as within the RAP application. This reference can be altered at any time, using the save icon to apply the updates immediately. Changing the reference name will have no detrimental side-affects to existing data held within the RAP.

Poll Time: The frequency of which the Agent should check the RAP queue for jobs to execute. This defaults to 10 seconds.

Observe Mode (don’t execute): This option facilitates debugging by always returning a success result for any Jobs without actually executing them.

Minimize agent on execute: For the period that a Job is executing the Agent can be minimized by checking this option.

Start/Stop: Simply start or stop the Agent communications with the RAP.

Queued Items: This tab indicates the queue of Jobs for this particular Agent.

Executed Items: Provides details of all Jobs executed by this Agent, along with details of the Result and timestamp.

RAP Configuration: Here you can see some basic RAP settings in a read-only view.

Logs: The Logs button gives quick access to the Agent application logs. Should any Agent application errors or issues arise they will be logged here.


Robot Parameters

The RAP Agent also needs to be configured to run an appropriate Robot instance in order to perform the automated tasks.

Robot Home: File path to your Robot install directory.

CLI Arguments: Here you can list any specific runtime arguments. Note: options entered here will be applied to all Robot sessions launch from this Agent.

Run Robot in the CLI mode (recommended): With this option selected the Robot UI will not appear when Workitems are being executed, instead Workitems will run in "CLI mode".

Local Workitems: This section allows to work with Workitems that originate and exist on the local system.

Search: Automatically search the local file system for Workitems within Robot projects.

Browse: Browse the local file system for Workitems within Robot projects.

Open: Open the directory of the selected Workitem within the system file viewer.

Open in Robot: Open the selected Workitem within the Robot UI.

Upload: Upload the selected Workitem(s) to the connected RAP portal.

RAP Workitems: This section reports the available Workitems from the connected RAP portal.

Refresh: Pull down the current list of Workitems from the RAP portal.

Download: Download a Project for the select Workitem to your local drive.