UiPath Documentation
automation-suite
2.2510
true

Automation Suite on OpenShift installation guide

Last updated May 22, 2026

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 2019 and 2022, Standard and Enterprise editions are supported.

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.

The following products require a dedicated PostgreSQL database in addition to Microsoft SQL Server:

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 the product requires.

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 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.
    • 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, you need to manually create the PostgreSQL database for AutomationSuite_Airflow before installing or upgrading to Automation Suite 2.2510 or higher. The PostgreSQL database for Airflow will not be created automatically by the installer.

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

ParameterDescription
sql.create_dbSet 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_urlFQDN of the SQL server, where you want the installer to configure database.
sql.portPort number on which a database instance should be hosted in the SQL server.
sql.usernameUsername / user ID to connect to the SQL server.
sql.passwordPassword 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.

Connection string templates​

ParameterDescriptionProducts
sql_connection_string_templateFull 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
Integration Service
Data Service
Studio Web
Process Mining
Document Understanding
LLM Gateway
ECS
LLM Observability
Solutions
Maestro
Agents
sql_connection_string_template_jdbcFull 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
Integration Service
sql_connection_string_template_odbcFull 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
Integration Service
sql_connection_string_template_sqlalchemy_pyodbcFull 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
postgresql_connection_string_template_sqlalchemy_pyodbcFull 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
Temporal as a Service (TaaS)
postgresql_connection_string_template_sqlalchemy_asyncpgFull PostgreSQL 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.Autopilot for developers

If your password contains reserved URL characters, replace each special character with its percent-encoded equivalent in the connection string. For example, if your password is P@ssw0rd#1!, you must encode it as P%40ssw0rd%231%21.

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.

sql_connection_string_template​

The following example shows a sql_connection_string_template connection string:

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

The following example shows a sql_connection_string_template_jdbc connection string:

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"
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 example shows a sql_connection_string_template_odbc connection string:

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;"
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 example shows a sql_connection_string_template_sqlalchemy_pyodbc connection string:

mssql+pyodbc://testuser%40sfdev3082457-sql.database.windows.net:_-%29X07_%5E3-%28%3B%25e-T@sfdev3082457-sql.database.windows.net:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"
mssql+pyodbc://testuser%40sfdev3082457-sql.database.windows.net:_-%29X07_%5E3-%28%3B%[email protected]:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"
postgresql_connection_string_template_sqlalchemy_pyodbc​

The following example shows a postgresql_connection_string_template_sqlalchemy_pyodbc connection string for Process Mining:

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

The following example shows a combined sql_connection_string_template and postgresql_connection_string_template_sqlalchemy_pyodbc connection string for Process Mining:

"sql_connection_string_template": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User [email protected];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"
"sql_connection_string_template": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User [email protected];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 shows a combined sql_connection_string_template and sql_connection_string_template_sqlalchemy_pyodbc connection string for Process Mining:

"sql_connection_string_template": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User [email protected];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~%3Az%60Ds%[email protected]:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"
"sql_connection_string_template": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User [email protected];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~%3Az%60Ds%[email protected]:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"

The following example shows the default and optional DB names for Automation Suite services:

{
  "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",
  "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",
  "llmgateway": "AutomationSuite_LLMGateway",
  "ecs": "AutomationSuite_ECS",
  "ecs_vector": "AutomationSuite_ECSVector",
  "llmobservability": "AutomationSuite_Llmops",
  "automationsolutions": "AutomationSuite_AutomationSolutions",
  "maestro": "AutomationSuite_Maestro",
  "taas": {
    "persistence store": "AutomationSuite_Taas",
    "visibility store": "AutomationSuite_Taas_Visibility"
  },
  "a4d": "AutomationSuite_A4D",
  "agents: AutomationSuite_Agents"
}
{
  "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",
  "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",
  "llmgateway": "AutomationSuite_LLMGateway",
  "ecs": "AutomationSuite_ECS",
  "ecs_vector": "AutomationSuite_ECSVector",
  "llmobservability": "AutomationSuite_Llmops",
  "automationsolutions": "AutomationSuite_AutomationSolutions",
  "maestro": "AutomationSuite_Maestro",
  "taas": {
    "persistence store": "AutomationSuite_Taas",
    "visibility store": "AutomationSuite_Taas_Visibility"
  },
  "a4d": "AutomationSuite_A4D",
  "agents: AutomationSuite_Agents"
}
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.

Orchestrator and platform​

The following example shows how to override the default connection string for Orchestrator and the platform:

{
  "orchestrator": {
    "sql_connection_str": "Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net,1433;Initial Catalog=CustomOrchDB;Persist Security Info=False;User [email protected];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"
  },
  "platform": {
    "sql_connection_str": "Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net,1433;Initial Catalog=CustomIDDB;Persist Security Info=False;User [email protected];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"
  }
}
{
  "orchestrator": {
    "sql_connection_str": "Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net,1433;Initial Catalog=CustomOrchDB;Persist Security Info=False;User [email protected];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"
  },
  "platform": {
    "sql_connection_str": "Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net,1433;Initial Catalog=CustomIDDB;Persist Security Info=False;User [email protected];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"
  }
}

To override the database connection strings for other products, set the sql_connection_str in the corresponding product blocks. The connection string should have a format supported by the respective product.

AI Center​

The following example shows a sample AI Center connection string using the required JDBC format:

"aicenter": {
    "enabled": true,
    "sql_connection_str": "jdbc:sqlserver://sfdev1804627-c83f074b-sql.database.windows.net;database=aicenter;[email protected];password=TFgID_9GsE7_P@srCQp0WemXX_euHQZJ"
}
"aicenter": {
    "enabled": true,
    "sql_connection_str": "jdbc:sqlserver://sfdev1804627-c83f074b-sql.database.windows.net;database=aicenter;[email protected];password=TFgID_9GsE7_P@srCQp0WemXX_euHQZJ"
}

Document Understanding​

The following example shows a sample Document Understanding connection string:

"documentunderstanding": {
        "enabled": true,
        "sql_connection_str": "Server=SERVER_PLACEHOLDER;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=USER_PLACEHOLDER;Password='PASSWORD_PLACEHOLDER';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;",
        "datamanager": {
            "sql_connection_str": "SERVER=SERVER_PLACEHOLDER;DATABASE=DB_NAME_PLACEHOLDER;DRIVER={ODBC Driver 17 for SQL Server};UID=USER_PLACEHOLDER;PWD={PASSWORD_PLACEHOLDER};;Encrypt=yes;TrustServerCertificate=no;Connection Timeout=30;hostNameInCertificate=customer-sql.database.windows.net",
            "pyodbc_sql_connection_str": "mssql+pyodbc://testadmin%40sql.database.windows.net:Z%3Aw%21%zE%[email protected]:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"
        }
    }
"documentunderstanding": {
        "enabled": true,
        "sql_connection_str": "Server=SERVER_PLACEHOLDER;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=USER_PLACEHOLDER;Password='PASSWORD_PLACEHOLDER';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;",
        "datamanager": {
            "sql_connection_str": "SERVER=SERVER_PLACEHOLDER;DATABASE=DB_NAME_PLACEHOLDER;DRIVER={ODBC Driver 17 for SQL Server};UID=USER_PLACEHOLDER;PWD={PASSWORD_PLACEHOLDER};;Encrypt=yes;TrustServerCertificate=no;Connection Timeout=30;hostNameInCertificate=customer-sql.database.windows.net",
            "pyodbc_sql_connection_str": "mssql+pyodbc://testadmin%40sql.database.windows.net:Z%3Aw%21%zE%[email protected]:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"
        }
    }

The data manager SQL connection string is optional; only specify it if you want to override the default.

Process Mining​

Process Mining connection strings have the following differences from template connection strings:

  • The template connection string names (postgresql_connection_string_template_sqlalchemy_pyodbc, sql_connection_string_template) differ from the bring-your-own-database names (sqlalchemy_pyodbc_sql_connection_str, 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 sql_connection_string_template and postgresql_connection_string_template_sqlalchemy_pyodbc are ignored.

The app_security_mode setting controls how SQL users are created for Process Mining apps. In the default app_security_mode="system_managed" mode, a new SQL user is created for every Process Mining app, which requires advanced permissions for the database user. In app_security_mode="single_account" mode, a single SQL user account is used for all process apps. For details, refer to Configuring process app security.

If you use a Multi-AZ with Always On SQL setup, set the MultiSubnetFailover parameter in your Process Mining connection strings. The value differs by connection string type: use MultiSubnetFailover=True for sql_connection_str and master_sql_connection_str, and MultiSubnetFailover=Yes for sqlalchemy_pyodbc_sql_connection_str. Note that for pyodbc you use '=Yes' instead of '=True''.

For Kerberos authentication, use the Integrated Security and Trusted_Connection parameters instead of a username and password. Set Integrated Security to true and Trusted_Connection to yes to authenticate using the credentials of the currently logged in user.

The following example shows a sample Process Mining connection string (PostgreSQL):

  "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 [email protected];Password='password';Persist Security Info=False;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
  }
  "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 [email protected];Password='password';Persist Security Info=False;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
  }

The following example shows a Process Mining connection string for a 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;"
      },
  },
"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;"
      },
  },

The following example shows a Process Mining connection string for a setup where the metadata database and data warehouse use a 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:[email protected]: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;"
    },
  "airflow": {
      "metadata_db_connection_str": "postgresql+psycopg2://testadmin:<password>@sfdev8454496-postgresql.postgres.database.azure.com:5432/AutomationSuite_Airflow"
    },
    "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;",  
},
"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:[email protected]: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;"
    },
  "airflow": {
      "metadata_db_connection_str": "postgresql+psycopg2://testadmin:<password>@sfdev8454496-postgresql.postgres.database.azure.com:5432/AutomationSuite_Airflow"
    },
    "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;",  
},

The following example shows a Process Mining connection string for a setup 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;"
      },
   "airflow": {
      "metadata_db_connection_str": "postgresql+psycopg2://testadmin:<password>@sfdev8454496-postgresql.postgres.database.azure.com:5432/AutomationSuite_Airflow"
    },
"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;"
      },
   "airflow": {
      "metadata_db_connection_str": "postgresql+psycopg2://testadmin:<password>@sfdev8454496-postgresql.postgres.database.azure.com:5432/AutomationSuite_Airflow"
    },

Studio Web​

The following example shows a sample Studio Web connection string:

"studioweb": {
      "enabled": true,
      "sql_connection_str": "Server=tcp:ci-asaksdev7031068.database.windows.net,1433;Initial Catalog=AutomationSuite_StudioWeb;Persist Security Info=False;User Id=mssqladminun;Password='****';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;"
      },
"studioweb": {
      "enabled": true,
      "sql_connection_str": "Server=tcp:ci-asaksdev7031068.database.windows.net,1433;Initial Catalog=AutomationSuite_StudioWeb;Persist Security Info=False;User Id=mssqladminun;Password='****';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;"
      },

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, dt, authz, and msgbus schema

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 requirements for Full-Text Search​

Context Grounding and Document Understanding require 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 find a full list of SQL Server components, which includes Full-Text Search.

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 Data Service​

If you create your own database, 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};
GRANT ALTER ANY SENSITIVITY CLASSIFICATION TO {userName};
GRANT VIEW ANY SENSITIVITY CLASSIFICATION TO {userName};

SQL requirements for Process Mining​

Important:

In Automation Suite versions 2.2510.0 and 2.2510.1, you cannot use a custom database name for the Platform database if Process Mining is enabled. If you specify a custom name, the OMS backfill job fails.

To avoid this, use AutomationSuite_Platform as the Platform database name when installing Process Mining.

When you enable Process Mining for installation on Automation Suite, you must bring a PostgreSQL database for AutomationSuite_Airflow. PostgreSQL is the only supported database type for AutomationSuite_Airflow.

AutomationSuite_Airflow PostgreSQL database​

Note:

