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

概要

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

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

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

入力フィールド

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

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

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

図 2. 1 つの必須フィールドを持つ要求フィールド

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

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

パラメーターの編集

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

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

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

入力パラメーター値

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

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

  
  

  

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

  

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

  

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

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

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

要求フィールド

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

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

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

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

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

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

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

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

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

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

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

   

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

   

   
   

出力フィールド

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

選別されたフィールド

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

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