UiPath Installation and Upgrade

The UiPath Installation and Upgrade Guide

Command Line Parameters for Insights Admin Tool

The Insights Admin Tool can be used to perform many administrative actions that may be required for your Insights instance. Here we provide the various available commands, as well as their parameters, when using the tool from the command prompt. The Insights Admin Tool can also be used via a GUI to perform all function except Upgrade.

Enable / Disable

Enable or disable Insights for the designated tenant(s).

Parameter

Description

--tenant, -t

The tenant(s) to be enabled or disabled.

--user, -u

The Orchestrator host admin user.

--password, -p

The password for the Orchestrator host admin user.

--lang

The language to be used for dashboard localization. By default, English is used.

Supported language codes:
en (English)
zh-CN (Chinese)
pt-BR (Portuguese Brazil)
es (Spanish)
es-MX (Spanish Mexico)
fr (French)
ja (Japanese)
de (German)
ru (Russian)

--replaceDashboards

Replace any existing OOTB dashboards.

--replaceCube

Replace any existing data cube.

--warmStartDays

Number of days of historical data to be ingested, by default this is set to 30.

--debug, -d

Enable debug messages in the output.

--prompt

Prompts the user for each feature.

--log-file

Indicate the file where the tool logs are written.

--help

Displays usage information for the Admin Tool.

--version

Displays version details.

For example: UiPath.InsightsAdminTool.exe enable --user HOST_USER --password HOST_USER_PASSWORD --tenant Default

Interactive

A walk-through for selecting on which tenant to enable Insights.

Parameter

Description

--user, -u

The Orchestrator host admin user.

--password, -p

The password for the Orchestrator host admin user.

--lang

The language to be used for dashboard localization. By default, English is used.

Supported language codes:
en (English)
zh-CN (Chinese)
pt-BR (Portuguese Brazil)
es (Spanish)
es-MX (Spanish Mexico)
fr (French)
ja (Japanese)
de (German)
ru (Russian)

--debug, -d

Enable debug messages in the output.

--prompt

Prompts the user for each feature.

--log-file

Indicate the file where the tool logs are written.

--help

Displays usage information for the Admin Tool.

--version

Displays version details.

For example: UiPath.InsightsAdminTool.exe interactive --user HOST_USER --password HOST_USER_PASSWORD

List

Displays a list of the available tenants.

Parameter

Description

--user, -u

The Orchestrator host admin user.

--password, -p

The password for the Orchestrator host admin user.

--debug, -d

Enable debug messages in the output.

--prompt

Prompts the user for each feature.

--log-file

Indicate the file where the tool logs are written.

--help

Displays usage information for the Admin Tool.

--version

Displays version details.

For example: UiPath.InsightsAdminTool.exe list --user HOST_USER --password HOST_USER_PASSWORD

groupedTables

Create grouped tables based upon a provided JSON configuration.

Parameter

Description

--groups

The grouping definition file.

--debug, -d

Enable debug messages in the output.

--prompt

Prompts the user for each feature.

--log-file

Indicate the file where the tool logs are written.

--help

Displays usage information for the Admin Tool.

--version

Displays version details.

For example: UiPath.InsightsAdminTool.exe groupedTables --groups C:\groupings.json --log-file C:\customTables.log --prompt --debug

Rebuild

Force a rebuild of the existing data models.

Parameter

Description

--tenant, -t

The tenant targeted.

--debug, -d

Enable debug messages in the output.

--prompt

Prompts the user for each feature.

--log-file

Indicate the file where the tool logs are written.

--help

Displays usage information for the Admin Tool.

--version

Displays version details.

For example: UiPath.InsightsAdminTool.exe rebuild -t TENANT_NAME

buildStatus

Display the current status of a tenant data cube build.

Parameter

Description

--tenant, -t

The tenant targeted.

--debug, -d

Enable debug messages in the output.

--prompt

Prompts the user for each feature.

--log-file

Indicate the file where the tool logs are written.

--help

Displays usage information for the Admin Tool.

--version

Displays version details.

For example: UiPath.InsightsAdminTool.exe buildStatus -t TENANT_NAME

getBuildLogs

Display logs for the most recent data cube build for a specified tenant.

Parameter

Description

--tenant, -t

The tenant targeted.

--output, -o

The output file.

--debug, -d

Enable debug messages in the output.

--prompt

Prompts the user for each feature.

--log-file

Indicate the file where the tool logs are written.

--help

Displays usage information for the Admin Tool.

--version

Displays version details.

For example: UiPath.InsightsAdminTool.exe getBuildLogs --tenant TENANT_NAME –output FILE_NAME

updateDB

Update the Orchestrator or Insights database configuration.

Parameter

Description

--user, -u

The Orchestrator host admin user.

--password, -p

The Orchestrator host admin password.

--databaseType, -c

The targeted database. The available options are:
Orchestrator - the Orchestrator database.
Insights - the Insights database.

--databaseServer, -s

The server for the targeted database.

--databaseName, -n

The database name.

--windowsAuth, -a

The authentication type for the database. The available options are:
0 - SQL authentication is used.
1 - Windows authentication is used.

--sqlUser, -r

The username for the targeted database.
Only required for SQL Authentication.

--sqlPassword, -w

The password of your database user.
Only required for SQL Authentication.

--debug, -d

Enable debug messages in the output.

--prompt

Prompts the user for each feature.

--log-file

Indicate the file where the tool logs are written.

--help

Displays usage information for the Admin Tool.

--version

Displays version details.

For example: UiPath.InsightsAdminTool.exe updateDB -u admin -p Orch_Host_Password -c Orchestrator -s sql.uipath.com -n UiPathOrchestrator -r docs-uipath -w my_SQL_Password

Upgrade

Upgrade any desired tenant(s) to the current Insights version.

Parameter

Description

--user, -u

The Orchestrator host admin user.

--password, -p

The Orchestrator host admin password.

--tenant, -t

The tenant to be upgraded. If not provided, all tenants are upgraded.

--debug, -d

Enable debug messages in the output.

--prompt

Prompts the user for each feature.

--log-file

Indicate the file where the tool logs are written.

--help

Displays usage information for the Admin Tool.

--version

Displays version details.

For example: UiPath.InsightsAdminTool.exe upgrade -u admin -p Orch_Host_Password -t Default

5个月前更新


Command Line Parameters for Insights Admin Tool


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.