Use dados existentes para preencher previamente campos de um formulário adaptável.
É possível pré-preencher 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.
Um formulário adaptável pode ter vários campos vinculados e não vinculados. Campos vinculados são campos que são arrastados da guia Localizador de conteúdo e contêm valores de propriedade bindRef
não vazios 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 pré-preencher 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 afUnBoundData 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 para campos e painéis vinculados. Esses dados devem ser compatíveis com o schema de modelo de formulário associado:
<?xml version="1.0" encoding="UTF-8"?>
<afData>
<afBoundData>
<employeeData>
.
</employeeData>
</afBoundData>
<afUnboundData>
<data>
<textbox>Hello World</textbox>
.
.
<numericbox>12</numericbox>
.
.
</data>
</afUnboundData>
</afData>
{
"afBoundData": {
"employeeData": { }
},
"afUnboundData": {
"data": {
"textbox": "Hello World",
"numericbox": "12"
}
}
}
Para campos vinculados com o mesmo código de barras 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", "A" será automaticamente preenchido na segunda caixa de texto. Essa vinculação é chamada de vinculação ao vivo de campos de formulário adaptáveis.
A estrutura do XML de pré-preenchimento e do XML enviado para formulários adaptativos baseados em XFA é a seguinte:
Preencher estrutura XML: O formulário adaptativo com base em XFA deve ser compatível com o schema de dados do modelo de formulário XFA. Para preencher previamente campos não vinculados, vincule a estrutura XML de preenchimento prévio à tag /afData/afBoundData
.
Estrutura XML enviada: Quando nenhum XML de pré-preenchimento é usado, o XML enviado contém dados para os campos vinculados e não vinculados na tag afData
wrapper. Se um XML de pré-preenchimento for usado, o XML submetido terá a mesma estrutura do XML de pré-preenchimento. Se o prefill XML start com a tag raiz afData
, o XML de saída também terá o mesmo formato. Se o XML de pré-preenchimento não tiver afData/afBoundData
wrapper e, em vez disso, for start diretamente da tag raiz do schema como employeeData
, o XML submetido também será start com a tag employeeData
.
Prefill-Submit-Data-ContentPackage.zip
Obter
FileSample contendo dados de preenchimento prévio e dados enviados
A estrutura do XML de preenchimento prévio e do XML enviado para formulários adaptáveis com base no schema XML é a seguinte:
afData
wrapper. Se o XML de pré-preenchimento for usado, o XML submetido terá a mesma estrutura do XML de pré-preenchimento. Se o prefill XML start com a tag raiz afData
, o XML de saída terá o mesmo formato. Se o XML de pré-preenchimento não tiver um invólucro afData/afBoundData
e, em vez disso, start diretamente da tag raiz do schema como employeeData
, o XML submetido também será start 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 é schema XML, os dados são preenchidos previamente na tag afBoundData
, como mostrado na amostra 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>
É recomendável não usar campos não vinculados em painéis vinculados (painéis com bindRef
não vazios que foram criados ao arrastar componentes da guia Sidekick ou Fontes de dados). Pode causar perda de dados desses campos não vinculados. Além disso, recomenda-se que os nomes dos campos sejam exclusivos no formulário, especialmente para campos não vinculados.
<?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>
Para formulários adaptáveis baseados no schema JSON, a estrutura de JSON pré-preenchido e JSON enviado é descrita abaixo. Para obter mais informações, consulte Criar formulários adaptáveis usando o schema JSON.
{
"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 schema JSON, os dados são preenchidos previamente 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 o invólucro afData/afBoundData
:
{
"afData": {
"afUnboundData": {
"data": { "textbox": "Ignorance is bliss :) " }
},
"afBoundData": {
"data": { {
"user": {
"address": {
"city": "Noida",
"country": "India"
}}}}}}}
Abaixo está um exemplo sem afData/afBoundData
invólucro:
{
"user": {
"address": {
"city": "Noida",
"country": "India"
}}}
Usar campos não vinculados em painéis vinculados (painéis com bindRef não vazios que foram criados arrastando componentes da guia Sidekick ou Fontes de Dados) é não recomendado, pois pode causar perda de dados dos campos não vinculados. É recomendável que haja nomes de campos exclusivos no formulário, especialmente para campos não vinculados.
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 dos campos 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>
Para habilitar o serviço de preenchimento prévio, especifique a Configuração do serviço de preenchimento padrão na Configuração do console da Web AEM. Use as seguintes etapas para configurar o serviço de Prefill:
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.
Abra Configuração do Adobe Experience Manager Web Console usando o URL:
https://<servidor>:<porta>/system/console/configMgr
Procure e abra Configuração de Serviço de Pré-preenchimento Padrão.
Insira o local dos dados ou um regex (expressão regular) para Locais de arquivos de dados. Exemplos de locais de arquivos de dados válidos são:
Por padrão, o preenchimento prévio é permitido por meio de arquivos crx para todos os tipos de Forms adaptável (XSD, XDP, JSON, FDM e sem base em Modelo de formulário). O preenchimento prévio é permitido somente com arquivos JSON e XML.
O serviço de preenchimento prévio agora está configurado para seu formulário.
O protocolo crx cuida da segurança de dados pré-preenchidos e, portanto, é permitido por padrão. Preenchimento por meio de outros protocolos usando regex genérico pode causar vulnerabilidade. Na configuração, especifique uma configuração de URL segura para proteger seus dados.
Geralmente, os campos vinculados (schema de formulário) e não vinculados são criados no mesmo formulário adaptável, mas as exceções a seguir são repetíveis caso os limites sejam repetidos:
Como regra geral, não misture campos vinculados e não vinculados se eles estiverem intersecados em dados preenchidos pelo usuário final em campos não vinculados. Se possível, você deve modificar o schema ou o modelo de formulário XFA e adicionar uma entrada para campos não vinculados, de modo que também se torne vinculado e seus dados estejam disponíveis como outros campos nos dados enviados.
Os formulários adaptativos podem ser pré-preenchidos com dados do usuário no formato de dados de pré-preenchimento através dos seguintes protocolos quando configurados com regex válido:
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.
http://localhost:4502/content/forms/af/someAF.html?wcmmode=disabled&dataRef=file:///C:/Users/form-user/Downloads/somesamplexml.xml
O arquivo referenciado deve estar no mesmo servidor.
http://localhost:4502/content/forms/af/xml.html?wcmmode=disabled&dataRef=http://localhost:8000/somesamplexmlfile.xml
http://localhost:4502/content/forms/af/abc.html?wcmmode=disabled&dataRef=service://[SERVICE_NAME]/[IDENTIFIER]
Não há suporte para a transmissão de parâmetros de autenticação.
Você também pode definir o atributo data
em slingRequest
, onde o atributo data
é uma string contendo XML ou JSON, como 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 sequência de caracteres XML ou JSON simples que contenha 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 sua página com um tipo específico de cabeçalho. Para conseguir isso, você pode gravar 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 busca 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
Você pode usar o serviço de preenchimento prévio personalizado para os cenários, onde você lê constantemente os dados de uma fonte predefinida. O serviço de preenchimento prévio lê dados de fontes de dados definidas e preenche previamente 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.
O serviço de pré-preenchimento é um serviço OSGi e é empacotado por meio do pacote OSGi. Crie o pacote OSGi, carregue e instale-o em pacotes da AEM Forms. Antes de começar a criar o pacote:
Coloque o arquivo de dados (dados de preenchimento prévio) no repositório crx. Você pode colocar o arquivo em qualquer local na pasta \content do crx-repository.
O pacote estereotipado (pacote de serviço de preenchimento prévio de amostra) contém uma 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.
Abra o arquivo src\main\java\com\adobe\test\Prefill.java para edição.
No código, defina o valor de:
nodePath:
A variável de caminho do nó que aponta para o local do repositório crx contém o caminho do arquivo de dados (pré-preenchimento). Por exemplo, /content/prefilldata.xmllabel:
O parâmetro label especifica o nome de exibição do serviço. Por exemplo, Serviço de preenchimento padrãoSalve e feche o arquivo Prefill.java
.
Adicione o pacote AEM Forms Client SDK
ao caminho de compilação do projeto estereotipado.
Compile o projeto e crie o .jar para o pacote.
Para start do serviço de preenchimento prévio, carregue o arquivo JAR no AEM Forms Web Console e ative o serviço. Agora, os start de serviço aparecem no editor de formulários adaptáveis. Para associar um serviço de preenchimento prévio a um formulário adaptável: