rpa.yml options

The rpa.yml is the configuration file, which you mandatorily must fill in before the product installation. It contains Windows users' credentials on your RPA servers. After you create the desired Windows users manually on all existing RPA servers, add their credentials to the rpa.yml file. During the product installation the provided credentials are pushed into Secrets Vault.

• It is mandatory to have the same sequence of rpa servers provided in hosts.yml and in rpa.yml.
• Be careful when completing rpa.yml. Don't modify the indentation before lines. Use the existing file structure, and replace the existing default values with the desired ones, without changing anything else.

For example, if you have one RPA server, delete all lines starting from rpa2.example.com, and adjust the remaining block with respective RPA hostname and user credentials. If you have three or more RPA servers, append (copy/paste) existing block(s) and adjust them respectively.

File structure

Example of rpa.yml

rpa_ad_domain: ''
rpa_machines:
  rpa1.example.com:
    -
      unit: 'master'
      username: 'USERNAME'
      password: 'PASSWORD'
    -
      unit: 'unit_1'
      username: 'USERNAME'
      password: 'PASSWORD'
    -
      unit: 'unit_2'
      username: 'USERNAME'
      password: 'PASSWORD'
  rpa2.example.com:
    -
      unit: 'master'
      username: 'USERNAME'
      password: 'PASSWORD'
    -
      unit: 'unit_1'
      username: 'USERNAME'
      password: 'PASSWORD'
    -
      unit: 'unit_2'
      username: 'USERNAME'
      password: 'PASSWORD'

The file contains the following parameters that you must specify:

• rpa_ad_domain:: If Active Directory Domain users are used for 'units', you also need to specify your Active Directory domain name for "rpa_ad_domain" setting. Example: rpa_ad_domain: 'EXAMPLE.COM'.

• rpa[X].example.com: the RPA host. The same host must also be specified in hosts.yml. If you have several hosts, add them all to the rpa.yml and hosts.yml files. The sequense does matter. Each host must include at least one of the following user's configuration block.

• unit: type of the user. Possible values:

  • 'master': Bot Master user.
  • 'unit_[X]': Bot Unit user.

If you use Windows Server 2016 as the OS on your RPA server (the Enterprise RPA Server installation), on the host, specify one unit: 'master' and all the Bot Unit users (unit: 'unit_1', unit: 'unit_2', and so on). Each host can have a different number of users.

• 'vdi': a VDI user, specify only one unit:'vdi' on this host.

• username: name of the unit user.

  Note that in case of Active Directory, specify the users in the format "DOMAIN\username" or "LOCALHOST\username", if the users belong to different types. For example, BotMaster is domain account, while BotUnits are local.

• password: password of the unit user.

note

In the unit parameter, remember to separate the name of a unit and its index number with the underscore symbol "_", for example, unit: 'unit_1'. See the example earlier.

Preparing the file

You must complete the file before the installation. Alternatively, if you agree with the following conditions, you can generate the file with the ./install.sh rpa_yml generate command (see further).

• Usernames for all Bot Master users on all RPA hosts are the same.
• Passwords for all Bot Master users on all RPA hosts are the same. You can also create the passwords manually after you generate the file.
• All RPA hosts have the same number of Bot Units.
• All Bot Units have the same basename and different and sequential index numbers at the end of the basename. For example, BotUnit1, BotUnit2,.. BotUnitN.
• Passwords for all Bot Units on all RPA hosts are the same. You can also create the passwords manually after you generate the file.

Enterprise RPA Server installation

To generate the rpa.yml file for the Enterprise RPA Server installation, on the Master server, run the following commands.

note

Note that in this case the RPA host values (rpa1.example.com of the example earlier) are taken from hosts.yml.

$ cd /opt/workfusion/wf_installer
$ ./install.sh rpa_yml generate -e bot_master_user_name=<username> -e bot_master_user_pass=<password> -e bot_unit_base_name=<username> -e bot_unit_pass=<password> -e rpa_bots_per_server=<number-of-bots-per-each-server>

If you want to have different passwords for all RPA users, perform the following steps.

1. Run the following command:

   $ ./install.sh rpa_yml generate -e bot_master_user_name=<username> -e bot_unit_base_name=<username> -e rpa_bots_per_server=5

   Mind that the rpa.yml file is generated with blank password parameters.

2. Open rpa.yml, and enter the passwords manually.

VDI RPA Server installation

To generate the rpa.yml file for the VDI RPA Server installation, on the Master server, run the following commands.

note

Note that in this case the RPA host values (rpa1.example.com of the example earlier) are taken from hosts.yml.

$ cd /opt/workfusion/wf_installer
$ ./install.sh rpa_yml generate -e bot_master_user_name=<username> -e bot_master_user_pass=<password> -e rpa_bots_per_server=0

If you want to have different passwords for all RPA users, perform the following steps.

1. Run the following command:

   $ ./install.sh rpa_yml generate -e bot_master_user_name=<username> -e rpa_bots_per_server=0

   The rpa.yml file is generated with blank password parameters.

2. Open rpa.yml, and enter the passwords manually.

caution

If you have both VDI RPA Server and Enterprise RPA Server installed on different hosts, fill in rpa.yml manually.