Show Menu
ARGOMENTI×

Aggiungere un’azione personalizzata alla visualizzazione Elenco risorse

Panoramica

La soluzione Gestione della corrispondenza consente di aggiungere azioni personalizzate all’interfaccia utente Gestisci risorse.
Potete aggiungere un’azione personalizzata alla visualizzazione Elenco risorse per:
  • Uno o più tipi di risorse o lettere
  • Esecuzione (azione/comando diventa attivo) in caso di selezione di risorse/lettere singole o multiple o senza selezione
Questa personalizzazione viene illustrata con lo scenario in cui viene aggiunto il comando "Scarica PDF semplice" alla visualizzazione Elenco risorse per lettere. Questo scenario di personalizzazione consente agli utenti di scaricare un PDF semplice di una singola lettera selezionata.

Prerequisiti

Per completare il seguente scenario o uno scenario simile, è necessario conoscere:
  • CRX
  • JavaScript
  • Java

Scenario: Aggiungere un comando all'interfaccia utente dell'elenco Lettere per scaricare la versione PDF semplice di una lettera

La procedura seguente aggiunge un comando "Scarica PDF semplice" alla visualizzazione Elenco risorse per lettere e consente agli utenti di scaricare un PDF semplice della lettera selezionata. Utilizzando questi passaggi con il codice e i parametri appropriati, potete aggiungere altre funzionalità a una risorsa diversa, come dizionari di dati o testi.
Per personalizzare la gestione della corrispondenza per consentire agli utenti di scaricare un PDF semplice di lettere, procedere come segue:
  1. Accedete a https://'[server]:[port]'/[ContextPath]/crx/de e accedete come amministratore.
  2. Nella cartella delle app, create una cartella denominata items con percorso/struttura simile alla cartella degli elementi che si trova nella cartella di selezione mediante la procedura seguente:
    1. Fate clic con il pulsante destro del mouse sulla cartella degli elementi nel percorso seguente e selezionate Nodo ​sovrapposizione:
      /libs/fd/cm/ma/gui/content/cmassets/jcr:content/body/content/header/items/selection/items
      Questo percorso è specifico per la creazione di un’azione che funziona con la selezione di una o più risorse/lettere. Se desiderate creare un’azione che funzioni senza selezione, dovete creare un nodo di sovrapposizione per il percorso seguente e completare di conseguenza i passaggi rimanenti:
      /libs/fd/cm/ma/gui/content/cmassets/jcr:content/body/content/header/items/default/items
    2. Verificate che la finestra di dialogo Nodo sovrapposizione contenga i seguenti valori:
      Percorso: /libs/fd/cm/ma/gui/content/cmassets/jcr:content/body/content/header/items/selection/items
      Posizione: /apps/
      Corrispondenza tipi di nodo: Selezionato
    3. Fai clic su OK . La struttura delle cartelle viene creata nella cartella delle app.
      Fate clic su Salva tutto .
  3. Nella cartella degli elementi appena creati, aggiungete un nodo per il pulsante o l’azione personalizzati in una risorsa specifica (esempio: downloadFlatPDF) utilizzando la procedura seguente:
    1. Fate clic con il pulsante destro del mouse sulla cartella degli elementi e selezionate Crea > Crea nodo .
    2. Verificate che la finestra di dialogo Crea nodo contenga i valori seguenti e fate clic su OK :
      Nome: downloadFlatPDF (o il nome che si desidera assegnare a questa proprietà)
      Tipo: nt:non strutturato
    3. Fare clic sul nuovo nodo creato (qui downloadFlatPDF). CRX visualizza le proprietà del nodo.
    4. Aggiungi le seguenti proprietà al nodo (qui downloadFlatPDF) e fai clic su Salva tutto :
      Nome Tipo Valore e descrizione
      classe Stringa foundation-collection-action
      foundation-collection-action Stringa
      {"target": ".cq-management-asset-admin-child-pages", "activeSelectionCount": "single","type": "LETTER"} activeSelectionCount può essere uno o più elementi, per consentire la selezione di una o più risorse sulle quali viene eseguita l'azione personalizzata.
      type può essere una o più voci (virgole separate, voci multiple) tra le seguenti: LETTERA,TESTO,ELENCO,CONDIZIONE,DATADICTIONARIO
      icon Stringa icon-download L'icona che Gestione corrispondenza visualizza a sinistra del comando/menu. Per le diverse icone e impostazioni disponibili, consultate la documentazione Icone CoralUI.
      jcr:primaryType Nome nt:unstructured
      rel Stringa download-flat-pdf-button
      sling:resourceType Stringa granite/ui/components/endor/actionbar/button
      testo Stringa Scarica PDF semplice (o qualsiasi altra etichetta) Il comando che viene visualizzato nell’interfaccia Elenco risorse
      titolo Stringa Scaricare un PDF semplice della lettera selezionata (o qualsiasi altro testo etichetta/Alt) Il titolo è il testo alternativo che Gestione corrispondenza visualizza quando l'utente passa il puntatore del mouse sul comando personalizzato.
  4. Nella cartella delle app, create una cartella denominata js con percorso/struttura simile alla cartella degli elementi che si trova nella cartella di amministrazione tramite la procedura seguente:
    1. Fate clic con il pulsante destro del mouse sulla cartella js nel percorso seguente e selezionate Nodo ​sovrapposizione:
      /libs/fd/cm/ma/gui/components/admin/clientlibs/admin/js
    2. Verificate che la finestra di dialogo Nodo sovrapposizione contenga i seguenti valori:
      Percorso: /libs/fd/cm/ma/gui/components/admin/clientlibs/admin/js
      Posizione: /apps/
      Corrispondenza tipi di nodo: Selezionato
    3. Fai clic su OK . La struttura delle cartelle viene creata nella cartella delle app. Fate clic su Salva tutto .
  5. Nella cartella js, creare un file denominato formaction.js con il codice per la gestione dell'azione del pulsante utilizzando la procedura seguente:
    1. Fate clic con il pulsante destro del mouse sulla cartella js nel percorso seguente e selezionate Crea > Crea file :
      /apps/fd/cm/ma/gui/components/admin/clientlibs/admin/js
      Denominate il file come formaction.js.
    2. Fate doppio clic sul file per aprirlo in CRX.
    3. Nel file formaction.js (sotto il ramo /apps), copiate il codice dal file formaction.js nel percorso seguente:
      /libs/fd/cm/ma/gui/components/admin/clientlibs/admin/js/formaction.js
      Quindi aggiungete il codice seguente alla fine nel file formaction.js (sotto il ramo /apps) e fate clic su Salva tutto :
      /* 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>';
      
      
      Il codice aggiunto in questo passaggio ha la priorità sul codice presente nella cartella libs, quindi copiate il codice precedente nel file formaction.js nel ramo /apps. Copiando il codice dal ramo /libs al ramo /apps si garantisce che funzioni anche la funzionalità precedente.
      Il codice riportato sopra è relativo alla gestione dell'azione specifica delle lettere del comando creato in questa procedura. Per la gestione delle azioni di altre risorse, modificate il codice JavaScript.
  6. Nella cartella delle app, create una cartella denominata items con percorso/struttura simile alla cartella degli elementi che si trova nella cartella dei gestori di azioni, eseguendo la procedura seguente:
    1. Fate clic con il pulsante destro del mouse sulla cartella degli elementi nel percorso seguente e selezionate Nodo ​sovrapposizione:
      /libs/fd/cm/ma/gui/content/commons/actionhandlers/items/
    2. Verificate che la finestra di dialogo Nodo sovrapposizione contenga i seguenti valori:
      Percorso: /libs/fd/cm/ma/gui/content/commons/actionhandlers/items/
      Posizione: /apps/
      Corrispondenza tipi di nodo: Selezionato
    3. Fai clic su OK . La struttura delle cartelle viene creata nella cartella delle app.
    4. Fate clic su Salva tutto .
  7. Sotto il nodo di elementi appena creati, aggiungete un nodo per il pulsante/azione personalizzato in una risorsa particolare (esempio: letterpdfdownloader) utilizzando i seguenti passaggi:
    1. Fare clic con il pulsante destro del mouse sulla cartella degli elementi e selezionare Crea > Crea nodo .
    2. Verificate che la finestra di dialogo Crea nodo contenga i valori seguenti e fate clic su OK :
      Nome: letterpdfdownloader (oppure il nome che si desidera assegnare a questa proprietà) deve essere univoco. Se utilizzate un nome diverso, specificate lo stesso nella variabile ACTION_URL del file formaction.js.)
      Tipo: nt:non strutturato
    3. Fare clic sul nuovo nodo creato (qui downloadFlatPDF). CRX visualizza le proprietà del nodo.
    4. Aggiungete la seguente proprietà al nodo (qui letterpdfdownloader) e fate clic su Salva tutto :
      Nome
      Tipo
      Valore
      sling:resourceType
      Stringa
      fd/cm/ma/gui/components/admin/clientlibs/admin
  8. Create un file denominato POST.jsp con il codice per la gestione dell'azione del comando nella posizione seguente:
    /apps/fd/cm/ma/gui/components/admin/clientlibs/admin
    1. Fate clic con il pulsante destro del mouse sulla cartella admin nel percorso seguente e selezionate Crea > Crea file :
      /apps/fd/cm/ma/gui/components/admin/clientlibs/admin
      Denominate il file come POST.jsp. (il nome del file deve essere solo POST.jsp.)
    2. Fate doppio clic sul file POST.jsp per aprirlo in CRX.
    3. Aggiungete il codice seguente al file POST.jsp e fate clic su Salva tutto :
      Questo codice è specifico per il servizio di rendering della lettera. Per qualsiasi altra risorsa, aggiungi le librerie Java della risorsa al codice. Per ulteriori informazioni sulle API di AEM Forms, consultate API di AEM Forms.
      Per ulteriori informazioni sulle librerie AEM, consultate Componenti 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" "https://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="https://sling.apache.org/taglibs/sling/1.0"%>
      <%@taglib prefix="cq" uri="https://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.");
          }
      %>
      
      

Download di un PDF semplice di una lettera utilizzando la funzionalità personalizzata

Dopo aver aggiunto funzionalità personalizzate per scaricare il PDF piatto delle lettere, è possibile utilizzare i seguenti passaggi per scaricare la versione PDF semplice della lettera selezionata:
  1. Vai a https://'[server]:[port]'/[ContextPath]/projects.html e accedi.
  2. Selezionare Moduli > Lettere . Gestione corrispondenza elenca le lettere disponibili nel sistema.
  3. Fare clic su Seleziona , quindi su una lettera per selezionarla.
  4. Selezionare Altro > <Scarica PDF piano> (la funzionalità personalizzata creata utilizzando le istruzioni riportate in questo articolo). Viene visualizzata la finestra di dialogo Scarica lettera come PDF.
    Il nome, la funzionalità e il testo alt della voce di menu si basano sulla personalizzazione creata in Scenario: Aggiungere un comando all'interfaccia utente dell'elenco Lettere per scaricare la versione PDF semplice di una lettera.
  5. Nella finestra di dialogo Scarica lettera come PDF, selezionare il codice XML appropriato dal quale si desidera compilare i dati nel PDF.
    Prima di scaricare la lettera come PDF semplice, è possibile creare il file XML con i dati nella lettera utilizzando l'opzione Crea rapporto .
    La lettera viene scaricata nel computer come PDF semplice.