O Adobe recomenda o uso da captura de dados moderna e extensível Componentes principais para criação de um novo Forms adaptável ou adição de Forms adaptável às páginas do AEM Sites. Esses componentes representam um avanço significativo na criação do Forms adaptável, garantindo experiências de usuário impressionantes. Este artigo descreve a abordagem mais antiga para criar o Forms adaptável usando componentes de base.
Versão | Link do artigo |
---|---|
AEM 6.5 | Clique aqui |
AEM as a Cloud Service | Este artigo |
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 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.
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:
O formulário adaptável agora está configurado para usar um arquivo XDP como modelo para o documento de registro. O próximo passo é vincular componentes do Formulário adaptável com campos de modelo correspondentes.
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:
O formulário adaptável agora está configurado para usar um acroforma como modelo para o documento de registro. O próximo passo é vincular componentes do Formulário adaptável com campos de modelo correspondentes.
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. :
Execute as seguintes etapas para configurar um Formulário adaptável para gerar automaticamente um Documento de registro:
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 Configurar ícone. Ele abre o navegador de propriedades.
No navegador de propriedades, navegue e selecione um campo.
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.
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 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.
Lembre-se das seguintes considerações e limitações ao trabalhar no Documento de registro do Adaptive Forms.
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.
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 | Rabisco 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 Enviar de email Botão Enviar do HTTP |
falso | |
Termos e condições | verdadeiro | ||
Anexo de arquivo | falso | Não disponível no documento de modelo de registro. Disponível somente no documento de registro por meio de anexos. |
Componente de formulário adaptável | Componente XFA correspondente | Notas |
---|---|---|
Painel |
Subformulário |
O painel repetível é mapeado para um subformulário repetível. |
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 do Documento de registro. |
Texto | Texto |
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.
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 mestra do modelo base é usada como uma página mestra do modelo de 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 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.
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 o cabeçalho, o rodapé, o número da 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 da 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 mestra 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.
Clique em Arquivo > Novo.
Selecione o Com base em um modelo opção.
Selecione o Forms - Documento de registro categoria.
Selecionar Modelo base do DoR.
Clique em Próxima e fornecer 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 o Documento de registro. Não modifique ou remova scripts presentes no modelo base.
Modificação do modelo base
Siga rigorosamente as convenções e instruções mencionadas acima para criar um modelo base.
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 toque em .
Toque . A guia Documento de registro é exibida.
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 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:
Propriedades básicas:
Propriedades do campo de formulário:
Página principal Propriedades:
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>
Para salvar as alterações de marca, toque em Concluído.
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:
Selecione o componente Container de Formulário Adaptável (raiz).
Clique no para abrir as Propriedades do container do formulário adaptável.
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.
Toque em para salvar as propriedades.
Quando Documento do registro for criado usando um editor de Modelo de formulário adaptável, apenas duas opções estarão disponíveis em Documento do modelo de registro guia como Nenhum e Gerar 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
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
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 mestre. 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:
Opção XCI | Descrição |
---|---|
config/present/pdf/creator | Identifica o criador do documento usando a entrada Criador no dicionário de Informações do Documento. Para obter informações sobre este dicionário, consulte Guia de referência do PDF. |
config/present/pdf/producer | Identifica o produtor do documento usando a entrada Produtor no dicionário de Informações do documento. Para obter informações sobre este dicionário, consulte Guia de referência do PDF. |
config/present/layout | Controla se a saída é um painel único ou paginada. |
config/present/pdf/compression/level | Especifica o grau de compactação a ser usado ao gerar um documento PDF. |
config/present/pdf/fontInfo/embed | Controla a incorporação de fontes no documento de saída. |
config/present/pdf/scriptModel | Controla se informações específicas de XFA são incluídas no documento PDF de saída. |
config/present/common/data/adjustData | Controla se o aplicativo XFA ajusta os dados após a mesclagem. |
config/present/pdf/renderPolicy | Controla se a geração do conteúdo da página é feita no servidor ou adiada para o cliente. |
configuração/presente/comum/local | Especifica a localidade padrão usada no documento de saída. |
config/present/destination | Quando contido por um elemento presente, especifica o formato de saída. Quando contido por um elemento openAction, especifica a ação a ser executada ao abrir o documento em um cliente interativo. |
config/present/output/type | Especifica o tipo de compactação a ser aplicado a um arquivo ou o tipo de saída a ser produzido. |
config/present/common/temp/uri | Especifica o URI do formulário. |
config/present/common/template/base | Fornece um local base para URIs no design do formulário. Quando este elemento estiver ausente ou vazio, o local do design do formulário será usado como base. |
config/present/common/log/to | Controla o local onde os dados de log ou de saída são gravados. |
config/present/output/to | Controla o local onde os dados de log ou de saída são gravados. |
config/present/script/currentPage | Especifica a página inicial quando o documento é aberto. |
config/present/script/exclude | Informa o Forms as a Cloud Service sobre quais eventos ignorar. |
config/present/pdf/linearized | Controla se o documento de PDF de saída está linearizado. |
config/present/script/runScripts | Controla qual conjunto de scripts o Forms as a Cloud Service executa. |
config/present/pdf/tagged | Controla a inclusão de tags no documento de PDF de saída. As tags, no contexto de PDF, são informações adicionais incluídas em um documento para expor a estrutura lógica do documento. As tags auxiliam na acessibilidade e na reformatação. Por exemplo, um número de página pode ser marcado como um artefato para que um leitor de tela não o enuncie no meio do texto. Embora as tags tornem um documento mais útil, elas também aumentam o tamanho do documento e o tempo de processamento para criá-lo. |
config/present/pdf/fontInfo/alwaysEmbed | Especifica uma fonte que está incorporada no documento de saída. |
config/present/pdf/fontInfo/neverEmbed | Especifica uma fonte que nunca deve ser incorporada ao documento de saída. |
config/present/pdf/pdfa/part | Especifica o número da versão da especificação de PDF/A com a qual o documento está em conformidade. |
config/present/pdf/pdfa/amd | Especifica o nível de alteração da especificação PDF/A. |
config/present/pdf/pdfa/conformance | Especifica o nível de conformidade com a especificação PDF/A. |
config/present/pdf/version | Especifica a versão do documento PDF a ser gerada |
config/present/pdf/version/map | Especifica as fontes de fallback do documento |
Adicione o arquivo XCI personalizado ao projeto de desenvolvimento.
Especifique o seguinte propriedade inline:
{
"xciFilePath": "[path of XCI file]"
}
Por exemplo,
{
"xciFilePath": "/content/dam/formsanddocuments/customMinionProBoldAndTagged.xci"
}
Implante o projeto no seu ambiente Cloud Service.