update documentation

UiPath-Services · Apr 24, 2024 · 6791156 · 6791156
1 parent f6412d1
commit 6791156
Show file tree

Hide file tree

Showing 7 changed files with 70 additions and 36 deletions.
diff --git a/README.md b/README.md
@@ -81,14 +81,8 @@ Five available scripts can be utilized
 Each script will log all output to its own `*.log` file and sometimes to the console.
 
 ### Dependency
-`The scripts will automatically download the dependencies during the runtime`  
-[Official UiPath CLI](https://uipath.visualstudio.com/Public.Feeds/_artifacts/feed/UiPath-Official/NuGet/UiPath.CLI.Windows/versions/23.10.8753.32995)
 
+`The scripts will automatically download the UiPath.CLI during the runtime.`  
+- [Official UiPath CLI](https://uipath.visualstudio.com/Public.Feeds/_artifacts/feed/UiPath-Official/NuGet/UiPath.CLI.Windows/overview/23.10.8753.32995)
+- UiPath CLI prerequesites: [.NET 6.0.7](https://versionsof.net/core/6.0/6.0.7/), that must include [.NET 6.0.7 Desktop Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/6.0), that come with the 6.0.302 SDK.
 
-* Package Pack
-* Package Deploy
-* Job Run
-* Test Run
-* asset delete
-* asset deploy  
-* package analyze
diff --git a/docs/UiPathAnalyzeProject.md b/docs/UiPathAnalyzeProject.md
@@ -13,7 +13,6 @@ Examples:
     . 'C:\scripts\UiPathAnalyzeProject.ps1' "C:\UiPath\Project\project.json" -analyzerTraceLevel "Error" -stopOnRuleViolation true -treatWarningsAsErrors true -resultPath "C:\UiPath\Project\output.json"
     . 'C:\scripts\UiPathAnalyzeProject.ps1' "C:\UiPath\Project\project.json" -analyzerTraceLevel "Error" -stopOnRuleViolation true -treatWarningsAsErrors true -resultPath "C:\UiPath\Project\output.json" -ignoredRules "ST-NMG-009,ST-DBP-020,UI-USG-011,ST-DBP-020"
     . 'C:\scripts\UiPathAnalyzeProject.ps1' "C:\UiPath\Project\project.json" -analyzerTraceLevel "Error" -stopOnRuleViolation true -treatWarningsAsErrors true -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"
-    . '\UiPathAnalyzeProject.ps1' "C:\UiPath\Project\project.json" -analyzerTraceLevel "Error" -stopOnRuleViolation true -treatWarningsAsErrors true -resultPath . 'C:\scripts\UiPathAnalyzeProject.ps1' "C:\UiPath\Project\output.json" -analyzerTraceLevel "Error" -ignoredRules "ST-NMG-009,ST-DBP-020,UI-USG-011,ST-DBP-020" -orchestratorUrl "https://orchestratorurl.com" -orchestratorTenant "default"  -orchestratorFolder "OrchestratorFolder" -orchestratorAccountForApp AccountName -orchestratorApplicationId e5b7*************** -orchestratorApplicationSecret *************** -orchestratorApplicationScope "OR.Analytics OR.Assets OR.Audit OR.BackgroundTasks OR.Execution OR.Folders OR.Jobs OR.Machines OR.Monitoring OR.Queues OR.Robots.Read OR.Settings OR.Tasks OR.TestSetExecutions OR.Users.Read"
     
 
 #Note: if the script folder location is different, you need to replace "C:" with directory folder (e.g. '[FOLDER_VARIABLE]\scripts\UiPathPack.ps1')
@@ -79,4 +78,7 @@ Script Parameters
     (Optional, useful only for additional package feeds) The Orchestrator tenant.
 
 -  `uipathCliFilePath`
-    if not provided, the script will auto download the cli from uipath public feed. the script was tested on version 22.10.8438.32859
+    if not provided, the script will auto download the cli from uipath public feed. the script was tested on version 23.10.8753.32995
+
+- `SpecificCLIVersion`
+    CLI version to auto download if uipathCliFilePath not provided. Default is "23.10.8753.32995" where the script was last tested.
diff --git a/docs/UiPathDeploy.md b/docs/UiPathDeploy.md
@@ -72,4 +72,7 @@ Script Parameters
     Disable telemetry data.
 
 -  `uipathCliFilePath`
-    if not provided, the script will auto download the cli from uipath public feed. the script was tested on version 22.10.8438.32859
+    if not provided, the script will auto download the cli from uipath public feed. the script was tested on version 23.10.8753.32995
+
+- `SpecificCLIVersion`
+    CLI version to auto download if uipathCliFilePath not provided. Default is "23.10.8753.32995" where the script was last tested.
diff --git a/docs/UiPathJobRun.md b/docs/UiPathJobRun.md
@@ -109,4 +109,7 @@ Script Parameters
     Disable telemetry data.
 
 -  `uipathCliFilePath`
-    if not provided, the script will auto download the cli from uipath public feed. the script was tested on version 22.10.8438.32859
+    if not provided, the script will auto download the cli from uipath public feed. the script was tested on version 23.10.8753.32995
+
+- `SpecificCLIVersion`
+    CLI version to auto download if uipathCliFilePath not provided. Default is "23.10.8753.32995" where the script was last tested.
diff --git a/docs/UiPathManageAssets.md b/docs/UiPathManageAssets.md
@@ -83,4 +83,7 @@ Script Parameters
     Disable telemetry data.
 
 -  `uipathCliFilePath`
-    if not provided, the script will auto download the cli from uipath public feed. the script was tested on version 22.10.8438.32859
+    if not provided, the script will auto download the cli from uipath public feed. the script was tested on version 23.10.8753.32995
+
+- `SpecificCLIVersion`
+    CLI version to auto download if uipathCliFilePath not provided. Default is "23.10.8753.32995" where the script was last tested.
diff --git a/docs/UiPathPack.md b/docs/UiPathPack.md
@@ -23,59 +23,63 @@ Examples:
 More on different authentication options here [UiPathAuthenticationsOptions](UiPathAuthenticationsOptions.md)
 
 Script Parameters
--  `project_path` 
+
+- `project_path` 
      Required. Path to a project.json file or a folder containing project.json files.
 
--  `destination_folder` 
+- `destination_folder` 
      Required. Destination folder.
 
--  `libraryOrchestratorUrl` 
+- `libraryOrchestratorUrl` 
     (Optional, useful only for libraries) The Orchestrator URL.
 
--  `libraryOrchestratorTenant` 
+- `libraryOrchestratorTenant` 
     (Optional, useful only for libraries) The Orchestrator tenant.
 
--  `libraryOrchestratorUsername`
+- `libraryOrchestratorUsername`
     (Optional, useful only for libraries) The Orchestrator password used for authentication. Must be used together with the username.
 
--  `libraryOrchestratorPassword`
+- `libraryOrchestratorPassword`
     (Optional, useful only for libraries) The Orchestrator username used for authentication. Must be used together with the password.
 
--  `libraryOrchestratorUserKey`
+- `libraryOrchestratorUserKey`
     (Optional, useful only for libraries) The Orchestrator OAuth2 refresh token used for authentication. Must be used together with the account name and client id.
 
--  `libraryOrchestratorAccountName`
+- `libraryOrchestratorAccountName`
     (Optional, useful only for libraries) The Orchestrator CloudRPA account name. Must be used together with the refresh token and client id.
 
--  `libraryOrchestratorAccountForApp`
+- `libraryOrchestratorAccountForApp`
     (Optional, useful only for libraries) The Orchestrator CloudRPA account name. Must be used together with id, secret and scope(s) for external application.
 
--  `libraryOrchestratorApplicationId`
+- `libraryOrchestratorApplicationId`
     (Optional, useful only for libraries) The external application id. Must be used together with account, secret and scope(s) for external application.
 
--  `libraryOrchestratorApplicationSecret`
+- `libraryOrchestratorApplicationSecret`
     (Optional, useful only for libraries) The external application secret. Must be used together with account, id and scope(s) for external application.
 
--  `libraryOrchestratorApplicationScope`
+- `libraryOrchestratorApplicationScope`
     (Optional, useful only for libraries) The space-separated list of application scopes. Must be used together with account, id and secret for external application.
 
--  `libraryOrchestratorFolder`
+- `libraryOrchestratorFolder`
     (Optional, useful only for libraries) The Orchestrator folder (organization unit).
 
--  `version`
+- `version`
     Package version.
 
--  `autoVersion`
+- `autoVersion`
     Auto-generate package version.
 
--  `outputType`
+- `outputType`
     Force the output to a specific type. <Process|Library|Tests|Objects>
 
--  `language`
+- `language`
     The orchestrator language.
 
--  `disableTelemetry`
+- `disableTelemetry`
     Disable telemetry data.
 
--  `uipathCliFilePath`
-    if not provided, the script will auto download the cli from uipath public feed. the script was tested on version 22.10.8438.32859
+- `uipathCliFilePath`
+    if not provided, the script will auto download the cli from uipath public feed. the script was tested on version 23.10.8753.32995
+
+- `SpecificCLIVersion`
+    CLI version to auto download if uipathCliFilePath not provided. Default is "23.10.8753.32995" where the script was last tested.
diff --git a/docs/UiPathRunTest.md b/docs/UiPathRunTest.md
@@ -15,6 +15,7 @@ Examples:
     . 'C:\scripts\UiPathRunTest.ps1' -orchestrator_url "https://uipath-orchestrator.myorg.com" -orchestrator_tenant default -UserKey a7da29a2c93a717110a82 -account_name myAccount -project_path "C:\UiPath\Project\project.json" -environment TestingEnv --out junit
     . 'C:\scripts\UiPathRunTest.ps1' -orchestrator_url "https://uipath-orchestrator.myorg.com" -orchestrator_tenant default -UserKey a7da29a2c93a717110a82 -account_name myAccount -project_path "C:\UiPath\Project\project.json" -environment TestingEnv -result_path "C:\results.json" -out uipath -language en-US
     . 'C:\scripts\UiPathRunTest.ps1' -orchestrator_url "https://uipath-orchestrator.myorg.com" -orchestrator_tenant default -UserKey a7da29a2c93a717110a82 -account_name myAccount -project_path "C:\UiPath\Project\project.json" -environment TestingEnv -result_path "C:\results.json" -input_path "C:\UiPath\Project\input-params.json" -out uipath -language en-US
+    . 'C:\scripts\UiPathRunTest.ps1' -orchestrator_url "https://uipath-orchestrator.myorg.com" -orchestrator_tenant default -UserKey a7da29a2c93a717110a82 -account_name myAccount -project_path "C:\UiPath\Project\project.json" -environment TestingEnv -result_path "C:\results.json" -input_path "C:\UiPath\Project\input-params.json" -out uipath -language en-US -attachRobotLogs "true"
 
 #Note: if script folder location is different you need to replace C: with directory folder (e.g. '[FOLDER_VARIABLE]\scripts\UiPathPack.ps1')
 ```
@@ -83,5 +84,29 @@ Script Parameters
 - `disableTelemetry`
     Disable telemetry data.
 
--  `uipathCliFilePath`
-    if not provided, the script will auto download the cli from uipath public feed. the script was tested on version 22.10.8438.32859
+- `uipathCliFilePath`
+    if not provided, the script will auto download the cli from uipath public feed. the script was tested on version 23.10.8753.32995
+
+- `SpecificCLIVersion`
+    CLI version to auto download if uipathCliFilePath not provided. Default is "23.10.8753.32995" where the script was last tested.
+
+- `attachRobotLogs`
+    Attaches Robot Logs for each testcases along with Junit Test Report.
+
+- `repositoryUrl`
+    Repository url where project is versioned.
+
+- `repositoryCommit`
+    Repository commit where the project was built from.
+
+- `repositoryBranch`
+    Repository branch where the project was built from.
+
+- `repositoryType`
+    VCS system repository type.
+
+- `projectUrl`
+    Automation Hub idea URL.
+
+- `identityUrl`
+    Url of your identity server. This is only required for PaaS deployments.