Upgrade from 10.1.4 to 10.2.1

The guide describes the upgrade to the 10.2.1 version of WorkFusion Intelligent Automation Cloud Enterprise. Note that this operation uses the installer, so the procedure is similar to the installation.

note

Only the upgrade option for the six-server topology is currently valid.

Before you start

The 10.2.1 non-HA topology requires only five servers:

MASTER
AGENT
RPA
BI
DB

Note the following changes in server roles:

The separate INT, APP, and BEP Master servers no longer exist. Instead, WorkFusion introduced a single MASTER server. It contains all services, which were previously running on these three servers. In the case of the single-point installation, MASTER becomes the server to run the setup on.
BEP Agent servers renamed to the AGENT servers.

The upgrade starts with preparing the environment to bring the topology to the appropriate state.

Before the upgrade, ensure that:

You created the additional DNS record for Keycloak (See DNS names).
No Business Process or Manual Task is running.
You prepared fleets for migration.
You backed up the following components:
- Directories /opt/workfusion/workfusion and /opt/workfusion/workspace.
- Vault properties for all components.
- Zookeeper settings that were changed since the last installation.
- Any system files that were changed since the previous installation.
You enabled SSH access to all Linux hosts.
You verified that the SSO or LDAP authentication you enabled on the existing environment is working.

Back up previous installation

In v.10.1.4.x, you can back up existing INSTALL_DIR and restore WorkFusion IA Cloud Enterprise to the previous version after the upgrade. Note that the backup files occupy the same amount of disk space as INSTALL_DIR. Before performing the procedure, make sure that there is enough space on the filesystem.

For rolling back to the previous state, back up the following components:

MSSQL database. You can do it according to your standard backup process.
Directory INSTALL_DIR. You can do it during the upgrade.
Shared directories. If you use any existing NAS, back up the following shared directories as per your standard process:
- /shared and /vds-data (for the HA mode)
- /vds-data (for the non-HA mode)

Save fleet names for Bot Units

To save currently used fleet names for Bot Units, do the following:

Log in to Control Tower, and click Bot Manager.
In the Bot Manager UI window, click on your RPA server to expand the fleets.
Copy the value into the fleet column → Actions → Edit Fleet.
In the Edit Fleet window, click Create new, and paste the values copied earlier.
Repeat steps 3-4 for all fleets.

Check running business processes

Before the upgrade, check that no business processes are running:

Go to INSTALL_DIR, which contains the installer directory created during the installation of 10.1.4, for example: /opt/workfusion:
```
$ cd INSTALL_DIR
```

Check the output of following command:

./zookeeper/bin/zkCli.sh ls /control-tower/execution/active-instances | egrep -qo '^\[[0-9a-f-]+' && echo 'There are running business processes. Please stop them first to continue upgrade.' || echo 'There are no running business processes. You are OK to continue update procedure.'

Continue the update procedure if the command displays the following message: "There are no running business processes. You are OK to continue update procedure." Otherwise, stop the running processes first.

Stop services

To stop services:

For single-point upgrade

For multi-point upgrade

Connect to the server with the previous installation package via SSH and run the following commands as <linux_installation_user>:

$ cd PACKAGE_DIR
$ export ANSIBLE_PRIVATE_KEY_FILE="<path_to_ssh_key>"   # Path to SSH key for connection to all Linux servers as WFUSER.
$ export ANSIBLE_VAULT_PASS="<ansible_vault_password>"   # Password for decryption of config.yml.
$ ./install.sh stop_services full

Connect to all Linux servers via SSH and run the following command as WFUSER on each of them:

$ wfmanager stop all

Prepare application user

Versions beyond 10.1.6.1 feature only one application user (here, WFUSER) to install and run the Product.

To perform the upgrade, provide the following permissions to the application user:

Grant the sudo permissions.
If you upgrade the system using the multi-point approach, skip step 2. Provide SSH access via the SSH-key to all Linux servers with the installation package.
Provide the application user with the owner permissions for PACKAGE_DIR, which contains the installer extracted during the initial installation of 10.1.4, for example: /opt/workfusion/wf_installer).
```
$ sudo chown -R WFUSER PACKAGE_DIR
```

Prepare environment

Before upgrading IA Cloud Enterprise, make sure that your environment meets the following requirements. Failing to do so results in an extended time of the upgrade and may cause errors.

Prerequisites

The environment must meet all the requirements listed in the System requirements section:
- Hardware and OS
- DNS names
  
  Make sure that you have created all domain names listed on the page.
- Ports
  
  Make sure that all ports listed on the page are open.
