Générer plusieurs communications interactives à l’aide de l’API Batch use-batch-api-to-generate-multiple-ic

Créez un Dossier de contrôle et configurez-le pour quʼil utilise l’API Batch :

1. Connectez-vous à votre instance d’auteur AEM Forms.
2. Accédez à Outils > Formulaires > Configurer le dossier de contrôle. Sélectionnez Nouveau.
3. Spécifiez le Nom et le Chemin dʼaccès physique du dossier. Par exemple, c:\batchprocessing.
4. Sélectionnez lʼoption Service dans le champ Traiter le fichier avec.
5. Sélectionnez le service com.adobe.fd.ccm.multichannel.batch.impl.service.InteractiveCommunicationBatchServiceImpl dans le champ Nom du service.
6. Spécifiez un Modèle de fichier de sortie. Par exemple, le modèle %F/ indique que le dossier de contrôle peut trouver des fichiers d’entrée dans un sous-dossier du dossier de contrôle\entrée.

Configurer les paramètres avancés

1. Ouvrez l’onglet Avancé et ajoutez les propriétés personnalisées suivantes :

   table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3
   Propriété	Type	Description
   templatePath	Chaîne	Spécifiez le chemin dʼaccès du modèle de communication interactive à utiliser. Par exemple, /content/dam/formsanddocuments/testsample/mediumic. Il s’agit d’une propriété obligatoire.
   recordPath	Chaîne	La valeur du champ recordPath permet de définir le nom d’une communication interactive. Vous pouvez définir le chemin dʼaccès du champ d’un enregistrement comme valeur du champ recordPath. Par exemple, si vous spécifiez /employee/Id, la valeur du champ ID devient le nom de la communication interactive correspondante. La valeur par défaut est une valeur UUID aléatoire.
   usePrefillService	Booléen	Donnez la valeur False à cette propriété. Vous pouvez utiliser le paramètre usePrefillService pour préremplir la communication interactive avec des données récupérées à partir du service de préremplissage configuré pour la communication interactive correspondante. Lorsque usePrefillService est défini sur true, les données JSON en entrée (pour chaque enregistrement) sont traitées comme des arguments FDM. La valeur par défaut est false.
   batchType	Chaîne	Définissez la valeur sur PRINT, WEB ou WEB_AND_PRINT. La valeur par défaut est WEB_AND_PRINT.
   paramètres régionaux	Chaîne	Spécifiez les paramètres régionaux de la communication interactive de sortie. Le service prêt à l’emploi n’utilise pas l’option des paramètres régionaux, mais vous pouvez créer un service personnalisé pour générer des communications interactives localisées. La valeur par défaut est en_US.

2. Sélectionnez Créer.

Utilisez le dossier de contrôle pour générer une communication interactive :

1. Ouvrez le dossier de contrôle. Accédez au dossier d’entrée.

2. Créez un dossier dans le dossier d’entrée et placez le fichier JSON dans le dossier nouvellement créé.

3. Attendez que le dossier de contrôle traite le fichier. Lorsque le traitement commence, le fichier d’entrée et le sous-dossier contenant le fichier sont déplacés vers le dossier intermédiaire.

4. Ouvrez le dossier de sortie pour afficher la sortie :

   • Lorsque vous spécifiez l’option PRINT dans la configuration du dossier de contrôle, une sortie PDF pour la communication interactive est générée.
   • Lorsque vous spécifiez l’option WEB dans la configuration du dossier de contrôle, un fichier JSON par enregistrement est généré. Vous pouvez utiliser ce fichier JSON pour préremplir un modèle web.
   • Lorsque vous spécifiez les options PRINT et WEB, des documents PDF et un fichier JSON par enregistrement sont générés.

Configurer le modèle de données de formulaire du modèle

1. Ouvrez le modèle de données de formulaire associé au modèle de communication interactive.

2. Sélectionnez l’OBJET DE MODÈLE DE NIVEAU SUPÉRIEUR, puis Modifier les propriétés.

3. Sélectionnez votre service de récupération ou dʼobtention dans le champ Service de lecture du volet Modifier les propriétés.

4. Sélectionnez l’icône en forme de crayon de l’argument de service de lecture pour lier l’argument à un attribut de requête et spécifier la valeur de liaison. Elle lie l’argument de service à la valeur d’attribut de liaison ou littérale spécifiée, qui est transmise au service en tant qu’argument pour extraire les détails associés à la valeur spécifiée de la source de données.

   Dans cet exemple, l’argument id prendra la valeur de l’attribut id du profil d’utilisateur ou d’utilisatrice et le transmettra en tant qu’argument au service de lecture. Il lira et renverra les valeurs des propriétés associées à partir de l’objet de modèle de données de la personne employée pour l’attribut id spécifié. Ainsi, si vous spécifiez 00250 dans le champ id du formulaire, le service de lecture lira les détails de la personne employée avec l’ID de personne employée 00250.

   

5. Enregistrez les propriétés et le modèle de données de formulaire.

Configurer la valeur de l’attribut de requête

1. Créez un fichier .json sur votre système de fichiers et ouvrez-le pour le modifier.

2. Créez un tableau JSON et spécifiez l’attribut principal pour récupérer les données du modèle de données de formulaire. Par exemple, le fichier JSON suivant demande à FDM d’envoyer les données des enregistrements dont l’ID est 27126 ou 27127 :

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

3. Enregistrez et fermez le fichier.

Créer et configurer un Dossier de contrôle pour quʼil utilise le service API Batch

1. Connectez-vous à votre instance d’auteur AEM Forms.
2. Accédez à Outils > Formulaires > Configurer le dossier de contrôle. Sélectionnez Nouveau.
3. Spécifiez le Nom et le Chemin dʼaccès physique du dossier. Par exemple, c:\batchprocessing.
4. Sélectionnez lʼoption Service dans le champ Traiter le fichier avec.
5. Sélectionnez le service com.adobe.fd.ccm.multichannel.batch.impl.service.InteractiveCommunicationBatchServiceImpl dans le champ Nom du service.
6. Spécifiez un Modèle de fichier de sortie. Par exemple, le modèle %F/ indique que le dossier de contrôle peut trouver des fichiers d’entrée dans un sous-dossier du dossier de contrôle\entrée.

Configurer les paramètres avancés

1. Ouvrez l’onglet Avancé et ajoutez les propriétés personnalisées suivantes :

   table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3
   Propriété	Type	Description
   templatePath	Chaîne	Spécifiez le chemin dʼaccès du modèle de communication interactive à utiliser. Par exemple, /content/dam/formsanddocuments/testsample/mediumic. Il s’agit d’une propriété obligatoire.
   recordPath	Chaîne	La valeur du champ recordPath permet de définir le nom d’une communication interactive. Vous pouvez définir le chemin dʼaccès du champ d’un enregistrement comme valeur du champ recordPath. Par exemple, si vous spécifiez /employee/Id, la valeur du champ ID devient le nom de la communication interactive correspondante. La valeur par défaut est une valeur UUID aléatoire.
   usePrefillService	Booléen	Définissez la valeur sur « true ». La valeur par défaut est false. Lorsque la valeur est définie sur « true », l’API Batch lit les données du modèle de données de formulaire configuré et les transmet dans la communication interactive. Lorsque la méthode usePrefillService est définie sur « true », les données JSON d’entrée (pour chaque enregistrement) sont traitées comme des arguments FDM.
   batchType	Chaîne	Définissez la valeur sur PRINT, WEB ou WEB_AND_PRINT. La valeur par défaut est WEB_AND_PRINT.
   paramètres régionaux	Chaîne	Spécifiez les paramètres régionaux de la communication interactive de sortie. Le service prêt à l’emploi n’utilise pas l’option des paramètres régionaux, mais vous pouvez créer un service personnalisé pour générer des communications interactives localisées. La valeur par défaut est en_US.

2. Sélectionnez Créer.

Utilisez le dossier de contrôle pour générer une communication interactive :

1. Ouvrez le dossier de contrôle. Accédez au dossier d’entrée.

2. Créez un dossier dans le dossier d’entrée. Mettez le fichier JSON créé à l’étape 2 dans le dossier nouvellement créé.

3. Attendez que le dossier de contrôle traite le fichier. Lorsque le traitement commence, le fichier d’entrée et le sous-dossier contenant le fichier sont déplacés vers le dossier intermédiaire.

4. Ouvrez le dossier de sortie pour afficher la sortie :

   • Lorsque vous spécifiez l’option PRINT dans la configuration du dossier de contrôle, une sortie PDF pour la communication interactive est générée.
   • Lorsque vous spécifiez l’option WEB dans la configuration du dossier de contrôle, un fichier JSON par enregistrement est généré. Vous pouvez utiliser ce fichier JSON pour préremplir un modèle web.
   • Lorsque vous spécifiez les options PRINT et WEB, des documents PDF et un fichier JSON par enregistrement sont générés.

Connectez-vous à votre instance AEM et créez une communication interactive. Pour utiliser la communication interactive mentionnée dans l’exemple de code ci-dessous, cliquez ici.

Créez et déployez un projet AEM en utilisant Apache Maven sur votre instance AEM.

Ajoutez le SDK client AEM Forms version 6.0.12 ou ultérieure dans la liste des dépendances du fichier POM de votre projet AEM. Par exemple,

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

ouvrez le projet Java™, créez un fichier .java, par exemple CCMBatchServlet.java. Ajoutez le code suivant au fichier :

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


        }

Dans le code ci-dessus, remplacez le chemin d’accès du modèle (setTemplatePath) par le chemin d’accès de votre modèle et définissez la valeur de l’API setBatchType :

• Lorsque vous spécifiez l’option PRINT, une sortie PDF est générée pour la communication interactive.
• Lorsque vous spécifiez l’option WEB, un fichier JSON par enregistrement est généré. Vous pouvez utiliser ce fichier JSON pour préremplir un modèle web.
• Lorsque vous spécifiez les options PRINT et WEB, des documents PDF et un fichier JSON par enregistrement sont générés.

Utilisez Maven pour déployer le code mis à jour sur votre instance AEM..

Pour générer la communication interactive, appelez l’API Batch. L’impression de l’API par lot renvoie un flux de fichiers PDF et .json en fonction du nombre d’enregistrements. Vous pouvez utiliser le fichier JSON pour préremplir un modèle web. Si vous utilisez le code ci-dessus, l’API est déployée à l’adresse http://localhost:4502/bin/batchServlet. Le code imprime et renvoie un flux de fichiers PDF et JSON.