Einführung in die Kommunikationsfunktion von AEM Forms as a Cloud Service frequently-asked-questions

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

Die Kommunikationsfunktion hilft Ihnen, markenorientierte, personalisierte und standardisierte Dokumente wie Geschäftskorrespondenzen, Kontoauszüge, Mahnschreiben, Leistungsbescheide, monatliche Rechnungen oder Willkommenspakete zu erstellen.

Die Funktion stellt APIs zum Erzeugen und Bearbeiten der Dokumente bereit. Sie können bei Bedarf ein Dokument erzeugen oder einen Batch-Vorgang erstellen, um mehrere Dokumente in definierten Intervallen zu generieren. Kommunikations-APIs bieten:

  • Optimierte Funktionen zur Erstellung von On-Demand- und Batch-Dokumentationen.

  • Die Möglichkeit, PDF-Dokumente bei Bedarf zu kombinieren, neu anzuordnen und zu validieren.

  • HTTP-APIs für eine einfachere Integration mit bestehenden Systemen. Separate APIs für Vorgänge auf Anfrage (niedrige Latenz) und Batch-Vorgänge (Vorgänge mit hohem Durchsatz) sind enthalten.

  • Sicherer Datenzugriff. Kommunikations-APIs verbinden sich nur mit Daten aus Daten-Repositorys, die vom Kunden festgelegt wurden, und greifen nur auf solche Daten zu, wodurch die Kommunikation extrem sicher ist.

Beispiel eines Kreditkartenauszugs
Ein Kreditkartenauszug kann mit Kommunikations-APIs erstellt werden. In diesem Beispielauszug wird dieselbe Vorlage verwendet, aber je nach Verwendung der Kreditkarte werden für jeden Kunden separate Daten genutzt.

Erzeugen von Dokumenten

APIs zur Generierung von Kommunikationsdokumenten ermöglichen Ihnen durch die Kombination einer Vorlage (XFA oder PDF) mit Kundendaten (XML-Daten) Dokumente in PDF- und Druckformaten wie PS, PCL, DPL, IPL und ZPL zu erstellen. Diese APIs verwenden PDF- und XFA-Vorlagen mit XML-Daten, um auf Anfrage ein einzelnes Dokument oder mehrere Dokumente mithilfe eines Batch-Vorgangs zu erzeugen.

Normalerweise erstellen Sie eine Vorlage mit Designer und verwenden Communications-APIs, um Daten mit der Vorlage zusammenzuführen. Ihr Programm kann das Ausgabedokument zur Archivierung an einen Netzwerkdrucker, einen lokalen Drucker oder an ein Speichersystem senden. Typische vorkonfigurierte und benutzerdefinierte Workflows sehen wie folgt aus:

Workflow zum Erzeugen von Kommunikationsdokumenten

Je nach Anwendungsfall können Sie diese Dokumente auch über Ihre Website oder einen Speicher-Server zum Download bereitstellen.

Beispiele für APIs zum Erzeugen von Dokumenten:

Erstellen von PDF-Dokumenten create-pdf-documents

Sie können die API zum Erzeugen von Dokumenten verwenden, um ein PDF-Dokument zu erstellen, das auf einem Formular-Design und XML-Formulardaten basiert. Die Ausgabe ist ein nicht interaktives PDF-Dokument. Das heißt, Benutzer können keine Formulardaten eingeben oder ändern. Ein einfacher Workflow besteht darin, XML-Formulardaten mit einem Formular-Design zusammenzuführen, um ein PDF-Dokument zu erstellen. Die folgende Abbildung zeigt die Zusammenführung von Formular-Designs und XML-Formulardaten zur Erstellung eines PDF-Dokuments.

Erstellen von PDF-Dokumenten
Abbildung: Typischer Workflow zum Erstellen eines PDF-Dokuments

Erstellen des Dokuments im Format PostScript (PS), Printer Command Language (PCL), Zebra Printing Language (ZPL) create-PS-PCL-ZPL-documents

Sie können APIs zum Erzeugen von Dokumenten verwenden, um PostScript (PS)-, Printer Command Language (PCL)- und Zebra Printing Language (ZPL)-Dokumente zu erstellen, die auf einem XDP-Formular-Design oder PDF-Dokument basieren. Diese APIs helfen beim Zusammenführen eines Formular-Designs mit Formulardaten, um ein Dokument zu erzeugen. Sie können das Dokument in einer Datei speichern und einen benutzerdefinierten Prozess entwickeln, um es an einen Drucker zu senden.

Verarbeitung von Batch-Daten zum Erstellen mehrerer Dokumente processing-batch-data-to-create-multiple-documents

