Skip to main content
Kofax

Kofax RPA Quick Start Guide - Robot File System

3011188

Summary: 

This article contains the general steps to configure Robot File System (RFS).

More Information: 

Robot File System has been introduced in v10.6 of Kofax RPA and provides shared storage for RoboServers, Design Studio instances and Desktop Automation agents. 

1. Installation

To setup an RFS server on Tomcat, please refer to the Administrators Guide. 

1.1. Prerequisite

Please make sure the Windows service WebClient is enabled on the machine(s) where the Desktop Automation Service is running.

 

2. Configuration


2.1. Configuration in Tomcat

Configure the web.xml file located in webaps\rfs\WEB-INF folder in the Tomcat installation folder. Below parameters need to be configured: 

mc-path, mc-username, mc-password, data-path. You can set allow-absolute-paths to either true or false. Restart the tomcat server after editing this file. 

clipboard_eb81b32ad551938a16db598b30a96dda3.png
 

2.2. Configuration in Management Console

Open the Management Console and go to Admin > Settings > Robot File System Server. Select Use RFS Server and specify the URL of the Tomcat server where you set up the RFS server, for example, http://myserver.my.domain:8080/rfs. Leave the User and Password fields as they are. 

clipboard_e0bbe5ea02504d1abb95c41009ec0eb29.png

In Management Console, under Repository > Robot File System, configure the robot file system shares. There are two different types of shares:

  • Volatile share : this is a share called "robot" that is created for the duration of the robot run. This folder is deleted when the robot completes is execution or is closed in Design Studio. There is no extra configuration needed for this share to be created/deleted.
  • Permanenent shares: these are shares that point to existing folders/other shares and they don't depend on the robot run. Therefore they can be used by multiple robots (e.g. robot #1 downloads files and saves them in the share, robot #2 uses these files). These shares have to be configured in Management Console; depending on the configuration used you can have:

1. Permanent share relative to the data-path configured in Tomcat (see section 2.1 above):

In this case, a folder will be created in the data-path folder and its name will be as specified in the "Path" field in the RFS configuration in Management Console:

clipboard_ef9113a6fd46068a2ee7b5a1c720eaf50.png

 

clipboard_ea0d607fc2e9615f0530ed9b216145c83.png

2. Permanent share that uses an absolute path:

This option can only be used if allow-absolute-paths parameter is set to true in Tomcat's web.xml file (see section 2.1 above)

clipboard_e2749eee77ec9da5715a0f99d7041aa9f.png

clipboard_e2cc42bbecd8930abd56bae439fd5d3d6.png

The content of the share is the same as the folder specified in the RFS configuration, "Path" field.

2.3 Configure Access

1.Give access to RFS for Design Studio.

Copy the access token from Design Studio > Help and enter in the Authorizes Access Token tab in Robot File Sytem configuration in Management Console:

clipboard_e2eaa3f6001557d6eb4c04ccb7d4ab493.png

clipboard_e30734f7e76db7a95a8f2b24c2f390275.png

2. Give access to robots uploaded in Management Console

Copy the access token from Repository > Robots > Right-click > Get Resources Access token. Paste the access token in RFS configuration window Authorized access token. 

clipboard_e362915d97d26077e9eea774fd9628834.png

 

You can also give access to the share to all Robots from a project by selecting 'Project Scope'

clipboard_ec1061b8cbc4977ef3f805570647e080f.png

2.4 Optional Configuration in Desktop Automation (DAS)

By default when RFS is used a new mapped drive is created on the DAS machine and the letter used is S:

This can be configured on the DAS Configuration tool > Windows tab:

clipboard_e3cb191286c7808f94a2fc1df98893ba6.png

3. How to use RFS in Design Studio

Create a Robot with Desktop Automation (DA) step and configure your Desktop Automation mapping. In the DA workflow, there are Read and Write action steps that allow file access via RFS (to read the complete description of these steps, please consult the User Guide).

clipboard_e867b3a950741550151e24dc497bcb049.png

Content must be passed between Robot and Workflows as binary parameters.

clipboard_e0a50c19e93274dfe5dbe0bd2eca6b3f0.png

When the robot is running, a new Drive letter S:\ mounted for Volatile share on the DAS machine. This drive will be deleted when the robot has stopped running. 

clipboard_e6ab42820bb30222e56798a92e7faea57.png

Applies to:  

Product Version Category
Kofax RPA 10.6 and later Robot File System

 

Author: Shivani Gupta  

  • Was this article helpful?