AEM Forms as a Cloud Service Communication APIs frequently-asked-questions

Hero-bild

Version
Artikellänk
AEM 6.5
Klicka här
AEM as a Cloud Service
Den här artikeln

Med kommunikationsfunktioner kan ni skapa varumärkesgodkända, personaliserade och standardiserade dokument som affärskontakter, kontoutdrag, kravbrev, förmånsmeddelanden, månatliga fakturor eller välkomstpaket.

Funktionen ger API:er för att generera och hantera dokument. Du kan generera eller ändra ett dokument on demand eller skapa ett batchjobb för att generera flera dokument med definierade intervall. Kommunikations-API:er ger:

  • smidiga funktioner för att generera on demand- och batchdokumentation.

  • möjlighet att kombinera, ordna om och validera PDF-dokument on-demand.

  • HTTP-API:er för enklare integrering med externa system. Separata API:er för on demand-åtgärder (låg fördröjning) och batchåtgärder (högdataåtgärder) ingår.

  • säker åtkomst till data. Kommunikations-API:er ansluter till och får endast åtkomst till data från kundutsedda datalager, vilket gör kommunikationen mycket säker.

Dokumentgenerering

API:er för dokumentgenerering för kommunikation hjälper dig att kombinera en mall (XFA eller PDF) med kunddata (XML) för att generera dokument i PDF och utskriftsformat som PS, PCL, DPL, IPL och ZPL. Dessa API:er använder PDF- och XFA-mallar med XML-data för att generera ett enda dokument vid behov eller flera dokument med hjälp av ett batchjobb.

Vanligtvis skapar du en mall med Designer och använder kommunikationsAPI:er för att sammanfoga data med mallen. Programmet kan skicka utdatadokumentet till en nätverksskrivare, en lokal skrivare eller till ett lagringssystem för arkivering. Ett typiskt exempel och anpassade arbetsflöden ser ut så här:

Arbetsflöde för dokumentgenerering för kommunikation

Beroende på hur de används kan du även göra dessa dokument tillgängliga för hämtning via din webbplats eller en lagringsserver.

Några exempel på API:er för dokumentgenerering är:

Skapa PDF-dokument create-pdf-documents

Du kan använda API:erna för dokumentgenerering för att skapa ett PDF-dokument som baseras på en formulärdesign och XML-formulärdata. Utdata är ett icke-interaktivt PDF-dokument. Användarna kan alltså inte ange eller ändra formulärdata. Ett grundläggande arbetsflöde är att sammanfoga XML-formulärdata med en formulärdesign för att skapa ett PDF-dokument. I följande bild visas sammanslagningen av en formulärdesign och XML-formulärdata för att skapa ett PDF-dokument.

Skapa PDF-dokument
Bild: Vanligt arbetsflöde för att skapa ett PDF-dokument

Skapa dokument för PostScript (PS), Printer Command Language (PCL) och Zebra Printing Language (ZPL) create-PS-PCL-ZPL-documents

Du kan använda API:er för dokumentgenerering för att skapa dokument i formaten PostScript (PS), Printer Command Language (PCL) och Zebra Printing Language (ZPL) som baseras på en XDP-formulärdesign eller ett PDF-dokument. Dessa API:er hjälper till att sammanfoga en formulärdesign med formulärdata för att generera ett dokument. Du kan spara dokumentet i en fil och utveckla en anpassad process för att skicka det till en skrivare.

Bearbeta gruppdata för att skapa flera dokument processing-batch-data-to-create-multiple-documents

Du kan använda API:er för dokumentgenerering för att skapa separata dokument för varje post i en XML-batchdatakälla. Du kan generera dokument i både gruppläge och asynkront läge. Du kan konfigurera olika parametrar för konverteringen och sedan starta gruppbearbetningen.

Skapa PDF-dokument

Dokumentmanipulering

API:er för dokumentbearbetning (Document Transformation) hjälper dig att kombinera och ordna om PDF-dokument. Vanligtvis skapar du en DX och skickar den till dokumenthanterings-API:er för att montera eller ordna om ett dokument. DDX-dokumentet innehåller instruktioner om hur du använder källdokumenten för att skapa en uppsättning med obligatoriska dokument. DDX-referensdokumentationen innehåller detaljerad information om alla åtgärder som stöds. Några exempel på dokumentbearbetning är:

Sammanställa dokument från PDF

Du kan använda API:erna för dokumentmanipulering för att sammanfoga två eller flera PDF- eller XDP-dokument till ett enda PDF-dokument eller PDF Portfolio. Här är några sätt att sammanställa PDF-dokument:

  • Sammanställa ett enkelt PDF-dokument
  • Skapa en PDF Portfolio
  • Sammanställa krypterade dokument
  • Sammanställa dokument med Bates-numrering
  • Förenkla och sammanställ dokument

Sammanställa ett enkelt PDF-dokument från flera PDF-dokument
Bild: Sammanställa ett enkelt PDF-dokument från flera PDF-dokument

Disassemblera PDF-dokument

Du kan använda API:erna för dokumentbearbetning för att demontera ett PDF-dokument. API:erna kan extrahera sidor från källdokumentet eller dela upp ett källdokument baserat på bokmärken. Vanligtvis är den här uppgiften användbar om PDF-dokumentet ursprungligen skapades från många enskilda dokument, till exempel en samling programsatser.

  • Hämta sidor från ett källdokument
  • Dela upp ett källdokument baserat på bokmärken

Dela upp ett källdokument baserat på bokmärken i flera dokument
Bild: Dela upp ett källdokument baserat på bokmärken i flera dokument

NOTE
AEM Forms har en mängd inbyggda teckensnitt som är helt integrerade med PDF filer. Klicka här om du vill visa en lista över teckensnitt som stöds.

Extrahering av dokument

Funktionen för dokumentextrahering är under Tidiga Adobe-program. Du kan skriva till aem-forms-ea@adobe.com från ditt officiella e-post-id för att gå med i det tidiga adopterprogrammet och begära åtkomst till funktionen.

Med dokumentextraheringstjänsten kan du hämta PDF-dokumentets egenskaper, t.ex. användarbehörighet, PDF-egenskaper och metadata. Extraheringsfunktionerna är:

  • Hämtar egenskaperna för ett PDF-dokument, t.ex. om PDF har bifogade filer, kommentarer, Acrobat-version och många andra.
  • Extrahera användningsrättigheterna som är aktiverade i ett PDF-dokument, så hämtar användarna användningsrättigheterna som är aktiverade eller inaktiverade i ett PDF-dokument för Adobe Acrobat Reader-utbyggbarhet.
  • Hämta metadatainformationen som finns i ett PDF-dokument. Metadata är information om dokumentet (som skiljer sig från dokumentets innehåll, som text och bilder). Adobe Extensible Metadata Platform (XMP) är en standard för hantering av dokumentmetadata. Tjänsten XMP Utilities kan hämta XMP metadata från PDF-dokument och exportera XMP metadata till PDF-dokument.

API-referensdokumentationen innehåller detaljerad information om alla parametrar, autentiseringsmetoder och tjänster som tillhandahålls av API:er. API-referensdokumentationen finns också i .yaml-format. Du kan hämta .yaml-filen och överföra den till Postman för att kontrollera API:ernas funktioner.

Dokumentkonvertering

Konvertera till och validera dokument som följer PDF/A

API:er för dokumentkonvertering för kommunikation hjälper till att konvertera ett PDF-dokument till PDF/A. Du kan använda API:erna för att konvertera ett PDF-dokument till ett dokument som överensstämmer med PDF/A och även för att avgöra om ett PDF-dokument är PDF/A-kompatibelt. PDF/A är ett arkiveringsformat som är avsett för långtidsarkivering av dokumentets innehåll. Teckensnitten bäddas in i dokumentet och filen är okomprimerad. Därför är ett PDF/A-dokument vanligtvis större än ett PDF-standarddokument. Ett PDF/A-dokument innehåller inte heller ljud- och videoinnehåll.

Konvertera PDF till XDP convert-pdf-to-xdp

Funktionen för att konvertera PDF till XDP finns i Tidigt Adobe-program. Du kan skriva till aem-forms-ea@adobe.com från ditt officiella e-post-id för att gå med i det tidiga adopterprogrammet och begära åtkomst till funktionen.

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 ordlistan.

Dokumentsäkerhet doc-assurance

