Transaktionsberichte Abrechnungsfähige APIs

AEM Forms bietet mehrere APIs zum Senden von Formularen, zum Verarbeiten von Dokumenten und zum Rendern von Dokumenten. Einige APIs werden als Transaktionen erfasst und andere können verwendet werden. Dieses Dokument enthält eine Liste aller APIs, die in einem Transaktionsbericht als Transaktionen bilanziert werden. Im Folgenden finden Sie einige gängige Szenarien, in denen eine abrechnungsfähige API verwendet wird:

  • Senden eines adaptiven Formulars, HTML5-Formulars und Formularsatzes
  • Rendern einer Druck- oder Webversion einer interaktiven Kommunikation
  • Konvertieren eines Dokuments aus einem Format in ein anderes
  • Reduzieren eines dynamischen PDF-Dokuments
  • Generieren eines Datensatzdokuments
  • Zusammenführen eines interaktiven PDF-Dokuments mit einem anderen PDF-Dokument
  • Verwenden der Schritte "Aufgabe zuweisen"und "Dokumentendienst"AEM Workflows
  • Verwenden des adaptiven Formulars in einem adaptiven Formular

Abrechnungs-APIs berücksichtigen nicht die Anzahl der Seiten, die Länge eines Dokuments oder Formulars oder das endgültige Format des wiedergegebenen Dokuments. Ein Transaktionsbericht unterteilt die Transaktionen in zwei Kategorien: Gerenderte und übermittelte Forms-Dokumente

  • Forms Submitted: Wenn Daten von einem mit AEM Forms erstellten Formulartyp gesendet werden und die Daten an ein Datenspeicherrepository oder eine Datenbank gesendet werden, gilt dies als Formularübermittlung. Beispielsweise werden beim Senden eines adaptiven Formulars, HTML5-Formulars, PDF forms und Formularsatzes Formulare als übermittelte Formulare berücksichtigt. Jedes Formular in einem Formularsatz gilt als Übermittlung. Wenn ein Formularsatz beispielsweise 5 Formulare umfasst, zählt der Transaktionsberichtsdienst ihn bei der Übermittlung des Formularsatzes als 5 Übermittlungen.

  • Gerenderte Dokumente: Das Generieren eines Dokuments durch Kombinieren einer Vorlage und von Daten, das digitale Signieren oder Zertifizieren eines Dokuments, das Verwenden abrechnungsfähiger Document Services-APIs für Document Services oder das Konvertieren eines Dokuments aus einem Format in ein anderes werden als gerenderte Dokumente berücksichtigt.

HINWEIS

Die Benutzeroberfläche "Transaktionsberichte"zeigt drei Kategorien an: Forms Gesendet, gerenderte Dokumente und verarbeitete Dokumente. Sowohl gerenderte als auch verarbeitete Dokumente werden als gerenderte Dokumente verbucht.

Abrechnungsfähige Document Services-APIs

Generate PDF Service

API

 Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
createPDF Erstellt Adobe PDF aus unterstützten Dateitypen. Verarbeitete Dokumente
createPDF2 Erstellt Adobe PDF aus unterstützten Dateitypen. Verarbeitete Dokumente
exportPDF Konvertiert Adobe PDF in unterstützte Dateitypen. Verarbeitete Dokumente
exportPDF2 Konvertiert Adobe PDF in unterstützte Dateitypen. Verarbeitete Dokumente
exportPDF3 Konvertiert Adobe PDF in unterstützte Dateitypen. Verarbeitete Dokumente
htmlFileToPdf

Erstellt PDF-Dateien aus HTML-Seiten.

 Verarbeitete Dokumente
htmlToPdf Erstellt PDF-Dateien aus URLs, die auf eine HTML-Seite verweisen. Verarbeitete Dokumente
htmlToPdf2 Erstellt PDF-Dateien aus URLs, die auf eine HTML-Seite verweisen. Verarbeitete Dokumente
optimizePDF Optimiert PDF-Dateien, um die Dateigröße zu reduzieren, indem unnötige Metadaten entfernt werden, ohne die Qualität zu beeinträchtigen. Verarbeitete Dokumente

Distiller-Dienst

API

 Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
createPDF
 Erstellt Adobe PDF aus unterstützten Dateitypen. Verarbeitete Dokumente
createPDF2 Erstellt Adobe PDF aus unterstützten Dateitypen. Verarbeitete Dokumente

Document of Record Service (DoR Service)

API

 Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
render Ruft die angegebene Render-Methode auf, um mithilfe der bereitgestellten Parameter ein Datensatzdokument zu generieren. Verarbeitete Dokumente

Ausgabe-Service

API

 Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
