Transactierapporten Billable API's

Laatste update: 2023-05-04
  • Gemaakt voor:
  • User
LET OP

AEM 6.4 heeft het einde van de uitgebreide ondersteuning bereikt en deze documentatie wordt niet meer bijgewerkt. Raadpleeg voor meer informatie onze technische ondersteuningsperioden. Ondersteunde versies zoeken hier.

Lijst met alle API's die als transacties worden beschouwd

AEM Forms biedt verschillende API's voor het verzenden van formulieren, het verwerken van documenten en het weergeven van documenten. Sommige API's worden beschouwd als transacties en andere zijn gratis. Dit document verstrekt een lijst van alle APIs die als transacties in een transactierapport worden rekenschap gegeven. Hier volgen enkele veelvoorkomende scenario's waarbij een factureerbare API wordt gebruikt:

  • Een adaptief formulier, HTML5-formulier en formulierset indienen
  • Een afdruk- of webversie van een interactieve communicatie renderen
  • Een document omzetten van de ene naar de andere indeling
  • Een dynamisch PDF-document afvlakken
  • Een recorddocument genereren
  • Een interactief PDF-document samenvoegen met een ander PDF-document
  • De stappen van de taakstap toewijzen en de documentservices van AEM Workflows gebruiken
  • Het adaptieve formulier gebruiken in een adaptief formulier

Factuur-API's zijn niet geschikt voor het aantal pagina's, de lengte van een document of formulier of de uiteindelijke indeling van het gerenderde document. In een transactierapport worden de transacties in drie categorieën verdeeld: Verwerkte documenten, gerenderde documenten en Forms verzonden.

  • Forms verzonden: Wanneer gegevens worden verzonden vanuit elk type formulier dat met AEM Forms is gemaakt en de gegevens worden verzonden naar een opslagplaats of database voor gegevensopslag, wordt dit beschouwd als een verzending. Bijvoorbeeld: het verzenden van een adaptief formulier, HTML5-formulier, PDF forms en formulierset worden beschouwd als verzonden formulieren. Elk formulier in een formulierset wordt beschouwd als een verzending. Als een formulierset bijvoorbeeld 5 formulieren heeft, telt de service voor transactierapportage deze als 5 verzendingen wanneer de formulierset wordt verzonden.
  • Gerenderde documenten: Het genereren van een document door een sjabloon en gegevens te combineren, een document digitaal te ondertekenen of te certificeren, met behulp van een factureerbare API's voor documentservices of door een document van de ene naar de andere indeling te converteren, wordt beschouwd als documenten die worden gerenderd.
OPMERKING

De gebruikersinterface voor transactierapporten bevat drie categorieën: Forms verzonden, gerenderde documenten en verwerkte documenten. Zowel gerenderde documenten als verwerkte documenten worden geboekt als gerenderde documenten.

Billable Document Services API's

PDF-service genereren

API

Beschrijving Categorie Transactieverslag Aanvullende informatie
createPDF Maakt Adobe PDF van ondersteunde bestandstypen. Verwerkte documenten
createPDF2 Maakt Adobe PDF van ondersteunde bestandstypen. Verwerkte documenten
exportPDF Converteert Adobe PDF naar ondersteunde bestandstypen. Verwerkte documenten
exportPDF2 Converteert Adobe PDF naar ondersteunde bestandstypen. Verwerkte documenten
exportPDF3 Converteert Adobe PDF naar ondersteunde bestandstypen. Verwerkte documenten
htmlFileToPdf

Hiermee maakt u PDF op basis van HTML-pagina's.

Verwerkte documenten
htmlToPdf Hiermee maakt u PDF van URL's die naar een HTML-pagina verwijzen. Verwerkte documenten
htmlToPdf2 Hiermee maakt u PDF van URL's die naar een HTML-pagina verwijzen. Verwerkte documenten
optimizePDF Hiermee optimaliseert u PDF om de bestandsgrootte te beperken door overbodige metagegevens uit te knippen zonder dat dit van invloed is op de kwaliteit. Verwerkte documenten

Distiller Service

API

Beschrijving Categorie Transactieverslag Aanvullende informatie
createPDF
Maakt Adobe PDF van ondersteunde bestandstypen. Verwerkte documenten
createPDF2 Maakt Adobe PDF van ondersteunde bestandstypen. Verwerkte documenten

