フォーム タスクを作成

UiPath.Persistence.Activities.FormTask.CreateFormTask

説明

Action Center のクラウド インスタンスとオンプレミス インスタンスの両方でフォーム アクションを作成します。On-Premises Orchestrator バージョン 21.4 以下の場合は、フォーム タスクも作成します。

前提条件

• フォーム デザイナーを有効化するには、パッケージ バージョン 2.0.7 以上の UiPath.FormActivityLibrary をインストールしてください。
• フォーム タスクのサイズ上限は 1 MB に制限されています。 この 1 MB の制限内に容量を抑えるには、ストレージ バケットのみを使用して、フォーム内に画像を埋め込む必要があります。 また、タイプ base64 の画像は 2 KB 未満のロゴやアイコンにのみ使用することをお勧めします。

プロジェクトの対応 OS

Windows - レガシ | Windows | クロスプラットフォーム

Windows および Windows - レガシでの設定

デザイナー パネル

• タスク タイトル - 作成するアクションのタイトルです。このフィールドは、文字列と String 型変数のみをサポートします。
• タスクの優先度 - アクションの優先度レベルを選択できます。既定では、このプロパティは [TaskPriority.Medium] に設定されています。使用できるオプションは、[TaskPriority.Low (低)]、[TaskPriority.Medium (中)]、[TaskPriority.High (高)]、および [TaskPriority.Critical (クリティカル)] です。

• TaskCatalog - タスクアイテムのオプションの事業分類です。このフィールドは、文字列と String 型変数のみをサポートします。

  重要: アクションを作成する前に、アクション カタログ が存在していることを確認してください。そうしないと、アクションの作成は失敗し、「タスク カタログ (アクション カタログ名) は存在しません。エラー コード: 2451」というメッセージが表示されます。
• フォーム データ - [アクション] 受信トレイ内のフォームに表示する Dictionary<String,Argument> 形式のビジネス データのコレクションです。Out および In/Out 引数を変更すると、タスク完了後にそれらがワークフローにマップされます。このフィールドは Dictionary<String,Argument> オブジェクトのみをサポートします。
• タスク オブジェクト (出力) - アクションの作成後に Orchestrator から FormTaskData オブジェクトとして返されるタスク オブジェクトです。このオブジェクトは、[フォーム タスク完了まで待機し再開] アクティビティに渡すことで、アクションが完了するまで、ワークフローの実行を一時停止することができます。

注: TaskObject には、出力アクション オブジェクトに関する情報を保持するいくつかの属性があります。
たとえば、TaskUrl 属性はオンプレミスの Orchestrator の [アクション] タブ内のアクションへの URL を提供するのに対し、ActionUrl 属性は Automation Cloud の [アクション] タブ内のアクションへの URL を提供します。
オンプレミスの Action Center からのアクションにアクセスするには、Action Center のベース URL に、「/actions_/tasks/taskID」を追加してください (例: https://laptop-name:port-number/actions_/tasks/taskID)。

[フォーム デザイナーを開く] ボタンをクリックすることで、フォーム デザイナー ウィザードを開いて、ワークフローで使用するフォームをカスタマイズすることができます。

[一括編集フォーム デザイナーを開く] ボタンは、[一括編集を有効化] プロパティを選択すると使用可能になります。このオプションでは、一括編集フォーム デザイナーを開いて、対応する Action Center インスタンスの [アクション] タブで一括編集または一括完了できるフォーム アクションを設計できます。

プロパティ パネル

共通

• エラー発生時に実行を継続 - アクティビティが例外をスローした場合でも、ワークフローを継続するかどうかを指定します。このフィールドでは Boolean 値 (True、False) のみサポートされています。既定値は False です。その結果、フィールドが空白で例外がスローされると、プロジェクトの実行が停止します。値を True に設定すると、プロジェクトの実行はエラーに関係なく継続されます。

注: このアクティビティが [トライ キャッチ] に含まれていて、[エラー発生時に実行を継続] プロパティの値が True の場合、プロジェクトが実行されたときにエラーは発生しません。

• 表示名 - アクティビティの表示名です。
• タイムアウト (ミリ秒) - エラーがスローされる前にアクティビティが実行されるまで待機する時間 (ミリ秒単位) を指定します。既定値は 30000 ミリ秒 (30 秒) です。

入力

• 高度なフォームを有効化 - フォームのレンダリングやロジックに関する、高度な機能やカスタマイズ オプションを有効化します。以下のようなものです。
  • 編集グリッド用のカスタマイズ可能なテンプレート。
  • イベントとして機能するボタン。
  • ES6 のモダン JavaScript を使用してフォームをカスタマイズできる機能。
  • フォームをカスタマイズするための instance 変数と options 変数。
• 一括編集を有効化 - 選択すると、アクティビティの本体で [一括編集フォーム デザイナーを開く] ボタンが使用可能になります。このオプションでは、Action Center の [アクション] タブから一括編集または一括完了できるフォーム アクションを生成できます。
  
  

  

  
  
• フォーム データ - [アクション] 受信トレイ内のフォームに表示する Dictionary<String,Argument> 形式のビジネス データのコレクションです。Out および In/Out 引数を変更すると、タスク完了後にそれらがワークフローにマップされます。このフィールドは Dictionary<String,Argument> オブジェクトのみをサポートします。
• 入力フィールドを生成 - 選択すると [フォーム データ] コレクションのすべてのエントリが、フォーム デザイナーでコンポーネントとして生成されます。空のままにすると、デザイナーにはフォーム フィールドが追加されません。
• ラベル - 入力されたラベルはロボットによってアクションに追加され、後でフィルター処理できます。このフィールドでは文字列の値のみがサポートされ、命名の制限があります。

注: 永続性アクティビティを使用してアクションに自動的にラベル付けできるようにするには、ワークフローを実行するロボット アカウントにタグの表示、作成、削除の権限が必要です。

• Orchestrator フォルダー パス - このアクティビティで使用する Orchestrator フォルダーのパスです。何も指定しない場合は、現在の Orchestrator フォルダーが使用されます。このフィールドは、文字列と String 型変数のみをサポートします。

注: このアクションを実行するユーザーがターゲット フォルダーに対する必要なアクセス許可を持っていない場合、タスクの作成は失敗し、重大なエラーがスローされます。フォルダーのアクセス許可の詳細については、こちらをご覧ください。

• 参照 - アクションの今後のフィルター処理で参照に使用される名前です。このフィールドは文字列の値のみをサポートします。

• TaskCatalog - タスクアイテムのオプションの事業分類です。このフィールドは、文字列と String 型変数のみをサポートします。

  重要: アクションを作成する前に、アクション カタログ が存在していることを確認してください。そうしないと、アクションの作成は失敗し、「タスク カタログ (アクション カタログ名) は存在しません。エラー コード: 2451」というメッセージが表示されます。
• タスクの優先度 - アクションの優先度レベルを選択できます。既定では、このプロパティは [TaskPriority.Medium] に設定されています。使用できるオプションは、[TaskPriority.Low (低)]、[TaskPriority.Medium (中)]、[TaskPriority.High (高)]、および [TaskPriority.Critical (クリティカル)] です。
• タスク タイトル - 作成するアクションのタイトルです。このフィールドは、文字列と String 型変数のみをサポートします。
• ローカルのフォーム ファイルを使用 - 実行時に指定されたフォームの JSON ファイルを使用したフォーム アクションの作成を有効化します。このフィールドでは Boolean の値のみがサポートされています。有効化すると、[フォーム ファイルのパス] プロパティ フィールドがアクティビティの本体に表示されます。このプロパティ フィールドに、特定のフォーム レイアウトが保存されている JSON ファイルのパスを指定します。

  [ローカルのフォーム ファイルを使用] を選択したら、[フォーム デザイナーを開く] をクリックし、[新規] を選択してフォームの構築を開始します。完了したら、[名前を付けて保存] を選択し、対応するプロジェクト フォルダー内に保存します。これで、作成したフォームが JSON ファイル内に保存されます。実行時にそのフォームを使用するには、[フォーム ファイルのパス] フィールドにこの JSON ファイルのパスを入力します。

その他

• プライベート - オンにした場合、変数および引数の値が Verbose レベルでログに出力されなくなります。

出力

• タスク オブジェクト (出力) - アクションの作成後に Orchestrator から FormTaskData オブジェクトとして返されるタスク オブジェクトです。このオブジェクトは、[フォーム タスク完了まで待機し再開] アクティビティに渡すことで、アクションが完了するまで、ワークフローの実行を一時停止することができます。

ストレージ

• ストレージ バケット名 - フォーム データで参照される大きいデータ ファイルに使用するストレージ バケットです。
• ストレージ フォルダー パス - 指定されたストレージ バケット内のフォルダーへのフル パスです。このフィールドは、文字列と String 型変数のみをサポートします。
  ヒント:

  ストレージ バケットを用いて画像埋め込みを使用する場合は、[ストレージ ファイルをアップロード] アクティビティと組み合わせて実行する必要があります。引数名は、[FormDataCollection] プロパティで接尾辞を付け、HTML 要素コンポーネントでアンダースコア (_) を使用してフォーム内の画像にマップする必要があります。

  引数名 (<key>_storage) は、[ストレージ ファイルをアップロード] アクティビティの [宛先] プロパティのストレージ値にマップする必要があります。

  画像ファイル名にプラス記号 (+) を含めることはできないことに注意してください。この文字はストレージ バケットのアップロード プロセスによってマスクされ、エラーが発生するためです。

クロスプラットフォームでの設定

• タスク タイトル - 作成するアクションのタイトルです。このフィールドは、文字列と String 型変数のみをサポートします。
• タスクの優先度 - アクションの優先度レベルを選択できます。既定では、このプロパティは [TaskPriority.Medium] に設定されています。使用できるオプションは、[TaskPriority.Low (低)]、[TaskPriority.Medium (中)]、[TaskPriority.High (高)]、および [TaskPriority.Critical (クリティカル)] です。

• TaskCatalog - タスクアイテムのオプションの事業分類です。このフィールドは、文字列と String 型変数のみをサポートします。

  重要: アクションを作成する前に、アクション カタログ が存在していることを確認してください。そうしないと、アクションの作成は失敗し、「タスク カタログ (アクション カタログ名) は存在しません。エラー コード: 2451」というメッセージが表示されます。
• フォーム データ - [アクション] 受信トレイ内のフォームに表示する Dictionary<String,Argument> 形式のビジネス データのコレクションです。Out および In/Out 引数を変更すると、タスク完了後にそれらがワークフローにマップされます。このフィールドは Dictionary<String,Argument> オブジェクトのみをサポートします。
• タスク オブジェクト (出力) - アクションの作成後に Orchestrator から FormTaskData オブジェクトとして返されるタスク オブジェクトです。このオブジェクトは、[フォーム タスク完了まで待機し再開] アクティビティに渡すことで、アクションが完了するまで、ワークフローの実行を一時停止することができます。

注: TaskObject には、出力アクション オブジェクトに関する情報を保持するいくつかの属性があります。
たとえば、TaskUrl 属性はオンプレミスの Orchestrator の [アクション] タブ内のアクションへの URL を提供するのに対し、ActionUrl 属性は Automation Cloud の [アクション] タブ内のアクションへの URL を提供します。
オンプレミスの Action Center からのアクションにアクセスするには、Action Center のベース URL に、「/actions_/tasks/taskID」を追加してください (例: https://laptop-name:port-number/actions_/tasks/taskID)。

[フォーム デザイナーを開く] ボタンをクリックすることで、フォーム デザイナー ウィザードを開いて、ワークフローで使用するフォームをカスタマイズすることができます。

[一括編集フォーム デザイナーを開く] ボタンは、[一括編集を有効化] プロパティを選択すると使用可能になります。このオプションでは、一括編集フォーム デザイナーを開いて、対応する Action Center インスタンスの [アクション] タブで一括編集または一括完了できるフォーム アクションを設計できます。

詳細オプション

共通

• エラー発生時に実行を継続 - アクティビティが例外をスローした場合でも、ワークフローを継続するかどうかを指定します。このフィールドでは Boolean 値 (True、False) のみサポートされています。既定値は False です。その結果、フィールドが空白で例外がスローされると、プロジェクトの実行が停止します。値を True に設定すると、プロジェクトの実行はエラーに関係なく継続されます。

注: このアクティビティが [トライ キャッチ] に含まれていて、[エラー発生時に実行を継続] プロパティの値が True の場合、プロジェクトが実行されたときにエラーは発生しません。

• タイムアウト (ミリ秒) - エラーがスローされる前にアクティビティが実行されるまで待機する時間 (ミリ秒単位) を指定します。既定値は 30000 ミリ秒 (30 秒) です。

入力

• 高度なフォームを有効化 - フォームのレンダリングやロジックに関する、高度な機能やカスタマイズ オプションを有効化します。以下のようなものです。
  • 編集グリッド用のカスタマイズ可能なテンプレート。
  • イベントとして機能するボタン。
  • ES6 のモダン JavaScript を使用してフォームをカスタマイズできる機能。
  • フォームをカスタマイズするための instance 変数と options 変数。
• 一括編集を有効化 - 選択すると、アクティビティの本体で [一括編集フォーム デザイナーを開く] ボタンが使用可能になります。このオプションでは、Action Center の [アクション] タブから一括編集または一括完了できるフォーム アクションを生成できます。
  
  

  

  
  
• ローカルのフォーム ファイルを使用 - 実行時に指定されたフォームの JSON ファイルを使用したフォーム アクションの作成を有効化します。このフィールドでは Boolean の値のみがサポートされています。有効化すると、[フォーム ファイルのパス] プロパティ フィールドがアクティビティの本体に表示されます。このプロパティ フィールドに、特定のフォーム レイアウトが保存されている JSON ファイルのパスを指定します。
• 入力フィールドを生成 - 選択すると [フォーム データ] コレクションのすべてのエントリが、フォーム デザイナーでコンポーネントとして生成されます。空のままにすると、デザイナーにはフォーム フィールドが追加されません。
• ラベル - 入力されたラベルはロボットによってアクションに追加され、後でフィルター処理できます。このフィールドでは文字列の値のみがサポートされ、命名の制限があります。

注: 永続性アクティビティを使用してアクションに自動的にラベル付けできるようにするには、ワークフローを実行するロボット アカウントにタグの表示、作成、削除の権限が必要です。

• Orchestrator フォルダー パス - このアクティビティで使用する Orchestrator フォルダーのパスです。何も指定しない場合は、現在の Orchestrator フォルダーが使用されます。このフィールドは、文字列と String 型変数のみをサポートします。

注: このアクションを実行するユーザーがターゲット フォルダーに対する必要なアクセス許可を持っていない場合、タスクの作成は失敗し、重大なエラーがスローされます。フォルダーのアクセス許可の詳細については、こちらをご覧ください。

• 参照 - アクションの今後のフィルター処理で参照に使用される名前です。このフィールドは文字列の値のみをサポートします。
• フォーム ファイルのパス - 現在のプロジェクトに保存したフォームの JSON ファイルの相対パスを入力します。

ストレージ

• ストレージ バケット名 - フォーム データで参照される大きいデータ ファイルに使用するストレージ バケットです。
• ストレージ フォルダー パス - 指定されたストレージ バケット内のフォルダーへのフル パスです。このフィールドは、文字列と String 型変数のみをサポートします。

既知の問題

グリッド コンポーネントに新しい列が追加されたときに、フォーム デザイナーが自動的に更新されないことがあります。この問題には、以下の回避策を使用して対処できます。

1. フォーム デザイナーを開きます。
2. フォーム内の任意のコンポーネントを編集し、変更を保存します。
3. フォーム全体を保存します。
4. フォームを再度開き、以前に行った変更を元に戻して、もう一度保存します。

   フォームがリセットされ、新しい列が表示されます。