Sie können APIs zum Erzeugen von Dokumenten verwenden, um separate Dokumente für jeden Eintrag in einer XML-Batch-Datenquelle zu erstellen. Sie können Dokumente im Bulk-Modus und im asynchronen Modus erstellen. Sie können verschiedene Parameter für die Konvertierung konfigurieren und dann den Batch-Prozess starten.

Erstellen von PDF-Dokumenten

Dokumentenbearbeitung

Mithilfe von APIs zur Dokumentenbearbeitung können Sie PDF-Dokumente kombinieren, neu anordnen und validieren. In der Regel erstellen Sie ein DDX und übermitteln es an APIs zur Dokumentenbearbeitung, um ein Dokument zusammenzustellen oder neu anzuordnen. Das DDX-Dokument enthält Anweisungen dazu, wie die Quelldokumente zum Erzeugen eines Satzes von erforderlichen Dokumenten verwendet werden. Die DDX-Referenzdokumentation enthält detaillierte Informationen zu allen unterstützten Vorgängen. Beispiele für die Bearbeitung von Dokumenten:

Zusammenführen von PDF-Dokumenten

Mithilfe von APIs zur Dokumentbearbeitung können Sie zwei oder mehrere PDF- oder XDP-Dokumente zu einem einzigen PDF-Dokument oder PDF-Portfolio zusammenführen. Im Folgenden finden Sie einige Möglichkeiten, wie Sie PDF-Dokumente zusammenführen können:

  • Zusammenführen eines einzelnen PDF-Dokuments
  • Erstellen eines PDF-Portfolios
  • Zusammenführen von verschlüsselten Dokumenten
  • Zusammenführen von Dokumenten mithilfe der Bates-Nummerierung
  • Reduzieren und Zusammenführen von Dokumenten

Zusammenstellen eines einfachen PDF-Dokuments aus mehreren PDF-Dokumenten
Abbildung: Zusammenstellen eines einfachen PDF-Dokuments aus mehreren PDF-Dokumenten

Aufteilen von PDF-Dokumenten

Sie können die APIs zur Dokumentbearbeitung verwenden, um ein PDF-Dokument zu zerlegen. Die APIs können kann Seiten aus dem Quelldokument extrahieren oder ein Quelldokument basierend auf Lesezeichen aufteilen. Diese Aufgabe ist normalerweise hilfreich, wenn das PDF-Dokument ursprünglich aus vielen Einzeldokumenten erstellt wurde, wie z. B. einer Sammlung von Aussagen.

  • Extrahieren von Seiten aus einem Quelldokument
  • Aufteilen eines Quelldokuments basierend auf Lesezeichen

Aufteilen eines Quelldokuments basierend auf Lesezeichen in mehrere Dokumente
Abbildung: Aufteilen eines Quelldokuments basierend auf Lesezeichen in mehrere Dokumente

Konvertieren in PDF/A-konforme Dokumente und Validieren

Sie können die APIs zur Dokumentbearbeitung verwenden, um ein PDF-Dokument in ein PDF/A-konformes Dokument zu konvertieren oder um zu ermitteln, ob ein PDF-Dokument PDF/A-konform ist. PDF/A ist ein Archivierungsformat für die langfristige Speicherung von Dokumentinhalten. Die Schriftarten werden im Dokument eingebettet und die Datei bleibt unkomprimiert. PDF/A-Dokumente sind daher in der Regel größer als normale PDF-Dokumente. Außerdem enthalten PDF/A-Dokumente keine Audio- und Videoinhalte.

NOTE
AEM Forms bietet eine Vielzahl integrierter Schriftarten, die nahtlos in PDF-Dateien integriert werden können. Um die Liste der unterstützten Schriftarten anzuzeigen, klicken Sie hier.

Document Assurance doc-assurance

Der DocAssurance-Dienst umfasst die Signature- und Verschlüsselungs-APIs:

Signature-APIs

Signature-APIs ermöglichten Ihrem Unternehmen, die Sicherheit und Vertraulichkeit verteilter und empfangener Adobe PDF-Dokumente zu gewährleisten. Die Sicherheitsfunktionen werden auf das Dokument selbst angewendet, das Dokument bleibt für seinen gesamten Lebenszyklus sicher und kontrolliert. Das Dokument bleibt außerhalb der Firewall sicher, wenn es offline heruntergeladen und an Ihr Unternehmen zurückgesendet wird. Sie können die folgenden Aufgaben mithilfe der Signature-APIs ausführen:

  • Fügen Sie einem PDF-Dokument ein sichtbares Signaturfeld hinzu.
  • Fügen Sie einem PDF-Dokument ein unsichtbares Signaturfeld hinzu.
  • Das angegebene Signaturfeld in einem PDF-Dokument signieren.
  • Ein PDF-Dokument zertifizieren

