Abrechenbare APIs für Transaktionsberichte

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

  • Übermitteln eines adaptiven Formulars, HTML5-Formulars und Formularsatzes
  • Rendern einer Druck- oder Web-Version 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 des Schritts zum Zuweisen einer Aufgabe und der Schritte für Dokumenten-Services von AEM-Workflows
  • Verwenden eines adaptiven Formulars innerhalb eines adaptiven Formulars

Kostenpflichtige 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 übermittelte Formulare.

  • Übermittelte Formulare: Wenn Daten von einem mit AEM Forms erstellten Formular beliebigen Typs gesendet werden und die Daten an ein Datenspeicher-Repository oder an eine Datenbank gesendet werden, gilt dies als Formularübermittlung. Beispielsweise werden das Übermitteln eines adaptiven Formulars, eines HTML5-Formulars, von PDF-Formularen und eines Formularsatzes als Übermittlungen von Formularen verbucht. Jedes Formular in einem Formularsatz gilt als Übermittlung. Wenn ein Formularsatz beispielsweise 5 Formulare umfasst, zählt der Transaktionsberichts-Service die Ü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, die Verwendung einer abrechnungsfähigen Document Services-API für Document Services oder das Konvertieren eines Dokuments von einem Format in ein anderes werden als gerenderte Dokumente berücksichtigt.

HINWEIS

Die Benutzeroberfläche „Transaktionsberichte“ zeigt drei Kategorien an: übermittelte Formulare, gerenderte Dokumente und verarbeitete Dokumente. Sowohl gerenderte als auch verarbeitete Dokumente werden als gerenderte Dokumente verbucht.

Kostenpflichtige 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 von HTML-Seiten.

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

DocAssurance-Dienst

API

 Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
secureDocument
 Mit dieser API können Sie Ihr Dokument sichern. Sie können die API verwenden, um ein PDF-Dokument zu signieren, zu zertifizieren, zu lesen, zu erweitern oder zu verschlüsseln. Verarbeitete Dokumente Es werden nur die Vorgänge zum Signieren und Zertifizieren des secureDocument in Rechnung gestellt.

Distiller-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

Datensatzdokument-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 Transaktionsberichts-Service jeden Datensatz als separate PDF-Ausgabedarstellung.
Sie können das Flag getGenerateManyFiles verwenden, um mehrere Ausgabedarstellungen zu einer einzigen PDF-Datei zu kombinieren. Unabhängig vom Status des Flags zählt der Service jeden Datensatz als separate PDF-Ausgabedarstellung.
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 Transaktionsberichts-Service jeden Datensatz als separate PDF-Ausgabedarstellung.
Sie können das Flag getGenerateManyFiles verwenden, um mehrere Ausgabedarstellungen zu einer einzigen PDF-Datei zu kombinieren. Unabhängig vom Status des Flags zählt der Service jeden Datensatz als separate PDF-Ausgabedarstellung.

Formularservice

API

 Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
renderPDFForm Rendert ein PDF-Formular aus XDP-Vorlagen. Die XDP-Vorlagen werden in Forms Designer erstellt. Verarbeitete Dokumente
exportData Extrahiert Daten aus einem PDF-Formular oder XDP-Vorlagen 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 Decodiert 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 verbucht:
  • Erstellen von Paketen oder Portfolios
  • Zusammenfügen 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 Der Assembler-Service unterstützt alle Eingabedateiformate, die von PDF Generator, Forms und Ausgabe-Services unterstützt werden, als Ausgabedateiformate.
toPDFA Konvertieren Sie ein bestimmtes Dokument mithilfe der angegebenen Optionen in PDF/A. Verarbeitete Dokumente

Die Verwendung der invoke-API wird als Transaktion gezählt, wenn Sie einen oder mehrere der folgenden Vorgänge ausführen:

  1. Konvertierung von Nicht-PDF-Formaten in PDF-Formate. Beispielsweise die Konvertierung vom XDP-Format in das PDF-Format, die sowohl interaktive als auch nicht interaktive Kommunikationsformen ermöglicht, und die Konvertierung von Word in PDF.
  2. Konvertierung vom PDF-Format in das PDF/A-Format.
  3. Konvertierung vom PDF-Format in Nicht-PDF-Formate. Beispiele sind die Umwandlung vom PDF in das Bildformat oder die Konvertierung vom PDF in das Textformat.
