Preparar e enviar comunicação interativa usando a interface do usuário do agente

A interface do usuário do agente permite que os agentes preparem e enviem comunicação interativa para o processo de publicação. O Agente faz as modificações necessárias conforme permitido e envia a Comunicação interativa para um processo posterior, como email ou impressão.

Visão geral

Após a criação de uma Comunicação interativa, o Agente pode abrir a Comunicação interativa na interface do usuário do agente e preparar uma cópia específica do destinatário inserindo dados e gerenciando conteúdo e anexos. Por fim, o Agente pode enviar a Comunicação Interativa para um processo posterior.

Ao preparar a Comunicação interativa usando a interface do usuário do agente, o agente gerencia os seguintes aspectos da Comunicação interativa na interface do agente antes de enviá-la para um processo de publicação:

  • Dados: A guia Dados da interface do usuário do agente exibe quaisquer variáveis editáveis pelo agente e propriedades de modelo de dados de formulário desbloqueadas na Comunicação interativa. Essas variáveis/propriedades são criadas durante a edição ou criação de fragmentos de documento incluídos na Comunicação interativa. A guia Data também inclui todos os campos criados no modelo de canal XDP/impressão. A guia Dados aparece somente quando há variáveis, propriedades de modelo de dados de formulário ou campos na Comunicação interativa que são editáveis pelo agente.
  • Conteúdo: Na guia Conteúdo, o Agente gerencia o conteúdo, como fragmentos de documento e variáveis de conteúdo na Comunicação interativa. O Agente pode fazer as alterações no fragmento do documento conforme permitido ao criar a Comunicação interativa nas propriedades desses fragmentos de documento. O Agente também pode reordenar, adicionar/remover um fragmento de documento e adicionar quebras de página, se permitido.
  • Anexos: A guia Anexos aparece na interface do usuário do agente somente se a Comunicação interativa tiver anexos ou se o agente tiver acesso à biblioteca. O agente pode ou não ter permissão para alterar ou editar os anexos.

Preparar comunicação interativa usando a interface do usuário do agente

  1. Selecione Forms > Forms & Documents.

  2. Selecione a Comunicação Interativa apropriada e toque em Abrir interface do usuário do agente.

    OBSERVAÇÃO

    A interface do usuário do agente funciona somente se a Comunicação interativa selecionada tiver um canal de impressão.

    openagentiui

    Com base no conteúdo e nas propriedades da Comunicação interativa, a interface do usuário do agente é exibida com as três guias a seguir: Dados, conteúdo e anexo.

    aventureiras

    Prossiga para inserir dados, gerenciar o conteúdo e gerenciar os anexos.

Inserir dados

  1. Na guia Data , insira os dados para variáveis, propriedades do modelo de dados de formulário e campos do modelo de impressão (XDP), conforme necessário. Preencha todos os campos obrigatórios marcados com um asterisco (*) para ativar o botão Submit.

    Toque em um valor de campo de dados na visualização Comunicação interativa para realçar o campo de dados correspondente na guia Dados ou vice-versa.

Gerenciar conteúdo

Na guia Conteúdo, gerencie o conteúdo, como fragmentos de documento e variáveis de conteúdo, na Comunicação interativa.

  1. Selecione Content. A guia Conteúdo da Comunicação interativa é exibida.

    Guia agentuicontenttab

  2. Edite os fragmentos do documento, conforme necessário, na guia Content . Para trazer o foco para o fragmento relevante na hierarquia do conteúdo, toque na linha relevante ou no parágrafo na visualização da Comunicação interativa ou toque no fragmento diretamente na hierarquia Conteúdo.

    Por exemplo, o fragmento do documento com a linha "Faça um pagamento online agora …" é selecionado na visualização no gráfico abaixo e o mesmo fragmento do documento foi selecionado na guia Conteúdo.

    contentmodulefocus

    Na guia Conteúdo ou Dados , ao tocar em Realçar Módulos Selecionados no Conteúdo ( highlight seletdmodulesincontentcr) no canto superior esquerdo da visualização, é possível desativar ou ativar a funcionalidade para ir para o fragmento do documento quando o texto, parágrafo ou campo de dados relevante for tocado/selecionado na visualização.

    Os fragmentos que podem ser editados pelo agente durante a criação da Comunicação interativa têm o ícone Editar conteúdo selecionado ( iconedittedcontent). Toque no ícone Editar conteúdo selecionado para iniciar o fragmento no modo de edição e fazer alterações nele. Use as seguintes opções para formatação e gerenciamento de texto:

    Para obter mais informações sobre as ações disponíveis para vários fragmentos de documento na interface do usuário do Agente, consulte Ações e informações disponíveis na interface do usuário do Agente.

  3. Para adicionar uma quebra de página à saída impressa da Comunicação interativa, coloque o cursor onde deseja inserir uma quebra de página e selecione Quebra de página antes ou Quebra de página depois de ( quebra de página antes de).

    Um espaço reservado explícito para quebras de página é inserido na Comunicação interativa. Para visualizar como uma quebra de página explícita afeta a Comunicação interativa, consulte a visualização de impressão.

    explicitpagebreak

    Continue a gerenciar os anexos da Comunicação interativa.

Gerenciar Anexos

  1. Selecione Attachment. A interface do usuário do agente exibe os anexos disponíveis como configurados ao criar a Comunicação interativa.

    Você pode optar por não enviar um anexo junto com a Comunicação interativa tocando no ícone de exibição e tocar na cruz no anexo para excluí-lo (se o agente tiver permissão para excluir ou ocultar o anexo) da Comunicação interativa. Para os anexos especificados como obrigatórios ao criar a Comunicação interativa, os ícones Exibir e Excluir são desativados.

    admentsagentui

  2. Toque no ícone Acesso à biblioteca ( acesso à biblioteca) para acessar a Biblioteca de conteúdo para inserir ativos DAM como anexos.

    OBSERVAÇÃO

    O ícone Acesso à biblioteca está disponível somente se o acesso à biblioteca foi ativado durante a criação da Comunicação interativa (nas propriedades do Contêiner de documento do canal Imprimir).

  3. Se a ordem dos anexos não tiver sido bloqueada durante a criação da Comunicação interativa, é possível reordenar os anexos selecionando um anexo e tocando nas setas para baixo e para cima.

  4. Use Visualização da Web e Visualização de impressão para ver se as duas saídas estão de acordo com seu requisito.

    Se você achar as visualizações satisfatórias, toque em Enviar para enviar/enviar a Comunicação interativa para um processo de publicação. Ou, para fazer alterações, saia da visualização para voltar para fazer as alterações.

Formatação de texto

Ao editar um fragmento de texto na interface do agente, a barra de ferramentas muda de acordo com o tipo de edição que você escolher fazer: Fonte, Parágrafo ou Lista:

typeofformattingtoolbarBarra de ferramentas Font

Barra de ferramentas Fonte

Barra de ferramentas Parágrafo

Barra de ferramentas Parágrafo

Barra de ferramentas Lista

Barra de ferramentas Lista

Realçar/realçar partes do texto

Para realçar\enfatizar partes do texto em um fragmento editável, selecione o texto e toque em Realçar cor.

Highlighttextagentusi

Colar texto formatado

texto colado

Inserir caracteres especiais no texto

A interface do usuário do agente tem suporte incorporado para 210 caracteres especiais. O administrador pode adicionar suporte para caracteres especiais mais/personalizados por personalização.

Entrega do anexo

  • Quando a Comunicação interativa é renderizada usando APIs do lado do servidor como um PDF interativo ou não interativo, o PDF renderizado contém anexos como anexos de PDF.
  • Quando um processo de publicação associado a uma Comunicação interativa é carregado como parte da Interface do usuário do agente Enviar, os anexos são passados como o parâmetro List<com.adobe.idp.Document> inAttachmentDocs .
  • Os workflows do mecanismo de delivery, como email e impressão, também fornecem anexos junto com a versão PDF da Comunicação interativa.

Ações e informações disponíveis na interface do usuário do agente

Fragmentos de documento

  • Setas para cima/para baixo: Setas para mover fragmentos de documento para cima ou para baixo na Comunicação interativa.
  • Excluir: Se permitido, exclua o fragmento de documento da Comunicação interativa.
  • Quebra de página antes de (aplicável para fragmentos filhos da área de destino): Insere quebra de página antes do fragmento do documento.
  • Recuo: Aumentar ou diminuir o recuo de um fragmento de documento.
  • Quebra de página depois de (aplicável para fragmentos filhos da área de destino): Insere quebra de página após o fragmento do documento.

docfragoptions

  • Editar (somente fragmentos de texto): Abra o editor de rich text para editar o fragmento do documento de texto. Para obter mais informações, consulte Formatação de texto.

  • Seleção (ícone de olhos): Inclui\exclui fragmento de documento da Comunicação interativa.

  • Valores não preenchidos (informações): Indica o número de variáveis não preenchidas no fragmento do documento.

Listar fragmentos de documento

listoptions

  • Inserir Linha em Branco: Insere uma nova linha em branco.
  • Seleção (ícone de olhos): Inclui\exclui fragmento de documento da Comunicação interativa.
  • Ignorar marcadores/números: Habilite para ignorar marcadores/numeração no fragmento de documento da lista.
  • Valores não preenchidos (informações): Indica o número de variáveis não preenchidas no fragmento do documento.

Salvar comunicações interativas como rascunho

Você pode usar a interface do usuário do agente para salvar um ou mais rascunhos de cada Comunicação interativa e recuperar o rascunho posteriormente para continuar trabalhando nela. Você pode especificar um nome diferente para cada rascunho para identificá-lo.

O Adobe recomenda executar essas instruções em sequência para salvar com êxito uma Comunicação interativa como rascunho.

Habilite o recurso Salvar como rascunho

Por padrão, o recurso Salvar como rascunho não é ativado. Execute as seguintes etapas para ativar o recurso:

  1. Implemente a ccrDocumentInstance Interface do Provedor de Serviços (SPI).

    O SPI permite salvar a versão de rascunho da Comunicação interativa no banco de dados com uma ID de rascunho como o identificador exclusivo. Essas instruções consideram que você tem conhecimento prévio sobre como criar um pacote OSGi usando um projeto Maven.

    Para obter exemplos de implementação de SPI, consulte Exemplo de implementação de SPI crDocumentInstance.

  2. Abra http://<hostname>:<port>/ system/console/bundles e toque em Instalar/atualizar para fazer upload do pacote OSGi. Verifique se o status do pacote carregado é exibido como Ativo. Reinicie o servidor se o status do pacote não for exibido como Ative.

  3. Ir para https://'[server]:[port]'/system/console/configMgr.

  4. Toque em Criar configuração de correspondência.

  5. Selecione Ativar Guardar Utilizando CCRDocumentInstanceService e toque em Guardar.

Salvar uma comunicação interativa como rascunho

Execute as seguintes etapas para salvar uma Comunicação interativa como rascunho:

  1. Selecione uma comunicação interativa no Forms Manager e toque em Abrir interface do usuário do agente.

  2. Faça as alterações apropriadas na interface do usuário do agente e toque em Salvar como rascunho.

  3. Especifique o nome do Rascunho no campo Nome e toque em Concluído.

Depois de salvar a Comunicação interativa como rascunho, toque em Salvar alterações para salvar mais alterações no rascunho.

Recuperar o rascunho de uma comunicação interativa

Depois de salvar uma Comunicação interativa como rascunho, você pode recuperá-la para continuar trabalhando nela. Recupere a comunicação interativa usando:

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

[] Os rascunhos se referem ao identificador exclusivo da versão de rascunho que é gerada após salvar uma Comunicação interativa como rascunho.

OBSERVAÇÃO

Se você fizer alterações na Comunicação interativa depois de salvá-la como um rascunho, a versão de rascunho não será aberta.

Exemplo de implementação de SPI ccrDocumentInstance

Implemente a SPI ccrDocumentInstance para salvar uma Comunicação interativa como rascunho. Veja a seguir uma amostra da implementação do SPI ccrDocumentInstance.

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;
    }
}

As operações save, update, get e getAll chamam o serviço de banco de dados para salvar uma Comunicação Interativa como rascunho, atualizar uma Comunicação Interativa, recuperar dados do banco de dados e recuperar dados de todas as Comunicações Interativas disponíveis no banco de dados. Este exemplo usa mySQLDataBaseServiceCRUD como o nome do serviço de banco de dados.

A tabela a seguir explica a amostra de implementação de SPI ccrDocumentInstance. Isso demonstra como as operações save, update, get e getAll chamam o serviço de banco de dados na implementação de amostra.

Operação

Exemplos de serviço de banco de dados

Você pode criar um rascunho para uma Comunicação interativa ou enviá-la diretamente. A API da operação de salvamento verifica se a Comunicação interativa é enviada como rascunho e inclui um nome de rascunho. A API chama o serviço mySQLDataBaseServiceCRUD com Save como método de entrada.



[#$sd1_sf1_dp9]

O serviço mySQLDataBaseServiceCRUD verifica Save como o método de entrada e gera uma ID de rascunho gerada automaticamente e a retorna ao AEM. A lógica para gerar uma ID de rascunho pode variar com base no banco de dados.



[#$sd1_sf1_dp13]

A API para a operação de atualização recupera o status do rascunho de Comunicação interativa e verifica se a Comunicação interativa inclui um nome de rascunho. A API chama o serviço mySQLDataBaseServiceCRUD para atualizar esse status no Banco de Dados.



[#$sd1_sf1_dp17]

O serviço mySQLDataBaseServiceCRUD verifica Update como o método de entrada e salva o status do rascunho Interativo de comunicação no banco de dados.

A API da operação get verifica se a Comunicação interativa inclui uma ID de rascunho. A API então chama o serviço mySQLDataBaseServiceCRUD com Get como o método de entrada para recuperar os dados da Comunicação interativa.

O serviço mySQLDataBaseServiceCRUD verifica Get como o método de entrada e recupera os dados da Comunicação interativa com base na ID de rascunho.



[#$sd1_sf1_dp29]

A API para a operação getAll chama o serviço mySQLGetALLData para recuperar dados para todas as Comunicações interativas salvas no banco de dados.

O serviço mySQLGetALLData recupera dados de todas as Comunicações interativas salvas no banco de dados.



[#$sd1_sf1_dp37]

Este é um exemplo do arquivo pom.xml que faz parte da implementação:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://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>
OBSERVAÇÃO

Certifique-se de atualizar a dependência aemfd-client-sdk para 6.0.160 no arquivo pom.xml.

Nesta página