Gerar documento de registro para o Forms adaptável (componentes principais)
Visão geral overview
Quando um formulário é preenchido ou enviado, você pode manter um registro do formulário, impresso ou no formato do documento. Esse registro é chamado de Documento de registro (DoR). É uma cópia do formulário enviado que pode ser impressa. Você também pode consultar o documento de registro para as informações que os clientes preencheram em uma data posterior ou usar o documento de registro para arquivar formulários e conteúdo juntos no formato PDF.
Para criar um documento de registro, um modelo baseado em XFA ou acroforma é mesclado com os dados coletados por meio de 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 XFA ou baseado em acroforma personalizado para fornecer uma aparência personalizada ao documento de registro.
É possível:
Antes de começar components-to-automatically-generate-a-document-of-record
Antes de começar a aprender e preparar os ativos necessários para um Documento de registro:
Modelo base: um modelo XFA (arquivo XDP) criado no Forms Designer ou em um formulário Acrobat (AcroForm). O Modelo base é usado para especificar informações de estilo e identidade visual para um Documento de Registro. Carregue seu modelo XFA (arquivo XDP) na 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 generate-an-XFA-based-document-of-record
Faça upload do 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:
- Na instância do autor do Experience Manager, clique em Forms > Forms e Documentos.
- Selecione um Formulário ou Crie um Formulário Adaptável e clique em Propriedades.
- Na janela Propriedades, selecione Modelo de formulário.
- Na guia Modelo de Formulário, no menu suspenso Selecionar de, selecione Modelo de Dados de Formulário, Esquema ou Nenhum. Você também pode selecionar um modelo de formulário ao criar um formulário.
- Na seção Document of Record Template Configuration da guia Form Model, selecione Associar Modelo de Formulário como Documento de Modelo de Registro. 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 o modelo XFA selecionado (arquivo XDP).
- Clique em Concluído.
O formulário adaptável agora está configurado para usar um arquivo XDP como modelo para o documento de registro. A próxima etapa é vincular componentes do Formulário adaptável com campos de modelo correspondentes.
Gerar um documento de registro baseado em acroforma generate-an-Acroform-based-document-of-record
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:
- Na instância do autor do Experience Manager, clique em Forms > Forms e Documentos.
- Selecione um Formulário ou Criar um Formulário Adaptável e clique em Propriedades.
- Na janela Propriedades, selecione Modelo de formulário.
- Na guia Modelo de Formulário, no menu suspenso Selecionar de, selecione Modelo de Dados de Formulário, Esquema ou Nenhum. Você também pode selecionar um modelo de formulário ao criar um formulário.
- Na seção Document of Record Template Configuration da guia Form Model, selecione Associar Modelo de Formulário como Documento de Modelo de Registro. Ao selecionar essa opção, todas as PDF de Acrobat (Acroform) disponíveis em sua máquina são exibidas. Selecione o Acrobat que deseja usar.
- Clique em Concluído.
O formulário adaptável agora está configurado para usar um acroforma como modelo para o documento de registro. A próxima etapa é vincular componentes do Formulário adaptável com campos de modelo correspondentes.
Gerar automaticamente um documento de registro auto-generate-a-document-of-record
Quando um formulário adaptável é configurado para gerar automaticamente um documento de registro, toda vez 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 as associações de dados manualmente. O Documento de registro gerado automaticamente cuida das atualizações relacionadas à vinculação de dados.
- Os desenvolvedores de formulários não precisam ocultar manualmente os campos marcados como excluir do documento de registro. O documento de registro gerado automaticamente é pré-configurado para excluir esses campos.
- A opção Documento de registro gerado automaticamente economiza tempo necessário para criar um modelo de Formulário para Documento de registro.
- A opção Documento de registro gerado automaticamente permite usar estilos e aparências diferentes usando modelos base diferentes. Ele ajuda a selecionar o melhor estilo e aparência para o Documento de registro da sua organização. Se você não especificar o estilo, os estilos do sistema serão definidos como padrão.
- O documento de registro 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:
- Na instância do autor do Experience Manager, clique em Forms > Forms e Documentos.
- Selecione um Formulário ou Crie um Formulário Adaptável e clique em Propriedades.
- Na janela Propriedades, selecione Modelo de formulário.
- Na guia Modelo de Formulário, no menu suspenso Selecionar de, selecione Modelo de Dados de Formulário, Esquema ou Nenhum. Você também pode selecionar um modelo de formulário ao criar um formulário.
- Na seção Document of Record Template Configuration da guia Form Model, selecione Gerar Documento de Registro.
- Clique em Concluído.
Vincular componentes do formulário adaptável a campos de modelo bind-adaptive-form-components-with-template-fields
Vincule campos de formulário adaptável a campos de modelo para exibir dados de formulário capturados no campo de documento de registro correspondente. Para vincular componentes do Formulário adaptável ao documento correspondente de campos de modelo de registro:
-
Abra o Formulário adaptável, configurado para usar um modelo de formulário personalizado para edição.
-
Selecione um componente de Formulário adaptável e clique em abrir o ícone Configurar
-
No navegador de propriedades, navegue e selecione um campo.
- (Para o modelo AcroForm) a propriedade campo Referência de Associação de Documento de Registro.
- (Para modelo XFA) a propriedade Referência de Associação de Modelo de Dados.
-
Clique em Salvar.
Você pode usar ações de envio como "Enviar email", "Chamar um fluxo de trabalho do AEM", "Chamar um fluxo do Power Automate" e outras Ações de envio para receber um Documento de Registro.
Atualizações incrementais no documento de modelo de registro document-of-record-template-incremental-updates
Os formulários adaptáveis e os documentos correspondentes de modelos de registro podem evoluir ao longo do tempo. Você pode optar por adicionar, remover ou modificar campos para um modelo de Formulário adaptável ou Documento de registro.
Quando você altera um modelo de documento de registro e faz upload do modelo alterado de documento de registro para o AEM Forms, o editor do Adaptive Forms detecta automaticamente as associações alteradas e informa sobre os componentes de formulário adaptáveis que exigem novas associações. Ele permite fazer atualizações incrementais em um documento de modelo de registro.
Por exemplo, uma organização, We.Retail, tem um modelo de documento de registro baseado no AcroForm, we-retail-Invoice.pdf. O modelo tem a seguinte aparência:
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.
Agora, quando o formulário adaptável é enviado, um documento de registro atualizado é gerado.
Considerações principais ao trabalhar com o documento de registro key-considerations-when-working-with-document-of-record
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 são compatíveis com rich text. Portanto, qualquer rich text no Formulário adaptável estático ou nas informações preenchidas pelo usuário 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ável são compatíveis.
- Não há suporte para vinculação de conteúdo no Documento de registro gerado para o Formulário adaptável baseado em Esquema XML.
- A versão localizada do documento de registro é criada sob demanda para um local 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 do formulário adaptável mapping-of-adaptive-form-elements
A tabela a seguir descreve os componentes do formulário adaptável e os componentes XFA correspondentes, e se eles aparecem em um documento de registro.
Campos fields
Contêineres containers
Componentes estáticos static-components
Tabelas tables
Os componentes da tabela Adaptive Forms, como cabeçalho, rodapé e mapa de linhas para componentes XFA correspondentes. Você pode mapear painéis repetíveis para tabelas no documento de registro.
Modelo base de um documento de registro base-template-of-a-document-of-record
O modelo base fornece informações de estilo e aparência ao documento de registro. Ela permite personalizar a aparência padrão do documento de registro gerado automaticamente. Por exemplo, você pode usar um modelo base para adicionar o logotipo da sua empresa nas informações de cabeçalho e copyright no rodapé do documento de registro.
A página mestra de um modelo base é usada como uma página mestra do modelo Documento de registro. A página-mestre pode ter informações como cabeçalho, rodapé e número de página que podem ser aplicadas ao documento de registro. É possível aplicar essas informações ao Documento de Registro usando o modelo-base para geração automática do Documento de Registro. O uso de um template base permite alterar as propriedades padrão dos campos.
Sempre siga as Convenções do modelo base ao criar o modelo base.
Convenções do modelo base base-template-conventions
Um modelo base é usado para definir o cabeçalho, rodapé, estilo e 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 mestra no modelo base é copiada e usada como página mestra do documento de registro, que contém um cabeçalho, rodapé, número de página ou qualquer outra informação que deve aparecer em todas as páginas do 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-mestre do modelo base ainda será usada no modelo Documento de registro. É altamente recomendável que você projete seu modelo base de acordo com suas convenções e o use para a geração automática do Documento de registro.
Convenções de página mestra
-
No modelo base, nomeie o subformulário raiz como
AF_METATEMPLATEe a página mestra comoAF_MASTERPAGE. -
A página mestra com o nome
AF_MASTERPAGE, localizada no subformulário raizAF_METATEMPLATE, é preferível para extrair informações de cabeçalho, rodapé e estilo. -
Se
AF_MASTERPAGEestiver ausente, a primeira página mestra 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_FIELDSSUBFORMabaixo do subformulário raizAF_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 da caixa de seleção deve serAF_CHECKBOX_XFO.
Para criar um template base, faça o seguinte no Forms Designer.
-
Clique em Arquivo > Novo.
-
Selecione a opção Baseado em um modelo.
-
Selecione a categoria Forms - Documento de Registro.
-
Selecione Modelo Base DoR.
-
Clique em Avançar e forneça as informações necessárias.
-
(Opcional) Modifique o estilo e a aparência dos campos que deseja aplicar nos campos do documento de registro.
-
Salve o formulário.
Agora você pode usar o formulário salvo como um modelo base para um Documento de registro. Não modifique ou remova scripts presentes no modelo base.
Modificando modelo base
- Não aplique nenhum estilo sobre os campos no modelo base. É aconselhável remover esses campos do modelo base para que todas as atualizações no modelo base sejam selecionadas automaticamente.
- Ao modificar o modelo base, não remova, adicione ou modifique scripts.
Siga rigorosamente as convenções e instruções mencionadas acima para criar um modelo base.
Personalizar as informações de marca no documento de registro customize-the-branding-information-in-document-of-record
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 e se você deseja ou não incluir opções de caixa de seleção e botão de opção não selecionados.
Para localizar as informações de marca inseridas na guia Documento de registro, certifique-se de que o local do navegador esteja definido adequadamente. Para personalizar as informações de marca do Documento de registro, execute as seguintes etapas:
-
Selecione um painel (painel raiz) no Documento de Registro e selecione
-
Selecione
-
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.
-
Se você selecionar um modelo padrão ou personalizado, algumas das propriedades a seguir, ou todas as propriedades, serão exibidas na guia Documento de registro. Especifique as propriedades mencionadas abaixo para definir a aparência do documento de registro:
-
Propriedades básicas:
-
Modelo: se quiser selecionar um modelo personalizado, procure e selecione um XDP no servidor AEM Forms. Se quiser usar um modelo que não esteja disponível no servidor AEM Forms, primeiro carregue o XDP no servidor AEM Forms.
-
Cor de Ênfase: a cor na qual o texto do cabeçalho e as linhas separadoras são renderizados no documento de PDF de registro.
-
Família de Fontes: Família de fontes do texto no documento de PDF de registro.
note note NOTE O AEM Forms oferece uma variedade de fontes integradas que se integram perfeitamente com arquivos PDF. Para ver a lista de fontes com suporte, clique aqui. -
Incluir objetos de formulário que não estão associados ao modelo de dados: a configuração da propriedade inclui campos não associados do Formulário adaptável baseado em esquema no Documento de Registro.
- Ocultar descrição de painéis: definir a propriedade exclui a descrição do painel/tabela do documento de registro. Aplicável para painel e tabela.
-
-
Propriedades do Campo de Formulário:
- Para os componentes da Caixa de Seleção e do Botão de Opção, mostrar apenas os valores selecionados: a configuração da propriedade exibe apenas os valores selecionados da caixa de seleção e do botão de opção em Documento de Registro.
- Separador para vários valores: você pode escolher qualquer separador como vírgula ou quebra de linha para exibir vários valores.
- Alinhamento de Opções: Você pode selecionar o alinhamento desejado (Horizontal, Vertical, Igual ao Formulário adaptável) para definir o alinhamento dos campos, como caixa de seleção ou botão de opção, a serem exibidos em Documento de Registro. Por padrão, o alinhamento vertical é definido para os campos em Documento de registro. Definir as propriedades das Propriedades do Campo de Formulário de DoR substitui as propriedades definidas no Alinhamento de Itens para os campos em um Formulário adaptável. Caso você selecione a opção Igual ao formulário adaptável, o alinhamento conforme configurado em uma instância de autor do formulário adaptável será usado para os campos Documento de registro.
- Número de opções de alinhamento horizontal:Você pode definir o número de opções a serem exibidas no Documento de Registro para o alinhamento horizontal.
-
Propriedades da Página Mestra:
- Imagem de logotipo: você pode optar por usar a imagem de logotipo do Formulário adaptável, escolher uma do DAM ou carregar uma do seu computador.
- Título do Formulário: Título do DoR.
- Texto do Cabeçalho: texto que aparece na seção de cabeçalho do Documento de Registro.
- Rótulo do aviso: Rótulo do aviso.
- Aviso de isenção de responsabilidade: texto que especifica o escopo dos direitos e obrigações no Documento de Registro.
- Texto do aviso: texto do aviso.
note note NOTE Se você estiver usando um modelo de Formulário adaptável criado com uma versão do Designer anterior à 6.3, para que as propriedades de Cor de ênfase e Família de fontes funcionem, verifique se o seguinte está presente no modelo de Formulário adaptável no subformulário raiz: code language-xml <proto> <font typeface="Arial"/> <fill> <color value="4,166,203"/> </fill> <edge> <color value="4,166,203"/> </edge> </proto> -
-
Para salvar as alterações de identidade visual, selecione Concluído.
Layouts de tabela e coluna para painéis no documento de registro table-and-column-layouts-for-panels-in-document-of-record
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 do Formulário adaptável no documento de PDF de registro.
Antes de gerar um documento de registro, nas configurações de um painel, selecione Layout do documento de registro para esse painel como Tabela ou Coluna. Os campos no painel são organizados de acordo 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
Configurações do documento de registro document-of-record-settings
As configurações de Documento de registro permitem escolher as opções que você deseja incluir no Documento de registro. Por exemplo, um banco aceita nome, idade, número de seguridade social e número de telefone em um formulário. O formulário gera um número de conta bancária e detalhes da agência. Você pode optar por exibir somente o nome, o número de seguridade social, a conta bancária e os detalhes da agência no Documento de Registro.
A configuração do componente Documento de registro está disponível em suas propriedades. Para acessar as propriedades de um componente, selecione o componente e clique em
Configurações de nível de campo
-
Excluir do documento de registro: definir a propriedade true exclui o campo do documento de registro. Esta é uma propriedade que pode ser gerada por script chamada
excludeFromDoR. Seu comportamento depende de Excluir campos do DoR se ocultos propriedade de nível de formulário. -
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 o painel.
-
Excluir título do documento de registro: a configuração da propriedade exclui título do painel/tabela do documento de registro. Aplicável somente para painel e tabela.
-
Excluir descrição do documento de registro: a configuração da 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 desatados em DoR: A configuração da propriedade inclui campos desatados do Formulário adaptável baseado em esquema no Documento de Registro. Por padrão, é verdadeiro.
Consulte também see-also
- Criar um formulário adaptável de AEM
- Adicionar um formulário adaptável de AEM à página do AEM Sites
- Aplicar temas a um formulário adaptável de AEM
- Adicionar componentes a um Formulário adaptável para AEM
- Usar CAPTCHA em um formulário adaptável de AEM
- Gerar versão do PDF (DoR) de um formulário adaptável AEM
- Traduzir um formulário adaptável de AEM
- Ativar o Adobe Analytics para um formulário adaptável para rastrear o uso do formulário
- Conectar o formulário adaptável ao Microsoft SharePoint
- Conectar o formulário adaptável ao Microsoft Power Automate
- Conectar o formulário adaptável ao Microsoft OneDrive
- Conectar o formulário adaptável ao armazenamento de blobs do Microsoft Azure
- Conectar o formulário adaptável ao Salesforce
- Usar o Adobe Sign em um formulário adaptável AEM
- Adicionar uma nova localidade para um Formulário adaptável
- Enviar dados do Formulário adaptável a um banco de dados
- Enviar dados do formulário adaptável para um endpoint REST
- Enviar dados do formulário adaptável para o fluxo de trabalho do AEM
- Usar o Forms Portal para listar AEM Adaptive Forms em um site de AEM
- Adicionar versões, comentários e anotações a um Formulário adaptável
- Comparar Forms adaptável