Special considerations are required to upgrade from versions prior to those listed below. Please review the following notices according to the version of Blue Prism which you are upgrading from.
For example, if a deployment currently running 5.0.21 is being upgraded to Version 6.1 it is essential that the information for updates prior to 5.0.23, 5.0.24, 5.0.29 and 6.0 are followed.
As with all upgrades it is essential that a full and verified database backup is performed prior to applying the database upgrades.
Requires .NET Framework 4.7
All components (interactive clients, runtime resources, and application server) will require .NET 4.7 to be installed as a pre-requisite.
Introduces WCF (Windows Communication Foundation)
Alternative server communication methods have been introduced, in addition to .NET remoting. Following a successful upgrade, it is recommended that one of the new WCF communication methods is chosen. WCF connection modes require session persistence to be enabled. If existing load balancing is configured that does not apply session persistence, re-configuration will be required.
Dates are now processed using different logic
The logic used to interpret dates and times has changed and it is important that all processes that use date and times, particularly those that use collections with code stages are re-validated and updated accordingly. See the release notes for details, and the v6 Data Sheet – Date and Time Handling available on the portal for full information on the changes and implications. Aesthetic changes are also included. For example: session logs are now saved and displayed in resource local time; and the process alert history is now stored in UTC and displayed in client local time.
Pending or Running sessions should be completed or cancelled prior to upgrade
Process automations that are in a running or pending state should be completed or otherwise stopped or cancelled prior to upgrading to avoid issues resulting from updated date/time handling logic. Tesseract language packs will need to be updated on all devices
Tesseract Language Packs that are compatible with Tesseract 3.05.01 will need to be deployed to all devices that use Tesseract with language packs. The files can be downloaded from the Tesseract product site:
A new installer has been introduced
A new Blue Prism installer was introduced in version 6.0 that brought about changes to the scripted install procedures. See the v6 User Guide – Installing Enterprise Edition for further details.
Multi-team Environments (Group-based Permissions) – validate permission assignment
The allocation of permissions is now more granular, and a number of new permissions have been provided. To ease upgrades, all pre-existing user roles are automatically expanded to include these selected new roles: Execute (Objects/Processes); Execute (Objects/Processes) as Web Services; Authenticate as Resource. For new deployments, these permissions are only added to the appropriate security roles.
The assignment of all permissions must be reviewed to ensure they are appropriate for impacted users.
Process Administrator role permissions
Before upgrading, check that the following permissions are not assigned to the default Process Administrator role:
- Object Studio > Test Business Object
- Process Studio > Test Process
If these permissions are assigned to the role, remove them in System > Security > User Roles, before upgrading to version 6.3 or above.
Following a successful upgrade, the Process Administrator role is granted equivalent permissions.
New default groups for objects and processes
During an upgrade to 6.3, new Default groups are added to the navigation trees in Object Studio and Process Studio. Before upgrading, any existing group named Default that contains one or more subgroups must be renamed.
New permission required to call objects or processes exposed as web services
A new permission, Execute as Web Service is required to call an Object or Process exposed as a web service.
Some programmatic options will no longer work by default
A number of session management commands (create, start, delete) no longer work by default. They have been superseded by createas, startas and deleteas which require the use of the getauthtoken method.
While not recommended, the previous methods can be re-enabled by disabling the new setting that enforces permissions of controlling users when carrying out session management actions.
New mechanism for securing access to runtime resources
The Access Rights option added to the context menu for resource groups replaces the previous method of applying permissions to individual resources in System Manager. The new folder-based mechanism aligns with the newly introduced mechanism for securing objects and process and additionally provides greater control.
Items that were secured using the old mechanism must be manually re-secured using the new one.
Allow Snapshot Isolation automatically applied when using in-product capability for creating or upgrading databases
When upgrading or creating a database, using the in-product capabilities, the Allow Snapshot Isolation setting is now automatically applied for new and upgraded databases by default provided that the user upgrading or creating the database has the Alter Database SQL permission. When performing an upgrade, it is possible that a user may not have this permission and as a result, snapshot isolation will not be enabled. In such circumstances the upgrade will still be performed but when attempting to log in or start a blue prism server service, a message will inform the user that snapshot isolation must be enabled before a connection to the database can be made.
To manually enable snapshot isolation after database creation or upgrade, a user with alter database permissions must run the following command:
ALTER DATABASE [%%dbasename%%] SET ALLOW_SNAPSHOT_ISOLATION ON
Snapshot isolation must by manually applied if using a script to create or upgrade a database
When creating or upgrading a database using a script, it is necessary to manually apply the Allow Snapshot Isolation setting to the database.
To manually enable snapshot isolation after database creation or upgrade, a user with alter database permissions must run the following command:
ALTER DATABASE [%%dbasename%%] SET ALLOW_SNAPSHOT_ISOLATION ON
Session logs are not migrated by default
When performing an upgrade, select whether session log data is migrated to new database tables or retained in existing ones. Depending on the volume of session log data, migration can be performed during the upgrade via the user interface or post-upgrade using a tool available from Blue Prism Customer Support.
To streamline the upgrade process, session logs should be archived before upgrading. By default, sessions logs that remain in the system will not be visible after upgrade but can still be migrated when required.
The following options display when Upgrade Database is selected from the Connection Configuration dialog:
- Upgrade database and retain session logs in existing tables – The new database tables are created during the upgrade but session log data remains in the existing tables. This is the default option and provides the recommended upgrade path, ensuring upgrades are performed more quickly. The existing session log table names are suffixed with '_pre65'. The data from these tables is not be visible in session management but can still be migrated using the tool, available from Blue Prism Customer Support.
Upgrade database and migrate existing session log data to new tables – Data from session logs is migrated to new database tables during the upgrade. As the migration can take some time, this option is not available for environments with more than 10 million session logs or 10GB of data and is not recommended for environments with more than 1 million session logs.
When generating upgrade scripts using the 'Generate Script' button, the created script will run the upgrade without migrating session logs.
Tesseract language packs must be updated
The Tesseract OCR engine has been upgraded to version 4.0 and is applied to all installations of Blue Prism 6.5. Any non-English language packs from versions prior to 6.5 will no longer work and new ones must be installed.
If required, Blue Prism 6.5 can be configured to use previous versions of Tesseract. For further information, see Tesseract v4.0.0.
Unicode logging must be enabled for Chinese and Japanese versions of Blue Prism
To ensure that process logs are correctly audited in Simplified Chinese and Japanese language versions of Blue Prism, select Enable Unicode support for session logs in System > Settings.
Automatic retry no longer created for locked work queue items
If a work queue item is locked at the end of a session, the cleanup process now only marks the item with an exception. Previously this scenario would automatically create a retry for the queue item.
Schedules created using Blue Prism version 6.5 on a Turkish operating system must be deleted and recreated
Any schedules that were created using Blue Prism version 6.5 on a Turkish operating system will need to be deleted and recreated after upgrading to this release. If this is not done, the schedule will not execute but will appear to report success within the Recent Activity screen in the Control Room.
Data Gateways configurations must be manually checked for the impact of automatically renamed published dashboards
Published dashboards with duplicate names are renamed with a numbered suffix during an upgrade to version 6.6. Where this is the case, such dashboards will be deselected in any Data Gateways configuration in which they are referenced. All Data Gateways configurations should be checked to ensure the required dashboards are selected.
Customers considering an upgrade to Blue Prism 6.7 should consider upgrading to the latest major version of Blue Prism 6.
Blue Prism application server configuration file certificate encryption
Consider implementing certificate encryption to protect information contained in the application server configuration files. Details on using certificate encryption for the Blue Prism application server configuration can be found in the product help.
Caps command needs to be manually re-enabled if using binary business objects
The caps command, called whenever a Blue Prism interactive client connected to a runtime resource and originally introduced to support interaction with binary business objects in version 3, is now disabled by default to improve performance. If still using binary business objects, please contact Blue Prism Support for information on how to re-enable it.
Offline product help
From version 6.7 onwards, the Blue Prism product help is available online by default and all in-product help links direct to the online help files. For users who do not want to access the new web-based product help online, or want to provide the help locally within their environment, the Enable Offline Help option has been added to the System > System - Settings screen. This is a system-wide setting, which applies to all Blue Prism devices connected to the environment, meaning the help must be stored in a location which is accessible to all devices.
Once downloaded, the help can be made accessible by specifying the location in Blue Prism's system settings.
- Download the help files from the Blue Prism 6.7 product page on the customer portal.
- Extract the help from the ZIP file to the required location. The help can be hosted on an internal network, a shared directory, or placed in a folder on a local machine.
- In the Blue Prism interactive client, click the System tab and select System > Settings.
- In the Offline Help section, select the check box and enter the URL or folder location of the parent directory of the help files.
The help files in the specified location are now accessed when the help in called from the Blue Prism user interface. To revert back to using the server-based help, deselect Enable Online Help.
Required installation if upgrading to 6.7.1.
This notice is only valid when upgrading to 6.7.1. If upgrading to 6.7.2 or later it is recommended to follow the method outlined here.
If upgrading from Blue Prism 6.6 or earlier to 6.7.1, this release must be installed on all devices (clients, runtime resources, and application servers).
If upgrading from Blue Prism 6.7.0:
- 6.7.1 must be installed on all interactive clients.
- If runtime resources have been upgraded to 6.7.0 and are set up to have a user.config file in Users\Username\AppData\Roaming\Blue Prism Limited\Automate V3, then these must be upgraded to 6.7.1, or the user.config file must be removed.
- Devices running 6.7.1 can connect to application services running 6.7.0 or 6.7.1. Servers running 6.7.0 do not need to be updated to 6.7.1 other than to improve future upgrade behavior by addressing bg-5533 described below. If upgrading application services from 6.7.0 to 6.7.1, please ensure you note the existing log on details and other configured properties for the Blue Prism server service so they can be re-applied after upgrade.
Required installation if upgrading to 6.7.2
This notice is only valid when upgrading to 6.7.2. If upgrading to 6.7.3 or later it is recommended to follow the method outlined here.
If upgrading from Blue Prism 6.6 or earlier to 6.7.2, this release must be installed on all devices (clients, runtime resources, and application servers).
If upgrading from Blue Prism 6.7.0 or 6.7.1:
- 6.7.2 must be installed on all interactive clients.
- 6.7.2 must be installed on all runtime resources.
- Devices running 6.7.2 can connect to application services running 6.7.0, 6.7.1, or 6.7.2. Servers running 6.7.0 do not need to be updated to 6.7.2 other than to improve future upgrade behavior by addressing bg-5533, which was introduced in 6.7.0 and fixed in 6.7.1. If upgrading application services from 6.7.0 to 6.7.2, please ensure you note the existing login details and other configured properties for the Blue Prism server service so they can be re-applied after upgrade.
Required installation if upgrading to 6.7.3
If upgrading from Blue Prism 6.6 or earlier to 6.7.3, this release must be installed on all devices (clients, runtime resources, and application servers).
If upgrading from Blue Prism 6.7.0, 6.7.1, or 6.7.2:
- 6.7.3 must be installed on all interactive clients.
- 6.7.3 must be installed on all runtime resources.
- Devices running 6.7.3 can connect to application services running 6.7.0, 6.7.1, 6.7.2, or 6.7.3. Servers running 6.7.0 do not need to be updated to 6.7.3 other than to improve future upgrade behavior by addressing bg-5533, which was introduced in 6.7.0 and fixed in 6.7.1. If upgrading application services from 6.7.0 to 6.7.3, please ensure you note the existing login details and other configured properties for the Blue Prism server service so they can be re-applied after upgrade.
Ensure the new setting for Chrome, Edge, and Firefox is appropriate
From 6.8 onwards, the Blue Prism browser extensions will, by default, dynamically select a port from the ephemeral range to communicate with Blue Prism. This removes the need for administrators to configure a defined port on every machine to ensure Blue Prism can automate browsers effectively, and improves the stability of the extension.
In the following situations users should still use a fixed browser extension port by enabling the new system setting Use fixed browser extension port (31924) only:
- When using Blue Prism with older versions of the browser extension – This will only be the case when policies have been configured to prevent the automatic installation of newer versions of the browser extension, or where Blue Prism is operating in an offline environment and a new version of the extension is not deployed at the same time as the product is upgraded.
- When attaching to instances of browsers launched manually or not launched by using a Blue Prism object model.
Any runtime resources used to run processes which automate Chrome, Edge, and Firefox need to be restarted when changing this setting.
See System Settings for more details.
Chrome browser extension must be manually installed for use with Microsoft Edge
These steps are only required if upgrading to a version of 6.8. If upgrading to version 6.9 or later, there is no requirement to install the Edge browser extension manually as it can be selected for automatic installation from the Blue Prism installer from 6.9 onwards.
To use the Blue Prism Chrome browser extension with Chromium-based versions of Microsoft Edge, the extension must be manually installed as follows:
- In Edge, enter edge://extensions in the address bar.
- Select the Allow extensions from other stores setting.
- Navigate to the Chrome store and search for the Blue Prism Browser Extension. Alternatively use this URL.
- Click Add to Chrome.
See Install Blue Prism browser extensions for more details.
Firefox browser extension for use with Firefox version 74 and later must be manually installed
This notice is only valid when upgrading to 6.8. If upgrading to 6.9 or later it is recommended to follow the method outlined in Upgrading from versions prior to 6.9.
The Blue Prism Firefox extension is installed automatically when selected during a custom Blue Prism installation or upgrade. However, for applications and websites using Firefox version 74 or later, the extension must be installed manually as follows:
- In Firefox, enter firefox://about:addons in the address bar.
- From the tools menu, select Install Add-on from File.
- From the Blue Prism install directory (typically C:\Program Files\Blue Prism Limited\Blue Prism Automate), select the FirefoxPlugin.xpi file.
Click Add and follow the additional prompts to complete the installation.
A notification displays when installation is complete and the Blue Prism extension icon is added to the Firefox toolbar. See Install Blue Prism browser extensions for more details.
Blue Prism native authentication environments updated to support multi-authentication
The new multi-authentication environment builds on the existing Blue Prism native authentication, and all Blue Prism native authentication environments will be updated to support multi-authentication when upgrading to 6.8. No action is required to continue using Blue Prism as before.
This new capability allows users to optionally associate Blue Prism with an Active Directory Domain Services infrastructure where administrators can set up user access to Blue Prism using Single Sign-on. This provides an environment with a mixture of users that use either Blue Prism native authentication or Active Directory Single Sign-On.
The compiler used to validate code stages written in C# and Visual Basic has been updated for this release. Because the new code compiler enforces modified syntax validation rules, code stages already written in C# and Visual Basic may generate syntax errors. It is recommended that code stages created in a previous release of Blue Prism are re-validated following upgrade. See 6.8 release notes for more details.
Manually installed versions of the Blue Prism browser extension for Chrome and Edge must be removed before upgrade if manually installed
If a previous version of the Blue Prism browser extension for Chrome and Edge has been manually installed from the browser web store (and not automatically during Blue Prism installation), it is necessary to manually remove the extension prior to a 6.9 upgrade. Please refer to the installation instructions relevant to each browser.
The Blue Prism Firefox extension is installed automatically when selected during an advanced Blue Prism installation or upgrade. However, for applications and websites using Firefox version 74 or later, the extension must be installed manually from the Firefox add-ons store as follows:
- Open Firefox.
- Paste the following URL into the address bar of the browser: https://addons.mozilla.org/en-GB/firefox/addon/blue-prism-6-9-extension/
- Click Add to Firefox and confirm the installation when prompted.
A notification displays when installation is complete and the Blue Prism extension icon is added to the browser toolbar.
Code stages need to be re-validated
The compiler used to validate code stages written in C# and Visual Basic was updated in Blue Prism 6.8. It is recommended that code stages created in a release of Blue Prism prior to 6.8 are re-validated following the upgrade. See 6.8 upgrade notices for more details.
Changes to communication between browser extensions and Blue Prism
The communication between Blue Prism and browser extensions used for natively automating Chrome, Edge, and Firefox has been updated as follows:
- When upgrading from Blue Prism versions earlier than 6.8 – The communication is via a fixed port by default (the Use fixed browser extension port (31924) only system setting is selected by default).
- When upgrading from Blue Prism version 6.8 and later:
If the setting has been manually set (irrespective of its value), then the setting will be retained.
If the setting has not been manually set, the Use fixed browser extension port (31924) only system setting is unselected by default and the communication will be via an ephemeral port.
Existing processes and business objects will not be affected by this change after upgrading. System administrators performing the upgrade should check whether the Use fixed browser extension port (31924) only system setting is either selected or unselected based on their deployment scenario.
Edge browser extension no longer needs to be enabled separately after Blue Prism installation
The Edge browser extension is now fully installed if selected on the Advanced install screen during Blue Prism installation. Previously, it was necessary to enable the extension separately in the Edge browser once the Blue Prism installation had completed.
Memory usage optimization could cause performance latency when opening and saving complex processes
This release includes improvements to reduce unnecessary memory usage while running automations. However, this may cause some additional performance latency when opening and saving complex processes which contain a high volume of dependencies, such as stages, data items, pages, objects, and environmental variables. Overall, the memory footprint for complex processes is now reduced compared to previous versions.