Before installing or upgrading to Automation Suite 2.2510 or higher, you need to manually create the PostgreSQL database for AutomationSuite_Airflow. The PostgreSQL database for Airflow will not be created automatically by the installer.

When migrating from Microsoft SQL Server to PostgreSQL, 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: 128 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;
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';
SELECT pg_encoding_to_char(encoding) AS encoding
FROM pg_database
WHERE datname = 'airflow_db';

For details on how to set up a PostgreSQL database for Airflow, refer to the official Airflow documentation.

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
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
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
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.

For details on how to set up PgBouncer, refer to the official PgBouncer documentation.

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, it is recommended to work on a small development dataset with a limited number of records for performance reasons.

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.

It is recommended to enable case sensitivity in table and column names using the following command:

ALTER DATABASE AutomationSuite_ProcessMining_Warehouse COLLATE SQL_Latin1_General_CP1_CS_AS
ALTER DATABASE AutomationSuite_ProcessMining_Warehouse COLLATE SQL_Latin1_General_CP1_CS_AS

This prevents errors when loading data caused by columns with similar names, such as ID and id. It also ensures that textual values differing only in capitalization are treated as distinct. For example:

  • 'activity 1' == 'activity 1'
  • 'Activity 1' != 'activity 1'

This prevents duplication issues in SQL transformations.

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
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"
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.

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.

SQL requirements for Orchestrator​

Important:

To increase performance, avoid deadlocks, and prevent dirty reads in SQL, make sure that the READ_COMMITTED_SNAPSHOT option is set to ON.

To process the same queue with multiple robots, and snapshot isolation is turned on, make sure that the ALLOW_SNAPSHOT_ISOLATION option is set to ON.

Use this query to check if READ_COMMITTED_SNAPSHOT and ALLOW_SNAPSHOT_ISOLATION are enabled or disabled:

SELECT is_read_committed_snapshot_on, snapshot_isolation_state FROM sys.databases
   WHERE name like 'PLACEHOLDER'
SELECT is_read_committed_snapshot_on, snapshot_isolation_state FROM sys.databases
   WHERE name like 'PLACEHOLDER'

Make sure to replace PLACEHOLDER with your Orchestrator database name.

If the settings are enabled, the returned value will be 1.

If the settings are disabled, the returned value will be 0. Use this query to enable it:

# To enable READ_COMMITTED_SNAPSHOT
ALTER DATABASE <PLACEHOLDER>
SET READ_COMMITTED_SNAPSHOT ON

# To enable ALLOW_SNAPSHOT_ISOLATION
ALTER DATABASE <PLACEHOLDER>
SET ALLOW_SNAPSHOT_ISOLATION ON
# To enable READ_COMMITTED_SNAPSHOT
ALTER DATABASE <PLACEHOLDER>
SET READ_COMMITTED_SNAPSHOT ON

# To enable ALLOW_SNAPSHOT_ISOLATION
ALTER DATABASE <PLACEHOLDER>
SET ALLOW_SNAPSHOT_ISOLATION ON

Make sure to replace <PLACEHOLDER> with your Orchestrator database name.

SQL requirements for Temporal as a Service (TaaS)​

When Maestro is enabled on Automation Suite, TaaS requires two dedicated PostgreSQL databases:

  • Persistence store (AutomationSuite_Taas) - stores workflow execution data and history.
  • Visibility store (AutomationSuite_Taas_Visibility) - stores workflow metadata used by the Temporal UI and visibility APIs. Requires the btree_gin extension to be available on the PostgreSQL server.

Both databases are created automatically by the installer when sql.create_db is set to true. If you bring your own databases, create both before running the installer. For the default database names, refer to Default and optional DB names for Automation Suite services.

To override the connection strings for TaaS, use postgresql_connection_string_template_sqlalchemy_pyodbc. For the connection string format, refer to Bring your own databases.

Supported PostgreSQL versions​

PostgreSQL versions 12.x to 16.x are supported.

Hardware requirements​

