Gerar documento de registro para Forms adaptável

Visão geral

Quando um formulário é preenchido ou enviado, é possível manter um registro do formulário, em formato impresso ou documento. Este registro é conhecido como Documento de Registro (DoR). É uma cópia fácil de imprimir do formulário enviado. Você também pode consultar o documento de registro para as informações que os clientes preencheram posteriormente ou usar o Documento de registro para arquivar formulários e conteúdo juntos em formato PDF.

Documento do registro

Para criar um Documento de registro, um modelo baseado em XFA ou Acroform é unido aos dados coletados por um formulário adaptável. Você pode gerar um Documento de registro automaticamente ou sob demanda.
A opção sob demanda permite especificar um modelo personalizado baseado em XFA ou Acroform para fornecer uma aparência personalizada ao seu Documento de registro.

É possível:

Antes de você iniciar

Antes de começar a aprender e a preparar os ativos necessários para um Documento de registro:

Modelo base: um modelo XFA (arquivo XDP) criado AEM Designer ou um formulário Acrobat (AcroForm). Os modelos base usados para especificar informações de estilo e identidade visual para um Documento de registro. Faça upload do seu modelo XFA (arquivo XDP) para a sua instância do AEM Forms antes de

Formulário adaptável: um formulário adaptável para o qual o documento de registro deve ser gerado.

Gerar um documento de registro baseado em XFA

Carregue seu modelo XFA (arquivo XDP) na instância do AEM Forms. Execute as seguintes etapas para configurar um Formulário adaptável para usar o modelo XFA (arquivo XDP) como modelo para o Documento de registro:

  1. Na instância AEM autor, clique em Forms > Forms and Documents.
  2. Selecione um formulário e clique em Properties.
  3. Na janela Propriedades, toque em Form Model.
  4. Na guia Form Model, no menu suspenso Select From, selecione Schema ou None. Também é possível selecionar um modelo de formulário ao criar um formulário.
  5. Na seção Document of Record Template Configuration da guia Form Model , selecione Associate Form Template as Document of Record Template. Ao selecionar essa opção, todos os modelos XFA (arquivos XDP) disponíveis em sua máquina são exibidos. Selecione o arquivo apropriado. Além disso, verifique se o mesmo esquema (esquema de dados) é usado para o Formulário adaptável e para o modelo XFA selecionado (arquivo XDP).
  6. Clique em Done.

Seu formulário adaptável agora está configurado para usar um arquivo XDP como modelo para o Documento de registro. As próximas etapas são para vincular componentes do Formulário adaptável aos campos de modelo correspondentes.

Gerar um documento de registro baseado em formulário

Carregue seu PDF Adobe Acrobat (Acroform) na instância do AEM Forms. Execute as seguintes etapas para configurar um Formulário adaptável para usar o Adobe Acrobat PDF (Acroform) como modelo para o Documento de registro:

  1. Na instância AEM autor, clique em Forms > Forms and Documents.
  2. Selecione um formulário e clique em Properties.
  3. Na janela Propriedades, toque em Form Model.
  4. Na guia Form Model, no menu suspenso Select From, selecione Schema ou None. Também é possível selecionar um modelo de formulário ao criar um formulário.
  5. Na seção Document of Record Template Configuration da guia Form Model , selecione Associate Form Template as Document of Record Template. Ao selecionar essa opção, todos os Acrobat PDF (Acroform) disponíveis no computador serão exibidos. Selecione o arquivo apropriado.
  6. Clique em Done.

O Formulário adaptável agora está configurado para usar um Acroform como modelo para o Documento de registro. As próximas etapas são para vincular componentes do Formulário adaptável aos campos de modelo correspondentes.

Gerar automaticamente um Documento de Registro

Quando um Formulário adaptável é configurado para gerar automaticamente um Documento de registro, sempre que um formulário é alterado, seu Documento de registro é atualizado imediatamente. Por exemplo, se um campo for removido de um formulário adaptável existente, o campo correspondente também será removido e não estará visível no Documento de registro. Há muitas outras vantagens de gerar automaticamente o Documento de Registro. :

  • Os desenvolvedores de formulários não precisam manter os vínculos de dados manualmente. O Documento de registro gerado automaticamente cuida de atualizações relacionadas ao vínculo de dados.
  • Os desenvolvedores de formulários não precisam ocultar manualmente os campos que estão marcados como excluídos do Documento de registro. O Documento de Registros gerado automaticamente é pré-configurado para excluir esses campos.
  • A opção Documento de registro gerado automaticamente economiza o tempo necessário para criar um modelo de formulário para o Documento de registro.
  • A opção Documento de registro gerado automaticamente permite que você use diferentes estilos e aparências usando diferentes modelos base. Ajuda a selecionar o melhor estilo e aparência do Documento de registro para sua organização. Se você não especificar estilos, os estilos do sistema serão definidos como padrão.
  • O Documento de Registros Gerado Automaticamente garante que qualquer alteração no formulário seja refletida imediatamente no Documento de Registro.

Execute as seguintes etapas para configurar um Formulário adaptável para gerar automaticamente um Documento de registro:

  1. Na instância AEM autor, clique em Forms > Forms and Documents.
  2. Selecione um formulário e clique em Properties.
  3. Na janela Propriedades, toque em Form Model.
  4. Na guia Form Model, no menu suspenso Select From, selecione Schema ou None. Também é possível selecionar um modelo de formulário ao criar um formulário.
  5. Na seção Document of Record Template Configuration da guia Form Model , selecione Generate Document of Record.
  6. Clique em Done.

Vincular componentes do formulário adaptável com campos de modelo

Vincule campos de formulário adaptável com campos de modelo para exibir dados de formulário capturados no campo Documento de registro correspondente. Para vincular componentes do Formulário adaptável ao documento correspondente dos campos do modelo de registro:

  1. Abra o Formulário adaptável, configurado para usar um modelo de formulário personalizado para edição.

  2. Selecione um componente de Formulário adaptável e clique no ícone Configurar Configurar. Ele abre o navegador de propriedades.

  3. No navegador de propriedades, navegue e selecione um campo.

    • (Para modelo AcroForm) a propriedade Document of Record Bind Reference field.
    • (Para modelo XFA) a propriedade Data Model Bind Reference .
  4. Clique em Save.

Você pode usar Enviar email, AEM ação de envio do fluxo de trabalho juntamente com a etapa Documento de registro e outras ações de envio para receber um Documento de registro.

Atualizações incrementais no modelo de Documento de registro

Os formulários adaptáveis e o documento correspondente dos modelos de registro podem evoluir ao longo do tempo. Você pode optar por adicionar, remover ou modificar campos em um formulário adaptável ou em um modelo de documento de registro.

Quando você faz alterações em um modelo de Documento de registro e carrega o modelo de Documento de registro alterado no AEM Forms, o editor de Adaptive Forms detecta automaticamente os vínculos alterados e informa sobre os componentes de formulário adaptáveis que exigem novos vínculos. Ele permite fazer atualizações incrementais em um modelo de Documento de registro.

Por exemplo, uma Organização, We.Retail, tem um modelo de Documento de registro baseado em AcroForm, we-retail-Invoice.pdf. O modelo tem a seguinte aparência:

Modelo original

Depois de usar o modelo por algum tempo, a organização decide renomear o campo invoice-number para o campo bill-number e capturar o endereço de email dos compradores. Um desenvolvedor atualiza o nome do campo invoice-number e adiciona um campo de email ao modelo. Ele também cria uma nova versão do modelo chamada we-retail-Invoice-v2.pdf.

Modelo atualizado

O desenvolvedor faz upload e se aplica ao modelo atualizado para o formulário adaptável. O formulário adaptável detecta e exibe automaticamente a lista de campos onde o vínculo foi alterado.

Erro de vínculo

O desenvolvedor do formulário vincula os campos Adaptive Forms ao modelo Documento de registro correspondente.

[!VIDEO] (assets/we-retail-binding.mp4)

Agora, quando o formulário adaptativo é enviado, um Documento de registro atualizado é criado.

Atualização dos pacotes-

Considerações principais ao trabalhar com o Documento de registro

Lembre-se das considerações e limitações a seguir ao trabalhar no Documento de registro do Adaptive Forms.

  • Os modelos de Documento de registro não suportam rich text. Portanto, qualquer rich text no Formulário adaptativo estático ou nas informações preenchidas pelo usuário final aparece como texto simples no Documento de registro.
  • Os fragmentos de documento em um formulário adaptável não aparecem no Documento de registro. No entanto, os Fragmentos de formulário adaptáveis são compatíveis.
  • Não há suporte para vínculo de conteúdo no Documento de registro gerado para o Formulário adaptável baseado no esquema XML.
  • A versão localizada do Documento de registro é criada sob demanda para uma localidade quando o usuário solicita a renderização do Documento de registro. A localização do documento de registro ocorre juntamente com a localização do formulário adaptável.

Mapeamento de elementos de formulário adaptável

A tabela a seguir descreve os componentes do Formulário adaptável e os componentes XFA correspondentes e se eles forem exibidos em um Documento de registro.

Fields

Componente de formulário adaptável Componente XFA correspondente Incluído por padrão no Documento de modelo de registro? Notas
Botão Botão falso
Caixa de seleção Caixa de seleção verdadeiro
Seletor de data Campo de data/hora verdadeiro
Lista suspensa Lista suspensa verdadeiro
Rabiscar a assinatura Scribble de assinatura verdadeiro
Caixa numérica Campo numérico verdadeiro
Caixa de senha Campo de senha falso
Botão de opção Botão de opção verdadeiro
Caixa de texto Campo de texto verdadeiro
Botão de redefinição Botão Redefinir falso
Botão Enviar

Botão Submeter por email

Botão Submeter por HTTP

falso
Termos e condições verdadeiro
Anexo de arquivo falso Não disponível no modelo Documento de registro. Disponível apenas no Documento de registro através de anexos.

Contêineres

Componente de formulário adaptável Componente XFA correspondente Notas
Painel
Subformulário
O painel repetível mapeia para subformulário repetível.

Componentes estáticos

Componente de formulário adaptável Componente XFA correspondente Notas
Imagem Imagem Os componentes TextDraw e Image, vinculados ou não, sempre aparecem no Documento de registro para um Formulário adaptável baseado em XSD, a menos que sejam excluídos usando as configurações de Documento de registro.
Texto Texto

Tabelas

Os componentes da tabela Adaptive Forms, como cabeçalho, rodapé e mapa de linha para os componentes XFA correspondentes. Você pode mapear painéis repetitivos para tabelas no Documento de registro.

Modelo base de um Documento de Registro

O modelo base fornece informações de estilo e aparência ao Documento de registro. Ele permite personalizar a aparência padrão do Documento de registro gerado automaticamente. Por exemplo, você pode usar o modelo base para adicionar o logotipo de sua empresa no cabeçalho e as informações de direitos autorais no rodapé do Documento de registro.

A página principal do modelo base é usada como uma página principal para o modelo Documento de registro. A página principal pode ter informações como cabeçalho de página, rodapé de página e número de página que você pode aplicar ao Documento de registro. Você pode aplicar essas informações ao Documento de registro usando o modelo básico para a geração automática do Documento de registro. O uso do template base permite alterar as propriedades padrão dos campos.

Sempre siga Convenções de modelo base ao criar modelo base.

Convenções de modelo básico

Um modelo base é usado para definir o cabeçalho, o rodapé, o estilo e a aparência de um Documento de registro. O cabeçalho e o rodapé podem incluir informações como o logotipo da empresa e o texto de direitos autorais. A primeira página principal no modelo base é copiada e usada como uma página principal para o Documento de registro, que contém cabeçalho, rodapé, número de página ou qualquer outra informação que deve aparecer em todas as páginas no Documento de registro. Se você usar um modelo base que não esteja em conformidade com as convenções do modelo base, a primeira página principal do modelo base ainda será usada no modelo Documento de registro. É altamente recomendável criar seu modelo base de acordo com suas convenções e usá-lo para a geração automática de Documento de registro.

Convenções de página principais

  • No modelo base, nomeie o subformulário raiz como AF_METATEMPLATE e a página principal como AF_MASTERPAGE.

  • A página principal com o nome AF_MASTERPAGE localizado no subformulário raiz AF_METATEMPLATE é preferível para extrair informações de cabeçalho, rodapé e estilo.

  • Se AF_MASTERPAGE estiver ausente, a primeira página principal presente no modelo base será usada.

Convenções de estilo para campos

  • Para aplicar estilo aos campos no Documento de registro, o modelo base fornece campos localizados no subformulário AF_FIELDSSUBFORM sob o subformulário raiz AF_METATEMPLATE.

  • As propriedades desses campos são aplicadas aos campos no Documento de registro. Esses campos devem seguir a convenção de nomenclatura AF_<name of field in all caps>_XFO. Por exemplo, o nome do campo para a caixa de seleção deve ser AF_CHECKBOX_XFO.

Para criar um modelo base, faça o seguinte no AEM Designer.

  1. Clique em File > New.

  2. Selecione a opção Based on a template.

  3. Selecione a categoria Forms - Document of Record.

  4. Selecionar DoR Base Template.

  5. Clique em Next e forneça as informações necessárias.

  6. (Opcional) Modifique o estilo e a aparência dos campos que você deseja aplicar aos campos no Documento de registro.

  7. Salve o formulário.

Agora você pode usar o formulário salvo como modelo base para o Documento de registro. Não modifique ou remova nenhum script presente no modelo base.

Modificação do modelo base

  • Se não aplicar nenhum estilo sobre campos no template base, é aconselhável remover esses campos do template base para que todas as atualizações no template base sejam selecionadas automaticamente.
  • Ao modificar o modelo base, não remova, adicione ou modifique scripts.

Siga rigorosamente as convenções acima mencionadas e as instruções para criar um modelo base.

Personalizar as informações da marca no Documento de registro

Ao gerar um Documento de Registro, você pode alterar as informações de marca do Documento de Registro na guia Documento de Registro. A guia Documento de registro inclui opções como logotipo, aparência, layout, cabeçalho e rodapé, aviso de isenção de responsabilidade e se você deseja ou não incluir as opções de caixa de seleção e botão de opção não selecionadas.

Para localizar as informações de marca inseridas na guia Document of Record , verifique se a localidade do navegador está definida corretamente. Para personalizar as informações de marca do Documento de registro, execute as seguintes etapas:

  1. Selecione um painel (painel raiz) no Documento de registro e toque em configurar.

  2. Toque em dortab. A guia Document of Record é exibida.

  3. Selecione o modelo padrão ou um modelo personalizado para renderizar o Documento de registro. Se você selecionar o modelo padrão, uma visualização em miniatura do Documento de registro será exibida abaixo do menu suspenso Modelo.

    modelo de marca

    Se você optar por selecionar um modelo personalizado, navegue por um XDP selecionado em seu servidor AEM Forms. Se você quiser usar um template que ainda não esteja no servidor AEM Forms, primeiro carregue o XDP no servidor AEM Forms.

  4. Com base na seleção de um modelo padrão ou personalizado, algumas ou todas as propriedades a seguir serão exibidas na guia Documento de registro. Especifique estes adequadamente:

    • Imagem do logotipo: Você pode optar por usar a imagem do logotipo do Formulário adaptável, escolher um DAM ou fazer upload de um de seu computador.
    • Título do formulário
    • Texto do cabeçalho
    • Rótulo do aviso
    • Aviso
    • Texto do aviso
    • Cor do destaque: A cor na qual o texto do cabeçalho e as linhas separadoras são renderizados no documento ou registro em PDF
    • Família de fontes: Família de fontes do texto no Documento de registro PDF
    • Para os componentes Caixa de seleção e Botão de opção , mostrar somente os valores selecionados
    • Separador para vários valores selecionados
    • Incluir objetos de formulário que não estão vinculados ao modelo de dados
    • Excluir campos ocultos do Documento de registro
    • Ocultar descrição de painéis
    OBSERVAÇÃO

    Se estiver usando um modelo de Formulário adaptável criado com uma versão do Designer anterior à 6.3, para que as propriedades Cor do destaque e Família de fontes funcionem, verifique se o seguinte está presente no modelo de Formulário adaptável abaixo do subformulário raiz:

    <proto>
    <font typeface="Arial"/>
    <fill>
    <color value="4,166,203"/>
    </fill>
    <edge>
    <color value="4,166,203"/>
    </edge>
    </proto>
    
  5. Para salvar as alterações da marca, toque em Concluído.

Layouts de tabela e coluna para painéis no Documento de registro

O formulário adaptável pode ser longo, com vários campos de formulário. Talvez você não queira salvar um Documento de registro como uma cópia exata do formulário adaptável. Agora é possível escolher um layout de tabela ou coluna para salvar um ou mais painéis de Formulário adaptável no PDF Documento de registro.

Antes de gerar um Documento de registro, nas configurações de um painel, selecione Layout para o documento de registro desse painel como Tabela ou Coluna. Os campos no painel são organizados adequadamente no Documento de registro.

Campos em um painel renderizado em um layout de tabela no Documento de registro

Campos em um painel renderizado em um layout de tabela no Documento de registro

Campos em um painel renderizado em um layout de coluna no Documento de registro

Campos em um painel renderizado em um layout de coluna no Documento de registro

Configurações do documento de registro

As configurações Documento de registro permitem que você escolha as opções que deseja incluir no Documento de registro. Por exemplo, um banco aceita nome, idade, número de segurança social e número de telefone em um formulário. O formulário gera um número de conta bancária e detalhes da ramificação. Você pode optar por exibir somente o nome, o número da segurança social, a conta bancária e os detalhes da ramificação no Documento de registro.

As configurações de Documento de registro de um componente estão disponíveis em suas propriedades. Para acessar as propriedades de um componente, selecione o componente e clique em cmppr na sobreposição. As propriedades são listadas na barra lateral e você pode encontrar as seguintes configurações nela.

Configurações de nível de campo

  • Excluir do documento de registro: A definição da propriedade true exclui o campo do Documento de registro. Essa é uma propriedade capaz de script chamada excludeFromDoR. Seu comportamento depende de Excluir campos do DoR se a propriedade de nível de formulário oculta.

  • Exibir painel como tabela: Definir a propriedade exibe o painel como tabela no Documento de registro se o painel tiver menos de 6 campos. Aplicável somente para painel.

  • Excluir título do Documento de registro: Definir a propriedade exclui o título do painel/tabela do Documento de registro. Aplicável somente para painel e tabela.

  • Excluir descrição do documento de registro: definir a propriedade exclui a descrição do painel/tabela do documento de registro. Aplicável somente para painel e tabela.

Configurações de nível de formulário

  • Incluir campos não vinculados no DoR: a configuração da propriedade inclui campos não vinculados do Formulário adaptável baseado em esquema no documento de registro. Por padrão, é verdadeiro.
  • Excluir campos do DoR se ocultos: a configuração da propriedade substitui o comportamento da propriedade de nível de campo "Excluir do documento de registro" quando não é verdadeira. Se os campos estiverem ocultos no momento do envio do formulário, eles serão excluídos do Documento de registro se a propriedade estiver definida como true, desde que a propriedade "Excluir do documento de registro" não esteja definida.

Nesta página