Batch API を使用して複数のインタラクティブ通信を生成する use-batch-api-to-generate-multiple-ic

監視フォルダーを作成して、Batch API を使用するように設定します。

1. AEM Forms オーサーインスタンスにログインします。
2. ツール／Forms／監視フォルダーを設定 ​に移動します。「新規」を選択します。
3. フォルダーの​ 名前 ​と物理的​ パス ​を指定します。例えば、c:\batchprocessing のように指定します。
4. 次を使用してファイルを処理 ​フィールドで「サービス」オプションを選択します。
5. サービス名 ​フィールドで、com.adobe.fd.ccm.multichannel.batch.impl.service.InteractiveCommunicationBatchServiceImpl サービスを選択します。
6. 出力ファイルパターン ​を指定します。例： %F/ pattern は、監視フォルダーが Watched Folder\input フォルダーのサブフォルダー内に入力ファイルを見つけることを指定します。

以下の手順に従って、詳細設定パラメーターを設定します。

1. 「詳細」タブを開いて、次のカスタムプロパティを追加します。

   table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3
   Property	型	説明
   templatePath	文字列	使用するインタラクティブ通信テンプレートのパスを指定します。例えば、/content/dam/formsanddocuments/testsample/mediumic のようになります。これは必須プロパティです。
   recordPath	文字列	recordPath フィールドの値は、インタラクティブ通信の名前を設定するのに役立ちます。レコードのフィールドのパスは、recordPath フィールドの値として設定できます。例えば、 /employee/Id を指定した場合、id フィールドの値は、対応するインタラクティブ通信の名前になります。デフォルト値は、 ランダム UUID.
   usePrefillService	Boolean	値を False に設定します。usePrefillService パラメーターを使用すると、対応するインタラクティブ通信用に設定された事前入力サービスから取得したデータを、インタラクティブ通信に事前入力することができます。usePrefillService が true に設定されている場合、（レコードごとに）入力された JSON データは FDM 引数として扱われます。デフォルト値は false です。
   batchType	文字列	値を PRINT、WEB、または WEB_AND_PRINT に設定します。デフォルト値は WEB_AND_PRINT です。
   locale	文字列	出力インタラクティブ通信のロケールを指定します。そのまま使用できるサービスでは、ロケールオプションは使用されませんが、カスタムサービスを作成して、ローカライズされたインタラクティブ通信を生成することができます。デフォルト値は en_US です。

2. 「作成」を選択します。

作成した監視フォルダーを使用してインタラクティブ通信を生成します。

1. 監視フォルダーを開きます。入力フォルダーに移動します。

2. 入力フォルダーにフォルダーを作成し、新しく作成したフォルダーに JSON ファイルを配置します。

3. 監視フォルダーがファイルを処理するのを待ちます。処理が開始されると、そのファイルを含む入力ファイルとサブフォルダーがステージングフォルダーに移動します。

4. output フォルダーを開き、出力を表示します。

   • 監視フォルダー設定で PRINT オプションを指定すると、インタラクティブ PDF の通信出力が生成されます。
   • 監視フォルダー設定で WEB オプションを指定すると、レコードごとに JSON ファイルが生成されます。JSON ファイルを使用して Web テンプレートに事前入力できます。
   • PRINT オプションと WEB オプションの両方を指定すると、レコードごとに PDF ドキュメントと JSON ファイルの両方が生成されます。

テンプレートのフォームデータモデルを設定します。

1. インタラクティブ通信テンプレートに関連付けたフォームデータモデルを開きます。

2. トップレベルモデルオブジェクトを選択し、「プロパティを編集」を選択します。

3. プロパティを編集パネルの「サービスの読み取り」フィールドから、サービス取得を選択します。

4. 読み取りサービスの引数の鉛筆アイコンを選択して、引数をリクエスト属性にバインドし、バインド値を指定します。これにより、指定したバインド属性またはリテラル値にサービスの引数がバインドされ、それが引数としてサービスに渡され、指定した値に関連付けられている詳細情報がデータソースから取得されます。

この例では、id 引数を使用してユーザープロファイルの id 属性の値を取得し、それを引数として読み取りサービスに渡しています。指定した ID の従業員データモデルオブジェクトから、関連するプロパティの値を読み取り、返します。 したがって、フォームの id フィールドに00250と指定した場合、読み取りサービスは、従業員 ID が00250の従業員の詳細を読み取ります。

1. プロパティとフォームデータモデルを保存します。

リクエスト属性の値を設定：

1. .json ファイルをファイルシステム上に作成し、編集用に開きます。

2. JSON 配列を作成し、フォームデータモデルからデータを取得できるように主属性を指定します。 例えば、次の JSON は FDM に対し、id が 27126 または 27127 のレコードのデータを送信するようにリクエストします。

   code language-json
   [ { "id": 27126 }, { "id": 27127 } ]

3. ファイルを保存して閉じます。

監視フォルダーを作成して、Batch API サービスを使用するように設定します。