Verschlüsselungs-APIs

Mit Verschlüsselungs-APIs können Sie Dokumente verschlüsseln und entschlüsseln. Wird ein Dokument verschlüsselt, ist sein Inhalt nicht mehr lesbar. Eine autorisierte Person kann das Dokument entschlüsseln, um Zugriff auf den Inhalt zu erhalten. Wenn ein PDF-Dokument mit einem Kennwort verschlüsselt ist, muss der Benutzer das Kennwort zum Öffnen angeben, bevor das Dokument in Adobe Reader oder Adobe Acrobat angezeigt werden kann.

Sie können diese Aufgaben mithilfe der Verschlüsselungs-APIs erledigen:

  • Verschlüsseln eines PDF-Dokuments mit einem Kennwort.
  • Entfernen der kennwortbasierten Verschlüsselung aus einem PDF-Dokument.
  • Abrufen des Sicherheitstyps, der zum Schützen eines PDF-Dokuments verwendet wurde.
  • Gibt den auf ein PDF-Dokument angewendeten Sicherheitstyp zurück.

Sowohl Signature-APIs als auch Verschlüsselungs-APIs sind synchrone APIs.

Dienst „Reader-Erweiterung“

Die Reader Extension Service-Funktion ist im Rahmen des Early Adopter Program verfügbar. Sie können schreiben anaem-forms-ea@adobe.comvon Ihrer offiziellen E-Mail-ID, um dem frühen Adopter-Programm beizutreten und Zugriff auf die Funktion anzufordern.

Der Reader Extensions-Dienst ermöglicht Ihrem Unternehmen die einfache Freigabe interaktiver PDF-Dokumente, indem die Funktionalität von Adobe Reader um zusätzliche Verwendungsrechte erweitert wird. Der Reader Extensions-Dienst funktioniert mit Adobe Reader. Der Dienst fügt einem PDF-Dokument Verwendungsrechte hinzu. Diese Aktion aktiviert Funktionen, die normalerweise nicht verfügbar sind, wenn ein PDF-Dokument mit Adobe Reader geöffnet wird, z. B. das Hinzufügen von Kommentaren zu einem Dokument, das Ausfüllen von Formularen und das Speichern des Dokuments.

Bei PDF-Dokumenten, denen entsprechende Verwendungsrechte hinzugefügt wurden, können Empfängerinnen und Empfänger die folgenden Aktivitäten in Adobe Reader durchführen:

  • Ausfüllen von PDF-Dokumenten und Formularen online oder offline, sodass Empfänger lokale Kopien speichern können, ohne die hinzugefügten Informationen zu verlieren.
  • Speichern Sie PDF-Dokumente auf einer lokalen Festplatte, um das Originaldokument und alle weiteren Kommentare, Daten oder Anhänge beizubehalten.
  • Anhängen von Dateien und Medienclips an PDF-Dokumente.
  • Signieren, Zertifizieren und Authentifizieren von PDF-Dokumenten durch die Anwendung digitaler Signaturen unter Verwendung von PKI-Technologien (PKI), die dem Industriestandard entsprechen.
  • Elektronische Übermittlung ausgefüllter oder mit Anmerkungen versehener PDF-Dokumente.
  • Verwenden Sie PDF-Dokumente und -Formulare als intuitives Entwicklungs-Frontend für interne Datenbanken und Webdienste.
  • Freigeben von PDF-Dokumenten für andere Benutzende, sodass Prüfende mit intuitiven Markup-Werkzeugen Kommentare hinzufügen können Zu diesen Werkzeugen gehören elektronische Haftnotizen, Stempel, Hervorheben und Durchstreichen. Dieselben Funktionen sind in Acrobat verfügbar.
  • Unterstützen der Dekodierung von Barcode-Formularen.

Diese speziellen Verwendungsrechtefunktionen werden automatisch aktiviert, wenn ein PDF-Dokument mit aktivierten Benutzerrechten in Adobe Reader geöffnet wird. Wenn der Benutzer mit einem Dokument mit aktivierten Benutzerrechten fertig ist, sind diese Funktionen in Adobe Reader erneut deaktiviert. Sie bleiben deaktiviert, bis die Benutzenden ein anderes PDF-Dokument mit aktivierten Rechten erhält.

