Criar uma ação enviar personalizada para o Forms adaptável writing-custom-submit-action-for-adaptive-forms

Versão
Link do artigo
AEM 6.5
Clique aqui
AEM as a Cloud Service
Este artigo

Um Formulário adaptável fornece várias Ações de envio prontas para uso (OOTB). Uma Ação de envio especifica detalhes das ações a serem executadas nos dados coletados por meio do Formulário adaptável. Por exemplo, enviar dados em um email.

Você pode criar uma Ação enviar personalizada para adicionar funcionalidades não incluídas em Ações de envio prontas para uso ou não suportado por meio de uma única Ação de envio OOTB. Por exemplo, enviar dados para um fluxo de trabalho, salvar os dados em um armazenamento de dados, enviar uma notificação por email à pessoa que envia o formulário e enviar um email à pessoa responsável pelo processamento do formulário enviado para aprovações e rejeições por meio de uma única Ação de envio.

Formato de dados XML xml-data-format

Os dados XML são enviados para o servlet usando o jcr:data parâmetro de solicitação. As Ações de envio podem acessar o parâmetro para processar os dados. O código a seguir descreve o formato dos dados XML. Os campos vinculados ao modelo de formulário aparecem na variável afBoundData seção. Os campos não vinculados aparecem no afUnoundDataseção.

<?xml ?>
<afData>
<afUnboundData>
<data>
<field1>value</field2>
<repeatablePanel>
    <field2>value</field2>
</repeatablePanel>
<repeatablePanel>
    <field2>value</field2>
</repeatablePanel>
</data>
</afUnboundData>
<afBoundData>
<!-- xml corresponding to the Form Model /XML Schema -->
</afBoundData>
</afData>

Campos de ação action-fields

Uma ação enviar pode adicionar campos de entrada ocultos (usando o HTML entrada tag) para o HTML de formulário renderizado. Esses campos ocultos podem conter valores necessários ao processar o envio do formulário. Ao enviar o formulário, esses valores de campo são postados de volta como parâmetros de solicitação que a Ação de envio pode usar durante o manuseio do envio. Os campos de entrada são chamados de campos de ação.

Por exemplo, uma Ação enviar que também capture o tempo necessário para preencher um formulário pode adicionar os campos de entrada ocultos startTime e endTime.

Um script pode fornecer os valores de startTime e endTime campos quando o formulário é renderizado e antes do envio do formulário, respectivamente. O script Enviar Ação post.jsp Em seguida, o pode acessar esses campos usando parâmetros de solicitação e calcular o tempo total necessário para preencher o formulário.

Anexos de arquivo file-attachments

As Ações de envio também podem usar os anexos de arquivo dos quais você faz upload usando o componente Anexo de arquivo. Os scripts de ação enviar podem acessar esses arquivos usando o sling API RequestParameter. A variável isFormField O método da API ajuda a identificar se o parâmetro de solicitação é um campo de arquivo ou de formulário. Você pode iterar sobre os parâmetros da Solicitação em uma Ação de envio para identificar os parâmetros de Anexo de arquivo.

O código de exemplo a seguir identifica os anexos de arquivo na solicitação. Em seguida, lê os dados no arquivo usando o Obter API. Por fim, ele cria um objeto Documento usando os dados e o anexa a uma lista.

RequestParameterMap requestParameterMap = slingRequest.getRequestParameterMap();
for (Map.Entry<String, RequestParameter[]> param : requestParameterMap.entrySet()) {
    RequestParameter rpm = param.getValue()[0];
    if(!rpm.isFormField()) {
        fileAttachments.add(new Document(rpm.get()));
    }
}

Ao anexar arquivos ao Formulário adaptável, o servidor valida os anexos de arquivo após o envio do Formulário adaptável e retorna uma mensagem de erro se:

  • Os anexos de arquivo incluem um nome de arquivo que começa com (.) caractere, contém \ / : * ? " < > | ; % $ caracteres ou contém nomes de arquivo especiais reservados para o sistema operacional Windows, como nul, prn, con, lptou com.

  • O tamanho do anexo de arquivo é de 0 bytes.

  • O formato do anexo de arquivo não está definido no Tipos de arquivo suportados ao configurar o componente Anexo de arquivo em um Formulário adaptável.

Caminho de encaminhamento e URL de redirecionamento forward-path-and-redirect-url

Depois de executar a ação necessária, o servlet Submit encaminha a solicitação para o caminho de encaminhamento. Uma ação usa a API setForwardPath para definir o caminho de encaminhamento no servlet Guide Submit.

Se a ação não fornecer um caminho de encaminhamento, o servlet Submit redirecionará o navegador usando o URL de redirecionamento. O autor configura o URL de redirecionamento usando a configuração da página de agradecimento na caixa de diálogo Edição do formulário adaptável. Você também pode configurar o URL de redirecionamento por meio da Ação enviar ou da API setRedirectUrl no servlet Guide Submit. Você também pode configurar os parâmetros de Solicitação enviados para o URL de redirecionamento usando a API setRedirectParameters no servlet de Envio do guia.

NOTE
Um autor fornece o URL de redirecionamento (usando a Configuração da página de agradecimento). Ações de envio OOTB use o URL de redirecionamento para redirecionar o navegador a partir do recurso ao qual o caminho de encaminhamento faz referência.
Você pode escrever uma ação enviar personalizada que encaminhe uma solicitação para um recurso ou servlet. A Adobe recomenda que o script que executa o tratamento de recursos para o caminho de encaminhamento redirecione a solicitação para o URL de redirecionamento quando o processamento for concluído.

Ação de envio submit-action

Uma ação enviar é uma sling:Folder que inclui o seguinte:

  • addfields.jsp: esse script fornece os campos de ação que são adicionados ao arquivo de HTML durante a representação. Use esse script para adicionar os parâmetros de entrada ocultos necessários durante o envio no script post.POST.jsp.

  • dialog.xml: Esse script é semelhante à caixa de diálogo Componente CQ. Ela fornece informações de configuração que o autor personaliza. Os campos são exibidos na guia Enviar Ações na caixa de diálogo Editar formulário adaptável ao selecionar a Ação de envio.

  • post.POST.jsp: O servlet Submit chama esse script com os dados enviados e os dados adicionais nas seções anteriores. Qualquer menção de executar uma ação nesta página implica executar o script post.POST.jsp. Para registrar a Ação de envio com o Forms adaptável a ser exibido na caixa de diálogo Edição do formulário adaptável, adicione essas propriedades à sling:Folder:

    • guideComponentType do tipo String e valor fd/af/components/guidesubmittype

    • guideDataModel do tipo String que especifica o tipo de Formulário adaptável ao qual a Ação enviar se aplica. xsd O é compatível com o Adaptive Forms baseado em XSD. básico O é compatível com o Adaptive Forms que não usam XDP ou XSD. Para exibir a ação em vários tipos de Forms adaptável, adicione as cadeias de caracteres correspondentes. Separe cada string por vírgula. Por exemplo, para tornar uma ação visível em Forms adaptável baseado em XSD, especifique o valor como xsd.

    • jcr:description do tipo String. O valor dessa propriedade é exibido na lista Ação de envio na guia Ações de envio da caixa de diálogo Edição do formulário adaptável. As ações OOTB estão presentes no repositório CRX no local /libs/fd/af/components/guidesubmittype.

    • submitService do tipo String. Para obter mais informações, consulte Programar envio do formulário adaptável para ações personalizadas.

Criação de uma Ação de envio personalizada creating-a-custom-submit-action

Execute as seguintes etapas para criar uma Ação enviar personalizada que salve os dados no repositório CRX e envie um email a você. O formulário adaptável contém o conteúdo do armazenamento de ação de envio OOTB (desaprovado) que salva os dados no repositório CRX. Além disso, o AEM fornece uma E-mail API que pode ser usada para enviar emails. Antes de usar a API de email, configure o serviço Day CQ Mail por meio do console do sistema. Você pode reutilizar a ação Armazenar conteúdo (obsoleto) para armazenar os dados no repositório. A ação Armazenar conteúdo (desaprovado) está disponível no local /libs/fd/af/components/guidesubmittype/store no repositório CRX.

  1. Faça logon no CRXDE Lite no URL https://<server>:<port>/crx/de/index.jsp. Crie um nó com a propriedade sling:Folder e o nome store_and_mail na pasta /apps/custom_submit_action. Crie a pasta custom_submit_action se ela ainda não existir.

    Captura de tela que representa a criação de um nó com a propriedade sling:Folder

  2. Forneça os campos de configuração obrigatórios.

    Adicione a configuração exigida pela ação Armazenar. Copie o cq:dialog nó da ação Armazenar de /libs/fd/af/components/guidesubmittype/store para a pasta de ação em /apps/custom_submit_action/store_and_email.

    Captura de tela mostrando a cópia do nó da caixa de diálogo para a pasta de ação

  3. Forneça campos de configuração para solicitar ao autor a configuração de email.

    O Formulário adaptável também fornece uma ação Email que envia emails para os usuários. Personalize esta ação com base em suas necessidades. Navegue até /libs/fd/af/components/guidesubmittype/email/dialog. Copie os nós no nó cq:dialog para o nó cq:dialog da sua ação enviar (https://experienceleague.adobe.com/apps/custom_submit_action/store_and_email/dialog?lang=pt-BR).

    Personalização da ação de email

  4. Disponibilize a ação na caixa de diálogo Edição do formulário adaptável.

    Adicione as seguintes propriedades no nó store_and_email:

    • guideComponentType do tipo String e valor fd/af/components/guidesubmittype

    • guideDataModel do tipo String e valor xsd, básico

    • jcr:description do tipo String e valor Ação de armazenamento e email

    • submitService do tipo String e valor Armazenamento e email. Para obter mais informações, consulte Programar envio do formulário adaptável para ações personalizadas.

  5. Abra qualquer Formulário adaptável. Clique em Editar botão ao lado de Início para abrir o Editar do contêiner Formulário adaptável. A nova ação é exibida na janela Ações de envio Guia. Selecionar o Ação de armazenamento e email exibe a configuração adicionada no nó de diálogo.

    Caixa de diálogo de configuração Enviar ação

  6. Use a ação para concluir uma tarefa.

    Adicione o script post.POST.jsp à sua ação. (https://experienceleague.adobe.com/apps/custom_submit_action/store_and_mail/?lang=pt-BR).

    Execute a ação de armazenamento OOTB (script post.POST.jsp). Use o FormsHelper.runAction(java.lang.String, java.lang.String, org.apache.sling.api.resource.Resource, org.apache.sling.api.SlingHttpServletRequest, org.apache.sling.api.SlingHttpServletResponse)) API fornecida pelo CQ no código para executar a ação Armazenar. Adicione o seguinte código no arquivo JSP:

    FormsHelper.runAction("/libs/fd/af/components/guidesubmittype/store", "post", resource, slingRequest, slingResponse);

    Para enviar o email, o código lê o endereço de email do recipient na configuração. Para buscar o valor de configuração no script da ação, leia as propriedades do recurso atual usando o código a seguir. Da mesma forma, você pode ler os outros arquivos de configuração.

    ValueMap properties = ResourceUtil.getValueMap(resource);

    String mailTo = properties.get("mailTo");

    Por fim, use a API de email do CQ para enviar o email. Use o SimpleEmail para criar o Objeto de email conforme representado abaixo:

    note note
    NOTE
    Verifique se o arquivo JSP tem o nome post.POST.jsp.
    code language-java
    <%@include file="/libs/fd/af/components/guidesglobal.jsp" %>
    <%@page import="com.day.cq.wcm.foundation.forms.FormsHelper,
           org.apache.sling.api.resource.ResourceUtil,
           org.apache.sling.api.resource.ValueMap,
                    com.day.cq.mailer.MessageGatewayService,
      com.day.cq.mailer.MessageGateway,
      org.apache.commons.mail.Email,
                    org.apache.commons.mail.SimpleEmail" %>
    <%@taglib prefix="sling"
                    uri="https://sling.apache.org/taglibs/sling/1.0" %>
    <%@taglib prefix="cq"
                    uri="https://www.day.com/taglibs/cq/1.0"
    %>
    <cq:defineObjects/>
    <sling:defineObjects/>
    <%
            String storeContent =
                        "/libs/fd/af/components/guidesubmittype/store";
            FormsHelper.runAction(storeContent, "post", resource,
                                    slingRequest, slingResponse);
     ValueMap props = ResourceUtil.getValueMap(resource);
     Email email = new SimpleEmail();
     String[] mailTo = props.get("mailto", new String[0]);
     email.setFrom((String)props.get("from"));
            for (String toAddr : mailTo) {
                email.addTo(toAddr);
       }
     email.setMsg((String)props.get("template"));
     email.setSubject((String)props.get("subject"));
     MessageGatewayService messageGatewayService =
                        sling.getService(MessageGatewayService.class);
     MessageGateway messageGateway =
                    messageGatewayService.getGateway(SimpleEmail.class);
     messageGateway.send(email);
    %>
    

    Selecione a ação no Formulário adaptável. A ação envia um email e armazena os dados.

Usar a propriedade submitService para ações de envio personalizadas submitservice-property

Ao definir a Ação enviar personalizada, que inclui a variável submitService propriedade, o formulário aciona a variável FormSubmitActionService no envio. A variável FormSubmitActionService usa o getServiceName método para recuperar o valor do submitService propriedade. Com base no valor de submitService propriedade, o serviço chama o método de envio apropriado. Inclua o FormSubmitActionService no pacote personalizado que você carregou na AEM Forms servidor.

Adicione o submitService propriedade do tipo string para o sling:Folder da sua ação enviar personalizada para habilitar Adobe Sign para o Formulário adaptável. É possível selecionar a variável Ativar o Adobe Sign opção no Assinatura eletrônica das propriedades do contêiner de Formulário adaptável somente após definir o valor para o submitService propriedade da sua Ação de envio personalizada.

Enviar propriedade de serviço

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab