アクティビティ デザイナー

Automation Suite の Integration Service のアクティビティ デザイナーを使用して、UiPath Studio に表示されるカスタム コネクタ アクティビティのレイアウトをプレビューして設定します。

概要

アクティビティ デザイナーでは、UiPath® Studio に表示される、ユーザー作成の Integration Service カスタム アクティビティのレイアウトをプレビューできます。

その主な機能は次のとおりです。

• レイアウトのプレビュー: カスタム アクティビティのデザインをプレビューし、Studio でどのように表示されるかを確認できます。 コネクタをデプロイする前に、設定を視覚化して必要な調整を行うことができます。
• パラメーター設定: パラメーター フィールドを作成および管理して、アクティビティをより柔軟にカスタマイズできます。 これには、入力、出力、入力/出力引数、およびワークフローで使用されるプロパティが含まれます。
• 要求フィールドと応答フィールド: 要求フィールドと応答フィールドを追加します。 これは、アクティビティ (要求) で必要な情報と、アクティビティ (応答) によって返される情報を定義するのに役立ちます。

入力フィールド

カスタム コネクタのリソースを設定するには、[ パラメーター ] タブを使用して、リクエストの種類に固有のフィールドを追加します。アクティビティ デザイナーは、[ パラメーター ] タブまたは [要求フィールド ] タブからすべてのパラメーターとフィールドを取得し、[ 入力 ] セクションの下に表示されます。

次の図は、リソースの [ パラメーター ] タブを示しています。必須としてマークされるフィールドは 1 つだけです。

図 1.必須フィールドが 1 つあるパラメーター

図 2.必須フィールドが 1 つある要求フィールド

次の図は、リソースの [要求フィールド ] タブを示しています。必須としてマークされるフィールドは 1 つだけです。

次の図は、リソースの [アクティビティ デザイナー ] タブを示しています。必要なパラメーターとリクエスト フィールドが [プレビュー] ウィンドウに表示されます。

パラメーターの編集

[アクティビティ デザイナー] タブでパラメーターを編集または削除するには、[その他のオプション] メニューを選択します。

パラメーターと要求フィールドの配置を構成するには、[ 位置 ] オプション ([プライマリ]、[セカンダリ]、または [なし]) を選択します。フィールドを [必須] に設定すると、 その [位置 ] は自動的に [ プライマリ ] に設定され、フィールドはアクティビティ キャンバスのメイン セクションに表示されます。

パラメーター名の横にある [ を編集] アイコンを選択して、プレビュー ウィンドウでのパラメーターの表示方法 ( 表示名と 説明) を変更します。

入力パラメーター値

[アクティビティ デザイナー] タブでは、アクティビティ キャンバス上のパラメーターまたはフィールドの位置を [プライマリ]、[セカンダリ]、または [なし] に指定できます。各オプションによって、パラメーターの動作と、アクティビティ キャンバス上のどこに表示されるかが決まります。または、フィールドを [必須 ] としてマークして、その位置を自動的にプライマリに設定することもできます。

• 必須: アクティビティを正常に実行するには、パラメーターまたはフィールドに値が必要です。このパラメーターは、アスタリスク (*) 記号を使用して必須としてマークされます。つまり、キャンバスには常に表示されるので、値を指定する必要があります。

• プライマリ: パラメーターは、アクティビティのプライマリ セクションに表示されます。オートメーションでアクティビティを使用する場合は、空白のままにすることができます。

• セカンダリ: パラメーターはメイン キャンバスで非表示になります。これは、[ その他のオプションを表示] セクションの下に表示されます。これらのフィールドは任意であり、空白のままにすることができます。

• なし: パラメーターはアクティビティで非表示になります。キャンバスに追加するには、[ プロパティを管理 ] ウィザードを使用する必要があります。

入力パラメーターの順序付け

入力パラメーターの順序によって、アクティビティのプレビュー ウィンドウでの場所が決まります。 各パラメータの左端にあるアイコンを使用してリスト項目を上下にドラッグすることで、表示順序を変更できます。

要求フィールド

要求フィールドを使用すると、HTTP 要求の本文を設定できます。

要求フィールドは、ほとんどの場合、 POST、 PUT、または PATCH 要求 ([挿入]、[更新/挿入]、[レコードを更新] アクティビティ) に関連付けられます。

要求フィールドと応答フィールドの設定

要求フィールドと応答フィールドに値を設定する方法は 2 つあります。

オプション 1 (推奨): 適切な形式の JSON を使用する。

1. リソースの [要求を送信 ] ボタンを選択します。
2. JSON を追加します。
3. [ 送信要求時にフィールドを上書き ] オプションが有効化されていることを確認します。
4. [Execute] を選択します。

応答が成功すると、[ 入力 ] フィールドに要求に使用された JSON プロパティが入力され、 出力 フィールドは応答に基づいて入力されます。

注:

この方法を使用する場合は、アクティビティで使用するすべてのフィールドを網羅した要求を行います。

次の図は、 POST 要求のペイロードの例を示しています。[ 送信要求でフィールドを上書き ] フィールドが有効になっていることを確認します。

オプション 2: [アクティビティ デザイナー ] タブから各要求フィールドと応答フィールドを手動で追加する

1. [アクティビティ デザイナー] タブに移動します。
2. [入力] タブで、メニューの [その他のオプション] を選択します。
3. [ 要求フィールドを追加] を選択します。
4. パラメーターを追加するのと同様の方法で、要求フィールドの詳細を追加します。

5. 回答フィールドを追加するには、[ 出力 ] タブに移動し、[ 回答フィールドを追加 ] オプションを選択します。

出力フィールド

アクティビティ デザイナーの出力フィールドは、[応答] フィールドから取得されます。値は、リソースへの呼び出しを正常に行うことで設定できます。

選別されたフィールド

出力フィールドは 検査済みとしてマークできます。フィールド値は応答オブジェクトから抽出され、変数に割り当てることができるため、オートメーションで使用するときに他のアクティビティで簡単にアクセスして使用できます。

以下の画像は、選定されたフィールドである [ステータス] がアクティビティの [ 出力 ] セクションにどのように直接表示されるかを示しています。