automation-suite
2022.4
false
- Overview
- Requirements
- Installation
- Post-installation
- Cluster administration
- Managing products
- Managing the cluster in ArgoCD
- Setting up the external NFS server
- Automated: Enabling the Backup on the Cluster
- Automated: Disabling the Backup on the Cluster
- Automated, Online: Restoring the Cluster
- Automated, Offline: Restoring the Cluster
- Manual: Enabling the Backup on the Cluster
- Manual: Disabling the Backup on the Cluster
- Manual, Online: Restoring the Cluster
- Manual, Offline: Restoring the Cluster
- Additional configuration
- Migrating objectstore from persistent volume to raw disks
- Monitoring and alerting
- Migration and upgrade
- Migration options
- Step 1: Moving the Identity organization data from standalone to Automation Suite
- Step 2: Restoring the standalone product database
- Step 3: Backing up the platform database in Automation Suite
- Step 4: Merging organizations in Automation Suite
- Step 5: Updating the migrated product connection strings
- Step 6: Migrating standalone Insights
- Step 7: Deleting the default tenant
- B) Single tenant migration
- Product-specific configuration
- Best practices and maintenance
- Troubleshooting
- How to Troubleshoot Services During Installation
- How to Uninstall the Cluster
- How to clean up offline artifacts to improve disk space
- How to clear Redis data
- How to enable Istio logging
- How to manually clean up logs
- How to clean up old logs stored in the sf-logs bucket
- How to disable streaming logs for AI Center
- How to debug failed Automation Suite installations
- How to delete images from the old installer after upgrade
- How to automatically clean up Longhorn snapshots
- How to disable TX checksum offloading
- How to address weak ciphers in TLS 1.2
- Unable to run an offline installation on RHEL 8.4 OS
- Error in Downloading the Bundle
- Offline installation fails because of missing binary
- Certificate issue in offline installation
- First installation fails during Longhorn setup
- SQL connection string validation error
- Prerequisite check for selinux iscsid module fails
- Azure disk not marked as SSD
- Failure After Certificate Update
- Automation Suite not working after OS upgrade
- Automation Suite Requires Backlog_wait_time to Be Set 1
- Volume unable to mount due to not being ready for workloads
- RKE2 fails during installation and upgrade
- Failure to upload or download data in objectstore
- PVC resize does not heal Ceph
- Failure to Resize Objectstore PVC
- Rook Ceph or Looker pod stuck in Init state
- StatefulSet volume attachment error
- Failure to create persistent volumes
- Storage reclamation patch
- Backup failed due to TooManySnapshots error
- All Longhorn replicas are faulted
- Setting a timeout interval for the management portals
- Update the underlying directory connections
- Cannot Log in After Migration
- Kinit: Cannot Find KDC for Realm <AD Domain> While Getting Initial Credentials
- Kinit: Keytab Contains No Suitable Keys for *** While Getting Initial Credentials
- GSSAPI Operation Failed With Error: An Invalid Status Code Was Supplied (Client's Credentials Have Been Revoked).
- Alarm Received for Failed Kerberos-tgt-update Job
- SSPI Provider: Server Not Found in Kerberos Database
- Login Failed for User <ADDOMAIN><aduser>. Reason: The Account Is Disabled.
- ArgoCD login failed
- Failure to get the sandbox image
- Pods not showing in ArgoCD UI
- Redis Probe Failure
- RKE2 Server Fails to Start
- Secret Not Found in UiPath Namespace
- After the Initial Install, ArgoCD App Went Into Progressing State
- MongoDB pods in CrashLoopBackOff or pending PVC provisioning after deletion
- Unexpected Inconsistency; Run Fsck Manually
- Degraded MongoDB or Business Applications After Cluster Restore
- Missing Self-heal-operator and Sf-k8-utils Repo
- Unhealthy Services After Cluster Restore or Rollback
- RabbitMQ pod stuck in CrashLoopBackOff
- Prometheus in CrashloopBackoff state with out-of-memory (OOM) error
- Missing Ceph-rook metrics from monitoring dashboards
- Pods cannot communicate with FQDN in a proxy environment
- Using the Automation Suite Diagnostics Tool
- Using the Automation Suite Support Bundle Tool
- Exploring Logs
Document Understanding configuration file
Automation Suite Installation Guide
Last updated Nov 4, 2024
Document Understanding configuration file
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.
"documentunderstanding": {
"enabled": Boolean,
"datamanager": {
"sql_connection_str" : "String"
}
"handwriting": {
"enabled": Boolean,
"max_cpu_per_pod": "Number"
}
}
"documentunderstanding": {
"enabled": Boolean,
"datamanager": {
"sql_connection_str" : "String"
}
"handwriting": {
"enabled": Boolean,
"max_cpu_per_pod": "Number"
}
}
Note:
The data manager SQL connection string is optional only if you want to overwrite the default database with your own.
Handwriting is always enabled for online installation.
"documentunderstanding": {
"enabled": true,
"datamanager": {
"sql_connection_str": "mssql+pyodbc://testadmin:myPassword@mydev-sql.database.windows.net:1433/datamanager?driver=ODBC+Driver+17+for+SQL+Server",
},
"handwriting": {
"enabled": true,
"max_cpu_per_pod": "2"
}
}
"documentunderstanding": {
"enabled": true,
"datamanager": {
"sql_connection_str": "mssql+pyodbc://testadmin:myPassword@mydev-sql.database.windows.net:1433/datamanager?driver=ODBC+Driver+17+for+SQL+Server",
},
"handwriting": {
"enabled": true,
"max_cpu_per_pod": "2"
}
}
Note: The value for
max_cpu_per_pod
is by default 2
, but it can be adjusted according to your needs. For more information on how to do this, see the (optional) max CPU per pod Parameter section.
- 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 more details about connecting to SQL please refer to the Using the configuration file page.
- Settings for the handwriting recognition functionality (part of IntelligentFormExtractor)
- Required: False.
- Setting this to true creates the resources necessary for performing handwriting recognition. This needs to be true to use IntelligentFormExtractor.
- Required: False
- This property is always enabled for online installation, and disabled for offline (air-gapped) installation. For air-gapped installation, you need to install the Document Understanding offline bundle before enabling handwriting.
- The maximum amount of CPUs each container is allowed to use. The recommended value is 2.
- Required: False.
- Default: 2.
If you plan to use Intelligent Form Extractor with handwriting detection feature, you may need to adjust the
handwriting.max_cpu_per_pod
parameter for more processing power.
The following factors are required to calculate the right sizing:
- total volume of documents/year = V
- expected number of handwriting shreds/doc = S
- days in which the workflow processes documents (workdays, all days, weekends, etc) = d
- hours in which the workflow processes documents = h
- Number of CPUs = (V x S / (d x h)) / 1500
As an example, if you expect to have 1 million documents to process for a year using Intelligent Form Extractor for handwriting detection, with 50 shreds on average, running weekdays from 00:00 to 08:00 (8hr), the calculation would be:
Number of CPUs = (1,000,000 x 50 / (250 x 8)) / 1500
= 25,000 / 1500
= 17 CPUs
Number of CPUs = (1,000,000 x 50 / (250 x 8)) / 1500
= 25,000 / 1500
= 17 CPUs
For the single-node evaluation mode, you need to adjust the
max_cpu_per_pod
parameter to 17.
For the multi-node HA-ready production mode (3 nodes), adjust the
max_cpu_per_pod
parameter to 5-6.