Renderização do Forms por valor rendering-forms-by-value
Exemplos e exemplos neste documento são somente para AEM Forms no ambiente JEE.
Normalmente, um design de formulário criado no Designer é transmitido por referência ao serviço do Forms. Os designs de formulário podem ser grandes e, como resultado, é mais eficiente passá-los por referência para evitar a necessidade de empacotar bytes de design de formulário por valor. O serviço Forms também pode armazenar o design do formulário em cache para que, quando armazenado em cache, ele não precise ler o design do formulário continuamente.
Se um design de formulário contiver um atributo UUID, ele será armazenado em cache. O valor UUID é exclusivo para todos os designs de formulário e é usado para identificar exclusivamente um formulário. Ao renderizar um formulário por valor, o formulário só deve ser armazenado em cache quando usado repetidamente. No entanto, se o formulário não for usado repetidamente e precisar ser exclusivo, é possível evitar o armazenamento em cache usando as opções de armazenamento em cache definidas com a API do AEM Forms.
O serviço Forms também pode resolver o local do conteúdo vinculado no design do formulário. Por exemplo, imagens vinculadas referenciadas no design do formulário são URLs relativas. O conteúdo vinculado é sempre considerado como relativo ao local de design do formulário. Portanto, resolver o conteúdo vinculado é uma questão de determinar sua localização aplicando o caminho relativo ao local absoluto do design do formulário.
Em vez de passar um design de formulário por referência, você pode passar um design de formulário por valor. Transmitir um design de formulário por valor é eficiente quando um design de formulário é criado dinamicamente; ou seja, quando um aplicativo cliente gera o XML que cria um design de formulário durante o tempo de execução. Nessa situação, um design de formulário não é armazenado em um repositório físico porque ele é armazenado na memória. Ao criar dinamicamente um design de formulário em tempo de execução e passá-lo por valor, você pode armazenar o formulário em cache e melhorar o desempenho do serviço do Forms.
Limitações da transmissão de um formulário por valor
As seguintes limitações se aplicam quando um design de formulário é passado pelo valor:
- Nenhum conteúdo vinculado relativo pode estar dentro do design do formulário. Todas as imagens e fragmentos devem ser incorporados no design do formulário ou referenciados de forma absoluta.
- Os cálculos do lado do servidor não podem ser executados após o formulário ser renderizado. Se o formulário for enviado de volta para o serviço Forms, os dados serão extraídos e retornados sem nenhum cálculo do lado do servidor.
- Como o HTML só pode usar imagens vinculadas em tempo de execução, não é possível gerar o HTML com imagens incorporadas. Isso ocorre porque o serviço Forms oferece suporte a imagens incorporadas com HTML ao recuperar as imagens de um design de formulário referenciado. Como um design de formulário transmitido por valor não tem um local de referência, as imagens incorporadas não podem ser extraídas quando a página de HTML é exibida. Portanto, as referências de imagem devem ser caminhos absolutos para serem renderizados em HTML.
Resumo das etapas summary-of-steps
Para renderizar um formulário por valor, execute as seguintes etapas:
- Incluir arquivos de projeto.
- Crie um objeto da API do cliente do Forms.
- Faça referência ao design do formulário.
- Renderiza um formulário por valor.
- Grave o fluxo de dados do formulário no navegador da Web do cliente.
Incluir arquivos de projeto
Inclua os arquivos necessários no projeto de desenvolvimento. Se você estiver criando uma aplicação cliente usando Java, inclua os arquivos JAR necessários. Se você estiver usando serviços da Web, certifique-se de incluir os arquivos proxy.
Criar um objeto da API do cliente do Forms
Antes de importar dados programaticamente para uma API do cliente do formulário PDF, você deve criar um cliente do serviço de Integração de dados. Ao criar um cliente de serviço, você define as configurações de conexão necessárias para chamar um serviço.
Referenciar o design do formulário
Ao renderizar um formulário por valor, é necessário criar um objeto com.adobe.idp.Document
que contenha o design do formulário a ser renderizado. Você pode referenciar um arquivo XDP existente ou criar dinamicamente um design de formulário em tempo de execução e preencher um com.adobe.idp.Document
com esses dados.
Renderizar um formulário pelo valor
Para renderizar um formulário por valor, passe uma instância com.adobe.idp.Document
que contenha o design do formulário para o parâmetro inDataDoc
do método de renderização (pode ser qualquer um dos métodos de renderização do objeto FormsServiceClient
, como renderPDFForm
, (Deprecated) renderHTMLForm
e assim por diante). Normalmente, esse valor de parâmetro é reservado para dados mesclados com o formulário. Da mesma forma, passe um valor de cadeia de caracteres vazio para o parâmetro formQuery
. Normalmente, esse parâmetro requer um valor de sequência de caracteres que especifica o nome do design do formulário.
xfa:datasets
. Para obter informações sobre a arquitetura XFA, acesse https://www.pdfa.org/norm-refs/XFA-3_3.pdf.Gravar o fluxo de dados de formulário no navegador Web cliente
Quando o serviço Forms renderiza um formulário por valor, ele retorna um fluxo de dados de formulário que você deve gravar no navegador da Web do cliente. Quando gravado no navegador da Web do cliente, o formulário fica visível para o usuário.
Consulte também
Renderizar um formulário por valor usando a API Java
Renderizar um formulário por valor usando a API do serviço Web
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
Início rápido da API de serviço do Forms
Renderizar um formulário por valor usando a API Java render-a-form-by-value-using-the-java-api
Renderize um formulário por valor usando a API do Forms (Java):
-
Incluir arquivos de projeto
Inclua arquivos JAR do cliente, como adobe-forms-client.jar, no caminho de classe do projeto Java.
-
Criar um objeto da API do cliente do Forms
- Crie um objeto
ServiceClientFactory
que contenha propriedades de conexão. - Crie um objeto
FormsServiceClient
usando seu construtor e transmitindo o objetoServiceClientFactory
.
- Crie um objeto
-
Referência ao design do formulário
- Crie um objeto
java.io.FileInputStream
que represente o design do formulário a ser renderizado usando seu construtor e transmitindo um valor de cadeia de caracteres que especifique o local do arquivo XDP. - Crie um objeto
com.adobe.idp.Document
usando seu construtor e transmitindo o objetojava.io.FileInputStream
.
- Crie um objeto
-
Renderizar um formulário por valor
Invoque o método
renderPDFForm
do objetoFormsServiceClient
e passe os seguintes valores:- Um valor de string vazio. (Normalmente, esse parâmetro requer um valor de sequência de caracteres que especifica o nome do design do formulário.)
- Um objeto
com.adobe.idp.Document
que contém o design do formulário. Normalmente, esse valor de parâmetro é reservado para dados que são mesclados com o formulário. - Um objeto
PDFFormRenderSpec
que armazena opções de tempo de execução. Este é um parâmetro opcional e você pode especificarnull
se não quiser especificar opções de tempo de execução. - Um objeto
URLSpec
que contém valores de URI exigidos pelo serviço Forms. - Um objeto
java.util.HashMap
que armazena anexos de arquivo. Este é um parâmetro opcional e você pode especificarnull
se não quiser anexar arquivos ao formulário.
O método
renderPDFForm
retorna um objetoFormsResult
que contém um fluxo de dados de formulário que pode ser gravado no navegador Web cliente. -
Gravar o fluxo de dados do formulário no navegador Web cliente
- Crie um objeto
com.adobe.idp.Document
invocando o métodogetOutputContent
do objetoFormsResult
. - Obtenha o tipo de conteúdo do objeto
com.adobe.idp.Document
invocando seu métodogetContentType
. - Defina o tipo de conteúdo do objeto
javax.servlet.http.HttpServletResponse
invocando seu métodosetContentType
e transmitindo o tipo de conteúdo do objetocom.adobe.idp.Document
. - Crie um objeto
javax.servlet.ServletOutputStream
usado para gravar o fluxo de dados de formulário no navegador da Web cliente, chamando o métodogetOutputStream
do objetojavax.servlet.http.HttpServletResponse
. - Crie um objeto
java.io.InputStream
invocando o métodogetInputStream
do objetocom.adobe.idp.Document
. - Crie uma matriz de bytes e aloque o tamanho do objeto
InputStream
. Invoque o métodoavailable
do objetoInputStream
para obter o tamanho do objetoInputStream
. - Preencha a matriz de bytes com o fluxo de dados de formulário chamando o método
read
do objetoInputStream
e transmitindo a matriz de bytes como um argumento. - Invoque o método
write
do objetojavax.servlet.ServletOutputStream
para enviar o fluxo de dados de formulário para o navegador Web cliente. Passar a matriz de bytes para o métodowrite
.
- Crie um objeto
Consulte também
Renderização do Forms por valor
Início rápido (modo SOAP): renderização por valor usando a API Java
Renderizar um formulário por valor usando a API do serviço Web render-a-form-by-value-using-the-web-service-api
Renderize um formulário por valor usando a API do Forms (serviço Web):
-
Incluir arquivos de projeto
- Crie classes de proxy Java que consomem o serviço WSDL do Forms.
- Inclua as classes de proxy Java no caminho da classe.
-
Criar um objeto da API do cliente do Forms
Crie um objeto
FormsService
e defina valores de autenticação. -
Referência ao design do formulário
- Crie um objeto
java.io.FileInputStream
usando seu construtor. Transmita um valor de string que especifique o local do arquivo XDP. - Crie um objeto
BLOB
usando seu construtor. O objetoBLOB
é usado para armazenar um documento PDF que está criptografado com uma senha. - Crie uma matriz de bytes que armazene o conteúdo do objeto
java.io.FileInputStream
. Você pode determinar o tamanho da matriz de bytes obtendo o tamanho do objetojava.io.FileInputStream
usando seu métodoavailable
. - Preencha a matriz de bytes com dados de fluxo invocando o método
read
do objetojava.io.FileInputStream
e transmitindo a matriz de bytes. - Preencha o objeto
BLOB
invocando seu métodosetBinaryData
e transmitindo a matriz de bytes.
- Crie um objeto
-
Renderizar um formulário por valor
Invoque o método
renderPDFForm
do objetoFormsService
e passe os seguintes valores:- Um valor de string vazio. (Normalmente, esse parâmetro requer um valor de sequência de caracteres que especifica o nome do design do formulário.)
- Um objeto
BLOB
que contém o design do formulário. Normalmente, esse valor de parâmetro é reservado para dados que são mesclados com o formulário. - Um objeto
PDFFormRenderSpec
que armazena opções de tempo de execução. Este é um parâmetro opcional e você pode especificarnull
se não quiser especificar opções de tempo de execução. - Um objeto
URLSpec
que contém valores de URI exigidos pelo serviço Forms. - Um objeto
java.util.HashMap
que armazena anexos de arquivo. Este é um parâmetro opcional e você pode especificarnull
se não quiser anexar arquivos ao formulário. - Um objeto
com.adobe.idp.services.holders.BLOBHolder
vazio preenchido pelo método. Isso é usado para armazenar o formulário de PDF renderizado. - Um objeto
javax.xml.rpc.holders.LongHolder
vazio preenchido pelo método. (Esse argumento armazena o número de páginas no formulário.) - Um objeto
javax.xml.rpc.holders.StringHolder
vazio preenchido pelo método. (Esse argumento armazena o valor do local.) - Um objeto
com.adobe.idp.services.holders.FormsResultHolder
vazio que conterá os resultados desta operação.
O método
renderPDFForm
preenche o objetocom.adobe.idp.services.holders.FormsResultHolder
que é passado como o último valor de argumento com um fluxo de dados de formulário que deve ser gravado no navegador Web cliente. -
Gravar o fluxo de dados do formulário no navegador Web cliente
- Crie um objeto
FormResult
obtendo o valor do membro de dadosvalue
do objetocom.adobe.idp.services.holders.FormsResultHolder
. - Crie um objeto
BLOB
que contenha dados de formulário invocando o métodogetOutputContent
do objetoFormsResult
. - Obtenha o tipo de conteúdo do objeto
BLOB
invocando seu métodogetContentType
. - Defina o tipo de conteúdo do objeto
javax.servlet.http.HttpServletResponse
invocando seu métodosetContentType
e transmitindo o tipo de conteúdo do objetoBLOB
. - Crie um objeto
javax.servlet.ServletOutputStream
usado para gravar o fluxo de dados de formulário no navegador da Web cliente, chamando o métodogetOutputStream
do objetojavax.servlet.http.HttpServletResponse
. - Crie uma matriz de bytes e preencha-a chamando o método
getBinaryData
do objetoBLOB
. Esta tarefa atribui o conteúdo do objetoFormsResult
à matriz de bytes. - Invoque o método
write
do objetojavax.servlet.http.HttpServletResponse
para enviar o fluxo de dados de formulário para o navegador Web cliente. Passar a matriz de bytes para o métodowrite
.
- Crie um objeto
Consulte também
Renderização do Forms por valor
Chamada de AEM Forms usando codificação Base64