Form Augmenter

注意： 2012 年 3 月 10 日から、アドビでは Adobe® AEM forms® ES のガイド機能を非推奨とします。ガイド機能は、アップグレード目的でのみ使用でき、今後 2 回のメジャーリリースの後で製品から削除されます。

フォームをプロセスに統合し、Workspace で使用できるようにするために役立つ操作を提供します。例えば、フォーム、ドキュメントフォームまたは xfaForm 変数に対するカスタムレンダリングサービスや送信サービスにおいて、Form Augmenter サービスの操作が役立ちます。

一般的に、次の順序ですべての Form Augmenter サービス操作を呼び出します。

  1. document 値、例えば PDF ファイルの値としてフォームを取得します。

  2. 「Insert Workflow XFO Data」操作 操作または 「Lookup and Insert Workflow XFO Data」操作 操作を使用して、値をフォームに挿入します。

  3. 「importData」操作 操作を使用してデータをフォームとマージします。

  4. 「Inject Form Bridge」操作 操作を使用して、Workspace に対してフォームを有効にします。

Form Augmenter サービスの使用に関する詳細は、『 AEM forms サービスリファレンス 』を参照してください。

「Get value of a form field」操作

フォーム上のフィールドから値を取得します。PDF フォームは Designer 8.2 以降、または Adobe Acrobat 7.0.5 以降で作成する必要があります。

General プロパティグループと Route Evaluation プロパティグループについて詳しくは、 共通の操作プロパティ を参照してください。

Input プロパティ

フォームおよびフォームフィールドを指定するプロパティ。

Input Form Data Document

フォームとマージされる XDP データを表す 文書 値。

リテラル値を指定する場合は、省略記号ボタン をクリックして、Select Asset ダイアログボックスを開きます（ Select Asset について を参照）。

「Name Of Form」フィールド

フォーム上のフィールド名を表す string 値。例えば、フォームデザインで、「mortgageAmount」という名前のフィールドに " mortgageAmount " と入力します。

Output プロパティ

フォームフィールドから値を保存するためのプロパティ。

「Value Of Form」フィールド

フォームフィールドからの値を保存する場所。データタイプは string です。

Exceptions

この操作は Java.lang.Exception 例外をスローする可能性があります。

「Inject Form Bridge」操作

Flex アプリケーションおよび AIR アプリケーションで PDF フォームとの通信を可能にするための JavaScript コードを追加します。このサービス操作により、次のことが可能になります。

  • Workspace で機能する Adobe PDF フォームまたは Adobe Acrobat フォーム。

  • ガイドとともに機能する Adobe Acrobat フォーム用の Adobe PDF。

  • Unified Workspace Solution の Document Portfolio Managementbuilding ブロックと一緒に使用される Adobe PDF フォーム。

プロセスで Adobe XML フォーム（XDP ファイル）を使用する場合、フォームを PDF にレンダリングして、「Inject Form Bridge」操作を使用することができます。PDF にレンダリングするには、Forms サービスで提供される 「renderPDFForm」操作 操作を使用します。Designer での JavaScript の作成について詳しくは、「 Workspace で使用するフォームを準備する 」を参照してください。

この操作の機能は、フォームに応じて異なります。

  • フォームに既に Form Bridge XFO コンポーネントが存在している場合、JavaScript がフォームに追加されません。

  • フォームが認証されている場合、その認証が取り消されます。Form Bridge XFO コンポーネントを追加した後でのみフォームを認証する必要があります。

  • フォームの権限が有効になっている場合、暗号化が機能しません。Form Bridge XFO コンポーネントを追加した後でのみフォームの権限を有効にする必要があります。

  • フォームに電子署名がある場合、署名が破棄されます。Form Bridge XFO コンポーネントを追加した後でのみフォームに電子署名する必要があります。

Workspace には「Complete」ボタンがあり、ユーザーがクリックすると、フォームが送信されます。ただし、フォームに送信ボタンを含めることもできます。フォームで「Inject Form Bridge」操作が使用されている場合、Workspace では送信ボタンが非表示になります。

フォームデザイン

結果

フォームに送信ボタンが含まれていません。

Workspace で「Complete」ボタンが無効になっていて、ユーザーはフォームを送信できません。「Assign Task」サービス操作と「Assign Multiple Tasks」サービス操作で「Reader Submit」オプションを有効にすると、「Submit」ボタンがなくてもフォームを送信できます。詳しくは、 Assign Task 操作 と Assign Multiple Tasks 操作 を参照してください。

フォームに 1 つの送信ボタンが含まれています。

Workspace で送信ボタンが非表示になっています。Workspace で「Complete」ボタンを有効にします。

フォームに、送信ボタン（直接的な送信）をポイントするボタン（間接的な送信）が含まれています。

複数の送信ボタンが存在している場合でも、間接的な送信ボタンが常に直接的な送信ボタンよりも優先されます。Workspace には常に間接的な送信ボタンが表示されます。

Workspace で送信ボタンが非表示になっています。Workspace で「Complete」ボタンを有効にします。

フォームには 1 つまたは複数の直接的な送信ボタンをポイントする複数の間接的な送信ボタンが含まれています。

Workspace で「Workspace Complete」ボタンが無効になっています。ユーザーはフォーム上の適切なボタンをクリックしてフォームを送信する必要があります。

この場合も、ユーザーはフォームの下書きを保存したり、フォームをオフラインで使用したりできます。

フォームには、繰り返しのサブフォームに間接的なボタンまたは直接的なボタンのいずれかが含まれています。

Workspace では、Workspace 内のフォームを送信するためのこのようなボタンが除外されています。

注意： Process Fields フォームオブジェクトを非表示にして「Submit」ボタンがフォームに追加された場合、このボタンによってフォームを送信するための機能が提供されます。

送信要求は Workspace で処理されます。これは、AEM forms サーバーと、オフライン・オンライン両対応のフォームの間に介在するようにして機能します。Workspace に対するフォームの指定について詳しくは、「 Workspace で使用するフォームを準備する 」を参照してください。

Input プロパティ

Workspace で使用する PDF フォームを有効にするためのプロパティ。

Input PDF Document

Form Bridge が埋め込まれる PDF フォームを指定する 文書 値。

リテラル値を指定する場合は、省略記号ボタンをクリックして、Select Asset ダイアログボックスを開きます（ Select Asset について を参照）。

Output プロパティ

PDF フォームを保存する場所を指定するプロパティ。

増大した PDF ドキュメント

増大した PDF ドキュメントを保存する場所。データタイプは 文書 です。

Exceptions

この操作は Java.lang.Exception 例外をスローする可能性があります。

「Insert Workflow XFO Data」操作

Workspace で作成された PDF フォームが Designer でオフラインで使用できるように、フォームデータにデータフィールドを追加します。Acrobat フォームは指定できません。

General プロパティグループと Route Evaluation プロパティグループについて詳しくは、 共通の操作プロパティ を参照してください。

Input プロパティ

フォームデータを XDP（XML 形式）データファイルとして指定するプロパティ。

Input Form Data Document

フォームデータを参照する xml 値。これは XDP（XML 形式）データファイルとしてフォーマットされます。

リテラル値を指定する場合は、省略記号ボタンをクリックをクリックして、Select Asset ダイアログボックスを開きます（ Select Asset について を参照）。

ターゲット URL の送信

フォームの送信要求を処理するために使用される Workspace サーブレットの場所を指定する string 値。

リテラル値を指定する場合は、AEM forms サーバーのロケーションサーバー名を入力します。例えば、Workspace にアクセスするには、" http:// [server name] : [port] / /rest/services/ProcessManagementDocumentHandlingService/submit " と入力します。ここで、 [server name] には AEM forms サーバーの名前を指定し、 [port] にはポート番号を指定します。次のデフォルトポート番号は、各アプリケーションサーバーの AEM forms で使用されます。

  • JBoss: 8080

  • WebLogic: 7001

  • WebSphere: 9080

    注意： Submit Target Url プロパティに HTTP over Secure Socket Layer（SSL）を使用することもできます。

タスク ID

タスクの固有な識別子を表す string 値。

リテラル値を指定する場合、タスクを表す固有な識別子を入力します。

サーバーの電子メールアドレスを返す

AEM forms サーバーが使用する電子メールアドレスを表す string 値。

リテラル値を指定する場合は、AEM forms サーバーが使用する電子メールアドレスを入力します。例えば、" myadministrator@example.com " と入力できます。

タスクステータス

割り当てられたタスクのステータスを表す string 値。

リテラル値を指定する場合、次の値のいずれかを使用するタスクのステータスを入力します。

1:
タスクが作成された。

2:
タスクが作成され、保存された。