- RPA server
  
  Make sure that the required Bot Master and Bot Unit users are present on the RPA server.
- Database
  
  Also, make sure that your database has a user with the enabled db_owner role.
- Users and permissions
  
  Make sure that installation users on the Analytics and RPA server have either WinRM or RDP access.

Prepare certificates

In 10.2.1, the server.crt certificate must mandatorily include the end certificate and all intermediate ones if they exist. Ensure that your certificates comply with the requirements.

Then, on the MASTER server, place prepared ca.crt, server.crt, and server.key to the PACKAGE_DIR/certificates/ directory.

Skip the step if you don't have those certificates. In this case, self-signed certificates get generated automatically during the installation.

$ ls -la PACKAGE_DIR/certificates/
total 24
drwxr-xr-x.  3 ec2-user ec2-user   78 Sep 24 14:47 .
drwxr-xr-x. 12 ec2-user ec2-user 4096 Sep 27 17:20 ..
-rw-r--r--.  1 ec2-user ec2-user 2984 Sep 24 14:42 ca.crt
-rw-r--r--.  1 ec2-user ec2-user 4835 Sep 24 14:42 server.crt
-rw-r--r--.  1 ec2-user ec2-user 1674 Sep 24 14:42 server.key

Verify prerequisites

After you prepare the environment for the upgrade, you can use the dedicated checking script for verification. For more information, read the check readiness instruction.

Download and extract installer

If you upgrade using the multi-point approach

On the MASTER server, generate configuration files as described earlier.
Ensure that PACKAGE_DIR, including installer package, certificates folder, config.yml, rpa.yml, ports.yml, and hosts.yml, are synchronized across all Linux hosts.

To download and extract the installer, connect to the server with the installation package from the previous version via SSH and run the following commands as WFUSER:

Go to INSTALL_DIR, which contains the installer directory created during the installation of 10.1.4, for example: /opt/workfusion:
```
$ cd INSTALL_DIR
```
Create the wf_installer_new directory for the new version of the installer. Ensure that the directory is writable for WFUSER.
note
Use only the wf_installer_new name for the directory to store the new installation package. Otherwise, the backup won't start.
```
$ mkdir wf_installer_new
```
Download the installer v.10.2.1 to INSTALL_DIR/wf_installer_new:
```
$ curl -o '<10.2.1-installer-archive>' '<link-to-installer-10.2.1>'
```
If Internet access is unavailable on the server, place the package to the INSTALL_DIR/wf_installer_new directory with any convenient method.

Extract the installer:

$ tar xzf <10.2.1-installer-archive> --strip 1

Stop unnecessary OCR servers.

For IA Cloud v.10.2.1 in 6-servers topology, WorkFusion doesn't use OCR as dedicated servers. You can stop them. For more details see the Hardware and OS section. If you plan to leave an opportunity for rollback, don't stop the OCR server.

Copy configuration files for the current environment from INSTALL_DIR/wf_installer to INSTALL_DIR/wf_installer_new:

$ cp -r INSTALL_DIR/wf_installer/{license.properties,certificates,.agreement,rpa.yml} INSTALL_DIR/wf_installer_new/

Generate new configuration files from existing ones:
```
$ export ANSIBLE_VAULT_PASS="<ansible_vault_password>"   # Password for decryption of config.yml.
$ cd INSTALL_DIR/wf_installer_new
$ ./install.sh hosts_yml  generate -e @INSTALL_DIR/wf_installer/hosts.yml
```
After executing ./install.sh hosts_yml generate, in hosts.yml, specify the correct value for keycloak_lb_hostname.
```
$ ./install.sh config_yml generate -e @INSTALL_DIR/wf_installer/config.yml
$ ./install.sh ports_yml  generate -e @INSTALL_DIR/wf_installer/ports.yml
$ ./install.sh rpa_yml    generate -e @INSTALL_DIR/wf_installer/config.yml
```
note

The new mssql_keycloak_user is introduced with the default password in config.yml. Change it to the password of mssql_keycloak_user, which you have created on the 'prepare the database' step.

note

In the 10.2.1 version, IA Cloud supports Active Directory logins. If you want to switch to MS SQL AD logins, in config.yml, change the corresponding mssql logins to the logins and password you have created when preparing the database.
Encrypt config.yml:
```
$ ./install.sh encrypt config
```
In the 10.2.1 version, the server.crt certificate must mandatorily include the end certificate and all intermediate ones if they exist. If your certificates don't comply with the requirements, prepare new ones according to the requirements.
Generate required internal certificates:
```
$ ./install.sh certs generate
```

Back up old installation directory

The procedure is optional.

To back up the old installation directory:

