Gerar documento de registro para Formulários adaptáveis

Visão geral

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:

• Gerar um documento de registro baseado em XFA
• Gerar um documento de registro baseado em acroforma (PDF do Acrobat Form)
• Gerar automaticamente um documento de registro

Antes de você iniciar

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 um formulário do Acrobat (AcroForm). Modelo base é usado para especificar informações de estilo e marca para um Documento de registro. Faça upload do 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

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:

1. Na instância do autor do Experience Manager, clique em Forms > Forms e documentos.
2. Selecione um formulário e clique em Propriedades.
3. Na janela Propriedades, toque em Modelo de formulário.
4. No Modelo de formulário , na guia Selecionar de selecione Esquema ou Nenhum. Você também pode 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 Associar o modelo de formulário como o 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).
6. Clique em Concluído.

O 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 vincular componentes do Formulário adaptável com campos de modelo correspondentes.

Gerar um documento de registro baseado em acroforma

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 do autor do Experience Manager, clique em Forms > Forms e documentos.
2. Selecione um formulário e clique em Propriedades.
3. Na janela Propriedades, toque em Modelo de formulário.
4. No Modelo de formulário , na guia Selecionar de selecione Esquema ou Nenhum. Você também pode 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 Associar o modelo de formulário como o documento de modelo de registro. Ao selecionar essa opção, todos os PDF Acrobat (Acroform) disponíveis em sua máquina são exibidos. Selecione o arquivo apropriado.
6. Clique em Concluído.

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

Gerar automaticamente um documento de registro

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:

1. Na instância do autor do Experience Manager, clique em Forms > Forms e documentos.
2. Selecione um formulário e clique em Propriedades.
3. Na janela Propriedades, toque em Modelo de formulário.
4. No Modelo de formulário , na guia Selecionar de selecione Esquema ou Nenhum. Você também pode 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 Gerar documento de registro.
6. Clique em Concluído.

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

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:

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 em abrir Configurar ícone. Ele abre o navegador de propriedades.

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

   • (Para o modelo AcroForm) a variável Campo Documento de referência de associação de registro propriedade.
   • (Para modelo XFA) a variável Referência de associação de modelo de dados propriedade.

4. Clique em Salvar.

Você pode usar Enviar e-mail, ação enviar do Fluxo de trabalho do Experience Manager em conjunto com Etapa Documento de registro e outras ações de envio para receber um documento de registro.

Atualizações incrementais no documento de modelo de registro

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ê faz alterações em 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 em 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 invoice-number campo para bill-number e capture o endereço de email dos compradores. Um desenvolvedor atualiza o nome do invoice-number e adiciona um campo de email ao modelo. Ele também cria uma nova versão do template chamada we-retail-Invoice-v2.pdf.

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 uma lista de campos em que a associação foi alterada.

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

Agora, quando o formulário adaptável for enviado, um documento de registro atualizado será criado.

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

Lembre-se das seguintes considerações e limitações 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 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á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

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

Contêineres

Componentes estáticos

Tabelas

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

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 o modelo base para adicionar o logotipo da sua empresa nas informações de cabeçalho e direitos autorais no rodapé do documento de registro.

A página principal do modelo base é usada como uma página principal do modelo Documento de registro. A página principal 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 a geração automática do Documento de registro. O uso do template base permite alterar as propriedades padrão dos campos.

Sempre seguir Convenções do modelo base ao criar o modelo base.

Convenções do modelo base

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 principal no modelo base é copiada e usada como uma página principal para o documento de registro, que contém o cabeçalho, o rodapé, o número da 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 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 principal

• No template 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 abaixo de AF_METATEMPLATE o subformulário raiz é preferido 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 nos campos no documento de registro, o modelo base fornece campos localizados na AF_FIELDSSUBFORM subde sob o AF_METATEMPLATE subformulário raiz.

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

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

1. Clique em Arquivo > Novo.

2. Selecione o Com base em um modelo opção.

3. Selecione o Forms - Documento de registro categoria.

4. Selecionar Modelo base do DoR.

5. Clique em Próxima e fornecer as informações necessárias.

6. (Opcional) Modifique o estilo e a aparência dos campos que deseja aplicar nos campos do documento de registro.

7. Salve o formulário.

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

Modificação do modelo base

• Se não aplicar nenhum estilo sobre os campos no modelo base, é aconselhável remover esses campos do modelo base para que todas as atualizações do 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

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:

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

2. Toque . A guia Documento de registro é 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.

4. Se você selecionar um modelo padrão ou personalizado, algumas ou todas as propriedades a seguir serão exibidas na guia Documento de registro. Especifique as propriedades mencionadas abaixo para definir a aparência do documento de registro:

   1. Propriedades básicas:

      • Modelo: se você optar por selecionar um modelo personalizado, procure um XDP selecionado em seu AEM Forms servidor. Se quiser usar um modelo que ainda não esteja na sua AEM Forms servidor, primeiro carregue o XDP no seu AEM Forms servidor.
      • Cor de realce: A cor na qual o texto do cabeçalho e as linhas separadoras são renderizados no PDF do documento ou do registro.
      • Família da fonte: Família de fontes do texto no documento de PDF de registro.
      • Incluir objetos de formulário que não estão vinculados ao modelo de dados: a configuração da propriedade inclui campos não vinculados do Formulário adaptável baseado em esquema no Documento de registro.
      • Excluir campos ocultos do documento de registro: a configuração da propriedade identifica os campos ocultos para exclusão do Documento de registro.
      • Ocultar descrição de painéis: a configuração da propriedade exclui a descrição do painel/tabela do Documento de registro. Aplicável para painel e tabela.

      

   2. Propriedades do campo de formulário:

      • Para os componentes Caixa de seleção e Botão de opções, mostrar apenas os valores selecionados: a configuração da propriedade exibe somente os valores selecionados da caixa de seleção e do botão de opção no Documento do registro.
      • Separador para vários valores: é possível 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 ser exibido em Documento do registro. Por padrão, o alinhamento vertical é definido para os campos em Documento do registro. Definir as propriedades do Propriedades do campo de formulário de DoR substitui as propriedades definidas no Alinhamento do Item para os campos em um Formulário adaptável. Caso, selecione O mesmo que Formulário adaptável opção, o alinhamento conforme configurado em uma instância do autor do Formulário adaptável é usado para Documento do registro campos.
      • 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.

      

   3. Página principal Propriedades:

      • Imagem de logotipo: Você pode optar por usar a imagem de logotipo do Formulário adaptável, escolher um do DAM ou fazer upload de um 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.
      • Isenção de responsabilidade: texto que especifica o escopo dos direitos e obrigações no documento de registro.
      • Texto do aviso: Texto do aviso de isenção de responsabilidade.

      

   OBSERVAÇÃO

   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:

   <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 de marca, toque em Concluído.

Suporte a documento de registro no editor de formulário adaptável

Você pode configurar o Documento do registro modelo diretamente do editor de formulário adaptável ou do editor de modelo de formulário adaptável.

Execute as seguintes etapas a partir da instância de autor do editor de Formulário adaptável:

1. Selecione o Contêiner de formulário adaptável (raiz) componente.

2. Clique em ícone para abrir o Propriedades do contêiner do Formulário adaptável.

3. Abra o Documento do modelo de registro e selecione uma das seguintes opções:

   • Nenhum: Quando essa opção é selecionada, não Documento do registro modelo criado para o formulário adaptável.

   • Associar o modelo de formulário como o documento de modelo de registro: quando essa opção é selecionada, o Formulário XFA é usado como um modelo para o Documento de registro.

   • Gerar documento de registro: Quando essa opção é selecionada, a variável Documento do registro O modelo é gerado automaticamente para o Formulário adaptável.

4. Toque para salvar as propriedades.

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 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

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 na sobreposição. As propriedades são listadas na barra lateral e você pode encontrar as seguintes configurações.

Configurações de nível de campo

• Excluir do documento de registro: definir a propriedade como true exclui o campo do Documento de registro. Esta é uma propriedade que pode ser gerada por script chamada excludeFromDoR. Seu comportamento depende da Excluir campos de 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: 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 do nível de formulário

• Incluir campos desatados em 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 de DoR se ocultos: Defina a propriedade para excluir os campos ocultos do documento de registro no envio do formulário. Quando você habilita Revalidar no servidor, o servidor recalcula os campos ocultos antes de excluir esses campos do documento de registro.

Usar um arquivo XCI personalizado

Um arquivo XCI ajuda a definir várias propriedades de um documento. O Forms as a Cloud Service tem um arquivo XCI principal. Você pode usar um arquivo XCI personalizado para substituir uma ou mais propriedades padrão especificadas no arquivo XCI principal. Por exemplo, você pode optar por incorporar uma fonte em um documento ou ativar a propriedade marcada para todos os documentos. A tabela a seguir especifica as opções de XCI:

Usar um arquivo XCI personalizado no ambiente as a Cloud Service do Forms

1. Adicione o arquivo XCI personalizado ao projeto de desenvolvimento.

2. Especifique o seguinte propriedade inline:

    {
     "xciFilePath": "[path of XCI file]"
    }
   

   Por exemplo,

    {
     "xciFilePath": "/content/dam/formsanddocuments/customMinionProBoldAndTagged.xci"
    }
   

3. Implante o projeto no seu ambiente Cloud Service.

Usar um arquivo XCI personalizado em seu ambiente de desenvolvimento as a Cloud Service do Forms local

1. Carregue o arquivo XCI no ambiente de desenvolvimento local.
2. Abra o gerenciador de configurações do SDK do Cloud Service. O URL padrão é: http://localhost:4502/system/console/configMgr.
3. Localize e abra o Canal da Web de comunicação interativa e Forms adaptável configuração.
4. Especifique o caminho do arquivo XCI e clique em Salvar.

Recursos do Business.Adobe.com