Fakturerbara API:er för transaktionsrapporter transaction-reports-billable-apis

AEM Forms har flera API:er för att skicka formulär, bearbeta dokument och återge dokument. Vissa API:er räknas som transaktioner och andra kan användas. Det här dokumentet innehåller en lista över alla API:er som har redovisats som transaktioner i en transaktionsrapport. Här är några vanliga scenarier där ett fakturerbart API används:

  • Skicka ett anpassat formulär, HTML5-formulär och formuläruppsättning
  • Återge en tryckt eller webbversion av en interaktiv kommunikation
  • Konvertera ett dokument från ett format till ett annat
  • Förenkla ett dynamiskt PDF-dokument
  • Generera ett postdokument
  • Sammanfoga ett interaktivt PDF-dokument med ett annat PDF-dokument
  • Tilldela uppgiftssteg och dokumenttjänststeg i AEM
  • Använda anpassningsbara formulär i ett adaptivt formulär

Fakturerings-API:erna tar inte hänsyn till antalet sidor, längden på ett dokument eller formulär eller det återgivna dokumentets slutliga format. En transaktionsrapport delar upp transaktionerna i två kategorier: Dokument som återges och Forms som skickas.

  • Forms: När data skickas in från någon typ av formulär som skapats med AEM Forms och data skickas till en datalagringsplats eller databas anses det som en formuläröverföring. Om du t.ex. skickar in ett anpassningsbart formulär, HTML5-formulär, PDF forms och formuläruppsättning, räknas de som inskickade formulär. Varje formulär i en formuläruppsättning betraktas som en inlämning. Om en formuläruppsättning till exempel har fem formulär, räknas den som 5 inskickade när formuläruppsättningen skickas.

  • Återgivna dokument: Att generera ett dokument genom att kombinera en mall och data, digitalt signera eller certifiera ett dokument, använda ett fakturerbart dokument-API för dokumenttjänster eller konvertera ett dokument från ett format till ett annat, räknas som dokument som återges.

NOTE
Gränssnittet för transaktionsrapporter visar tre kategorier: Forms skickat, Dokument återgivet och Bearbetade dokument. Både återgivna dokument och behandlade dokument räknas som återgivna dokument.

Fakturerbara API:er för dokumenttjänster billable-document-services-apis

Generera tjänsten PDF generate-pdf-service

API
Beskrivning
Kategori för transaktionsrapport
Ytterligare information
createPDF
Skapar Adobe PDF av filtyper som stöds.
Bearbetade dokument
createPDF2
Skapar Adobe PDF av filtyper som stöds.
Bearbetade dokument
exportPDF
Konverterar Adobe PDF till filtyper som stöds.
Bearbetade dokument
exportPDF2
Konverterar Adobe PDF till filtyper som stöds.
Bearbetade dokument
exportPDF3
Konverterar Adobe PDF till filtyper som stöds.
Bearbetade dokument
htmlFileToPdf
Skapar PDF från HTML.
Bearbetade dokument
htmlToPdf
Skapar PDF från URL:er som pekar mot en HTML-sida.
Bearbetade dokument
htmlToPdf2
Skapar PDF från URL:er som pekar mot en HTML-sida.
Bearbetade dokument
optimeraPDF
Optimerar PDF för att minska filstorleken genom att ta bort onödiga metadata utan att påverka kvaliteten.
Bearbetade dokument

DocAssurance-tjänst DocAssurance-Service

API
Beskrivning
Kategori för transaktionsrapport
Ytterligare information
secureDocument
Med detta API kan du skydda ditt dokument. Du kan använda API:t för att signera, certifiera, utöka eller kryptera ett PDF-dokument.
Bearbetade dokument
Endast signerings- och certifieringsåtgärden för secureDocument faktureras.

Distiller Service distiller-service

API
Beskrivning
Kategori för transaktionsrapport
Ytterligare information
createPDF
Skapar Adobe PDF av filtyper som stöds.
Bearbetade dokument
createPDF2
Skapar Adobe PDF av filtyper som stöds.
Bearbetade dokument

DoR-tjänst (Document of Record Service) document-of-record-service-dor-service

API
Beskrivning
Kategori för transaktionsrapport
Ytterligare information
återge
Anropar den angivna återgivningsmetoden för att generera ett postdokument med angivna parametrar.
Bearbetade dokument

Output Service output-service

API
Beskrivning
Kategori för transaktionsrapport
Ytterligare information
generatePDFOutput
Sammanfogar data och mallar för att skapa ett PDF-dokument.
Bearbetade dokument
generatePDFOutput
Sammanfogar data och mallar för att skapa ett PDF-dokument.
Bearbetade dokument
generatePDFOutputBatch
Sammanfogar data och mallar för att skapa en uppsättning PDF-dokument.
Bearbetade dokument
API:t generatePDFOutputBatch kombinerar en formulärmall med en post och genererar en PDF. När du bearbetar en grupp poster räknas varje post som en separat PDF-återgivning av transaktionsrapporteringstjänsten.
Du kan använda getGenerateManyFiles om du vill kombinera flera renderingar till en enda PDF-fil. Oavsett flaggstatus räknas varje post som en separat PDF-återgivning.
generatePrintedOutput
Konverterar XDP- och PDF-dokument till filformaten PostScript (PS), Printer Command Language (PCL) och ZPL.
Bearbetade dokument
generatePrintedOutput
Konverterar XDP- och PDF-dokument till filformaten PostScript (PS), Printer Command Language (PCL) och ZPL.
Bearbetade dokument
generatePrintedOutputBatch
Konverterar en uppsättning XDP- och PDF-dokument till en uppsättning PostScript- (PS), Printer Command Language (PCL) och ZPL-filformat.
Bearbetade dokument
API:t generatePDFOutputBatch kombinerar en formulärmall med en post och genererar en PDF. När du bearbetar en grupp poster räknas varje post som en separat PDF-återgivning av transaktionsrapporteringstjänsten.
Du kan använda getGenerateManyFiles om du vill kombinera flera renderingar till en enda PDF-fil. Oavsett flaggstatus räknas varje post som en separat PDF-återgivning.

Forms Service forms-service

API
Beskrivning
Kategori för transaktionsrapport
Ytterligare information
renderPDFForm
Återger PDF-formulär från XDP-mallar. XP-mallarna skapas i Forms Designer.
Bearbetade dokument
exportData
Extraherar data från ett PDF-formulär eller XDP-mallar
Bearbetade dokument

Konvertera tjänsten PDF convert-pdf-service

API
Beskrivning
Kategori för transaktionsrapport
Ytterligare information
toImage
Konverterar ett PDF-dokument till en lista med bilddokument. Bildformat som stöds är JPEG, JPEG2K, PNG och TIFF.
Bearbetade dokument
toPS
Konverterar en platt PDF-fil till PostScript-format med de alternativ som anges i alternativspecifikationen.
Bearbetade dokument

Barcoded Forms Service barcoded-forms-service

API
Beskrivning
Kategori för transaktionsrapport
Ytterligare information
decode
Avkodar alla streckkoder i ett Document-objekt och returnerar ett org.w3c.dom.Document-objekt som innehåller data som hämtats från streckkoden.
Bearbetade dokument

Assembler Service assembler-service

API
Beskrivning
Kategori för transaktionsrapport
Ytterligare information
invoke
Kör det angivna DDX-dokumentet och returnerar ett AssemblerResult objekt som innehåller de resulterande dokumenten.
Bearbetade dokument

Följande operationer redovisas inte som transaktioner:

  • Skapa paket eller portfölj
  • Välja ut flera XDP-filer
invoke
Kör det angivna DDX-dokumentet och returnerar ett AssemblerResult objekt som innehåller de resulterande dokumenten.
Bearbetade dokument
Alla indatafilformat som stöds av PDF Generator-, Forms- och Output-tjänsterna har stöd för alla dessa format som utdatafilformat.
toPDFA
Konvertera ett angivet dokument till PDF/A med de angivna alternativen.
Bearbetade dokument

API:ts användning räknas som en transaktion när du utför en eller flera av följande åtgärder:

  1. Konvertering från andra format än PDF till PDF. Konverteringen från XDP-format till PDF, till exempel både interaktiva och icke-interaktiva kommunikationsformer och konverteringen från Word till PDF.
  2. Konvertering från PDF till PDF/A-format.
  3. Konvertering från PDF till andra format än PDF. Exempel omfattar omformningen från PDF till bildformat eller konverteringen från PDF till textformat.
NOTE
  • Anrop-API:t för sammansättartjänsten kan internt anropa ett fakturerbart API för en annan tjänst beroende på indata. Detta innebär att invoke-API:t kan redovisas som inga, enskilda eller flera transaktioner. Antalet transaktioner som räknas beror på indata och de interna API:erna som anropas.
  • Ett enda PDF-dokument som skapats med en monteringsfunktion kan redovisas som inga, enstaka eller flera transaktioner. Antalet transaktioner som räknas beror på den angivna DDX-koden.

Verktygstjänsten PDF pdf-utility-service

