OSGi 上の Forms 中心のワークフロー - ステップリファレンス forms-centric-workflow-on-osgi-step-reference
ワークフローモデルを使用して、ビジネスロジックを、自動化された繰り返しプロセスに変換します。モデルは、一連の手順を定義して実行するのに役立ちます。ワークフローを一時的なものにするか、複数のリソースを使用するかなど、モデルのプロパティを定義することもできます。ビジネスロジックを達成するために、様々な AEM ワークフローステップをモデルに含めることができます。
Forms のワークフローステップ forms-workflow-steps
Forms ワークフローステップは、AEM ワークフローで AEM Forms 固有の操作を実行します。これらのステップを使用すると、OSGi でアダプティブフォームをベースとした Forms 中心のワークフローを迅速に構築できます。これらのワークフローは、基本的なレビューワークフローおよび承認ワークフローの開発、ファイアウォール内およびファイアウォール間のビジネスプロセスの開発に使用できます。Forms Workflow ステップを使用して、ドキュメントサービスを開始したり Adobe Sign 署名ワークフローと統合したり、その他の AEM Forms の操作を実行することもできます。これらのステップをワークフローで使用するには、AEM Forms アドオンが必要です。
Forms 中心のワークフローステップは、AEM ワークフローで AEM Forms 固有の操作を実行します。これらのステップを使用すると、OSGi でアダプティブフォームをベースとした Forms 中心のワークフローを迅速に構築できます。これらのワークフローを使用すると、レビューや承認の基本的なワークフローを開発したり、組織内およびファイアウォールをまたがるビジネスプロセスを開発したりすることができます。
タスクを割り当てステップ assign-task-step
タスクを割り当てステップは、タスクを作成してユーザーまたはグループに割り当てます。このコンポーネントは、タスクの割り当てに加えて、タスクのアダプティブフォームまたは非インタラクティブ PDF を指定します。アダプティブフォームはユーザーからの入力を受け付けるために必要であり、非インタラクティブ PDF または読み取り専用のアダプティブフォームはレビュー専用のワークフローに使用されます。
このコンポーネントを使用すると、タスクの動作を制御することもできます。例えば、レコードのドキュメントの自動作成、特定のユーザーまたはグループへのタスクの割り当て、送信済みデータのパスの指定、事前入力されるデータのパスの指定、デフォルトアクションの指定が対象になります。タスクを割り当てステップには、次のプロパティがあります。
-
タイトル:タスクのタイトル。タイトルは AEM インボックスに表示されます。
-
説明:タスクで実行される操作の説明。この情報は、共有開発環境で作業している場合に他のプロセス開発者にとって有用です。
-
サムネールのパス:タスクサムネールのパス。パスを指定しない場合、アダプティブフォームではデフォルトのサムネールが表示され、レコードのドキュメントではデフォルトのアイコンが表示されます。
-
ワークフローステージ: 1 つのワークフローに複数のステージを含めることができます。これらのステージは、AEM インボックスに表示されます。これらのステージは、モデルのプロパティ(サイドキック/ページ/ページのプロパティ/ステージ)で定義できます。
-
優先度: 選択した優先度が AEM インボックスに表示されます。「高」、「中」、「低」の各オプションを使用できます。デフォルト値は「中」です。
-
期限:タスクが期限切れとマークされるまでの日数または時間数を指定します。「オフ」を選択した場合、タスクが期限切れとマークされることはありません。タイムアウトハンドラーを指定して、タスクが期限切れになった後に特定のタスクを実行することもできます。
-
日: タスクを完了するまでの日数。この日数は、タスクがユーザーに割り当てられた後にカウントされます。タスクが完了せず、「日」フィールドに指定された日数を過ぎると、期限後にタイムアウトハンドラー(選択した場合)が呼び出されます。
-
時間:タスクを完了するまでの時間数。時間数は、タスクがユーザーに割り当てられた後にカウントされます。タスクが完了せず、「時間」フィールドに指定された時間数を過ぎると、期限後にタイムアウトハンドラー(選択した場合)が呼び出されます。
-
期限後にタイムアウト: このオプションを選択して、タイムアウトハンドラー選択フィールドを有効にします。
-
タイムアウトハンドラー: タスクを割り当てステップが期限切れになったときに実行するスクリプトを選択します。CRX リポジトリ([apps]/fd/dashboard/scripts/timeoutHandler)にあるスクリプトを選択できます。指定されたパスは crx リポジトリに存在しません。このパスは、使用する前に管理者が作成します。
-
タスクの詳細で最後のタスクのアクションとコメントを強調表示する: タスクの詳細セクションで最後に実行されたアクションと受け取ったコメントを表示するには、このオプションを選択します。
-
タイプ: ワークフローの開始時に入力するドキュメントのタイプを選択します。アダプティブフォーム、読み取り専用アダプティブフォーム、非インタラクティブ PDF ドキュメント、インタラクティブ通信エージェント UI、またはインタラクティブ通信 web チャンネルドキュメントを選択できます。
-
アダプティブフォームを使用:入力されたアダプティブフォームを検索する方法を指定します。このオプションは、「タイプ」ドロップダウンリストから「アダプティブフォーム」または「読み取り専用アダプティブフォーム」を選択した場合に使用できます。アダプティブフォームは、ワークフローに送信されたもの、絶対パスで利用できるもの、変数内のパスで利用できるものを使用できます。パスを指定するには、String 型の変数を使用します。
複数のアダプティブフォームをワークフローに関連付けることができます。それにより、使用可能な入力メソッドを使用して、実行時にアダプティブフォームを指定できます。 -
インタラクティブ通信を使用: 入力されたインタラクティブ通信を検索する方法を指定します。 インタラクティブな通信は、ワークフローに送信されたもの、絶対パスで利用できるもの、変数内のパスで利用できるものを使用できます。パスを指定するには、String 型の変数を使用します。このオプションは、「タイプ」ドロップダウンリストで「インタラクティブ通信エージェント UI」または「インタラクティブ通信 web チャンネルドキュメント」を選択した場合に使用できます。
-
アダプティブフォームまたはインタラクティブ通信パス:アダプティブフォームまたはインタラクティブ通信のパスを指定します。 ワークフローに送信済み、または絶対パスで使用可能なアダプティブフォームを使用できます。または、文字列データタイプの変数に保存されたパスからアダプティブフォームを取得できます。
-
次を使用して入力 PDF を選択:非インタラクティブ PDF ドキュメントのパスを指定します。このフィールドは、「タイプ」フィールドで非インタラクティブ PDF ドキュメントを選択した場合に使用できます。入力 PDF は、ペイロードに対する相対パス、絶対パスで保存されたもの、またはドキュメントデータ型の変数を使用して選択できます。例えば、[Payload_Directory]/Workflow/PDF/credit-card.pdf となります。このパスは crx リポジトリに存在しません。このパスは、使用する前に管理者が作成します。「PDF のパス」オプションを使用する場合は、有効な「レコードのドキュメント」オプションか、フォームテンプレートベースのアダプティブフォームが必要です。
-
完了したタスクのアダプティブフォームを次の形式でレンダリングする: タスクが完了とマークされると、アダプティブフォームを読み取り専用のアダプティブフォームまたは PDF ドキュメントとしてレンダリングできます。アダプティブフォームをレコードのドキュメントとしてレンダリングするには、有効な「レコードのドキュメント」オプションか、フォームテンプレートベースのアダプティブフォームが必要です。
-
埋め込み済み:以下のフィールドは、タスクへの入力として使用できます。
-
次を使用して入力データファイルを選択:入力データファイルのパス(.json、.xml、.doc またはフォームデータモデル)。ペイロードに対する相対パスを使用して入力データファイルを取得したり、ドキュメント、XML、JSON データ型の変数に格納されたファイルを取得したりできます。例えば、ファイルには、AEM インボックスアプリケーションを介してフォームに送信されるデータが含まれています。一例として、[Payload_Directory]/workflow/data というパスを指定します。
-
次を使用して入力添付ファイルを選択:指定した場所にある添付ファイルは、タスクに関連付けられたフォームに添付されます。パスは、ペイロードを基準とした相対パスにすることもできますし、ドキュメントの ArrayList 型の変数に格納された添付ファイルを取得することもできます。一例として、[Payload_Directory]/attachments/ というパスを指定します。ペイロードを基準にして添付ファイルを指定するか、ドキュメントタイプ(配列リスト/ドキュメント)変数を使用して、アダプティブフォームの入力添付ファイルを指定できます。
- 入力 JSON を選択: ペイロードに対する相対パス、または Document、JSON、または Form Data Model データタイプの変数に格納されたパスを使用して、入力 JSON ファイルを選択します。 このオプションは、「タイプ」ドロップダウンリストで「インタラクティブ通信エージェント UI」または「インタラクティブ通信 web チャンネルドキュメント」を選択した場合に使用できます。
- カスタム事前入力サービスを選択:事前入力サービスを選択してデータを取得し、インタラクティブ通信 web チャンネルドキュメントまたはエージェント UI に事前入力します。
- 上で選択したインタラクティブ通信の事前入力サービスを使用:このオプションを使用して、「インタラクティブ通信を使用」ドロップダウンリストで定義されたインタラクティブ通信の事前入力サービスを使用します。
- 要求属性マッピング:要求属性マッピングセクションを使用して、要求属性の名前と値を定義します。リクエストで指定された属性名と値に基づいて、データソースから詳細を取得します。リテラル値または String データ型の変数を使用して、要求属性値を定義できます。
事前入力サービスとリクエスト属性のマッピングオプションは、「タイプ」ドロップダウンリストで「インタラクティブ通信エージェント UI」または「インタラクティブ通信 web チャンネルドキュメント」を選択した場合にのみ使用できます。
-
-
送信される情報: 以下のフィールドは、タスクの出力先として使用できます。
-
次を使用して出力データファイルを保存:データファイル(.json、.xml、.doc またはフォームデータモデル)を保存します。このデータファイルには、関連付けられたフォームを介して送信された情報が含まれます。ペイロードに対する相対パスを使用して出力データファイルを保存するか、ドキュメント、XML または JSON データ型の変数に保存できます。例えば、[Payload_Directory]/Workflow/data のように指定します。ここで、data はファイルです。
-
次を使用して添付ファイルを保存:タスクに指定されたフォーム添付ファイルを保存します。ペイロードに対する相対パスを使用して添付ファイルを格納するか、ドキュメントデータタイプの配列リストの変数に保存できます。
-
次を使用してレコードのドキュメントを保存:レコードのドキュメントファイルの保存先のパス。例えば、[Payload_Directory]/DocumentofRecord/credit-card.pdf のように指定します。レコードのドキュメントは、ペイロードに対する相対パスを使用して保存するか、ドキュメントデータ型の変数に格納できます。「ペイロードを基準とする」オプションを選択した場合、パスフィールドを空のままにすると、レコードのドキュメントは生成されません。このオプションは、「タイプ」ドロップダウンリストから「アダプティブフォーム」を選択した場合にのみ使用できます。
-
次を使用して web チャネルデータを保存: ペイロードに対する相対パスを使用して web チャネルデータファイルを保存するか、ドキュメント、JSON、フォームデータモデルのいずれかのデータタイプの変数に格納します。このオプションは、「タイプ」ドロップダウンリストから「インタラクティブな通信エージェント UI」を選択した場合にのみ使用できます。
-
次を使用して PDF ドキュメントを保存: ペイロードに対する相対パスを使用して PDF ドキュメントを保存するか、ドキュメント データタイプの変数に格納します。このオプションは、「タイプ」ドロップダウンリストから「インタラクティブな通信エージェント UI」を選択した場合にのみ使用できます。
-
次を使用してレイアウトテンプレートを保存: ペイロードに対する相対パスを使用してレイアウトテンプレートを保存するか、ドキュメントデータタイプの変数に格納します。レイアウトテンプレート は、Forms Designer を使用して作成した XDP ファイルを参照します。このオプションは、「タイプ」ドロップダウンリストから「インタラクティブな通信エージェント UI」を選択した場合にのみ使用できます。
-
-
「担当者/割り当て」オプション:タスクをユーザーに割り当てる方法を指定します。参加者選択スクリプトを使用してタスクを動的にユーザーまたはグループに割り当てることも、タスクを特定の AEM ユーザーまたはグループに割り当てることもできます。
-
参加者選択:このオプションは、「割り当てオプション」フィールドで「ユーザーまたはグループに動的に割り当て」オプションを選択した場合に使用できます。ユーザーまたはグループを動的に選択するには、ECMAScript またはサービスを使用できます。詳しくは、ユーザーへのワークフローの動的な割り当ておよびカスタムの Adobe Experience Manager 動的参加者ステップの作成を参照してください。
-
参加者: このフィールドは、「参加者選択」フィールドで「com.adobe.granite.workflow.core.process.RandomParticipantChooser」オプションが選択されている場合に使用できます。このフィールドでは、「RandomParticipantChooser」オプションのユーザーまたはグループを選択できます。
-
担当者:このフィールドは、「参加者選択」フィールドで「com.adobe.fd.workspace.step.service.VariableParticipantChooser」オプションが選択されている場合に使用できます。このフィールドでは、文字列データタイプの変数を選択することにより担当者を定義できます。
-
引数: このフィールドは、「参加者選択」フィールドで RandomParticipantChoose スクリプト以外のスクリプトが選択されている場合に使用できます。このフィールドでは、「参加者選択」フィールドで選択したスクリプトのコンマ区切りの引数のリストを指定できます。
-
ユーザーまたはグループ: 選択したユーザーまたはグループにタスクが割り当てられます。このオプションは、「割り当てオプション」フィールドで「特定のユーザーまたはグループに割り当て」オプションを選択した場合に使用できます。このフィールドには、ワークフローユーザーグループのすべてのユーザーとグループが一覧表示されます。
「ユーザーまたはグループ」ドロップダウンメニューには、ログインユーザーおよびグループがアクセスできるリストが表示されます。ユーザー名の表示は、その特定のユーザーの crx-repository の users ノードに対するアクセス権限があるかどうかによって異なります。 -
通知メールを送信: メール通知を担当者に送信するには、このオプションを選択します。この通知は、タスクがユーザーまたはグループに割り当てられたときに送信されます。「受信者のメールアドレス」オプションを使用して、メールアドレスを取得するメカニズムを指定できます。
-
受信者のメールアドレス:メールアドレスは、変数に格納したり、リテラルを使用して永続的なメールアドレスを指定したり、担当者のプロファイルで指定したデフォルトのメールアドレスを使用したりできます。リテラルまたは変数を使用して、グループのメールアドレスを指定できます。変数オプションは、メールアドレスを動的に取得して使用する場合に便利です。「担当者のデフォルトのメールアドレスを使用する」オプションは、1 人の担当者に対してのみ使用できます。この場合、担当者のユーザープロファイルに保存されているメールアドレスが使用されます。
-
HTML メールテンプレート: 通知メールのメールテンプレートを選択します。テンプレートを編集するには、crx リポジトリの /libs/fd/dashboard/templates/email/htmlEmailTemplate.txt にあるファイルを変更します。
-
許可するデリゲーション:AEM インボックスには、ログインユーザーが、割り当てられたワークフローを別のユーザーにデリゲートするオプションが用意されています。同じグループ内または別のグループのワークフローユーザーにデリゲートできます。タスクが 1 人のユーザーに割り当てられ、「担当者グループのメンバーへのデリゲーションを許可」オプションが選択されている場合は、そのタスクを別のユーザーまたはグループにデリゲートできません。
-
共有設定:AEM インボックスには、インボックス内の 1 つまたはすべてのタスクを他のユーザーと共有するオプションが用意されています。
- 「担当者がインボックスで明示的に共有することを許可する」オプションが選択されている場合、ユーザーはインボックスでタスクをクリックし、別の AEM ユーザーと共有できます。
- 「担当者がインボックスの共有を使用して共有することを許可する」オプションを選択し、ユーザーがインボックス項目を共有したり、他のユーザーがインボックス項目にアクセスできるようにした場合、前述のオプションが有効になっているタスクのみが他のユーザーと共有されます。
-
アクション/デフォルトのアクション:標準提供されている送信、保存およびリセットなどのアクションを使用できます。すべてのアクションは、デフォルトで有効になっています。
-
ルート変数:ルート変数の名前。ユーザーが AEM インボックスで選択したカスタムアクションは、ルート変数で取得します。
-
ルート:タスクは様々なルートに分岐することができます。AEM インボックスで選択すると、ルートから値が返され、選択したルートに基づいてワークフローが分岐します。ルートは、文字列データ型の配列の変数に格納するか、リテラル を選択して手動でルートを追加できます。
-
タイトル:ルートのタイトルを指定します。これは AEM インボックスに表示されます。
-
Coral アイコン:Coral アイコンの HTML 属性を指定します。Adobe CoralUI ライブラリでは、多数のタッチファーストなアイコンを提供します。ルートのアイコンを選択して使用できます。アイコンは、タイトルと共に AEM インボックスに表示されます。変数にルートを格納した場合、ルートにはデフォルトの「タグ」Coral アイコンが使用されます。
-
担当者がコメントを追加することを許可: タスクのコメントを有効にするには、このオプションを選択します。担当者は、タスクの送信時に AEM インボックス内からコメントを追加できます。
-
コメントを変数に保存:コメントを文字列データタイプの変数に保存します。このオプションは、「担当者がコメントを追加することを許可」チェックボックスを選択した場合にのみ表示されます。
-
担当者によるタスクへの添付ファイルの追加を許可:タスクの添付ファイルを有効にするには、このオプションを選択します。担当者は、タスクの送信時に AEM インボックス内から添付ファイルを追加できます。
-
次を使用して出力タスクの添付ファイルを保存:添付ファイルフォルダーの場所を指定します。出力タスクの添付ファイルは、ペイロードに対する相対パスを使用するか、ドキュメントデータタイプの配列の変数に保存できます。このオプションは、「担当者がタスクに添付ファイルを追加することを許可」チェックボックスを選択し、「フォーム/ドキュメント」タブの「タイプ」ドロップダウンリストから、「アダプティブフォーム」、「読み取り専用アダプティブフォーム」、「非インタラクティブ PDF ドキュメント」のいずれかを選択した場合にのみ表示されます。
- カスタムメタデータを使用:カスタムメタデータフィールドを有効にするには、このオプションを選択します。カスタムメタデータは、メールのテンプレートで使用します。
- カスタムメタデータ: メールテンプレートのカスタムメタデータを選択します。カスタムメタデータは、crx リポジトリの apps/fd/dashboard/scripts/metadataScripts にあります。指定されたパスは crx リポジトリに存在しません。このパスは、使用する前に管理者が作成します。また、カスタムメタデータ用のサービスを使用することもできます。WorkitemUserMetadataService インターフェイスを拡張して、カスタムメタデータを提供することもできます。
- 前の手順のデータを表示:このオプションを選択すると、以前の担当者、タスクに対して既に実行されたアクション、タスクに追加されたコメント、完了したタスクのレコードのドキュメントがある場合、担当者がそれらを表示できるようになります。
- 以降の手順のデータを表示する: このオプションを選択すると、後続の担当者が実行したアクションと追加したコメントを、現在の担当者が表示できるようになります。また、このオプションを選択すると、完了したタスクのレコードのドキュメント(使用可能な場合)を現在の担当者が表示できるようになります。
- データタイプの表示:デフォルトで、担当者は、レコードのドキュメント、担当者、実行されたアクションに加え、前の担当者および後続の担当者が追加したコメントを表示することができます。「データタイプの表示」オプションを使用すると、担当者に表示されるデータタイプを制限できます。
「メールを送信」ステップ send-email-step
メールのステップを使用して、メールを送信します。例えば、レコードのドキュメント、アダプティブフォームのリンク、インタラクティブ通信のリンクまたは添付 PDF ドキュメントを含むメールを送信します。メールを送信ステップは、HTML メールをサポートします。HTML メールは、受信者のメールクライアントや画面サイズにレスポンシブに対応します。HTML メールテンプレートを使用して、メールの外観、カラースキーム、動作を定義できます。
メールステップは、Day CQ Mail Service を使用してメールを送信します。メールステップを使用する前に、メールサービスが設定されていることを確認してください。メール手順には、次のプロパティがあります。
タイトル: ステップのタイトルは、ワークフローエディターでステップを識別するのに役立ちます。
説明: 説明は、共通の開発環境で作業する他のプロセス開発者にとって有用です。
メールの件名:件名は、ワークフローのメタデータから取得することも、手動で指定することも、変数に格納されている値から取得することもできます。次のいずれかのオプションを選択します。
- リテラル - 件名を手動で指定します。
- ワークフローメタデータから取得 - メタデータプロパティから件名を取得します。
- 変数 - 文字列データ型の変数に格納された値から件名を取得します。
HTML メールテンプレート:メールの HTML テンプレート。変数はメールテンプレートで指定できます。メールステップは、入力のため、テンプレートに含まれるすべての変数を抽出して表示します。
メールテンプレートメタデータ:メールテンプレートの変数の値は、ユーザー指定の値、オーサーサーバーまたはパブリッシュサーバー上のアセットのパス、画像、ワークフローメタデータプロパティのいずれにもすることができます。
-
リテラル: このオプションは、指定する値が正確に分かっている場合に使用します。例えば、example@example.com と指定します。
-
ワークフローメタデータ: 使用する値がワークフローメタデータプロパティに保存されている場合は、このオプションを使用します。オプションを選択した後、「ワークフローメタデータ」オプションの下にある空のテキストボックスに、メタデータプロパティ名を入力します。例えば、emailAddress と指定します。
-
アセット URL: インタラクティブ通信の web リンクをメールに埋め込むには、このオプションを使用します。このオプションを選択したら、埋め込むインタラクティブ通信を参照して選択します。アセットは、オーサーまたはパブリッシュサーバー上に配置できます。
-
画像: 画像をメールに埋め込むには、このオプションを使用します。このオプションを選択したら、画像を参照して選択します。「画像」オプションは、メールテンプレートで使用できる画像タグ(<img src="*"/>)に対してのみ使用できます。
送信者/受信者のメールアドレス: メールアドレスを手動で指定するには、「リテラル」オプションを選択します。メールアドレスをメタデータプロパティから取得するには、「ワークフローメタデータから取得」オプションを選択します。「ワークフローメタデータから取得」オプションのメタデータプロパティ配列のリストを指定することもできます。「変数」オプションを選択して、文字列データ型の変数に格納されている値からメールアドレスを取得します。
添付ファイル: 指定された場所で使用可能なアセットがメールに添付されます。アセットのパスは、ペイロードに対する相対パスまたは絶対パスのどちらでもかまいません。一例として、[Payload_Directory]/attachments/ というパスを指定します。
「変数」オプションを選択して、ドキュメント、XML、JSON データ型の変数に格納された添付ファイルを取得します。
ファイル名: メール添付ファイルの名前です。メールステップは、添付ファイルの元のファイル名を指定されたファイル名に変更します。この名前は、手動で指定することも、ワークフローメタデータのプロパティまたは変数から取得することもできます。指定する値が正確に分かっている場合は、「リテラル」オプションを使用します。「変数」オプションを使用して、文字列データ型の変数に格納された値からファイル名を取得します。使用する値がワークフローメタデータプロパティに保存されている場合は、「ワークフローメタデータから取得」オプションを使用します。
レコードのドキュメントを生成ステップ generate-document-of-record-step
フォームの入力時または送信時には、そのフォームを印刷物またはドキュメント形式で記録しておくことができます。これを、レコードのドキュメント(DoR)といいます。レコードのドキュメントを生成するステップを使用して、アダプティブフォームの(読み取り専用またはインタラクティブの)PDF バージョンを作成できます。PDF バージョンには、アダプティブフォームのレイアウトと共にフォームに入力された情報が含まれます。
レコードのドキュメントステップには、次のプロパティがあります。
アダプティブフォームを使用: 入力するアダプティブフォームを検索する方法を指定します。アダプティブフォームは、ワークフローに送信されたもの、絶対パスで利用できるもの、変数内のパスで利用できるものを使用できます。文字列データ型の変数を使用して、「変数を選択して解決」フィールドのパスを指定できます。
複数のアダプティブフォームをワークフローに関連付けることができます。それにより、使用可能な入力メソッドを使用して、実行時にアダプティブフォームを指定できます。
アダプティブフォームのパス:アダプティブフォームのパスを指定します。このフィールドは、「アダプティブフォームを使用」フィールドから「絶対パスで使用可能」オプションを選択した場合に使用できます。
次を使用して入力データを選択: アダプティブフォームの入力データのパス。ペイロードに対して相対的な場所にデータを保持したり、データの絶対パスを指定したり、ドキュメント、JSON または XML データ型の変数に格納されたデータを取得したりできます。入力データは、レコードのドキュメントを作成するためにアダプティブフォームとマージされます。
次を使用して入力添付ファイルのパスを選択: 添付ファイルのパス。これらの添付ファイルは「レコードのドキュメント」に含まれます。添付ファイルは、ペイロードに対する相対的な場所に保持したり、添付ファイルの絶対パスを指定したり、ドキュメントデータ型配列の変数に格納された添付ファイルを取得したりできます。
フォルダーのパスを指定すると、添付ファイルなど、そのフォルダー内で直接使用可能なすべてのファイルがレコードのドキュメントに添付されます。指定された添付ファイルのパスに直接存在するフォルダー内に使用できるファイルがある場合、そのファイルはレコードのドキュメントに添付ファイルとして含まれます。直接存在するフォルダー内にフォルダーがある場合、それらはスキップされます。
生成されたレコードのドキュメントを次のオプションを使用して保存:レコードのドキュメントファイルを保持する場所を指定します。ペイロードフォルダーを上書き、ペイロードディレクトリ内の任意の場所にレコードのドキュメントを配置、ドキュメントデータタイプの変数にレコードのドキュメントを格納することを選択できます。
ロケール:レコードのドキュメントの言語を指定します。ドロップダウンリストからロケールを選択する場合は「リテラル」を選択し、文字列データ型の変数に格納されている値からロケールを取得する場合は「変数」を選択します。ロケールの値を変数に格納する際は、ロケールコードを定義します。例えば、英語は en_US、フランス語は fr_FR と指定します。
フォームデータモデルサービスを呼び出しステップ invoke-form-data-model-service-step
AEM Forms のデータ統合機能により、複数の異なるデータソースを設定して接続することができます。これらのデータソースには、データベース、Web サービス、REST サービス、OData サービス、CRM ソリューションがあります。AEM Forms のデータ統合を使用すると、様々なサービスを実行するフォームデータモデルを作成できます。例えば、構成されたデータベースに対して、データの取得、追加、更新を実行できます。データモデルサービスの呼び出し手順 を使用して、フォームデータモデル(FDM)を選択し、FDM のサービスを使用すると、各種データソースの取得、更新、追加を行うことができます。
手順のフィールドの入力を説明するために、次のデータベーステーブルと JSON ファイルを例として使用します。
CustomerDetails テーブルの例
サンプル JSON ファイル
{
customer: {
firstName: "Sarah",
lastName:"Rose",
customerId: "1",
emailAddress:"srose@we.info"
},
insurance: {
customerId: "1",
policyType: "Premium,
policyNumber: "Premium-521499",
customerDetails: {
firstName: "Sarah",
lastName: "Rose",
customerId: "1",
emailAddress: "srose@we.info"
}
}
}
フォームデータモデルサービスを呼び出しステップには、以下に一覧されたフィールドがあり、フォームデータモデルの操作に役立ちます。
-
タイトル:手順のタイトルです。ワークフローエディターでステップを識別するのに役立ちます。
-
説明: 説明は、共通の開発環境で作業する他のプロセス開発者にとって有用です。
-
フォームデータモデルのパス: サーバー上のフォームデータモデルを参照して選択します。
-
サービス: 選択したフォームデータモデルのサービスのリストです。
-
サービスの入力/リテラル、変数またはワークフローメタデータおよび JSON ファイルを使用して入力データを指定:サービスには複数の引数を持たせることができます。ワークフローメタデータプロパティ、JSON オブジェクト、変数からサービス引数の値を取得するか、用意されたテキストボックスに直接値を入力するには、このオプションを選択します。
-
リテラル: 指定する値が正確に分かっている場合は、このオプションを使用します。例えば、srose@we.info と指定します。
-
変数:変数に格納された値を取得するには、このオプションを使用します。
-
ワークフローメタデータから取得:使用する値がワークフローメタデータプロパティに保存されている場合は、このオプションを使用します。例えば、emailAddress と指定します。
-
ペイロードに相対的:ペイロードへの相対パスに保存された添付ファイルを取得するには、オプションを使用します。オプションを選択し、添付ファイルを含むフォルダー名を指定するか、テキストボックスで添付ファイル名を指定します。
例えば、CRX リポジトリの「ペイロードに相対的」フォルダーの
attachment\attachment-folder
の場所にファイル添付ファイルが含まれている場合、「ペイロードに相対的」オプションを選択した後、テキストボックスでattachment\attachment-folder
を指定します。 -
JSON ドット表記法: 使用する値が JSON ファイル内にある場合は、このオプションを使用します。例えば、insurance.customerDetails.emailAddress と指定します。「JSON ドット表記法」オプションを使用できるのは、「入力 JSON からのマップ入力フィールド 」オプションが選択されている場合だけです。
-
入力 JSON からのマップ入力フィールド: JSON ファイルのパスを指定して、その JSON ファイルから一部のサービスの引数の入力値を取得します。JSON ファイルのパスは、ペイロードとの相対パス、絶対パスにするか、JSON またはフォームデータモデル型の変数を使用して入力 JSON ドキュメントを選択できます。
-
-
サービスの入力/変数または JSON ファイルを使用して入力データを指定: 絶対パス、ペイロードに対する相対パスまたは変数に保存された JSON ファイルからすべての引数の値を取得する場合は、このオプションを選択します。
-
次を使用して入力 JSON ドキュメントを選択:すべてのサービス引数の値が含まれる JSON ファイル。JSON ファイルのパスは、ペイロードに対する相対パス または 絶対パスのどちらでもかまいません。 また、JSON またはフォームデータモデルデータ型の変数を使用して、入力 JSON ドキュメントを取得することもできます。
-
JSON ドット表記法:指定した JSON ファイルのすべてのオブジェクトをサービス引数の入力として使用するには、フィールドを空のままにします。指定した JSON ファイルからサービス引数の入力として特定の JSON オブジェクトを読み取るには、JSON オブジェクトにドット表記法を指定します。例えば、この節の冒頭に一覧表示されている JSON に似た JSON を使用している場合は、insurance.customerDetails を指定して、顧客のすべての詳細をサービスへの入力として提供します。
-
サービスの出力/マップして出力値を変数またはメタデータに書き込む: CRX リポジトリ内のワークフローインスタンスのメタデータノードのプロパティとして出力値を保存するには、このオプションを選択します。メタデータプロパティの名前を指定し、メタデータプロパティにマップされる対応するサービス出力属性を選択します。例えば、出力サービスが返す phone_number をワークフローメタデータの phone_number プロパティでマッピングします。同様に、出力は Long データ型の変数に格納できます。「マッピングする必要があるサービス出力属性」オプションのプロパティを選択すると、選択したプロパティのデータを保存できる変数のみが、「出力を次に保存」オプションに設定されます。
-
サービスの出力/出力を変数または JSON ファイルに保存:出力値を絶対パス、ペイロードに対する相対パス、または変数内の JSON ファイルに保存する場合は、このオプションを選択します。
-
以下のオプションを使用して出力 JSON ドキュメントを保存する: 出力 JSON ファイルを保存します。出力 JSON ファイルのパスは、ペイロードに対する相対パスまたは絶対パスのどちらでもかまいません。また、JSON またはフォームデータモデルデータ型の変数を使用して、出力 JSON ファイルを保存することもできます。
ドキュメントに署名ステップ sign-document-step
ドキュメントに署名ステップでは、Adobe Sign を使用してドキュメントに署名できます。ドキュメントへの署名手順には、次のプロパティがあります。
-
契約名: 契約のタイトルを指定します。契約名は、署名者に送信されるメールの件名と本文の一部として使用されます。名前は文字列データ型の変数に格納するか、リテラル を選択して手動で追加できます。
-
ロケール: メールと検証オプションの言語を指定します。ロケールは文字列データ型の変数に格納するか、リテラル を選択して、使用可能なオプションのリストからロケールを選択できます。ロケールの値を変数に格納する際は、ロケールコードを定義します。例えば、英語は en_US、フランス語は fr_FR と指定します。
-
Adobe Sign クラウド設定: Adobe Sign クラウド設定を選択します。Adobe Sign を AEM Forms 用に設定していない場合は、Adobe Sign と AEM Forms の統合を参照してください。
-
次を使用して署名するドキュメントを選択:ペイロードに対する相対的な場所からドキュメントを選択、ドキュメントとしてペイロードを使用、ドキュメントの絶対パスを指定、またはドキュメントデータタイプの変数に格納されたドキュメントを取得できます。
-
次を使用して入力添付ファイルのパスを選択: 添付ファイルのパス。これらの添付ファイルは、署名ドキュメントに含まれます。 添付ファイルは、ペイロードに対する相対的な場所に保持したり、添付ファイルの絶対パスを指定したり、ドキュメントデータ型配列の変数に格納された添付ファイルを取得したりできます。
フォルダー(例:attachments)のパスを指定する場合、そのフォルダーに直接存在するすべてのファイルが署名ドキュメントに添付されます。指定された添付ファイルパスに直接存在するフォルダー内に使用できるファイルがある場合、そのファイルは署名ドキュメントに添付ファイルとして含まれます。直接存在するフォルダー内にフォルダーがある場合、それらはスキップされます。
-
期限までの日数:「期限までの日数」フィールドに指定された日数の間にタスクのアクティビティがない場合、ドキュメントは期限切れとマークされます。日数は、ドキュメントが署名のためにユーザーに割り当てられた後にカウントされます。
-
リマインダーメールの頻度: リマインダーメールを日単位または週単位で送信できます。週のカウントは、ドキュメントが署名のためにユーザーに割り当てられた日から始まります。
-
署名プロセス:ドキュメントへの署名を順次行うか並列で行うかを選択できます。順次署名する場合、ドキュメントは署名のために一度に 1 人の署名者に送信されます。最初の署名者がドキュメントの署名を完了すると、ドキュメントは 2 人目の署名者に送信され、それ以降も同様です。並列で署名する場合、複数の署名者が同時に 1 つのドキュメントに署名することができます。
-
リダイレクト URL:リダイレクト URL を指定します。ドキュメントへの署名が完了したら、担当者を URL にリダイレクトできます。通常、この URL には、感謝のメッセージやその後の手順が含まれています。
-
ワークフローステージ: 1 つのワークフローに複数のステージを含めることができます。これらのステージは、AEM インボックスに表示されます。これらのステージは、モデルのプロパティ(サイドキック/ページ/ページのプロパティ/ステージ)で定義できます。
-
署名者を選択:ドキュメントの署名者を選択する方法を指定します。ワークフローを動的にユーザーまたはグループに割り当てることも、手動で署名者の詳細を追加することもできます。ドロップダウンで「手動」を選択すると、受信者の詳細(メール、役割、認証方法など)が追加されます。
note note NOTE - 役割セクションで、受信者の役割として「署名者」、「承認者」、「同意者」、「認証済み受信者」、「フォーム入力者」および「委任者」を指定できます。
- 「役割」オプションで「委任者」を選択した場合、委任者は署名タスクを別の受信者に割り当てることができます。
- Adobe Sign の認証方法を設定済みの場合、設定に基づいて、電話による認証、ソーシャル ID に基づく認証、ナレッジベースの認証、政府機関の ID に基づく認証などの認証方法を選択します。
-
受信者を選択するためのスクリプトまたはサービス:このオプションを使用できるのは、「受信者を選択」フィールドで「動的」オプションが選択されている場合のみです。ECMAScript またはサービスを指定すると、ドキュメントの署名者と検証オプションを選択することができます。
-
署名者の詳細:このオプションを使用できるのは、「署名者を選択」フィールドで「手動」オプションが選択されている場合のみです。メールアドレスを指定し、オプションの検証メカニズムを選択します。2 段階検証メカニズムを選択する前に、設定済みの Adobe Sign アカウントに対応する検証オプションが有効になっていることを確認してください。文字列データタイプの変数を使用して、「メール」、「国コード」、「電話番号」の各フィールドの値を定義できます。「国コード」と「電話番号」フィールドは、「2 段階認証」ドロップダウンリストから「電話の検証」を選択した場合にのみ表示されます。
-
ステータス変数: Adobe Sign 対応ドキュメントでは、ドキュメントの署名ステータスが文字列データタイプの変数に格納されます。ステータス変数の名前(adobeSignStatus)を指定します。インスタンスのステータス変数は、変数のステータスが格納されている CRXDE の /etc/workflow/instances/<server>/<date-time>/<instance of workflow model>/workItems/<node>/metaData から利用できます。
-
署名済みドキュメント:署名済みドキュメントのステータスを変数に保存できます。電子署名サイン監査証跡を追加して署名ドキュメントのセキュリティと合法性を向上するには、監査レポートを含めることができます。署名済みドキュメントは、変数またはペイロードフォルダーを使用して保存できます。
note note NOTE 監査レポートは、署名済みドキュメントの最後のページに追加されます。
ドキュメントサービスの手順 document-services-steps
AEM Document Services は、PDF ドキュメントを作成、アセンブリおよび保護するための一連のサービスです。AEM Forms は、それぞれのドキュメントサービスに対して個別の AEM ワークフローステップを提供します。
タスクの割り当て、メールの送信、ドキュメントの署名など、他の AEM Forms ワークフローステップと同様に、AEM Document Services のすべての手順で変数を使用できます。変数の作成と管理については、AEM ワークフローの変数を参照してください。
ドキュメントのタイムスタンプの適用手順 apply-document-time-stamp-step
ドキュメントにタイムスタンプを追加します。入力ドキュメントのパス、入力ドキュメントの名前、書き出されたデータの保存場所など、ドキュメントの詳細を指定します。既存のペイロードファイルを上書きするか、別のファイル名を選択してデータをペイロードフォルダーの下の別のファイルに格納するか、データへの絶対パスを指定するか、データをドキュメントデータタイプの変数に格納するかを選択できます。
画像に変換ステップ convert-to-image-step
PDF ドキュメントを画像のリストに変換します。サポートされている画像形式は、JPEG、JPEG2000、PNG および TIFF です。TIFF 画像への変換には、次の情報が適用されます。
- 複数ページの TIFF ファイルが生成されます。
- 一部の注釈は TIFF 画像に含まれません。Acrobat によるアピアランスの生成が必要な注釈は含まれません。
PDF/A に変換手順 convert-to-pdf-a-step
指定したオプションを使用して PDF ドキュメントを PDF/A 形式に変換します。PDF/A バージョンの Portable Document Format(PDF)は、ドキュメントのアーカイブおよび長期保存に特化しています。
PS に変換手順 convert-to-ps-step
PDF ドキュメントを PostScript に変換します。PostScript に変換する際に、この変換操作を使用して、変換元のドキュメントと、PostScript レベル 2 と 3 のどちらに変換するかを指定できます。PostScript ファイルに変換する PDF ドキュメントは、非インタラクティブである必要があります。
指定されたタイプで PDF を作成手順 create-pdf-from-specified-type-step
入力ファイルから PDF ドキュメントを生成します。入力ドキュメントは、ペイロードに対する相対パス、絶対パス、ペイロード自体を持つこと、または Document データ型の変数に格納することができます。
URL/HTML/ZIP から PDF を作成手順 create-pdf-from-url-html-zip-step
指定された URL、HTML、ZIP ファイルから PDF ドキュメントを生成します。
データを書き出す手順 export-data-step
PDF forms または XDP ファイルからデータを書き出します。入力ドキュメントのファイルパスとデータを書き出す形式を入力する必要があります。データを書き出す形式のオプションは、「自動」、「XDP」および「XmlData」です。
PDF を指定されたタイプに書き出す手順 export-pdf-to-specified-type-step
PDF ドキュメントを選択した形式に変換します。
非インタラクティブ PDF の生成手順 generatenoninteractive
非インタラクティブ PDF を生成します。様々なカスタマイズオプションが用意されています。
データを読み込む手順 import-data-step
フォームデータを PDF フォームに結合します。PDF フォームに フォームデータを読み込むことができます。
DDX を呼び出すステップ invokeddx
入力ドキュメントの指定されたマップ上で DDX ファイルを実行し、操作された PDF ドキュメントを返します。
PDF を最適化する手順 optimize-pdf-step
サイズを縮小して PDF ファイルを最適化します。この変換の結果、PDF ファイルは、元のバージョンよりも小さくなる場合があります。また、この操作では、PDF ドキュメントが最適化パラメーターで指定された PDF バージョンに変換されます。
最適化設定では、ファイルの最適化方法を指定します。次に設定例を示します。
- ターゲットの PDF バージョン
- JavaScript アクションや埋め込みページのサムネールなどのオブジェクトの破棄
- コメントや添付ファイルなどのユーザーデータの破棄
- 無効な設定や未使用の設定の破棄
- 非圧縮データの圧縮またはより効率的な圧縮アルゴリズムの使用
- 埋め込みフォントの削除
- 透明度の値の設定
PDF フォームをレンダリングする手順 renderpdf
フォームデザイナー(XDP)で作成したフォームを PDF フォームにレンダリングします。
ドキュメントを保護する手順 secure-document-step
ドキュメントの暗号化、署名および認証を行います。AEM Forms は、パスワードベースと証明書ベース両方の暗号化をサポートしています。また、ドキュメントに署名するための様々なアルゴリズムの中から選択することもできます。例えば、SHA-256 や SHA-512 などがあります。ワークフローの手順を使用して、拡張 PDF ドキュメントを読み取ることもできます。このワークフローステップには、バーコードのデコード、デジタル署名、PDF データの読み込みと書き出しなどのオプションを有効にするためのオプションが用意されています。
プリンターに送信する手順 send-to-printer-step
プリンターにドキュメントを直接送信します。次の印刷アクセスメカニズムがサポートされています。
- 直接アクセス可能プリンター:同じコンピューターにインストールされているプリンターは、直接アクセス可能プリンターと呼ばれ、そのコンピューターはプリンターホストと呼ばれます。このタイプのプリンターは、コンピューターに直接接続されているローカルプリンターなどです。
- 間接アクセス可能プリンター:印刷サーバーにインストールされているプリンターは、他のコンピューターからアクセスします。ネットワークプリンターへの接続には、Common UNIX® Printing System(CUPS)や Line Printer Daemon(LPD)プロトコルなどのテクノロジーを使用できます。間接的にアクセス可能なプリンターにアクセスするには、プリントサーバーの IP またはホスト名を指定します。ネットワークで LPD が実行されている場合はこの方法でドキュメントを LPD URI に送信できます。この仕組みにより、LPD が実行されているネットワークに接続されているすべてのプリンターにドキュメントをルーティングできます。
印刷出力ステップを生成 generatePrintedOutput
指定したフォームデザインとデータファイルに対して PCL、PostScript、ZPL、IPL、TPCL または DPL の出力を生成します。データファイルはフォームデザインとマージされ、印刷用にフォーマットされます。この操作で生成された出力はプリンターに直接送信したり、ファイルとして保存したりできます。この操作はフォームデザインやデータをアプリケーションから使用する場合に実行することをお勧めします。フォームデザインがネットワーク、ローカルファイルシステム、または HTTP 上の場所にある場合は、generatePrintedOutput 操作を使用します。
例えば、アプリケーションでフォームデザインをデータファイルとマージする必要があるとします。データには数百件のレコードがあります。さらに、ZPL をサポートしているプリンターに出力を送信する必要があります。フォームデザインと入力データはアプリケーション内にあります。generatePrintedOutput 操作を使用して、レコードをフォームデザインとマージし、ZPL がサポートされるプリンターに出力を送信します。
「印刷出力を生成」ステップには、次のプロパティがあります。
Input プロパティ
-
次を使用してテンプレートファイルを選択:テンプレートファイルのパスを指定します。 テンプレートファイルは、ペイロードに対する相対パス、絶対パスで保存されたもの、またはドキュメントデータタイプの変数を使用して選択できます。例: [Payload_Directory]/Workflow/data.xml。パスが crx-repository に存在しない場合、管理者はパスを作成してから使用できます。 さらに、ペイロードを入力データファイルとして受け入れることもできます。
-
次を使用してデータドキュメントを選択:入力データファイルのパスを指定します。入力データファイルは、ペイロードに対する相対パス、絶対パスで保存されたもの、またはドキュメントデータタイプの変数を使用して選択できます。例: [Payload_Directory]/Workflow/data.xml。パスが crx-repository に存在しない場合、管理者はパスを作成してから使用できます。
-
プリンター形式:XDC ファイルがない場合に出力ストリームの生成に使用するページ説明言語を指定する値。リテラル値を指定する場合、次のいずれかの値を選択します。
- Custom PCL:PCL 用のカスタム XDC ファイルを指定するには、このオプションを使用します。
- Custom PostScript:PostScript のカスタム XDC ファイルを指定するには、このオプションを使用します。
- Custom ZPL:ZPL 用のカスタム XDC ファイルを指定するには、このオプションを使用します。
- Generic Color PCL (5c):汎用カラー PCL(5c)を使用します。
- Generic PostScript Level3:汎用の PostScript レベル 3 を使用します。
- ZPL 300 DPI:ZPL 300 DPI を使用します。 zpl300.xdc が使用されます。
- ZPL 600 DPI:ZPL 600 DPI を使用します。 zpl600.xdc ファイルが使用されます。
- Custom IPL:IPL のカスタム XDC ファイルを指定するには、このオプションを使用します。
- IPL 300 DPI:IPL 300 DPI を使用します。 ipl300.xdc が使用されます。
- IPL 400 DPI:IPL 400 DPI を使用します。 ipl400.xdc ファイルが使用されます。
- Custom TPCL:TPCL 用のカスタム XDC ファイルを指定するには、このオプションを使用します。
- TPCL 305 DPI:TPCL 300 DPI を使用します。 tpcl305.xdc ファイルが使用されます。
- PCL 600 DPI:TPCL 600 DPI を使用します。 tpcl600.xdc ファイルが使用されます。
- Custom DPL:カスタム XDC ファイル DPL を指定するには、このオプションを使用します。
- DPL300DPI:DPL 300 DPI を使用します。 dpl300.xdc ファイルが使用されます。
- DPL406DPI:DPL 400 DPI を使用します。 dpl406.xdc が使用されます。
- DPL600DPI:DPL 600 DPI を使用します。 dpl600.xdc が使用されます。
出力プロパティ
- 次を使用して出力ドキュメントを保存:出力ファイルを保存する場所を指定します。 出力ファイルは、ペイロードに相対した場所の変数に保存するか、出力ファイルを保存する絶対位置を指定することができます。 パスが crx-repository に存在しない場合、管理者はパスを作成してから使用できます。
詳細プロパティ
-
次を使用してコンテンツルートの場所を選択:コンテンツルートは、フォームデザインで使用される相対アセットを取得するための、リポジトリ内の URI、絶対参照、または場所を指定する文字列値です。 例えば、フォームデザインが …/myImage.gif のようにイメージを相対的に参照する場合、myImage.gif は repository:// に配置する必要があります。デフォルト値は repository:// で、これはリポジトリーのルートレベルを指します。
アプリケーションからアセットを選択するとき、コンテンツルート URI パスは正確な構造になっている必要があります。例えば、フォームを SampleApp というアプリケーションから選択し、SampleApp/1.0/forms/Test.xdp に配置する場合、コンテンツルート URI は repository://administrator@password/Applications/SampleApp/1.0/forms/ または repository:/Applications/SampleApp/1.0/forms/(認証機関情報が NULL の場合)と指定する必要があります。コンテンツルート URI をこのように指定すると、フォーム内の参照されているすべてのアセットのパスがこの URI に対して解決されます。
-
を使用して XCI ファイルを選択:XCI ファイルは、フォームデザイン要素に使用されるフォントやその他のプロパティを記述するために使用されます。 XCI ファイルは、ペイロードに対する相対パス、絶対パス、またはドキュメントデータタイプの変数を使用して保持できます。
-
ロケール:PDF ドキュメントの生成に使用する言語を設定します。リテラル値を指定する場合、リストから言語を選択するか、次のいずれかの値を選択します。
-
Use Server Default:
(デフォルト)AEM Forms サーバー上で設定されているロケール設定を使用します。ロケール設定は、管理コンソールを使用して設定します(「Designer ヘルプ」を参照)。 -
カスタム値を使用するには:
リテラルボックスにロケールコードを入力するか、ロケールコードを含む文字列変数を選択します。サポートされているすべてのロケールコードのリストについては、https://java.sun.com/j2se/1.5.0/docs/guide/intl/locale.doc.html を参照してください。
-
-
Copies:出力の作成部数を指定する整数値。デフォルト値は 1 です。
-
Duplex Printing:両面印刷か片面印刷かを指定する Pagination 値。この値は、PostScript と PCL をサポートするプリンターで使用されます。リテラル値を指定する場合、次のいずれかの値を選択します。
- Duplex Long Edge:両面印刷を使用し、長辺のページネーションを使用して印刷します。
- Duplex Short Edge:両面印刷を使用し、短辺のページネーションを使用して印刷します。
- Simplex:片面印刷を使用します。