Aggiungi azione/pulsante personalizzato nell’interfaccia utente Crea corrispondenza

Panoramica

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

Lo scenario descritto in questo documento spiega come creare un pulsante nell’interfaccia utente Crea corrispondenza per condividere una lettera come PDF di revisione allegato a un messaggio e-mail.

Prerequisiti

Per completare questo scenario, è necessario quanto segue:

• Conoscenza di CRX e JavaScript
• Server LiveCycle

Scenario: Crea il pulsante nell’interfaccia utente Crea corrispondenza per inviare una lettera per la revisione

L’aggiunta di un pulsante con un’azione (qui invia lettera per la revisione) all’interfaccia utente Crea corrispondenza include:

1. Aggiunta del pulsante all’interfaccia utente Crea corrispondenza
2. Aggiunta della gestione delle azioni al pulsante
3. Aggiunta del processo di LiveCycle per abilitare la gestione delle azioni

Aggiungi il pulsante all’interfaccia utente Crea corrispondenza

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

2. Nella cartella delle app, crea una cartella denominata defaultApp con percorso/struttura simile alla cartella defaultApp (che si trova nella cartella di configurazione). Per creare la cartella, effettua le seguenti operazioni:

   • Fai clic con il pulsante destro del mouse sulla cartella defaultApp al seguente percorso e seleziona Sovrapponi nodo:

     /libs/fd/cm/config/defaultApp/

     

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

     Percorso: /libs/fd/cm/config/defaultApp/

     Posizione di sovrapposizione: /apps/

     Tipi di nodo di corrispondenza: controllati

     

   • Fai clic su OK.

   • Fare clic su Salva tutto.

3. Crea una copia del file acmExtensionsConfig.xml (esiste sotto il ramo /libs) sotto il ramo /apps .

   • Vai a "/libs/fd/cm/config/defaultApp/acmExtensionsConfig.xml"

   • Fai clic con il pulsante destro del mouse sul file acmExtensionsConfig.xml e seleziona Copia.

     

   • Fai clic con il pulsante destro del mouse sulla cartella defaultApp in "/apps/fd/cm/config/defaultApp/" e seleziona Incolla.

   • Fare clic su Salva tutto.

4. Fai doppio clic sulla copia di acmExtentionsConfig.xml appena creata nella cartella apps . Il file viene aperto per la modifica.

5. Individua il codice seguente:

   <?xml version="1.0" encoding="utf-8"?>
   <extensionsConfig>
       <modelExtensions>
           <modelExtension type="LetterInstance">
     <customAction name="Preview" label="loc.letterInstance.preview.label" tooltip="loc.letterInstance.preview.tooltip" styleName="previewButton"/>
               <customAction name="Submit" label="loc.letterInstance.submit.label" tooltip="loc.letterInstance.submit.tooltip" styleName="submitButton" permissionName="forms-users"/>
               <customAction name="SaveAsDraft" label="loc.letterInstance.saveAsDraft.label" tooltip="loc.letterInstance.saveAsDraft.tooltip" styleName="submitButton" permissionName="forms-users"/>
               <customAction name="Close" label="loc.letterInstance.close.label" tooltip="loc.letterInstance.close.tooltip" styleName="closeButton"/>
           </modelExtension>
       </modelExtensions>
   </extensionsConfig> 
   

6. Per inviare un messaggio e-mail, è possibile utilizzare il Forms Workflow LiveCycle. Aggiungi un tag customAction sotto il tag modelExtension in acmExtensionsConfig.xml come segue:

    <customAction name="Letter Review" label="Letter Review" tooltip="Letter Review" styleName="" permissionName="forms-users" actionHandler="CM.domain.CCRCustomActionHandler">
         <serviceName>Forms Workflow -> SendLetterForReview/SendLetterForReviewProcess</serviceName>
       </customAction>
   

   

   Il tag modelExtension dispone di un set di tag secondari customAction che configurano l’azione, le autorizzazioni e l’aspetto del pulsante di azione. Di seguito è riportato un elenco di tag di configurazione customAction:

   Nome	Descrizione
   name	Nome alfanumerico dell’azione da eseguire. Il valore di questo tag è obbligatorio, deve essere univoco (all'interno del tag modelExtension ) e deve iniziare con un alfabeto.
   etichetta	Etichetta da visualizzare sul pulsante di azione
   tooltip	Testo della descrizione comando del pulsante, visualizzato quando l’utente passa il mouse sul pulsante.
   styleName	Nome dello stile personalizzato applicato al pulsante di azione.
   permissionName	L’azione corrispondente viene visualizzata solo se l’utente dispone dell’autorizzazione specificata da permissionName. Quando si specifica permissionName come forms-users, tutti gli utenti possono accedere a questa opzione.
   actionHandler	Nome completo della classe ActionHandler che viene chiamata quando l'utente fa clic sul pulsante.

   Oltre ai parametri di cui sopra, possono essere presenti configurazioni aggiuntive associate a un'azione personalizzata. Queste configurazioni aggiuntive sono rese disponibili al gestore tramite l'oggetto CustomAction.

   Nome	Descrizione
   serviceName	Se un oggetto customAction contiene un tag secondario con nome serviceName, fare clic sul pulsante o sul collegamento corrispondente per chiamare un processo con il nome rappresentato dal tag serviceName. Verificare che questo processo abbia la stessa firma del PostProcess Lettera. Aggiungi il prefisso "Forms Workflow ->" nel nome del servizio.
   Parametri contenenti il prefisso cm_ nel nome del tag	Se un'azione personalizzata contiene tag secondari che iniziano con nome cm_, in fase di post (che si tratti di Processo post lettera o del processo speciale rappresentato dal tag serviceName) questi parametri sono disponibili nel codice XML di input sotto il tag rilevante con il prefisso cm_ rimosso.
   actionName	Ogni volta che un processo post è dovuto a un clic, l'XML inviato contiene un tag speciale con il nome sotto il tag con il nome dell'azione utente.

7. Fare clic su Salva tutto.

Crea una cartella locale con il file delle proprietà nel ramo /apps

Il file ACMExtensionMessages.properties include etichette e messaggi di descrizione comando di vari campi nell'interfaccia utente Crea corrispondenza. Affinché le azioni/i pulsanti personalizzati funzionino, crea una copia di questo file nel ramo /apps .

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

   /libs/fd/cm/config/defaultApp/locale

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

   Percorso: /libs/fd/cm/config/defaultApp/locale

   Posizione di sovrapposizione: /apps/

   Tipi di nodo di corrispondenza: controllati

3. Fai clic su OK.

4. Fare clic su Salva tutto.

5. Fai clic con il pulsante destro del mouse sul file seguente e seleziona Copia:

   /libs/fd/cm/config/defaultApp/locale/ACMExtensionsMessages.properties

6. Fai clic con il pulsante destro del mouse sulla cartella locale nel percorso seguente e seleziona Incolla:

   /apps/fd/cm/config/defaultApp/locale/

   Il file ACMExtensionMessages.properties viene copiato nella cartella locale.

7. Per localizzare le etichette dell'azione/pulsante personalizzato appena aggiunto, crea il file ACMExtensionMessages.properties per le impostazioni internazionali pertinenti in /apps/fd/cm/config/defaultApp/locale/.

   Ad esempio, per localizzare l'azione/pulsante personalizzato creato in questo articolo, crea un file denominato ACMExtensionMessages_fr.properties con la voce seguente:

   loc.letterInstance.letterreview.label=Revue De Lettre

   Allo stesso modo, in questo file è possibile aggiungere più proprietà, ad esempio per la descrizione comando e lo stile.

8. Fare clic su Salva tutto.

Riavvia il bundle Adobe Asset Composer Building Block

Dopo aver apportato ogni modifica lato server, riavvia il bundle Adobe Asset Composer Building Block. In questo scenario, i file acmExtensionsConfig.xml e ACMExtensionMessages.properties sul lato server vengono modificati e quindi il bundle Adobe Asset Composer Building Block richiede un riavvio.

1. Passa a https://[host]:[port]/system/console/bundles. Se necessario, accedi come Amministratore.

2. Individua il bundle Adobe Asset Composer Building Block . Riavvia il bundle: fare clic su Interrompi e quindi su Avvia.

   

Dopo aver riavviato il bundle Adobe Asset Composer Building Block, il pulsante personalizzato viene visualizzato nell’interfaccia utente Crea corrispondenza. Puoi aprire una lettera nell’interfaccia utente Crea corrispondenza per visualizzare l’anteprima del pulsante personalizzato.

Aggiungi la gestione delle azioni al pulsante

L’interfaccia utente Crea corrispondenza per impostazione predefinita ha implementato ActionHandler nel file cm.domain.js nella posizione seguente:

/libs/fd/cm/ccr/gui/components/admin/clientlibs/ccr/js/cm.domain.js

Per la gestione delle azioni personalizzata, crea una sovrapposizione del file cm.domain.js nel ramo /apps di CRX.

La gestione dell’azione o del pulsante quando si fa clic su action/button include la logica per:

• L’azione appena aggiunta diventa visibile/invisibile: eseguito ignorando la funzione actionVisible() .
• Abilitazione/disabilitazione della nuova azione aggiunta: eseguito ignorando la funzione actionEnabled() .
• Gestione effettiva dell'azione quando l'utente fa clic sul pulsante: eseguito ignorando l'implementazione della funzione handleAction() .

1. Passa a https://[server]:[port]/[ContextPath]/crx/de. Se necessario, accedi come Amministratore.

2. Nella cartella delle app, crea una cartella denominata js nel ramo /apps di CRX con struttura simile alla seguente:

   /libs/fd/cm/ccr/gui/components/admin/clientlibs/ccrui/js

   Per creare la cartella, effettua le seguenti operazioni:

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

      /libs/fd/cm/ccr/gui/components/admin/clientlibs/ccrui/js

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

      Percorso: /libs/fd/cm/ccr/gui/components/admin/clientlibs/ccrui/js

      Posizione di sovrapposizione: /apps/

      Tipi di nodo di corrispondenza: controllati

   3. Fai clic su OK.

   4. Fare clic su Salva tutto.

3. Nella cartella js , crea un file denominato ccrcustomization.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/ccr/gui/components/admin/clientlibs/ccrui/js

      Denomina il file come ccrcustomization.js.

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

   3. Nel file , incolla il codice seguente e fai clic su Salva tutto:

      /* for adding and handling custom actions in Extensible Toolbar.
        * One instance of handler will be created for each action.
        * CM.domain.CCRCustomActionHandler is actionHandler class.
        */
      var CCRCustomActionHandler;
          CCRCustomActionHandler = CM.domain.CCRCustomActionHandler = new Class({
              className: 'CCRCustomActionHandler',
              extend: CCRDefaultActionHandler,
              construct : function(action,model){
              }
          });
          /**
           * Called when user user click an action
           * @param extraParams additional arguments that may be passed to handler (For future use)
           */
          CCRCustomActionHandler.prototype.handleAction = function(extraParams){
              if (this.action.name == CCRCustomActionHandler.SEND_FOR_REVIEW) {
                  var sendForReview = function(){
                      var serviceName = this.action.actionConfig["serviceName"];
                      var inputParams = {};
                      inputParams["dataXML"] = this.model.iccData.data;
                      inputParams["letterId"] = this.letterVO.id;
                      inputParams["letterName"] = this.letterVO.name;
                      inputParams["mailId"] = $('#email').val();
                      /*function to invoke the LivecyleService */
                      ServiceDelegate.callJSONService(this,"lc.icc.renderlib.serviceInvoker.json","invokeProcess",[serviceName,inputParams],this.onProcessInvokeComplete,this.onProcessInvokeFail);
                      $('#ccraction').modal("hide");
                  }
                  if($('#ccraction').length == 0){
                      /*For first click adding popup & setting letterName.*/
                      $("body").append(popUp);
                      $("input[id*='letterName']").val(this.letterVO.name);   
                      $(document).on('click',"#submitLetter",$.proxy( sendForReview, this ));
                  }
                  $('#ccraction').modal("show");
              }
          };
          /**
           * Should the action be enabled in toolbar
           * @param extraParams additional arguements that may be passed to handler (For future use)
           * @return flag indicating whether the action should be enabled
           */
         CCRCustomActionHandler.prototype.actionEnabled = function(extraParams){
                  /*can be customized as per user requirement*/
                  return true;
          };
          /**
           * Should the action be visible in toolbar
           * @param extraParams additional arguments that may be passed to handler (For future use)
           * @return flag indicating whether the action should be enabled
           */
          CCRCustomActionHandler.prototype.actionVisible = function(extraParams){
              /*Check can be enabled for Non-Preview Mode.*/
              return true;
          };
          /*SuccessHandler*/
          CCRCustomActionHandler.prototype.onProcessInvokeComplete = function(response) {
              ErrorHandler.showSuccess("Letter Sent for Review");
          };
          /*FaultHandler*/
          CCRCustomActionHandler.prototype.onProcessInvokeFail = function(event) {
              ErrorHandler.showError(event.message);
          };
          CCRCustomActionHandler.SEND_FOR_REVIEW  = "Letter Review";
      /*For PopUp*/
          var popUp = '<div class="modal fade" id="ccraction" tabindex="-1" role="dialog" aria-hidden="true">'+
          '<div class="modal-dialog modal-sm">'+
              '<div class="modal-content">' +
                  '<div class="modal-header">'+
                      '<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>'+
                      '<h4 class="modal-title"> Send Review </h4>'+
                  '</div>'+
                  '<div class="modal-body">'+
                      '<form>'+
                          '<div class="form-group">'+
                              '<label class="control-label">Email Id</label>'+
                              '<input type="text" class="form-control" id="email">'+
                          '</div>'+
                          '<div class="form-group">'+
                              '<label  class="control-label">Letter Name</label>'+
                              '<input id="letterName" type="text" class="form-control" readonly>'+
                          '</div>'+
                          '<div class="form-group">'+
                              '<input id="letterData" type="text" class="form-control hide" readonly>'+
                          '</div>'+
                      '</form>'+
                  '</div>'+
                  '<div class="modal-footer">'+
                     '<button type="button" class="btn btn-default" data-dismiss="modal"> Cancel </button>'+
                     '<button type="button" class="btn btn-primary" id="submitLetter"> Submit </button>'+
                  '</div>'+
              '</div>'+
          '</div>'+
      '</div>';
      

Aggiungi il processo di LiveCycle per abilitare la gestione dell’azione .

In questo scenario, abilita i seguenti componenti, che fanno parte del file components.zip allegato:

• JAR del componente DSC (DSCSample.jar)
• Invia lettera per il processo di revisione LCA (SendLetterForReview.lca)

Scarica e decomprimi il file components.zip per ottenere i file DSCSample.jar e SendLetterForReview.lca. Utilizzare questi file come specificato nelle procedure seguenti.

Ottieni file

Configurare il server di LiveCycle per eseguire il processo LCA

Il processo LCA viene eseguito sul server di LiveCycle e richiede l'indirizzo del server e le credenziali di accesso.

1. Vai a https://[server]:[port]/system/console/configMgr e accedi come amministratore.

2. Individua la configurazione dell’SDK client di Adobe LiveCycle e fai clic su Modifica (icona di modifica). Viene visualizzato il pannello Configurazioni .

3. Immetti i seguenti dettagli e fai clic su Salva:

   • Url server: URL del server LC il cui servizio Invia per revisione viene utilizzato dal codice del gestore azioni.
   • Nome utente: Nome utente amministratore del server LC
   • Password: Password del nome utente amministratore

   

Installa archivio LiveCycli (LCA)

Il processo di LiveCycle richiesto che abilita il processo del servizio e-mail.

1. Accedi come amministratore a Livecycle Server adminui all'indirizzo https:/[lc server]/:[lc port]/adminui.

2. Passa a Home > Servizi > Applicazioni e servizi > Gestione applicazioni.

3. Se l'applicazione SendLetterForReview è già presente, salta i passaggi rimanenti di questa procedura, altrimenti continua con i passaggi successivi.

   

4. Fai clic su Importa.

5. Fare clic su Scegli file e selezionare SendLetterForReview.lca.

   

6. Fare clic su Anteprima.

7. Seleziona Distribuisci risorse in fase di esecuzione al termine dell'importazione.

8. Fai clic su Importa.

Aggiunta di ServiceName all'elenco dei servizi Inseriti nell'elenco Consentiti

Indicare nel server AEM i servizi di LiveCycle a cui si desidera accedere al server AEM.

1. Accedi come amministratore a https:/[host]/:[port]/system/console/configMgr.

2. Individua e fai clic su Configurazione Adobe LiveCycle Client SDK. Viene visualizzato il pannello Configurazione dell’SDK client di Adobe LiveCycle.

3. Nell'elenco Nome servizio, fai clic sull'icona + e aggiungi un serviceName SendLetterForReview/SendLetterForReviewProcess.

4. Fai clic su Salva.

Configurare il servizio e-mail

In questo scenario, affinché Gestione Corrispondenza possa inviare un’e-mail, configura il servizio e-mail nel server di LiveCycle.

1. Accedi con le credenziali di amministratore a Livecycle Server adminui all'indirizzo https:/[lc server]:[lc port]/adminui.

2. Passa a Home > Servizi > Applicazioni e servizi > Gestione dei servizi.

3. Individua e fai clic su EmailService.

4. In Host SMTP, configura il servizio e-mail.

5. Fai clic su Salva.

Configurare il servizio DSC

Per utilizzare l'API di gestione della corrispondenza, scarica il DSCSample.jar (allegato in questo documento come parte di components.zip) e caricalo sul server di LiveCycle. Dopo il caricamento del file DSCSample.jar sul server di LiveCycle, il server AEM utilizza il file DSCSample.jar per accedere all’API renderLetter.

Per ulteriori informazioni, consulta Collegamento di AEM Forms con il LiveCycle Adobe.

1. Aggiorna l'URL del server AEM in cmsa.properties in DSCSample.jar, che si trova nel seguente percorso:

   DSCSample.jar\com\adobe\livecycle\cmsa.properties

2. Fornisci i seguenti parametri nel file di configurazione:

   • crx.serverUrl=https:/[host]/:[port]/[context path]/[AEM URL]
   • crx.username= nome utente AEM
   • crx.password= password AEM
   • crx.appRoot=/content/apps/cm
   NOTA

   Ogni volta che apporti modifiche sul lato server, riavvia il server.

   Il file DSCSample.jar utilizza l'API renderLetter. Per ulteriori informazioni sull'API renderLetter, consulta Interfaccia LetterRenderService.

Importare DSC in AEM Forms su JEE

DSCSample.jar Il file utilizza l’ renderLetter API per eseguire il rendering della lettera come byte PDF dai dati XML che C fornisce come input. Per ulteriori informazioni su renderLetter e altre API, consulta Servizio di rendering delle lettere.

1. Avvia Workbench ed effettua l'accesso.

2. Seleziona Finestra > Mostra visualizzazioni > Componenti. La vista Componenti viene aggiunta a Workbench ES2.

3. Fai clic con il pulsante destro del mouse su Componenti e seleziona Installa componente.

4. Seleziona il file DSCSample.jar dal browser dei file e fai clic su Apri.

5. Fai clic con il pulsante destro del mouse su RenderWrapper e seleziona Avvia componente. Se il componente viene avviato, accanto al nome del componente viene visualizzata una freccia verde.

Invia lettera di revisione

Dopo aver configurato l’azione e il pulsante per l’invio della lettera per la revisione:

1. Cancella la cache del browser.

2. Nell'interfaccia utente Crea corrispondenza, fai clic su Revisione lettera e specifica l'ID e-mail del revisore.

3. Fare clic su Invia.

Il revisore riceve un'e-mail dal sistema con la lettera come allegato PDF.