1. AEM Forms オーサーインスタンスにログインします。
2. ツール／Forms／監視フォルダーを設定 ​に移動します。「新規」を選択します。
3. フォルダーの​ 名前 ​と物理的​ パス ​を指定します。例えば、c:\batchprocessing のように指定します。
4. 次を使用してファイルを処理 ​フィールドで「サービス」オプションを選択します。
5. サービス名 ​フィールドで、com.adobe.fd.ccm.multichannel.batch.impl.service.InteractiveCommunicationBatchServiceImpl サービスを選択します。
6. 出力ファイルパターン ​を指定します。例： %F/ pattern は、監視フォルダーが Watched Folder\input フォルダーのサブフォルダー内に入力ファイルを見つけることを指定します。

以下の手順に従って、詳細設定パラメーターを設定します。

1. 「詳細」タブを開いて、次のカスタムプロパティを追加します。

   table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3
   Property	型	説明
   templatePath	文字列	使用するインタラクティブ通信テンプレートのパスを指定します。例えば、 /content/dam/formsanddocuments/testsample/mediumic のように指定します。これは必須プロパティです。
   recordPath	文字列	recordPath フィールドの値は、インタラクティブ通信の名前を設定するのに役立ちます。レコードのフィールドのパスは、recordPath フィールドの値として設定できます。例えば、 /employee/Id を指定した場合、id フィールドの値は、対応するインタラクティブ通信の名前になります。デフォルト値は、 ランダム UUID.
   usePrefillService	Boolean	値を True に設定します。デフォルト値は false です。 値を true に設定すると、Batch API は設定されたフォームデータモデルからデータを読み取り、インタラクティブ通信に入力します。usePrefillService が true に設定されている場合、（レコードごとに）入力された JSON データは FDM 引数として扱われます。
   batchType	文字列	値を PRINT、WEB、または WEB_AND_PRINT に設定します。デフォルト値は WEB_AND_PRINT です。
   locale	文字列	出力インタラクティブ通信のロケールを指定します。そのまま使用できるサービスでは、ロケールオプションは使用されませんが、カスタムサービスを作成して、ローカライズされたインタラクティブ通信を生成することができます。デフォルト値は en_US です。

2. 「作成」を選択します。

作成した監視フォルダーを使用してインタラクティブ通信を生成します。

1. 監視フォルダーを開きます。入力フォルダーに移動します。

2. 入力フォルダーにフォルダーを作成します。手順 2 で作成した JSON ファイルを、新しく作成したフォルダーに配置します。

3. 監視フォルダーがファイルを処理するのを待ちます。処理が開始されると、そのファイルを含む入力ファイルとサブフォルダーがステージングフォルダーに移動します。

4. output フォルダーを開き、出力を表示します。

   • 監視フォルダー設定で PRINT オプションを指定すると、インタラクティブ PDF の通信出力が生成されます。
   • 監視フォルダー設定で WEB オプションを指定すると、レコードごとに JSON ファイルが生成されます。JSON ファイルを使用して Web テンプレートに事前入力できます。
   • PRINT オプションと WEB オプションの両方を指定すると、レコードごとに PDF ドキュメントと JSON ファイルの両方が生成されます。

AEM インスタンスにログインし、インタラクティブ通信を作成します。以下のサンプルコードで説明するインタラクティブ通信を使用するには、ここをクリックしてください。

AEM インスタンスで Apache Maven を使用した AEM プロジェクトのビルドとデプロイをおこないます。

追加 AEM Forms Client SDK バージョン 6.0.12 以降 AEMプロジェクトの POM ファイルの dependencies リスト。 例：

    <dependency>
        <groupId>com.adobe.aemfd</groupId>
        <artifactId>aemfd-client-sdk</artifactId>
        <version>6.0.122</version>
    </dependency>

