Generare più comunicazioni interattive utilizzando API Batch use-batch-api-to-generate-multiple-ic

Crea una cartella controllata e configurala per utilizzare l'API Batch:

1. Accedi all’istanza Autore AEM Forms.
2. Passa a Strumenti > Forms > Configura cartella controllata. Seleziona Nuovo.
3. Specifica il Nome e il Percorso fisici della cartella. Esempio: c:\batchprocessing.
4. Selezionare l'opzione Servizio nel campo Elabora file tramite.
5. Selezionare il servizio com.adobe.fd.ccm.multichannel.batch.impl.service.InteractiveCommunicationBatchServiceImpl nel campo Nome servizio.
6. Specificare un pattern file di output. Ad esempio, il %F/ pattern specifica che la cartella controllata può trovare i file di input in una sottocartella della cartella controllata\input.

Configura parametri avanzati:

1. Apri la scheda Avanzate e aggiungi le seguenti proprietà personalizzate:

   table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3
   Proprietà	Tipo	Descrizione
   templatePath	Stringa	Specifica il percorso del modello di comunicazione interattiva da utilizzare. Ad esempio, /content/dam/formsanddocuments/testsample/mediumic. È una proprietà obbligatoria.
   recordPath	Stringa	Il valore del campo recordPath consente di impostare il nome di una comunicazione interattiva. È possibile impostare il percorso di un campo di un record come valore del campo recordPath. Ad esempio, se specifichi /employee/Id, il valore del campo id diventa il nome della comunicazione interattiva corrispondente. Il valore predefinito è un UUID casuale.
   usePrefillService	Booleano	Imposta il valore su False. Puoi utilizzare il parametro usePrefillService per precompilare la comunicazione interattiva con i dati recuperati dal servizio precompilato configurato per la comunicazione interattiva corrispondente. Quando usePrefillService è impostato su true, i dati JSON di input (per ogni record) vengono trattati come argomenti FDM. Il valore predefinito è false.
   batchType	Stringa	Impostate il valore su PRINT, WEB o WEB_AND_PRINT. Il valore predefinito è WEB_AND_PRINT.
   lingua	Stringa	Specifica le impostazioni locali della comunicazione interattiva di output. Il servizio preconfigurato non utilizza l’opzione internazionale, ma puoi creare un servizio personalizzato per generare comunicazioni interattive localizzate. Il valore predefinito è en_US

2. Seleziona Crea.

Utilizza la cartella controllata creata per generare la comunicazione interattiva:

1. Apri la cartella controllata. Passare alla cartella di input.

2. Crea una cartella nella cartella di input e inserisci il file JSON nella cartella appena creata.

3. Attendi che la cartella controllata elabori il file. All'avvio dell'elaborazione, il file di input e la sottocartella che contiene il file vengono spostati nella cartella di gestione temporanea.

4. Apri la cartella di output per visualizzare l’output:

   • Quando specifichi l’opzione STAMPA in Configurazione cartella controllata, viene generato l’output PDF per la comunicazione interattiva.
   • Quando specifichi l’opzione WEB in Configurazione cartella controllata, viene generato un file JSON per record. È possibile utilizzare il file JSON per precompilare un modello Web.
   • Quando si specificano le opzioni PRINT e WEB, vengono generati sia i documenti PDF che un file JSON per record.

Configura il modello dati modulo del modello:

1. Apri il modello dati modulo associato al modello di comunicazione interattiva.

2. Selezionate l'OGGETTO MODELLO DI LIVELLO SUPERIORE (TOP LEVEL MODEL OBJECT), quindi Modifica proprietà (Edit Properties).

3. Seleziona Recupera o ottieni servizio dal campo Servizio di lettura nel riquadro Modifica proprietà.

4. Seleziona l’icona a forma di matita per l’argomento del servizio di lettura per associare l’argomento a un attributo di richiesta e specifica il valore di associazione. L'argomento del servizio viene associato all'attributo di associazione o al valore letterale specificato, che viene passato al servizio come argomento per recuperare i dettagli associati al valore specificato dall'origine dati.

   In questo esempio, l'argomento id prende il valore dell'attributo id del profilo utente e lo trasmette come argomento al servizio di lettura. Legge e restituisce i valori delle proprietà associate dall'oggetto modello dati dipendente per l'ID specificato. Pertanto, se si specifica 00250 nel campo ID del modulo, il servizio di lettura legge i dettagli del dipendente con 00250 ID dipendente.

   

5. Salva proprietà e modello dati modulo.

Configura valore per attributo richiesta:

1. Crea un file .json sul file system e aprilo per la modifica.

2. Crea un array JSON e specifica l’attributo primario per recuperare i dati dal modello dati del modulo. Ad esempio, il seguente JSON richiede a FDM di inviare dati di record in cui l’ID è 27126 o 27127:

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

3. Salva e chiudi il file.

Crea una cartella controllata e configurala per utilizzare il servizio API Batch:

1. Accedi all’istanza Autore AEM Forms.
2. Passa a Strumenti > Forms > Configura cartella controllata. Seleziona Nuovo.
3. Specifica il Nome e il Percorso fisici della cartella. Esempio: c:\batchprocessing.
4. Selezionare l'opzione Servizio nel campo Elabora file tramite.
5. Selezionare il servizio com.adobe.fd.ccm.multichannel.batch.impl.service.InteractiveCommunicationBatchServiceImpl nel campo Nome servizio.
6. Specificare un pattern file di output. Ad esempio, il %F/ pattern specifica che la cartella controllata può trovare i file di input in una sottocartella della cartella controllata\input.

Configura parametri avanzati:

1. Apri la scheda Avanzate e aggiungi le seguenti proprietà personalizzate:

   table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3
   Proprietà	Tipo	Descrizione
   templatePath	Stringa	Specifica il percorso del modello di comunicazione interattiva da utilizzare. Ad esempio, /content/dam/formsanddocuments/testsample/media. È una proprietà obbligatoria.
   recordPath	Stringa	Il valore del campo recordPath consente di impostare il nome di una comunicazione interattiva. È possibile impostare il percorso di un campo di un record come valore del campo recordPath. Ad esempio, se specifichi /employee/Id, il valore del campo id diventa il nome della comunicazione interattiva corrispondente. Il valore predefinito è un UUID casuale.
   usePrefillService	Booleano	Imposta il valore su True. Il valore predefinito è false. Quando il valore è impostato su true, l’API Batch legge i dati dal modello dati del modulo configurato e li inserisce nella comunicazione interattiva. Quando usePrefillService è impostato su true, i dati JSON di input (per ogni record) vengono trattati come argomenti FDM.
   batchType	Stringa	Impostate il valore su PRINT, WEB o WEB_AND_PRINT. Il valore predefinito è WEB_AND_PRINT.
   lingua	Stringa	Specifica le impostazioni locali della comunicazione interattiva di output. Il servizio preconfigurato non utilizza l’opzione internazionale, ma puoi creare un servizio personalizzato per generare comunicazioni interattive localizzate. Il valore di default è en_US.

2. Seleziona Crea.

Utilizza la cartella controllata creata per generare la comunicazione interattiva:

1. Apri la cartella controllata. Passare alla cartella di input.

2. Crea una cartella nella cartella di input. Posiziona il file JSON creato al passaggio 2 nella cartella appena creata.

3. Attendi che la cartella controllata elabori il file. All'avvio dell'elaborazione, il file di input e la sottocartella che contiene il file vengono spostati nella cartella di gestione temporanea.

4. Apri la cartella di output per visualizzare l’output:

   • Quando specifichi l’opzione STAMPA in Configurazione cartella controllata, viene generato l’output PDF per la comunicazione interattiva.
   • Quando specifichi l’opzione WEB in Configurazione cartella controllata, viene generato un file JSON per record. È possibile utilizzare il file JSON per precompilare un modello Web.
   • Quando si specificano le opzioni PRINT e WEB, vengono generati sia i documenti PDF che un file JSON per record.

Accedi all’istanza dell’AEM e crea una comunicazione interattiva. Per utilizzare la comunicazione interattiva indicata nel codice di esempio fornito di seguito, fai clic qui.

Crea e distribuisci un progetto AEM utilizzando Apache Maven nella tua istanza AEM.

Aggiungi AEM Forms Client SDK versione 6.0.12 o successiva nell'elenco delle dipendenze del file POM del progetto AEM. Ad esempio:

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

Apri il progetto Java™, crea un file .java, ad esempio CCMBatchServlet.java. Aggiungi al file il codice seguente:

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


        }

Nel codice precedente, sostituisci il percorso del modello (setTemplatePath) con il percorso del modello e imposta il valore dell’API setBatchType:

• Quando si specifica l'opzione PRINT PDF, viene generato l'output per la comunicazione interattiva.
• Quando si specifica l'opzione WEB, viene generato un file JSON per record. È possibile utilizzare il file JSON per precompilare un modello Web.
• Quando si specificano le opzioni PRINT e WEB, vengono generati sia i documenti PDF che un file JSON per record.

Utilizza maven per distribuire il codice aggiornato alla tua istanza AEM.

Per generare la comunicazione interattiva, richiama l’API batch. L’API batch stampa restituisce un flusso di file PDF e .json a seconda del numero di record. È possibile utilizzare il file JSON per precompilare un modello Web. Se si utilizza il codice riportato sopra, l'API viene distribuita in http://localhost:4502/bin/batchServlet. Il codice stampa e restituisce un flusso di un file PDF e un file JSON.