Integrating Your Tool With Test Manager

概要

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

前提条件

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

認可方法

You can choose between two methods for provisioning an external OAuth client, based on specific use cases that are dependent on the versions used in your UiPath® product infrastructure:

• If you run both Test Manager and Orchestrator version 21.4 or above, you can use Provisioning through Identity Management.
• If you run Test Manager version 21.4 and Orchestrator version 20.10, or you want to enable cross-tenant access, you can use the Provisioning through Test Manager CLI.

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

You can register your application in Identity Management, define the Test Manager scopes and establish a connection between the applications.

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

When you define the API scopes for the integration, select Test Manager as a Resource. For more information, see Scopes.

Provisioning through Test Manager CLI

Through the Test Manager CLI authorization, you can provision the client, assign scopes, and then establish a service-to-service connection between the applications.

To integrate and start using your application with Test Manager, you need to configure authorization: Provision client and scopes and then get a client ID and client secret.

認可を設定する

To establish a service-to-service connection between Test Manager and your application you will be using the Test Manager Provisioning Tool as the main CLI tool to get a client, provide access rights and scopes for your integration. You can find this tool packaged with each build as testmanager.exe in the default installation location, as follows:

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

Alternatively, you can find the executable in your custom installation folder. For a list of commands and options that are outside of the scope of your integration, see Test Manager Provisioning Tool Cheat Sheet.

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

注:

• 「前提条件」セクションで要求されている、Orchestrator の [ID 管理] で生成されたインストール トークンが必要になります。
• You need to define Test Manager scopes.

コマンド	オプション	説明
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*gbj9