Subscribe

UiPath Automation Suite

The UiPath Automation Suite Guide

Configuring Microsoft SQL Server

Databases


Each product in Automation Suite requires its own SQL database with corresponding specifications.

By default, the installer creates all the databases for you during the installation process. You must provide the necessary permissions for the installer to do so on your SQL server.

Alternatively, you have the option to create your own databases. Refer to the following table for the names you need to use.

The following table lists out the database names and their corresponding format.

Product / serviceDefault database nameConnection string format
Shared Platform CapabilitiesAutomationSuite_PlatformADO.NET
OrchestratorAutomationSuite_OrchestratorADO.NET
Action CenterAutomationSuite_OrchestratorADO.NET
Automation Suite RobotsAutomationSuite_OrchestratorADO.NET
Automation HubAutomationSuite_Automation_HubADO.NET
Data ServiceAutomationSuite_DataServiceADO.NET
InsightsAutomationSuite_InsightsADO.NET
Test ManagerAutomationSuite_Test_ManagerADO.NET
Task MiningAutomationSuite_Task_MiningADO.NET
AI CenterAutomationSuite_AICenterJDBC
Document UnderstandingAutomationSuite_DU_DatamanagerODBC
Process MiningAutomationSuite_ProcessMining_Metadata
AutomationSuite_ProcessMining_Warehouse1
AutomationSuite_Airflow2
ADO.NET
PYODBC

1 AutomationSuite_ProcessMining_Warehouse uses both ADO.NET and PYODBC formats.
2 AutomationSuite_Airflow uses PYODBC connection string format. AutomationSuite_Airflow must have READ_COMMITTED_SNAPSHOT enabled when creating databases manually. The connection to the AutomationSuite_Airflow database can not begin with a { character.

🚧

Important!

If you manually set the connection strings in the configuration file, you can escape SQL, JDBC, or ODBC passwords as follows:

  • for SQL: add ' at the beginning and end of the password, and double any other '.
  • for JDBC/ODBC: add { at the beginning of the password and } at the end, and double any other }.

📘

Note:

You could use the databases in an elastic pool for better cost-effectiveness.


In the case of Apps, you cannot bring your own MongoDB.

 

Permissions


If you want the installer to create a database on the provided SQL server, then make sure to grant at least dbcreator role to the SQL account used to connect to the database.

If you wish to create your own databases for all the products, then the SQL account should be granted the db_owner role for all Automation Suite databases. If security restrictions do not allow the use of db_owner, then the SQL account should have the following roles and permissions on all databases:

  • db_ddladmin
  • db_datawriter
  • db_datareader
  • EXECUTE permission on dbo schema

 

SQL requirement for Full-Text Search


Document Understanding requires the SQL Server to have the Full-Text Search component of the SQL Server Database Engine, which is not always installed by default.

If you did not select Full-Text Search when you installed SQL Server, run SQL Server Setup again to add it before configuring Document Understanding.

For more info, check this guide on how to add/install features on SQL server. You can also check here all the components that can be added to the SQL Server, which includes also Full-Text Search.

 

SQL requirements for Insights


Insights requires SQL Server 2019, including support for columnstore index and .json functions.

For Azure SQL, ensure the database is S3 service objective or above.

Make sure the compatibility level for Insights database is set to 130 or higher. In most cases, the default settings meet this requirement. For more info, refer to View or Change the Compatibility level of a Database - SQL Server.

The installation validates both conditions and alerts you if minimum requirements are not met.

 

SQL requirements for Data Service


Data Service requires SQL Server version 2016 or higher.
The collation sequence is the same as the default one: Latin1_General_CI_AS.

If you create your own database using SQL Server version 2019 or higher, make sure to grant the following Data Service permissions to your users:

GRANT ALTER ANY SENSITIVITY CLASSIFICATION TO {userName};

GRANT VIEW ANY SENSITIVITY CLASSIFICATION TO {userName};

 

SQL requirements for Process Mining


Process Mining on Automation Suite requires a separate Microsoft SQL Server for the AutomationSuite_ProcessMining_Warehouse for data storage for Process Mining process apps. Below is an overview of hardware requirements and recommendations for setting up a Microsoft SQL Server database machine for AutomationSuite_ProcessMining_Warehouse.

To calculate the hardware requirements, you need to have an indication of:

  • the number of (million) events in your process.
  • the number of case and event fields in your output data. For example, in TemplateOne this would be 30.

📘

Note:

In a development environment, for performance reasons, it is recommended to work on a small development dataset with a limited number of records.

You can use the Capacity calculator to determine the hardware requirements for setting up a dedicated Microsoft SQL Server machine for Process Mining. When you add Process Mining to the Product section, the minimum requirements for 1 Dedicated SQL Server are displayed.

See also Hardware requirements.

 

SQL requirements for HA


For a high-availability configuration of your SQL Server, select an Always On availability group. For more info, refer to Overview of Always On availability groups.

Updated 2 months ago


Configuring Microsoft SQL Server


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.