Generieren mehrerer interaktiver Kommunikationen mithilfe der Batch-API use-batch-api-to-generate-multiple-ic

Erstellen Sie einen überwachten Ordner und konfigurieren Sie ihn für die Verwendung der Batch-API:

1. Melden Sie sich bei der AEM Forms-Autoreninstanz an.
2. Navigieren Sie zu Tools > Formulare > Überwachten Ordner konfigurieren. Wählen Sie Neu aus.
3. Geben Sie die den Namen und den physischen Pfad des Ordners an. Beispiel: c:\batchprocessing.
4. Wählen Sie die Option Service im Feld Datei verarbeiten mit.
5. Wählen Sie den Service com.adobe.fd.ccm.multichannel.batch.impl.service.InteractiveCommunicationBatchServiceImpl im Feld Service-Name.
6. Geben Sie ein Ausgabedateimuster an. Beispiel: Das %F/ Muster gibt an, dass der überwachte Ordner Eingabedateien in einem Unterordner des Ordners „Watched Folder\input“ finden kann.

So konfigurieren Sie die erweiterten Parameter:

1. Öffnen Sie die Registerkarte Erweitert und fügen Sie die folgenden benutzerdefinierten Eigenschaften hinzu:

   table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3
   Eigenschaft	Typ	Beschreibung
   templatePath	Zeichenfolge	Geben Sie den Pfad der zu verwendenden interaktiven Kommunikationsvorlage an. Beispiel: /content/dam/formsanddocuments/testsample/mediumic. Dies ist eine obligatorische Eigenschaft.
   recordPath	Zeichenfolge	Der Wert des Felds recordPath hilft beim Festlegen des Namens einer interaktiven Kommunikation. Sie können den Pfad eines Datensatzfelds als Wert des Felds recordPath festlegen. Wenn Sie beispielsweise /employee/Id angeben, wird der Wert des ID-Felds zum Namen für die entsprechende interaktive Kommunikation. Der Standardwert ist eine zufällige UUID.
   usePrefillService	Boolesch	Legen Sie den Wert auf „False“ fest. Sie können den Parameter usePrefillService verwenden, um die interaktive Kommunikation mit Daten vorzufüllen, die aus dem Vorbefüllungs-Service abgerufen wurden, der für die entsprechende interaktive Kommunikation konfiguriert ist. Wenn usePrefillService auf „true“ gesetzt ist, werden JSON-Eingabedaten (für jeden Datensatz) als FDM-Argumente behandelt. Der Standardwert lautet false.
   batchType	Zeichenfolge	Setzen Sie den Wert auf PRINT, WEB oder WEB_AND_PRINT. Der Standardwert ist WEB_AND_PRINT.
   locale	Zeichenfolge	Geben Sie das Gebietsschema für die Ausgabe der interaktiven Kommunikation an. Der vordefinierte Service verwendet nicht die Gebietsschema-Option, Sie können jedoch einen benutzerdefinierten Service erstellen, um lokalisierte interaktive Kommunikationen zu generieren. Der Standardwert ist en_US

2. Wählen Sie Erstellen aus.

Verwenden Sie den erstellten überwachten Ordner, um interaktive Kommunikation zu generieren:

1. Öffnen Sie den überwachten Ordner. Navigieren Sie zum Eingabeordner.

2. Erstellen Sie einen Ordner im Eingabeordner und legen Sie die JSON-Datei im neu erstellten Ordner ab.

3. Warten Sie, bis der überwachte Ordner die Datei verarbeitet hat. Wenn die Verarbeitung beginnt, werden die Eingabedatei und der Unterordner, die die Datei enthält, in den Staging-Ordner verschoben.

4. Öffnen Sie den Ausgabeordner, um die Ausgabe anzuzeigen:

   • Wenn Sie in der Konfiguration des überwachten Ordners die PRINT-Option angeben, wird eine PDF-Ausgabe für die interaktive Kommunikation generiert.
   • Wenn Sie in der Konfiguration des überwachten Ordners die WEB-Option angeben, wird eine JSON-Datei pro Datensatz generiert. Sie können die JSON-Datei zum Vorausfüllen einer Web-Vorlage verwenden.
   • Wenn Sie sowohl die PRINT- als auch die WEB-Option angeben, werden sowohl PDF-Dokumente als auch eine JSON-Datei pro Datensatz generiert.

So konfigurieren Sie das Formulardatenmodell der Vorlage:

1. Öffnen Sie das Formulardatenmodell, das mit der Vorlage für interaktive Kommunikation verknüpft ist.

2. Wählen Sie Ihr MODELLOBJEKT DER OBERSTEN EBENE aus und wählen Sie „Eigenschaften bearbeiten“ aus.

3. Wählen Sie Ihren Service zum Abrufen aus dem Feld „Lese-Service“ im Bereich „Eigenschaften bearbeiten“ aus.

4. Wählen Sie das Stiftsymbol für das Argument des Lese-Service aus, um das Argument an ein Anfrageattribut zu binden, und geben Sie den Bindungswert an. Er bindet das Dienstargument an das angegebene Bindungsattribut oder den angegebenen Literalwert, der an den Dienst als Argument übergeben wird, um mit dem angegebenen Wert verknüpfte Details aus der Datenquelle abzurufen.

   In diesem Beispiel nimmt das ID-Argument den Wert des ID-Attributs des Benutzerprofils an und übergibt ihn als Argument an den Lesedienst. Dieser liest Werte aus zugeordneten Eigenschaften aus dem Datenmodellobjekt „employee“ für die angegebene ID und gibt sie zurück. Wenn Sie beispielsweise im ID-Feld im Formular den Wert „00250“ festlegen, liest der Lesedienst die Informationen zu der Person mit der Mitarbeiter-ID „00250“.

   

5. Speichern Sie die Eigenschaften und das Formulardatenmodell.

So konfigurieren Sie den Wert für das Anfrageattribut:

1. Erstellen Sie eine JSON-Datei in Ihrem Dateisystem und öffnen Sie sie zur Bearbeitung.

2. Erstellen Sie ein JSON-Array und geben Sie das primäre Attribut an, um Daten aus dem Formulardatenmodell abzurufen. Beispielsweise fordert die folgende JSON-Datei FDM auf, Daten von Datensätzen mit einer ID von 27126 oder 27127 zu senden:

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

3. Speichern und schließen Sie die Datei.

Erstellen Sie einen überwachten Ordner und konfigurieren Sie ihn für die Verwendung des Batch-API-Services:

1. Melden Sie sich bei der AEM Forms-Autoreninstanz an.
2. Navigieren Sie zu Tools > Formulare > Überwachten Ordner konfigurieren. Wählen Sie Neu aus.
3. Geben Sie die den Namen und den physischen Pfad des Ordners an. Beispiel: c:\batchprocessing.
4. Wählen Sie die Option Service im Feld Datei verarbeiten mit.
5. Wählen Sie den Service com.adobe.fd.ccm.multichannel.batch.impl.service.InteractiveCommunicationBatchServiceImpl im Feld Service-Name.
6. Geben Sie ein Ausgabedateimuster an. Beispiel: Das %F/ Muster gibt an, dass der überwachte Ordner Eingabedateien in einem Unterordner des Ordners „Watched Folder\input“ finden kann.

So konfigurieren Sie die erweiterten Parameter:

1. Öffnen Sie die Registerkarte Erweitert und fügen Sie die folgenden benutzerdefinierten Eigenschaften hinzu:

   table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3
   Eigenschaft	Typ	Beschreibung
   templatePath	Zeichenfolge	Geben Sie den Pfad der zu verwendenden interaktiven Kommunikationsvorlage an. Beispiel: /content/dam/formsanddocuments/testsample/mediumic. Dies ist eine obligatorische Eigenschaft.
   recordPath	Zeichenfolge	Der Wert des Felds recordPath hilft beim Festlegen des Namens einer interaktiven Kommunikation. Sie können den Pfad eines Datensatzfelds als Wert des Felds recordPath festlegen. Wenn Sie beispielsweise /employee/Id angeben, wird der Wert des ID-Felds zum Namen für die entsprechende interaktive Kommunikation. Der Standardwert ist eine zufällige UUID.
   usePrefillService	Boolesch	Legen Sie den Wert auf „True“ fest. Der Standardwert lautet „false“. Wenn der Wert auf „true“ gesetzt ist, liest die Batch-API Daten aus dem konfigurierten Formulardatenmodell und füllt sie in die interaktive Kommunikation. Wenn usePrefillService auf „true“ gesetzt ist, werden JSON-Eingabedaten (für jeden Datensatz) als FDM-Argumente behandelt.
   batchType	Zeichenfolge	Setzen Sie den Wert auf PRINT, WEB oder WEB_AND_PRINT. Der Standardwert ist WEB_AND_PRINT.
   locale	Zeichenfolge	Geben Sie das Gebietsschema für die Ausgabe der interaktiven Kommunikation an. Der vordefinierte Service verwendet nicht die Gebietsschema-Option, Sie können jedoch einen benutzerdefinierten Service erstellen, um lokalisierte interaktive Kommunikationen zu generieren. Der Standardwert ist en_US.

