Conjunto de formulários no AEM Forms form-set-in-aem-forms

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

Tópicos:

Criado para:

Usuário

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

Geralmente, seus clientes precisam enviar vários formulários para se candidatarem a um serviço ou benefício. Implica encontrar todas as formas pertinentes; e preenchê-las, enviá-las e rastreá-las separadamente. Além disso, é necessário que eles preencham detalhes comuns várias vezes em formulários. Todo o processo se torna complicado e sujeito a erros se envolver um grande número de formulários. O recurso de conjunto de formulários do AEM Forms pode ajudar a simplificar a experiência do usuário em tais cenários.

Um conjunto de formulários é uma coleção de formulários HTML5 agrupados e apresentados como um único conjunto de formulários para os usuários finais. Quando os usuários finais começam a preencher um conjunto de formulários, eles são perfeitamente transitados de um formulário para outro. No final, eles podem enviar todos os formulários com apenas um clique.

O AEM Forms fornece aos autores de formulários uma interface de usuário intuitiva para criar, configurar e gerenciar conjuntos de formulários. Como autor, você pode ordenar os formulários em uma sequência específica que você deseja que os usuários finais sigam. Além disso, você pode aplicar condições ou expressões de qualificação em formulários individuais para controlar sua visibilidade com base em entradas do usuário. Por exemplo, você pode configurar o formulário de detalhes do cônjuge para aparecer somente quando o status civil especificar como Casado.

Além disso, é possível configurar campos comuns em diferentes formulários para compartilhar vínculos de dados comuns. Com vínculos de dados adequados em vigor, os usuários finais devem preencher informações comuns somente uma vez que sejam preenchidas automaticamente nos formulários subsequentes.

Os conjuntos de formulários também são suportados no aplicativo AEM Forms, permitindo que a força de trabalho de campo assuma um conjunto de formulários offline, visite os clientes, insira dados e sincronize com o servidor AEM Forms posteriormente para enviar dados de formulários a processos comerciais.

Criação e gerenciamento do conjunto de formulários creating-and-managing-form-set

É possível associar vários XDPs ou Modelos de formulário, criados usando o Designer, em um conjunto de formulários. Os conjuntos de formulários podem ser usados para renderizar seletivamente os XDPs com base nos valores inseridos pelos usuários nos formulários iniciais e em seus perfis.

Use Interface do usuário do AEM Forms para gerenciar todos os formulários, conjuntos de formulários e ativos relacionados.

Criar um conjunto de formulários create-a-form-set

Para criar um conjunto de formulários, faça o seguinte:

Selecione Forms > Forms e Documentos.
Selecione Criar > Conjunto de formulários.
Na página Adicionar propriedades , adicione os detalhes a seguir e clique em Avançar.
- Título: Especifica o título do documento. O título ajuda a identificar o conjunto de formulários na interface do usuário do AEM Forms.
- Descrição: Especifica as informações detalhadas sobre o documento.
- Tags: Especifica tags para identificar exclusivamente o conjunto de formulários. As tags ajudam a pesquisar o conjunto de formulários. Para criar tags, digite novos nomes de tags na caixa Tags .
- Enviar URL: Especifica o URL no qual os dados enviados são publicados no caso de renderização independente do conjunto de formulários (caso de uso de aplicativos não AEM Forms). Os dados são enviados para esse terminal como dados multipart/formdata com o seguinte parâmetro de solicitação:
- dataXML: Esse parâmetro contém uma representação XML dos dados enviados do conjunto de formulários. Se todos os formulários no conjunto de formulários usarem um esquema comum, o XML será gerado de acordo com esse esquema. Caso contrário, a tag raiz XML contém uma tag filho para cada formulário preenchido no conjunto de formulários que contém dados para os anexos do formulário.
- formsetPath: O caminho do conjunto de formulários no CRXDE, que foi enviado.
- Perfil de HTML Render: É possível configurar determinadas opções, como campos flutuantes, anexos e suporte a rascunho (para renderização independente de conjuntos de formulários) para personalizar a aparência, o comportamento e as interações do conjunto de formulários. Você pode personalizar ou estender o perfil existente para alterar qualquer configuração de perfil do HTML Form.

A tela Selecionar formulário(s) exibe os formulários XDP ou arquivos XDP disponíveis. Pesquise e selecione os formulários que serão incluídos no conjunto de formulários e clique em Adicionar ao conjunto de formulários. Se necessário, procure novamente formulários para adicionar. Depois de adicionar todos os formulários ao conjunto de formulários, clique em Avançar.

note note
NOTE
Certifique-se de que os nomes de campo em formulários XDP não contenham o caractere de ponto. Caso contrário, os scripts que tentam resolver os campos, que têm caracteres de ponto, não poderão resolvê-los.

Na página Configurar formulários, é possível fazer o seguinte:

Pedido do formulário: Arraste e solte os formulários para reorganizá-los. A ordem do formulário define a ordem em que os formulários são mostrados ao usuário final no aplicativo AEM Forms e na representação independente.
Identificador de formulário: Especifica uma identidade exclusiva para os formulários a serem usados em expressões de elegibilidade.
Raiz dos dados: Para cada formulário no conjunto de formulários, o Autor pode configurar o XPATH no qual os dados desse formulário específico são posicionados no XML enviado. Por padrão, o valor é /. Se todos os formulários no conjunto de formulários forem vinculados ao esquema e compartilharem o mesmo esquema XML, você poderá alterar esse valor. Recomenda-se que cada campo no formulário tenha um vínculo de dados adequado especificado no XDP. Se dois campos em dois formulários diferentes compartilharem o vínculo de dados comum, o campo no segundo formulário mostrará valores pré-preenchidos a partir do primeiro formulário. Não vincule dois subformulários com o mesmo conteúdo interno ao mesmo nó XML. Para obter mais informações sobre a estrutura XML do conjunto de formulários, consulte Preencher XML para o conjunto de formulários.
Expressão de elegibilidade: Especifica uma expressão JavaScript que avalia um valor booleano e indica se um formulário no conjunto de formulários está qualificado para preenchimento. Se falso, o usuário não é solicitado ou nem mesmo exibido ao formulário para preencher. Normalmente, a expressão se baseia nos valores dos campos capturados antes deste formulário. As expressões também contêm chamadas para o conjunto de formulários API fs.valueOf para extrair os valores preenchidos pelo usuário em um campo de um formulário do conjunto de formulários:

fs.valueOf(<form identifier="">, <fieldsom expression="">) > <value>

Por exemplo, se você tiver dois formulários no conjunto de formulários: despesas de negócios e despesas de viagem, é possível adicionar um trecho de JavaScript no campo Expressão de elegibilidade para ambos os formulários para verificar a entrada do usuário quanto ao tipo de despesa em um formulário. Se o usuário escolher Despesa de Negócios, o formulário Despesa de Negócios será renderizado para o usuário final. Ou se o usuário escolher a despesa de viagem, um formulário diferente será renderizado para o usuário final. Para obter mais informações, consulte Expressão de elegibilidade.

Além disso, o Autor também pode optar por remover um formulário do conjunto de formulários usando o ícone Excluir presente no canto direito de cada linha ou adicionar outro conjunto de formulários usando o + ícone ' na barra de ferramentas. Este '+ O ícone ' redireciona o usuário para a etapa anterior do assistente, que foi usada para 'Selecionar formulário(s)'. As seleções existentes são mantidas e qualquer seleção adicional feita deve ser adicionada ao conjunto de formulários usando o ícone Adicionar ao conjunto de formulários nessa página.

Conjunto de formulários: Configurar formulários

note note
NOTE
Todos os formulários usados no conjunto de formulários são gerenciados pela interface do usuário do AEM Forms.

Gerenciamento de um conjunto de formulários managing-a-form-set

Depois que um conjunto de formulários é criado, é possível executar as seguintes ações nesse conjunto de formulários:

Clique uma vez em: Quando o conjunto de formulários é criado e listado na página principal do ativo, é possível clicar uma vez no conjunto de formulários para exibi-lo. Um conjunto de formulários é aberto e exibe todos os modelos de formulário (XDPs) nesse conjunto de formulários.
Editar: Ao clicar em Editar após selecionar um conjunto de formulários, a tela Configurar formulários, que é mostrada acima em Etapas para criar um conjunto de formulários, é aberta. Você pode executar todas as funcionalidades descritas aqui.
Copiar + Colar: Isso permite copiar todo o conjunto de formulários de um local e colá-lo no mesmo local ou em qualquer outro local ou pasta.
Download: É possível baixar o conjunto de formulários com todas as suas dependências.
Iniciar/Gerenciar Revisão: Depois que o conjunto de formulários é criado, é possível configurar sua revisão clicando em Iniciar revisão. Depois que a revisão de um conjunto de formulários for iniciada, a opção Gerenciar revisão será exibida ao usuário. Na tela Gerenciar revisão, é possível atualizar/encerrar a revisão. Para as revisões adicionadas, é possível verificar a revisão e adicionar comentários, se necessário.
Excluir: Exclui o conjunto de formulários completo. Os formulários no conjunto de formulários excluído permanecem no repositório.
Publicar/Desfazer a publicação: Isso publica/desfaz a publicação do conjunto de formulários juntamente com todos os formulários que ele contém e os ativos relacionados desses formulários.
Visualizar: A Visualização fornece duas opções: Visualize como HTML (sem dados) e personalize com os dados de amostra.
Exibir/editar propriedades: É possível exibir/editar as propriedades de metadados de um conjunto de formulários selecionado.

createformset3

Editar um conjunto de formulários edit-a-form-set

Para editar um conjunto de formulários, faça o seguinte:

Selecione Forms > Forms e Documentos.
Localize o conjunto de formulários que deseja editar. Passe o mouse sobre ele e selecione Editar ( ).
Na página Configurar formulários, é possível editar o seguinte:
- Pedido de formulário
- Identificador de formulário
- Raiz de dados
- Expressão de elegibilidade
Você também pode clicar no ícone Excluir relevante para excluir o formulário do Conjunto de formulários.

Conjunto de formulários no Gerenciamento de Processos form-set-in-process-management

Depois de criar um conjunto de formulários usando a interface do usuário do AEM Forms Management, você pode usar o conjunto de formulários em uma atividade de Ponto de Início ou Atribuir Tarefa usando o Workbench.

Uso do conjunto de formulários na tarefa ou no ponto de início using-form-set-in-task-or-start-point

Ao projetar um processo, na seção Apresentação e dados de Atribuir Tarefa/Ponto de Início, selecione usar um ativo CRX. O navegador CRX Asset é exibido.
Selecione o conjunto de formulários para filtrar o conjunto de formulários AEM repositório (CRX).
Seleciona um conjunto de formulários e clique em OK.

Expressões de elegibilidade eligibility-expressions

Expressões de elegibilidade em um conjunto de formulários são usadas para definir e controlar dinamicamente formulários exibidos para um usuário. Por exemplo, para exibir um determinado formulário somente se o usuário pertencer a um determinado grupo etário. Especifique e edite uma expressão de qualificação usando o gerenciador de formulários.

Uma expressão de elegibilidade pode ser qualquer instrução JavaScript válida que retorne um valor booleano. A última declaração no trecho de código JavaScript é tratada como um valor booleano que determina a elegibilidade do formulário com base no processamento no restante (linhas anteriores) do trecho de código JavaScript. Se o valor da expressão for true, o formulário estará qualificado para ser exibido ao usuário. Esses formulários são conhecidos como formulários elegíveis.

NOTE

A expressão Eligibility para o primeiro formulário do conjunto de formulários não é executada. O primeiro formulário é sempre exibido, independentemente de sua expressão de qualificação.

Além das funções JavaScript padrão, o conjunto de formulários também expõe a API fs.valueOf que fornece acesso ao valor de um campo de um formulário em um conjunto de formulários. Use essa API para acessar o valor de um campo de formulário em um conjunto de formulários. A sintaxe da API é fs.valueOf (formUid, fieldSOM), onde:

formUid (cadeia de caracteres): Uma ID exclusiva de um formulário no conjunto de formulários. Você pode especificá-lo ao criar o conjunto de formulários na interface do usuário do Gerenciador de formulários. Por padrão, é o nome do formulário.
fieldSOM (cadeia de caracteres): Uma expressão SOM do campo no formulário especificado pelo formUid. A expressão SOM ou a expressão Modelo de objeto de script é usada para fazer referência a valores, propriedades e métodos em um modelo de objeto de documento (DOM) específico. É possível exibi-lo no Designer de formulário, na guia Scripts , enquanto o campo é selecionado.

NOTE

Os parâmetros formUid e fieldSOM devem ser literais de cadeia de caracteres.

Exemplos examples

Uso válido da API:

fs.valueOf("form1", "xfa.form.form1.subform1.field1")

Uso inválido da API:

var formUid = "form1";
 var fieldSOM = “xfa.form.form1.subform1.field1"; fs.valueOf(formUid, fieldSOM);

Preencher XML para o conjunto de formulários prefill-xml-for-form-set

O conjunto de formulários é uma coleção de vários formulários HTML5 que têm esquemas comuns ou diferentes. O conjunto de formulários suporta o pré-preenchimento de campos de formulário usando um arquivo XML. É possível associar um arquivo XML a um conjunto de formulários para que, ao abrir um formulário no conjunto de formulários, alguns dos campos no formulário sejam pré-poluídos.

O arquivo XML de preenchimento prévio é especificado usando o parâmetro dataRef do URL do conjunto de formulários. O parâmetro dataRef especifica o caminho absoluto do arquivo XML de dados que é unido ao conjunto de formulários.

Por exemplo, você tem três formulários (formulário1, formulário2 e formulário3), no conjunto de formulários com a seguinte estrutura:

form1

campo
form1field

form2

campo
form2field

form3

campo
form3field

Cada formulário tem um campo com nome comum, chamado "campo" e um campo com nome exclusivo chamado "formfield".

Você pode preencher previamente esse conjunto de formulários usando um XML com a seguinte estrutura:

<?xml version="1.0" encoding="UTF-8" ?>
<formSetRootTag>
 <field>common field value</field>
 <form1field>value1</form1field>
 <form2field>value2</form2field>
 <form3field>value3</form3field>
</formSetRootTag>

NOTE

A tag raiz XML pode ter qualquer nome, mas as tags de elemento correspondentes aos campos devem ter o mesmo nome do campo. A hierarquia do XML deve imitar a hierarquia do formulário, o que significa que o XML deve ter as tags correspondentes para o vínculo de subformulários.

O trecho XML acima mostra que o XML de preenchimento prévio para o conjunto de formulários é uma união dos trechos XML de preenchimento prévio dos formulários individuais. Se determinados campos nos diferentes formulários tiverem hierarquia/esquema de dados semelhante um ao outro, os campos serão preenchidos com os mesmos valores. Neste exemplo, os três formulários recebem o mesmo valor para o campo comum, "campo". Essa é uma maneira simples de transmitir dados de um formulário para o seguinte. Isso também pode ser feito vinculando os campos ao mesmo schema ou referência de dados. Se desejar segregar os dados do conjunto de formulários com base no esquema dos formulários. Isso pode ser feito especificando o atributo "raiz de dados" do formulário, durante a criação do conjunto de formulários (o valor padrão é "/", que mapeia para a tag raiz do conjunto de formulários).

No exemplo anterior, se você especificar as raízes de dados: "/form1", "/form2" e "/form3" respectivamente para os três formulários, é necessário usar um XML de preenchimento prévio da seguinte estrutura:

<?xml version="1.0" encoding="UTF-8" ?>
<formSetRootTag>
 <form1>
  <field>field value1</field>
  <form1field>value1</form1field>
 </form1>
 <form2>
  <field>field value2</field>
  <form2field>value2</form2field>
 </form2>
 <form3>
  <field>field value3</field>
  <form3field>value3</form3field>
 </form3>
</formSetRootTag>

Em um conjunto de formulários, o XML definiu um esquema XML com a seguinte sintaxe:

<formset>
 <fs_data>
  <xdp:xdp xmlns:xdp="https://ns.adobe.com/xdp/">
  <xfa:datasets xmlns:xfa="https://www.xfa.org/schema/xfa-data/1.0/">
   <xfa:data>
   <rootElement>
    ... data ....
   </rootElement>
   </xfa:data>
  </xfa:datasets>
  </xdp:xdp>
 </fs_data>
 <fs_draft>
  ... private data...
 </fs_draft>
</formset>

NOTE

Se houver dois formulários com raízes de dados sobrepostas, ou se a hierarquia de elemento de um formulário se sobrepor à hierarquia de raiz de dados de outro formulário, no xml de preenchimento prévio, os valores dos elementos sobrepostos serão unidos. O XML de envio tem estrutura semelhante à do XML de preenchimento prévio, mas o XML de envio tem mais tags wrapper e algumas tags de dados de contexto de conjunto de formulários anexadas no final.

Preencher descrição dos elementos XML prefill-xml-elements-description

Regras de sintaxe para criar um arquivo XML de preenchimento prévio:

elementos principais: elemento(s) que pode ser seu pai, onde null indica que o elemento pode estar na raiz do XML.
cardinalidade: descreve o número de vezes que o elemento pode ser usado dentro de seu elemento pai.
submitXML: indica se o elemento está sempre presente (P) ou opcional(O) no XML de envio.
prefillXML: indica se o elemento é obrigatório ® ou opcional(O) no XML de preenchimento prévio.
crianças: indica quais elementos podem ser seus filhos.

FORMSET formset

parent elements:

null

cardinality: [0,1]

submitXML: P

prefillXML: O

children: fs_data

O elemento raiz do XML de conjunto de formulários. É recomendável não usar essa palavra como o nome do rootSubform de qualquer formulário no conjunto de formulários.

FS_DATA fs-data

parent elements:

formset

cardinalidade: [1]

submitXML: P

prefillXML: O

children: xdp:xdp/rootElement

A subárvore indica os dados dos formulários no conjunto de formulários. O elemento é opcional no XML de preenchimento prévio somente se o elemento do conjunto de formulários não estiver presente

XDP:XDP xdp-xdp

parent elements: fs_data/null

cardinality: [0,1]

submitXML: O

prefillXML: O

children: xfa:datasets

Esta tag indica o início do HTML5 Form XML. Isso é adicionado no XML de envio se estiver presente no XML de preenchimento prévio ou se não houver um XML de preenchimento prévio. Essa tag pode ser removida do XML de preenchimento prévio.

XFA:CONJUNTOS DE DADOS xfa-datasets

parent elements: xdp:xdp

cardinality: [1]

submitXML: O

prefillXML: O

children: xfa:data

XFA:DATA xfa-data

parent elements: xfa:datasets

cardinality: [1]

submitXML: O

prefillXML: O

children: rootElement

ROOTELMENT rootelement

parent elements: xfa:datasets/fs_data/null

cardinality: [0,1]

submitXML: P

prefillXML: O

children: controlled by the Forms in Form set

O nome rootElement é apenas um espaço reservado. O nome real é extraído dos formulários usados no conjunto de formulários. A subárvore que começa com rootElement contém os dados dos campos e subformulários dentro do Forms no conjunto de formulários. Há vários fatores que determinam a estrutura do rootElement e seus filhos.

No XML de preenchimento prévio, essa tag é opcional, mas se estiver ausente, o XML inteiro será ignorado.

NOME DA TAG DE ELEMENTO RAIZ

Caso haja um elemento raiz no XML de preenchimento, o nome desse elemento também será usado no XML de envio. Nos casos em que não há um xml de preenchimento prévio, o nome do rootElement é o nome do Subformulário raiz do primeiro formulário no conjunto de formulários que tem uma propriedade dataRoot definida como "/". Se esse formulário não existir, o nome rootElement será fs_dummy_root, que é uma palavra-chave reservada.

Conjunto de formulários no aplicativo AEM Forms formset-in-workspace-app

O aplicativo AEM Forms permite que trabalhadores de campo sincronizem seus dispositivos móveis com um servidor AEM Forms e trabalhem em suas tarefas. O aplicativo funciona mesmo quando o dispositivo está offline, salvando os dados localmente no dispositivo. Usando recursos de anotação, como fotografias, os trabalhadores de campo podem fornecer informações precisas para se integrar aos processos comerciais.

Para obter mais informações sobre o aplicativo AEM Forms, consulte Aplicativo AEM Forms.

Limitações conhecidas - padrões não totalmente compatíveis com o Conjunto de formulários known-limitations-patterns-not-fully-supported-in-form-set

Os seguintes padrões de dados não são totalmente compatíveis com o Conjunto de formulários:

Padrão não totalmente compatível no conjunto de formulários

Exemplo

Tamanho de entrada e incompatibilidade de tamanho de padrão

Quando o padrão= num{z,zzz}

E input=

12 345 ou

1,23

Padrões da Cláusula de Imagem com colchetes "(" ")"

num{(zz,zzz)}

Vários padrões de dados

num{zz,zzz} | num{z,zzz,zzz}

Padrões de encurtamento

num.integer{},

num.decimal{},

num.percent{} ou

num.currency{}

recommendation-more-help

a6ebf046-2b8b-4543-bd46-42a0d77792da