Preparare e inviare comunicazioni interattive tramite l’interfaccia utente dell’agente

Ultimo aggiornamento: 2023-12-04

L’interfaccia utente agente consente agli agenti di preparare e inviare la comunicazione interattiva al processo successivo. L’agente apporta le modifiche necessarie come consentito e invia la comunicazione interattiva a un processo successivo, ad esempio e-mail o stampa.

Panoramica

Dopo aver creato una comunicazione interattiva, l’agente può aprirla nell’interfaccia utente dell’agente e preparare una copia specifica per il destinatario immettendo i dati e gestendo il contenuto e gli allegati. Infine, l’agente può inviare la comunicazione interattiva a un processo successivo.

Durante la preparazione della comunicazione interattiva tramite l’interfaccia utente dell’agente, l’agente gestisce i seguenti aspetti della comunicazione interattiva nell’interfaccia utente dell’agente prima di inviarla a un processo successivo:

  • Dati: nella scheda Dati dell’interfaccia utente dell’agente vengono visualizzate tutte le variabili modificabili dall’agente e le proprietà del modello dati del modulo sbloccato nella comunicazione interattiva. Queste variabili o proprietà vengono create durante la modifica o la creazione di frammenti di documento inclusi nella comunicazione interattiva. La scheda Dati include anche tutti i campi generati nel modello del canale di stampa/XDP. La scheda Dati viene visualizzata solo quando nella comunicazione interattiva sono presenti variabili, proprietà del modello dati del modulo o campi modificabili dall’agente.
  • Contenuto: nella scheda Contenuto, l’agente gestisce il contenuto, ad esempio i frammenti di documento e le variabili di contenuto, nella comunicazione interattiva. L’agente può apportare le modifiche nel frammento di documento come consentito durante la creazione della comunicazione interattiva nelle proprietà di tali frammenti di documento. L’agente può anche riordinare, aggiungere/rimuovere un frammento di documento e aggiungere interruzioni di pagina, se consentite.
  • Allegati: la scheda Allegati viene visualizzata nell’interfaccia utente dell’agente solo se la comunicazione interattiva dispone di allegati o se l’agente dispone dell’accesso alla libreria. L'agente può o non può essere autorizzato a modificare gli allegati.

Preparare la comunicazione interattiva tramite l’interfaccia utente dell’agente

  1. Seleziona Forms > Forms e documenti.

  2. Seleziona la comunicazione interattiva appropriata e seleziona Apri interfaccia utente agente.

    NOTA

    L'interfaccia utente agente funziona solo se la comunicazione interattiva selezionata dispone di un canale di stampa.

    openagentiui

    In base al contenuto e alle proprietà della comunicazione interattiva, l’interfaccia utente dell’agente viene visualizzata con le tre schede seguenti: Dati, Contenuto e Allegato.

    agentuitabs

    Procedi all’immissione dei dati, alla gestione del contenuto e alla gestione degli allegati.

Inserisci dati

  1. Nella scheda Dati, immettere i dati per le variabili, le proprietà del modello di dati del modulo e i campi del modello di stampa (XDP), come richiesto. Compila tutti i campi obbligatori contrassegnati da un asterisco (*) per abilitare Invia pulsante.

    Seleziona un valore per un campo dati nell’anteprima della comunicazione interattiva per evidenziare il campo dati corrispondente nella scheda Dati o viceversa.

Gestione contenuto

Nella scheda Contenuto, gestisci il contenuto, ad esempio frammenti di documento e variabili di contenuto, nella comunicazione interattiva.

  1. Seleziona Contenuto. Viene visualizzata la scheda del contenuto della comunicazione interattiva.

    agentuicontenttab

  2. Se necessario, modifica i frammenti di documento nella scheda Contenuto. Per spostare lo stato attivo sul frammento rilevante nella gerarchia del contenuto, puoi selezionare la riga o il paragrafo pertinente nell’anteprima della comunicazione interattiva oppure selezionare il frammento direttamente nella gerarchia del contenuto.

    Ad esempio, il frammento di documento con la riga "Esegui un pagamento online ora …" è selezionato nell’anteprima dell’immagine seguente e lo stesso frammento di documento è stato selezionato nella scheda Contenuto.

    contentmodulefocus

    Nella scheda Contenuto o Dati, toccando Evidenzia moduli selezionati nel contenuto ( highlightselectedmodulesincontentccr) in alto a sinistra nell’anteprima, puoi disabilitare o abilitare la funzionalità per passare al frammento di documento quando il testo, il paragrafo o il campo dati rilevante viene toccato/selezionato nell’anteprima.

    I frammenti che possono essere modificati dall’agente durante la creazione della comunicazione interattiva hanno la proprietà Modifica contenuto selezionato ( iconeditselectedcontent). Seleziona l’icona Modifica contenuto selezionato per avviare il frammento in modalità di modifica e apportarvi modifiche. Utilizza le seguenti opzioni per la formattazione e la gestione del testo:

    Per ulteriori informazioni sulle azioni disponibili per i vari frammenti di documento nell'interfaccia utente dell'agente, vedere Azioni e informazioni disponibili nell’interfaccia utente dell’agente.

  3. Per aggiungere un'interruzione di pagina all'output di stampa della comunicazione interattiva, posizionare il cursore nel punto in cui si desidera inserire un'interruzione di pagina e selezionare Interruzione di pagina prima o Interruzione di pagina dopo ( pagebreakbeforeafter).

    Nella comunicazione interattiva viene inserito un segnaposto esplicito per l’interruzione di pagina. Per visualizzare in che modo un’interruzione di pagina esplicita influisce sulla comunicazione interattiva, consulta l’anteprima di stampa.

    expitpagebreak

    Procedi alla gestione degli allegati della comunicazione interattiva.

Gestisci allegati

  1. Seleziona Allegato. Nell’interfaccia utente dell’agente vengono visualizzati gli allegati disponibili configurati durante la creazione della comunicazione interattiva.

    Per scegliere di non inviare un allegato insieme alla comunicazione interattiva, tocca l’icona di visualizzazione e puoi selezionare la croce nell’allegato per eliminarlo (se all’agente è consentito eliminare o nascondere l’allegato) dalla comunicazione interattiva. Per gli allegati specificati come obbligatori durante la creazione della comunicazione interattiva, le icone Visualizza ed Elimina sono disattivate.

    attachmentsagentui

  2. Seleziona l'accesso alla libreria ( accesso alla libreria) per accedere alla Libreria dei contenuti e inserire risorse DAM come allegati.

    NOTA

    L’icona Accesso libreria è disponibile solo se l’accesso alla libreria è stato abilitato durante la creazione della comunicazione interattiva (nelle proprietà Contenitore documenti del canale di stampa).

  3. Se l'ordine degli allegati non è stato bloccato durante la creazione della comunicazione interattiva, è possibile riordinarli selezionando un allegato e toccando le frecce giù e su.

  4. Utilizza Anteprima web e Anteprima di stampa per verificare se i due output corrispondono alle tue esigenze.

    Se le anteprime risultano soddisfacenti, selezionare Invia per inviare/inviare la comunicazione interattiva a un processo post. Oppure, per apportare modifiche, esci dall’anteprima per tornare all’esecuzione delle modifiche.

Formattazione del testo

Durante la modifica di un frammento di testo nell’interfaccia utente dell’agente, la barra degli strumenti cambia a seconda del tipo di modifiche che si sceglie di apportare: Carattere, Paragrafo o Elenco:

typeofformattingtoolbar Barra degli strumenti Carattere

Barra degli strumenti Carattere

Barra degli strumenti Paragrafo

Barra degli strumenti Paragrafo

Barra degli strumenti Elenco

Barra degli strumenti Elenco

Evidenzia/evidenzia parti di testo

Per evidenziare/enfatizzare parti di testo in un frammento modificabile, selezionate il testo e selezionate Colore evidenziazione.

highlighttextagentui

Incolla testo formattato

incolledtext

Inserisci caratteri speciali nel testo

L’interfaccia utente dell’agente supporta 210 caratteri speciali. L’amministratore può aggiungi supporto per caratteri speciali aggiuntivi/personalizzati tramite personalizzazione.

Consegna dell’allegato

  • Quando viene eseguito il rendering della comunicazione interattiva utilizzando le API lato server come PDF interattivo o non interattivo, il PDF sottoposto a rendering contiene allegati come allegati PDF.
  • Quando un processo di post associato a una comunicazione interattiva viene caricato come parte dell’interfaccia utente di invio tramite agente, gli allegati vengono passati come elenco<com.adobe.idp.document> parametro inAttachmentDocs.
  • I flussi di lavoro del meccanismo di consegna, ad esempio e-mail e stampa, consegnano anche allegati insieme alla versione PDF della comunicazione interattiva.

Azioni e informazioni disponibili nell’interfaccia utente dell’agente

Frammenti di documenti

  • Frecce Su/Giù: frecce per spostare i frammenti di documento verso l’alto o il basso nella comunicazione interattiva.
  • Elimina: se consentito, elimina il frammento di documento dalla comunicazione interattiva.
  • Interruzione di pagina prima (applicabile ai frammenti secondari dell’area di destinazione): inserisce l’interruzione di pagina prima del frammento del documento.
  • Rientra: aumenta o diminuisce il rientro di un frammento di documento.
  • Interruzione di pagina dopo (applicabile ai frammenti secondari dell’area di destinazione): inserisce l’interruzione di pagina dopo il frammento del documento.

docfragoptions

  • Modifica (solo frammenti di testo): apri l’editor Rich Text per modificare il frammento di documento di testo. Per ulteriori informazioni, consulta Formattazione del testo.

  • Selezione (icona a forma di occhio): include\esclude il frammento di documento dalla comunicazione interattiva.

  • Valori non compilati (informazioni): indica il numero di variabili non compilate nel frammento di documento.

Elencare frammenti di documenti

listoptions

  • Inserisci riga vuota: inserisce una nuova riga vuota.
  • Selezione (icona a forma di occhio): include\esclude il frammento di documento dalla comunicazione interattiva.
  • Ignora punti elenco/numeri: consente di ignorare i punti elenco/la numerazione nel frammento di documento elenco.
  • Valori non compilati (informazioni): indica il numero di variabili non compilate nel frammento di documento.

Salvare le comunicazioni interattive come bozza

Puoi utilizzare l’interfaccia utente dell’agente per salvare una o più bozze per ciascuna comunicazione interattiva e recuperare la bozza in un secondo momento, per continuare a lavorarci. Potete specificare un nome diverso per ogni bozza per identificarla.

L’Adobe consiglia di eseguire queste istruzioni in sequenza per salvare correttamente una comunicazione interattiva come bozza.

Abilitare la funzione Salva come bozza

Per impostazione predefinita, la funzione Salva come bozza non è attivata. Per abilitare la funzione, effettua le seguenti operazioni:

  1. Implementare ccrDocumentInstance SPI (Service Provider Interface).

    La SPI consente di salvare nel database la versione bozza della comunicazione interattiva con un ID bozza come identificatore univoco. Queste istruzioni presuppongono una conoscenza preventiva di come creare un bundle OSGi utilizzando un progetto Maven.

    Per un esempio di implementazione SPI, vedi Esempio di implementazione SPI ccrDocumentInstance.

  2. Apri http://<hostname>:<port>/ system/console/bundles e seleziona Installa/Aggiorna per caricare il bundle OSGi. Verifica che lo stato del pacchetto caricato sia visualizzato come Attivo. Riavvia il server se lo stato del pacchetto non viene visualizzato come Attivo.

  3. Passa a https://'[server]:[port]'/system/console/configMgr.

  4. Seleziona Crea configurazione corrispondenza.

  5. Seleziona Abilita salvataggio tramite CCRDocumentInstanceService e seleziona Salva.

Salvare una comunicazione interattiva come bozza

Per salvare una comunicazione interattiva come bozza, effettua le seguenti operazioni:

  1. Seleziona una comunicazione interattiva in Forms Manager e seleziona Apri interfaccia utente agente.

  2. Apporta le modifiche appropriate nell’interfaccia utente dell’agente e seleziona Salva come bozza.

  3. Specificate il nome della bozza in Nome e seleziona Fine.

Dopo aver salvato la comunicazione interattiva come bozza, seleziona Salva modifiche per salvare eventuali ulteriori modifiche alla bozza.

Recuperare la bozza di una comunicazione interattiva

Dopo aver salvato una comunicazione interattiva come bozza, puoi recuperarla per continuare a lavorarci. Recupera la comunicazione interattiva utilizzando:

https://server:port/aem/forms/createcorrespondence.hmtl?draftid=[draftid]

[draft tid] si riferisce all’identificatore univoco della bozza di versione che viene generato dopo il salvataggio di una comunicazione interattiva come bozza.

Esempio di implementazione SPI ccrDocumentInstance

Implementare ccrDocumentInstance SPI per salvare una comunicazione interattiva come bozza. Di seguito è riportato un esempio di implementazione di ccrDocumentInstance SPI.

package Implementation;

import com.adobe.fd.ccm.ccr.ccrDocumentInstance.api.exception.CCRDocumentException;
import com.adobe.fd.ccm.ccr.ccrDocumentInstance.api.model.CCRDocumentInstance;
import com.adobe.fd.ccm.ccr.ccrDocumentInstance.api.services.CCRDocumentInstanceService;
import org.apache.commons.lang3.StringUtils;
import org.osgi.service.component.annotations.Component;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.*;


@Component(service = CCRDocumentInstanceService.class, immediate = true)
public class CCRDraftService implements CCRDocumentInstanceService {

    private static final Logger logger = LoggerFactory.getLogger(CCRDraftService.class);

    private HashMap<String, Object> draftDataMap = new HashMap<>();

    @Override
    public String save(CCRDocumentInstance ccrDocumentInstance) throws CCRDocumentException {
        String documentInstanceName = ccrDocumentInstance.getName();
        if (StringUtils.isNotEmpty(documentInstanceName)) {
            logger.info("Saving ccrData with name : {}", ccrDocumentInstance.getName());
            if (!CCRDocumentInstance.Status.SUBMIT.equals(ccrDocumentInstance.getStatus())) {
                ccrDocumentInstance = mySQLDataBaseServiceCRUD(ccrDocumentInstance,null, "SAVE");
            }
        } else {
            logger.error("Could not save data as draft name is empty");
        }
        return ccrDocumentInstance.getId();
    }

    @Override
    public void update(CCRDocumentInstance ccrDocumentInstance) throws CCRDocumentException {
        String documentInstanceName = ccrDocumentInstance.getName();
        if (StringUtils.isNotEmpty(documentInstanceName)) {
            logger.info("Saving ccrData with name : {}", documentInstanceName);
            mySQLDataBaseServiceCRUD(ccrDocumentInstance, ccrDocumentInstance.getId(), "UPDATE");
        } else {
            logger.error("Could not save data as draft Name is empty");
        }
    }

    @Override
    public CCRDocumentInstance get(String id) throws CCRDocumentException {
        CCRDocumentInstance cCRDocumentInstance;
        if (StringUtils.isEmpty(id)) {
            logger.error("Could not retrieve data as draftId is empty");
            cCRDocumentInstance = null;
        } else {
            cCRDocumentInstance = mySQLDataBaseServiceCRUD(null, id,"GET");
        }
        return cCRDocumentInstance;
    }

    @Override
    public List<CCRDocumentInstance> getAll(String userId, Date creationTime, Date updateTime,
                                            Map<String, Object> optionsParams) throws CCRDocumentException {
        List<CCRDocumentInstance> ccrDocumentInstancesList = new ArrayList<>();

        HashMap<String, Object> allSavedDraft = mySQLGetALLData();
        for (String key : allSavedDraft.keySet()) {
            ccrDocumentInstancesList.add((CCRDocumentInstance) allSavedDraft.get(key));
        }
        return ccrDocumentInstancesList;
    }

    //The APIs call the service in the database using the following section.
    private CCRDocumentInstance mySQLDataBaseServiceCRUD(CCRDocumentInstance ccrDocumentInstance,String draftId, String method){
        if(method.equals("SAVE")){

            String autoGenerateId = draftDataMap.size() + 1 +"";
            ccrDocumentInstance.setId(autoGenerateId);
            draftDataMap.put(autoGenerateId, ccrDocumentInstance);
            return ccrDocumentInstance;

        }else if (method.equals("UPDATE")){

            draftDataMap.put(ccrDocumentInstance.getId(), ccrDocumentInstance);
            return ccrDocumentInstance;

        }else if(method.equals("GET")){

            return (CCRDocumentInstance) draftDataMap.get(draftId);

        }
        return null;
    }

    private HashMap<String, Object> mySQLGetALLData(){
        return draftDataMap;
    }
}

Il save, update, get, e getAll Le operazioni richiamano il servizio del database per salvare una comunicazione interattiva come bozza, aggiornare una comunicazione interattiva, recuperare i dati dal database e recuperare i dati per tutte le comunicazioni interattive disponibili nel database. In questo esempio si utilizza mySQLDataBaseServiceCRUD come nome del servizio di database.

Nella tabella seguente viene illustrato l'esempio ccrDocumentInstance Implementazione SPI. Questo dimostra che save, update, get, e getAll le operazioni chiamano il servizio di database nell'implementazione di esempio.

Operazione

Esempi di servizi di database

Puoi creare una bozza per una comunicazione interattiva o inviarla direttamente. L’API per l’operazione di salvataggio controlla se la comunicazione interattiva viene inviata come bozza e include un nome della bozza. L’API chiama quindi il servizio mySQLDataBaseServiceCRUD con Salva come metodo di input.


Il servizio mySQLDataBaseServiceCRUD verifica il metodo Save come metodo di input e genera un ID bozza generato automaticamente e lo restituisce all'AEM. La logica per generare un ID bozza può variare in base al database.


L’API per l’operazione di aggiornamento recupera lo stato della bozza di comunicazione interattiva e controlla se la comunicazione interattiva include un nome di bozza. L'API chiama il servizio mySQLDataBaseServiceCRUD per aggiornare tale stato nel database.


Il servizio mySQLDataBaseServiceCRUD verifica Update come metodo di input e salva lo stato della bozza di comunicazione interattiva nel database.

L’API per l’operazione GET controlla se la comunicazione interattiva include un ID bozza. L’API chiama quindi il servizio mySQLDataBaseServiceCRUD con Get come metodo di input per recuperare i dati per la comunicazione interattiva.

Il servizio mySQLDataBaseServiceCRUD verifica Get come metodo di input e recupera i dati per la comunicazione interattiva in base all'ID bozza.


L'API per l'operazione getAll chiama il servizio mySQLGetALLData per recuperare i dati per tutte le comunicazioni interattive salvate nel database.

Il servizio mySQLGetALLData recupera i dati per tutte le comunicazioni interattive salvate nel database.


Di seguito è riportato un esempio di pom.xml file che fa parte dell'implementazione:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="https://maven.apache.org/POM/4.0.0"
         xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.adobe.livecycle</groupId>
    <artifactId>draft-sample</artifactId>
    <version>2.0.0-SNAPSHOT</version>

    <name>Interact</name>
    <packaging>bundle</packaging>

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


    <!-- ====================================================================== -->
    <!-- B U I L D D E F I N I T I O N -->
    <!-- ====================================================================== -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <version>3.3.0</version>
                <extensions>true</extensions>
                <executions>
                    <!--Configure extra execution of 'manifest' in process-classes phase to make sure SCR metadata is generated before unit test runs-->
                    <execution>
                        <id>scr-metadata</id>
                        <goals>
                            <goal>manifest</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <exportScr>true</exportScr>
                    <instructions>
                        <!-- Enable processing of OSGI DS component annotations -->
                        <_dsannotations>*</_dsannotations>
                        <!-- Enable processing of OSGI metatype annotations -->
                        <_metatypeannotations>*</_metatypeannotations>
                        <Bundle-SymbolicName>${project.groupId}-${project.artifactId}</Bundle-SymbolicName>
                    </instructions>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>8</source>
                    <target>8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
    <profiles>
        <profile>
            <id>autoInstall</id>
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.apache.sling</groupId>
                        <artifactId>maven-sling-plugin</artifactId>
                        <executions>
                            <execution>
                                <id>install-bundle</id>
                                <phase>install</phase>
                                <goals>
                                    <goal>install</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>
    </profiles>

</project>
NOTA

Assicurati di aggiornare aemfd-client-sdk dipendenza a 6.0.160 nel pom.xml file.

In questa pagina