Stapel-API

Sie können die Stapel-API verwenden, um mehrere interaktive Mitteilungen aus einer Vorlage zu erstellen. Die Vorlage ist eine interaktive Kommunikation ohne Daten. Die Stapel-API kombiniert Daten mit einer Vorlage, um eine interaktive Kommunikation zu erzeugen. Die API ist bei der Massenproduktion interaktiver Kommunikation nützlich. Zum Beispiel Telefonrechnungen, Kreditkartenauszüge für mehrere Kunden.

Weitere Informationen zur API zur Stapelgenerierung

Dieser Artikel enthält Beispiel-Assets zum Generieren von interaktiven Kommunikations-Dokumenten mit der Stapel-API.

Stapelgenerierung mit überwachtem Ordner

  • Importieren Sie die Vorlage Interaktive Kommunikation in Ihren AEM Forms-Server.
  • Importieren Sie die Konfiguration des überwachten Ordners a1/>. Dadurch wird ein Ordner mit dem Namen batchAPI im Laufwerk C erstellt.

Wenn Sie AEM Forms unter einem Nicht-Windows-Betriebssystem ausführen, führen Sie die folgenden 3 Schritte aus:

  1. Überwachten Ordner öffnen
  2. Wählen Sie BatchAPIWatchedFolder und klicken Sie auf Bearbeiten.
  3. Ändern Sie den Pfad entsprechend Ihrem Betriebssystem.

path

  • Laden Sie den Inhalt der ZIP-Datei herunter und extrahieren Sie ihn. Die ZIP-Datei enthält den Ordner jsonfile, der die Datei beneficiaries.json enthält. Diese Datei enthält die Daten, um 3 Dokumente zu generieren.

  • Legen Sie den Ordner jsonfile in den Eingabeordner Ihres überwachten Ordners ab.

  • Nachdem der Ordner zur Verarbeitung aufgenommen wurde, überprüfen Sie den Ergebnisordner Ihres überwachten Ordners. Es sollten 3 generierte PDF-Dateien angezeigt werden.

Stapelgenerierung mit REST-Anforderungen

Sie können die Stapel-API über REST-Anforderungen aufrufen. Sie können REST-Endpunkte für andere Anwendungen bereitstellen, um die API zum Generieren von Dokumenten aufzurufen.
Die bereitgestellten Beispiel-Assets stellen den REST-Endpunkt zum Generieren von Dokumenten der interaktiven Kommunikation dar. Das Servlet akzeptiert die folgenden Parameter:

  • fileName - Speicherort der Datendatei im Dateisystem.
  • templatePath - IC-Vorlagenpfad
  • saveLocation - Speicherort zum Speichern der generierten Dokumente im Dateisystem
  • channelType - Print, Web oder beides
  • recordId - JSON-Pfad zu einem Element zum Festlegen des Namens einer interaktiven Kommunikation

Der folgende Screenshot zeigt die Parameter und ihre Werte
Beispielanforderung

Beispielelemente auf dem Server bereitstellen

Auf dieser Seite