プレビュー

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

概要

アクティビティ デザイナーにコネクタ ビルダーの新しい機能を追加しました。 アクティビティ デザイナーを使用すると、Integration Service のカスタム アクティビティのレイアウトを UiPath Studio に表示されるとおりにプレビューできます。

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

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

入力フィールド

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

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

次の図は、リソースの [アクティビティ デザイナー ] タブを示しています。 左側にも同じパラメーターが一覧表示されますが、[プレビュー] ウィンドウには [ 必須 ] とマークされたフィールドのみが表示されます。

パラメーターの編集

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

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

入力パラメーター値

[アクティビティ デザイナー ] タブでは、各入力フィールドを [必須]、[ メイン ]、または [ 追加] のいずれかとしてマークできます。各オプションによって、パラメーターの動作と、アクティビティ キャンバス上でのパラメーターの表示場所が決まります。

• 必須: パラメーターには、アスタリスク (*) 記号を使用して必須のマークが付けられます。 つまり、メタデータは常にキャンバス上に表示され、値を指定する必要があります。

  
  

  

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

  

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

  

  
  

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

入力パラメーターの順序によって、アクティビティの [プレビュー] ウィンドウでのパラメーターの場所が決まります。 各パラメーターの横にあるドラッグ アイコンを使用して、順序を変更できます。

たとえば、[ When ] フィールドを Input セクションの最上部に移動するには、対応する アイコンを上にドラッグします。

アクティビティの [プレビュー] ウィンドウには、フィールドが割り当てられているグループ ([ 必須 ]、[ メイン ]、および [ 追加 ]) に応じて、[ 入力 ] タブに一覧表示される順序でフィールドが表示されます。

要求フィールド

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

要求フィールドは、ほとんどの場合、 POST、 PUT、または PATCH 要求 (レコードを挿入、更新/挿入、または更新アクティビティ) に関連付けられます。 GET要求またはDELETE要求に要求フィールドを追加すると (listing、get、または削除のアクティビティ)、その操作ではフィールドが表示されないことを示すエラー メッセージが表示されます。

次の図は、 DELETE リソースに要求フィールドを追加しようとしたときに表示されるエラー メッセージを示しています。

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

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

オプション 1 (推奨)

適切な形式の JSON を使用します。

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

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

メモ： この方法を使用する場合は、アクティビティで使用するすべてのフィールドを網羅した要求を行うようにしてください。

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

オプション 2

[ アクティビティ デザイナー ] タブから、各要求と応答のフィールドを手動で追加できます。

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

   

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

   

   
   

出力フィールド

アクティビティ デザイナーの出力フィールドは、[応答] フィールドから取得されます。値を設定するには、リソースに要求を正常に行います。

選別されたフィールド

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

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

公開されたアクティビティ

コネクタをパブリッシュしてプロジェクトで使用すると、コネクタ ビルダーで設定したアクティビティのレイアウトが、UiPath Studio で表示されるものと一致するようになります。

コネクタ ビルダーのプレビューと、プロジェクトでの最後のアクティビティを使用した場合の比較を以下に示します。

コネクタ ビルダー (プレビュー):

Studio Web でのアクティビティ: