- Getting Started
- Studio
- Orchestrator
- Testing robots
- Test Manager
- CI/CD Integrations
Analyzing a Project
Prerequisites:
- Create a project.
- Run the CLI
exe
(for Windows) ordll
(for Linux) file. - Add the Orchestrator API Access Application Scopes below:
Application Scope
Description
OR.Assets
Assets read and write access in Orchestrator.
OR.BackgroundTasks
BackgroundTasks read and write access in Orchestrator.
OR.Execution
Execution read and write access in Orchestrator.
OR.Folders
Folders read and write access in Orchestrator.
OR.Jobs
Jobs read and write access in Orchestrator.
OR.Machines.Read
Machines read access in Orchestrator.
OR.Monitoring
Monitoring read and write access in Orchestrator.
OR.Robots.Read
Robots read access in Orchestrator.
OR.Settings.Read
Settings read access in Orchestrator.
OR.TestSets
TestSets read and write access in Orchestrator.
OR.TestSetExecutions
TestSetExecutions read and write access in Orchestrator.
OR.TestSetSchedules
TestSetSchedules read and write access in Orchestrator.
OR.Users.Read
Users read access in Orchestrator.
Legend: (*) - Optional, recommended when using additional package feeds.
Parameter |
Description |
---|---|
Project(s) Path (pos.0) (Required)
|
The path to the
project.json file, or the path to the folder that contains multiple project.json files.
|
|
Choose what types of messages to output after analyzing:
|
|
The job fails when any rule is violated. |
|
Treat warnings as errors. |
|
The full path to a JSON file where you want to store the results. If you don't add this as an argument, then the results will print only in the standard console. |
|
A list of rules that you want to ignore during the analysis, separated by commas. |
--orchestratorUsername (*)
(Required if you use Basic Authentication, through a username and a password) |
The username used for authenticating to Orchestrator. You must pair it with the corresponding password. |
--orchestratorPassword (*)
(Required if you use Basic Authentication, through a username and a password) |
The password used for authenticating to Orchestrator. You must pair it with the corresponding username. |
-orchestratorAuthToken (*)
(Required if you use token-based authentication) |
The OAuth2 refresh token used for authenticating to Orchestrator. You must pair it with the Account Name and Client ID. |
--orchestratorAccountName (*)
(Required if you use token-based authentication) |
The Orchestrator CloudRPA account name. You must pair it with the OAuth2 refresh token and Client ID. |
--orchestratorAccountForApp (*)
|
The Orchestrator CloudRPA account name. You must pair it with the Application ID,Application Secret, and Application scope for external application. |
--orchestratorApplicationId (*)
(Required if you use external application authentication) |
The external Application ID. You must pair it with the **Application Account, Application Secret, and Application scope. |
--orchestratorApplicationSecret (*)
(Required if you use external application authentication) |
The external Application Secret. You must pair it with the Application Account,Application ID, and Application scope. |
--orchestratorApplicationScope (*)
(Required if you use external application authentication) |
The list of application scopes, separated by single spaces. You must pair it with the Application Account,Application ID, and Application Secret for external application. |
--orchestratorFolder (*)
|
The name of the target Orchestrator folder. To input subfolders make sure to input both the parent folder
name and the name of the subfolder. For instance, use
AccountingTeam\TeamJohn .
|
--orchestratorUrl (*)
|
The URL of the Orchestrator instance. |
--orchestratorTenant (*)
|
The tenant of the Orchestrator instance where you want to delete a machine. |
|
Displays the parameters and examples for this command. |
Examples:
package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json"
package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json" --ignoredRules "ST-NMG-009,ST-DBP-020,UI-USG-011,ST-DBP-020"
package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json" --ignoredRules "ST-NMG-009,ST-DBP-020,UI-USG-011,ST-DBP-020" --orchestratorUrl "https://orchestratorurl.com" --orchestratorTenant "default" --orchestratorUsername "username" --orchestratorPassword "\_ye5zG9(x" --orchestratorAuthToken "AuthToken" --orchestratorAccountName "AccountName" --orchestratorFolder "OrchestratorFolder"