Show Menu
THEMEN×

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 kostenlos 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:
  • Übermitteln eines adaptiven Formulars, HTML5-Formulars und Formularsatzes
  • Rendern einer Druck- oder Webversion einer interaktiven Kommunikation
  • Konvertieren eines Dokuments von einem Format in ein anderes
  • Reduzieren eines dynamischen PDF-Dokuments
  • Erstellen eines Datensatzdokuments
  • Zusammenführen eines interaktiven PDF-Dokuments mit einem anderen PDF-Dokument
  • Verwenden der Schritte zum Zuweisen von Aufgabenschritten und den DOC-Diensten von AEM-Workflows
  • Verwenden von adaptiven Formularen in einem adaptiven Formular
Die 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 Dokumente und gesendete Formulare
  • Übermittelte Formulare: Wenn Daten von einem beliebigen mit AEM Forms erstellten Formulartyp gesendet werden und die Daten an ein Datenspeicher-Repository gesendet werden, gilt die Formularübermittlung. Beispielsweise werden beim Senden eines adaptiven Formulars, HTML5-Formulars, PDF-Formulare und Formularsätze als gesendete Formulare verbucht. Jedes Formular in einem Formularsatz gilt als Übermittlung. Wenn ein Formularsatz beispielsweise 5 Formulare umfasst, zählt der Transaktionsberichtsdienst ihn bei Übermittlung des Formularsatzes als 5 Übermittlungen.
  • Gerenderte Dokumente: Das Generieren eines Dokuments durch Kombination von Vorlage und Daten, das digitale Signieren oder Zertifizieren eines Dokuments, die Verwendung einer abrechnungsfähigen Document Services-APIs für Document Services oder die Konvertierung eines Dokuments von einem Format in ein anderes werden als gerenderte Dokumente berücksichtigt.
Die Benutzeroberfläche "Transaktionsberichte"enthält drei Kategorien: Formulare gesendet, wiedergegebene Dokumente und verarbeitete Dokumente. Sowohl gerenderte als auch verarbeitete Dokumente werden als gerenderte Dokumente verbucht.

Billable Document Services-APIs

Generate PDF Service

API
Beschreibung Transaktionsberichtkategorie 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 Service

API
Beschreibung Transaktionsberichtkategorie Zusätzliche Informationen
createPDF Erstellt Adobe PDF aus unterstützten Dateitypen. Verarbeitete Dokumente
createPDF2 Erstellt Adobe PDF aus unterstützten Dateitypen. Verarbeitete Dokumente

Datensatzdokument-Dienst (DoR-Dienst)

API
Beschreibung Transaktionsberichtkategorie Zusätzliche Informationen
render Ruft die angegebene Render-Methode auf, um ein Datensatzdokument mit den bereitgestellten Parametern zu erstellen. Verarbeitete Dokumente

Output Service

API
Beschreibung Transaktionsberichtkategorie 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. Bei der Verarbeitung eines Datensatzstapels zählt der Transaktionsberichtsdienst jeden Datensatz als separate PDF-Darstellung. Mit dem Flag getGenerateManyFiles können Sie mehrere Darstellungen zu einer einzelnen PDF-Datei kombinieren. Unabhängig vom Status des Flag zählt der Dienst jeden Datensatz als separate PDF-Darstellung.
generatePrintedOutput Konvertiert XDP- und PDF-Dokumente in die Formate PostScript (PS), Printer Command Language (PCL) und ZPL. Verarbeitete Dokumente
generatePrintedOutput Konvertiert XDP- und PDF-Dokumente in die Formate PostScript (PS), Printer Command Language (PCL) und ZPL. Verarbeitete Dokumente
generatePrintedOutputBatch Konvertiert eine Reihe von XDP- und PDF-Dokumenten in eine Reihe von PostScript- (PS), Printer Command Language (PCL)- und ZPL-Dateiformaten. Verarbeitete Dokumente Die generatePDFOutputBatch-API kombiniert eine Formularvorlage mit einem Datensatz und generiert eine PDF-Datei. Bei der Verarbeitung eines Datensatzstapels zählt der Transaktionsberichtsdienst jeden Datensatz als separate PDF-Darstellung. Mit dem Flag getGenerateManyFiles können Sie mehrere Darstellungen zu einer einzelnen PDF-Datei kombinieren. Unabhängig vom Status des Flag zählt der Dienst jeden Datensatz als separate PDF-Darstellung.

Formularservice

API
Beschreibung Transaktionsberichtkategorie 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 Transaktionsberichtkategorie 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 mit den in der Optionsangabe angegebenen Optionen. Verarbeitete Dokumente

Barcoded Forms-Dienst

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

Assembler-Dienst

API
Beschreibung Transaktionsberichtkategorie 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
  • Mehrere XDPs anheften
invoke Führt das angegebene DDX-Dokument aus und gibt ein AssemblerResult -Objekt zurück, das die resultierenden Dokumente enthält. Verarbeitete Dokumente Der Assembler-Dienst unterstützt alle Eingabedateiformate, die von PDF Generator, Forms und Output-Diensten unterstützt werden, als Ausgabeformate.
toPDFA Konvertieren Sie ein angegebenes Dokument mit den angegebenen Optionen in PDF/A. Verarbeitete Dokumente
  • Die invoke-API des Assembler-Dienstes kann intern abhängig von der Eingabe eine abrechnungsfähige API eines anderen Dienstes aufrufen. Die invoke-API kann also als keine, einzelne oder mehrere Transaktionen bilanziert werden. Die Anzahl der gezählten Transaktionen hängt von der Eingabe und den aufgerufen internen APIs ab.
  • Ein einzelnes mit Assembler-Dienst erstelltes PDF-Dokument kann als keine, einzelne oder mehrere Transaktionen bilanziert werden. Die Anzahl der gezählten Transaktionen hängt vom bereitgestellten DDX-Code ab.

PDF-Dienstprogrammdienst

API
Beschreibung Transaktionsberichtkategorie 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

Billable Datenerfassungs-APIs

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

Adaptive Formulare

Nutzungsszenario
Beschreibung Transaktionsberichtkategorie Zusätzliche Informationen
Senden eines adaptiven Formulars Sendet ein adaptives Formular zur konfigurierten Übermittlungsaktion. Übermittelte Formulare
  • Erfolgreiches Übermittlungskonto für ein oder zwei Transaktionen. Die Anzahl der gezählten Transaktionen hängt von der Art der Sendeaktion ab, die für die Übermittlung verwendet wird. Beispielsweise werden beim Senden von PDF per E-Mail-Übermittlungsaktion zwei Transaktionszahlen erfasst. Eine Transaktion für die Formularübermittlung und eine andere für mit dem DOR-Dienst generierte PDF.
  • Bei Verwendung des adaptiven Formulars in einem adaptiven Formular (adaptiven Formularsatz) wird nur eine Transaktion erfasst. Sie können eine beliebige Anzahl adaptiver Formulare in einem adaptiven Formular haben.

HTML5-Formulare

Nutzungsszenario
Beschreibung Transaktionsberichtkategorie Zusätzliche Informationen
Senden eines HTML5-Formulars Sendet ein HTML5-Formular, um die im Formular konfigurierte URL zu senden. Übermittelte Formulare

Formularsatz

API
Beschreibung Transaktionsberichtkategorie 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 (adaptiven Formularsatz) wird nur eine Transaktion erfasst. Sie können eine beliebige Anzahl adaptiver Formulare in einem adaptiven Formular haben.
  • Jedes Formular in einem HTML5-Formularsatz wird als separate Transaktion behandelt.

Billable interaktive Kommunikation und formularorientierte AEM-Workflows auf OSGi-APIs

Weisen Sie Aufgaben- und Document Services-Schritte für Form-orientierte AEM-Workflows auf OSGi und alle Darstellungen 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 Agent-Benutzeroberfläche werden nicht als Transaktionen erfasst. Wenn ein Workflow-Schritt eine Transaktion abschließt und der Workflow nicht abgeschlossen werden kann, wird die Transaktionsanzahl nicht umgekehrt.

Webkanal für interaktive Kommunikation

API
Beschreibung Transaktionsberichtkategorie Zusätzliche Informationen
Rendern eines Webkanals Öffnet die Webversion einer interaktiven Kommunikation. Gerenderte Dokumente

Interactive Communication - Print Channel

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

Formularorientierte AEM-Workflows in OSGi

Anwendungsfall
Transaktionsberichtkategorie Zusätzliche Informationen
Senden eines Assign Task-Schritts Übermittelte Formulare
Senden eines Startpunkts für eine 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 Agent-Benutzeroberfläche zum Anzeigen einer Vorschau einer interaktiven Kommunikation, das Senden von nicht standardmäßigen Formularen und benutzerdefinierte Implementierungen werden nicht als Transaktionen erfasst. AEM Forms bietet eine API zum Aufzeichnen von Aktionen wie Transaktionen. Sie können die API aus Ihren benutzerdefinierten Implementierungen aufrufen, um eine Transaktion aufzuzeichnen .