APIs de relatórios de transação faturáveis transaction-reports-billable-apis

O 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 para uso. Este documento fornece uma lista de todas as APIs que são contabilizadas como transações em um relatório de transações. Estes são 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
  • Nivelamento de um documento PDF dinâmico
  • Gerar um documento de registro
  • Mesclar um documento PDF interativo com outro documento PDF
  • Usando a etapa atribuir tarefa e as etapas serviços de documento dos fluxos de trabalho do AEM
  • Uso de formulário adaptável em um formulário adaptável

As APIs de faturamento não levam em conta 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ções divide as transações em duas categorias: Documentos Renderizados e Forms Submetidos.

  • Forms enviado: Quando os dados são enviados de qualquer tipo de formulário criado com o AEM Forms e os dados são enviados para qualquer repositório ou banco de dados de armazenamento de dados, é considerado o envio do formulário. Por exemplo, o envio de um formulário adaptável, o Formulário HTML, os PDF forms e o 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 for enviado, o serviço de relatório de transações o contará como 5 envios.

  • Documentos renderizados: Gerar um documento combinando um modelo e dados, assinando ou certificando digitalmente um documento, usando uma API de serviços de documento faturável para serviços de documento ou convertendo um documento de um formato para outro são considerados documentos renderizados.

NOTE
A interface dos Relatórios de Transação exibe três categorias: Forms Submetido, Documentos Renderizados e Documentos Processados. Tanto os Documentos renderizados quanto os Documentos processados são contabilizados como Documentos renderizados.

APIs de serviços de documento faturáveis billable-document-services-apis

Gerar serviço de PDF generate-pdf-service

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

Serviço DocAssurance DocAssurance-Service

API
Descrição
Categoria do relatório de transações
Informações adicionais
secureDocument
Essa API permite que você proteja seu documento. Você pode usar a API para assinar, certificar, estender o leitor ou criptografar um documento PDF.
Documentos processados
Somente assinar e certificar a operação do secureDocument são cobrados.

Serviço Distiller distiller-service

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

Documento do serviço de registro (serviço DoR) document-of-record-service-dor-service

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

Serviço de saída output-service

API
Descrição
Categoria do relatório de transações
Informações adicionais
generatePDFOutput
Mescla dados e modelos para criar um documento PDF.
Documentos processados
generatePDFOutput
Mescla dados e modelos para criar um documento PDF.
Documentos processados
generatePDFOutputBatch
Mescla 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ório de transações conta cada registro como uma representação de PDF separada.
Você pode usar o getGenerateManyFiles sinalizador para combinar várias representações em um único arquivo PDF. Independentemente do status do sinalizador, o serviço conta cada registro como uma representação de PDF separada.
generatePrintedOutput
Converte documentos XDP e PDF em formatos de arquivo PostScript (PS), Printer Command Language (PCL) e ZPL.
Documentos processados
generatePrintedOutput
Converte documentos XDP e PDF em formatos de arquivo PostScript (PS), Printer Command Language (PCL) e ZPL.
Documentos processados
generatePrintedOutputBatch
Converte um conjunto de documentos XDP e PDF em um conjunto de formatos de arquivo PostScript (PS), Printer Command Language (PCL) 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ório de transações conta cada registro como uma representação de PDF separada.
Você pode usar o getGenerateManyFiles sinalizador para combinar várias representações em um único arquivo PDF. Independentemente do status do sinalizador, o serviço conta cada registro como uma representação de PDF separada.

Serviço do Forms forms-service

API
Descrição
Categoria do relatório de transações
Informações adicionais
renderPDFForm
Renderiza o formulário de 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 de PDF convert-pdf-service

API
Descrição
Categoria do relatório de transações
Informações adicionais
toImage
Converte um documento PDF em uma lista de documentos de imagem. Os formatos de imagem compatíveis são JPEG, JPEG2K, PNG e TIFF.
Documentos processados
toPS
Converte um arquivo de 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 barcoded-forms-service

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

Serviço de Assembler assembler-service

API
Descrição
Categoria do relatório de transações
Informações adicionais
invocar
Executa o documento DDX especificado e retorna um AssemblerResult objeto que contém os documentos resultantes.
Documentos processados

As seguintes operações não são contabilizadas como transações:

  • Criação de pacotes ou portfólio
  • Compilação de vários XDPs
invocar
Executa o documento DDX especificado e retorna um AssemblerResult objeto que contém os documentos resultantes.
Documentos processados
Todos os formatos de arquivo de entrada compatíveis com os serviços PDF Generator, Forms e Output, o serviço Assembler é compatível com 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

O uso da API de chamada é contado como uma transação, quando você executa uma ou mais das seguintes operações:

  1. Conversão de formatos sem PDF para formatos PDF. Por exemplo, a conversão do formato XDP para o formato PDF, atendendo a formas de comunicação interativas e não interativas e a conversão do Word para o PDF.
  2. Conversão do formato PDF para o formato PDF/A.
  3. Conversão do formato PDF para formatos não PDF. Os exemplos englobam a transformação do formato PDF para o formato Imagem ou a conversão do formato PDF para Texto.
NOTE
  • A API de chamada do serviço do montador pode chamar internamente uma API faturável de outro serviço, dependendo da entrada. Portanto, a API invoke pode ser contabilizada como nenhuma, uma única ou várias transações. O número de transações contadas depende da entrada e das APIs internas chamadas.
  • Um único documento de PDF produzido usando o serviço de montagem pode ser contabilizado como nenhuma, uma única ou várias transações. O número de transações contadas depende do código DDX fornecido.

Serviço do utilitário PDF pdf-utility-service

API
Descrição
Categoria do relatório de transações
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 billable-data-capture-apis

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 de PDF não é contabilizado como uma transação. Usar o fornecido API do gravador de transações para registrar um envio de PDF forms como uma transação.

Adaptive Forms adaptive-forms

Caso de uso
Descrição
Categoria do relatório de transações
Informações adicionais
Envio de um formulário adaptável
Envia um formulário adaptável para a ação de envio configurada.
Formulários enviados
  • Os envios bem-sucedidos levam em conta uma ou duas transações. O número de transações contadas depende do tipo de ação de envio usado para envio. Por exemplo, o envio de PDF por meio de ações de envio de email contabiliza duas contagens de transações. Uma transação para envio de formulário e outra para PDF gerado usando o serviço de Documento de registro (DOR).
  • O uso do formulário adaptável em um formulário adaptável (conjunto de formulários de formulário adaptável) contabiliza apenas uma transação. É possível ter qualquer número de formulários adaptáveis em um formulário adaptável.

Formulários HTML5 html-forms

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

Conjunto de formulários form-set

API
Descrição
Categoria do relatório de transações
Informações adicionais
Envio de um conjunto de formulários
Envia o conjunto de formulários para a URL de envio configurada 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 de formulário adaptável) contabiliza apenas uma transação. É possível ter qualquer número de formulários adaptáveis em um formulário adaptável.
  • Todos os formulários em um conjunto de formulários HTML5 Forms são considerados uma transação separada.

Comunicação interativa faturável e fluxos de trabalho do AEM centrados em formulário nas APIs OSGi billable-interactive-communication-and-form-centric-aem-workflows-on-osgi-apis

Atribua etapas de serviços de tarefa e documento de Workflows do AEM centrados em formulário no OSGi e todas as representaçõ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 da transação não será revertida.

Comunicação interativa - Canal da Web interactive-communication-web-channel

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

Comunicação interativa - Canal de impressão interactive-communication-print-channel

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

Workflows do AEM centrados em formulários no OSGi form-centric-aem-workflows-on-osgi

Caso de uso
Categoria do relatório de transações
Informações adicionais
Submetendo uma etapa Atribuir Tarefa
Formulários enviados
Envio de um ponto de partida de aplicativo de fluxo de trabalho
Formulários enviados
Envio de 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 recording-billable-apis-as-transactions-for-custom-code

Ações como enviar um Formulário PDF, usar a interface do usuário do agente para visualizar uma comunicação interativa, usar o envio de formulários não padrão e implementações personalizadas não são contabilizadas como transações. O 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.

Artigos relacionados related-articles

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2