Document of Record Service (DoR-service)

API

Beschrijving Categorie Transactieverslag Aanvullende informatie
renderen Roept de opgegeven rendermethode aan om een document met een record te genereren met behulp van opgegeven parameters. Verwerkte documenten

Uitvoerservice

API

Beschrijving Categorie Transactieverslag Aanvullende informatie
generatePDFOutput Hiermee voegt u gegevens en sjablonen samen om een PDF-document te maken. Verwerkte documenten
generatePDFOutputBatch Hiermee voegt u gegevens en sjablonen samen om een set PDF-documenten te maken. Verwerkte documenten
generatePrintedOutput XDP- en PDF-documenten worden omgezet in de bestandsindelingen PostScript (PS), Printer Command Language (PCL) en ZPL. Verwerkte documenten
generatePrintedOutput XDP- en PDF-documenten worden omgezet in de bestandsindelingen PostScript (PS), Printer Command Language (PCL) en ZPL. Verwerkte documenten
generatePrintedOutputBatch Hiermee converteert u een set XDP- en PDF-documenten naar een set PostScript- (PS), Printer Command Language (PCL)- en ZPL-bestandsindelingen. Verwerkte documenten

Forms Service

API

Beschrijving Categorie Transactieverslag Aanvullende informatie
renderPDFForm Hiermee maakt u PDF-formulier van XDP-sjablonen. De XP-sjablonen worden gemaakt in Forms Designer. Verwerkte documenten
exportData Hiermee worden gegevens opgehaald uit een PDF-formulier of XDP-sjablonen Verwerkte documenten

PDF-service converteren

API

Beschrijving Categorie Transactieverslag Aanvullende informatie
toImage Hiermee wordt een PDF-document omgezet in een lijst met afbeeldingsdocumenten. Ondersteunde afbeeldingsindelingen zijn JPEG, JPEG, 2K, PNG en TIFF. Verwerkte documenten
naarPS Zet een Flat PDF-bestand om in PostScript-indeling met de opties die zijn opgegeven in de optiesspecificatie. Verwerkte documenten

Barcoded Forms Service

API

Beschrijving Categorie Transactieverslag Aanvullende informatie
decoderen Decodeert alle streepjescodes in een object Document en retourneert een object org.w3c.dom.Document dat gegevens bevat die uit de streepjescode zijn opgehaald. Verwerkte documenten

Assembler-service

API

Beschrijving Categorie Transactieverslag Aanvullende informatie
oproepen Hiermee wordt het opgegeven DDX-document uitgevoerd en wordt een AssemblerResult -object dat de resulterende documenten bevat. Verwerkte documenten De volgende transacties worden niet administratief verwerkt als transacties:
  • Pakketten of portfolio maken
  • Meerdere XDP's vastleggen
oproepen Hiermee wordt het opgegeven DDX-document uitgevoerd en wordt een AssemblerResult -object dat de resulterende documenten bevat. Verwerkte documenten Alle invoerbestandsindelingen die door de PDF Generator, Forms en Output Services worden ondersteund, worden door de Assembler-service ondersteund in al die indelingen als uitvoerbestandsindelingen.
toPDFA Zet een opgegeven document om in PDF/A met de opgegeven opties. Verwerkte documenten
OPMERKING
  • De invoke API van de assemblageservice kan intern een factureerbare API van een andere service oproepen, afhankelijk van de invoer. De API voor aanroepen kan dus worden beschouwd als geen, enkele of meerdere transacties. Het aantal transacties dat wordt geteld, is afhankelijk van de invoer en de interne API's die worden aangeroepen.
  • Eén enkel PDF-document dat met de assembleerservice wordt gemaakt, kan worden beschouwd als geen, enkele of meerdere transacties. Het aantal transacties dat wordt geteld, is afhankelijk van de geleverde DDX-code.

PDF Utility-service

API

Beschrijving Categorie Transactieverslag Aanvullende informatie
convertPDFtoXDP Hiermee wordt een PDF-document omgezet in een XDP-bestand. Een PDF-document kan alleen worden geconverteerd naar een XDP-bestand als het PDF-document een XFA-stroom bevat in het AcroForm-woordenboek. Verwerkte documenten

Doc Assurance Service

API

