Introduction

This article describes how to upgrade to the latest version of BPA Platform.

IMPORTANT: Due to the number of new features in BPA Platform 2020 Update 1, if upgrading from version 4.6 you must upgrade your BPA Platform server instance first before attempting to upgrade any remote clients or agents. This reduces interruption to any runtime activity and the communication between server and remote client or agent.

Prior to version 4.6, all remote agents must be upgraded first.

You can no longer use a client running this version or higher to access a BPA Platform server running a lower version. Ensure all instances of BPA Platform (server, client, Email Trigger (SMTP)Closed The Email Trigger (SMTP) tool triggers a task to run based on the contents of incoming or outgoing mail sent via an SMTP mail server. Agent, Microsoft SQL Server TriggerClosed The Microsoft SQL Server Trigger tool uses the Microsoft® SQL Server™ trigger functionality to create a trigger on a table of a specified SQL data source. When a specified data modification is attempted, such as an attempt to add or delete a table row, the trigger then causes a task to run. Agent, and Workflow components) are upgraded to this release to make use of all available features.

Supported Upgrade Path

A single upgrade "jump" is not possible from version 4.1 to 2024; the upgrade must be completed in stages. Because of this, you can use this article when upgrading from any version to the latest — ensure you start the procedure from the version you are currently running.

Note: For the 2018 release, we rebranded “TaskCentre” as “BPA Platform”. This article refers to BPA Platform for all versions but note that you may still be running a TaskCentre version.

The supported upgrade path is as follows:

TaskCentre 4.1 (Build 300) to 4.5 SR4 (Build 1065)
TaskCentre 4.5 SR4 to 4.6 (Build 1944)

From this point on, the order of upgrading BPA Platform components is different but the upgrade path must be adhered to:

TaskCentre 4.6 to BPA Platform 2018 (Build 4031) — Note that the same procedure applies when upgrading from 4.7 to 2018
BPA Platform 2018 (Build 4031) to 2020 (Build 6333) — Note that the same procedure applies when upgrading from 2018 Update 1 to 2020
BPA Platform 2021 (Build 6618) or higher to 2024  (Build 8750)

NOTE: The minimum supported operating system is Windows Server 2008 SP2 (64-bit edition) — see System Requirements. If you are using an unsupported operating system, you must upgrade this first before continuing.


Upgrade Considerations

Note the following before performing the upgrade:

Anti-Virus Considerations

If you find your upgrade does not progress beyond the “Begin execution” stage, it may be that your anti-virus software is preventing the Installation Console from writing to the hard drive. In such cases, it is recommended you disable your anti-virus scanner or any security software during the upgrade time.

BPA Platform Services Considerations

As part of the upgrade process, all BPA Platform services are re-registered — this also changes the user the services run under back to Local System. If, for previous versions, you had BPA Platform services running under a different user, you must go into Windows Server Administration and change them back to the required user.

Be aware that from version 2020 onwards, service names are encapsulated in quotes for new installations; upgraded systems honour the previous configuration of no encapsulation. To make use of this feature, you must perform a “manual” upgrade:

  1. Backup the BPA Platform store.
  2. Uninstall your existing BPA Platform.
  3. Install BPA Platform 2024.
  4. In the ConfiguratorClosed You use the Configurator to install third-party software that may be required by available tools. Connection to required agents are also configured here. Note that you can only launch the Configurator if logged into the machine with Administrator rights., re-connect to your store.

For more information, contact our Support Desk or your Codeless Platforms partner.

Database Collation Considerations

If upgrading a BPA Platform installation that uses an existing Microsoft SQL Server store, consider the database collation used by the store. If using a case-sensitive database collation for the store’s database, you may encounter multiple errors for the BPA Platform ScheduleClosed The Schedule tool is used to trigger a task to run based on a date and time schedule. Any number of Schedule steps can be created for a task. service. If so, we recommend you switch to the non-case-sensitive version of the database collation. For example, from “Latin1_General_CS_AS” to “Latin1_General_CI_AS”.

Log File Considerations

