DocumentaçãoAEM 6.4Guia do Forms

Adicionar ação/botão personalizado na interface do usuário Criar correspondência add-custom-action-button-in-create-correspondence-ui

Last update: Thu May 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • User
CAUTION
AEM 6.4 chegou ao fim do suporte estendido e esta documentação não é mais atualizada. Para obter mais detalhes, consulte nossa períodos de assistência técnica. Encontre as versões compatíveis here.

Visão geral overview

A solução Gerenciamento de correspondência permite adicionar ações personalizadas à interface do usuário Criar correspondência .

O cenário deste documento explica como criar um botão na Interface do usuário Criar correspondência para compartilhar uma carta como PDF de revisão anexada a um email.

Pré-requisitos prerequisites

Para concluir esse cenário, você precisa do seguinte:

  • Conhecimento do CRX e do JavaScript
  • Servidor LiveCycle

Cenário: Crie o botão na interface do usuário Criar correspondência para enviar uma carta para revisão scenario-create-the-button-in-the-create-correspondence-user-interface-to-send-a-letter-for-review

Adicionar um botão com uma ação (aqui, enviar carta para revisão) à interface do usuário Criar correspondência inclui:

  1. Adicionar o botão à interface do usuário Criar correspondência
  2. Adição do manuseio de ação de ação ao botão
  3. Adicionar o processo do LiveCycle para ativar a ação "manuseio

Adicione o botão à interface do usuário Criar correspondência add-the-button-to-the-create-correspondence-user-interface

  1. Ir para https://[server]:[port]/[ContextPath]/crx/de e faça logon como Administrador.

  2. Na pasta apps, crie uma pasta chamada defaultApp com caminho/estrutura semelhante à pasta defaultApp (localizada na pasta de configuração). Use as seguintes etapas para criar a pasta:

    • Clique com o botão direito do mouse no defaultApp no caminho a seguir e selecione Nó de sobreposição:

      /libs/fd/cm/config/defaultApp/

      Nó de sobreposição

    • Certifique-se de que a caixa de diálogo Sobrepor nó tenha os seguintes valores:

      Caminho: /libs/fd/cm/config/defaultApp/

      Localização da sobreposição: /apps/

      Corresponder tipos de nó: Verificado

      Nó de sobreposição

    • Clique em OK.

    • Clique em Salvar tudo.

  3. Faça uma cópia do arquivo acmExtensionsConfig.xml (existe na ramificação /libs) na ramificação /apps.

    • Vá para "/libs/fd/cm/config/defaultApp/acmExtensionsConfig.xml"

    • Clique com o botão direito do mouse no arquivo acmExtensionsConfig.xml e selecione Copiar.

      Copiar acmExtensionsConfig.xml

    • Clique com o botão direito do mouse no defaultApp pasta em "/apps/fd/cm/config/defaultApp/", e selecione Colar.

    • Clique em Salvar tudo.

  4. Clique duas vezes na cópia de acmExtentionsConfig.xml que você criou recentemente na pasta de aplicativos. O arquivo é aberto para edição.

  5. Localize o seguinte código:

    code language-xml 
    <?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. Para enviar uma carta por email, você pode usar o LiveCycle. Adicione uma tag customAction na tag modelExtension em acmExtensionsConfig.xml da seguinte maneira:

    code language-xml 
     <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>

    tag customAction

    A tag modelExtension tem um conjunto de tags secundárias customAction que configuram a ação, as permissões e a aparência do botão de ação. Veja a seguir a lista de tags de configuração customAction:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
    Nome Descrição
    name O nome alfanumérico da ação a ser executada. O valor dessa tag é obrigatório, deve ser exclusivo (dentro da tag modelExtension) e deve começar com um alfabeto.
    label O rótulo a ser exibido no botão de ação
    tooltip Texto de dica de ferramenta do botão, que é exibido quando o usuário passa o mouse sobre ele.
    styleName Nome do estilo personalizado que é aplicado no botão de ação.
    permissionName A ação correspondente é exibida somente se o usuário tiver a permissão especificada por permissionName. Quando você especifica o permissionName como forms-users, todos os usuários terão acesso a essa opção.
    actionHandler Nome totalmente qualificado da classe ActionHandler chamada quando o usuário clica no botão.

    Além dos parâmetros acima, pode haver configurações adicionais associadas a um customAction. Essas configurações adicionais são disponibilizadas para o manipulador por meio do objeto CustomAction .

    table 0-row-2 1-row-2 2-row-2 3-row-2
    Nome Descrição
    serviceName Se uma customAction contiver uma tag filho com o nome serviceName e, em seguida, ao clicar no botão/link relevante, um processo será chamado com o nome representado pela tag serviceName . Certifique-se de que esse processo tenha a mesma assinatura que o PostProcess da carta. Adicione o prefixo "Forms Workflow ->" no nome do serviço.
    Parâmetros contendo o prefixo cm_ no nome da tag Se uma customAction contiver tags filho que começam com o nome cm_, então no processo de publicação (seja o Processo de postagem da carta ou o processo especial representado pela tag serviceName ) esses parâmetros estarão disponíveis no código XML de entrada sob a tag relevante com o prefixo cm_ removido.
    actionName Sempre que um processo de publicação é devido a um clique, o XML enviado contém uma tag especial com nome na tag com o nome da ação do usuário.

  7. Clique em Salvar tudo.

Crie uma pasta de localidade com o arquivo de propriedades na ramificação /apps create-a-locale-folder-with-properties-file-in-the-apps-branch

O arquivo ACMExtensionsMessages.properties inclui rótulos e mensagens de dica de ferramenta de vários campos na interface do usuário Criar correspondência . Para que as ações/botões personalizados funcionem, faça uma cópia desse arquivo na ramificação /apps.

  1. Clique com o botão direito do mouse no locale no caminho a seguir e selecione Nó de sobreposição:

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

  2. Certifique-se de que a caixa de diálogo Sobrepor nó tenha os seguintes valores:

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

    Localização da sobreposição: /apps/

    Corresponder tipos de nó: Verificado

  3. Clique em OK.

  4. Clique em Salvar tudo.

  5. Clique com o botão direito do mouse no arquivo a seguir e selecione Copiar:

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

  6. Clique com o botão direito do mouse no locale no caminho a seguir e selecione Colar:

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

    O arquivo ACMExtensionsMessages.properties é copiado na pasta do local.

  7. Para localizar os rótulos da ação/botão personalizado recém-adicionado, crie o arquivo ACMExtensionsMessages.properties para o local relevante em /apps/fd/cm/config/defaultApp/locale/.

    Por exemplo, para localizar a ação/botão personalizado criado neste artigo, crie um arquivo chamado ACMExtensionsMessages_fr.properties com a seguinte entrada:

    loc.letterInstance.letterreview.label=Revue De Lettre

    Da mesma forma, é possível adicionar mais propriedades, como dica de ferramenta e estilo, neste arquivo.

  8. Clique em Salvar tudo.

Reinicie o pacote de blocos de construção do Adobe Asset Composer restart-the-adobe-asset-composer-building-block-bundle

Depois de fazer cada alteração no lado do servidor, reinicie o pacote Adobe Asset Composer Building Block. Neste cenário, os arquivos acmExtensionsConfig.xml e ACMExtensionsMessages.properties do lado do servidor são editados e, portanto, o pacote Adobe Asset Composer Building Block requer uma reinicialização.

NOTE
Talvez seja necessário limpar o cache do navegador.

  1. Ir para https://[host]:[port]/system/console/bundles. Se necessário, faça logon como Administrador.

  2. Localize o pacote Adobe Asset Composer Building Block. Reinicie o pacote: clique em Parar e em Iniciar.

    Bloco de construção do Adobe Asset Composer

Depois de reiniciar o pacote Adobe Asset Composer Building Block, o botão personalizado aparece na interface do usuário Criar correspondência. Você pode abrir uma carta na interface do usuário Criar correspondência para visualizar o botão personalizado.

Adicionar manipulação de ação ao botão add-action-handling-to-the-button

A interface de usuário Criar correspondência por padrão tem a implementação do ActionHandler no arquivo cm.domain.js no seguinte local:

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

Para manipulação de ação personalizada, crie uma sobreposição do arquivo cm.domain.js na ramificação /apps do CRX.

Lidar com a ação/botão ao clicar em ação/botão inclui lógica para:

  • Tornar a ação recém-adicionada visível/invisível: para fazer isso, substitua a função actionVisible() .
  • Ativar/desativar a ação recém-adicionada: feito substituindo a função actionEnabled() .
  • Manuseio real da ação quando o usuário clica no botão : feito substituindo a implementação da função handleAction() .

  1. Ir para https://[server]:[port]/[ContextPath]/crx/de. Se necessário, faça logon como Administrador.

  2. Na pasta apps, crie uma pasta chamada js na ramificação /apps do CRX com estrutura semelhante à seguinte pasta:

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

    Use as seguintes etapas para criar a pasta:

    1. Clique com o botão direito do mouse no js no caminho a seguir e selecione Nó de sobreposição:

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

    2. Certifique-se de que a caixa de diálogo Sobrepor nó tenha os seguintes valores:

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

      Localização da sobreposição: /apps/

      Corresponder tipos de nó: Verificado

    3. Clique em OK.

    4. Clique em Salvar tudo.

  3. Na pasta js , crie um arquivo chamado crcustomization.js com o código para a manipulação de ação do botão usando as seguintes etapas:

    1. Clique com o botão direito do mouse no js no caminho a seguir e selecione Criar > Criar arquivo:

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

      Nomeie o arquivo como crcustomization.js.

    2. Clique duas vezes no arquivo crcustomization.js para abri-lo no CRX.

    3. No arquivo , cole o seguinte código e clique em Salvar tudo:

      code language-none 
      /* 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>';

Adicionar o processo LiveCycle para ativar a ação manipulação add-the-livecycle-process-to-enable-action-span-class-acrolinxcursormarker-span-handling

Nesse cenário, ative os seguintes componentes, que fazem parte do arquivo components.zip anexado:

  • jar do componente DSC (DSCSample.jar)
  • Enviar carta para o processo de revisão LCA (SendLetterForReview.lca)

Baixe e descompacte o components.zip arquivo a ser obtido DSCSample.jar e SendLetterForReview.lca arquivos. Use esses arquivos conforme especificado nos procedimentos a seguir.

Obter arquivo

Configure o servidor do LiveCycle para executar o processo LCA configure-the-livecycle-server-to-run-the-lca-process

NOTE
Esta etapa é necessária somente se você estiver em uma "configuração OSGI e a integração LC é necessária para o tipo de personalização que você está implementando.

O processo LCA é executado no servidor do LiveCycle e requer o endereço do servidor e as credenciais de logon.

  1. Ir para https://[server]:[port]/system/console/configMgr e faça logon como Administrador.

  2. Localize Configuração do SDK do cliente do Adobe LiveCycle e clique em Editar (ícone de edição). O painel Configurações é aberto.

  3. Insira os detalhes a seguir e clique em Salvar:

    • Url Do Servidor: URL do servidor LC cujo serviço Enviar para revisão o código do manipulador de ação usa.
    • Nome do usuário: Nome de usuário administrador do servidor LC
    • Senha: Senha do nome de usuário administrador

    Configuração do SDK do cliente do Adobe LiveCycle

Instalar o LiveCycle Archive (LCA) install-livecycle-archive-lca

O processo LiveCycle necessário que habilita o processo de serviço de email.

NOTE
Para visualizar o que esse processo faz ou para criar um processo semelhante, você precisa do Workbench.

  1. Faça logon como Administrador no Livecycle Server adminui em https:/[lc server]/:[lc port]/adminui.

  2. Navegar para Home > Serviços > Aplicativos e Serviços > Gerenciamento de Aplicativos.

  3. Se o aplicativo SendLetterForReview já estiver presente, pule as etapas restantes neste procedimento; caso contrário, continue para as próximas etapas.

    Aplicativo SendLetterForReview na interface do usuário

  4. Clique em Importar.

  5. Clique em Escolher arquivo e selecione SendLetterForReview.lca.

    Selecione o arquivo SendLetterForReview.lca

  6. Clique em Visualizar.

  7. Selecionar Implantar ativos no tempo de execução quando a importação estiver concluída.

  8. Clique em Importar.

Adicionar ServiceName à lista Serviço Incluir na lista de permissões adding-servicename-to-the-allowlisted-service-list

Mencione no servidor do AEM os serviços do LiveCycle que você deseja acessar o servidor AEM.

  1. Faça logon como Administrador para https:/[host]/:[port]/system/console/configMgr.

  2. Localize e clique em Configuração do SDK do cliente do Adobe LiveCycle. O painel Configuração do SDK do cliente do Adobe LiveCycle é exibido.

  3. Na lista Nome do serviço, clique no ícone + e adicione um serviceName SendLetterForReview/SendLetterForReviewProcess.

  4. Clique em Salvar.

Configurar o serviço de email configure-the-email-service

Nesse cenário, para que o Gerenciamento de correspondência possa enviar um email, configure o serviço de email no servidor do LiveCycle.

  1. Faça logon com as credenciais de administrador no Livecycle Server adminui em https:/[lc server]:[lc port]/adminui.

  2. Navegar para Home > Serviços > Aplicativos e Serviços > Gerenciamento de Serviços.

  3. Localize e clique em EmailService.

  4. Em Host SMTP, configure o serviço de email.

  5. Clique em Salvar.

Configurar o serviço DSC configure-the-dsc-service

Para usar a API de gerenciamento de correspondência, baixe a variável DSCSample.jar (anexo ao presente documento como parte de components.zip) e carregue-o no servidor do LiveCycle. Depois que a variável DSCSample.jar for carregado no servidor do LiveCycle, o servidor do AEM usará o DSCSample.jar para acessar a API renderLetter.

Para obter mais informações, consulte Conectar o AEM Forms com o LiveCycle Adobe.

  1. Atualize o URL do servidor AEM em cmsa.properties em DSCSample.jar, que está no seguinte local:

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

  2. Forneça os seguintes parâmetros no arquivo de configuração:

    • crx.serverUrl=https:/[host]/:[porta]/[caminho do contexto]/[URL AEM]
    • crx.username= nome de usuário AEM
    • crx.password= AEM senha
    • crx.appRoot=/content/apps/cm
    note note
    NOTE
    Toda vez que você fizer alterações no lado do servidor, reinicie o Servidor.

    O DSCSample.jar O arquivo usa a variável renderLetter API. Para obter mais informações sobre a API renderCarta, consulte Interface LetterRenderService.

Importar DSC para o AEM Forms no JEE import-dsc-to-livecyle

DSCSample.jar O arquivo usa a variável renderLetter API para renderizar letras como PDF bytes de dados XML que C fornece como entrada. Para obter mais informações sobre o renderLetter e outras APIs, consulte Serviço de Renderização de Carta.

  1. Inicie o Workbench e faça logon.

  2. Selecionar Janela > Mostrar exibições > Componentes. A exibição Componentes é adicionada ao Workbench ES2.

  3. Clique com o botão direito do mouse Componentes e selecione Componente de instalação.

  4. Selecione o DSCSample.jar navegue pelo navegador de arquivos e clique em Abrir.

  5. Clique com o botão direito do mouse RenderWrapper e selecione Componente de início. Se o componente for iniciado, uma seta verde será exibida ao lado do nome do componente.

Enviar carta para revisão send-letter-for-review

Depois de configurar a ação e o botão para enviar a carta para revisão:

  1. Limpe o cache do navegador.

  2. Na interface do usuário Criar correspondência, clique em Revisão de Carta e especifique a ID de email do revisor.

  3. Clique em Enviar.

sendreview

O revisor recebe um email do sistema com a carta como anexo de PDF.

recommendation-more-help
a6ebf046-2b8b-4543-bd46-42a0d77792da