Show Menu
TÓPICOS×

Relatórios de transação APIs faturáveis

A AEM Forms fornece várias APIs para enviar formulários, processar documentos e renderizar documentos. Algumas APIs são contabilizadas como transações e outras são livres de usar. Este documento fornece uma lista de todas as APIs que são contabilizadas como transações em um relatório de transação. Veja alguns cenários comuns em que uma API faturável é usada:
  • Envio de um formulário adaptável, formulário HTML5 e conjunto de formulários
  • Renderização de uma versão impressa ou da Web de uma comunicação interativa
  • Conversão de um documento de um formato para outro
  • Achatar um documento PDF dinâmico
  • Gerando um Documento de Registro
  • Mesclar um documento PDF interativo com outro documento PDF
  • Uso da etapa de atribuição de tarefa e das etapas de serviços de doc de Workflows AEM
  • Uso de formulário adaptável em um formulário adaptável
As APIs de cobrança não contabilizam o número de páginas, o comprimento de um documento ou formulário ou o formato final do documento renderizado. Um relatório de transação divide as transações em duas categorias: Documentos renderizados e Forms enviado.
  • Forms Submetido: Quando os dados são enviados de qualquer tipo de formulário criado com a AEM Forms e os dados são enviados para qualquer repositório ou banco de dados do armazenamento de dados é considerado como envio ao formulário. Por exemplo, o envio de um formulário adaptável, formulário HTML5, PDF forms e conjunto de formulários são contabilizados como formulários enviados. Cada formulário em um conjunto de formulários é considerado um envio. Por exemplo, se um conjunto de formulários tiver 5 formulários, quando o conjunto de formulários for submetido, o serviço de relatórios de transação contará como 5 envios.
  • Documentos renderizados: Gerar um documento combinando um modelo e dados, assinando ou certificando digitalmente um documento, usando APIs de serviços de documento faturáveis para serviços de documento ou convertendo um documento de um formato para outro são contabilizados como documentos renderizados.
A interface do usuário de Relatórios de Transação exibe três categorias: Forms Submetido, Documentos Renderizados e Documentos Processados. Os Documentos Renderizados e os Documentos Processados são contabilizados como Documentos Renderizados.

APIs de serviços de Documento faturáveis

Gerar serviço PDF

API
Descrição Categoria do relatório de transação Informações adicionais
createPDF Cria o Adobe PDF a partir de tipos de arquivos suportados. Documentos processados
createPDF2 Cria o Adobe PDF a partir de tipos de arquivos suportados. Documentos processados
exportPDF Converte o Adobe PDF em tipos de arquivos suportados. Documentos processados
exportPDF2 Converte o Adobe PDF em tipos de arquivos suportados. Documentos processados
exportPDF3 Converte o Adobe PDF em tipos de arquivos suportados. Documentos processados
htmlFileToPdf
Cria PDF de páginas HTML.
Documentos processados
htmlToPdf Cria PDF a partir de URLs apontando para uma página HTML. Documentos processados
htmlToPdf2 Cria PDF a partir de URLs apontando para uma página HTML. Documentos processados
otimizePDF Otimiza o PDF para reduzir o tamanho do arquivo, removendo metadados desnecessários sem afetar a qualidade. Documentos processados

Serviço Distiller

API
Descrição Categoria do relatório de transação Informações adicionais
createPDF Cria o Adobe PDF a partir de tipos de arquivos suportados. Documentos processados
createPDF2 Cria o Adobe PDF a partir de tipos de arquivos suportados. Documentos processados

Documento do serviço de registro (serviço DoR)

API
Descrição Categoria do relatório de transação Informações adicionais
renderizar Chama o método de renderização especificado para gerar um documento de registro usando parâmetros fornecidos. Documentos processados

Serviço de saída

API
Descrição Categoria do relatório de transação Informações adicionais
generatePDFOutput Une dados e modelos para criar um documento PDF. Documentos processados
generatePDFOutput Une dados e modelos para criar um documento PDF. Documentos processados
generatePDFOutputBatch Une dados e modelos para criar um conjunto de documentos PDF. Documentos processados A API generatePDFOutputBatch combina um modelo de formulário com um registro e gera um PDF. Quando você processa um lote de registros, o serviço de relatórios de transações conta cada registro como uma representação em PDF separada. Você pode usar o sinalizador getGeneratemanyFiles para combinar várias execuções em um único arquivo PDF. Independentemente do status do sinalizador, o serviço conta cada registro como uma execução em PDF separada.
generatePrintedOutput Converte documentos XDP e PDF em formatos PostScript (PS), PCL (Printer Command Language) e ZPL. Documentos processados
generatePrintedOutput Converte documentos XDP e PDF em formatos PostScript (PS), PCL (Printer Command Language) e ZPL. Documentos processados
generatePrintedOutputBatch Converte um conjunto de documentos XDP e PDF em um conjunto de formatos PostScript (PS), PCL (Printer Command Language) e ZPL. Documentos processados A API generatePDFOutputBatch combina um modelo de formulário com um registro e gera um PDF. Quando você processa um lote de registros, o serviço de relatórios de transações conta cada registro como uma representação em PDF separada. Você pode usar o sinalizador getGeneratemanyFiles para combinar várias execuções em um único arquivo PDF. Independentemente do status do sinalizador, o serviço conta cada registro como uma execução em PDF separada.

Serviço do Forms

API
Descrição Categoria do relatório de transação Informações adicionais
renderPDFForm Renderiza o formulário PDF a partir de modelos XDP. Os modelos do XP são criados no Forms Designer. Documentos processados
exportData Extrai dados de um formulário PDF ou modelos XDP Documentos processados

Converter serviço PDF

API
Descrição Categoria do relatório de transação Informações adicionais
toImage Converte um documento PDF em uma lista de documentos de imagem. Os formatos de imagem suportados são JPEG, JPEG2K, PNG e TIFF. Documentos processados
toPS Converte um arquivo PDF simples em formato PostScript usando as opções especificadas na especificação da opção. Documentos processados

Serviço Forms com código de barras

API
Descrição Categoria do relatório de transação Informações adicionais
decodificação Decodifica todos os códigos de barras em um objeto de Documento e retorna um objeto org.w3c.dom.Documento que contém dados recuperados do código de barras. Documentos processados

Serviço de Assembler

API
Descrição Categoria do relatório de transação Informações adicionais
invocar Executa o documento DDX especificado e retorna um objeto AssemblerResult contendo os documentos resultantes. Documentos processados As seguintes operações não são contabilizadas como transações:
  • Criação de pacotes ou portfólio
  • Como criar vários XDPs
invocar Executa o documento DDX especificado e retorna um objeto AssemblerResult contendo os documentos resultantes. Documentos processados Todos os formatos de arquivo de entrada suportados pelos serviços de Gerador de PDF, Forms e Saída, o serviço Assembler oferece suporte a todos esses formatos como formatos de arquivo de saída.
toPDFA Converta um documento especificado em PDF/A usando as opções especificadas. Documentos processados
  • A API de chamada do serviço de montador pode chamar internamente uma API faturável de outro serviço, dependendo da entrada. Portanto, a API de chamada pode ser considerada como nenhuma, única ou várias transações. O número de transações contadas depende da entrada e das APIs internas chamadas.
  • Um único documento PDF produzido usando o serviço de montador pode ser considerado como nenhuma, única ou várias transações. O número de transações contadas depende do código DDX fornecido.

Serviço de utilitário PDF

API
Descrição Categoria do relatório de transação Informações adicionais
convertPDFtoXDP Converte um documento PDF em um arquivo XDP. Para que um documento PDF seja convertido com êxito em um arquivo XDP, o documento PDF deve conter um fluxo XFA no dicionário AcroForm. Documentos processados

APIs de captura de dados faturáveis

Todos os eventos de envio de formulários adaptáveis, HTML5 Forms e conjunto de formulários são contabilizados como transações. Por padrão, o envio de um formulário PDF não é contabilizado como uma transação. Use a API do gravador de transações fornecida para registrar uma submissão de PDF forms como uma transação.

Formulários adaptáveis

Caso de uso
Descrição Categoria do relatório de transação Informações adicionais
Enviar um formulário adaptável Envia um formulário adaptável para a ação de envio configurada. Formulários enviados
  • Contrapartidas bem-sucedidas para uma ou duas transações. O número de transações contadas depende do tipo de ação de submissão usada para submissão. Por exemplo, enviar PDF por email enviando contas de ação para duas contagens de transações. Uma transação para envio de formulário e outra para PDF gerada usando o serviço Documento de registro (DOR).
  • O uso do formulário adaptável em um formulário adaptável (Conjunto de formulários adaptáveis) conta somente uma única transação. É possível ter qualquer número de formulários adaptáveis em um formulário adaptável.

Formulários HTML5

Caso de uso
Descrição Categoria do relatório de transação Informações adicionais
Envio de um formulário HTML5 Envia um formulário HTML5 para enviar o URL configurado no formulário. Formulários enviados

Conjunto de formulários

API
Descrição Categoria do relatório de transação Informações adicionais
Como enviar um conjunto de formulários Envia o conjunto de formulários para o URL de envio configurado no conjunto de formulários. Formulários enviados
  • O uso do formulário adaptável em um formulário adaptável (Conjunto de formulários adaptáveis) conta somente uma única transação. É possível ter qualquer número de formulários adaptáveis em um formulário adaptável.
  • Cada formulário em um formulário HTML5 Forms define contas como uma transação separada.

Comunicação interativa faturável e Workflows de AEM centrados em forma em APIs OSGi

Atribua etapas de serviços de tarefa e documento a Workflows de AEM centrados em forma no OSGi e todas as execuções de comunicação interativa e são contabilizadas como transações. A visualização de uma comunicação interativa na instância do autor e a visualização na instância de publicação usando a interface do usuário do agente não são contabilizadas como transações. Se uma etapa do fluxo de trabalho contabilizar uma transação e o fluxo de trabalho não for concluído, a contagem de transações não será revertida.

Comunicação interativa - Canal da Web

API
Descrição Categoria do relatório de transação Informações adicionais
Como renderizar um canal da Web Abre a versão da Web de uma comunicação interativa. Documentos renderizados

Interactive Communication - Print Channel

API
Descrição Categoria do relatório de transação Informações adicionais
renderizar (converter em PDF) Gera a versão PDF de uma comunicação interativa. Documentos renderizados

Workflows de AEM centrados em forma no OSGi

Caso de uso
Categoria do relatório de transação Informações adicionais
Enviando uma etapa Atribuir Tarefa Formulários enviados
Enviar um ponto de partida de aplicativo de fluxo de trabalho Formulários enviados
Enviar uma comunicação interativa (Canal de impressão) da interface do usuário do agente para um fluxo de trabalho Documentos renderizados

Registrando APIs faturáveis como transações para código personalizado

Ações como enviar um formulário PDF, usar a interface do usuário do agente para pré-visualização de uma comunicação interativa, usar envio de formulário não padrão e implementações personalizadas não são contabilizadas como transações. A AEM Forms fornece uma API para registrar ações como transações. Você pode chamar a API de suas implementações personalizadas para registrar uma transação .