コネクタ ビルダーで変数を使用する

UiPath® が接続できるサードパーティ アプリケーションの多くは、特に幅広いユーザー向けのコネクタを構築する場合には、何らかの動的な設定が必要です。ベース URL には組織パラメーターが必要な場合や、すべての API 呼び出しに認証時に返される入力が必要な場合などがあります。

この問題を解決するための方法が複数あり、これらの種類のプロセスには {organizationId} や responseKey などの変数を使用するのが最も簡単な方法です。

このページでは、コネクタ ビルダー内のこれらの変数を追加できる領域とその方法について説明します。

注: コネクタ ビルダー内で使用される変数表記は、単に中括弧を使用した文字列です (例: {myVariable})。

ベース URL

ベース URL は、すべての HTTP 要求に既定で使用される URL です。多くの場合、この URL はサードパーティ アプリケーションに対して静的であるため、変数の使用は範囲外です。一部のベンダーは、アプリケーションの特定のインスタンスに対するすべての API 呼び出しに対応するか、ユーザーの ID を識別する基本パスに何らかの識別子を追加する必要があります。

UiPath Orchestrator インスタンスに接続する例では、ベース URL に組織とテナントの詳細を設定する必要があります。 これは、今後行う要求の基本パスとして後から使用されます。 ユーザーがこのコネクタをテナントにインポートしてコネクションを作成するときに、これらのパラメーターを変数として追加して認証画面で要求することで、その情報の入力を要求できます。

これを行うには、まずベース URL に {organization} と {tenant} の表記を使用して変数を追加します。

認証

認証の種類にかかわらず、認証のセットアップでは、内容がローカライズされた表が提供されます。この表にはすべてのパラメーターが含まれます。この表には、クイックインライン編集 オプション、またはその他のオプションメニュー を使用したより高度な画面が表示されます。

Orchestrator API の例では、コネクションを作成するユーザーに {organization} と {tenant} への入力を求める必要があるため、表にパラメーターを 2 つ追加します。

新しい認証パラメーターを追加する際は、[名前] (特定のフィールドをコネクション画面にどのように表示するか)、[値] (空のままにすることが可能)、および [ユーザーに確認] フィールド (認証時にパラメーターの入力を要求する場合) を設定する必要があります。

パラメーターの変数を定義するには、[その他のオプション] メニュー を選択します。

この例では、([ユーザーに確認] が [はい] に設定されているため) ユーザーに要求されるパラメーター Organization name は、organization (名前) および path (種類) としてプロバイダーに送信されます。

テナントについても同じことが行われます。このため、[認証] 画面で [組織名] と [テナント名] が必須フィールドになり、その組織とテナントがベース URL の一部になります。

要求を送信する

リソース内での変数の使用の動作も同様で、Swagger ファイルをインポートした後、パラメーター セクションにも表示される {id} を GETBYID するリソースにすでに表示されている可能性があります。

Orchestrator の場合、次の例ではその変数を {key} として使用します。