ツールを Test Manager と連携する

概要

このトピックで説明する承認方法では、Test Manager とユーザーのアプリケーションまたは他のパートナーアプリケーションとの間にサービス間接続を確立する方法についての情報を提供します。

前提条件

Orchestrator で Test Automation を有効化します。詳細については、「機能を有効化/無効化する」をご覧ください。
Orchestrator の [ID 管理] でインストールトークンを生成します。コマンドラインを使用してプロビジョニングするには、この操作が必要です。Orchestrator Identity のアクセストークンの取得方法については、「ホスト認証とセキュリティ設定」の「外部プロバイダーについて」セクションをご覧ください。

認可方法

外部 OAuth クライアントをプロビジョニングする方法を、UiPath 製品インフラストラクチャで使用されている各種のバージョンに依存する特定のユースケースに基づいて、以下の 2 種類から選択できます。

Test Manager と Orchestrator バージョン 21.4 以上の両方を実行している場合、ID 管理を使用したプロビジョニングを使用できます。
Test Manager バージョン 21.4 と Orchestrator バージョン 20.10 を実行している場合、またはクロステナントアクセスを有効化する場合は、Test Manager CLI を使用したプロビジョニングを使用できます。

ID 管理を使用したプロビジョニング

[ID 管理] でアプリケーションを登録し、Test Manager のスコープを定義して、アプリケーション間の接続を確立できます。

アプリケーションを構成して認可するには、外部アプリケーションを追加する必要があります。

連携の API スコープを定義する際は、リソースとして Test Manager を選択します。詳しくは、「API スコープ」をご覧ください。

Test Manager CLI を使用したプロビジョニング

Test Manager CLI 認可を使用することで、クライアントをプロビジョニングし、スコープを割り当てて、アプリケーション間でサービス間接続を確立できます。

アプリケーションを Test Manager と連携して、使用を開始するには、認可を設定する必要があります。すなわち、クライアントをプロビジョニングし、スコープを指定して、クライアント ID とクライアントシークレットを取得します。

認可を設定する

Test Manager とアプリケーションとの間にサービス間接続を確立するには、Test Manager プロビジョニングツールをメイン CLI ツールとして使用して、クライアントを取得し、連携に必要なアクセス権とスコープを指定します。このツールは、既定のインストール場所で、testmanager.exe として各ビルドに、次のようにパッケージされています。

C:\Program Files (x86)\UiPath\TestManager\Tools\TestManagerProvisioner.

または、カスタムのインストールフォルダーに実行可能ファイルがあります。連携のスコープ外のコマンドとオプションのリストについては、「Test Manager プロビジョニングツール」をご覧ください。

以下のセクションでは、使用可能なコマンドラインパラメーターをオプションおよび既定値と共にリストで示します。これらを使用して、アクセス権やスコープを指定し、アプリケーションのクライアント ID とクライアントシークレットを取得できます。

注:

「前提条件」セクションで要求されている、Orchestrator の [ID 管理] で生成されたインストールトークンが必要になります。
Test Manager のスコープを定義する必要があります。

コマンド	オプション	説明
`register third-party-s2sclient`	`-iu, --identityUrl` (必須)	Identity Server が置かれている絶対 URL。
	`-iit, --identityInstallationToken <identityinstallationtoken>` (必須)	Identity Server でクライアントをプロビジョニングするための認証トークン。
	`cscopes, --clientScopes <clientscopes>` (必須)	クライアントの作成時に使用されるクライアントスコープを示します。
	'-cid,--clientID <clientid>`	クライアントの作成時に使用されるクライアント ID を示します。クライアント ID を指定しない場合は自動的に生成されます。
	`-cname, --clientName <clientname>`	クライアントの作成時に使用されるクライアント名を示します。クライアント名を指定しない場合は自動的に生成されます。
	`-csecret, --clientSecret <clientsecret>`	クライアントの作成時に使用されるクライアントシークレットを示します。クライアントシークレットを指定しない場合は自動的に生成されます。
	`-lang, --language <language>`	エラーメッセージの言語を指定します。
	`-?, -h?, --help`	ヘルプや使用状況に関する情報を表示します。

Shell スクリプトのサンプル

以下の例では、register third-party-s2sclient コマンドにつづいて、 Orchestrator Identity URL、ID インストールトークン、Test Manager プロジェクトスコープが記述されています。

testmanager.exe `
register third-party-s2sclient`
-iu "https://orchestratorURL/identity" `
-iit "e908741iofjikasjijfapuosf09210-012opjawdfsaodgfsadgu90029183i1jiratjapo" `
-cscopes "TM.Projects" "TM.Requirements.Read"
Client created successfully. Please note the data below right away. You will not be able to retrieve the secret afterwards.
ClientID: TestManager.ThirdPartyClient.36512487-1rfasdf-11451-321535
ClientName: TestManager.ThirdPartyClient.36512487-1rfasdf-11451-321535
ClientSecret: 43sdgj@efg145!fgdsg53125sfdg12a*gbj9testmanager.exe `
register third-party-s2sclient`
-iu "https://orchestratorURL/identity" `
-iit "e908741iofjikasjijfapuosf09210-012opjawdfsaodgfsadgu90029183i1jiratjapo" `
-cscopes "TM.Projects" "TM.Requirements.Read"
Client created successfully. Please note the data below right away. You will not be able to retrieve the secret afterwards.
ClientID: TestManager.ThirdPartyClient.36512487-1rfasdf-11451-321535
ClientName: TestManager.ThirdPartyClient.36512487-1rfasdf-11451-321535
ClientSecret: 43sdgj@efg145!fgdsg53125sfdg12a*gbj9