If your current set of BPA Platform log files are substantial, you should be aware the next maintenance run may take a long time to complete — depending on machine performance, this may process at a rate of 4 GB per hour. You can avoid this delay by truncating the logs — if you are unsure how to carry this out, contact our Support Desk, your account manager, or business partner.

Upgrading from BPA Platform 2018 Update 1 Hotfix KB46432

If upgrading from BPA Platform 2018 Update 1 Hotfix KB46432, be aware that some BPA Platform services may require a manual restart once the upgrade has completed. Go to Control Panel > Administrative Tools > Services and check those services that start with BPA Platform.

Upgrading Remote Clients to BPA Platform 2020 Update 1

Due to the number of new features in this release, you can no longer use a client running BPA Platform 2020 Update 1 or higher to access a BPA Platform server running a lower version. Ensure all instances of BPA Platform (server, client, Email Trigger (SMTP) Agent, Microsoft SQL Server Trigger Agent, and Workflow components) are upgraded to the same version to make use of all available features.


Pre-Upgrade Preparation

It is recommended you perform the following before starting the upgrade, no matter what version you are upgrading from:

Disable All Tasks

If you have a fairly small number of tasks on your BPA Platform server, disable each one. This prevents them from running before the configuration has been checked post-upgrade which may cause task failures. This is the recommended procedure to follow.

If you have a large number of tasks, disable the BPA Platform Schedule Agent service. This is the service responsible for executing tasks; disabling this ensures tasks will not fire until you re-enable this service.

Backup the BPA Platform Store

If your BPA Platform installation makes use of an internal store, make a copy of the c:\iwdb folder (note that a custom location may have been specified at installation time; refer to the Server > Store > Internal Store Location node in the Configurator.

If your BPA Platform installation makes use of a SQL Server-hosted store, a backup is not required as this database should be included in your database administrator's backup routine.

Backup any Separately Installed BPA Platform Data Connector Tools

It is recommended you take a backup of any configuration you have for separately installed Data Connector tools (typically, those developed using the BPA Platform Tool SDK).

If running an older version of the Data Connector tool, bear in mind that these may require upgrading after you have completed upgrading BPA Platform. For a detailed description of the supported tools, refer to our Supported Tools Matrix.

Windows Updates

Pending Windows updates can delay the upgrade. Consider rebooting your BPA Platform computer first to ensure any postponed Windows updates are completed before starting the upgrade process.

Close All Instances of the BPA Platform Client

The installation process cannot continue while a BPA Platform client is open and logged into the server. Ensure you close all instances, both local and remote, before starting the upgrade.


Required Software

Contact our Support department or your account manager or business partner for a copy of the following releases (these are available by request only):

TaskCentre 4.5 SR4 (Build 1065)
TaskCentre 4.6 (Build 1944)

Download copies of the following software (note that a Codeless Platforms account is required to access these pages):

BPA Platform 2018 (Build 4031)
BPA Platform 2021 (Build 6618)

Ensure you extract all zip files to a folder on the BPA Platform server.

TIP: Consider extracting the zip files to a portable device as you must also upgrade remote agents and clients. It is not recommended you extract the files to a shared network location — any network lag may cause the upgrade process to time out.


Upgrading from Version 4.1 to 4.6

This section describes how to upgrade all aspects of your BPA Platform installation to version 4.6 from version 4.1.

Due to a change in the agent architecture in version 4.6, when upgrading from version 4.5 SR4 and 4.6, you must upgrade the Microsoft SQL Server Trigger Agent first. Because of this, we recommend performing this part of the upgrade in the following sequence:

  1. Upgrade the remote Microsoft SQL Server Trigger Agent and any other remote agents (Email Trigger (SMTP) and Workflow Job TriggerClosed The Workflow Job Trigger tool triggers a task to run when responses from Workflow Jobs match criteria specified in one or a number of filters.) — go to Upgrading Remote Agents
  2. Upgrade the BPA Platform server — go to Upgrading the BPA Platform Server
  3. Upgrade any remote BPA Platform clients — go to Upgrading Remote Clients

Upgrading Remote Agents

TIP: Any agents installed locally on the BPA Platform server are upgraded at the same time as the server; if your installation only makes use of local agents, this stage can be skipped — go to Upgrading the BPA Platform Server.

Due to a change in the agent architecture in version 4.6, you must upgrade the Microsoft SQL Server Trigger Agent first. Although the Email Trigger (SMTP) Agent (formerly the SMTP Agent) and the Workflow Job Trigger Agent (formerly the Workflow Job Agent) can be upgraded after the server, it is recommended you upgrade these now.

Are you running a version between TaskCentre 4.1 and 4.5 SR4?


Upgrading the BPA Platform Server

TIP: All BPA Platform components found on the server are upgraded at the same time to avoid crucial agents being out of sync.

Are you running a version between TaskCentre 4.1 and 4.5 SR4?


Upgrading Remote Clients

TIP: The BPA Platform client installed locally on the BPA Platform server is upgraded at the same time as the server; if your installation only makes use of the local client, this stage can be skipped.

Are you running a version between TaskCentre 4.1 and 4.5 SR4?



Upgrading from Version 4.6 to 2024

This section describes how to upgrade all aspects of your BPA Platform installation to version 2024 from version 4.6.

Due to the number of new features introduced in BPA Platform 2020 Update 1, when upgrading from version 4.6 you must upgrade your BPA Platform server instance first before attempting to upgrade any remote clients or agents. This reduces interruption to any runtime activity and the communication between server and remote client or agent.

Because of this, we recommend performing this part of the upgrade in the following sequence:

  1. Upgrade the BPA Platform server — go to Upgrading the BPA Platform Server
  2. Upgrade the remote Microsoft SQL Server Trigger Agent and any other remote agents (Email Trigger (SMTP) and Workflow Job Trigger) — go to Upgrading Remote Agents
  3. Upgrade any remote BPA Platform clients — go to Upgrading Remote Clients
  4. Test BPA Platform — go to Post-Upgrade Tasks

Upgrading the BPA Platform Server

TIP: All BPA Platform components found on the server are upgraded at the same time to avoid crucial agents being out of sync.

Are you running a version between TaskCentre 4.6 and BPA Platform 2018?

Upgrading Remote Agents

TIP: Any agents installed locally on the BPA Platform server are upgraded at the same time as the server; if your installation only makes use of local agents, this stage can be skipped — go to Upgrading the BPA Platform Server.

Due to a change in the agent architecture in version 4.6, you must upgrade the Microsoft SQL Server Trigger Agent first. Although the Email Trigger (SMTP) Agent (formerly the SMTP Agent) and the Workflow Job Trigger Agent (formerly the Workflow Job Agent) can be upgraded after the server, it is recommended you upgrade these now.

Are you running a version between TaskCentre 4.6 and BPA Platform 2018?

Upgrading Remote Clients

TIP: The BPA Platform client installed locally on the BPA Platform server is upgraded at the same time as the server; if your installation only makes use of the local client, this stage can be skipped.

Are you running a version between TaskCentre 4.6 and BPA Platform 2018?


Post-Upgrade Tasks

Note: As part of the upgrade process, all BPA Platform services are re-registered — this also changes the user the services run under back to Local System. If, for previous versions, you had BPA Platform services running under a different user, you must go into Windows Server Administration and change them back to the required user.

Testing BPA Platform 2024

As with any change to your BPA Platform installation, you should verify that everything has been successful. The following tests are only recommendations and should not be taken as a full test plan:

Launch the BPA Platform client and click BPA Platform - About (About). Ensure the version and build numbers are correct:

BPA Platform 2024

Do the same for any remote clients.

Ensure all task folders, tasks, users, variables, repositoriesClosed Repositories are used by the Internal Memory feature to store memorised data in BPA Platform's proprietary database format., and so on are still available.
Open the global configuration for all tools and ensure the setup and connections persist.
Ensure all previously registered agents are still registered.
Open the Event Log and check for any possible errors.
Enable your disabled tasks and run a sample of them to ensure output is still correct.