SQL database

Important:

Only Microsoft ODBC Driver 17 is supported.

Unless otherwise specified in the dedicated requirements sections, these requirements are applicable to all Automation Suite products.

You must bring an external SQL server to install Automation Suite and UiPath® products. Microsoft SQL Server 2016, 2017, 2019, and 2022 Standard and Enterprise editions are supported.

Important:

SQL Server 2016 and 2017 are not supported in the Automation Suite versions from 2023.10.6 to 2023.10.8. All SQL versions are supported starting with Automation Suite versions 2023.10.9 or higher for all applications except Insights.

Additional Microsoft SQL platforms, such as Azure SQL Database, Azure SQL Managed Instance, or Amazon Relational Database Service, are also supported as long as the Microsoft SQL Server database engine meets the requirements. For details, refer to Compatibility matrix.

Note:

If Process Mining is enabled and you want to use the latest version of Airflow, PostgreSQL is required for the AutomationSuite_Airflow database. (Version 2023.10.9 or higher.) Refer to SQL requirements for Process Mining for more information.

Note:

Make sure that the SQL server can be accessed from the cluster nodes.

Individual product support varies.

For each product you plan to deploy, you must:

• check the supported version of SQL Server as required by the product;
• meet the SQL Server configuration requirements, including SQL Server User permissions, as required by the product.

Hardware requirements

The general minimum hardware requirements for Microsoft SQL Server are as follows:

• 8 (v-)CPU
• 32 GB RAM
• 256 GB SSD

The minimum requirements are general guidance and do not guarantee reliable operation in a production deployment. Capacity planning is required to determine the hardware requirements that are needed for reliable operation. For details, refer to Capacity planning.

Each UiPath® product requires its own SQL database.

Database creation workflow

The interactive installer automatically creates databases using the following workflow:

1. The interactive installer script checks the value of the sql.create_db parameter in the input.json file.

   • If the sql.create_db parameter is set to true, the installer automatically generates all the databases on your behalf. In this case, the installer uses the default database names and default templates, and ignores any custom database names you provided.

     For details, refer to Automatically create the necessary databases.

   • If sql.create_db is set to false, you must bring your own databases. In this case, you must manually set up your databases. Note that you can use custom database names, provided that you follow the provided naming conventions. This step is critical because we use the database name in conjunction with the connection template to form the database connection string. If you do not follow the recommended naming convention, you must provide the SQL connection strings yourself.

     For details, refer to Bring your own databases.

2. The interactive installer generates the connection strings as follows:
   • If you did not define a connection string for your service, the installer uses the connection template to generate all database connection strings.
   • If you defined a connection string for your service, the installer uses the provided connection string for your database.

Automatically create the necessary databases

Important:

For Process Mining on Automation Suite 2023.10.9 or higher, using PostgreSQL for the Airflow database is the recommended option. If you choose to use a PostgreSQL database, you need to manually create the PostgreSQL database for AutomationSuite_Airflow before installing or upgrading to Automation Suite 2023.10.9 or higher. The PostgreSQL database for Airflow will not be created automatically by the installer.

For details, refer to SQL requirements for Process Mining.

If you want the installer to create the databases, fill in the following fields of the input.json file:

Parameter	Description
sql.create_db	Set to true to allow the installer to create the databases. Note that the installer uses the default database names and default templates, and ignores any custom database names you provided.
sql.server_url	FQDN of the SQL server, where you want the installer to configure database.
sql.port	Port number on which a database instance should be hosted in the SQL server.
sql.username	Username / user ID to connect to the SQL server.
sql.password	Password of the username provided earlier to connect to the SQL server.

Note:

• Ensure the user has the dbcreator role. This grants them permission to create the database in SQL Server. Otherwise, the installation fails.
• Automatically creating the necessary databases does not work in combination with directory authentication. If you use directory authentication, you must bring your own databases.
• ODBC connection does not support usernames that contain special characters. For database usernames for AI Center, Document Understanding, and Apps, use only uppercase and lowercase letters.

Bring your own databases

If you choose to bring your own databases for a new Automation Suite installation, we strongly recommend setting up new databases rather than using existing ones. This precaution is necessary to prevent any conflicts with the operation of Automation Suite that might occur due to leftover metadata from old databases.

