- 基本情報
- Studio
- Orchestrator
- Testing ロボット
- Test Manager
- CI/CD との連携
タスクを実行する
Windows デバイス用に設計された UiPath CLI (UiPath.CLI.Windows) 内でタスクを実行するには、必要な作業がいくつかあります。
UiPath.CLI.Windows の手順と UiPath.CLI (Linux デバイス用に設計された UiPath CLI) の手順の主な違いは、CLI を実行するデバイスの種類に固有のタスクで渡すことができる追加の引数にあります。
The action could not be performed because the project is already opened in another Studio instance. Please close it and try again. (操作を実行できませんでした。このプロジェクトは別の Studio インスタンスですでに開かれています。プロジェクトを閉じてから、もう一度お試しください。)」というエラー メッセージが表示されます。以下の表は、CLI タスクを実行するために必要な Orchestrator API アクセスのアプリケーション スコープを示しています。
|
アプリケーション スコープ |
説明 |
|---|---|
|
OR.Assets |
Orchestrator でのアセットの読み取り/書き込みアクセス権 |
|
OR.BackgroundTasks |
Orchestrator でのバックグラウンド タスクの読み取り/書き込みアクセス権 |
|
OR.Execution |
Orchestrator での実行の読み取り/書き込みアクセス権 |
|
OR.Folders |
Orchestrator でのフォルダーの読み取り/書き込みアクセス権 |
|
OR.Jobs |
Orchestrator でのジョブの読み取り/書き込みアクセス権 |
|
OR.Machines.Read |
Orchestrator でのマシンの読み取りアクセス権 |
|
OR.Monitoring |
Orchestrator での監視の読み取り/書き込みアクセス権 |
|
OR.Robots.Read |
Orchestrator での Robot の読み取りアクセス権 |
|
OR.Settings.Read |
Orchestrator での設定の読み取りアクセス権 |
|
OR.TestSets |
Orchestrator でのテスト セットの読み取り/書き込みアクセス権 |
|
OR.TestSetExecutions |
Orchestrator でのテスト セット実行の読み取り/書き込みアクセス権 |
|
OR.TestSetSchedules |
Orchestrator でのテスト セットのスケジュールの読み取り/書き込みアクセス権 |
|
OR.Users.Read |
Orchestrator でのユーザーの読み取りアクセス権 |
表に示されているスコープに加えて、強調表示する重要なスコープは OR です。デフォルト。OR.既定のスコープはワイルドカードとして機能します。組織レベルとフォルダー レベルの両方で、きめ細かいロール固有のアクセス権を提供します。 これにより、事前定義された組織全体のスコープを超えて、アプリケーションのアクセス許可を柔軟に正確に制御できます。 詳しくは、「 スコープの宣言」をご覧ください。
前提条件: Windows 用の UiPath CLI を使用してタスクを実行するには、.NET 6.0.7 をインストールします。これには、6.0.302 SDK に付属する .NET 6.0.7 Desktop Runtime が含まれている必要があります。
uipcli.exe を、対応するパラメーターを含めて呼び出します。サブタスクを実行するには、コマンドが uipcli.exe <task name> <sub-task name> の形式である必要があります。CLI を実行するには、以下の手順を実行します。
- コマンド プロンプトを開き、NUPKG ファイルから展開したフォルダーに移動します。
- 「
uipcli.exe」と入力し、Enter キーを押します。
前提条件: クロスプラットフォーム用の UiPath CLI を使用してジョブ タスクを実行するには、6.0.302 SDK に付属する .NET 6.0.7 をインストールします。
uipcli.exe を、対応するパラメーターを含めて呼び出します。サブタスクを実行するには、コマンドが dotnet uipcli.dll <task name> <sub-task name> の形式である必要があります。CLI を実行するには、以下の手順を実行します。
- コマンド プロンプトを開き、NUPKG ファイルから展開したフォルダーに移動します。
- 「
dotnet uipcli.dll」と入力し、Enter キーを押します。
前提条件:
- Orchestrator 内にアセットを作成します。
- 削除するアセットを含む CSV ファイルを作成します。CSV ファイルには、
name、type、valueの 3 つの列が必要です。type列とvalue列の下のデータ セルは空のままで構いません。 - CLI の
exeファイル (Windows の場合) またはdllファイル (Linux の場合) を実行します。 - 必要な Orchestrator API アクセスのアプリケーション スコープを追加します。
CSV ファイルについて詳しくは、以下の表の例をご覧ください。
|
name |
type |
value |
|---|---|---|
|
asset1_name | N/A | N/A |
|
asset2_name |
Bool |
|
|
asset3_name |
integer | N/A |
|
asset4_name |
Credential |
username:password |
Orchestrator からアセットを削除するには、以下の手順を実行します。
例:
asset delete assets_file.csv "https://uipath-orchestrator.myorg.com"default -u admin -p 123456 -l en-USasset delete assets_file.csv "https://uipath-orchestrator.myorg.com"default -u admin -p 123456 -o OurOrganizationasset delete assets_file.csv "https://uipath-orchestrator.myorg.com"default -t a7da29a2c93a717110a82 -a myAccountasset delete assets_file.csv "https://uipath-orchestrator.myorg.com"default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read"
前提条件:
- Orchestrator にデプロイするアセットを含む CSV ファイルを作成します。
CSV ファイルには、
name、type、value、descriptionの 4 つの列が必要です。 - CLI の
exeファイル (Windows の場合) またはdllファイル (Linux の場合) を実行します。 - 必要な Orchestrator API アクセスのアプリケーション スコープを追加します。
CSV ファイルについて詳しくは、以下の例をご覧ください。
|
name |
type |
value |
説明 |
|---|---|---|---|
|
asset_1_name |
text |
"i have a comment" |
asset_1_description |
|
asset_2_name |
integer |
|
asset_2_description |
|
asset_3_name |
Bool |
|
asset_3_description |
|
asset_4_name |
Credential |
username:password |
asset_4_description |
Orchestrator にアセットをデプロイするには、以下の手順を実行します。
例:
asset deploy assets_file.csv "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -l en-USです。asset deploy assets_file.csv "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -o OurOrganizationです。asset deploy assets_file.csv "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccountです。asset delete assets_file.csv "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read"です。
- Orchestrator 内にプロセスを作成します。
- CLI の
exeファイル (Windows の場合) またはdllファイル (Linux の場合) を実行します。 - 必要な Orchestrator API アクセスのアプリケーション スコープを追加します。
job run ProcessName "https://uipath-orchestrator.myorg.com"default -u admin -p 123456 -P High -o MyFolderjob run ProcessName "https://uipath-orchestrator.myorg.com"default -t a7da29a2c93a717110a82 -a myAccount -P High -j 3 -w falsejob run ProcessName "https://uipath-orchestrator.myorg.com"default -t a7da29a2c93a717110a82 -a myAccount -r robotName -R C:\Temp\status.json
前提条件:
- プロジェクトを作成します。
- CLI の
exeファイル (Windows の場合) またはdllファイル (Linux の場合) を実行します。 - 必要な Orchestrator API アクセスのアプリケーション スコープを追加します。
プロジェクトの検証は、UiPath CLI のパック タスクや分析タスクでは実行されません。
|
パラメーター |
説明 |
|---|---|
Project(s) Path (pos.0) (必須)
|
project.json ファイルのパス、または複数の project.json ファイルを含むフォルダーのパスです。
|
|
|
分析後に出力するメッセージの種類を選択します。
|
|
|
ルールに違反した場合、ジョブは失敗します。 |
|
|
警告をエラーとして扱います。 |
|
|
結果を保存する JSON ファイルのフル パスです。 これを引数として追加しない場合、結果は標準コンソールにのみ出力されます。 |
|
|
分析時に無視するルールをコンマで区切って列挙したリストです。 |
--orchestratorUsername (*)
(ユーザー名とパスワードによる基本認証を使用する場合は必須) |
Orchestrator への認証に使用するユーザー名です。対応するパスワードと組み合わせて使用する必要があります。 |
--orchestratorPassword (*)
(ユーザー名とパスワードによる基本認証を使用する場合は必須) |
Orchestrator への認証に使用するパスワードです。対応するユーザー名と組み合わせて使用する必要があります。 |
-orchestratorAuthToken (*)
(トークンベースの認証を使用する場合は必須) |
Orchestrator への認証に使用する OAuth2 更新トークンです。アカウント名およびクライアント ID と組み合わせて使用する必要があります。 |
--orchestratorAccountName (*)
(トークンベースの認証を使用する場合は必須) |
Orchestrator Cloud RPA のアカウント名です。OAuth2 更新トークンおよびクライアント ID と組み合わせて使用する必要があります。 |
--orchestratorAccountForApp (*)
|
Orchestrator Cloud RPA のアカウント名 (組織名) です。外部アプリケーションのアプリケーション ID、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。 |
--orchestratorApplicationId (*)
(外部アプリケーション認証を使用する場合は必須) |
外部アプリケーション ID です。**アプリケーション アカウント、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。 |
--orchestratorApplicationSecret (*)
(外部アプリケーション認証を使用する場合は必須) |
外部アプリケーション シークレットです。アプリケーション アカウント、アプリケーション ID、アプリケーション スコープと組み合わせて使用する必要があります。 |
--orchestratorApplicationScope (*)
(外部アプリケーション認証を使用する場合は必須) |
アプリケーション スコープを単一のスペースで区切って列挙したリストです。外部アプリケーションのアプリケーション アカウント、アプリケーション ID、アプリケーション シークレットと組み合わせて使用する必要があります。 |
--orchestratorFolder (*)
|
対象の Orchestrator フォルダーの名前です。 サブフォルダーを入力するには、親フォルダーの名前とサブフォルダーの名前の両方を入力してください。例:
AccountingTeam\TeamJohn
|
--orchestratorUrl (*)
|
Orchestrator インスタンスの URL です。 |
--orchestratorTenant (*)
|
マシンを削除する Orchestrator インスタンスのテナントです。 |
|
|
このコマンドのパラメーターと例を表示します。 |
例:
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"
前提条件:
- パッケージを Orchestrator にパブリッシュします。
- CLI の
exeファイル (Windows の場合) またはdllファイル (Linux の場合) を実行します。 - 必要な Orchestrator API アクセスのアプリケーション スコープを追加します。
例:
package delete PackageName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -l en-USです。package delete PackageName "https://uipath-orchestrator.myorg.com" default -t refreshToken -a accountNameです。package delete PackageName "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read"です。
前提条件:
- パッケージを作成します。
- CLI の
exeファイル (Windows の場合) またはdllファイル (Linux の場合) を実行します。 - 必要な Orchestrator API アクセスのアプリケーション スコープを追加します。
uipcli により、default エントリ ポイントを持つプロセスが作成されます。エントリ ポイントを指定した場合は、そのエントリ ポイントを持つプロセスが作成され、プロセス名に _{entryPoint} が付加されます。さらに、プロセスが手動で作成されたか、パイプラインから作成されたかにかかわらず、package.Id に関連付けられているすべてのプロセスが最新バージョンに更新されます。
例:
package deploy "C:\UiPath\Project\TestsPackage.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -e SAPEnvironment,ExcelAutomationEnvironment -l en-USです。package deploy "C:\UiPath\Project\TestsPackage.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -A myAccountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read"です。package deploy "C:\UiPath\Project\TestsPackage.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -e SAPEnvironment,ExcelAutomationEnvironment -l en-US -h EntryPoint1,EntryPoint2です。
前提条件:
- プロジェクトを作成します。
- CLI の
exeファイル (Windows の場合) またはdllファイル (Linux の場合) を実行します。 - 必要な Orchestrator API アクセスのアプリケーション スコープを追加します。
プロジェクトの検証は、UiPath CLI のパック タスクや分析タスクでは実行されません。
凡例: (*) - 任意です。Orchestrator のライブラリとの依存関係がある場合にのみ有効です。
|
パラメーター |
説明 |
|---|---|
Project(s) Path (pos. 0) (必須)
|
project.json ファイルのパス、または project.json ファイルを含むフォルダーのパスです。
|
-o または --output (必須)
|
プロジェクトのパッケージ化先の Orchestrator フォルダーです。 |
-v または --version |
パッケージのバージョンを設定します。 |
|
|
パッケージのバージョンを自動生成します。 |
|
|
特定の種類に出力を強制します。 |
|
|
リリース ノートを追加する |
--libraryOrchestratorUsername (*)
(ユーザー名とパスワードによる基本認証を使用する場合は必須) |
Orchestrator への認証に使用するユーザー名です。対応するパスワードと組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。 |
--libraryOrchestratorPassword (*)
(ユーザー名とパスワードによる基本認証を使用する場合は必須) |
Orchestrator への認証に使用するパスワードです。対応するユーザー名と組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。 |
--libraryOrchestratorAuthToken (*)
(トークンベースの認証を使用する場合は必須) |
Orchestrator への認証に使用する OAuth2 更新トークンです。アカウント名およびクライアント ID と組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。 |
--libraryOrchestratorAccountName (*)
(トークンベースの認証を使用する場合は必須) |
Orchestrator Cloud RPA のアカウント名です。OAuth2 更新トークンおよびクライアント ID と組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。 |
--libraryOrchestratorAccountForApp (*)
|
Orchestrator Cloud RPA のアカウント名 (組織名) です。外部アプリケーションのアプリケーション ID、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。 |
--libraryOrchestratorApplicationId (*)
(外部アプリケーション認証を使用する場合は必須) | 外部アプリケーション ID です。アプリケーション アカウント、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。 |
--libraryOrchestratorApplicationSecret (*)
(外部アプリケーション認証を使用する場合は必須) |
外部アプリケーション シークレットです。アプリケーション アカウント、アプリケーション ID、アプリケーション スコープと組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。 |
--libraryOrchestratorApplicationScope (*)
(外部アプリケーション認証を使用する場合は必須) |
アプリケーション スコープを単一のスペースで区切って列挙したリストです。外部アプリケーションのアプリケーション アカウント、アプリケーション ID、アプリケーション シークレットと組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。 |
--libraryOrchestratorFolder (*)
|
対象の Orchestrator フォルダーの名前です。 サブフォルダーを入力するには、親フォルダーの名前とサブフォルダーの名前の両方を入力してください。例:
AccountingTeam\TeamJohn
|
--libraryOrchestratorUrl (*)
|
Orchestrator インスタンスの URL です。 |
--libraryOrchestratorTenant (*)
|
マシンを削除する Orchestrator インスタンスのテナントです。 |
-y または --disableTelemetry |
テレメトリ データを無効化します。 |
|
|
イベントのトレースを表示します。 |
-l または --language |
Orchestrator のユーザー インターフェイスで使用する言語です。 |
|
|
組み込みの NuGet フィードを無効にします。 |
|
|
このコマンドのパラメーターと例を表示します。 |
例:
package pack "C:\UiPath\Project\project.json" -o "C:\UiPath\Package" -v 1.0.6820.22047です。package pack "C:\UiPath\Project\project.json" -o "C:\UiPath\Package" --autoVersionです。package pack "C:\UiPath\Project\project.json" -o "C:\UiPath\Package" --outputType Tests -l en-USです。
前提条件:
- パッケージまたはテスト セットを作成する。
- CLI の
exeファイル (Windows の場合) またはdllファイル (Linux の場合) を実行します。 - 必要な Orchestrator API アクセスのアプリケーション スコープを追加します。
例:
-
test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" -
test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" -
test run "https://automation-suite.base.url.com/" "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" -
test run "https://cloud.uipath.com/" "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json -
test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" --out junit -
test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" --out uipath