HINWEIS
  • Die invoke-API des Assembler-Services kann abhängig von der Eingabe intern eine kostenpflichtige API eines anderen Services aufrufen. Daher kann die invoke-API als keine, eine einzige oder auch mehrere Transaktionen verbucht werden. Die Anzahl der gezählten Transaktionen hängt von der Eingabe und den aufgerufenen internen APIs ab.
  • Ein einzelnes PDF-Dokument, das mit dem Assembler-Service erstellt wurde, kann als keine, eine einzige oder auch 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

Kostenpflichtige Datenerfassungs-APIs

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

Adaptive Formulare

Nutzungsszenario

 Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
Senden eines adaptiven Formulars Übermittelt ein adaptives Formular entsprechend der konfigurierten Übermittlungsaktion. Übermittelte Formulare
  • Erfolgreiche Übermittlungen zählen als eine oder zwei Transaktionen. Die Anzahl der gezählten Transaktionen hängt vom Typ der für die Übermittlung verwendeten Übermittlungsaktion ab. Das Senden einer PDF-Datei über eine E-Mail-Übermittlungsaktion wird zum Beispiel als zwei Transaktionen gezählt. Eine Transaktion für die Formularübermittlung und eine andere für die PDF, die mit dem DoR-Service (Datensatzdokument) generiert wurde.
  • Bei Verwendung des adaptiven Formulars innerhalb eines adaptiven Formulars (Formularsatz von adaptiven Formularen) wird nur eine einzige Transaktion verbucht. Sie können eine beliebige Anzahl adaptiver Formulare innerhalb eines adaptiven Formulars verwenden.

HTML5-Formulare

Nutzungsszenario

 Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
Übermitteln eines HTML5-Formulars Übermittelt ein HTML5-Formular an die im Formular konfigurierte Übermittlungs-URL. Übermittelte Formulare

Formularsatz

API

 Beschreibung Kategorie des Transaktionsberichts Zusätzliche Informationen
Übermitteln eines Formularsatzes Übermittelt einen Formularsatz an die im Formularsatz konfigurierte Übermittlungs-URL. Übermittelte Formulare
  • Bei Verwendung des adaptiven Formulars innerhalb eines adaptiven Formulars (Formularsatz von adaptiven Formularen) wird nur eine einzige Transaktion verbucht. Sie können eine beliebige Anzahl adaptiver Formulare innerhalb eines adaptiven Formulars verwenden.
  • Jedes Formular in einem Formularsatz von HTML5-Formularen wird als separate Transaktion verbucht.

Kostenpflichtige interaktive Kommunikation und formularzentrierte AEM Workflows in OSGi-APIs

Die Schritte der Zuweisung von Aufgaben und der Dokumenten-Services von formularzentrierten AEM-Workflows unter OSGi und alle Ausgabedarstellungen von interaktiver Kommunikation werden als Transaktionen verbucht. Die Vorschau einer interaktiven Kommunikation auf der Autoreninstanz und die Vorschau auf der Veröffentlichungsinstanz mithilfe der Agent-Benutzeroberfläche werden nicht als Transaktionen verbucht. Wenn durch einen Workflow-Schritt eine Transaktion verbucht wird 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
Rendern eines Web-Kanals Öffnet die Web-Version einer interaktiven Kommunikation. Gerenderte Dokumente

Interaktive Kommunikation – Druckkanal

API

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

Formularorientierte AEM-Workflows in OSGi

Nutzungsszenario

 Kategorie des Transaktionsberichts Zusätzliche Informationen
Übermitteln eines Schritts „Aufgabe zuweisen“ Übermittelte Formulare
Übermitteln eines Startpunkts für ein Workflow-Programm Übermittelte Formulare
Übermitteln einer interaktiven Kommunikation (Druckkanal) von der Agent-Benutzeroberfläche an einen Workflow Gerenderte Dokumente

Aufzeichnen von kostenpflichtigen APIs als Transaktionen für benutzerspezifischen Code

Aktionen wie das Übermitteln eines PDF-Formulars, die Verwendung der Agent-Benutzeroberfläche 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 solcher Aktionen als Transaktionen. Sie können die API aus Ihren benutzerdefinierten Implementierungen aufrufen, um eine Transaktion aufzuzeichnen.

Auf dieser Seite