Report transazioni API fatturabili

AEM Forms fornisce diverse API per inviare moduli, elaborare documenti ed eseguire il rendering di documenti. Alcune API sono contabilizzate come transazioni e altre sono libere di utilizzare. Questo documento fornisce un elenco di tutte le API contabilizzate come transazioni in un report sulle transazioni. Di seguito sono riportati alcuni scenari comuni in cui viene utilizzata un’API fatturabile:

  • Invio di un modulo adattivo, di un modulo HTML5 e di un set di moduli
  • Rendering di una versione stampata o web di una comunicazione interattiva
  • Conversione di un documento da un formato a un altro
  • Appiattimento di un documento di Dynamic PDF
  • Generazione di un documento di record
  • Unione di un documento PDF interattivo con un altro documento PDF
  • Utilizzo dei passaggi Assegna attività e Servizi documentali dei flussi di lavoro AEM
  • Utilizzo di un modulo adattivo 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 sottoposto a rendering. Un report di transazioni suddivide 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 vengono inviati a qualsiasi archivio di dati o database, viene considerato invio modulo. L’invio di un modulo adattivo, di un modulo HTML5, di PDF forms e di un set di moduli, ad esempio, viene considerato come moduli inviati. Ogni modulo di un set di moduli è considerato un inoltro. Ad esempio, se una serie di moduli contiene 5 moduli, quando la serie di moduli viene sottomessa, il servizio di reporting delle transazioni conteggia tale serie come 5 invii.

  • Documenti sottoposti a rendering: La generazione di un documento mediante la combinazione di un modello e di dati, la firma o la certificazione digitale di un documento, l'utilizzo di un'API di servizi di gestione dei documenti fatturabile per i servizi di gestione dei documenti o la conversione di un documento da un formato a un altro vengono considerati documenti sottoposti a rendering.

NOTA

Nell’interfaccia utente Rapporti transazioni sono visualizzate tre categorie: Forms Inviato, Documenti sottoposti a rendering ed Elaborati. Sia i documenti sottoposti a rendering che i documenti elaborati vengono considerati documenti sottoposti a rendering.

API di 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 dalle pagine HTML.

Documenti elaborati
htmlToPdf Crea PDF dagli URL che puntano a una pagina HTML. Documenti elaborati
htmlToPdf2 Crea PDF dagli URL che puntano a una pagina HTML. Documenti elaborati
optimizePDF Ottimizza PDF per ridurre le dimensioni dei file eliminando i metadati non necessari senza influire sulla qualità. Documenti elaborati

Servizio DocAssurance

API

Descrizione Categoria report transazioni Informazioni aggiuntive
secureDocument
Questa API consente di proteggere il documento. Puoi utilizzare l’API per firmare, certificare, estendere o crittografare un documento PDF. Documenti elaborati Vengono fatturate solo le operazioni di firma e certificazione di secureDocument.

Servizio Distiller

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 documenti di record (servizio DoR)

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 conta ogni record come una rappresentazione PDF separata.
È possibile utilizzare getGenerateManyFiles flag per combinare più rappresentazioni in un singolo file PDF. Indipendentemente dallo stato del flag, il servizio conta ogni record come una rappresentazione PDF separata.
generatePrintedOutput Converte i documenti XDP e PDF in formati PostScript (PS), Printer Command Language (PCL) e ZPL. Documenti elaborati
generatePrintedOutput Converte i documenti XDP e PDF in formati PostScript (PS), Printer Command Language (PCL) e ZPL. Documenti elaborati
generatePrintedOutputBatch Converte un set di documenti XDP e PDF in un set di formati di file PostScript (PS), Printer Command Language (PCL) 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 conta ogni record come una rappresentazione PDF separata.
È possibile utilizzare getGenerateManyFiles flag per combinare più rappresentazioni in un singolo file PDF. Indipendentemente dallo stato del flag, il servizio conta ogni record come una rappresentazione PDF separata.

Servizio Forms

API

Descrizione Categoria report transazioni Informazioni aggiuntive
renderPDFForm Esegue il rendering del modulo PDF dai modelli XDP. I modelli XP vengono creati in Forms Designer. Documenti elaborati
exportData Estrae 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 di immagine supportati sono JPEG, JPEG2K, PNG e TIFF. Documenti elaborati
toPS Converte un file Flat PDF in formato PostScript utilizzando le opzioni specificate nella specifica dell'opzione. 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 dati recuperati dal codice a barre. Documenti elaborati

Servizio assemblatore

API

Descrizione Categoria report transazioni Informazioni aggiuntive
richiamare Esegue il documento DDX specificato e restituisce un AssemblerResult oggetto contenente i documenti risultanti. Documenti elaborati Le seguenti operazioni non sono contabilizzate come operazioni:
  • Creazione di pacchetti o portfolio
  • Unione di più XDP
richiamare Esegue il documento DDX specificato e restituisce un AssemblerResult oggetto contenente i documenti risultanti. Documenti elaborati Tutti i formati di file di input supportati dai servizi PDF Generator, Forms e Output, 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

L’utilizzo dell’API di richiamo viene conteggiato come una transazione, quando si eseguono una o più delle seguenti operazioni:

  1. Conversione da formati non PDF a formati PDF. Ad esempio, la conversione dal formato XDP al formato PDF, che include forme di comunicazione interattive e non interattive, e la conversione da Word a PDF.
  2. Conversione dal formato PDF al formato PDF/A.
  3. Conversione dal formato PDF a formati non PDF. Gli esempi includono la trasformazione da PDF a formato immagine o la conversione da PDF a formato testo.
NOTA
  • L’API di richiamo del servizio assembler può chiamare internamente un’API fatturabile di un altro servizio a seconda dell’input. Pertanto, l’API di richiamo può essere contabilizzata 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 assembler può essere contabilizzato come nessuna, singola o più transazioni. Il numero di transazioni conteggiate dipende dal codice DDX fornito.

Servizio Utilità PDF

API

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

API di acquisizione dati fatturabili

Tutti gli eventi di invio di moduli adattivi, HTML5 Forms e set di moduli vengono contabilizzati come transazioni. Per impostazione predefinita, l’invio di un modulo PDF non viene contabilizzato come una transazione. Utilizza il fornito API registratore transazioni per registrare un 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 all’azione di invio configurata. Moduli inviati
  • Account invio corretto per una o due transazioni. Il numero di transazioni conteggiate dipende dal tipo di azione di invio utilizzato per la sottomissione. Ad esempio, l’invio di PDF tramite un’azione di invio tramite e-mail tiene conto di due conteggi di transazioni. Una transazione per l’invio di moduli e un’altra per PDF generata utilizzando il servizio Document of Record (DOR).
  • L’utilizzo del modulo adattivo all’interno di un modulo adattivo (set di moduli adattivi) contabilizza una sola transazione. All’interno di un modulo adattivo è possibile disporre di 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 set di moduli all’URL di invio configurato nel set di moduli. Moduli inviati
  • L’utilizzo del modulo adattivo all’interno di un modulo adattivo (set di moduli adattivi) contabilizza una sola transazione. All’interno di un modulo adattivo è possibile disporre di un numero qualsiasi di moduli adattivi.
  • Ogni modulo di un set di moduli HTML5 Forms viene contabilizzato come transazione separata.

Flussi di lavoro AEM basati su moduli e comunicazione interattiva fatturabili sulle API OSGi

Assegna i passaggi dei servizi relativi alle attività e ai documenti dei flussi di lavoro AEM basati su moduli su OSGi e tutte le rappresentazioni della comunicazione interattiva e vengono contabilizzati come transazioni. L’anteprima di una comunicazione interattiva sull’istanza di authoring e l’anteprima sull’istanza di pubblicazione utilizzando l’interfaccia utente dell’agente non vengono considerate transazioni. Se un passaggio del flusso di lavoro contabilizza 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

Comunicazione interattiva - Canale di stampa

API

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

Flussi di lavoro AEM basati su moduli su OSGi

Caso d’uso

Categoria report transazioni Informazioni aggiuntive
Invio di un passaggio Assegna attività Moduli inviati
Invio di un punto d'inizio di un'applicazione del flusso di lavoro 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 il codice personalizzato

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

In questa pagina