UiPath Documentation
automation-suite
2.2510
true
Automation Suite on Linux installation guide

Document Understanding-specific configuration

Reference for the documentunderstanding configuration properties in cluster_config.json in Automation Suite.

documentunderstanding is a property in the Automation Suite's configuration file, cluster_config.json. It contains configurable values that control the behavior of the Document Understanding service. The installer generates the default values. Additional changes can be made to further configure the Document Understanding service.

If you need to change any settings related to Document Understanding, the documentunderstanding section in cluster_config.json can be edited and the installer can be re-run.

Alternatively, the same changes can be made in the UiPath® app in ArgoCD.

Document Understanding config

"documentunderstanding": {
    "enabled": true,
    "sql_connection_str": "",
    "datamanager": {
      "sql_connection_str": "String",
      "pyodbc_sql_connection_str": "String"
    },
    "extendedOcr": {
      "enabled": null,
      "license": "license obtained"
    },
    "modernProjects": {
      "enabled": true,
      "enable_cpu_inference": false
    }
  }
"documentunderstanding": {
    "enabled": true,
    "sql_connection_str": "",
    "datamanager": {
      "sql_connection_str": "String",
      "pyodbc_sql_connection_str": "String"
    },
    "extendedOcr": {
      "enabled": null,
      "license": "license obtained"
    },
    "modernProjects": {
      "enabled": true,
      "enable_cpu_inference": false
    }
  }
Note:

The data manager SQL connection string is optional only if you want to overwrite the default database with your own.

Configurable values

datamanager.sql_connection_str

  • Connection string for datamanager
  • Required: False.
  • This property is generated and populated by the installer, you do not need to set it unless you want to override the default connection string. For details about connecting to SQL, refer to the Database configuration page.

datamanager.pyodbc_sql_connection_str

  • Connection string for datamanager
  • Required: False.
  • This property is generated and populated by the installer, you do not need to set it unless you want to override the default connection string. For details about connecting to SQL, refer to the Database configuration page.

modernProjects

  • Setting for Document Understanding modern projects.
  • Required: True
  • Default: True

extendedOcr

  • Setting this to true enables UiPath Extended Languages OCR.
  • Required: False
  • License: value depends on if a license is obtained or not

For details on how to obtain a license for UiPath Extended Language OCR and enable it, refer to Enabling or disabling Extended Languages OCR.

Configuring Service Principal authentication for SQL

When using SQL Authentication with an Azure Active Directory Service Principal for the database connection, you must explicitly add an advanced_configuration section to the documentunderstanding block in cluster_config.json. Replace your-tenant-id with your Azure tenant ID.

"documentunderstanding": {
    "enabled": true,
    "enable_sql_wi": null,
    "advanced_configuration": {
      "du-annotations": {
        "additionalConfigs": {
          "AZURE_TENANT_ID": "your-tenant-id"
        }
      }
    },
},
"documentunderstanding": {
    "enabled": true,
    "enable_sql_wi": null,
    "advanced_configuration": {
      "du-annotations": {
        "additionalConfigs": {
          "AZURE_TENANT_ID": "your-tenant-id"
        }
      }
    },
},

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated