Adicionar um botão de ação personalizado na interface de Criar correspondência add-custom-action-button-in-create-correspondence-ui
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 você pode criar um botão na interface do usuário Criar correspondência para compartilhar uma correspondência como um PDF de revisão anexado a um email.
Pré-requisitos prerequisites
Para concluir este cenário, você precisa do seguinte:
- Conhecimento sobre CRX e JavaScript
- LiveCycle Server
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 uma carta para revisão) à interface do usuário Criar correspondência inclui:
- Adicionando o botão à Interface do Usuário Criar Correspondência
- Adição do controle de ação ao botão
- Adicionar o processo de LiveCycle para habilitar o controle de ações
Adicionar o botão à interface do usuário Criar correspondência add-the-button-to-the-create-correspondence-user-interface
-
Ir para
https://'[server]:[port]'/[ContextPath]/crx/de
e faça logon como Administrador. -
Na pasta de aplicativos, crie uma pasta chamada
defaultApp
com caminho/estrutura semelhante à pasta defaultApp (na pasta de configuração). Use as seguintes etapas para criar a pasta:-
Clique com o botão direito do mouse no defaultApp no seguinte caminho e selecione Sobrepor nó:
/libs/fd/cm/config/defaultApp/
-
Certifique-se de que a caixa de diálogo Sobrepor nó tenha os seguintes valores:
Caminho: /libs/fd/cm/config/defaultApp/
Local da sobreposição: /apps/
Corresponder Tipos de Nó: Marcado
-
Clique em OK.
-
Clique em Salvar tudo.
-
-
Faça uma cópia do arquivo acmExtensionsConfig.xml (existe na ramificação /libs) na ramificação /apps.
-
Acesse "/libs/fd/cm/config/defaultApp/acmExtensionsConfig.xml"
-
Clique com o botão direito no arquivo acmExtensionsConfig.xml e selecione Copiar.
-
Clique com o botão direito do mouse no defaultApp em "/apps/fd/cm/config/defaultApp/" e selecione Colar.
-
Clique em Salvar tudo.
-
-
Clique duas vezes na cópia do acmExtentionsConfig.xml recém-criado na pasta de aplicativos. O arquivo é aberto para edição.
-
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>
-
Para enviar uma carta por email, você pode usar o Forms Workflow do 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>
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. rótulo O rótulo a ser exibido no botão de ação dica de ferramenta Texto da dica de ferramenta do botão, que é exibido quando o usuário passa o mouse sobre o botão. styleName Nome do estilo personalizado aplicado ao 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 permissionName como forms-users
, todos os usuários terão acesso a essa opção.actionHandler Nome totalmente qualificado da classe ActionHandler que é chamada quando o usuário clica no botão. Além dos parâmetros acima, pode haver configurações adicionais associadas a uma 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 secundária com o nome serviceName, 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 que contêm o prefixo cm_ no nome da tag Se uma customAction contiver uma tag secundária começando com o nome cm_, em seguida, no pós-processo (seja ele Letter Post Process 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 posterior ocorre devido a um clique, o XML enviado contém uma tag especial com o nome na tag com o nome da ação do usuário. -
Clique em Salvar tudo.
Crie uma pasta de local 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.
-
Clique com o botão direito do mouse no localidade no seguinte caminho e selecione Sobrepor nó:
/libs/fd/cm/config/defaultApp/locale
-
Certifique-se de que a caixa de diálogo Sobrepor nó tenha os seguintes valores:
Caminho: /libs/fd/cm/config/defaultApp/locale
Local da sobreposição: /apps/
Corresponder Tipos de Nó: Marcado
-
Clique em OK.
-
Clique em Salvar tudo.
-
Clique com o botão direito do mouse no seguinte arquivo e selecione Copiar:
/libs/fd/cm/config/defaultApp/locale/ACMExtensionsMessages.properties
-
Clique com o botão direito do mouse no localidade no seguinte caminho e selecione Colar:
/apps/fd/cm/config/defaultApp/locale/
O arquivo ACMExtensionsMessages.properties é copiado na pasta locale.
-
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
De maneira similar, é possível adicionar mais propriedades, como de dica de ferramenta e estilo, neste arquivo.
-
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 de blocos de construção do Adobe Asset Composer. Nesse cenário, os arquivos acmExtensionsConfig.xml e ACMExtensionsMessages.properties no lado do servidor são editados e, portanto, o pacote de blocos de construção do Adobe Asset Composer requer uma reinicialização.
-
Ir para
https://[host]:'port'/system/console/bundles
. Se necessário, efetue login como Administrador. -
Localize o pacote de blocos de construção do Adobe Asset Composer. Reinicie o pacote: clique em Stop e em Start.
Depois de reiniciar o pacote de blocos de construção do Adobe Asset Composer, o botão personalizado é exibido na interface do usuário Criar correspondência. É possível abrir uma correspondência 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
Por padrão, a interface do usuário Criar correspondência implementa o ActionHandler no arquivo cm.domain.js no seguinte local:
/libs/fd/cm/ccr/gui/components/admin/clientlibs/ccr/js/cm.domain.js
Para manuseio de ação personalizada, crie uma sobreposição do arquivo cm.domain.js na ramificação /apps do CRX.
Manipular a ação/botão ao clicar na ação/botão inclui lógica para:
- Tornar a ação recém-adicionada visível/invisível: feito substituindo 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().
-
Ir para
https://'[server]:[port]'/[ContextPath]/crx/de
. Se necessário, efetue login como Administrador. -
Na pasta de aplicativos, 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:
-
Clique com o botão direito do mouse no js no seguinte caminho e selecione Sobrepor nó:
/libs/fd/cm/ccr/gui/components/admin/clientlibs/ccrui/js
-
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
Local da sobreposição: /apps/
Corresponder Tipos de Nó: Marcado
-
Clique em OK.
-
Clique em Salvar tudo.
-
-
Na pasta js, crie um arquivo chamado customization.js com o código para a manipulação de ação do botão usando as seguintes etapas:
-
Clique com o botão direito do mouse no js no seguinte caminho e selecione Criar > Criar arquivo:
/apps/fd/cm/ccr/gui/components/admin/clientlibs/ccrui/js
Nomeie o arquivo como crcustomization.js.
-
Clique duas vezes no arquivo crcustomization.js para abri-lo no CRX.
-
No arquivo, cole o código a seguir e clique em Salvar tudo:
code language-javascript /* 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">×</code></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 de LiveCycle para habilitar a ação manuseio 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 LCA do processo de revisão (SendLetterForReview.lca)
Baixe e descompacte o arquivo components.zip para obter os arquivos DSCSample.jar e SendLetterForReview.lca. Use esses arquivos conforme especificado nos procedimentos a seguir.
Obter arquivo
Configurar o LiveCycle Server para executar o processo LCA configure-the-livecycle-server-to-run-the-lca-process
O processo LCA é executado no servidor do LiveCycle e requer o endereço do servidor e as credenciais de login.
-
Ir para
https://'[server]:[port]'/system/console/configMgr
e faça logon como Administrador. -
Localize Configuração do SDK do cliente do LiveCycle Adobe e clique em Editar (ícone editar). O painel Configurações é aberto.
-
Insira os seguintes detalhes 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 de usuário: nome de usuário administrador do servidor LC
- Senha: Senha do nome de usuário Admin
Instalar o arquivo do LiveCycle (LCA) install-livecycle-archive-lca
O processo de LiveCycle necessário que habilita o processo do serviço de email.
-
Faça logon como Administrador no adminui do LiveCycle® Server em
https:/[lc server]/:[lc port]/adminui
. -
Navegue até Início > Serviços > Aplicativos e Serviços > Gerenciamento de Aplicativos.
-
Se o aplicativo SendLetterForReview já estiver presente, ignore as etapas restantes neste procedimento; caso contrário, continue para as próximas etapas.
-
Clique em Importar.
-
Clique em Escolher arquivo e selecione SendLetterForReview.lca.
-
Clique em Visualizar.
-
Selecionar Implantar ativos para tempo de execução quando a importação for concluída.
-
Clique em Importar.
Adicionando ServiceName à lista de serviços de Inclui na lista de permissões adding-servicename-to-the-allowlist-service-list
Mencione no servidor Experience Manager os serviços de LiveCycle que você deseja que acessem o servidor Experience Manager.
-
Efetue login como administrador em
https:/[host]:'port'/system/console/configMgr
. -
Localize e clique em Configuração do SDK do cliente do LiveCycle Adobe. O painel Configuração do SDK do cliente do LiveCycle do Adobe é exibido.
-
Na lista Nome do serviço, clique no ícone + e adicione um serviceName EnviarCartaParaRevisão/EnviarCartaParaProcessoDeRevisão.
-
Clique em Salvar.
Configurar o serviço de email configure-the-email-service
Nesse cenário, para que o Gerenciamento de correspondências possa enviar um email, configure o serviço de email no servidor do LiveCycle.
-
Faça logon com credenciais de Administrador para LiveCycle Server adminui em
https:/[lc server]:[lc port]/adminui
. -
Navegue até Home > Serviços > Aplicativos e Serviços > Gerenciamento de Serviços.
-
Localize e clique em ServiçoEmail.
-
Entrada Host SMTP, configure o serviço de email.
-
Clique em Salvar.
Configurar o serviço DSC configure-the-dsc-service
Para usar a API do Gerenciamento de correspondências, baixe o DSCSample.jar (anexado neste documento como parte do components.zip) e faça upload dele para o servidor do LiveCycle. Depois que o arquivo DSCSample.jar é carregado no servidor do LiveCycle, o servidor do Experience Manager usa o arquivo DSCSample.jar para acessar a API renderLetter.
Para obter mais informações, consulte Conectar o AEM Forms com o LiveCycle Adobe.
-
Atualize o URL do servidor Experience Manager no cmsa.properties em DSCSample.jar, que está no seguinte local:
DSCSample.jar\com\adobe\livecycle\cmsa.properties
-
Forneça os seguintes parâmetros no arquivo de configuração:
- crx.serverUrl=https:/host:port/[caminho do contexto]/[URL do AEM]
- crx.username= nome de usuário Experience Manager
- crx.password= senha do Experience Manager
- crx.appRoot=/content/apps/cm
note note NOTE Toda vez que você fizer alterações no lado do servidor, reinicie o Servidor do LiveCycle. O arquivo DSCSample.jar usa a API renderLetter. Para obter mais informações sobre a API renderLetter, consulte Interface LetterRenderService.
Importar DSC para o LiveCycle import-dsc-to-livecyle
O arquivo DSCSample.jar usa a API renderLetter para renderizar a letra como bytes de PDF dos dados XML que o DSC fornece como entrada. Para obter mais informações sobre renderLetter e outras APIs, consulte Serviço de renderização de carta.
-
Inicie o Workbench e faça logon.
-
Selecionar Janela > Mostrar exibições > Componentes. A visualização Componentes é adicionada ao Workbench ES2.
-
Clique com o botão direito do mouse Componentes e selecione Instalar componente.
-
Selecione o DSCSample.jar arquivo por meio do navegador de arquivos e clique em Abertura.
-
Clique com o botão direito do mouse RenderWrapper e selecione Iniciar componente. Se o componente for iniciado, uma seta verde aparecerá 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:
-
Limpe o cache do navegador.
-
Na interface de Criar correspondência, clique em Revisão da carta e especifique a ID de email do revisor.
-
Clique em Enviar.
O revisor recebe um email do sistema com a carta como um anexo PDF.