2. Wählen Sie Erstellen aus.

Verwenden Sie den erstellten überwachten Ordner, um interaktive Kommunikation zu generieren:

1. Öffnen Sie den überwachten Ordner. Navigieren Sie zum Eingabeordner.

2. Erstellen Sie einen Ordner im Eingabeordner. Platzieren Sie die in Schritt 2 erstellte JSON-Datei im neu erstellten Ordner.

3. Warten Sie, bis der überwachte Ordner die Datei verarbeitet hat. Wenn die Verarbeitung beginnt, werden die Eingabedatei und der Unterordner, die die Datei enthält, in den Staging-Ordner verschoben.

4. Öffnen Sie den Ausgabeordner, um die Ausgabe anzuzeigen:

   • Wenn Sie in der Konfiguration des überwachten Ordners die PRINT-Option angeben, wird eine PDF-Ausgabe für die interaktive Kommunikation generiert.
   • Wenn Sie in der Konfiguration des überwachten Ordners die WEB-Option angeben, wird eine JSON-Datei pro Datensatz generiert. Sie können die JSON-Datei zum Vorausfüllen einer Web-Vorlage verwenden.
   • Wenn Sie sowohl die PRINT- als auch die WEB-Option angeben, werden sowohl PDF-Dokumente als auch eine JSON-Datei pro Datensatz generiert.

Melden Sie sich bei Ihrer AEM-Instanz an und erstellen Sie eine interaktive Kommunikation. Um die interaktive Kommunikation zu verwenden, die im folgenden Beispielcode erwähnt wird, hier klicken.

Erstellen Sie ein AEM-Projekt und stellen Sie es mit Apache Maven auf Ihrer AEM-Instanz bereit.

Fügen Sie AEM Forms Client SDK Version 6.0.12 oder später in der Abhängigkeitsliste der POM-Datei Ihres AEM-Projekts hinzu. Beispiel:

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

Öffnen Sie das Java™-Projekt und erstellen Sie eine .java-Datei, z. B. „CCMBatchServlet.java“. Fügen Sie der Datei den folgenden Code hinzu:

        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";
            }


        }

Ersetzen Sie im obigen Code den Vorlagenpfad (setTemplatePath) durch den Pfad Ihrer Vorlage und legen Sie den Wert der setBatchType-API fest:

• Wenn Sie die PRINT-Option PDF angeben, wird eine Ausgabe für die interaktive Kommunikation generiert.
• Wenn Sie die WEB-Option angeben, wird eine JSON-Datei pro Eintrag generiert. Sie können die JSON-Datei zum Vorausfüllen einer Web-Vorlage verwenden.
• Wenn Sie sowohl die PRINT- als auch die WEB-Option angeben, werden sowohl PDF-Dokumente als auch eine JSON-Datei pro Datensatz generiert.

Verwenden Sie Maven, um den aktualisierten Code für Ihre AEM-Instanz bereitzustellen.

Rufen Sie zum Generieren der interaktiven Kommunikationen die Batch-API auf.  Die Batch-API druckt und gibt einen Stream von PDF- und JSON-Dateien abhängig von der Anzahl der Datensätze zurück. Sie können die JSON-Datei zum Vorausfüllen einer Web-Vorlage verwenden. Wenn Sie den oben genannten Code verwenden, wird die API unter http://localhost:4502/bin/batchServlet bereitgestellt. Der Code druckt und gibt einen Stream von PDF- und JSON-Dateien zurück.