Connect to each Linux server via SSH and, on each of them, run the following commands as WFUSER to create a backup directory:
```
$ mkdir </path/to/backup_dir> 
```

Connect to the server containing the new installation package via SSH and run the following commands as WFUSER to back up old installation directory (INSTALL_DIR),:

$ cd INSTALL_DIR/wf_installer_new
$ export ANSIBLE_PRIVATE_KEY_FILE="<path_to_ssh_key>"   # Path to the SSH key for connection to all Linux servers as WFUSER
$ export ANSIBLE_REMOTE_USER="WFUSER"                # Application user specified in config.yml
$ export ANSIBLE_VAULT_PASS="<ansible_vault_password>"  # Password for decrypting config.yml
$ ./install.sh backup full -e backup_dir=/path/to/backup_dir # Path to the directory to place a backup. Make sure it is writable for WFUSER.

note

The preceding procedure is intended for the single-point installation. To back up the the directory created during the multi-point installation, in the last command specify <server_role> instead of full. For example,

$ ./install.sh backup <server_role> -e backup_dir=/path/to/backup_dir -c local --limit <current_hostname> # here, <server_role> may be int, app, bepagent, etc.

Check users' passwords

Ensure that users' passwords are valid in config.yml. In most cases, you don't need to change anything in the file. You may proceed further and skip this step. If you encounter issues, for example, an error message with invalid credentials, then:

Open config.yml for editing.

./install.sh edit_config master
# you'll be prompted for the decryption password

Update it with valid passwords.

nexus_admin_pass

mssql_dba_pass
mssql_ct_pass
mssql_ws_pass
mssql_sqc_pass
mssql_rpa_pass
mssql_pm_pass
mssql_dm_pass
mssql_ocr_pass
mssql_automl_mms_pass
mssql_keycloak_pass

Re-run the installation script.

For example, after the initial 10.1.4 installation, you may change the Nexus or MSSQL passwords manually in the environment. In this case, actualize them in config.yml because the installer uses them to update DB schemas and Nexus artifacts).

Upgrade components on servers

caution

Before uninstalling the RPA component, manually copy the log content if you want to preserve the logs, as the corresponding folder and all of its content will get deleted.

Log locations:

bot-agent logs: ..\RPA\bot-agent\logs
worker logs: ..\RPA\logs
nginx logs: ..\RPA\nginx\logs
WFSvc logs: ..\RPA\tools\logs

Upgrade the components, depending on your installation approach:

Single-point

Multi-point install

Remember to run the following command on the MASTER server as WFUSER.

Go to INSTALL_DIR/wf_installer_new:
```
$ cd INSTALL_DIR/wf_installer_new
```

Run the following command to set up the application user.

$ export ANSIBLE_PRIVATE_KEY_FILE="<path_to_ssh_key>"   # Path to SSH key for connection to all Linux servers as WFUSER.
$ export ANSIBLE_VAULT_PASS="<ansible_vault_password>"   # Password for decryption of config.yml.

Run the following command to remove outdated components of the previous installation:
```
$ cd PACKAGE_DIR
$ ./install.sh cleanup rudiments
```

Run the following commands:

$ ./install.sh precheck mssql   # Checks that MSSQL credentials are set correctly in config.yml, Database exists, wf_dba_user exists and has db_owner role
$ ./install.sh configure mssql  # Creates all required schemas in Workfusion DB, creates and maps DB users to provided MSSQL logins, and assigns correct user permissions per schemas

Run the upgrade commands:

$ ./install.sh preinstall full -e skip_bi=true -e skip_rpa=true -e skip_ocrwin=true
$ ./install.sh install full -e skip_bi=true -e skip_rpa=true -e skip_ocrwin=true
$ ./install.sh check full -e skip_bi=true -e skip_rpa=true -e skip_ocrwin=true

Before updating the RPA server, uninstall current RPA and perform a clean installation of new RPA:

$ ./install.sh uninstall rpa
$ ./install.sh preinstall rpa
$ ./install.sh install rpa
$ ./install.sh check rpa

Cleanup RabbitMQ queues:

On the server with the installation packages, run the command:
```
$ ./install.sh stop_services full # stop all services
```

On the server with rabbitmq (first MASTER server in the HA mode, or the MASTER server), run the commands:

$ wfmanager start rabbitmq
$ rabbitmq-diagnostics ping -q # repeat untill Ping succeeded (echo $? == 0)
$ rabbitmqctl --silent list_queues --vhost bep | awk '{ print $1 }' | xargs -r -L1 rabbitmqctl delete_queue --vhost bep

On the server with the installation package, run the command:
```
$ ./install.sh start_services full # start all services
```

The upgrade is complete. It may require Control Tower for about 5 minutes to start. So, if you see error 503 in a browser right now, wait a bit.

Run the following commands on each Linux server, as WFUSER:

On each Linux server, stop all IA Cloud services:
```
$ wfmanager stop all
```
To verify the status of services, use the command wfmanager status.
On each Linux servers, in the PACKAGE_DIR, run the following command to remove outdated components of the previous installation:
```
$ ./install.sh cleanup rudiments -c local --limit=<current_server_dns_name>
```

Run the following commands once on any Linux server:

$ ./install.sh precheck mssql   # Checks that MSSQL credentials are set correctly in config.yml, Database exists, wf_dba_user exists and has db_owner role
$ ./install.sh configure mssql  # Creates all required schemas in Workfusion DB, creates and maps DB users to provided MSSQL logins, and assigns correct user permissions per schemas

Install IA Cloud Enterprise components on all Linux servers by following the corresponding guide.

Note the server changes:
- For a 6-server environment: your current APP server means MASTER, and BEP AGENT servers mean AGENT.
Log in to the RPA server and uninstall RPA components: Control Panel → Programs and Features → RPA (Uninstall). After that, remove the RPA folder.
Install RPA by following the instructions in the section Install RPA package.

Cleanup the RabbitMQ queues to ensure that old workers don't spawn queues:

$ wfmanager stop all        # Run on each Linux server
$ wfmanager start rabbitmq  # Run on all MASTER servers
$ rabbitmqctl --silent list_queues --vhost bep | awk '{ print $1 }' | xargs -r -L1 rabbitmqctl delete_queue --vhost bep      # Run on first MASTER server
$ wfmanager start all      # Run on each Linux server

Upgrade Analytics server

Backup site configuration

Before upgrading the Analytics components, connect to the BI server via RDP as a Windows Administrator user and save all your custom workbooks and datasources to a predefined location on a local disk.

important

Download custom workbooks and datasources to separate directories. For example, c:\patch_10_1_6_backup\workbooks\ and c:\patch_10_1_6_backup\datasources\.

Don't save backup files in Analytics (BI) server installation directory, for example, c:\workfusion\ as it gets deleted during the upgrade.

To download the custom workbooks from the Analytics server UI:

Go to a particular site, and, on the Content tab, click Workbooks. To identify custom workbooks, look for the _custom postfix in their names.
In the right corner of the Name column, click More (...), click Download, and save the file as a Tableau workbook.

To download the custom datasources from the Analytics server UI:

Go to a particular site, and, on the Content tab, click Datasources.
In the right corner of the Name column, click More (...), click Download, and save the file as a Tableau datasource.
Remember to rename the custom dashboards by replacing all occurrences of the underscore character ("_") with a plus symbol ("+") in the titles, except for the first and last two underscores.
To restore custom dashboards, follow the instructions in the section Backup and restore custom Analytics dashboards.

Upgrade Analytics

For single-point upgrade

For multi-point upgrade

To upgrade the Analytics Server:

On the MASTER server, run the following command:

$ cd /opt/workfusion/wf_installer_new
$ ./install.sh uninstall bi

Restart the Analytics server to apply changes.

On the MASTER server, run the following command:

$ ./install.sh preinstall bi
$ ./install.sh install bi
$ ./install.sh check bi

To upgrade the Analytics Server:

On the Analytics (BI) server, launch the New PowerShell ISE.

Launch PowerShell ISE as Administrator and copy the following script and execute it in PowerShell on the relevant Analytics server.

# UNINSTALL TABLEAU SERVER
# FILL IN THE PARAMETERS BELOW
$install_dir   = "c:\workfusion" # The value of "install_dir" which you've set in config.yml during Linux servers installation.

$env:win_user="username" # The value of "bi_user" which you've set in config.yml during Linux servers installation.
$env:win_pass='"password"' # Leave single and double quotes in place. Replace only word password. The value of "bi_pass" which you've set in config.yml during Linux servers installation.
# =========================================
$package_dir   = "${install_dir}\WorkFusionAnalyticsServer"

Write-Host "Uninstalling filebeat"
$service = Get-WmiObject -Class Win32_Service -Filter "name='filebeat'"
    if ($service) {
    $service.StopService()
    Start-Sleep -s 1
    $service.delete()
    }

Write-Host "Uninstalling metricbeat"
$service = Get-WmiObject -Class Win32_Service -Filter "name='metricbeat'"
    if ($service) {
    $service.StopService()
    Start-Sleep -s 1
    $service.delete()
    }