API
Beskrivning
Kategori för transaktionsrapport
Ytterligare information
convertPDFtoXDP
Konverterar ett PDF-dokument till en XDP-fil. För att ett PDF-dokument ska kunna konverteras till en XDP-fil måste PDF-dokumentet innehålla en XFA-ström i AcroForm-ordlistan.
Bearbetade dokument

Fakturerbara API:er för datainhämtning billable-data-capture-apis

Alla överföringshändelser för adaptiva formulär, HTML5 Forms och formuläruppsättningar redovisas som transaktioner. Som standard räknas inte inlämning av ett PDF-formulär som en transaktion. Använd den angivna API för transaktionsregistrering för att registrera en PDF forms som en transaktion.

Adaptiv Forms adaptive-forms

Användningsfall
Beskrivning
Kategori för transaktionsrapport
Ytterligare information
Skicka ett anpassat formulär
Skickar ett anpassat formulär till den konfigurerade skicka-åtgärden.
Forms har skickats
  • Konto för slutförda överföringar för en eller två transaktioner. Antalet transaktioner som räknas beror på vilken typ av överföringsåtgärd som används för att skicka in. Du kan till exempel skicka PDF via e-poståtgärdskonton för att skicka två antal transaktioner. En transaktion för att skicka formulär och en annan för PDF som genereras med tjänsten Document of Record (DOR).
  • När du använder det adaptiva formuläret i ett adaptivt formulär (adaptiv formuläruppsättning) utförs endast en transaktion. Du kan ha ett obegränsat antal anpassningsbara formulär i ett anpassat formulär.

HTML5 Forms html-forms

Användningsfall
Beskrivning
Kategori för transaktionsrapport
Ytterligare information
Skicka ett HTML5-formulär
Skickar ett HTML5-formulär till en skicka-URL som är konfigurerad i formuläret.
Forms har skickats

Formuläruppsättning form-set

API
Beskrivning
Kategori för transaktionsrapport
Ytterligare information
Skicka en formuläruppsättning
Skickar formuläruppsättningen till den skicka-URL som är konfigurerad i formuläruppsättningen.
Forms har skickats
  • När du använder det adaptiva formuläret i ett adaptivt formulär (adaptiv formuläruppsättning) utförs endast en transaktion. Du kan ha ett obegränsat antal anpassningsbara formulär i ett anpassat formulär.
  • Alla formulär i en HTML5 Forms-formuläruppsättning konton som en separat transaktion.

Fakturerbar interaktiv kommunikation och formulärcentrerade AEM arbetsflöden i OSGi API:er billable-interactive-communication-and-form-centric-aem-workflows-on-osgi-apis

Tilldela uppgifter och dokumenttjänster steg i formulärbaserade AEM arbetsflöden i OSGi och alla återgivningar av interaktiv kommunikation och redovisas som transaktioner. Förhandsgranskning av en interaktiv kommunikation på författarinstansen och förhandsgranskning på publiceringsinstansen med agentens användargränssnitt räknas inte som transaktioner. Om ett arbetsflödessteg redovisar en transaktion och arbetsflödet inte kan slutföras, återförs inte antalet transaktioner.

Interaktiv kommunikation - webbkanal interactive-communication-web-channel

API
Beskrivning
Kategori för transaktionsrapport
Ytterligare information
Återge en webbkanal
Öppnar webbversionen av en interaktiv kommunikation.
Återgivna dokument

Interaktiv kommunikation - tryckkanal interactive-communication-print-channel

API
Beskrivning
Kategori för transaktionsrapport
Ytterligare information
återge (konvertera till PDF)
Skapar PDF-versionen av en interaktiv kommunikation.
Återgivna dokument

Formulärbaserade AEM arbetsflöden i OSGi form-centric-aem-workflows-on-osgi

Använd skiftläge
Kategori för transaktionsrapport
Ytterligare information
Skicka ett steg för Tilldela uppgift
Forms har skickats
Skicka en startpunkt för ett arbetsflödesprogram
Forms har skickats
Skicka en interaktiv kommunikation (tryckkanal) från agentgränssnittet till ett arbetsflöde
Återgivna dokument

Registrera fakturerbara API:er som transaktioner för anpassad kod recording-billable-apis-as-transactions-for-custom-code

Åtgärder som att skicka ett PDF-formulär, använda agentanvändargränssnittet för att förhandsgranska interaktiv kommunikation, skicka formulär som inte är standard och anpassade implementeringar räknas inte som transaktioner. AEM Forms tillhandahåller ett API för att spela in sådana åtgärder som transaktioner. Du kan anropa API:t från dina anpassade implementeringar till spela in en transaktion.

Relaterade artiklar related-articles

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