フォームタスクを作成

UiPath.Persistence.Activities.FormTask.CreateFormTask

説明

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

前提条件

Install the UiPath.FormActivityLibrary package version 2.0.7 or higher to enable the form designer.
Form tasks have a limit of maximum 1MB. To fit in this 1MB limit, you need to embed images inside forms, using Storage Buckets only. Also, we suggest using images of type base64 only for logos and icons smaller than 2KB.

プロジェクトの対応 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 フォルダーが使用されます。このフィールドは、文字列と 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 オブジェクトとして返されるタスクオブジェクトです。このオブジェクトは、[フォームタスク完了まで待機し再開] アクティビティに渡すことで、アクションが完了するまで、ワークフローの実行を一時停止することができます。

詳細オプション

共通

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

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

入力

高度なフォームを有効化 - フォームのレンダリングやロジックに関する、高度な機能やカスタマイズオプションを有効化します。以下のようなものです。
- 編集グリッド用のカスタマイズ可能なテンプレート。
- イベントとして機能するボタン。
- ES6 のモダン JavaScript を使用してフォームをカスタマイズできる機能。
- フォームをカスタマイズするための instance 変数と options 変数。
一括編集を有効化 - 選択すると、アクティビティの本体で [一括編集フォームデザイナーを開く] ボタンが使用可能になります。このオプションでは、Action Center の [アクション] タブから一括編集または一括完了できるフォームアクションを生成できます。
ローカルのフォームファイルを使用 - 実行時に指定されたフォームの JSON ファイルを使用したフォームアクションの作成を有効化します。このフィールドでは Boolean の値のみがサポートされています。有効化すると、[フォームファイルのパス] プロパティフィールドがアクティビティの本体に表示されます。このプロパティフィールドに、特定のフォームレイアウトが保存されている JSON ファイルのパスを指定します。
入力フィールドを生成 - 選択すると [フォームデータ] コレクションのすべてのエントリが、フォームデザイナーでコンポーネントとして生成されます。空のままにすると、デザイナーにはフォームフィールドが追加されません。
ラベル - 入力されたラベルはロボットによってアクションに追加され、後でフィルター処理できます。このフィールドでは文字列の値のみがサポートされ、命名の制限があります。