10.0

Edit

Update from 10.0.0 to 10.0.2

This guide describes the steps to upgrade SPA from 10.0.0 to 10.0.2.

Prerequisites

  • You have WorkFusion SPA 10.0.0 installed.
  • Run all following steps as <installation-user>. The Root user is not required.

Prepare Integration server

Prepare update packages

To extract installation packages:

  1. Log in to the Integration server as a Linux installation user, by using Linux Terminal, Windows PuTTY, or any other SSH client:

    $ ssh -i <path-to-private-key.pem> <username>@<hostname.example.com>

  2. In the /opt/workfusion/ directory, create the NEW_PACKAGE_DIR directory for the new WorkFusion installation package, for example, /opt/workfusion/wf_installer_10.0.2. Grant the read access for this directory to all users:

    $ sudo mkdir -p /opt/workfusion/wf_installer_10.0.2

$ sudo chmod 0755 /opt/workfusion/wf_installer_10.0.2

  3. Make sure that the Linux installation user is an owner of the installation directory:

    $ sudo chown -R <username>:<username> /opt/workfusion/wf_installer_10.0.2

  4. Download the provided installation package with any file retrieving tool, for example, wget or curl:

    $ curl 'https://link_to_installer_package' --output /opt/workfusion/workfusion-full-package-<version>.tar.gz

    If the Internet access is not available on the Integration server, download the installer and copy it as workfusion-full-package-<version>.tar.gz to /opt/workfusion/ on the Integration server.

  5. Extract the downloaded package to the NEW_PACKAGE_DIR directory:

    $ tar -xzvf /opt/workfusion/workfusion-full-package-<version>.tar.gz --strip 1 -C /opt/workfusion/wf_installer_10.0.2

  6. Download a new RPA installer package:

    $ curl 'https://source_with_RPAInstaller-{version}.zip' --output NEW_PACKAGE_DIR/sources/RPAInstaller-{version}.zip

    If internet access is not available on the target server download RPA Installer using the download link and copy it to the Integration server to NEW_PACKAGE_DIR/sources/RPAInstaller-{version}.zip.

Configure update

To configure the update:

  1. Copy your previously generated license.properties, and all certificates from OLD_PACKAGE_DIR to NEW_PACKAGE_DIR:

    $ cd /opt/workfusion/
$ cp ./wf_installer/certificates/* ./wf_installer_10.0.2/certificates/
$ cp ./wf_installer/license.properties ./wf_installer_10.0.2/

  2. In your NEW_PACKAGE_DIR directory, replace the hosts.yml and config.yml configuration files with those in the OLD_PACKAGE_DIR.

  3. In the hosts.yml, rename the variable <bep_agent_hostname> to <bep_agent_hostnames>. The vi text editor is used in the example below:

    $ vi hosts.yml

    Refer to the hosts.yml options section for more details on each option.

    For NEW_PACKAGE_DIR/config.yml:

    $ cd /opt/workfusion/wf_installer_10.0.2
$ ./install.sh edit_config int

    To edit the file, use your <ansible_vault_password>.

    In the end of config.yml, add these variables:

    mesos92_master_port:                 '5092'  # Used only when SPA9.2 AutoML is installed for backward compatibility with SPA9.2 business-processes. Mesos master port for VDS. Listens on 0.0.0.0 (HTTPS).
marathon92_port:                     '8092'  # Used only when SPA9.2 AutoML is installed for backward compatibility with SPA9.2 business-processes. Marathon Port. Listens on 127.0.0.1 (HTTP).
marathon92_proxy_port:               '8492'  # Used only when SPA9.2 AutoML is installed for backward compatibility with SPA9.2 business-processes. Nginx port. Listens on 0.0.0.0 (HTTPS) and proxies requests to 'marathon92_port'.
marathon92_communication_port:       '15092' # Used only when SPA9.2 AutoML is installed for backward compatibility with SPA9.2 business-processes. Used by Marathon for libprocess communication. Listens on 0.0.0.0 (HTTPS).

mesos92_slave_port:                  '5051'        # Used only when SPA9.2 AutoML is installed for backward compatibility with SPA9.2 business-processes. Mesos Agent port. Listens on 0.0.0.0 (HTTPS).
mesos92_slave_port_range:            '40000-44000' # Used only when SPA9.2 AutoML is installed for backward compatibility with SPA9.2 business-processes. Ports range on mesos Agent(s) used for communication with Mesos Master (ports from this range are opened randomly during tasks execution).

wf_sso_saml_enabled:                     '{{ sso_saml_enabled }}'
wf_sso_saml_sp_metadata:                 '{{ sso_saml_sp_metadata }}'
wf_sso_saml_idp_metadata:                '{{ sso_saml_idp_metadata }}'
wf_sso_saml_idp_file_metadata:           '{{ sso_saml_idp_file_metadata }}'
wf_sso_saml_username_attribute:          '{{ sso_saml_username_attribute }}'
wf_sso_saml_metadata_admin_user:         'workfusion'
wf_sso_saml_metadata_admin_pass:         '********'
wf_sso_saml_metadata_admin_authorities:  ROLE_METADATA_ADMIN

ws_sso_saml_enabled:            '{{ sso_saml_enabled }}'
ws_sso_saml_sp_metadata:        '{{ sso_saml_sp_metadata }}'
ws_sso_saml_idp_metadata:       '{{ sso_saml_idp_metadata }}'
ws_sso_saml_idp_file_metadata:  '{{ sso_saml_idp_file_metadata }}'
ws_sso_saml_username_attribute: 'mail'

    Refer to the config.yml options section for more details on each configuration option.

Remember to encypt config.yml before proceeding to update.

$ cd /opt/workfusion/wf_installer
$ ./install.sh edit_config int

Update all servers

note

Run all following steps as <installation-user>.

To update components:

  1. On the INT server, stop all services:

    $ cd NEW_PACKAGE_DIR
$ export ANSIBLE_PRIVATE_KEY_FILE="<path-to-private-linux-installation-key>"
$ export ANSIBLE_REMOTE_USER="<installation-user>"
$ export ANSIBLE_VAULT_PASS="<ansible_vault_password>"
$ ./install.sh stop_services full

  2. Uninstall the previous RPA server:

    $ ./install.sh uninstall rpa

  3. Install new components:

    $ ./install.sh install full -e skip_bi=true

  4. Check that the installation is performed correctly:

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

If you want to have more control over the installation of separate components:

  1. Log in to each server and stop all services as <wf_user>.

    $ wfmanager stop all

  2. Log in to the INT server and install each server separately as <installation-user>. See the following sections for instructions.

Integration server

To install and check the Integration server's components:

$ ./install.sh install int
$ ./install.sh check int

BEP Master server

To install and check the Master server:

$ ./install.sh install bep-master
$ ./install.sh check bep-master

BEP Agent server

Install and check the Agent server:

$ ./install.sh install bep-agent
$ ./install.sh check bep-agent

APP server

Install and check the APP server's components:

$ ./install.sh install app
$ ./install.sh check app

RPA server

Install the RPA server:

$ ./install.sh install rpa

OCR server

Follow the instruction for the corresponding Operating System.

To install the OCR server:

Install and check the OCR server:

$ ./install.sh install ocr
$ ./install.sh check ocr

  1. Download the OCR Installer package:

    $ curl 'https://source_with_OCRInstaller-{version}.zip' --output sources/OCRInstaller-{version}.zip

    Note: If the Internet access is not available on the target server, download the OCRWin installer using the https://source_with_OCRInstaller-{version}.zip link and copy it to the Integration server as NEW_PACKAGE_DIR/sources/OCRInstaller-{version}.zip.

    The name of the destination file is important and must mandatorily be OCRInstaller-{version}.zip (for example, OCRInstaller-10.0.0.12-1.zip).

  2. In config.yml, ensure that the ocr_platform parameter is set to windows:

    $ ./install.sh edit_config int

  3. Uninstall the previous version of the OCR server:

    $ ./install.sh unistall ocrwin

  4. Install the OCR server:

    $ ./install.sh install ocrwin

  5. Check that the installation is performed correctly:

    $ ./install.sh check ocrwin

After updating the OCR server, remember to reactivate the Licence for it.

Check the update

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

← PreviousNext →