使用批处理API生成多个交互式通信 use-batch-api-to-generate-multiple-ic

创建Watched文件夹并将其配置为使用批处理API：

1. 登录到AEM Forms创作实例。
2. 导航到​ 工具 > Forms > 配置Watched文件夹。 选择​ 新建。
3. 指定文件夹的​ 名称 ​和物理​ 路径。 例如：c:\batchprocessing。
4. 使用​ 字段在 ​处理文件中选择​ 服务 ​选项。
5. 在​ 服务名称 ​字段中选择​ com.adobe.fd.ccm.multichannel.batch.impl.service.InteractiveCommunicationBatchServiceImpl ​服务。
6. 指定​ 输出文件模式。 例如，%F/ pattern指定Watched文件夹可以在Watched文件夹\input文件夹的子文件夹中找到输入文件。

配置高级参数：

1. 打开​ 高级 ​选项卡并添加以下自定义属性：

   table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3
   属性	类型	描述
   templatepath	字符串	指定要使用的交互式通信模板的路径。 例如，/content/dam/formsanddocuments/testsample/mediumic。它是必需属性。
   recordpath	字符串	recordPath字段的值有助于设置交互式通信的名称。 您可以将记录字段的路径设置为recordPath字段的值。 例如，如果指定/employee/Id，则id字段的值将成为相应交互式通信的name。 默认值为随机UUID。
   usePrefillService	布尔值	将值设置为False。 可以使用usePrefillService参数预填充交互式通信，该数据是从为相应的交互式通信配置的预填充服务中获取的数据的。 当usePrefillService设置为true时，输入JSON数据（每个记录）将被视为FDM参数。 默认值为false。
   batchtype	字符串	将值设置为PRINT、WEB或WEB_AND_PRINT。 缺省值为WEB_AND_PRINT。
   区域设置	字符串	指定输出交互式通信的区域设置。 现成服务不使用区域设置选项，但您可以创建自定义服务来生成本地化的交互式通信。 默认值为en_US

2. 选择​ 创建。

使用创建的watched文件夹生成交互式通信：

1. 打开Watched文件夹 导航到输入文件夹。

2. 在输入文件夹中创建文件夹，并将JSON文件放在新创建的文件夹中。

3. 等待Watched文件夹处理文件。 处理开始时，输入文件和包含该文件的子文件夹将移至暂存文件夹。

4. 打开输出文件夹，以便查看输出：

   • 在Watched文件夹配置中指定PRINT选项时，将生成交互式通信的PDF输出。
   • 在监视文件夹配置中指定WEB选项时，将为每个记录生成一个JSON文件。 您可以使用JSON文件预填充Web模板。
   • 当您同时指定PRINT和WEB选项时，将生成PDF文档以及每个记录的JSON文件。

配置模板的表单数据模型：

1. 打开与交互式通信模板关联的表单数据模型。

2. 选择顶级模型对象，然后选择编辑属性。

3. 从编辑属性窗格下的读取服务字段中选择获取或获取服务。

4. 选择读取服务参数的铅笔图标以将参数绑定到请求属性，并指定绑定值。 它将服务参数绑定到指定的绑定属性或文本值，该属性或文本值作为参数传递给服务，以从数据源获取与指定值关联的详细信息。

   在此示例中，id参数接受用户配置文件的id属性的值，并将其作为参数传递给读取服务。 它会从指定id的员工数据模型对象中读取并返回关联属性的值。 因此，如果您在表单的id字段中指定00250，则读取服务将读取具有员工id00250员工的详细信息。

   

5. 保存属性和表单数据模型。

配置请求属性的值：

1. 在文件系统上创建一个.json文件并打开它进行编辑。

2. 创建JSON数组并指定主要属性，以便您可以从表单数据模型中提取数据。 例如，以下JSON请求FDM发送id为27126或27127的记录的数据：

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

3. 保存并关闭该文件。

创建Watched文件夹并将其配置为使用批处理API服务：

1. 登录到AEM Forms创作实例。
2. 导航到​ 工具 > Forms > 配置Watched文件夹。 选择​ 新建。
3. 指定文件夹的​ 名称 ​和物理​ 路径。 例如：c:\batchprocessing。
4. 使用​ 字段在 ​处理文件中选择​ 服务 ​选项。
5. 在​ 服务名称 ​字段中选择​ com.adobe.fd.ccm.multichannel.batch.impl.service.InteractiveCommunicationBatchServiceImpl ​服务。
6. 指定​ 输出文件模式。 例如，%F/ pattern指定Watched文件夹可以在Watched文件夹\input文件夹的子文件夹中找到输入文件。

配置高级参数：

1. 打开​ 高级 ​选项卡并添加以下自定义属性：

   table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3
   属性	类型	描述
   templatepath	字符串	指定要使用的交互式通信模板的路径。 例如，/content/dam/formsanddocuments/testsample/mediumic。 它是必需属性。
   recordpath	字符串	recordPath字段的值有助于设置交互式通信的名称。 您可以将记录字段的路径设置为recordPath字段的值。 例如，如果指定/employee/Id，则id字段的值将成为相应交互式通信的name。 默认值为随机UUID。
   usePrefillService	布尔值	将该值设置为True。 默认值为false。 当该值设置为true时，批处理API会从配置的表单数据模型中读取数据，并将其填充到交互式通信中。 当usePrefillService设置为true时，输入JSON数据（每个记录）将被视为FDM参数。
   batchtype	字符串	将值设置为PRINT、WEB或WEB_AND_PRINT。 缺省值为WEB_AND_PRINT。
   区域设置	字符串	指定输出交互式通信的区域设置。 现成服务不使用区域设置选项，但您可以创建自定义服务来生成本地化的交互式通信。 缺省值为en_US。

2. 选择​ 创建。

使用创建的watched文件夹生成交互式通信：

1. 打开Watched文件夹 导航到输入文件夹。

2. 在输入文件夹中创建文件夹。 将在步骤2中创建的JSON文件放入新创建的文件夹中。

3. 等待Watched文件夹处理文件。 处理开始时，输入文件和包含该文件的子文件夹将移至暂存文件夹。

4. 打开输出文件夹，以便查看输出：

   • 在Watched文件夹配置中指定PRINT选项时，将生成交互式通信的PDF输出。
   • 在监视文件夹配置中指定WEB选项时，将为每个记录生成一个JSON文件。 您可以使用JSON文件预填充Web模板。
   • 当您同时指定PRINT和WEB选项时，将生成PDF文档以及每个记录的JSON文件。

登录AEM实例并创建交互式通信。 要使用下面给出的示例代码中提到的交互式通信，单击此处。

在您的AEM实例上使用Apache Maven生成和部署AEM项目。

在AEM项目的POM文件的依赖项列表中添加AEM Forms客户端SDK版本6.0.12或更高版本。 例如，

    <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文件。