Beschrijving Categorie Transactieverslag Aanvullende informatie
secureDocument Met de API kunt u uw document beveiligen. Met de API kunt u een PDF-document ondertekenen, certificeren, lezen of uitbreiden. Verwerkte documenten Alleen de werking van het secureDocument worden gefactureerd.

Billable Data Capture API's

Alle verzendingen van adaptieve formulieren, HTML5 Forms en formuliersets worden administratief verwerkt als transacties. Door gebrek, wordt de voorlegging van een Vorm van de PDF niet administratief verwerkt als transactie. Gebruik de opgegeven transactierapporten, API om een PDF forms te registreren die als een transactie wordt ingediend.

Adaptieve Forms

Hoofdletters gebruiken

Beschrijving Categorie Transactieverslag Aanvullende informatie
Een adaptief formulier indienen Hiermee wordt een adaptief formulier verzonden voor een geconfigureerde verzendactie. Forms verzonden
  • Een of twee transacties worden verwerkt met succes verzonden. Het aantal transacties dat wordt meegeteld, is afhankelijk van het type verzendactie dat wordt gebruikt voor verzending. Als u bijvoorbeeld PDF via e-mail verzendt, worden actierekeningen voor twee tellingen van transacties verzonden. Eén transactie voor het verzenden van formulieren en een andere voor PDF die is gegenereerd met de service Document of Record (DOR).
  • Met het adaptieve formulier in een adaptief formulier (adaptief formulierformaat) wordt slechts één transactie verwerkt. U kunt een willekeurig aantal adaptieve formulieren in een adaptief formulier gebruiken.

HTML5 Forms

Hoofdletters gebruiken

Beschrijving Categorie Transactieverslag Aanvullende informatie
Een HTML5-formulier verzenden Hiermee verzendt u een HTML5-formulier voor het verzenden van de URL die in het formulier is geconfigureerd. Forms verzonden

Formulierset

API

Beschrijving Categorie Transactieverslag Aanvullende informatie
Een formulierset verzenden Hiermee verzendt u het formulier dat is ingesteld op de URL voor verzending die in de formulierset is geconfigureerd. Forms verzonden
  • Met het adaptieve formulier in een adaptief formulier (adaptief formulierformaat) wordt slechts één transactie verwerkt. U kunt een willekeurig aantal adaptieve formulieren in een adaptief formulier gebruiken.
  • Elk formulier in een HTML5 Forms-formulierset wordt als een aparte transactie verwerkt.

Billable Interactive Communication en Form-centric AEM Workflows op OSGi API's

Wijs taak en de stappen van de documentdiensten van vorm-centric AEM Workflows op OSGi en alle vertoningen van interactieve mededeling toe en zijn rekenschap gegeven als transacties. Het voorvertonen van een interactieve mededeling over de auteursinstantie en het voorvertonen op publiceer instantie gebruikend de UI van de Agent worden niet rekenschap gegeven als transacties. Als een workflowstap een transactie verwerkt en de workflow niet wordt voltooid, wordt het aantal transacties niet teruggedraaid.

Interactieve communicatie - Webkanaal

API

Beschrijving Categorie Transactieverslag Aanvullende informatie
Een webkanaal renderen Hiermee opent u de webversie van een interactieve communicatie. Gerenderde documenten

Interactieve communicatie - Afdrukkanaal

API

Beschrijving Categorie Transactieverslag Aanvullende informatie
renderen (omzetten in PDF) Genereert de PDF-versie van een interactieve communicatie. Gerenderde documenten

Form-centric AEM Workflows op OSGi

Hoofdletters gebruiken

Categorie Transactieverslag Aanvullende informatie
Een taakstap toewijzen verzenden Forms verzonden
Een startpunt voor een workflowtoepassing indienen Forms verzonden
Het voorleggen van een interactieve mededeling (het Kanaal van de Druk van de Agent UI aan een werkschema Gerenderde documenten

Infactureerbare API's opnemen als transacties voor aangepaste code

Handelingen zoals het verzenden van een PDF-formulier, het gebruik van de gebruikersinterface van de om een voorvertoning van een interactieve communicatie weer te geven, met behulp van niet-standaardformulierverzending, en aangepaste implementaties worden niet als transacties beschouwd. AEM Forms biedt een API om dergelijke handelingen op te nemen, zoals transacties. U kunt de API vanuit uw aangepaste implementaties aanroepen naar een transactie opnemen.

Op deze pagina