複数のXDPフラグメントのアセンブリ

複数のXDPフラグメントを1つのXDPドキュメントにアセンブリできます。 例えば、各XDPファイルにヘルスフォームの作成に使用される1つ以上のサブフォームが含まれているXDPフラグメントを考えてみましょう。 次の図に、アウトラインビューを示します(複数のXDPフラグメントのアセンブリ​クイックスタートで使用されるtuc018_template_flowed.xdpファイルを表します)。

am_am_forma

次の図に、患者のセクションを示します( 複数のXDPフラグメントのアセンブリ​クイックスタートで使用されるtuc018_contact.xdpファイルを表します)。

am_am_formb

次の図に、患者の健康に関する節を示します(複数のXDPフラグメントのアセンブリ​クイックスタートで使用されるtuc018_patient.xdpファイルを表します)。

am_am_formc

このフラグメントには、subPatientPhysical​および​subPatientHealth​という2つのサブフォームが含まれています。 これらのサブフォームは両方とも、Assemblerサービスに渡されるDDXドキュメント内で参照されます。 次の図に示すように、Assemblerサービスを使用して、これらのすべてのXDPフラグメントを1つのXDPドキュメントに結合できます。

am_am_formd

次のDDXドキュメントは、複数のXDPフラグメントを1つのXDPドキュメントにアセンブリします。

 <?xml version="1.0" encoding="UTF-8"?> 
 <DDX xmlns="https://ns.adobe.com/DDX/1.0/"> 
         <XDP result="tuc018result.xdp"> 
            <XDP source="tuc018_template_flowed.xdp"> 
             <XDPContent insertionPoint="ddx_fragment" source="tuc018_contact.xdp" fragment="subPatientContact" required="false"/> 
               <XDPContent insertionPoint="ddx_fragment" source="tuc018_patient.xdp" fragment="subPatientPhysical" required="false"/> 
               <XDPContent insertionPoint="ddx_fragment" source="tuc018_patient.xdp" fragment="subPatientHealth" required="false"/> 
            </XDP> 
         </XDP>         
 </DDX>

DDXドキュメントには、結果の名前を指定するXDP resultタグが含まれています。 この場合、値はtuc018result.xdpです。 この値は、Assemblerサービスが結果を返した後にXDPドキュメントを取得するために使用されるアプリケーションロジックで参照されます。 例えば、アセンブリされたXDPドキュメントを取得するために使用される次のJavaアプリケーションロジックについて考えてみます(値は太字で示されています)。

 //Iterate through the map object to retrieve the result XDP document 
 for (Iterator i = allDocs.entrySet().iterator(); i.hasNext();) { 
     // Retrieve the Map object’s value 
     Map.Entry e = (Map.Entry)i.next(); 
                  
     //Get the key name as specified in the  
     //DDX document  
     String keyName = (String)e.getKey(); 
     if (keyName.equalsIgnoreCase("tuc018result.xdp")) 
                 {  
         Object o = e.getValue(); 
         outDoc = (Document)o; 
  
         //Save the result PDF file 
         File myOutFile = new File("C:\\AssemblerResultXDP.xdp");  
         outDoc.copyToFile(myOutFile); 
     } 
 }

XDP sourceタグは、XDPフラグメントを追加するコンテナとして、またはXDPフラグメントを順に追加する数多くのドキュメントの1つとして使用できる完全なXDPドキュメントを表すXDPファイルを指定します。 この場合、XDPドキュメントはコンテナとしてのみ使用されます(複数のXDPフラグメントのアセンブリ​で示す最初の図)。 つまり、他のXDPファイルはXDPコンテナ内に配置されます。

サブフォームごとに、XDPContent要素を追加できます(この要素はオプションです)。 上記の例では、3つのサブフォームがあることに注意してください。subPatientContactsubPatientPhysical、およびsubPatientHealthsubPatientPhysicalサブフォームとsubPatientHealthサブフォームは、両方とも同じXDPファイルtuc018_patient.xdpに存在します。 フラグメント要素は、Designerで定義されたサブフォームの名前を指定します。

メモ

Assemblerサービスについて詳しくは、『AEM Forms🔗向けサービスリファレンス』を参照してください。

メモ

DDXドキュメントについて詳しくは、『AssemblerサービスとDDXリファレンス』を参照してください。

手順の概要

複数のXDPフラグメントをアセンブリするには、次のタスクを実行します。

  1. プロジェクトファイルを含めます。
  2. PDFアセンブラークライアントを作成します。
  3. 既存のDDXドキュメントの参照
  4. XDPドキュメントを参照します。
  5. 実行時オプションを設定します。
  6. 複数のXDPドキュメントをアセンブリします。
  7. アセンブリされたXDPドキュメントを取得します。

プロジェクトファイルを含める

必要なファイルを開発プロジェクトに含めます。 Javaを使用してクライアントアプリケーションを作成する場合は、必要なJARファイルを含めます。 Webサービスを使用する場合は、プロキシファイルを必ず含めてください。

次のJARファイルをプロジェクトのクラスパスに追加する必要があります。

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-assembler-client.jar
  • adobe-utilities.jar(AEM FormsをJBossにデプロイする場合に必要)
  • jbossall-client.jar(AEM FormsをJBossにデプロイする場合に必要)

PDFアセンブラークライアントの作成

プログラムでAssembler操作を実行する前に、Assemblerサービスクライアントを作成します。

既存のDDXドキュメントの参照

複数のXDPドキュメントをアセンブリするには、DDXドキュメントを参照する必要があります。 このDDXドキュメントには、XDP resultXDP sourceおよびXDPContentの各要素を含める必要があります。

XDPドキュメントの参照

複数のXDPドキュメントをアセンブリするには、結果のXDPドキュメントのアセンブリに使用されるすべてのXDPファイルを参照します。 XDPドキュメントに含まれている、source属性で参照されるサブフォームの名前がfragment属性で指定されていることを確認します。 サブフォームはDesignerで定義されます。 例えば、次のXMLについて考えてみます。

 <XDPContent insertionPoint="ddx_fragment" source="tuc018_contact.xdp" fragment="subPatientContact" required="false"/>

subPatientContact​という名前のサブフォームは、tuc018_contact.xdp​という名前のXDPファイル内に存在する必要があります。

実行時オプションの設定

ジョブの実行中にAssemblerサービスの動作を制御する実行時オプションを設定できます。 例えば、エラーが発生した場合にジョブの処理を続行するようAssemblerサービスに指示するオプションを設定できます。

複数のXDPドキュメントのアセンブリ

複数のXDPファイルをアセンブリするには、invokeDDX操作を呼び出します。 Assemblerサービスは、コレクションオブジェクト内にアセンブリされたXDPドキュメントを返します。

アセンブリ済みXDPドキュメントの取得

アセンブリされたXDPドキュメントがコレクションオブジェクト内で返されます。 コレクションオブジェクトを繰り返し処理し、XDPドキュメントをXDPファイルとして保存します。 また、XDPドキュメントを別のAEM Formsサービス(Outputなど)に渡すこともできます。

関連トピック

Java APIを使用した複数のXDPフラグメントのアセンブリ

WebサービスAPIを使用した複数のXDPフラグメントのアセンブリ

AEM Forms Java ライブラリファイルを含める

接続プロパティの設定

PDFドキュメントのプログラムによるアセンブリ

フラグメントを使用したPDFドキュメントの作成

Java APIを使用した複数のXDPフラグメントのアセンブリ

AssemblerサービスAPI(Java)を使用して、複数のXDPフラグメントをアセンブリします。

  1. プロジェクトファイルを含めます。

    Javaプロジェクトのクラスパスに、adobe-assembler-client.jarなどのクライアントJARファイルを含めます。

  2. PDFアセンブラークライアントを作成します。

    • 接続プロパティを含む ServiceClientFactory オブジェクトを作成します。
    • コンストラクターを使用してAssemblerServiceClientオブジェクトを渡し、ServiceClientFactoryオブジェクトを作成します。
  3. 既存のDDXドキュメントの参照

    • コンストラクターを使用し、DDXファイルの場所を指定する文字列値を渡して、DDXドキュメントを表すjava.io.FileInputStreamオブジェクトを作成します。
    • コンストラクタを使用して com.adobe.idp.Document オブジェクトを渡すことによって、java.io.FileInputStream オブジェクトを作成します。
  4. XDPドキュメントを参照します。

    • HashMapコンストラクターを使用して、入力XDPドキュメントの格納に使用するjava.util.Mapオブジェクトを作成します。

    • com.adobe.idp.Documentオブジェクトを作成し、入力XDPファイルを含むjava.io.FileInputStreamオブジェクトを渡します(各XDPファイルに対してこの作業を繰り返します)。

    • putメソッドを呼び出し、次の引数を渡して、java.util.Mapオブジェクトにエントリを追加します。

      • キー名を表すstring値です。 この値は、DDXドキュメントで指定されたsource要素の値と一致する必要があります(XDPファイルごとにこのタスクを繰り返します)。
      • source要素に対応するXDPドキュメントを含むcom.adobe.idp.Documentオブジェクト(各XDPファイルに対してこのタスクを繰り返します)。
  5. 実行時オプションを設定します。

    • コンストラクターを使用して、実行時オプションを格納するAssemblerOptionSpecオブジェクトを作成します。
    • AssemblerOptionSpecオブジェクトに属するメソッドを呼び出して、ビジネス要件に合った実行時オプションを設定します。 例えば、エラーが発生したときにジョブの処理を続行するようにAssemblerサービスに指示するには、AssemblerOptionSpecオブジェクトのsetFailOnErrorメソッドを呼び出し、falseを渡します。
  6. 複数のXDPドキュメントをアセンブリします。

    AssemblerServiceClientオブジェクトのinvokeDDXメソッドを呼び出し、次の必須値を渡します。

    • 使用するDDXドキュメントを表すcom.adobe.idp.Documentオブジェクト
    • 入力XDPファイルを含むjava.util.Mapオブジェクト
    • デフォルトのフォントやジョブのログレベルを含む、実行時のオプションを指定するcom.adobe.livecycle.assembler.client.AssemblerOptionSpecオブジェクト

    invokeDDXメソッドは、アセンブリされたXDPドキュメントを含むcom.adobe.livecycle.assembler.client.AssemblerResultオブジェクトを返します。

  7. アセンブリされたXDPドキュメントを取得します。

    アセンブリ済みのXDPドキュメントを取得するには、次の操作を実行します。

    • AssemblerResultオブジェクトのgetDocumentsメソッドを呼び出します。 このメソッドはjava.util.Mapオブジェクトを返します。
    • java.util.Mapオブジェクトを繰り返し処理して、結果のcom.adobe.idp.Documentオブジェクトを見つけます。
    • com.adobe.idp.DocumentオブジェクトのcopyToFileメソッドを呼び出して、アセンブリされたXDPドキュメントを抽出します。

関連トピック

複数のXDPフラグメントのアセンブリ

クイックスタート(SOAPモード):Java APIを使用した複数のXDPフラグメントのアセンブリ

AEM Forms Java ライブラリファイルを含める

接続プロパティの設定

WebサービスAPIを使用して複数のXDPフラグメントをアセンブリする

AssemblerサービスAPI(Webサービス)を使用して、複数のXDPフラグメントをアセンブリします。

  1. プロジェクトファイルを含めます。

    MTOMを使用するMicrosoft .NETプロジェクトを作成します。 サービス参照を設定する際は、次のWSDL定義を使用してください。

     http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1.
    
    メモ

    localhostを、AEM FormsをホストするサーバーのIPアドレスに置き換えます。

  2. PDFアセンブラークライアントを作成します。

    • デフォルトのコンストラクターを使用してAssemblerServiceClientオブジェクトを作成します。

    • System.ServiceModel.EndpointAddressコンストラクターを使用してAssemblerServiceClient.Endpoint.Addressオブジェクトを作成します。 AEM FormsサービスにWSDLを指定するstring値(http://localhost:8080/soap/services/AssemblerService?blob=mtomなど)を渡します。 lc_version属性を使用する必要はありません。 この属性は、サービス参照を作成する際に使用されます。

    • AssemblerServiceClient.Endpoint.Bindingフィールドの値を取得してSystem.ServiceModel.BasicHttpBindingオブジェクトを作成します。 戻り値を BasicHttpBinding にキャストします。

    • System.ServiceModel.BasicHttpBindingオブジェクトのMessageEncodingフィールドをWSMessageEncoding.Mtomに設定します。 この値は、MTOMが使用されるようにします。

    • 次のタスクを実行して、基本的なHTTP認証を有効にします。

      • AssemblerServiceClient.ClientCredentials.UserName.UserNameフィールドにAEM formsユーザー名を割り当てます。
      • 対応するパスワード値をAssemblerServiceClient.ClientCredentials.UserName.Passwordフィールドに割り当てます。
      • HttpClientCredentialType.Basic定数値をBasicHttpBindingSecurity.Transport.ClientCredentialTypeフィールドに割り当てます。
      • BasicHttpSecurityMode.TransportCredentialOnly定数値をBasicHttpBindingSecurity.Security.Modeフィールドに割り当てます。
  3. 既存のDDXドキュメントの参照

    • コンストラクタを使用して BLOB オブジェクトを作成します。BLOBオブジェクトは、DDXドキュメントの格納に使用されます。
    • コンストラクターを呼び出し、DDXドキュメントのファイルの場所とファイルを開くモードを表すstring値を渡して、System.IO.FileStreamオブジェクトを作成します。
    • System.IO.FileStreamオブジェクトの内容を格納するバイト配列を作成します。 System.IO.FileStreamオブジェクトのLengthプロパティを取得することで、バイト配列のサイズを判断できます。
    • System.IO.FileStreamオブジェクトのReadメソッドを呼び出して、バイト配列にストリームデータを入力します。 読み取るバイト配列、開始位置、ストリーム長を渡します。
    • BLOBオブジェクトのMTOMプロパティにバイト配列の内容を割り当てて、オブジェクトを設定します。
  4. XDPドキュメントを参照します。

    • 各入力XDPファイルに対して、コンストラクターを使用してBLOBオブジェクトを作成します。 BLOBオブジェクトは、入力ファイルの保存に使用されます。
    • コンストラクターを呼び出し、入力ファイルのファイルの場所とファイルを開くモードを表すstring値を渡して、System.IO.FileStreamオブジェクトを作成します。
    • System.IO.FileStreamオブジェクトの内容を格納するバイト配列を作成します。 System.IO.FileStreamオブジェクトのLengthプロパティを取得することで、バイト配列のサイズを判断できます。
    • System.IO.FileStreamオブジェクトのReadメソッドを呼び出して、バイト配列にストリームデータを入力します。 読み取るバイト配列、開始位置、ストリーム長を渡します。
    • BLOBオブジェクトのMTOMフィールドにバイト配列の内容を割り当てて、オブジェクトを設定します。
    • MyMapOf_xsd_string_To_xsd_anyTypeオブジェクトを作成します。 このコレクションオブジェクトは、アセンブリされたXDPドキュメントの作成に必要な入力ファイルを格納するために使用されます。
    • 入力ファイルごとに、MyMapOf_xsd_string_To_xsd_anyType_Itemオブジェクトを作成します。
    • MyMapOf_xsd_string_To_xsd_anyType_Itemオブジェクトのkeyフィールドに、キー名を表すstring値を割り当てます。 この値は、DDXドキュメントで指定されたエレメントの値と一致する必要があります。 (このタスクは入力XDPファイルごとに実行します)。
    • 入力ファイルを格納するBLOBオブジェクトをMyMapOf_xsd_string_To_xsd_anyType_Itemオブジェクトのvalueフィールドに割り当てます。 (このタスクは入力XDPファイルごとに実行します)。
    • MyMapOf_xsd_string_To_xsd_anyType_ItemオブジェクトをMyMapOf_xsd_string_To_xsd_anyTypeオブジェクトに追加します。 MyMapOf_xsd_string_To_xsd_anyTypeオブジェクトのAddメソッドを呼び出して、MyMapOf_xsd_string_To_xsd_anyTypeオブジェクトを渡します。 (このタスクは入力XDPドキュメントごとに実行します)。
  5. 実行時オプションを設定します。

    • コンストラクターを使用して、実行時オプションを格納するAssemblerOptionSpecオブジェクトを作成します。
    • AssemblerOptionSpecオブジェクトに属するデータメンバーに値を割り当てて、ビジネス要件に合った実行時オプションを設定します。 例えば、エラーが発生したときにジョブの処理を続行するようにAssemblerサービスに指示するには、falseAssemblerOptionSpecオブジェクトのfailOnErrorデータメンバーに割り当てます。
  6. 複数のXDPドキュメントをアセンブリします。

    AssemblerServiceClientオブジェクトのinvokeDDXメソッドを呼び出し、次の値を渡します。

    • DDXドキュメントを表すBLOBオブジェクト
    • 必要なファイルを含むMyMapOf_xsd_string_To_xsd_anyTypeオブジェクト
    • 実行時オプションを指定するAssemblerOptionSpecオブジェクト

    invokeDDXメソッドは、ジョブの結果と発生した例外を含むAssemblerResultオブジェクトを返します。

  7. アセンブリされたXDPドキュメントを取得します。

    新しく作成したXDPドキュメントを取得するには、次の操作を実行します。

    • AssemblerResultオブジェクトのdocumentsフィールド(結果のPDFドキュメントを含むMapオブジェクト)にアクセスします。
    • Mapオブジェクトを繰り返し処理して、各結果ドキュメントを取得します。 次に、配列メンバのvalueBLOBにキャストします。
    • BLOBオブジェクトのMTOMプロパティにアクセスして、PDFドキュメントを表すバイナリデータを抽出します。 XDPファイルに書き出すことができるバイトの配列を返します。

関連トピック

複数のXDPフラグメントのアセンブリ

MTOMを使用したAEM Formsの呼び出し

このページ