Upgrade from 10.2.x to 10.2.6

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

Prepare for upgrade

Before the upgrade, ensure that:

You created the additional DNS record for Minio UI. See DNS names.
You allowed additional ports between servers For Zookeeper and ETCD. See Ports.

important

Pay attention that IA Cloud Enterprise v.10.2.6 now requires additional ports 9064, 9079, and 9094 to be opened for the correct Product's operation.
You added <MSSQL_PM_USER> to SQLAgentUserRole. See Database.
You granted view server state permission to <MSSQL_PM_USER>. See Database.
No Business Process or Manual Task is running.
You prepared fleets for migration.
You backed up the following components:
- The /opt/workfusion/workfusion and /opt/workfusion/workspace directories
- Vault properties for all components
- ZooKeeper settings changed since the previous installation
- Any system files changed since the previous installation
You enabled SSH access to all Linux hosts.

note

If you configured LDAP/AD or IDP/SSO and turned off wf_username in Keycloak for the upgrade process, re-enable this user. You can deactivate it again after the upgrade.

Ensure that config.yml containes correct wf_username and wf_password.

Save fleet names for Bot Units

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

Log in to Control Tower and click Bot Manager.
In the Bot Manager window, click 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 that contains the installer directory created during the installation of 10.2.0, for example: /opt/workfusion:
```
$ cd INSTALL_DIR
```

Check the output of the 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.

If you stopped all of the Business Processes (step 1) but the output from the command is still displaying "There are running business processes..." (step 2), list them and delete them one by one by running the following commands:

# List all Business Processes
$ ./zookeeper/bin/zkCli.sh ls /control-tower/execution/active-instances | egrep '^\[[0-9a-f-]+.*$'
[1b76392d-f629-4800-ba70-3050e20df11f, 548dcb6a-73b1-490d-9436-c22f079494d5]

# Remove BPs one by one
$ ./zookeeper/bin/zkCli.sh delete /control-tower/execution/active-instances/1b76392d-f629-4800-ba70-3050e20df11f
$ ./zookeeper/bin/zkCli.sh delete /control-tower/execution/active-instances/548dcb6a-73b1-490d-9436-c22f079494d5

Destroy all workers

Before the upgrade, ensure that all the workers are destroyed:

In your browser, open the Marathon UI.
Under Applications, find the worker item.
Find the additional options button and click Destroy.

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 APPLICATION_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.
$ wfmanager stop all
$ ./install.sh stop_services full

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

$ wfmanager stop all

note

When updating the DR Failover environment, skip Prepare certificate and Download installer sections and execute steps 1-3 from the Deploy DR environment section.

Prepare certificates

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, for the single-point installation, on the first Master server, add ca.crt, server.crt, and server.key to the PACKAGE_DIR/certificates/ directory. For the multi-point installation, do that on all Linux servers.

$ 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 installer

To download and configure the installer v.10.2.6:

Go to INSTALL_DIR that contains the installer directory created during the initial installation, 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 doesn't start.
```
$ mkdir wf_installer_new
```
Download the installer to PACKAGE_DIR:
```
$ curl -o '<10.2.6-installer-archive>' '<link-to-installer-10.2.6>'
```
If Internet access is unavailable on the server, download the package to the PACKAGE_DIR directory using any convenient method.

Extract the installer:

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

Copy configuration files for the current environment from BACKUP_DIR to PACKAGE_DIR:
```
$ cp -r ../BACKUP_DIR/{license.properties,.agreement} PACKAGE_DIR/
```
Generate new configuration files from the existing ones:
```
$ export ANSIBLE_VAULT_PASS="<ansible_vault_password>"   # Password for decryption of config.yml.

$ cd PACKAGE_DIR
$ ./install.sh hosts_yml  generate -e @../BACKUP_DIR/hosts.yml
$ ./install.sh config_yml generate -e @../BACKUP_DIR/config.yml
$ ./install.sh ports_yml  generate -e @../BACKUP_DIR/ports.yml
$ test -f ../BACKUP_DIR/rpa.yml && cp -f ../BACKUP_DIR/rpa.yml rpa.yml || ./install.sh rpa_yml generate
```
Fill empty passwords in config.yml.
```
$ ./install.sh passwords generate
```
note

Alternatively, you can set the passwords manually. In that case, remember to use only Latin letters and allowed symbols. For more information, see Specify installation parameters.

important

In the 10.2.6 version, IA Cloud supports Active Directory logins for MSSQL. To switch to MSSQL AD logins, in config.yml, change the corresponding mssql logins to the credentials you created when preparing the database.
note
BI workbooks are not published by default during the installation process. To publish them during the installation, go to config.yml and set the publish_bi_dashboards variable to True. Another option to publish BI workbooks is to run the following command at any time after the installation is completed.
```
$ ./install.sh install bi-workbooks -e publish_bi_dashboards=true
```
Encrypt config.yml:
```
$ ./install.sh encrypt config
```
Check that your certificates comply with the requirements and generate required internal ones:
```
$ ./install.sh certs generate
```

