Upgrading the minor version
Bizagi generates new versions periodically which include important improvements along with great new features, as described at Bizagi versions.
We strongly recommend that you upgrade your projects to the newest release, so that you can enjoy all the benefits of new Bizagi features, enhancements, major improvements and bug fixes (maintenance).
This section details how to carry out a software upgrade of your Bizagi version.
This procedure is applicable only when upgrading to the newest minor version (while in the same major release).
You must upgrade to this release from a Bizagi project already using a 11.2.0 version or higher.
If you have a lower version please contact Support.
Before you start
Before upgrading your project, keep in mid the following:
Projects using WS-Federation authentication
To keep compatibility with our cloud-based service, Automation Service, the updates to the 22.214.171.124x version does not change the Web.config file with the WS-Federation configuration. Before updating your project, change the authentication type to Bizagi. After you successfully update your project, configure the WS-Federation authentication type again.
Create a database backup file and copies of the folders and files by default at C:\BizAgi\Projects\[your_project]\WebApplication and
Although we recommend that you create your own backups of the project's environments, Bizagi automatically generates a backup of: the database, the Scheduler and the files used by the Work Portal before performing the upgrade.
In the event of a failure to upgrade, Bizagi rolls back to and restores the state of the environment by relying on these backups.
If you need these backup files, they are stored in the backup path (in a SQL Server local setup, this would be: C:\Bizagi\Projects\[your_project]\Backups), as shown in the image below:
When you use the SQL Server Database remotely, the path for backups is usually set on the database server as: C:\Program Files (x86)\Microsoft SQL Server\[MSSQL_instance]\MSSQL\Backup\.
In projects using Oracle as the Database, the backup path is as defined for that given Oracle instance (during initial project configuration) is the property BA_BACKUP_PATH.
Upgrade the development environment first
Always upgrade the development environment first.
We recommend that you perform unit tests in the Development environment after you have completed the upgrade to verify that existing processes behave as expected.
Once this is done, upgrade and perform user-acceptance tests for your Test environment.
After verifying that processes work as they should in both the development and the test environment, and depending on how critical your processes are, you may create a production-replica environment.
In Production-replica environment you can perform an upgrade and test your Production environment processes with live instances.
After ensuring that the production-replica environment processes and instances function as they should, upgrade your real Production environment.
A Production-replica environment is a Bizagi project which has the production backup restored into it.
It is not the real Production environment because Production parameters and other relevant information have not been modified to reflect the environment's location (for instance, the actual e-mail addresses of users, the SMTP Server or other URLs involved in integration points in the production, etc).
Confirm that all environments use the same Bizagi version
If you have not yet deployed your project into a production environment, you may disregard this consideration.
If your project has been already published into a production environment, upgrading your project in the development environment will eventually require that you also upgrade your project in the Test and Production environments.
The upgrade procedure is done separately for each environment, but you will need to plan upgrading all of them so that they use the same version:
If you do not do this, you will not be able to carry out deployments to publish your processes.
Plan the development environment's upgrade and coordinate them with your team
A version upgrade should be carried out with advance notice and coordination, so you upgrade the Bizagi servers, when team members are not working on the project.
Upgrade the Test and Production environments during non-working hours
A version upgrade will stop services (for approximately three minutes).
Do not upgrade your version if you have a pending Release Candidate to deploy into production
Before the upgrade, either apply the Release Candidate or cancel it.
If you have doubts on this steps, contact our support team.
Here is the upgrade procedure for each environments.
1. Development environment upgrade (Bizagi Studio)
To upgrade your project to the newest release, first upgrade your Bizagi Studio installation.
If the project is configured for multiple users (in a teamwork collaboration setup), perform the Bizagi Studio and project upgrade in the central development Bizagi Server where the project is hosted.
If your project was created using Windows Authentication, take into account that your user must have the same permissions explained in Creating a project using Windows Authentication.
1.1. Uninstall Bizagi Studio, using your computer's control panel option:
At this point your server may ask for a reboot.
1.2. Download and install the newest version of Bizagi Studio.
After the upgrade completes, reboot the server.
1.3. Upgrade your development environment project:
•Open Bizagi Studio and open the project.
Select it from the list of projects displayed in the window:
If the project is not listed, select the All Projects option:
•Confirm by clicking Yes when prompted about the project's upgrade:
Coordinate with team members and alert them in advance that you will be upgrading the project.
In this way you also make sure that no other team member is currently working on the project or has Bizagi Studio opened.
•When the upgrade is finished your project opens in Bizagi Studio.
At this point your project has been upgraded to the new version.
•Have all team members upgrade their Bizagi Studio installation.
At this point, you may proceed to run tests on the processes you have implemented in the development environment.
•Keep in mind that after upgrading the Bizagi Studio version, you should always reboot the host server.
•If you haven't checked your project's metadata with our support team already, perform a backup of your project. Then create a ticket in our Support website and send your backup. This is so the Support Team can check your project's metadata thoroughly to help you with a smooth migration on your other environments.
2. Test environment upgrade
Once you have verified that your processes behave as expected in the development environment, you can upgrade your other environments (first test, then the production replica environment if you use it, and finally, production).
Upgrade each environment following a similar procedure you used to update the Development environment, and with the same recommendations.
The overall procedure would be:
•Make backups and plan and coordinate the upgrade.
•Install the Automation Server release that matches the version of Bizagi Studio used by your development environment.
To install a newer release, first uninstall the current version, as described at Uninstall. Then install the newer version.
After uninstalling or installing, you may need to reboot your server.
•Once the newer version has been installed, upgrade the project using the Management Console.
In the Management Console you are presented with a similar procedure to what you used to upgrade the project with Bizagi Studio.
•Verify that your processes behave as expected.
3. Production environment upgrade
Complete this step only after confirming that user-acceptance tests had satisfactory results in your test environment.
This procedure is the same as performed for the test environment.
The same procedure also applies for a production-replica if you decide to set up such an environment.
Once again, upgrading this environment involves:
•Make backups and plan and coordinate the upgrade.
•Install the Automation Server release that matches the Bizagi Studio version used by your Development environment (by uninstalling the current version and then installing the newer one. and performing any required reboot).
•Upgrade the project in the environment, using the Management Console.
Review the .NET framework
Bizagi uses a .NET framework, as mentioned in the Bizagi system requirements. After upgrading, you can change the framework in the web.config file, To do so, go to the project folder, usually located at:
Open the web.config file, and within the <system.web> node, find the following tag:
<httpRuntime maxRequestLength="50000" maxUrlLength="1024" targetFramework="4.6.1" requestValidationMode="2.0" />
Make sure that the target framework is the same mentioned in the system requirements.