Die verschiedenen Funktionen für Verwendungsrechte mit Reader Extension Services sind:

  • Dekodierung von Barcodes: So dekodieren Sie Barcodes im PDF-Dokument.

  • Kommentare: Zum Offlinekomprimieren des PDF-Dokuments.

  • Kommentare online: Zum Online-Kommentar zum PDF-Dokument.

  • Digitale Signatur: So fügen Sie einem PDF-Dokument digitale Signaturen hinzu.

  • Dynamische Formularfelder: So fügen Sie einem PDF-Dokument Formularfelder hinzu.

  • Dynamische Formularseiten: So fügen Sie Formularseiten zu einem PDF-Dokument hinzu.

  • Eingebettete Dateien: So betten Sie Dateien in ein PDF-Dokument ein.

  • Formular-Datenimport: So importieren Sie Formulardaten in ein PDF-Dokument.

  • Formulardaten exportieren: So importieren Sie Formulardaten in ein PDF-Dokument.

  • Ausfüllen des Formulars: Zum Ausfüllen von Formularfeldern in einem PDF-Dokument.

  • Online Forms: Um über ein PDF-Dokument auf einen Webdienst oder eine Datenbank zuzugreifen.

  • Submit Standalone: Zum Senden von Formulardaten offline von einem PDF-Dokument.

Weitere Funktionen in Reader Extension Services

  • Nachricht: Die Meldung, die in Adobe Acrobat Reader beim Öffnen eines PDF-Dokuments mit einer oder mehreren angewendeten Verwendungsrechten angezeigt wird.
  • Kennwort entsperren: Das zum Öffnen eines verschlüsselten PDF-Dokuments erforderliche Kennwort. Normalerweise ist dies das Kennwort zum Öffnen des Dokuments, aber wenn das PDF-Dokument zusätzlich durch ein Berechtigungskennwort geschützt ist, kann es entweder zum Öffnen verwendet werden.

Die Dokumentation zur API-Referenz enthält detaillierte Informationen zu allen Parametern, Authentifizierungsmethoden und verschiedenen Services, die von APIs bereitgestellt werden. Die Dokumentation zur API-Referenz ist auch im Format .yaml verfügbar. Sie können die .yaml-Datei herunterladen und in Postman hochladen, um die Funktionalität der APIs zu überprüfen.

Typen von Kommunikations-APIs types

Kommunikationen bieten HTTP-APIs für die On-Demand- und Batch-Dokumentgenerierung:

  • Synchrone APIs eignen sich für die Dokumenterstellung auf Anfrage, mit geringer Latenz und mit einzelnen Datensätzen. Diese APIs eignen sich besser für Anwendungen auf Basis einer Benutzeraktion. Zum Beispiel das Generieren eines Dokuments, nachdem ein Benutzer ein Formular ausgefüllt hat.

  • Batch-APIs (asynchrone APIs) eignen sich für Anwendungsfälle für die geplante Erstellung mehrerer Dokumente mit hohem Durchsatz. Diese APIs generieren Dokumente in Stapeln. Beispielsweise werden damit monatliche Telefonrechnungen, Kreditkartenauszüge und Leistungsmitteilungen generiert.

Einstieg

Die Kommunikationsfunktion steht Forms as a Cloud Service-Benutzern als eigenständiges und als Add-on-Modul zur Verfügung. Sie können sich an das Adobe-Vertriebs-Team oder Ihren Adobe-Support-Mitarbeiter wenden, um Zugriff anzufordern. Adobe ermöglicht den Zugriff für Ihre Organisation und stellt der in Ihrer Organisation als Administrator genannten Person die erforderlichen Berechtigungen zur Verfügung. Der Administrator kann den Forms as a Cloud Service-Entwicklern (Benutzern) Ihrer Organisation Zugriff auf die APIs gewähren.

So aktivieren Sie die Kommunikationsfunktion nach der Einarbeitung für Ihre Forms as a Cloud Service-Umgebung:

  1. Melden Sie sich bei Cloud Manager an und öffnen Sie eine AEM Forms as a Cloud Service-Instanz.

  2. Wählen Sie die Option „Programm bearbeiten“, gehen Sie zur Registerkarte „Lösungen und Add-ons“ und wählen Sie Forms – Kommunikation.

    Kommunikation

    Wenn Sie die Option Forms – Digitale Registrierung bereits aktiviert haben, wählen Sie anschließend die Option Forms – Kommunikations-Add-on.

    Add-on

  3. Klicken Sie auf Aktualisieren.

  4. Führen Sie die Build-Pipeline aus. Nachdem die Build-Pipeline erfolgreich ausgeführt wurde, werden die Kommunikations-APIs für Ihre Umgebung aktiviert.

NOTE
Um APIs zur Dokumentbearbeitung zu aktivieren und zu konfigurieren, fügen Sie die folgende Regel zur Dispatcher-Konfiguration hinzu:
# Allow Forms Doc Generation requests
/0062 { /type "allow" /method "POST" /url "/adobe/forms/assembler/*" }

Siehe auch see-also

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