Tjänsten DocAssurance innehåller API:erna för signatur och kryptering:

Signatur-API:er

Med signatur-API:erna kan din organisation skydda säkerheten och sekretessen för Adobe PDF-dokument som den distribuerar och tar emot. Säkerhetsfunktionerna tillämpas på själva dokumentet. Dokumentet förblir säkert och styrs under hela livscykeln. Dokumentet förblir säkert även utanför brandväggen när det laddas ned offline och när det skickas tillbaka till organisationen. Du kan utföra följande uppgifter med signatur-API

  • Lägg till ett synligt signaturfält i ett PDF-dokument.
  • Lägg till ett osynligt signaturfält i ett PDF-dokument.
  • Signera det angivna signaturfältet i ett PDF-dokument.
  • Certifiera ett PDF-dokument

Krypterings-API:er

Med krypterings-API:erna kan du kryptera och dekryptera dokument. När ett dokument är krypterat blir innehållet oläsligt. En behörig användare kan dekryptera dokumentet för att få åtkomst till innehållet. Om ett PDF-dokument är krypterat med ett lösenord måste användaren ange det öppna lösenordet innan dokumentet kan visas i Adobe Reader eller Adobe Acrobat.

Du kan utföra följande uppgifter med krypterings-API

  • Kryptera ett PDF-dokument med ett lösenord.
  • Ta bort lösenordsbaserad kryptering från ett PDF-dokument.
  • Hämta den typ av skydd som används för ett PDF-dokument.
  • Returnera säkerhetstypen som används för ett PDF-dokument.

Både signatur-API:er och krypterings-API:er är synkrona API:er.

Dokumentverktyg doc-utility

Dokumentverktyg med synkrona API:er hjälper dig att konvertera dokument mellan filformaten PDF och XDP. Använd användarrättigheter för ett dokument och extrahera de aktiverade användningsrättigheterna från ett dokument. Frågeinformation om ett PDF-dokument. Information om API:er för användningsrättigheter anges nedan:

API:er för användningsrättigheter (Reader Extension)

Funktionen Användningsrättigheter (Reader Extension) finns under Tidiga Adobe-programmet. Du kan skriva till aem-forms-ea@adobe.com från ditt officiella e-post-id för att gå med i det tidiga adopterprogrammet och begära åtkomst till funktionen.

Med funktionen Användningsrättigheter kan man enkelt utbyta interaktiva PDF-dokument genom att utöka funktionaliteten i Adobe Reader med ytterligare användarrättigheter. Tjänsten fungerar med Adobe Reader 7.0 eller senare och lägger till användarrättigheter i ett PDF-dokument. Den här åtgärden aktiverar funktioner som normalt inte är tillgängliga när ett PDF-dokument öppnas med Adobe Reader, till exempel för att lägga till kommentarer i ett dokument, fylla i formulär och spara dokumentet.

När PDF-dokument har rätt användarbehörighet kan mottagarna göra följande i Adobe Reader:

  • Fyll i PDF-dokument och -formulär online eller offline, så att mottagarna kan spara kopior lokalt för att spara dem och ändå behålla informationen intakt.
  • Spara PDF-dokument på en lokal hårddisk om du vill behålla originaldokumentet och eventuella ytterligare kommentarer, data eller bilagor.
  • Bifoga filer och medieklipp i PDF-dokument.
  • Signera, certifiera och autentisera PDF-dokument genom att använda digitala signaturer med PKI-teknik (public key infrastructure) som är branschstandard.
  • Skicka in ifyllda eller kommenterade PDF-dokument elektroniskt.
  • Använd PDF-dokument och -formulär som en intuitiv utvecklingsmiljö för interna databaser och webbtjänster.
  • Utbyt PDF-dokument med andra så att granskarna kan lägga in kommentarer med de intuitiva kommentarverktygen. Bland dessa verktyg finns elektroniska notisar, stämplar, högdagrar och textöverstrykning. Samma funktioner är tillgängliga i Acrobat.
  • Support Barcoded Forms decoding.

Dessa specialfunktioner aktiveras automatiskt när ett PDF-dokument med aktiverade rättigheter öppnas i Adobe Reader. När användaren är klar med ett rättighetsaktiverat dokument inaktiveras dessa funktioner igen i Adobe Reader. De är inaktiverade tills användaren får ett annat rättighetsaktiverat PDF-dokument.