Java™プロジェクトを開き、.java ファイル（例：CCMBatchServlet.java）を作成します。 次のコードをファイルに追加します。

        package com.adobe.fd.ccm.multichannel.batch.integration;

        import java.io.File;
        import java.io.FileInputStream;
        import java.io.FileOutputStream;
        import java.io.IOException;
        import java.io.InputStream;
        import java.io.PrintWriter;
        import java.util.List;
        import javax.servlet.Servlet;
        import org.apache.commons.io.IOUtils;
        import org.apache.sling.api.SlingHttpServletRequest;
        import org.apache.sling.api.SlingHttpServletResponse;
        import org.apache.sling.api.servlets.SlingAllMethodsServlet;
        import org.json.JSONArray;
        import org.json.JSONObject;
        import org.osgi.service.component.annotations.Component;
        import org.osgi.service.component.annotations.Reference;

        import com.adobe.fd.ccm.multichannel.batch.api.builder.BatchConfigBuilder;
        import com.adobe.fd.ccm.multichannel.batch.api.factory.BatchComponentBuilderFactory;
        import com.adobe.fd.ccm.multichannel.batch.api.model.BatchConfig;
        import com.adobe.fd.ccm.multichannel.batch.api.model.BatchInput;
        import com.adobe.fd.ccm.multichannel.batch.api.model.BatchResult;
        import com.adobe.fd.ccm.multichannel.batch.api.model.BatchType;
        import com.adobe.fd.ccm.multichannel.batch.api.model.RecordResult;
        import com.adobe.fd.ccm.multichannel.batch.api.model.RenditionResult;
        import com.adobe.fd.ccm.multichannel.batch.api.service.BatchGeneratorService;
        import com.adobe.fd.ccm.multichannel.batch.util.BatchConstants;
        import java.util.Date;


        @Component(service=Servlet.class,
        property={
                "sling.servlet.methods=GET",
                "sling.servlet.paths="+ "/bin/batchServlet"
        })
        public class CCMBatchServlet extends SlingAllMethodsServlet {

            @Reference
            private BatchGeneratorService batchGeneratorService;
            @Reference
            private BatchComponentBuilderFactory batchBuilderFactory;
            public void doGet(SlingHttpServletRequest req, SlingHttpServletResponse resp) {
                try {
                    executeBatch(req,resp);
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
            private void executeBatch(SlingHttpServletRequest req, SlingHttpServletResponse resp) throws Exception {
                int count = 0;
                JSONArray inputJSONArray = new JSONArray();
                String filePath = req.getParameter("filePath");
                InputStream is = new FileInputStream(filePath);
                String data = IOUtils.toString(is);
                try {
                    // If input file is json object, then create json object and add in json array, if not then try for json array
                    JSONObject inputJSON = new JSONObject(data);
                    inputJSONArray.put(inputJSON);
                } catch (Exception e) {
                    try {
                        // If input file is json array, then iterate and add all objects into inputJsonArray otherwise throw exception
                        JSONArray inputArray = new JSONArray(data);
                        for(int i=0;i<inputArray.length();i++) {
                            inputJSONArray.put(inputArray.getJSONObject(i));
                        }
                    } catch (Exception ex) {
                        throw new Exception("Invalid JSON Data. File name : " + filePath, ex);
                    }
                }
                BatchInput batchInput = batchBuilderFactory.getBatchInputBuilder().setData(inputJSONArray).setTemplatePath("/content/dam/formsanddocuments/[path of the interactive communcation]").build();
                BatchConfig batchConfig = batchBuilderFactory.getBatchConfigBuilder().setBatchType(BatchType.WEB_AND_PRINT).build();
                BatchResult batchResult = batchGeneratorService.generateBatch(batchInput, batchConfig);
                List<RecordResult> recordList = batchResult.getRecordResults();
                JSONObject result = new JSONObject();
                for (RecordResult recordResult : recordList) {
                    String recordId = recordResult.getRecordID();
                    for (RenditionResult renditionResult : recordResult.getRenditionResults()) {
                        if (renditionResult.isRecordPassed()) {
                            InputStream output = renditionResult.getDocumentStream().getInputStream();
                            result.put(recordId +"_"+renditionResult.getContentType(), output);

                            Date date= new Date();
                            long time = date.getTime();

                            // Print output
                            if(getFileExtension(renditionResult.getContentType()).equalsIgnoreCase(".json")) {
                                File file = new File(time + getFileExtension(renditionResult.getContentType()));
                                copyInputStreamToFile(output, file);
                            } else
                            {
                                File file = new File(time + getFileExtension(renditionResult.getContentType()));
                                copyInputStreamToFile(output, file);
                            }
                        }
                    }
                }
                PrintWriter writer = resp.getWriter();
                JSONObject resultObj = new JSONObject();
                resultObj.put("result", result);
                writer.write(resultObj.toString());
            }


            private static void copyInputStreamToFile(InputStream inputStream, File file)
                    throws IOException {

                    try (FileOutputStream outputStream = new FileOutputStream(file)) {

                        int read;
                        byte[] bytes = new byte[1024];

                        while ((read = inputStream.read(bytes)) != -1) {
                            outputStream.write(bytes, 0, read);
                        }

                    }

                }


            private String getFileExtension(String contentType) {
                if (contentType.endsWith(BatchConstants.JSON)) {
                    return ".json";
                } else return ".pdf";
            }


        }

上記のコードで、テンプレートのパス（setTemplatePath）をテンプレートのパスに置き換え、setBatchType API の値を設定します。

• PRINT オプションPDFを指定すると、インタラクティブ通信の出力が生成されます。
• WEB オプションを指定すると、レコードごとに JSON ファイルが生成されます。 JSON ファイルを使用して Web テンプレートに事前入力できます。
• PRINT オプションと WEB オプションの両方を指定すると、レコードごとに PDF ドキュメントと JSON ファイルの両方が生成されます。

Maven を使用して、更新されたコードを AEM インスタンスにデプロイする。

インタラクティブ通信を生成するには、バッチ API を呼び出します。 バッチ API では、レコード数に応じて、PDFと.json ファイルのストリームを出力して返します。JSON ファイルを使用すると、Web テンプレートの事前入力ができます。上記のコードを使用する場合、API は http://localhost:4502/bin/batchServlet にデプロイされます。このコードは、PDF ファイルと JSON ファイルのストリームを出力して返します。