If you upgrade using the multi-point approach

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

Upgrade components

caution

Before uninstalling the RPA component, manually copy the log content to preserve the logs. The corresponding folder and all of its content will be 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 non-HA and HA

Multi-point install

Multi-point HA

Remember to run the following command on the Master server as APPLICATION_USER.

Set up 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.

Remove the 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

Optional.

For the DR installations: if you are updating a DR Failover environment, execute steps 5-8 from the Deploy DR environment section.
Before updating the RPA server, uninstall the current RPA and perform a clean installation of a new RPA:
```
$ ./install.sh uninstall rpa
$ ./install.sh install rpa
$ ./install.sh check rpa
```

Clean up 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 (the 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
```

On each Linux server, run the following commands as APPLICATION_USER:

Stop all IA Cloud services:
```
$ wfmanager stop all
```
To verify the status of the services, run the wfmanager status command.
In 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>
```

On any Linux server, run the following commands once:

$ ./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.
Optional.

For the DR installations: if you are updating a DR Failover environment, execute steps 5-8 from the Deploy DR environment section.
Log in to the RPA server and uninstall RPA components: Control Panel → Programs and Features → RPA (Uninstall).
Re-install RPA by following the instructions in the Install RPA package section.

Clean up 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

Before starting the installation, ensure that config.yml, ports.yml, rpa.yml, hosts.yml, and the /certificates directory are the same on all hosts.

To upgrade components, run the following command on the server with the installation package as APPLICATION_USER:

On all Linux servers, prepare the environment variables:

$ export ANSIBLE_VAULT_PASS="<ansible_vault_password>"  # Run on each Linux server to disable password prompt (not mandatory, just for convenience)

On all Linux servers, enter the PACKAGE_DIR directory and run the following command to remove the outdated components of the previous installation:
```
$ cd /opt/workfusion/wf_installer_new
$ ./install.sh cleanup rudiments -c local
```

Run the following commands once on any Master 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 the IA Cloud Enterprise components on all Linux servers by following the corresponding guide.
Optional.

For the DR installations: if you are updating a DR Failover environment, execute steps 5-8 from the Deploy DR environment section.
Log in to the RPA server and uninstall RPA components: Control Panel → Programs and Features → RPA (Uninstall). After that, remove the RPA folder.
Re-install RPA by following the instructions in the Install RPA package section.

Clean up 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

The upgrade is complete. It may take about five minutes for Control Tower to start. Wait several minutes if you see error 503 in a browser right after the upgrade.

Upgrade Analytics server

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

Back up site configuration

important

Download custom workbooks and datasources to separate directories, for example, c:\10_2_0_backup\workbooks\ and c:\patch_10_2_0_backup\datasources\.

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

To download the custom workbooks from the Analytics server interface:

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

To download the custom data sources from the Analytics server interface:

Go to a particular site. 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 the plus symbol ("+") in the titles, except for the first and last two underscores.
Follow the instructions in the Backup and restore custom Analytics dashboards section to restore custom dashboards.

Upgrade Analytics

To upgrade the Analytics Server:

For single-point upgrade

For multi-point upgrade

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

On the Analytics 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" you've set in config.yml during Linux servers installation.

$env:win_user="username" # The value of "bi_user" 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. You've set the value of "bi_pass" in config.yml during Linux server 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 server components by following the instructions in the Install Analytics Server section.

Restore custom parameters from previous versions

Custom workers

Suppose you have changed workers' settings in IA Cloud 10.2.1.x, you can migrate them after the upgrade.

For that, after upgrading, 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.2.1.5/worker.yml, and enter the previous corresponding settings, such as memory, CPU, and so on.

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 post-installation checks, see Install components.

On the DR Failover environment, disable autostart of its processes. For that, execute step 11 from the Deployment section.

Known issues

If, during the upgrade, you face a "unique key constraint" issue related to WorkSpace, see the following instruction on how to resolve it.

WorkFusion Documentation

10.2.6

Hardware

Install Linux components

Keycloak administrator guide

Prepare for upgrade

important

note

Save fleet names for Bot Units

Check running Business Processes

Destroy all workers

Stop services

note

Prepare certificates

Verify prerequisites

Download installer

note

note

important

note

If you upgrade using the multi-point approach

Upgrade components

caution

Upgrade Analytics server

Back up site configuration

important

Upgrade Analytics

Restore custom parameters from previous versions

Custom workers

Upgrade Business Processes

Check upgrade

Known issues