Batch-API

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

Weitere Informationen zur Batch-Generierungs-API

Dieser Artikel enthält Beispiel-Assets zum Generieren von Dokumenten zur interaktiven Kommunikation mithilfe der Batch-API.

Batch-Generierung mithilfe überwachter Ordner

• Importieren Sie die Vorlage zur interaktiven Kommunikation in Ihren AEM Forms-Server.
• Importieren Sie die Konfiguration für überwachte Ordner. Dadurch wird ein Ordner mit dem Namen batchAPI auf dem Laufwerk „C:“ erstellt.

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

1. Öffnen Sie den überwachten Ordner.
2. Wählen Sie „BatchAPIWatchedFolder“ aus und klicken Sie auf „Bearbeiten“.
3. Ändern Sie den Pfad entsprechend Ihrem Betriebssystem.

• Laden Sie die ZIP-Datei herunter und extrahieren Sie deren Inhalt. Die ZIP-Datei enthält den Ordner jsonfile mit der Datei beneficiaries.json. Diese Datei verfügt über die Daten, um drei Dokumente zu generieren.

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

• Nachdem der Ordner der Verarbeitung zugeführt wurde, überprüfen Sie den Ergebnisordner des überwachten Ordners. Es sollten drei PDF-Dateien generiert worden sein.

Batch-Generierung mithilfe von REST-Anfragen

Sie können die Batch-API durch REST-Anfragen aufrufen. Sie können REST-Endpunkte für andere Anwendungen offenlegen, um die API zum Generieren von Dokumenten aufzurufen.
Die bereitgestellten Beispiel-Assets machen den REST-Endpunkt zum Generieren von Dokumenten zur interaktiven Kommunikation verfügbar. 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 zum Element, um den Namen für die interaktive Kommunikation festzulegen

Der folgende Screenshot zeigt die Parameter und deren Werte.

Bereitstellen von Beispiel-Assets auf Ihrem Server

• Importieren Sie ICTemplate mit Package Manager.
• Importieren Sie den benutzerdefinierten Übermittlungs-Handler mit Package Manager.
• Importieren Sie das adaptive Formular mithilfe der Benutzeroberfläche Formulare und Dokumente.
• Implementieren und starten Sie das benutzerdefinierte OSGi-Bundle mithilfe der Felix-Web-Konsole.
• Lösen Sie die Batch-Generierung aus, indem Sie das Formular übermitteln.