Abrechenbare APIs für Transaktionsberichte transaction-reports-billable-apis

Version
Artikel-Link
AEM 6.5
Hier klicken
AEM as a Cloud Service
Dieser Artikel

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:

  • Senden eines adaptiven Formulars
  • Konvertieren eines Dokuments aus einem Format in ein anderes
  • Reduzieren eines dynamischen PDF-Dokuments
  • Generieren eines Datensatzdokuments (mit dem Forms-Dienst oder dem Ausgabe-Service)
  • Zusammenführen eines interaktiven PDF-Dokuments mit einem anderen PDF-Dokument
  • Verwenden des Schritts zum Zuweisen einer Aufgabe und der Kommunikations-API-Schritte von AEM-Workflows

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: übermittelte Formulare und gerenderte Dokumente.

  • Ü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 wird das Senden eines adaptiven Formulars oder eines Formularsatzes als Formularübermittlung betrachtet. Wenn ein Formularsatz 5 Formulare umfasst und dieser Formularsatz übermittelt wird, zählt der Dienst für Transaktionsberichte dies 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 kostenpflichtiger Document Services-APIs für Dokumenten-Services oder das Konvertieren eines Dokuments von einem Format in ein anderes werden als gerenderte Dokumente verbucht.

Kostenpflichtige Document Services-APIs billable-document-services-apis

Generate PDF-Service generate-pdf-service

API
Beschreibung
Kategorie des Transaktionsberichts
Zusätzliche Informationen
createPDF
Generiert ein PDF-Dokument aus einer Vorlage und führt Daten damit zusammen.
Verarbeitete Dokumente
exportPDF
Konvertiert XDP-Dateien oder PDF-Dokumente in unterstützte Dateitypen.
Verarbeitete Dokumente

Ausgabe-Service output-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 (PDFOutputOptions)
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
generatePrintedOutput
Konvertiert XDP- und PDF-Dokumente in die Dateiformate PostScript (PS), Printer Command Language (PCL) und ZPL.
Verarbeitete Dokumente
generatePrintedOutput (PrintedOutputOptions)
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

DocAssurance-Dienst DocAssurance-Service

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.

Document of Record(DOR)-Dienst document-of-record-dor-forms-service-and-output-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.
Mit dem Forms-Dienst verarbeitete Dokumente

Assembler-Service assembler-service

API
Beschreibung
Kategorie des Transaktionsberichts
Zusätzliche Informationen
invoke
Führt das DDX-Dokument für die angegebenen Eingabedokumente aus und gibt ein Objekt zurück, das die Zieldokumente 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 DDX-Dokument für die angegebenen Eingabedokumente aus und gibt ein Objekt zurück, das die Zieldokumente 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.
  2. Konvertierung vom PDF-Format in das PDF/A-Format.
  3. Konvertierung vom PDF-Format in Nicht-PDF-Formate. Beispiele sind die Umwandlung von PDF in das Bildformat oder die Konvertierung von PDF in das Textformat.
NOTE
  • 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 Code ab.

Kostenpflichtige Datenerfassungs-APIs billable-data-capture-apis

Alle Übermittlungsereignisse von adaptiven Formularen 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 adaptive-forms

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.

Abrechenbare formularzentrierte AEM-Workflows billable--form-centric-aem-workflows

Die Schritte der Zuweisung von Aufgaben und der Dokumenten-Services von formularzentrierten AEM-Workflows werden als Transaktionen verbucht. Wenn durch einen Workflow-Schritt eine Transaktion verbucht wird, aber der Workflow nicht abgeschlossen werden kann, wird die Transaktionsanzahl trotzdem nicht zurückgesetzt.

Formularzentrierte AEM-Workflows form-centric-aem-workflows

Anwendungsfall
Kategorie des Transaktionsberichts
Zusätzliche Informationen
Übermitteln eines Schritts „Aufgabe zuweisen“
Übermittelte Formulare
Übermitteln eines Startpunkts für ein Workflow-Programm
Übermittelte Formulare

Aufzeichnen von kostenpflichtigen APIs als Transaktionen für benutzerspezifischen Code recording-billable-apis-as-transactions-for-custom-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.

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab