API fatturabili report transazioni

AEM Forms fornisce diverse API per l'invio di moduli, l'elaborazione di documenti e il rendering di documenti. Alcune API sono considerate come transazioni e altre sono gratuite da utilizzare. Questo documento fornisce un elenco di tutte le API contabilizzate come transazioni in un rapporto sulle transazioni. Di seguito sono riportati alcuni scenari comuni in cui viene utilizzata un'API fatturabile:

  • Invio di un modulo adattivo, un modulo HTML5 e un set di moduli
  • Rendering di una versione per la stampa o il Web di una comunicazione interattiva
  • Conversione di un documento da un formato a un altro
  • Appiattimento di un documento PDF dinamico
  • Generazione di un documento di record
  • Unione di un documento PDF interattivo con un altro documento PDF
  • Utilizzo della fase di assegnazione delle attività e dei passi dei servizi doc di AEM Flussi di lavoro
  • Uso di moduli adattivi all'interno di un modulo adattivo

Le API di fatturazione non tengono conto del numero di pagine, della lunghezza di un documento o modulo o del formato finale del documento di cui è stato effettuato il rendering. Un rapporto sulle transazioni divide le transazioni in due categorie: Documenti sottoposti a rendering e Forms inviati.

  • Forms inviato: Quando i dati vengono inviati da qualsiasi tipo di modulo creato con AEM Forms e i dati vengono inviati a qualsiasi archivio dati o database è considerato invio del modulo. Ad esempio, l'invio di un modulo adattivo, di un modulo HTML5, di PDF forms e di un set di moduli viene contabilizzato come moduli inviati. Ciascun modulo in un set di moduli è considerato un invio. Ad esempio, se un set di moduli contiene 5 moduli, all'invio del set di moduli il servizio di reporting delle transazioni li conteggia come 5 invii.

  • Documenti sottoposti a rendering: La generazione di un documento mediante la combinazione di un modello e dati, la firma digitale o la certificazione di un documento, l'utilizzo di API Document Services fatturabili per Document Services o la conversione di un documento da un formato a un altro vengono contabilizzate come documenti sottoposti a rendering.

Nota

L'interfaccia utente Rapporti transazione presenta tre categorie: Forms Inviato, Documenti sottoposti a rendering e Documenti elaborati. Sia i documenti sottoposti a rendering che i documenti elaborati vengono considerati come documenti sottoposti a rendering.

API Document Services fatturabili

Genera servizio PDF

API

Descrizione Categoria report transazioni Informazioni aggiuntive
createPDF Crea Adobe PDF dai tipi di file supportati. Documenti elaborati
createPDF2 Crea Adobe PDF dai tipi di file supportati. Documenti elaborati
exportPDF Converte Adobe PDF in tipi di file supportati. Documenti elaborati
exportPDF2 Converte Adobe PDF in tipi di file supportati. Documenti elaborati
exportPDF3 Converte Adobe PDF in tipi di file supportati. Documenti elaborati
htmlFileToPdf

Crea PDF da pagine HTML.

Documenti elaborati
htmlToPdf Crea PDF da URL che puntano a una pagina HTML. Documenti elaborati
htmlToPdf2 Crea PDF da URL che puntano a una pagina HTML. Documenti elaborati
optimizePDF Ottimizza i file PDF per ridurne le dimensioni eliminando i metadati non necessari senza comprometterne la qualità. Documenti elaborati

Distiller Service

API

Descrizione Categoria report transazioni Informazioni aggiuntive
createPDF
Crea Adobe PDF dai tipi di file supportati. Documenti elaborati
createPDF2 Crea Adobe PDF dai tipi di file supportati. Documenti elaborati

Servizio Document of Record (DoR Service)

API

Descrizione Categoria report transazioni Informazioni aggiuntive
rendering Richiama il metodo di rendering specificato per generare un documento di record utilizzando i parametri forniti. Documenti elaborati

Servizio di output

API

Descrizione Categoria report transazioni Informazioni aggiuntive
generatePDFOutput Unisce dati e modelli per creare un documento PDF. Documenti elaborati
generatePDFOutput Unisce dati e modelli per creare un documento PDF. Documenti elaborati
generatePDFOutputBatch Unisce dati e modelli per creare un set di documenti PDF. Documenti elaborati L'API generatePDFOutputBatch combina un modello di modulo con un record e genera un PDF. Quando si elabora un batch di record, il servizio di reporting delle transazioni conteggia ogni record come rappresentazione PDF separata.
È possibile utilizzare il flag getGenerateManyFiles per combinare più rappresentazioni in un singolo file PDF. Indipendentemente dallo stato del contrassegno, il servizio conteggia ogni record come rappresentazione PDF separata.
generatePrintedOutput Converte i documenti XDP e PDF nei formati PostScript (PS), PCL (Printer Command Language) e ZPL. Documenti elaborati
generatePrintedOutput Converte i documenti XDP e PDF nei formati PostScript (PS), PCL (Printer Command Language) e ZPL. Documenti elaborati
generatePrintedOutputBatch Converte un set di documenti XDP e PDF in un set di formati di file PostScript (PS), PCL (Printer Command Language) e ZPL. Documenti elaborati L'API generatePDFOutputBatch combina un modello di modulo con un record e genera un PDF. Quando si elabora un batch di record, il servizio di reporting delle transazioni conteggia ogni record come rappresentazione PDF separata.
È possibile utilizzare il flag getGenerateManyFiles per combinare più rappresentazioni in un singolo file PDF. Indipendentemente dallo stato del contrassegno, il servizio conteggia ogni record come rappresentazione PDF separata.

Servizio Forms

API

Descrizione Categoria report transazioni Informazioni aggiuntive
renderingPDFForm Consente di renderizzare i moduli PDF dai modelli XDP. I modelli XP vengono creati in Forms Designer. Documenti elaborati
exportData Estrai dati da un modulo PDF o da modelli XDP Documenti elaborati

Converti servizio PDF

API

Descrizione Categoria report transazioni Informazioni aggiuntive
toImage Converte un documento PDF in un elenco di documenti immagine. I formati immagine supportati sono JPEG, JPEG2K, PNG e TIFF. Documenti elaborati
toPS Converte un file PDF semplice in formato PostScript utilizzando le opzioni specificate nella specifica delle opzioni. Documenti elaborati

Servizio Forms con codice a barre

API

Descrizione Categoria report transazioni Informazioni aggiuntive
decodificare Decodifica tutti i codici a barre in un oggetto Document e restituisce un oggetto org.w3c.dom.Document contenente i dati recuperati dai codici a barre. Documenti elaborati

Servizio assemblatore

API

Descrizione Categoria report transazioni Informazioni aggiuntive
invoke Esegue il documento DDX specificato e restituisce un oggetto AssemblerResult contenente i documenti risultanti. Documenti elaborati Le seguenti operazioni non sono contabilizzate come transazioni:
  • Creazione di pacchetti o portfolio
  • Stitching di più XDP
invoke Esegue il documento DDX specificato e restituisce un oggetto AssemblerResult contenente i documenti risultanti. Documenti elaborati Tutti i formati di file di input supportati da PDF Generator, Forms e Output Services, il servizio Assembler supporta tutti questi formati come formati di file di output.
toPDFA Convertire un documento specificato in PDF/A utilizzando le opzioni specificate. Documenti elaborati
Nota
  • L'API invoke del servizio assembler può chiamare internamente un'API fatturabile di un altro servizio a seconda dell'input. Pertanto, l'API invoke può essere considerata come nessuna, singola o più transazioni. Il numero di transazioni conteggiate dipende dall'input e dalle API interne richiamate.
  • Un singolo documento PDF prodotto utilizzando il servizio di assemblaggio può essere contabilizzato come nessuna, singola o più transazioni. Il numero di transazioni conteggiate dipende dal codice DDX fornito.

PDF Utility Service

API

Descrizione Categoria report transazioni Informazioni aggiuntive
convertPDFtoXDP Converte un documento PDF in un file XDP. Affinché un documento PDF possa essere convertito correttamente in un file XDP, il documento PDF deve contenere un flusso XFA nel dizionario AcroForm. Documenti elaborati

API Billable Data Capture

Tutti gli eventi di invio di moduli adattivi, Forms HTML5 e set di moduli sono considerati transazioni. Per impostazione predefinita, l'invio di un modulo PDF non viene contabilizzato come transazione. Utilizzate l'API di registrazione delle transazioni fornita per registrare l'invio di PDF forms come transazione.

Moduli adattivi

Caso d’uso

Descrizione Categoria report transazioni Informazioni aggiuntive
Invio di un modulo adattivo Invia un modulo adattivo a un'azione di invio configurata. Moduli inviati
  • Conto di invio riuscito per una o due transazioni. Il numero di transazioni conteggiate dipende dal tipo di azione di invio utilizzata per l'invio. Ad esempio, l'invio di PDF tramite e-mail invia account azione per due conteggi di transazioni. Una transazione per l'invio del modulo e un'altra per i PDF generati mediante il servizio DOR (Document of Record).
  • L'utilizzo del modulo adattivo all'interno di un modulo adattivo (modulo adattivo) consente di gestire solo transazioni singole. All'interno di un modulo adattivo è possibile utilizzare un numero qualsiasi di moduli adattivi.

Moduli HTML5

Caso d’uso

Descrizione Categoria report transazioni Informazioni aggiuntive
Invio di un modulo HTML5 Invia un modulo HTML5 per inviare l’URL configurato nel modulo. Moduli inviati

Set di moduli

API

Descrizione Categoria report transazioni Informazioni aggiuntive
Invio di un set di moduli Invia il modulo impostato all'URL di invio configurato nel set di moduli. Moduli inviati
  • L'utilizzo del modulo adattivo all'interno di un modulo adattivo (modulo adattivo) consente di gestire solo transazioni singole. All'interno di un modulo adattivo è possibile utilizzare un numero qualsiasi di moduli adattivi.
  • Ogni modulo in un modulo Forms HTML5 imposta i conti come transazione separata.

Comunicazione interattiva fatturabile e flussi di lavoro AEM basati su moduli sulle API OSGi

Assegna i passaggi di task e servizi documenti dei flussi di lavoro AEM basati su modulo su OSGi e di tutte le rappresentazioni delle comunicazioni interattive e sono contabilizzati come transazioni. L’anteprima di una comunicazione interattiva sull’istanza di creazione e l’anteprima sull’istanza di pubblicazione mediante l’interfaccia utente dell’agente non vengono considerate come transazioni. Se una fase del flusso di lavoro registra una transazione e il flusso di lavoro non viene completato, il conteggio delle transazioni non viene stornato.

Comunicazione interattiva - Canale web

API

Descrizione Categoria report transazioni Informazioni aggiuntive
Rendering di un canale Web Apre la versione Web di una comunicazione interattiva. Documenti sottoposti a rendering

Interactive Communication - Print Channel

API

Descrizione Categoria report transazioni Informazioni aggiuntive
rendering (convertire in PDF) Genera la versione PDF di una comunicazione interattiva. Documenti sottoposti a rendering

Flussi di lavoro AEM incentrati sui moduli in OSGi

Caso di utilizzo

Categoria report transazioni Informazioni aggiuntive
Invio di un passaggio Assegna attività Moduli inviati
Invio di un punto di inizio applicazione di workflow Moduli inviati
Invio di una comunicazione interattiva (canale di stampa) dall’interfaccia utente dell’agente a un flusso di lavoro Documenti sottoposti a rendering

Registrazione di API fatturabili come transazioni per codice personalizzato

Azioni come l'invio di un modulo PDF, l'utilizzo dell'interfaccia utente dell'agente per visualizzare l'anteprima di una comunicazione interattiva, l'utilizzo di sottomoduli non standard e l'implementazione personalizzata non vengono considerate come transazioni. AEM Forms fornisce un'API per registrare azioni come le transazioni. Puoi richiamare l'API dalle tue implementazioni personalizzate per registrare una transazione.

In questa pagina