Robot File System

This section is available for users with the following roles: Administrator, Viewer, Project Administrator, and RoboServer.

The Robot File System section lists file systems configured to share and store data used and/or produced by robots. You can add a configuration for a file system by providing the required credentials and defining a list of robots and users to access this file system.

The file system can be a local Windows folder, Windows file share, SFTP, and FTP server. For FTP, FTPS is supported. The maximum size of the file that can be uploaded to or downloaded from the Robot File System is limited by available memory.

For information on how to configure a server for the Robot File System, see "Set up Robot File System server" in the Kofax RPA Administrator's Guide. The guide also contains an example of general configuration and usage steps.

At the top of the Robot File System section, in the Projects drop-down list, you can select the project with file systems to display. You can change the way the information for each configure file system is presented as follows:

• Filter the list of file systems in the table by applying filters in the Filter text field. See Filtering for more information.
• Select the table columns to display for a file system using the menu icon on the right.
• Refresh the displayed information by clicking the refresh icon on the right.
• Reset the custom column settings by clicking the reset icon on the right.
• Select the number of items to display per page and navigate among pages by using the navigation menu in the bottom right corner.

By default, the following information is displayed for each configured file system.

Configure new Robot File System

1. To add a new file system, click the plus sign in the upper left corner.

   Several new tabs open.

2. On the General information tab, specify the following information:

   • Projects: Specify a project to contain the file system.

   • Project scope: Select this option to make the file system accessible to all robots of the project. Alternatively, you can make the file system accessible only to particular robots as shown in Step 3.

   • File system name: Type the name for the new file system configuration.

     Example: RFS1

   • Path: Specify the path to the file system.

     File system	Description	Path example
     Windows		Folder\Subfolder1\Subfolder2
     Windows file share	The file share is mapped to the Robot File System as specified in the Name field. Subfolders cannot be used.	\\WindowsServer\FileShareFolder
     FTP or FTPS server	The path must start with ftp:// or ftps://.	ftp://website.com:9551/guest
     	The FTP client tries to detect if the FTP server supports UTF-8 encoding. To override this auto detection, add utf8:option, where option is: on to force UTF-8 support off to disable UTF-8 support auto to perform auto detection	ftp://website.com:9551/guest,utf8:on
     SFTP server	The path must start with sftp://.	sftp://ssh.domain.com:9551/guest
     	There are two ways to use SSH key authentication: Use default SSH keys configured on the Robot File System server by adding publickey to the Path field. Use a private SSH key to authenticate by adding publickey:<path-to-the-private-key> to the Path field. DSA, Ed25519 and ECDSA keys are supported. RSA keys are deprecated and should be replaced. If SSH key authentication is configured, the Password is ignored.	sftp://ssh.domain.com:9951/guest,publickey:c:\keys\ssh-domain-com_ed25519.key

   • User name and Password: Type the credentials to access the file system.

     For Windows, the user name must conform to: username@domain

     The credentials are only used by a secure service to allow robots to read and/or write to the file system.

   • Save the changes.

3. To make the file system accessible to particular robots within the project, you can map them by names or add access tokens for those robots. This method works as long as the robot name remains unchanged. Click to open the context menu for the file system you are working on and click Edit.

   • Use the robot name to ensure that all versions of the robot (current and future) have access to the file system.

     On the Robot mapping tab, select which robots have access to the file system. The robots must be synchronized with the Management Console to appear on this tab.

     Save the changes.

   • Use the robot access token to ensure that only the current version of the robot has access to the file system and that no changes made to the robot are written into the file system. As the token corresponds to the particular version of a robot, if the robot changes, it will no longer be allowed to the file system.

     1. In the Management Console navigation menu, in the Robots section, click to open the context menu for the required robot and select Get resource access token.

        A new dialog box appears.

     2. Copy the token and close the dialog box.

     3. Return to the Robot File System section, click to edit the file system, and on the Authorized access tokens tab, add the copied access token.

4. Save the changes.

To delete a file system, select it in the table and click the bin icon in the upper left corner. You are prompted to confirm the deletion.