generatePDFOutput Führt Daten und Vorlagen zusammen, um ein PDF-Dokument zu erstellen. Verarbeitete Dokumente
generatePDFOutput Führt Daten und Vorlagen zusammen, um ein PDF-Dokument zu erstellen. Verarbeitete Dokumente
generatePDFOutputBatch Führt Daten und Vorlagen zusammen, um einen Satz von PDF-Dokumenten zu erstellen. Verarbeitete Dokumente Die generatePDFOutputBatch -API kombiniert eine Formularvorlage mit einem Datensatz und generiert eine PDF-Datei. Wenn Sie einen Datensatz-Batch verarbeiten, zählt der Transaktionsberichtsdienst jeden Datensatz als separate PDF-Ausgabe.
Sie können das Flag getGenerateManyFilesflag verwenden, um mehrere Ausgabedarstellungen zu einer einzelnen PDF-Datei zu kombinieren. Unabhängig vom Status des Flag zählt der Dienst jeden Datensatz als separate PDF-Ausgabe.
generatePrintedOutput Konvertiert XDP- und PDF-Dokumente in die Dateiformate PostScript (PS), Printer Command Language (PCL) und ZPL. Verarbeitete Dokumente
generatePrintedOutput Konvertiert XDP- und PDF-Dokumente in die Dateiformate PostScript (PS), Printer Command Language (PCL) und ZPL. Verarbeitete Dokumente
generatePrintedOutputBatch Konvertiert einen Satz von XDP- und PDF-Dokumenten in die Formate PostScript (PS), Printer Command Language (PCL) und ZPL. Verarbeitete Dokumente Die generatePDFOutputBatch -API kombiniert eine Formularvorlage mit einem Datensatz und generiert eine PDF-Datei. Wenn Sie einen Datensatz-Batch verarbeiten, zählt der Transaktionsberichtsdienst jeden Datensatz als separate PDF-Ausgabe.
Sie können das Flag getGenerateManyFilesflag verwenden, um mehrere Ausgabedarstellungen zu einer einzelnen PDF-Datei zu kombinieren. Unabhängig vom Status des Flag zählt der Dienst jeden Datensatz als separate PDF-Ausgabe.

Formularservice

API

 Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
renderPDFForm Rendert PDF-Formulare aus XDP-Vorlagen. Die XP-Vorlagen werden in Forms Designer erstellt. Verarbeitete Dokumente
exportData Extrahiert Daten aus einem PDF-Formular oder einer XDP-Vorlage Verarbeitete Dokumente

Convert PDF Service

API

 Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
toImage Konvertiert ein PDF-Dokument in eine Liste von Bilddokumenten. Unterstützte Bildformate sind JPEG, JPEG2K, PNG und TIFF. Verarbeitete Dokumente
toPS Konvertiert eine einfache PDF-Datei in das PostScript-Format mithilfe der in der Optionsbeschreibung angegebenen Optionen. Verarbeitete Dokumente

Barcoded Forms-Dienst

API

 Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
decode Dekodiert alle Barcodes in einem Dokumentobjekt und gibt ein org.w3c.dom.Document -Objekt zurück, das Daten enthält, die aus dem Barcode abgerufen wurden. Verarbeitete Dokumente

Assembler-Service

API

 Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
invoke Führt das angegebene DDX-Dokument aus und gibt ein AssemblerResult-Objekt zurück, das die resultierenden Dokumente enthält. Verarbeitete Dokumente Folgende Vorgänge werden nicht als Transaktionen erfasst:
  • Erstellen von Paketen oder Portfolios
  • Zuordnen mehrerer XDPs
invoke Führt das angegebene DDX-Dokument aus und gibt ein AssemblerResult-Objekt zurück, das die resultierenden Dokumente enthält. Verarbeitete Dokumente Assembler-Dienst unterstützt alle Eingabedateiformate, die von PDF Generator, Forms und den Output-Diensten unterstützt werden, als Ausgabedateiformate.
toPDFA Konvertieren Sie ein angegebenes Dokument mithilfe der angegebenen Optionen in PDF/A. Verarbeitete Dokumente
HINWEIS
  • Die invoke-API des Assembler-Dienstes kann abhängig von der Eingabe intern eine abrechnungsfähige API eines anderen Dienstes aufrufen. Daher kann die invoke-API als keine, einzelne oder mehrere Transaktionen bilanziert werden. Die Anzahl der gezählten Transaktionen hängt von der Eingabe und den aufgerufenen internen APIs ab.
  • Ein einzelnes PDF-Dokument, das mit Assembler-Dienst erstellt wurde, kann als keine, einzelne oder mehrere Transaktionen erfasst werden. Die Anzahl der gezählten Transaktionen hängt vom bereitgestellten DDX-Code ab.

PDF Utility Service

API

 Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
convertPDFtoXDP Konvertiert ein PDF-Dokument in eine XDP-Datei. Damit ein PDF-Dokument erfolgreich in eine XDP-Datei konvertiert werden kann, muss das PDF-Dokument einen XFA-Stream im AcroForm-Wörterbuch enthalten. Verarbeitete Dokumente

Abrechenbare Datenerfassungs-APIs

Alle Übermittlungsereignisse von adaptiven Formularen, HTML5 Forms und Formularsätzen werden als Transaktionen berücksichtigt. Standardmäßig wird die Übermittlung eines PDF-Formulars nicht als Transaktion berücksichtigt. Verwenden Sie die bereitgestellte Transaktions-Recorder-API, um eine PDF forms-Übermittlung als Transaktion aufzuzeichnen.

Adaptive Formulare

Nutzungsszenario

Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
Senden eines adaptiven Formulars Sendet ein adaptives Formular an die konfigurierte Sendeaktion. Übermittelte Formulare
  • Erfolgreiche Übermittlungen für einzelne oder zwei Transaktionen. Die Anzahl der gezählten Transaktionen hängt vom Typ der für die Übermittlung verwendeten Sendeaktion ab. Beispielsweise werden beim Senden von PDF-Dateien über E-Mail-Übermittlungsaktionen zwei Zählungen von Transaktionen berücksichtigt. Eine Transaktion für die Formularübermittlung und eine andere für mit dem DOR-Dienst (Document of Record) generierte PDF-Dateien.
  • Bei Verwendung des adaptiven Formulars in einem adaptiven Formular (adaptiver Formularformsatz) wird nur eine Transaktion berücksichtigt. Sie können eine beliebige Anzahl adaptiver Formulare in einem adaptiven Formular haben.

HTML5-Formulare

Nutzungsszenario

Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
Senden eines HTML5-Formulars Sendet ein HTML5-Formular, um die URL zu senden, die im Formular konfiguriert ist. Übermittelte Formulare

Formularsatz

API

 Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
Senden eines Formularsatzes Sendet den Formularsatz an die im Formularsatz konfigurierte Sende-URL. Übermittelte Formulare
  • Bei Verwendung des adaptiven Formulars in einem adaptiven Formular (adaptiver Formularformsatz) wird nur eine Transaktion berücksichtigt. Sie können eine beliebige Anzahl adaptiver Formulare in einem adaptiven Formular haben.
  • Jedes Formular in einem HTML5-Forms-Formularsatz wird als separate Transaktion erfasst.

Abrechnungsfähige interaktive Kommunikation und formularzentrierte AEM Workflows in OSGi-APIs

Weisen Sie die Schritte "Aufgaben"und "Document Services"von formularzentrierten AEM Workflows in OSGi und allen Ausgabedarstellungen der interaktiven Kommunikation zu und werden als Transaktionen erfasst. Die Vorschau einer interaktiven Kommunikation auf der Autoreninstanz und die Vorschau auf der Veröffentlichungsinstanz mithilfe der Benutzeroberfläche für Agenten werden nicht als Transaktionen berücksichtigt. Wenn ein Workflow-Schritt eine Transaktion abschließt und der Workflow nicht abgeschlossen werden kann, wird die Transaktionsanzahl nicht zurückgesetzt.

Webkanal für interaktive Kommunikation

API

 Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
Webkanal rendern Öffnet die Webversion einer interaktiven Kommunikation. Gerenderte Dokumente

Interaktive Kommunikation - Druckkanal

API

 Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
render (in PDF konvertieren) Generiert die PDF-Version einer interaktiven Kommunikation. Gerenderte Dokumente

Formularorientierte AEM-Workflows in OSGi

Anwendungsfall

 Kategorie des Transaktionsberichts Zusätzliche Informationen
Übermitteln eines Schritts "Assign Task" Übermittelte Formulare
Senden eines Start-Punkts einer Workflow-Anwendung Übermittelte Formulare
Senden einer interaktiven Kommunikation (Druckkanal) von der Benutzeroberfläche des Agenten an einen Workflow Gerenderte Dokumente

Aufzeichnen von abrechnungsfähigen APIs als Transaktionen für benutzerdefinierten Code

Aktionen wie das Senden eines PDF-Formulars, die Verwendung der Benutzeroberfläche für Agenten zur Vorschau einer interaktiven Kommunikation, die Verwendung nicht standardmäßiger Formularübermittlung und benutzerdefinierte Implementierungen werden nicht als Transaktionen berücksichtigt. AEM Forms bietet eine API zum Aufzeichnen von Aktionen wie Transaktionen. Sie können die API von Ihren benutzerdefinierten Implementierungen zu Aufzeichnen einer Transaktion aufrufen.

Auf dieser Seite