La solution Correspondence Management vous permet d’ajouter des actions personnalisées à l’interface utilisateur de gestion des actifs.
Vous pouvez ajouter une action personnalisée à la vue Liste des ressources pour :
- Un ou plusieurs types de ressources ou de lettres
- Exécution (l’action/la commande devient active) dans la sélection des ressources/des lettres simples et multiples ou en l’absence de sélection
Pour suivre le scénario ci-après ou un scénario similaire, vous devez disposer des connaissances suivantes :
- CRX
- JavaScript
- Java
Scénario : Ajoutez une commande à l’interface utilisateur des listes Lettres pour envoyer la version PDF aplatie d’une lettre
Les étapes ci-dessous ajoutent une commande « Télécharger un PDF aplati » à la vue Liste des ressources de lettres et permettent à vos utilisateurs de télécharger le PDF aplati de la lettre sélectionnée. Le suivi de ces étapes à l’aide du code et des paramètres appropriés permet d’ajouter une autre fonctionnalité pour une ressource différente, telle que des dictionnaires de données ou des textes.
Pour personnaliser Correspondence Management et permettre aux utilisateurs de télécharger un fichier PDF aplati ou des lettres, suivez les étapes ci-après :
-
Dans le dossier d’applications, créez un dossier appelé Éléments avec un chemin/une structure semblables au dossier d’éléments situé dans le dossier de sélection. Pour cela, suivez les étapes ci-après :
-
Faites un clic droit sur le dossier des éléments à l’emplacement suivant puis sélectionnez Nœud de recouvrement :
/libs/fd/cm/ma/gui/content/cmassets/jcr:content/body/content/header/items/selection/items
Remarque :
Ce chemin est spécifique à la création d’une action qui fonctionne avec la sélection d’une ou plusieurs ressources/lettres. Si vous souhaitez créer une action qui se déroule sans sélection, vous devez créer un nœud de recouvrement pour le chemin suivant et suivre les étapes restantes :
/libs/fd/cm/ma/gui/content/cmassets/jcr:content/body/content/header/items/default/items
-
-
Dans le dossier d’éléments que vous avez créé, ajoutez un nœud pour le bouton/l’action personnalisé(e) d’une ressources particulière (exemple : downloadFlatPDF) en suivant les étapes ci-après :
-
Nom Type Valeur et description catégorie Chaîne foundation-collection-action foundation-collection-action Chaîne {"target": ".cq-manageasset-admin-childpages", "activeSelectionCount": "single","type": "LETTER"}
activeSelectionCount peut être unique ou multiple pour autoriser les sélections de ressources uniques ou multiples sur lesquelles effectuer une action personnalisée.type peut être unique ou multiple (entrées multiples séparées par des virgules) : LETTER,TEXT,LIST,CONDITION,DATADICTIONARY
icône Chaîne icône-téléchargement
Icône affichée par Correspondence Management sur le côté gauche de la commande/du menu. Pour connaître les icônes et paramètres disponibles, voir la documentation relative aux icônes CoralUI.
jcr:primaryType Nom nt:unstructured rel Chaîne download-flat-pdf-button sling:resourceType Chaîne granite/ui/components/endor/actionbar/button texte Chaîne Télécharger le PDF aplati (ou tout autre libellé)
Commande affichée dans l’interface de liste des ressourcestitre Chaîne Téléchargez un document PDF aplati de la lettre sélectionnée (ou de tout autre libellé/texte de remplacement)
Le titre correspond au texte affiché par Correspondence Management lorsque l’utilisateur passe sa souris sur la commande personnalisée.
-
Dans le dossier js, procédez comme suit pour créer un fichier nommé formaction.js avec le code de traitement d’action du bouton :
-
Dans le fichier formaction.js (sous la branche /apps), copiez le code à partir du fichier formaction.js à l’emplacement suivant :
/libs/fd/cm/ma/gui/components/admin/clientlibs/admin/js/formaction.js
Apposez alors le code suivant à l’extrémité dans le fichier de formaction.js (sous la branche /apps) et cliquez sur Enregistrer tout :
/* Action url for xml file to be added.*/ var ACTION_URL = "/apps/fd/cm/ma/gui/content/commons/actionhandlers/items/letterpdfdownloader.html"; /* File upload handling*/ var fileSelectedHandler = function(e){ if(e && e.target && e.target.value) $(".downloadLetterPDFBtn").removeAttr('disabled'); else $(".downloadLetterPDFBtn").attr('disabled','disabled'); } /*Handing of Download button in pop up.*/ var downloadClickHandler = function(){ $('#downloadLetterPDFDilaog').modal("hide"); var element = $('.foundation-selections-item'); var path = $(element).data("path"); $("#fileUploadForm").attr('action', ACTION_URL + "?letterId="+path).submit(); } /*Click handling on action button.*/ $(document).on("click",'.download-flat-pdf-button',function(e){ $("#uploadSamepledata").val(""); if($('#downloadLetterPDFDilaog').length == 0){ $(document).on("click",".downloadLetterPDFBtn",downloadClickHandler); $(document).on("change","#uploadSamepledata",fileSelectedHandler); $("body").append(downloadLetterPDFDilaog); } $('#downloadLetterPDFDilaog').modal("show"); }); /*Download popup.*/ var downloadLetterPDFDilaog = '<div id="downloadLetterPDFDilaog" class="coral-Modal notice " role="dialog" aria-hidden="true">'+ '<form id="fileUploadForm" method="POST" enctype="multipart/form-data">'+ '<div class="coral-Modal-header">'+ '<h2 class="coral-Modal-title coral-Heading coral-Heading--2" id="modal-header1443020790107-label" tabindex="0">Download Letter as PDF.</h2>'+ '<button type="button" class="coral-MinimalButton coral-Modal-closeButton" data-dismiss="modal">×</button>'+ '</div>'+ '<div class="coral-Modal-body" id="modal-header1443020790107-message" role="document" tabindex="0">'+ '<div class="coral-Modal-message">'+ '<p></p>'+ '</div>'+ '<div class="coral-Modal-uploader">'+ '<p>Select sample data for letter.</p>'+ '<input type="file" id="uploadSamepledata" name="file" accept=".xml" size="70px">'+ '</div>'+ '</div>'+ '</form>'+ '<div class="coral-Modal-footer">'+ '<button type="button" class="coral-Button" data-dismiss="modal">Cancel</button>'+ '<button type="button" class="coral-Button coral-Button--primary downloadLetterPDFBtn" disabled="disabled">Download</button>'+ '</div>'+ '</div>';Le code que vous ajoutez dans cette étape remplace le code dans le dossier libs. Vous devez donc copier le code précédent vers le fichier formaction.js dans la branche /apps. La copie du code de la branche /libs vers la branche /apps garantit que la fonctionnalité précédente marche également.
Le code ci-dessus correspond au traitement des actions spécifiques aux lettres de la commande créée dans cette procédure. Pour le traitement des actions d’autres ressources, modifiez le code javascript.
-
Dans le nœud d’éléments que vous avez créé, ajoutez un nœud pour le bouton/l’action personnalisé(e) d’une ressources particulière (exemple : letterpdfdownloader) en suivant les étapes ci-après :
-
Assurez-vous que la boîte de dialogue de création du nœud possède les valeurs suivantes et cliquez sur OK :
Nom : letterpdfdownloader (ou le nom que vous souhaitez donner à cette propriété) - doit être unique. Si vous utilisez ici un nouveau nom, spécifiez le même dans la variable ACTION_URL du fichier formaction.js.
Type : nt:unstructured
-
-
Créez un fichier appelé POST.jsp avec le code de traitement d’action de la commande à l’emplacement suivant :
/apps/fd/cm/ma/gui/components/admin/clientlibs/admin
-
Ajoutez le code suivant au fichier POST.jsp et cliquez sur Enregistrer tout :
Ce code est spécifique au service de rendu de la lettre. Pour toute autre ressource, ajoutez les bibliothèques Java de la ressource à ce code. Pour plus d’informations sur les API AEM Forms, voir API AEM Forms.
Pour plus d’informations sur les bibliothèques d’AEM, voir Composants AEM.
/*Import libraries. Here we are downloading letter flat pdf with input xml data so we require letterRender Api. For any other Module functionality we need to first import that library. */ <%@include file="/libs/foundation/global.jsp"%> <!DOCTYPE html lang="en" PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <%@page import="com.adobe.icc.ddg.api.*"%> <%@page import="com.adobe.icc.dbforms.obj.*"%> <%@page import="com.adobe.icc.render.obj.*" %> <%@page import="com.adobe.icc.services.api.*" %> <%@page import="org.apache.sling.api.resource.*" %> <%@page import="java.io.File" %> <%@page import="java.util.*" %> <%@page import="com.adobe.livecycle.content.appcontext.AppContextManager"%> <%@page import=" com.adobe.icc.dbforms.exceptions.ICCException"%> <%@page import="java.io.InputStream" %> <%@page import="java.io.FileInputStream" %> <%@page import="org.apache.commons.io.IOUtils" %> <%@page session="false" contentType="text/html; charset=utf-8"%> <%@taglib prefix="sling" uri="http://sling.apache.org/taglibs/sling/1.0"%> <%@taglib prefix="cq" uri="http://www.day.com/taglibs/cq/1.0" %> <%@page session="false" contentType="text/html; charset=utf-8"%> <% AppContextManager.setCurrentAppContext("/content/apps/cm"); /*Get letter id sent in js file.*/ String letterId = request.getParameter("letterId"); if(letterId.lastIndexOf("?") != -1) letterId = letterId.substring(0, letterId.indexOf("?")); String fileName = null; String letterName = null; InputStream inputStream = null; /*Get xml file data*/ if (slingRequest.getRequestParameter("file") != null) inputStream = slingRequest.getRequestParameter("file").getInputStream(); if(letterId != null){ String xmlData = null; try{ xmlData = IOUtils.toString(inputStream, "UTF-8"); } catch (Exception e) { log.error("Xml data does not exists."); } /*letter Name from letter letter id.*/ letterName = letterId.substring(letterId.lastIndexOf("/")+1); /*Invoking letter render services API.*/ LetterRenderService letterRenderService = sling.getService(LetterRenderService.class); /*using CM renderLetter api to get pdfbytes.*/ PDFResponseType pdfResponseType= letterRenderService.renderLetter(letterId,xmlData,true,false,false,false); byte[] bytes = null; /*Downloading pdf bytes as pdf.*/ if(pdfResponseType != null && pdfResponseType.getFile() != null){ bytes = pdfResponseType.getFile().getDocument(); /*set the response header to enable download*/ response.setContentType("application/OCTET-STREAM"); response.setHeader("Content-Disposition", "attachment;filename=\"" + letterName + ".pdf\""); response.setHeader("Pragma", "cache"); response.setHeader("Cache-Control", "private"); out.clear(); response.getOutputStream().write(bytes); } } else{ log.error("Letter id does not exists."); } %>
Après avoir ajouté la fonctionnalité personnalisée pour télécharger un fichier PDF aplati de vos lettres, vous pouvez suivre les étapes ci-après pour télécharger la version PDF aplatie de la lettre :
-
Sélectionnez plus > <Télécharger un PDF aplati> (soit la fonctionnalité personnalisées créée à l’aide des instructions cet article). La boîte de dialogue Télécharger la lettre en tant que PDF s’affiche.
Le nom de l’élément de menu, la fonctionnalité et l’autre texte dépendent de la personnalisation créée dans le Scénario : Ajoutez une commande à l’interface utilisateur des listes Lettres pour envoyer la version PDF aplatie d’une lettre.
-
Dans la boîte de dialogue Télécharger la lettre en tant que PDF, sélectionnez le XML approprié à partir duquel vous souhaitez renseigner les données du PDF.
Remarque :
Avant de télécharger la lettre en tant que PDF aplati, vous pouvez créer le fichier XML avec les données dans la lettre à l’aide de l’option Créer un rapport
Les publications Twitter™ et Facebook ne sont pas couvertes par les dispositions Creative Commons.