SQL Server prerequisites

<< Click to Display Table of Contents >>

Navigation:  Automation Server > Automation Server configuration and administration guide > System prerequisites > Database server prerequisites >

SQL Server prerequisites


Automation Serveruses a database server to store your processes and their related data.

Microsoft SQL Server is supported for database server configuration.

You need to install and set up a SQL Server instance, ensuring you comply with the information below.


Supported versions and editions

The following are supported:




SQL Server 2017


SQL Server 2016, service pack 2

13.0.5026 or above

SQL Server 2016, service pack 1

13.0.4001 or above

SQL Server 2014

12.0.2000 or above

SQL Server 2012

11.0.2100 or above

SQL Server 2008 R2, service pack 2

10.50.4000 or above

SQL Server 2008, service pack 3

10.00.5500 or above


For Automation Server, supported editions are Standard or higher.

SQL Azure is not supported.



The database instance must be set up with a collation which:

Is case-insensitive (CI).

Is not a Turkish collation


Required configuration

Configuring a SQL Server instance to work with Bizagi, requires the following:


SQL Server in mixed mode authentication

Make sure that SQL Server authentication mode is enabled for your database instance (in mixed mode), at least initially to create a Bizagi project. You may later choose to authenticate users based on Windows authentication.


TCP/IP protocol enabled

Make sure the TCP/IP protocol is enabled for your instance, and check for recommended settings such as establishing an explicit TCP/IP port (instead of using dynamic ports) and allowing remote connections when needed.


Authorized login accounts

You need one authorized login account using SQL Server authentication and having the required rights for processes execution (for Bizagi's database).

A separate login account having sysadmin rights is required for administration tasks.


Verifying SQL Server prerequisites

Carry out these steps, to make sure that your SQL Server instance is set to work with Bizagi.


Before you start

To verify the configuration of your SQL Server instance (or to set it up), you need these SQL Server client and configuration tools.

SQL Server Management Studio and SQL Server Configuration Manager.

Both tools can be included when installing the SQL Server database. If your SQL Server version does not include the SQL Server Management Studio, you may download and install it directly from Microsoft's official web site at no cost.


Which version do I have?

To determine the version of an installed SQL Server, use the SQL Server Management Console.

Run the following command while connected to your database instance:

Select @@version




This shows you information about your instance:

The product's official name and service pack

The exact version number and its date

Additional details about the SQL Server edition and bit support.





Required configuration

Check or configure the following requirements.


1. SQL Server in mixed mode authentication

Run the SQL Server Management Studio.

Right-click to select its properties:




In the Security option, make sure that the SQL Server and Windows Authentication Mode is checked and then click OK.




2. TCP/IP protocol enabled

Run the SQL Server Configuration Manager.




Enable the TCP/IP protocol for your database connection by locating the specific database instance (under the SQL Server Network Configuration).

Right-click on this protocol and select Enable:



We recommended that the TCP port be explicitly defined (by default as 1433), so that dynamic ports are not used by the instance:





You may want to make sure that the SQL Server Browser service is in Running mode as well:





Changing these settings may require restarting your database service.

The TCP/IP port configuration requires that there is no firewall rule or corporate security software blocking the port used for your database connection.


For remote connections, configure the Allow remote connections property.

This property can be reviewed or activated through the SQL Server Management Studio, and in the database instance's properties.

Under the Connections option, make sure that this property is selected:




3. Authorized login accounts

While using the SQL Server Management Studio, make sure you can rely on an account that has sysadmin rights (e.g., with the sa default role).

With this account, you can create the Bizagi database.


We recommend having two types of users:

Sysadmin user for the Management Console.

Public user for Work Portal and the Scheduler.


Sysadmin account for the Management Console

You can configure a different account to administer for the Bizagi database.




Public user for Work Portal and Scheduler

Make sure you create or verify that the login account you will use for Bizagi Engine meets the following conditions:


The login account uses SQL Server authentication mode:




The server roles specified for this login must include: public.




The login must include the following user mapping items for that specific database: db_datareader, db_datawriter, public, rlBA_SQL_BizagiWebApp and rlBA_SQL_ExecuteBizagiSPs.





The db_datareader, db_datawriter, public, rlBA_SQL_BizagiWebApp and rlBA_SQL_ExecuteBizagiSPs user mappings apply for your project's database. This means that you need to apply these mappings once your Bizagi production environment database has been created.


Recall that in order to create that Bizagi database, you need to have previously used a sysadmin account.


Check that the login is enabled and not locked out:




You may modify or review that this SQL Server account login, is used in the connection string of the Work Portal and the Scheduler connections, by editing their corresponding configuration files.



The connection for the Work portal is modified, by editing the web.config located at the Web application folder of the given project environment (by default at C:\Bizagi\Projects\[PROJECT_NAME]\WebApplication).

The connection for the Scheduler service is modified, by editing, the Bizagi.Scheduler.Services.exe.config file located at the Scheduler folder of the given project environment (by default at C:\Bizagi\Projects\[PROJECT_NAME]\Scheduler).

This connection is specified in both of the above into the following key:

<add key="DSNDB" value="Current Language=us_english;Initial Catalog=[MY_PROJECT_DATABASE];Data Source=[MY_SQL_SERVER_INSTANCE];User ID=[MY_NEW_LOGIN];Password=[MY_LOGIN_PASSWORD];" />


Updating a project

When you are updating a project additional from the access rights mentioned in the previous section, you need the following:


Server privileges

Set the user with privileges to backup and create the database





Open the Securables section, select the Effective tab and make sure that you have the following permissions;