automation-suite
2023.10
false
UiPath logo, featuring letters U and I in white

Automation Suite on Linux installation guide

Last updated May 5, 2025

Updating the cluster configuration

After regenerating the cluster_config.json file but before performing the upgrade, you can make various changes, such as updates to the database configuration, certificate configuration, and more. For details, see Performing advanced configuration.

Additionally, there are a few service-specific configurations that you must apply before upgrading. To check which changes are required for your Automation Suite cluster, see the following table:

Conditions

Actions

1. You installed Automation Suite 2023.4 or earlier in an offline environment.

  • AND

2. You upgrade to Automation Suite 2023.10 or later.
You must manually add install_type: offline to the cluster_config.json file. 
{
"install_type": "offline"
"fqdn": "<sample_fqdn>" ,
…
}{
"install_type": "offline"
"fqdn": "<sample_fqdn>" ,
…
}

1. Orchestrator is installed on the old Automation Suite version.

  • AND

2. You upgrade from Automation Suite 2022.10.
Set the following parameter in the cluster_config.json file to confirm that you agree with blocking classic folder executions. Without consent, the upgrade will fail. 
...
"orchestrator": {
  "enabled": true,
  "block_classic_executions": true,
......
"orchestrator": {
  "enabled": true,
  "block_classic_executions": true,
...

1. Apps is installed on the old Automation Suite version.

  • AND

2. You upgrade from Automation Suite 2022.10 or earlier.
  1. Create a database for Apps with the following default name: AutomationSuite_Apps.
  2. If you want to overwrite the default SQL connection string, update the ODBC connection string for the Apps database in the cluster_config.json file. 
{ 
  "apps": {
    "sql_connection_str": "SERVER=sqlserver.mycompany.com,1433;DATABASE=AutomationSuite_Apps;DRIVER={ODBC Driver 17 for SQL Server};UID=testadmin;PWD=***;MultipleActiveResultSets=False;Encrypt=YES;TrustServerCertificate=NO;Connection Timeout=30;"
  }
}{ 
  "apps": {
    "sql_connection_str": "SERVER=sqlserver.mycompany.com,1433;DATABASE=AutomationSuite_Apps;DRIVER={ODBC Driver 17 for SQL Server};UID=testadmin;PWD=***;MultipleActiveResultSets=False;Encrypt=YES;TrustServerCertificate=NO;Connection Timeout=30;"
  }
}

For an example of the ODBC connection string, see Database configuration.

1. AI Center is installed on the old Automation Suite version and connects to an external Orchestrator.

  1. Copy the Orchestrator certificates to the server node on which you plan to trigger the upgrade. For details, see Copy the Orchestrator certificate to the virtual machine.

  2. Update the cluster_config.json file with the following configuration: 
    "aicenter": {
    "enabled": true,
    "orchestrator_url": "https://orchestrator.example.com", //Specify the Orchestrator URL for AI Center
    "identity_server_url": "https://orchestrator.example.com/identity", //Specify the Identiy URL for AI Center
    "orchestrator_cert_file_path": "/opt/UiPathAutomationSuite/UiPath_Installer/orch.cer", //Specify the path to the Orchestrator certificate
    "identity_cert_file_path": "/opt/UiPathAutomationSuite/UiPath_Installer/orch.cer", //Specify the path to Identity certificate file
    "metering_api_key": "test" //Specify the metering API key
  }"aicenter": {
    "enabled": true,
    "orchestrator_url": "https://orchestrator.example.com", //Specify the Orchestrator URL for AI Center
    "identity_server_url": "https://orchestrator.example.com/identity", //Specify the Identiy URL for AI Center
    "orchestrator_cert_file_path": "/opt/UiPathAutomationSuite/UiPath_Installer/orch.cer", //Specify the path to the Orchestrator certificate
    "identity_cert_file_path": "/opt/UiPathAutomationSuite/UiPath_Installer/orch.cer", //Specify the path to Identity certificate file
    "metering_api_key": "test" //Specify the metering API key
  }
  3. Ensure that cluster_config.json includes the following parameter: 
    {
  "sql_connection_string_template": "DOTNET connection string templates", 
  "sql_connection_string_template_odbc": "ODBC connection string templates"
}{
  "sql_connection_string_template": "DOTNET connection string templates", 
  "sql_connection_string_template_odbc": "ODBC connection string templates"
}

1. Document Understanding is already installed on the old Automation Suite version.

  • AND

2. You upgrade from Automation Suite 2023.10.3 or earlier to Automation Suite 2023.10.4 or later.
  1. Add the pyodbc_connection_string connection string in the data_manager section:
    "documentunderstanding": {
...
"datamanager": {
 ...
  "pyodbc_sql_connection_str": "***" // python sql connection string
 }
}"documentunderstanding": {
...
"datamanager": {
 ...
  "pyodbc_sql_connection_str": "***" // python sql connection string
 }
}

1. Document Understanding was not installed on the old Automation Suite version.

  • AND

2. You upgrade from Automation Suite 2023.10.3 or earlier to Automation Suite 2023.10.4 or later.
  1. Add or merge the entire Document Understanding section:
    "documentunderstanding": {
"enabled": true,
"sql_connection_str": "" // dotnet connection string,
"datamanager": {
 "sql_connection_str": "" // odbc connection string
  "pyodbc_sql_connection_str": "***" // python sql connection string
 }
}"documentunderstanding": {
"enabled": true,
"sql_connection_str": "" // dotnet connection string,
"datamanager": {
 "sql_connection_str": "" // odbc connection string
  "pyodbc_sql_connection_str": "***" // python sql connection string
 }
}

1. Process Mining is installed on the old Automation Suite version.

  • AND

2. You want to use latest version of Airflow which needs PostgreSQL.

Note:

For Process Mining on Automation Suite 2023.10.9 or higher, using PostgreSQL for the Airflow database is the recommended option.
  1. Update the sqlalchemy connection string template applicable for PostgreSQL in the cluster_config.json file before the upgrade.

postgresql_connection_string_template_sqlalchemy_pyodbc

postgresql+psycopg2://<user>:<password>@<postgresql host>:<postgresql port>/<airflow db name>postgresql+psycopg2://<user>:<password>@<postgresql host>:<postgresql port>/<airflow db name>
Note:

When upgrading from Microsoft SQL Server to PostgreSQL database data migration is not required.

1. Process Mining is not installed on the old Automation Suite version.
  • AND
2. You want to use latest version of Airflow which needs PostgreSQL.
Note:

For Process Mining on Automation Suite 2023.10.9 or higher, using PostgreSQL for the Airflow database is the recommended option.
  1. Add the sqlalchemy connection string template applicable for PostgreSQL in the cluster_config.json file before the upgrade.

postgresql_connection_string_template_sqlalchemy_pyodbc

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

When upgrading from Microsoft SQL Server to PostgreSQL database data migration is not required.

Was this page helpful?

Support and Services
Get The Help You Need
UiPath Academy
Learning RPA - Automation Courses
UiPath Forum
UiPath Community Forum
Uipath Logo White
Trust and Security
Terms of Use
Privacy Policy
Cookies Policy
© 2005-2025 UiPath. All rights reserved.