Aktivera eller inaktivera användningsrättigheter

De olika funktionerna för användarrättigheter för utökning av PDF Reader är följande:

  • Streckkoder avkodas: Om du vill avkoda streckkoder i PDF-dokumentet.

  • Kommentarer: Om du vill kommentera offline i PDF-dokumentet.

  • Kommentarer online: Om du vill kommentera online i PDF-dokumentet.

  • Digital signatur: Så här lägger du till digitala signaturer i ett PDF-dokument.

  • Dynamiska formulärfält: Så här lägger du till formulärfält i ett PDF-dokument.

  • Dynamiska formulärsidor: Så här lägger du till formulärsidor i ett PDF-dokument.

  • Inbäddade filer: Om du vill bädda in filer i ett PDF-dokument.

  • Importera formulärdata: Om du vill importera formulärdata till ett PDF-dokument.

  • Formulärdataexport: Så här importerar du formulärdata till ett PDF-dokument.

  • Formulärfyllning: Om du vill fylla i formulärfält i ett PDF-dokument.

  • Online Forms: Om du vill komma åt en webbtjänst eller databas från ett PDF-dokument.

  • Skicka fristående: Om du vill skicka formulärdata offline från ett PDF-dokument.

Andra funktioner

  • Meddelande: Meddelandet som visas i Adobe Acrobat Reader när ett PDF-dokument öppnas med en eller flera användningsrättigheter.
  • Lås upp lösenord: Lösenordet som krävs för att öppna ett krypterat PDF-dokument. Det här är vanligtvis lösenordet för dokumentöppning, men om PDF-dokumentet dessutom skyddas av ett behörighetslösenord kan det användas för att öppna det.

API-referensdokumentationen innehåller detaljerad information om alla parametrar, autentiseringsmetoder och olika tjänster som tillhandahålls av API:er. API-referensdokumentationen finns också i .yaml-format. Du kan hämta .yaml-filen och överföra den till Postman för att kontrollera API:ernas funktioner.

Typer av API:er för kommunikation types

Kommunikationen tillhandahåller HTTP-API:er för on demand- och batchdokumentgenerering:

  • Synkrona API:er är lämpliga för dokumentgenerering on demand, low latency och single record. Dessa API:er lämpar sig bättre för användaråtgärdsbaserade användningsfall. Du kan till exempel skapa ett dokument när en användare har fyllt i ett formulär.

  • Batch-API:er (asynkrona API:er) passar för schemalagda, höga genomströmningsscenarier och flera dokumentgenereringsscenarier. Dessa API:er genererar dokument gruppvis. Till exempel genereras telefonräkningar, kreditkortsräkningar och förmånsräkningar varje månad.

Onboarding

Kommunikationskapaciteten är tillgänglig som en fristående modul och tilläggsmodul för Forms as a Cloud Service användare. Du kan kontakta Adobe säljteam eller din Adobe-representant för att få åtkomst. Adobe aktiverar åtkomst för organisationen och tillhandahåller behörigheter åt den person som utses till administratör i organisationen. Administratören kan ge Forms as a Cloud Service utvecklare (användare) i organisationen åtkomst till API:erna.

Efter introduktionen, för att aktivera kommunikationsfunktioner för din Forms as a Cloud Service miljö:

  1. Logga in på Cloud Manager och öppna AEM Forms as a Cloud Service Instance.

  2. Öppna alternativet Redigera program, gå till fliken Lösningar och tillägg och välj alternativet Forms - Communications.

    Kommunikation

    Om du redan har aktiverat alternativet Forms - Digital Enrollment väljer du alternativet Forms - Communications Add-On.

    Lägg till

  3. Klicka på Update.

  4. Kör byggprocessen. När byggprocessen är klar aktiveras API:er för kommunikation för din miljö.

NOTE
Om du vill aktivera och konfigurera API:er för dokumentbearbetning lägger du till följande regel i Dispatcher-konfigurationen:
# Allow Forms Doc Generation requests
/0062 { /type "allow" /method "POST" /url "/adobe/forms/assembler/*" }

Se även see-also

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