Aggiungi un’azione personalizzata alla vista Elenco risorse

Panoramica

La soluzione Gestione della corrispondenza consente di aggiungere azioni personalizzate all’interfaccia utente Gestione risorse.

Puoi aggiungere un’azione personalizzata alla vista Elenco risorse per:

  • Uno o più tipi di risorse o lettere
  • Esecuzione (azione/comando diventa attivo) quando si selezionano singole risorse/lettere o senza selezione

Questa personalizzazione viene illustrata con lo scenario in cui viene aggiunto il comando "Scarica PDF piatto" alla vista Elenco risorse per lettere. Questo scenario di personalizzazione consente agli utenti di scaricare un PDF semplice di una singola lettera selezionata.

Prerequisiti

Per completare lo scenario seguente o uno scenario simile, è necessario conoscere:

  • CRX
  • JavaScript
  • Java

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

I passaggi seguenti aggiungono un comando "Scarica PDF piatto" alla vista Elenco risorse per lettere e consentono agli utenti di scaricare un PDF piatto della lettera selezionata. Utilizzando questi passaggi con il codice e i parametri appropriati, puoi aggiungere altre funzionalità per una risorsa diversa, ad esempio dizionari di dati o testi.

Per personalizzare Gestione Corrispondenza per consentire agli utenti di scaricare un PDF piatto di lettere, completa i seguenti passaggi:

  1. Vai a https://[server]:[port]/[ContextPath]/crx/de e accedi come amministratore.

  2. Nella cartella delle app, crea una cartella denominata items con percorso/struttura simile alla cartella degli elementi che si trova nella cartella di selezione, seguendo i passaggi seguenti:

    1. Fai clic con il pulsante destro del mouse sulla cartella items nel seguente percorso e seleziona Sovrapponi nodo:

      /libs/fd/cm/ma/gui/content/cmassets/jcr:content/body/content/header/items/selection/items

      NOTA

      Questo percorso è specifico per la creazione di un’azione che funziona con la selezione di una o più risorse/lettere. Se desideri creare un'azione che funzioni senza selezione, devi invece creare un nodo di sovrapposizione per il seguente percorso e completare di conseguenza i passaggi rimanenti:

      /libs/fd/cm/ma/gui/content/cmassets/jcr:content/body/content/header/items/default/items

      Crea nodo

    2. Assicurati che la finestra di dialogo Sovrapponi nodo abbia i seguenti valori:

      Percorso: /libs/fd/cm/ma/gui/content/cmassets/jcr:content/body/content/header/items/selection/items

      Posizione: /apps/

      Tipi di nodo di corrispondenza: selezionati

      nodo di sovrapposizione

    3. Fai clic su OK. La struttura delle cartelle viene creata nella cartella delle app.

      Fare clic su Salva tutto.

  3. Nella cartella degli elementi appena creati, aggiungi un nodo per il pulsante/azione personalizzato in una particolare risorsa (Esempio: scaricaFlatPDF) seguendo la seguente procedura:

    1. Fai clic con il pulsante destro del mouse sulla cartella items e seleziona Crea > Crea nodo.

    2. Assicurati che la finestra di dialogo Crea nodo abbia i seguenti valori e fai clic su OK:

      Nome: downloadFlatPDF (o il nome che si desidera assegnare a questa proprietà)

      Tipo: nt:unstructured

    3. Fai 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-manageasset-admin-children pages", "activeSelectionCount": "single","type": "LETTER"}


    activeSelectionCount può essere singolo o multiplo per consentire la selezione di risorse singole o multiple su cui viene eseguita l'azione personalizzata.

    può essere uno o più (voci multiple separate da virgola) dei seguenti elementi: LETTERA, TESTO, ELENCO, CONDIZIONE, DATAZIONARIO

    icon Stringa icon-download

    L'icona che Gestione corrispondenza visualizza sul lato sinistro del comando/menu. Per le diverse icone e impostazioni disponibili, consulta la documentazione CoralUI Icons.
    jcr:primaryType Nome nt:unstructured
    cilindro Stringa download-flat-pdf-button
    sling:resourceType Stringa granite/ui/components/endor/actionbar/button
    testo Stringa Scarica PDF Flat (O qualsiasi altra etichetta)

    Il comando che viene visualizzato nell’interfaccia di Elenco risorse
    titolo Stringa Scarica un PDF piatto della lettera selezionata (O qualsiasi altro testo etichetta/Alt)

    Il titolo è il testo alt visualizzato quando l'utente passa il puntatore del mouse sul comando personalizzato.
  4. Nella cartella delle app, crea una cartella denominata js con percorso/struttura simile alla cartella degli elementi che si trova nella cartella di amministrazione, seguendo i passaggi seguenti:

    1. Fai clic con il pulsante destro del mouse sulla cartella js al seguente percorso e seleziona Sovrapponi nodo: "

      /libs/fd/cm/ma/gui/components/admin/clientlibs/admin/js

    2. Assicurati che la finestra di dialogo Sovrapponi nodo abbia i seguenti valori:

      Percorso: /libs/fd/cm/ma/gui/components/admin/clientlibs/admin/js

      Posizione: /apps/

      Tipi di nodo di corrispondenza: selezionati

    3. Fai clic su OK. La struttura delle cartelle viene creata nella cartella delle app. Fare clic su Salva tutto.

  5. Nella cartella js , crea un file denominato formaction.js con il codice per la gestione dell’azione del pulsante seguendo i passaggi seguenti:

    1. Fai clic con il pulsante destro del mouse sulla cartella js al seguente percorso e seleziona Crea > Crea file:

      /apps/fd/cm/ma/gui/components/admin/clientlibs/admin/js

      Denomina il file come formaction.js.

    2. Fai doppio clic sul file per aprirlo in CRX.

    3. Nel file formaction.js (sotto il ramo /apps), copia il codice dal file formaction.js nel seguente percorso:

      /libs/fd/cm/ma/gui/components/admin/clientlibs/admin/js/formaction.js

      Quindi aggiungi il seguente codice alla fine nel file formaction.js (sotto il ramo /apps) e fai 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 sostituisce il codice sotto la cartella libs, quindi copia il codice precedente nel file formaction.js nel ramo /apps . Copiare il codice dal ramo /libs al ramo /apps assicura che funzioni anche la funzionalità precedente.

      Il codice di cui sopra è per la gestione dell'azione specifica delle lettere del comando creato in questa procedura. Per la gestione delle azioni di altre risorse, modifica il codice JavaScript.

  6. Nella cartella delle app, crea una cartella denominata items con percorso/struttura simile alla cartella items che si trova nella cartella actionhandlers seguendo i seguenti passaggi:

    1. Fai clic con il pulsante destro del mouse sulla cartella items nel seguente percorso e seleziona Sovrapponi nodo:

      /libs/fd/cm/ma/gui/content/commons/actionhandlers/items/

    2. Assicurati che la finestra di dialogo Sovrapponi nodo abbia i seguenti valori:

      Percorso: /libs/fd/cm/ma/gui/content/commons/actionhandlers/items/

      Posizione: /apps/

      Tipi di nodo di corrispondenza: selezionati

    3. Fai clic su OK. La struttura delle cartelle viene creata nella cartella delle app.

    4. Fare clic su Salva tutto.

  7. Sotto il nodo elementi appena creati, aggiungi un nodo per il pulsante/azione personalizzato in una particolare risorsa (Esempio: letterpdfdownloader) seguendo i seguenti passaggi:

    1. Fai clic con il pulsante destro del mouse sulla cartella degli elementi e seleziona Crea > Crea nodo.

    2. Assicurati che la finestra di dialogo Crea nodo abbia i seguenti valori e fai clic su OK:

      Nome: letterpdfdownloader (o il nome che vuoi assegnare a questa proprietà - deve essere univoco. Se utilizzi un nome diverso, specifica lo stesso nella variabile ACTION_URL del file formaction.js.)

      Tipo: nt:unstructured

    3. Fai clic sul nuovo nodo creato (qui downloadFlatPDF). CRX visualizza le proprietà del nodo.

    4. Aggiungi la seguente proprietà al nodo (qui letterpdfdownloader) e fai clic su Salva tutto:

      Nome Tipo Valore
      sling:resourceType Stringa fd/cm/ma/gui/components/admin/clientlibs/admin
  8. Crea un file denominato POST.jsp con il codice per la gestione delle azioni del comando nella posizione seguente:

    /apps/fd/cm/ma/gui/components/admin/clientlibs/admin

    1. Fai clic con il pulsante destro del mouse sulla cartella admin nel seguente percorso e seleziona Crea > Crea file:

      /apps/fd/cm/ma/gui/components/admin/clientlibs/admin

      Denomina il file come POST.jsp. (Il nome del file deve essere solo POST.jsp.)

    2. Fai doppio clic sul file POST.jsp per aprirlo in CRX.

    3. Aggiungi il codice seguente al file POST.jsp e fai clic su Salva tutto:

      Questo codice è specifico per il servizio di rendering della lettera. Per qualsiasi altra risorsa, aggiungi le librerie java della risorsa a questo codice. Per ulteriori informazioni sulle API di AEM Forms, consulta API di AEM Forms.

      Per ulteriori informazioni sulle librerie AEM, consulta AEM Componenti.

      /*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.");
          }
      %>
      

Scarica il PDF piatto di una lettera utilizzando la funzionalità personalizzata

Dopo aver aggiunto funzionalità personalizzate per scaricare i PDF piatti delle lettere, puoi utilizzare i seguenti passaggi per scaricare la versione PDF piatta della lettera selezionata:

  1. Vai a https://[server]:[port]/[ContextPath]/projects.html e accedi.

  2. Selezionare Forms > Lettere. Gestione corrispondenza elenca le lettere disponibili nel sistema.

  3. Fare clic su Seleziona, quindi fare clic su una lettera per selezionarla.

  4. Seleziona Altro > <Scarica PDF semplice> (la funzionalità personalizzata creata utilizzando le istruzioni contenute in questo articolo). Viene visualizzata la finestra di dialogo Scarica lettera come PDF.

    Il nome, la funzionalità e l'alt-text della voce di menu è in base alla personalizzazione creata in Scenario: Aggiungere un comando all'interfaccia utente dell'elenco Lettere per scaricare la versione PDF piatta di una lettera.

    Funzionalità personalizzata: Scarica PDF Flat

  5. Nella finestra di dialogo Scarica lettera come PDF, selezionare l’XML pertinente da cui si desidera compilare i dati nel PDF.

    NOTA

    Prima di scaricare la lettera come PDF piatto, è possibile creare il file XML con i dati nella lettera utilizzando l'opzione Crea rapporto.

    Scarica lettera come PDF

    La lettera viene scaricata sul tuo computer come PDF piatto.

In questa pagina