3:
タスクが割り当てられた。

4:
タスクが割り当てられ、保存された。

100:
タスクが完了した。

101:
タスクのデッドラインが過ぎた。

102:
タスクが終了した。

ルートのリスト

ユーザーが選択できるルートのリストを表す string 値。タスクが完了したと見なされる前に発生するアクションを表すルート。

リテラル値を指定する場合、ユーザーによって選択されるルートのリストをカンマで区切って入力します。例えば、" Accept, Deny, Cancel " と入力できます。

割り当てられたユーザー ID

タスクを割り当てられたユーザーのグローバル一意識別子（GUID）を表す string 値。通常はこの値を使用して、タスクを完了したユーザーの GUID を保存します。

リテラル値を指定する場合、ユーザーを表す GUID を入力します。

Output プロパティ

変更されたフォームデータを保存する場所を指定するプロパティ。

変更されたデータドキュメント

変更されたフォームを保存する場所。データタイプは xml です。

Exceptions

この操作は Java.lang.Exception 例外をスローする可能性があります。

「Lookup and Insert Workflow XFO Data」操作

Designer で作成された PDF フォームを Workspace でオフラインで使用できるようにします。Acrobat フォームは指定できません。フォームを送信するように割り当てられたユーザープロファイル、使用可能なルートのリスト、およびタスクのステータスは input Task Id 値を使用して情報を検索することによって決まります。

General プロパティグループと Route Evaluation プロパティグループについて詳しくは、 共通の操作プロパティ を参照してください。

Input プロパティ

フォームデータを Acrobat フォームまたは Adobe XML フォームとして指定するプロパティ。

Input Form Data Document

フォームデータを参照する xml 値。これは XDP データファイルとしてフォーマットされます。

リテラル値を指定する場合は、省略記号ボタンをクリックして、Select Asset ダイアログボックスを開きます（ Select Asset について を参照）。

ターゲット URL の送信

フォームの送信要求を処理するために使用される Workspace サーブレットの場所を表す string 値。

リテラル値を指定する場合は、AEM forms サーバーのロケーションサーバー名を入力します。例えば、Workspace にアクセスするには、" http:// [server name] : [port] /rest/services/ProcessManagementDocumentHandlingService/submit " と入力します。ここで、 [server name] には AEM forms サーバーの名前を指定し、 [port] にはポート番号を指定します。次のデフォルトポート番号は、各アプリケーションサーバーの AEM forms で使用されます。

  • JBoss: 8080

  • WebLogic: 7001

  • WebSphere: 9080

    注意： また、Submit Target Url プロパティに対して「HTTP over Secure Socket Layer」を使用することもできます。

タスク ID

タスクの固有な識別子を表す string 値。

リテラル値を指定する場合、タスクを表す固有な識別子を入力します。

サーバーの電子メールアドレスを返す

AEM forms サーバーが使用する電子メールアドレスを表す string 値。

リテラル値を指定する場合は、AEM forms サーバーが使用する電子メールアドレスを入力します。例えば、" myadministrator@sampleOrganization.com " と入力できます。

Output プロパティ

変更されたフォームデータドキュメントを保存する場所を指定するプロパティ。

変更されたデータドキュメント

変更されたフォームデータを保存する場所。データタイプは xml です。

Exceptions

この操作は Java.lang.Exception 例外をスローする可能性があります。

「Remove Data Fields」操作

フォームデータのデータフィールドのセットを削除します。

General プロパティグループと Route Evaluation プロパティグループについて詳しくは、 共通の操作プロパティ を参照してください。

Input プロパティ

削除するフォームデータおよびフィールドを指定するプロパティ。

Input Data Document

フォームデータを表す xml 値。

リテラル値を指定する場合は、省略記号ボタンをクリックして、Select Asset ダイアログボックスを開きます（ Select Asset について を参照）。

Input Field Map

フォームデータから削除するデータフィールドを指定するサブタイプ string の map 値。

Output プロパティ

変更されたフォームデータドキュメントを保存する場所を指定するプロパティ。

変更されたデータドキュメント

フォームデータを保存する場所。データタイプは xml です。

Exceptions

この操作は Java.lang.Exception 例外をスローする可能性があります。

Form Augmenter 例外

Form Augmenter サービスでは、例外イベントをスローするために次の例外が提供されます。

Java.lang.Exception

フォームが増大した場合にエラーがスローされます。