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

CAUTION
AEM 6.4 chegou ao fim do suporte estendido e esta documentação não é mais atualizada. Para obter mais detalhes, consulte nossa períodos de assistência técnica. Encontre as versões compatíveis here.

Lista de todas as APIs que são contabilizadas como transações

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 podem ser usadas livremente. Este documento fornece uma lista de todas as APIs que são contabilizadas como transações em um relatório de transações. 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
  • Converter um documento de um formato para outro
  • Nivelar um documento de PDF dinâmico
  • Gerar um Documento de Registro
  • Mesclar um documento PDF interativo com outro documento PDF
  • Uso da etapa de atribuição de tarefa e etapas de serviços de documento de AEM Workflows
  • Uso de formulários adaptáveis em um formulário adaptável

As APIs de faturamento 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ções divide as transações em três categorias: Documentos processados, Documentos renderizados e Forms Enviados.

  • Forms Enviada: 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 de armazenamento de dados ou banco de dados é considerado envio de formulário. Por exemplo, o envio de um formulário adaptável, HTML5 Form, PDF forms e conjunto de formulários são considerados 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 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 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.
NOTE
A interface do usuário de Relatórios de transação exibe três categorias: Forms Enviado, 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ção
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 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 a partir de HTML pages.
Documentos processados
htmlToPdf
Cria PDF a partir de URLs que apontam para uma página HTML.
Documentos processados
htmlToPdf2
Cria PDF a partir de URLs que apontam 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 distiller-service

API
Descrição
Categoria do relatório de transação
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 (DoR Service) document-of-record-service-dor-service

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

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
generatePDFOutputBatch
Une dados e modelos para criar um conjunto de documentos PDF.
Documentos processados
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 de arquivo PostScript (PS), PCL (Printer Command Language) e ZPL.
Documentos processados

Serviço do Forms forms-service

API
Descrição
Categoria do relatório de transação
Informações adicionais
renderPDFForm
Renderiza o PDF Form a partir de modelos XDP. Os modelos 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çã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 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çã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.Document que contém dados recuperados do código de barras.
Documentos processados

Serviço de Assembler assembler-service

API
Descrição
Categoria do relatório de transação
Informações adicionais
invocar
Executa o documento DDX especificado e retorna um AssemblerResult objeto 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 configurar vários XDPs
invocar
Executa o documento DDX especificado e retorna um AssemblerResult objeto contendo os documentos resultantes.
Documentos processados
Todos os formatos de arquivo de entrada que os serviços PDF Generator, Forms e Output suportam, o serviço Assembler suporta 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
NOTE
  • A API invoke do serviço de montagem pode chamar internamente uma API faturável de outro serviço, dependendo da entrada. Portanto, a API de chamada pode ser contabilizada 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 de PDF produzido usando o serviço de montagem pode ser contabilizado como nenhuma, única ou várias transações. O número de transações contadas depende do código DDX fornecido.

Serviço Utilitário PDF pdf-utility-service

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

Serviço de Garantia de Doc doc-assurance-service

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

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 PDF não é contabilizado como uma transação. Use o API de relatórios de transação 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ção
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
  • Envios bem-sucedidos de uma ou duas transações. O número de transações contadas depende do tipo de ação de envio usada para envio. Por exemplo, o envio de PDF por email para enviar 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 Document of Record (DOR) .
  • O uso do formulário adaptável em um formulário adaptável (Adaptive Form Form Forset) conta somente 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çã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 form-set

API
Descrição
Categoria do relatório de transação
Informações adicionais
Envio de um conjunto de formulários
Envia o formulário definido 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 (Adaptive Form Form Forset) conta somente uma transação. É possível ter qualquer número de formulários adaptáveis em um formulário adaptável.
  • Cada formulário em um conjunto de formulários HTML5 Forms é contabilizado como uma transação separada.

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

Atribua etapas de tarefas e serviços de documento de Fluxos de trabalho de AEM centrados em formulários 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 de transações não será revertida.

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

API
Descrição
Categoria do relatório de transação
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ção
Informações adicionais
renderizar (converter em PDF)
Gera a versão PDF de uma comunicação interativa.
Documentos renderizados

Fluxos de trabalho de AEM centrados em formulários no OSGi form-centric-aem-workflows-on-osgi

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

Registro de APIs faturáveis como transações do 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ário 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 das implementações personalizadas para registrar uma transação.

Artigos relacionados related-articles

recommendation-more-help
a6ebf046-2b8b-4543-bd46-42a0d77792da