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

Automation Suite installation guide

Last updated Feb 24, 2025

Using the Orchestrator Configurator Tool

The Orchestrator Configurator Tool is a bash script that allows you to place files and settings inside the Orchestrator deployment in Automation Suite. The tool helps you add storage files, credential store plugins, NLog extensions, new NLog configurations, and override appSettings.

The environment where you use the Orchestrator Configurator Tool must be able to run a bash script and have the following tools:

  • kubectl configured with a connection to the cluster
  • jq 1.6
  • s3cmd
Important:

Do not download and use the ArgoCD CLI tool independently. To maintain compatibility and ensure smooth operation, we recommend using the ArgoCD we bundle within the Automation Suite artifacts. To do that, you must add ArgoCD to your path from the latest installer by running the following command: 

export PATH="$PATH:/opt/UiPathAutomationSuite/<version>/installer/bin"export PATH="$PATH:/opt/UiPathAutomationSuite/<version>/installer/bin"

To be able to run Orchestraor Configurator Tool from any location, follow these steps:

  1. Update the PATH variable so as to include <installer-dir>/Tools. For example:

    export PATH="$PATH:/opt/UiPathAutomationSuite/online_installer_<version>/Tools"

  2. Make sure that the jq --version utility version is 1.6. If it's not, update it through one of these options:
    yum install -y epel-release yum install -y jqyum install -y epel-release yum install -y jq

    or

    curl https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/j/jq-1.6-2.el7.x86_64.rpm --output /tmp/jq-1.6-2.el7.x86_64.rpm
yum localinstall /tmp/jq-1.6-2.el7.x86_64.rpm
jq --versioncurl https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/j/jq-1.6-2.el7.x86_64.rpm --output /tmp/jq-1.6-2.el7.x86_64.rpm
yum localinstall /tmp/jq-1.6-2.el7.x86_64.rpm
jq --version

Example:

Usage: ./orchestrator_configurator.sh \
  -s blobstoragefolder -p pluginsfolder -n nlogextensionsfolder \
  -c appsettings.json -l nlog.custom.config 

    -c|--app-settings
        application configuration file containing json with key-value structure
    -l|--nlog-config-file
        nlog config file, json

    -s|--storage-folder
        location of the storage folder on the local disk
    -n|--nlog-extensions-folder
        location of the nlog extensions on the local disk
    -p|--securestore-plugins-folder
        location of the securestore plugins on the local disk

    -d|--dry-run
        do not update the orchestrator app with the new values
    -y|--accept-all
        do not prompt for confirmation of actions and overwriting of files with kubectl cp.Usage: ./orchestrator_configurator.sh \
  -s blobstoragefolder -p pluginsfolder -n nlogextensionsfolder \
  -c appsettings.json -l nlog.custom.config 

    -c|--app-settings
        application configuration file containing json with key-value structure
    -l|--nlog-config-file
        nlog config file, json

    -s|--storage-folder
        location of the storage folder on the local disk
    -n|--nlog-extensions-folder
        location of the nlog extensions on the local disk
    -p|--securestore-plugins-folder
        location of the securestore plugins on the local disk

    -d|--dry-run
        do not update the orchestrator app with the new values
    -y|--accept-all
        do not prompt for confirmation of actions and overwriting of files with kubectl cp.

To apply new application settings, run the following command:

./orchestrator_configurator.sh -c appsettings.json./orchestrator_configurator.sh -c appsettings.json
If the appsettings.json file does not exist, you can create it yourself, as shown in the following example: 
{
    "ExampleSetting.Enabled": true,
    "ExampleSetting.Type": "BasicExample",
    "ExampleSetting.Count": 3
}{
    "ExampleSetting.Enabled": true,
    "ExampleSetting.Type": "BasicExample",
    "ExampleSetting.Count": 3
}

To change NLog configuration, run the following command:

./orchestrator_configurator.sh -l nlog.custom.json./orchestrator_configurator.sh -l nlog.custom.json

Example:

{
  "Nlog": {
    "targets": {
      "robotElasticBuffer": {
        "flushTimeout": 1000,
        "bufferSize": 1000,
        "slidingTimeout": false,
        "target": {
          "uri": "https://elastic.example.com:9200",
          "requireAuth": true,
          "username": "elastic-user",
          "password": "elastic-password",
          "index": "${event-properties:item=indexName}-${date:format=yyyy.MM}",
          "documentType": "logEvent",
          "includeAllProperties": true,
          "layout": "${message}",
          "excludedProperties": "agentSessionId,tenantId,indexName"
        }
      }
    }
  }
}{
  "Nlog": {
    "targets": {
      "robotElasticBuffer": {
        "flushTimeout": 1000,
        "bufferSize": 1000,
        "slidingTimeout": false,
        "target": {
          "uri": "https://elastic.example.com:9200",
          "requireAuth": true,
          "username": "elastic-user",
          "password": "elastic-password",
          "index": "${event-properties:item=indexName}-${date:format=yyyy.MM}",
          "documentType": "logEvent",
          "includeAllProperties": true,
          "layout": "${message}",
          "excludedProperties": "agentSessionId,tenantId,indexName"
        }
      }
    }
  }
}

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.