Previous considerations and requirements

<< Click to Display Table of Contents >>

Navigation:  Automation Server > Automation Server configuration and administration guide > Initial project configuration > Deployment of processes and new versions >

Previous considerations and requirements


Before carrying out a process deployment in Bizagi, review the following considerations and requirements either if planning to use the One-click feature or the Advanced Deployment.

Consider as well the technical requirements which apply only to the One-click Deployment.

For more information about Deployment in Bizagi refer to Deployment of processes and new versions.


Before you start

Consider that if you will be running your processes in a .NET platform, the use of IIS Express is not supported.

Recall that the bundled IIS Express server in Bizagi Studio enables quick prototyping capabilities or allows you to use a simpler server to verify, demo/present, or do unit tests on your processes implementations.

Though this server was not designed to be used in a production environment, since such environment demands a more robust server. Instead, it is strongly recommended to use the IIS as featured by the Windows operating system, even in a development environment.


1. General requirements regarding the processes implementation

Consider the below regardless of the type of Deployment chosen.


1.1 Processes check-in

Ensure that the Processes versions planned for the deployment are all checked-in in the Development environment.

To do so, in Bizagi Studio select the Expert View, and click on the Processes module.

Processes to be deployed should be all checked-in. This may be confirmed if no one else is working on the model, and if the Processes can be checked-out:





Make sure you coordinate the deployment with other team members of your project, so they are aware of this procedure schedule and can agree which Bizagi Processes versions will be deployed (these must be checked-in).


1.2. Acknowledging how and which objects are deployed

Bizagi handles deployment differently according to what is, or is not, taken  to the Production environment. Furthermore, some experience objects might require special attention when required for deployment.


It is important to understand the deployment behavior and features as it varies according to the selected module (Entities, Security, Systems, etc.).


For instance, Parameter Entities have a special configuration in which you can select individually each attribute to be deployed.

Click for more information about how Bizagi deploys the objects and modules.



2. Technical requirements

Consider the below regardless of the type of Deployment chosen.


2.1 Environments upgraded to the same Bizagi version  

When the deployment is not the first deployment to the same environment (Test or Production already exist), it is required that the Development, and the target environment (Test or Production) projects are updated to have the same Bizagi release.


To ascertain the version of a project, use the Management Console options to see the project's information:





2.2 Database servers having the same Database version.

The Database instance of the Test or Production environment need to have the same Database version as that of the Database Server in Development.


For Microsoft SQL Server, it means applying the same major version and service packs:




For Oracle, the servers must have the same version and the same release number:





2.3 Database servers having the same character settings

The Database Instance of a Test or Production environment needs to have the same character settings as that defined for Development.


If using Microsoft SQL Server, the server collation must match:




For Oracle, the database servers must have the same character set configuration:






3. Specific technical requirements of the One-click Deployment

The following are technical requirements to use the One-click Deployment feature in Bizagi Studio, given that this Deployment is carried out in an online manner and with assistance of Bizagi.


3.1 Automation Server must be installed in the target environments

In order to perform a deployment to a test or production environment, it is required to previously install Automation Server in that target server.

The installed Automation Server version must match the version of the Bizagi Studio installed in the Development environment.


3.2 Development server having network access to the target server

Since the One-click Deployment is done in an online manner, for this procedure it is required that the Development Server can access the Test or Production environment servers (both the server having Bizagi and the database server).

It is recommended to verify that there are no firewall configuration blocking the ports involved in Bizagi's Deployment.


For the connection from the Development server to the test or production Bizagi server:

TCP port number 5679.

UDP 50051, 50052, 50053.

The TCP port defined to be used in the response communication (from the test or production Bizagi server back to the Development server).

This port is specified within the BizagiStudio.exe.config file located at the Bizagi Studio installation folder of your Development environment (which is by default located at: C:\Program Files\Bizagi\Studio\BizagiStudio).

The TCP response port is by default 0, which means that it will be a random port.


To edit this port's value by setting a port number allowed in your infrastructure configuration, in the defined value of the channel element of this configuration file.




For the connection to the Test or Production Database Server, ensure that the port defined for the database service connection is allowed from the test or production Bizagi server.

The default port for SQL Server instances is 1433, while the default port for Oracle is 1521.


3.3 Authorized credentials for the target server

When deploying Processes to either Test or Production, Bizagi will create a new project in the target server.

The Windows user performing the deployment requires authorized credentials.


This means having an account which belongs to the Administrators and Bizagi group at that server, or having the credentials of an account that meets these conditions.