Transactierapporten Billable API's voor AEM Forms op OSGi transaction-reports-billable-apis

Versie
Artikelkoppeling
AEM as a Cloud Service
​ klik hier ​
AEM 6,5
Dit artikel

AEM Forms biedt verschillende API's voor het verzenden van formulieren, procesdocumenten en het weergeven van documenten. Sommige API's worden beschouwd als transacties en andere kunnen gratis worden gebruikt. 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 weergeven
  • Een document omzetten van de ene naar de andere indeling
  • Een dynamisch PDF-document afvlakken
  • Een document met records 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 twee categorieën verdeeld: gerenderde documenten en Forms verzonden.

  • Voorgelegde Forms: Wanneer het gegeven van om het even welk type van vorm wordt voorgelegd die met AEM Forms wordt gecreeerd en het gegeven wordt voorgelegd aan om het even welke gegevensopslagplaats of gegevensbestand wordt beschouwd als vormvoorlegging. 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 produceren van een document door een malplaatje en gegevens te combineren, digitaal het ondertekenen of het certificeren van een document, gebruikend een factureerbare API van de documentdiensten voor documentdiensten, of het omzetten van een document van één formaat in een andere worden rekenschap gegeven als teruggegeven documenten.

NOTE
De gebruikersinterface van 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 billable-document-services-apis

PDF-service genereren generate-pdf-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
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 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

DocAssurance Service DocAssurance-Service

API
Beschrijving
Categorie Transactieverslag
Aanvullende informatie
secureDocument
Met deze API kunt u uw document beveiligen. Met de API kunt u een PDF-document ondertekenen, certificeren, lezen of uitbreiden.
Verwerkte documenten
Alleen de bewerking voor ondertekenen en certificeren van het SecureDocument wordt in rekening gebracht.

Distiller Service 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) 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 output-service

API
Beschrijving
Categorie Transactieverslag
Aanvullende informatie
generatePDFOutput
Hiermee voegt u gegevens en sjablonen samen om een PDF-document te maken.
Verwerkte documenten
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
De generatePDFOutputBatch-API combineert een formuliersjabloon met een record en genereert een PDF. Wanneer u een partij verslagen verwerkt, telt de transactie rapporterende dienst elk verslag als afzonderlijke vertoning van de PDF.
u kunt de getGenerateManyFilesvlag gebruiken om veelvoudige vertoningen aan één enkel dossier van PDF te combineren. Ongeacht de status van de vlag telt de dienst elke record als een aparte PDF-uitvoering.
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
De generatePDFOutputBatch-API combineert een formuliersjabloon met een record en genereert een PDF. Wanneer u een partij verslagen verwerkt, telt de transactie rapporterende dienst elk verslag als afzonderlijke vertoning van de PDF.
u kunt de getGenerateManyFilesvlag gebruiken om veelvoudige vertoningen aan één enkel dossier van PDF te combineren. Ongeacht de status van de vlag telt de dienst elke record als een aparte PDF-uitvoering.

Forms Service 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 convert-pdf-service

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
Converteert een Flat PDF-bestand naar de PostScript-indeling met behulp van de opties die zijn opgegeven in de optiespecc.
Verwerkte documenten

Barcoded Forms Service 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 assembler-service

API
Beschrijving
Categorie Transactieverslag
Aanvullende informatie
oproepen
Voert het gespecificeerde document DDX uit en keert een AssemblerResultvoorwerp terug 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
Voert het gespecificeerde document DDX uit en keert een AssemblerResultvoorwerp terug dat de resulterende documenten bevat.
Verwerkte documenten
Alle invoerbestandsindelingen die door PDF Generator-, Forms- en Output-services worden ondersteund, worden door de Assembler-service ondersteund voor al die indelingen als uitvoerbestandsindelingen.
toPDFA
Zet een opgegeven document om in PDF/A met de opgegeven opties.
Verwerkte documenten

Het gebruik van de API voor aanroepen wordt als een transactie geteld wanneer u een of meer van de volgende bewerkingen uitvoert:

  1. Conversie van niet-PDF-indelingen naar PDF-indelingen. Bijvoorbeeld de conversie van XDP-indeling naar PDF-indeling, catering naar zowel interactieve als niet-interactieve communicatievormen en de conversie van Word naar PDF.
  2. Omzetten van PDF-indeling naar PDF/A-indeling.
  3. Conversie van PDF-indeling naar niet-PDF-indeling. Voorbeelden hiervan zijn de transformatie van de indeling PDF naar Afbeelding of de conversie van de indeling PDF naar tekst.
NOTE
  • De invoke API van de assemblageservice kan intern een factureerbare API van een andere service oproepen, afhankelijk van de invoer. De aanroepAPI 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 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 met succes worden geconverteerd naar een XDP-bestand als het PDF-document een XFA-stroom bevat in het AcroForm-woordenboek.
Verwerkte documenten

Billable Data Capture API's billable-data-capture-apis

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 verstrekte ​ transactierecorder API ​ om een voorlegging van PDF forms als transactie te registreren.

Adaptieve Forms adaptive-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 geslaagde verzendingen. Het aantal transacties dat wordt meegeteld, is afhankelijk van het type verzendactie dat wordt gebruikt voor verzending. Bijvoorbeeld, verzendend PDF door e-mail verzend actierekeningen voor twee tellingen van transacties. 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 html-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 form-set

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 billable-interactive-communication-and-form-centric-aem-workflows-on-osgi-apis

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 interactive-communication-web-channel

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

Interactieve communicatie - Afdrukkanaal interactive-communication-print-channel

API
Beschrijving
Categorie Transactieverslag
Aanvullende informatie
teruggeven(zet in PDF om)
Genereert de PDF-versie van een interactieve communicatie.
Gerenderde documenten

Form-centric AEM Workflows op OSGi form-centric-aem-workflows-on-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 recording-billable-apis-as-transactions-for-custom-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 API van uw douaneimplementaties roepen om ​ een transactie ​ te registreren.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2