Size the TaaS PostgreSQL database based on workflow volume per day. Three complexity profiles are used for sizing:

  • Simple - approximately 3 BPMN tasks per workflow
  • Moderate - approximately 25 BPMN tasks and 1 subprocess (5 tasks)
  • Complex - approximately 100 BPMN tasks and 3 subprocesses (5 tasks each)

Find the row that matches your workload in any one column (OR, not AND) and read the hardware requirements on the right. You do not need to meet all three column thresholds simultaneously. For mixed-complexity workloads, use the Automation Suite capacity calculator - contributions across complexity tiers are additive.

CPU and RAM​

The following table describes the CPU and RAM requirements based on daily workflow volume and complexity:

Simple workflows/dayModerate workflows/dayComplex workflows/dayCPURAM
< 12,500< 1,900< 5252 vCores4 GB
12,500–125,0001,900–19,200525–5,2754 vCores8 GB
125,000+19,200+5,275+8 vCores16 GB
Disk and IOPS​

Disk size depends on workflow volume, complexity, and the process retention period configured in Orchestrator. Use the Automation Suite capacity calculator for a workload-driven recommendation. The following table describes the recommended disk and IOPS based on your steady-state size:

Recommended diskIOPS
100 GB500
150 GB800
250 GB1,110
500 GB2,300
1 TB5,000
Important:

Premium SSD (or equivalent) is required. Standard SSD cannot sustain TaaS write throughput beyond very low load.

Read replica​

Optional - recommended for high-availability deployments.

The PostgreSQL server must be co-located with the TaaS cluster components (for example, in the same datacenter). This requirement applies to both the primary region and any passive or failover regions.

Connection requirements​

TaaS maintains an application-side connection pool per pod. The following table describes the required max_connections value based on your deployment profile and daily workflow volume:

Simple workflows/dayModerate workflows/dayComplex workflows/daydefaultliteha
< 12,500< 1,900< 525200200400
12,500–125,0001,900–19,200525–5,275200400500
125,000+19,200+5,275+200600600
Important:

The default PostgreSQL max_connections value is 100, which is insufficient for any TaaS profile. Use the table above to determine the required value for your deployment profile and workflow volume, and increase max_connections on the PostgreSQL server before installation.

Connection constraints​
  • TaaS does not support connections through pgBouncer.
  • Only username and password authentication is supported. Workload Identity, Kerberos, and IAM authentication are not supported.

Tuning the connection pool​

The default connection pool settings are suitable for most deployments. If your PostgreSQL instance has a lower max_connections limit, override the defaults using advanced_configuration in input.json:

{
  "taas": {
    "enabled": true,
    "advanced_configuration": {
      "taas": {
        "temporal": {
          "server": {
            "config": {
              "persistence": {
                "default": {
                  "sql": {
                    "maxConns": 10,
                    "maxIdleConns": 10
                  }
                },
                "visibility": {
                  "sql": {
                    "maxConns": 10,
                    "maxIdleConns": 10
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
{
  "taas": {
    "enabled": true,
    "advanced_configuration": {
      "taas": {
        "temporal": {
          "server": {
            "config": {
              "persistence": {
                "default": {
                  "sql": {
                    "maxConns": 10,
                    "maxIdleConns": 10
                  }
                },
                "visibility": {
                  "sql": {
                    "maxConns": 10,
                    "maxIdleConns": 10
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
Important:

Lowering maxConns aggressively can cause TaaS persistence timeouts under load. Only adjust these values if your PostgreSQL instance cannot meet the default connection requirements.

SQL requirements for Autopilot for Developers (A4D)​

Autopilot for Developers requires a dedicated PostgreSQL database (AutomationSuite_A4D). A4D uses the postgresql_connection_string_template_sqlalchemy_asyncpg connection string template.

Hardware requirements​

The following table describes the hardware requirements for the A4D PostgreSQL server:

ResourceRequirement
CPU2 vCores
Memory8 GB RAM
Storage128 GB
IOPS100

Connection requirements​

The required max_connections value on the PostgreSQL server is 100.

If you use different databases for Test Automation and/or Update Server, READ_COMMITTED_SNAPSHOT and ALLOW_SNAPSHOT_ISOLATION must be enabled on those as well.

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated