Preencher previamente campos de formulário adaptáveis

Use dados existentes para preencher previamente campos de um formulário adaptável.

Introdução

É possível preencher previamente os campos de um formulário adaptável usando dados existentes. Quando um usuário abre um formulário, os valores desses campos são preenchidos previamente. Para preencher previamente os dados em um formulário adaptável, disponibilize os dados do usuário como um XML / JSON de preenchimento prévio no formato que adere à estrutura de dados de preenchimento prévio de formulários adaptáveis.

Estrutura dos dados de preenchimento prévio

Um formulário adaptável pode ter vários campos vinculados e não vinculados. Campos vinculados são campos que são arrastados a partir da guia Localizador de conteúdo e contêm valor de propriedade bindRef não vazio na caixa de diálogo de edição de campo. Campos não vinculados são arrastados diretamente do navegador de componentes do Sidekick e têm um valor bindRef vazio.

É possível preencher previamente os campos vinculados e não vinculados de um formulário adaptável. Os dados de preenchimento prévio contêm as seções afBoundData e afBoundData para preencher previamente os campos vinculados e não vinculados de um formulário adaptável. A seção afBoundData contém os dados de preenchimento prévio de campos e painéis vinculados. Esses dados devem ser compatíveis com o schema do modelo de formulário associado:

  • Para formulários adaptáveis usando o modelo de formulário XFA, use o preenchimento prévio XML compatível com o schema de dados do modelo XFA.
  • Para formulários adaptáveis usando XML schema, use o preenchimento prévio XML compatível com a estrutura do esquema XML.
  • Para formulários adaptáveis usando esquema JSON, use o preenchimento prévio JSON compatível com o esquema JSON.
  • Para formulários adaptáveis usando o esquema FDM, use o esquema de preenchimento prévio JSON compatível com o esquema FDM.
  • Para formulários adaptáveis com nenhum modelo de formulário, não há dados vinculados. Cada campo é um campo não vinculado e é preenchido usando o XML não vinculado.

Exemplo de estrutura XML de preenchimento prévio

<?xml version="1.0" encoding="UTF-8"?>
<afData>
  <afBoundData>
     <employeeData>
        .
     </employeeData>
  </afBoundData>

  <afUnboundData>
    <data>
      <textbox>Hello World</textbox>
         .
         .
      <numericbox>12</numericbox>
         .
         .
    </data>
  </afUnboundData>
</afData>

Exemplo de estrutura JSON de pré-preenchimento

{
   "afBoundData": {
      "employeeData": { }
   },
   "afUnboundData": {
      "data": {
         "textbox": "Hello World",
         "numericbox": "12"
      }
   }
}

Para campos vinculados com o mesmo bindref ou campos não vinculados com o mesmo nome, os dados especificados na tag XML ou no objeto JSON são preenchidos em todos os campos. Por exemplo, dois campos em um formulário são mapeados para o nome textbox nos dados de preenchimento prévio. Durante o tempo de execução, se o primeiro campo da caixa de texto contiver "A", o "A" será preenchido automaticamente na segunda caixa de texto. Esse vínculo é chamado de vínculo em tempo real de campos de formulário adaptáveis.

Formulário adaptável usando o modelo de formulário XFA

A estrutura do XML de preenchimento prévio e do XML enviado para formulários adaptáveis baseados em XFA é a seguinte:

  • Preencher Estrutura XML: O XML de preenchimento prévio para formulário adaptável baseado em XFA deve ser compatível com o schema de dados do template de formulário XFA. Para preencher previamente campos não vinculados, vincule a estrutura XML de preenchimento prévio na tag /afData/afBoundData .

  • Estrutura XML enviada: Quando nenhum XML de preenchimento é usado, o XML enviado contém dados para os campos vinculados e não vinculados na tag afData wrapper. Se um XML de preenchimento prévio for usado, o XML enviado terá a mesma estrutura do XML de preenchimento prévio. Se o XML de preenchimento prévio começar com a tag raiz afData, o XML de saída também terá o mesmo formato. Se o XML de preenchimento prévio não tiver afData/afBoundDatawrapper e, em vez disso, começar diretamente da tag raiz do esquema como employeeData, o XML enviado também começará com a tag employeeData .

Prefill-Submit-Data-ContentPackage.zip

Obter
FileSample contendo dados de preenchimento prévio e dados enviados

Formulários adaptáveis baseados em esquema XML 

A estrutura do XML de preenchimento prévio e do XML enviado para formulários adaptáveis com base no esquema XML é a seguinte:

  • Preencher estrutura XML previamente: O XML de preenchimento prévio deve ser compatível com o Esquema XML associado. Para preencher previamente campos não vinculados, vincule a estrutura XML de preenchimento prévio na tag /afData/afBoundData .
  • Estrutura XML enviada: se nenhum XML de preenchimento prévio for usado, o XML enviado conterá dados para os campos vinculados e não vinculados na tag afData wrapper. Se o XML de preenchimento prévio for usado, o XML enviado terá a mesma estrutura do XML de preenchimento prévio. Se o XML de preenchimento prévio começar com a tag raiz afData, o XML de saída terá o mesmo formato. Se o XML de preenchimento prévio não tiver o wrapper afData/afBoundData e, em vez disso, começar diretamente da tag raiz do schema, como employeeData, o XML enviado também começará com a tag employeeData.
<?xml version="1.0" encoding="utf-8" ?>
<xs:schema targetNamespace="https://adobe.com/sample.xsd"
            xmlns="https://adobe.com/sample.xsd"
            xmlns:xs="https://www.w3.org/2001/XMLSchema">

    <xs:element name="sample" type="SampleType"/>

    <xs:complexType name="SampleType">
        <xs:sequence>
            <xs:element name="noOfProjectsAssigned" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Para campos cujo modelo é esquema XML, os dados são preenchidos previamente na tag afBoundData , como mostrado na amostra de XML abaixo. Ele pode ser usado para preencher previamente um formulário adaptável com um ou mais campos de texto não vinculados.

<?xml version="1.0" encoding="UTF-8"?><afData>
  <afUnboundData>
    <data>
      <textbox>Ignorance is bliss :) </textbox>
    </data>
  </afUnboundData>
  <afBoundData>
    <data>
      <noOfProjectsAssigned>twelve</noOfProjectsAssigned>
    </data>
  </afBoundData>
</afData>
OBSERVAÇÃO

É recomendável não usar campos não vinculados em painéis vinculados (painéis com bindRef não vazio que foi criado ao arrastar componentes do Sidekick ou da guia Fontes de dados). Pode causar perda de dados desses campos não vinculados. Além disso, é recomendável que os nomes dos campos sejam exclusivos no formulário, especialmente para campos não vinculados.

Um exemplo sem o wrapper afData e afBoundData

<?xml version="1.0" encoding="UTF-8"?><config>
 <assignmentDetails descriptionOfAssignment="Some Science Project" durationOfAssignment="34" financeRelatedProject="1" name="Lisa" numberOfMentees="1"/>
 <assignmentDetails descriptionOfAssignment="Kidding, right?" durationOfAssignment="4" financeRelatedProject="1" name="House" numberOfMentees="3"/>
</config>

Formulários adaptáveis baseados em esquema JSON

Para formulários adaptáveis com base no esquema JSON, a estrutura do JSON de preenchimento prévio e do JSON enviado é descrita abaixo. Para obter mais informações, consulte Criação de formulários adaptáveis usando o esquema JSON.

  • Preencher estrutura JSON previamente: O JSON de preenchimento prévio deve ser compatível com o Esquema JSON associado. Como opção, ele pode ser incluído no objeto /afData/afBoundData se você quiser preencher previamente campos não vinculados também.
  • Estrutura JSON enviada: se nenhum JSON de preenchimento prévio for usado, o JSON enviado conterá dados para os campos vinculados e não vinculados na tag do wrapper afData. Se o JSON de preenchimento prévio for usado, o JSON enviado terá a mesma estrutura do JSON de preenchimento prévio. Se o JSON de preenchimento prévio começar com o objeto raiz afData, o JSON de saída terá o mesmo formato. Se o JSON de preenchimento prévio não tiver o wrapper afData/afBoundData e, em vez disso, começar diretamente do objeto raiz do esquema, como o usuário, o JSON enviado também inicia com o objeto do usuário.
{
    "id": "https://some.site.somewhere/entry-schema#",
    "$schema": "https://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "address": {
            "type": "object",
            "properties": {
    "name": {
     "type": "string"
    },
    "age": {
     "type": "integer"
}}}}}

Para campos que usam o modelo de esquema JSON, os dados são pré-preenchidos no objeto afBoundData , como mostrado na amostra JSON abaixo. Ele pode ser usado para preencher previamente um formulário adaptável com um ou mais campos de texto não vinculados. Abaixo está um exemplo de dados com afData/afBoundData wrapper:

{
  "afData": {
    "afUnboundData": {
      "data": { "textbox": "Ignorance is bliss :) " }
    },
    "afBoundData": {
      "data": { {
   "user": {
    "address": {
     "city": "Noida",
     "country": "India"
}}}}}}}

Abaixo está um exemplo sem afData/afBoundData wrapper:

{
 "user": {
  "address": {
   "city": "Noida",
   "country": "India"
}}}
OBSERVAÇÃO

Usar campos não vinculados em painéis vinculados (painéis com bindRef não vazio que foram criados ao arrastar componentes do Sidekick ou guia Fontes de dados) é não recomendado, pois pode causar perda de dados dos campos não vinculados. É recomendável ter nomes de campo exclusivos no formulário, especialmente para campos não vinculados.

Formulário adaptável sem modelo de formulário

Para formulários adaptáveis sem modelo de formulário, os dados para todos os campos estão sob a tag <data> de <afUnboundData> tag.

Além disso, tome nota do seguinte:

As tags XML para os dados do usuário enviados para vários campos são geradas usando o nome dos campos. Portanto, os nomes de campo devem ser exclusivos.

<?xml version="1.0" encoding="UTF-8"?><afData>
  <afUnboundData>
    <data>
      <radiobutton>2</radiobutton>
      <repeatable_panel_no_form_model>
        <numericbox>12</numericbox>
      </repeatable_panel_no_form_model>
      <repeatable_panel_no_form_model>
        <numericbox>21</numericbox>
      </repeatable_panel_no_form_model>
      <checkbox>2</checkbox>
      <textbox>Nopes</textbox>
    </data>
  </afUnboundData>
  <afBoundData/>
</afData>

Configuração do serviço de preenchimento prévio usando o Gerenciador de configuração

Para ativar o serviço de preenchimento prévio, especifique a Configuração do serviço de preenchimento prévio padrão na Configuração do console da Web AEM. Use as seguintes etapas para configurar o serviço de Preenchimento prévio:

OBSERVAÇÃO

A Configuração do serviço de preenchimento prévio é aplicável a formulários adaptáveis, formulários HTML5 e conjuntos de formulários HTML5.

  1. Abra Configuração do Console Web do Adobe Experience Manager usando o URL:
    https://<server>:<port>/system/console/configMgr

  2. Pesquise e abra Configuração Padrão do Serviço de Preenchimento.

    prefill_config

  3. Insira o local dos dados ou um regex (expressão regular) para os Data files locations. Exemplos de locais de arquivos de dados válidos são:

    • file:///C:/Users/public/Document/Prefill/.*
    • http://localhost:8000/somesamplexmlfile.xml
    OBSERVAÇÃO

    Por padrão, o preenchimento prévio é permitido por meio de arquivos crx para todos os tipos de Adaptive Forms (XSD, XDP, JSON, FDM e sem base no Modelo de formulário). O preenchimento prévio é permitido somente com arquivos JSON e XML.

  4. O serviço de preenchimento prévio agora está configurado para seu formulário.

    OBSERVAÇÃO

    O protocolo crx cuida da segurança de dados pré-preenchidos e, portanto, é permitido por padrão. Preencher via outros protocolos usando regex genérico pode causar vulnerabilidade. Na configuração, especifique uma configuração de URL segura para proteger seus dados.

O caso curioso de painéis repetíveis

Geralmente, campos vinculados (esquema de formulário) e não vinculados são criados no mesmo formulário adaptável, mas as exceções a seguir caso o vínculo seja repetível:

  • Painéis repetitivos não vinculados não são compatíveis com formulários adaptáveis usando o modelo de formulário XFA, XSD, esquema JSON ou esquema FDM.
  • Não use campos não vinculados em painéis repetitivos vinculados.
OBSERVAÇÃO

Como regra geral, não misture campos vinculados e não vinculados se eles forem cruzados em dados preenchidos pelo usuário final em campos não vinculados. Se possível, você deve modificar o esquema ou o modelo de formulário XFA e adicionar uma entrada para campos não vinculados, de modo que também se torne vinculada e seus dados estejam disponíveis como outros campos em dados enviados.

Protocolos compatíveis para o preenchimento prévio de dados do usuário

Os formulários adaptáveis podem ser preenchidos com dados do usuário no formato de dados de preenchimento prévio por meio dos seguintes protocolos quando configurados com regex válido:

O protocolo crx://

http://localhost:4502/content/forms/af/xml.html?wcmmode=disabled&dataRef=crx:///tmp/fd/af/myassets/sample.xml

O nó especificado deve ter uma propriedade chamada jcr:data e manter os dados.

O protocolo file:// 

http://localhost:4502/content/forms/af/someAF.html?wcmmode=disabled&dataRef=file:///C:/Users/form-user/Downloads/somesamplexml.xml

O arquivo de referência deve estar no mesmo servidor.

O protocolo https://

http://localhost:4502/content/forms/af/xml.html?wcmmode=disabled&dataRef=http://localhost:8000/somesamplexmlfile.xml

O protocolo service://

http://localhost:4502/content/forms/af/abc.html?wcmmode=disabled&dataRef=service://[SERVICE_NAME]/[IDENTIFIER]
  • SERVICE_NAME refere-se ao nome do serviço de preenchimento prévio OSGI. Consulte Criar e executar um serviço de preenchimento prévio.
  • IDENTIFIER refere-se a quaisquer metadados exigidos pelo serviço de preenchimento prévio OSGI para buscar os dados de preenchimento prévio. Um identificador para o usuário conectado é um exemplo de metadados que podem ser usados.
OBSERVAÇÃO

Não há suporte para transmitir parâmetros de autenticação.

Configuração do atributo de dados no slingRequest

Você também pode definir o atributo data em slingRequest, onde o atributo data é uma string contendo XML ou JSON, conforme mostrado no código de amostra abaixo (Exemplo é para XML):

<%
           String dataXML="<afData>" +
                            "<afUnboundData>" +
                                "<data>" +
                                    "<first_name>"+ "Tyler" + "</first_name>" +
                                    "<last_name>"+ "Durden " + "</last_name>" +
                                    "<gender>"+ "Male" + "</gender>" +
                                    "<location>"+ "Texas" + "</location>" +
                                    "</data>" +
                            "</afUnboundData>" +
                        "</afData>";
        slingRequest.setAttribute("data", dataXML);
%>

Você pode gravar uma string XML ou JSON simples contendo todos os seus dados e configurá-la em slingRequest. Isso pode ser feito facilmente no JSP do renderizador para qualquer componente, que você deseja incluir na página, onde é possível definir o atributo de dados slingRequest .

Por exemplo, onde você deseja um design específico para a página com um tipo específico de cabeçalho. Para fazer isso, você pode escrever seu próprio header.jsp, que pode ser incluído no componente da página e definir o atributo data.

Outro bom exemplo é um caso de uso em que você gostaria de preencher previamente os dados de logon por meio de contas sociais, como Facebook, Twitter ou LinkedIn. Nesse caso, você pode incluir um JSP simples em header.jsp, que obtém dados da conta do usuário e define o parâmetro de dados.

prefill-page component.zip

Obter
FileSample prefill.jsp no componente de página

Serviço de preenchimento prévio personalizado do AEM Forms

Você pode usar o serviço de preenchimento prévio personalizado para os cenários, onde os dados de uma fonte predefinida são constantemente lidos. O serviço de preenchimento prévio lê dados de fontes de dados definidas e preenche os campos do formulário adaptável com o conteúdo do arquivo de dados de preenchimento prévio. Também ajuda a associar permanentemente os dados pré-preenchidos a um formulário adaptável.

Criar e executar um serviço de preenchimento prévio

O serviço de pré-preenchimento é um serviço OSGi e é empacotado por meio do pacote OSGi. Crie o pacote OSGi, faça upload e instale-o nos pacotes do AEM Forms. Antes de começar a criar o pacote:

Criar um serviço de preenchimento prévio

O pacote estereotipado (pacote de serviço de preenchimento prévio de exemplo) contém a implementação de amostra do serviço de preenchimento prévio da AEM Forms. Abra o pacote estereotipado em um editor de código. Por exemplo, abra o projeto estereotipado no Eclipse para edição. Depois de abrir o pacote estereotipado em um editor de código, execute as seguintes etapas para criar o serviço.

  1. Abra o arquivo src\main\java\com\adobe\test\Prefill.java para edição.

  2. No código, defina o valor de:

    • nodePath: A variável do caminho do nó que aponta para o local do repositório crx contém o caminho do arquivo de dados (preenchimento prévio). Por exemplo, /content/prefilldata.xml
    • label: O parâmetro label especifica o nome de exibição do serviço. Por exemplo, Serviço de preenchimento prévio padrão

  3. Salve e feche o arquivo Prefill.java.

  4. Adicione o pacote AEM Forms Client SDK ao caminho de compilação do projeto estereotipado.

  5. Compile o projeto e crie o .jar para o pacote.

Iniciar e usar o serviço de preenchimento prévio

Para iniciar o serviço de pré-preenchimento, carregue o arquivo JAR no Console da Web do AEM Forms e ative o serviço. Agora, o serviço começa a aparecer no editor de formulários adaptáveis. Para associar um serviço de preenchimento prévio a um formulário adaptável:

  1. Abra o formulário adaptável no Editor do Forms e abra o painel Propriedades do Contêiner de formulário.
  2. No console Propriedades, navegue até AEM Forms container > Basic > Prefill Service.
  3. Selecione o Serviço de preenchimento prévio padrão e clique em Salvar. O serviço está associado ao formulário.

Nesta página