If you bring your own database, you must provide the SQL connection strings for every database. Automation Suite supports the following SQL connection string formats:

Note:

For Document Understanding, make sure that you are using the same database, unless otherwise explicitly stated. Specific connection strings are assigned to various services and jobs that connect to the same database.

Parameter	Description	Products
sql_connection_string_template	Full ADO.NET connection string where Catalog name is set to DB_NAME_PLACEHOLDER. The installer will replace this placeholder with the default database names for the installed suite services.	Platform Orchestrator Automation Suite Robots Test Manager Automation Hub Automation Ops Insights Task Mining Data Service Process Mining Document Understanding
sql_connection_string_template_jdbc	Full JDBC connection string where database name is set to DB_NAME_PLACEHOLDER. The installer will replace this placeholder with the default database names for the installed suite services.	AI Center
sql_connection_string_template_odbc	Full ODBC connection string where database name is set to DB_NAME_PLACEHOLDER. The installer will replace this placeholder with the default database names for the installed suite services.	Document Understanding Apps
sql_connection_string_template_sqlalchemy_pyodbc	Full SQL alchemy PYODBC connection string where database name is set to DB_NAME_PLACEHOLDER. The installer will replace this placeholder with the default database names for the installed suite services.	Document Understanding Process Mining
postgresql_connection_string_template_sqlalchemy_pyodbc	Full SQL alchemy PSYCOPG2 connection string where database name is set to DB_NAME_PLACEHOLDER. The installer will replace this placeholder with the default database names for the installed suite services.	Process Mining (2023.10.9 or newer)

If you manually set the connection strings in the configuration file, you can escape SQL, JDBC, ODBC, or PYODBC 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 }.
• for PYODBC: username and password should be url encoded to account for special characters. Document Understanding database passwords cannot start with {.

The AutomationSuite_ProcessMining_Airflow database for Process Mining product must have READ_COMMITTED_SNAPSHOT enabled.

By default, TrustServerCertificate is set to False, and you must provide an additional CA certificate for the SQL Server. This is required if the SQL Server certificate is self-signed or signed by an internal CA. If you do not provide the SQL Server certificate in this scenario, the prerequisite check will fail.

Connection string templates

sql_connection_string_template

The following is an example value:

Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net:1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=[e-mail];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;

sql_connection_string_template_jdbc

The following is an example value:

jdbc:sqlserver://sfdev1804627-c83f074b-sql.database.windows.net:1433;database=DB_NAME_PLACEHOLDER;user=testadmin;password=***;encrypt=true;trustServerCertificate=false;Connection Timeout=30;hostNameInCertificate=sfdev1804627-c83f074b-sql.database.windows.net"

sql_connection_string_template_odbc

The following is an example value:

SERVER=sfdev1804627-c83f074b-sql.database.windows.net,1433;DATABASE=DB_NAME_PLACEHOLDER;DRIVER={ODBC Driver 17 for SQL Server};UID=testadmin;PWD=***;MultipleActiveResultSets=False;Encrypt=YES;TrustServerCertificate=NO;Connection Timeout=30;"

sql_connection_string_template_sqlalchemy_pyodbc

The following is an example value:

mssql+pyodbc://testuser%40sfdev3082457-sql.database.windows.net:[e-mail]:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"

postgresql_connection_string_template_sqlalchemy_pyodbc

The following is an example value:

postgresql+psycopg2://<user>:<password>@<host>:<port>/DB_NAME_PLACEHOLDER

Process Mining combined templates

Use the following examples when Process Mining requires both an SQL and a PostgreSQL template at the same time.

The following example combines sql_connection_string_template with postgresql_connection_string_template_sqlalchemy_pyodbc:

"sql_connection_string_template": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=[e-mail];Password='07<l[xj-=~:z`Ds&nl';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"

"postgresql_connection_string_template_sqlalchemy_pyodbc ": 
"postgresql+psycopg2://<user>:<password>@sfdev4515230-postgresql.database.windows.net:5432/DB_NAME_PLACEHOLDER"

The following example combines sql_connection_string_template with sql_connection_string_template_sqlalchemy_pyodbc:

"sql_connection_string_template": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=[e-mail];Password='07<l[xj-=~:z`Ds&nl';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"

"sql_connection_string_template_sqlalchemy_pyodbc": "mssql+pyodbc://testadmin%40sfdev4515230-sql.database.windows.net:07%3Cl%5Bxj-%3D~[e-mail]:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"

Default database names

{
  "orchestrator": "AutomationSuite_Orchestrator",
  "orchestrator_ta": "AutomationSuite_Orchestrator",
  "asrobots": "AutomationSuite_Orchestrator",
  "orchestrator_upd": "AutomationSuite_Platform",
  "platform": "AutomationSuite_Platform",
  "test_manager": "AutomationSuite_Test_Manager",
  "automation_ops": "AutomationSuite_Platform",
  "automation_hub": "AutomationSuite_Automation_Hub",
  "insights": "AutomationSuite_Insights",
  "integrationservices": "AutomationSuite_Integration_Services",
  "studioweb": "AutomationSuite_StudioWeb",
  "task_mining": "AutomationSuite_Task_Mining",
  "dataservice": "AutomationSuite_DataService",
  "aicenter": "AutomationSuite_AICenter",
  "documentunderstanding": "AutomationSuite_DU_Datamanager",
  "processmining_airflow": "AutomationSuite_Airflow",
  "processmining_metadata": "AutomationSuite_ProcessMining_Metadata",
  "processmining_warehouse": "AutomationSuite_ProcessMining_Warehouse",
  "apps": "AutomationSuite_Apps"
}

Note:

If you want to override the connection string for any of the mentioned services, set the sql_connection_str for that specific service.

You still have to manually create these databases before running the installer.

Process Mining

The connection string names differ depending on whether you use templates or bring your own database:

Type	Template	Bring your own
SQL	sql_connection_string_template	sql_connection_str
PostgreSQL	postgresql_connection_string_template_sqlalchemy_pyodbc	sqlalchemy_pyodbc_sql_connection_str
SQL Server (PYODBC)	sql_connection_string_template_sqlalchemy_pyodbc	sqlalchemy_pyodbc_sql_connection_str

If you bring your own database and configure it using sql_connection_str and sqlalchemy_pyodbc_sql_connection_str in the processmining section of input.json, the template connection strings are ignored.

Set MultiSubnetFailover=True for sql_connection_str and master_sql_connection_str and MultiSubnetFailover=Yes for sqlalchemy_pyodbc_sql_connection_str connection strings. Note that for pyodbc you use '=Yes' instead of '=True'.

Depending on the app_security_mode setting either a new SQL user is created for every Process Mining app by the system (app_security_mode="system_managed"), or a single SQL user account is created that is used for all process apps (app_security_mode="single_account"). Note that app_security_mode="system_managed" is the default setting, and that this requires advanced permissions for the database user. Refer to Configuring process app security.

When using Kerberos authentication, utilize the Integrated Security and Trusted_Connection parameters. By setting Integrated Security to true and setting Trusted_Connection to yes, the credentials of the currently logged in user are used for the connection. In this case, you do not need to specify a separate username and password.

PostgreSQL

The following example shows a Process Mining connection string using PostgreSQL for the Airflow database:

  "processmining": {
    "enabled": true,
    "app_security_mode": "system_managed",
    "airflow": {
      "metadata_db_connection_str": "postgresql+psycopg2://testadmin:<password>@sfdev8454496-postgresql.postgres.database.azure.com:5432/AutomationSuite_Airflow"
    },
    "warehouse": {
      "sql_connection_str": "Server=tcp:kerberossql.autosuitead.local,1433;Initial Catalog=AutomationSuite_Warehouse;Persist Security Info=False;User Id=testadmin;Password='password';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
      "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://testadmin:<password>@kerberossql.autosuitead.local:1433/AutomationSuite_Warehouse?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES",
      "master_sql_connection_str": "Server=tcp:kerberossql.autosuitead.local,1433;Initial Catalog=master;Persist Security Info=False;User Id=testadmin;Password='password';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;"
    }
    "sql_connection_str": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=AutomationSuite_ProcessMining_Metadata;User Id=[e-mail];Password='password';Persist Security Info=False;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
  }

SQL Server

The following example shows a Process Mining connection string using SQL Server for the Airflow database:

"processmining": {
    "enabled": true,
    "app_security_mode": "system_managed",
    "warehouse": {
        "sql_connection_str": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=AutomationSuite_ProcessMining_Warehouse;User Id=[e-mail];Password='password';Persist Security Info=False;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
        "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://testadmin%40sfdev4515230-sql.database.windows.net:<password>:@sfdev4515230-sql.database.windows.net:1433/AutomationSuite_ProcessMining_Warehouse?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES",
        "master_sql_connection_str": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=master;Persist Security Info=False;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;"
    },
    "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://testadmin%40sfdev4515230-sql.database.windows.net:<password>@sfdev4515230-sql.database.windows.net:1433/AutomationSuite_Airflow?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES"
    "sql_connection_str": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=AutomationSuite_ProcessMining_Metadata;User Id=[e-mail];Password='password';Persist Security Info=False;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",  
},

Sample Process Mining connection string

• Scenario: setup with Kerberos authentication (PostgreSQL)

"processmining": {
    "enabled": true,
    "airflow": {
      "metadata_db_connection_str": "postgresql+psycopg2://kerberos_user:@kerberospostgres.AUTOSUITEAD.LOCAL:5432/automationsuite_airflow"
    }
    "warehouse": {
        "sql_connection_str": "Server=tcp:assql2019.autosuitead.local,1433;Initial Catalog=AutomationSuite_ProcessMining_Warehouse;Persist Security Info=False;Integrated Security=true;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
        "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://:@assql2019.autosuitead.local:1433/AutomationSuite_ProcessMining_Warehouse?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES&Trusted_Connection=yes",
        "master_sql_connection_str": "Server=tcp:assql2019.autosuitead.local,1433;Initial Catalog=master;Persist Security Info=False;Integrated Security=true;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;"
      },
  },

• Scenario: setup with Kerberos authentication (Microsoft SQL Server).

"processmining": {
    "enabled": true,
    "warehouse": {
        "sql_connection_str": "Server=tcp:assql2019.autosuitead.local,1433;Initial Catalog=AutomationSuite_ProcessMining_Warehouse;Persist Security Info=False;Integrated Security=true;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
        "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://:@assql2019.autosuitead.local:1433/AutomationSuite_ProcessMining_Warehouse?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES&Trusted_Connection=yes",
        "master_sql_connection_str": "Server=tcp:assql2019.autosuitead.local,1433;Initial Catalog=master;Persist Security Info=False;Integrated Security=true;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;"
      },
    "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://:@assql2019.autosuitead.local:1433/AutomationSuite_Airflow?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES&Trusted_Connection=yes"
  },

Sample Process Mining connection string

• Scenario: Metadata database and data warehouse use separate SQL server (Non-Kerberos authentication).

"processmining": {
    "enabled": true,
    "warehouse": {
      "sql_connection_str": "Server=tcp:uipath-integration1.database.windows.net,1433;Initial Catalog=AutomationSuite_ProcessMining_Warehouse;Persist Security Info=False;User Id=userid;Password='password';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
      "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://userid:[e-mail]:1433/AutomationSuite_ProcessMining_Warehouse?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES",
      "master_sql_connection_str": "Server=tcp:uipath-integration1.database.windows.net,1433;Initial Catalog=master;Persist Security Info=False;User Id=userid;Password='password';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;"
    },
    "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://userid:[e-mail]:1433/AutomationSuite_Airflow?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES"
    "sql_connection_str": "Server=tcp:uipath-integration2.database.windows.net,1433;Initial Catalog=AutomationSuite_ProcessMining_Metadata;Persist Security Info=False;User Id=userid;Password='password';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",  
},

Sample Process Mining connection string

• Scenario: using custom app_security_mode.

"processmining": {
    "enabled": true,
    "app_security_mode": "system_managed",
    "warehouse": {
        "sql_connection_str": "Server=tcp:assql2019.autosuitead.local,1433;Initial Catalog=AutomationSuite_ProcessMining_Warehouse;Persist Security Info=False;Integrated Security=true;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
        "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://:@assql2019.autosuitead.local:1433/AutomationSuite_ProcessMining_Warehouse?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES&Trusted_Connection=yes",
        "master_sql_connection_str": "Server=tcp:assql2019.autosuitead.local,1433;Initial Catalog=master;Persist Security Info=False;Integrated Security=true;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;"
      },
    "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://:@assql2019.autosuitead.local:1433/AutomationSuite_Airflow?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES&Trusted_Connection=YES"
  },

Permissions

Make sure the SQL account specified in the connection strings is 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 must have the following roles and permissions on all databases:

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

We only use the db_securityadmin and db_ddladmin roles during installation or if the databases are reprovisioned, so you may revoke these permission afterwards. Insights requires the db_owner role to be assigned for a successful installation.

SQL collation

Automation Suite supports SQL collation set to SQL_Latin1_General_CP1_CI_AS at both the server and database level. We strongly recommend this particular setup for optimum performance and stability.

While you have the flexibility to use a collation of your choice, be aware that untested configurations can potentially lead to unexpected issues.

Important:

We do not recommend using Binary SQL or any collations that are case-sensitive, as they cause known issues while installing Automation Suite.

SQL server ciphers

Only the listed SQL ciphers are supported in Automation Suite:

• TLS_AES_256_GCM_SHA384
• TLS_CHACHA20_POLY1305_SHA256
• TLS_AES_128_GCM_SHA256
• TLS_AES_128_CCM_SHA256
• ECDHE-ECDSA-AES256-GCM-SHA384
• ECDHE-RSA-AES256-GCM-SHA384
• ECDHE-ECDSA-CHACHA20-POLY1305
• ECDHE-RSA-CHACHA20-POLY1305
• ECDHE-ECDSA-AES256-CCM
• ECDHE-ECDSA-AES128-GCM-SHA256
• ECDHE-RSA-AES128-GCM-SHA256
• ECDHE-ECDSA-AES128-CCM
• ECDHE-ECDSA-AES128-SHA256
• ECDHE-RSA-AES128-SHA256
• ECDHE-ECDSA-AES256-SHA
• ECDHE-RSA-AES256-SHA
• ECDHE-ECDSA-AES128-SHA
• ECDHE-RSA-AES128-SHA
• AES256-GCM-SHA384
• AES256-CCM
• AES128-GCM-SHA256
• AES128-CCM
• AES256-SHA256
• AES128-SHA256
• AES256-SHA
• AES128-SHA
• DHE-RSA-AES256-GCM-SHA384
• DHE-RSA-CHACHA20-POLY1305
• DHE-RSA-AES256-CCM
• DHE-RSA-AES128-GCM-SHA256
• DHE-RSA-AES128-CCM
• DHE-RSA-AES256-SHA256
• DHE-RSA-AES128-SHA256
• DHE-RSA-AES256-SHA
• DHE-RSA-AES128-SHA
• PSK-AES256-GCM-SHA384
• PSK-CHACHA20-POLY1305
• PSK-AES256-CCM
• PSK-AES128-GCM-SHA256
• PSK-AES128-CCM
• PSK-AES256-CBC-SHA
• PSK-AES128-CBC-SHA256
• PSK-AES128-CBC-SHA
• DHE-PSK-AES256-GCM-SHA384
• DHE-PSK-CHACHA20-POLY1305
• DHE-PSK-AES256-CCM
• DHE-PSK-AES128-GCM-SHA256
• DHE-PSK-AES128-CCM
• DHE-PSK-AES256-CBC-SHA
• DHE-PSK-AES128-CBC-SHA256
• DHE-PSK-AES128-CBC-SHA
• ECDHE-PSK-CHACHA20-POLY1305
• ECDHE-PSK-AES256-CBC-SHA
• ECDHE-PSK-AES128-CBC-SHA256
• ECDHE-PSK-AES128-CBC-SHA
• RSA-PSK-AES256-GCM-SHA384
• RSA-PSK-CHACHA20-POLY1305
• RSA-PSK-AES128-GCM-SHA256
• RSA-PSK-AES256-CBC-SHA
• RSA-PSK-AES128-CBC-SHA256
• RSA-PSK-AES128-CBC-SHA

SQL authentication

Azure Active Directory based access to SQL from AKS

Note:

Insights and Task Mining currently do not support Microsoft Entra ID (formerly Azure Active Directory) authentication configuration for access to SQL.

You may choose to access Microsoft SQL server via Azure Active Directory from AKS cluster. The following example shows some connections strings using the AAD access method:

  "sql_connection_string_template": "Server=tcp:sfdev3888449-sql.database.windows.net,1433;Authentication=Active Directory Service Principal;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=<service-principal-id>;Password='<service-principal-secret>';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;",
  "sql_connection_string_template_jdbc": "jdbc:sqlserver://sfdev3888449-sql.database.windows.net;authentication=ActiveDirectoryServicePrincipal;database=DB_NAME_PLACEHOLDER;user=<service-principal-id>;password={<service-principal-secret>};encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.database.windows.net;loginTimeout=30;",
  "sql_connection_string_template_odbc": "SERVER=sfdev3888449-sql.database.windows.net;Authentication=ActiveDirectoryServicePrincipal;DATABASE=DB_NAME_PLACEHOLDER;DRIVER={ODBC Driver 17 for SQL Server};UID=<service-principal-id>;PWD={<service-principal-secret>};Encrypt=yes;TrustServerCertificate=no;Connection Timeout=30;hostNameInCertificate=sfdev3888449-sql.database.windows.net",
  "sql_connection_string_template_sqlalchemy_pyodbc": "mssql+pyodbc://<service-principal-id>:<service-principal-secret>@sfdev3888449-sql.database.windows.net:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server&authentication=ActiveDirectoryServicePrincipal",

SQL requirements for Insights

Note:

Insights does not support Azure AD authentication. If you authenticate using Azure AD, dashboards cannot be loaded and data cannot be fetched from the Microsoft SQL database.

Insights requires SQL Server 2019 or 2022, including support for columnstore index and .json functions. SQL Server Enterprise is recommended due to more efficient threading and scalability.

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

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 Process Mining

When you enable Process Mining for installation on Automation Suite 2023.10.9 or higher you can choose to bring either a PostgreSQL database or a Microsoft SQL Server database for AutomationSuite_Airflow.

Important:

For Process Mining on Automation Suite 2023.10.9 or higher versions, you are recommended to move to PostgreSQL for the AutomationSuite_Airflow database, as PostgreSQL runs with the latest versions of Apache Airflow. Running the latest version of Airflow ensures you make use of new functionality, performance, and security fixes.

If you choose not to use a PostgreSQL database and keep using a Microsoft SQLServer database, Process Mining on Automation Suite will run with legacy Airflow. Legacy versions of Apache Airflow may lack functionality, performance, and security fixes.

Starting with Process Mining on Automation Suite 2025.10 only PostgreSQL database is supported for the AutomationSuite_Airflow database.

AutomationSuite_Airflow PostgreSQL database

For Process Mining on Automation Suite 202310.9 or higher versions, you can choose to use a PostgreSQL database for the AutomationSuite_Airflow database.

When migrating from Microsoft SQL Server to PostgreSQL database, data migration is not required. With a correct configuration setup, the database is rebuilt when running Sync Airflow.

Supported PostgreSQL versions

PostgreSQL versions 12.x to 16.x are supported. It is recommended to use the most recent version of PostgreSQL within this range for optimal compatibility and performance.

Hardware requirements

The machine on which the PostgreSQL database for Airflow is installed must meet the following harware requirements.

• Cores: 4
• Memory: 16 GiB
• Storage: 64 GiB
• IOPS: >=500 IOPS

Required permissions

The PostgreSQL Airflow user (or any dedicated database user) must have

• "All Privileges" permissions for the designated Airflow database.
• "all grants" on the server's public schema.
• "search_path" set to "public".

Note:

You may need to update PostgreSQL Host-Based Authentication file pg_hba.conf to add the Airflow user to the database access control list and reload the database configuration to apply the changes.

The following code shows an example for setting up a PostgreSQL database.

CREATE DATABASE airflow_db
  WITH ENCODING 'UTF8'
  LC_COLLATE='en_US.UTF-8'
  LC_CTYPE='en_US.UTF-8'
  TEMPLATE template0;

CREATE USER airflow_user WITH PASSWORD 'airflow_pass';
GRANT ALL PRIVILEGES ON DATABASE airflow_db TO airflow_user;

-- PostgreSQL 15 requires additional privileges:
GRANT ALL ON SCHEMA public TO airflow_user;

The following code shows a database encoding validation example.

SELECT pg_encoding_to_char(encoding) AS encoding
FROM pg_database
WHERE datname = 'airflow_db';

Refer to the official Airflow documentation for more information on how to set up a PostgreSQL database for Airflow.

Default server port

The default server port for Airflow database connections with PostgreSQL is 5432. If you are using the PgBouncer connection pooler, it is common to use port 6432.

The following code blocks show some example connection strings for PostgreSQL using port 5432.

Sample connection string:

postgresql+psycopg2://testadmin:<password>@test-cu231009v3-postgresql.postgres.database.azure.com:5432/automationsuite_airflow

Sample connection string for using Kerberos:

postgresql+psycopg2://kerberos_user:@kerberospostgres.AUTOSUITEAD.LOCAL:5432/automationsuite_airflow

Sample connection string for using Managed Identitiy:

postgresql+psycopg2://testmanagedidentity:@test-postgresql-1.postgres.database.azure.com/airflow-ci-sfasaksqacu8524745

The default server port can be configured to use any available port as per your system requirements.

PgBouncer

Since Airflow uses short-lived connections, it is highly recommended to set up PgBouncer. PgBouncer is a lightweight connection pooler for PostgreSQL.

Refer to the official PgBouncer documentation for more information on how to set up PgBouncer.

AutomationSuite_Airflow Microsoft SQL Server database

Note:

For the AutomationSuite_Airflow database, Microsoft SQL Server is the only option available for Process Mining on Automation Suite versions 2023.10.8 and earlier. For Process Mining on Automation Suite 2023.10.9 or higher versions, you are recommended to move to PostgreSQL.

If you use Microsoft SQL Server for AutomationSuite_Airflow database, make sure you meet the following requirements.

Important:

You must use the default server port 1433 for Airflow database connections. Non-standard SQL Server ports are not supported.

Note:

When setting up Microsoft SQL Server make sure that the timezone of the SQL Server machine where the Airflow database is installed, is set to UTC.

AutomationSuite_ProcessMining_Warehouse database

Process Mining on Automation Suite requires a separate Microsoft SQL Server for the AutomationSuite_ProcessMining_Warehouse for data storage for Process Mining process apps.

Important:

To ensure proper functioning of Process Mining, it is recommended to use Microsoft SQL Server 2022.

This 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. 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 UiPath Automation Suite Install Sizing 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. For details, refer to Hardware requirements.

The SQL user used in the connection strings must have the db_securityadmin database-level role both during and post-installation to enable per app security on the Process Mining data warehouse SQL Server. For details, refer to the official Microsoft documentation on Database-level roles and Configuring process app security.

SQL requirements for AI Center

Requirements for AI Center installed on a FIPS 140-2-enabled machine

To install AI Center on a FIPS 140-2-enabled machine, take the following steps:

1. Before starting the Automation Suite installation, take the following steps:
   1. Enable FIPS 140-2 on the machine on which you plan to install Microsoft Server by following the Microsoft instructions.
   2. Install Microsoft SQL Server on the FIPS 140-2-enabled machine.
   3. Get the Microsoft SQL Server certificate by running the following command from the SQL Server or any server that can connect to the SQL server with the configured SQL host name:

      nmap -sV -p <port> -vv --script ssl-cert domain
      

2. During the Automation Suite installation, take the following steps:

   1. Append the following values to the AI Center sql_connection_string_template_jdbc connection string in the input.json file: encrypt=true;trustServerCertificate=false;fips=true;.

      Example:

      jdbc:sqlserver://sfdev1804627-c83f074b-sql.database.windows.net:1433;database=DB_NAME_PLACEHOLDER;user=testadmin;password=***;encrypt=true;trustServerCertificate=false;fips=true;Connection  Timeout=30;hostNameInCertificate=sfdev1804627-c83f074b-sql.database.windows.net"
      

      For details on database configuration, refer to Advanced installation experience and Updating the SQL database.

   2. Add the exported cert from step 1.c. to the trust store of the host machine. For details refer to Updating the CA Certificates.