Write-Host "Stop PostgreSQL process"
$proceses = "postgress"
        Get-Process | Where-Object {$proceses.Contains($_.Name)} | Stop-Process -Force

Write-Host "Uninstall WorkFusion Analytics Server"
$path = Get-ChildItem -Path $install_dir\WorkFusionAnalyticsServer\packages -Recurse tableau-server-obliterate.cmd
        if ($path) {
        &$path.FullName -y -y -y
        }

Write-Host "Uninstall PostgreSQL Server"
$app = Get-WmiObject -Class Win32_Product | Where-Object {$_.Name -match "psql"}
        if ($app) {$app.Uninstall()}

Write-Host "Remove installation directory"
If (Test-Path $install_dir){
Get-ChildItem -Path $install_dir -Recurse | Remove-Item -force -recurse
Remove-Item $install_dir -Force
}

Restart the Analytics server to apply changes.
Install Analytics (BI) server by following the instructions in the section Install Analytics Server.

Restore custom parameters from previous versions

note

When upgrading to v.10.2.1, you need to configure LDAP/AD and IDP/SSO manually in Keycloak.

For LDAP/AD configuration instructions, refer to the Configure LDAP section.
For IDP/SSO configuration instructions, refer to the Configure Identity Providers section.

Custom workers

If you have changed workers' settings in IA Cloud 10.1.4, you can migrate them after the upgrade.

For that, after upgrading to IA Cloud 10.2.1, on the MASTER server, open the file with workers' settings for Control Tower (for example, /opt/workfusion/vds-data/workers/app/com.workfusion.spa.ct/worker-app/10.1.0.32/worker.yml), and enter the previous corresponding settings, such as memory, CPU, etc. Note that the structure of the new file differs from the previous one.

File worker.yml for 10.1.4

#cat /opt/workfusion/vds-data/workers/app/com.workfusion.spa.ct/worker-app/10.1.0.10/worker.yml

command: ${java} -XX:CICompilerCount=2 -XX:+UseSerialGC -XX:MaxMetaspaceSize=${metaspace}M -Xmx${heap}M -XX:+ExitOnOutOfMemoryError -Dgroovy.use.classvalue=true -Dgroovy.target.indy=true -Dfile.encoding=UTF8 -Dexecution.task.queue.input=${tasks.queue} -Dlogging.path=${log.dir} -Dlogging.file=${log.file} -Djava.io.tmpdir=${temp.dir} -Dwebharvest.machine.config.bundle.dir=${working.dir}/bcb -jar ${worker.jar} ${config.server.parameters}
cpu: 0.25
memory:
  heap: 1024

File worker.yml for 10.2.1

# cat /opt/workfusion/vds-data/workers/app/com.workfusion.spa.ct/worker-app/10.1.0.32/worker.yml

command: ${java} -XX:CICompilerCount=2 -XX:+UseSerialGC -XX:MaxMetaspaceSize=${metaspace}M -Xmx${heap}M -XX:+ExitOnOutOfMemoryError -Dgroovy.use.classvalue=true -Dgroovy.target.indy=true -Dfile.encoding=UTF8 -Dexecution.task.queue.input=${tasks.queue} -Dlogging.path=${log.dir} -Dlogging.file=${log.file} -Djava.io.tmpdir=${temp.dir} -Dwebharvest.machine.config.bundle.dir=${temp.dir}/bcb -jar ${worker.jar} ${config.server.parameters}
cpu: 0.4
memory:
  heap: 1024
  metaspace: 512
health-checks:
  - protocol: MESOS_HTTP
    path: /actuator/health
    grace-period-sec: 180
    interval-sec: 60
    timeout-sec: 10
    max-failures: 3

Upgrade Business Processes

Migrate your Business Processes with Manual Tasks that use qualifications. To do that, refer to the following guides:

Check upgrade

Once the upgrade is complete, check the WorkFusion Platform with Business Process (BP) and Manual Task. The OCR must be activated. For more information on the post-installation checks, see Install components.

WorkFusion Documentation

10.2.1

Hardware

Install Linux components

Keycloak administrator guide

note

Before you start

Back up previous installation

Save fleet names for Bot Units

Check running business processes

Stop services

Prepare application user

Prepare environment

Prerequisites

Prepare certificates

Verify prerequisites

Download and extract installer

If you upgrade using the multi-point approach

note

note

note

Back up old installation directory

note

Check users' passwords

Upgrade components on servers

caution

Upgrade Analytics server

Backup site configuration

important

Upgrade Analytics

Restore custom parameters from previous versions

note

Custom workers

Upgrade Business Processes

Check upgrade