Freigeben über

Aufbau eines Kaizala-Aktionspakets

  • Artikel

Ein Kaizala-Aktionspaket ist eine reguläre ZIP-Datei, die nicht kennwortgeschützte ist und eine maximale Größe von 1 MB aufweist. Die Ressourcen im Paket befinden sich im Stammverzeichnis der ZIP-Datei und nicht in einer Verzeichnisstruktur. Die Ressourcen können auch nicht auf externe Ressourcen verweisen, die nicht im Paket vorhanden sind.

Die grundlegenden Komponenten eines Kaizala-Aktionspakets sind

  • Eine Manifestdatei im JSON-Format
  • Ein App-Modell für Ihre Kaizala-Aktion im JSON-Format
  • Webressourcen, die Ihre Kaizala-Aktion bilden: HTML-, JS-, CSS- und Bilddateien

Paketmanifest

Das Manifest gibt Einstellungen der Kaizala-Aktion an, z. B. die folgenden:

  • Anzeigename, Beschreibung, ID, Version und Aktionssymbol der Aktion.
  • Verschiedene Ansichten, die Ihre Aktion definieren und sie ihren jeweiligen Invokationspunkten zuordnen
    • Eine Erstellungsansicht, wenn eine Aktion über die Palette aufgerufen wird
    • Eine Karte Ansicht, die im Chatbereich angezeigt wird, wenn eine instance der Aktion gesendet wird
    • Eine Antwortansicht für Benutzer, um auf die Kaizala-Aktion zu reagieren
    • Eine Zusammenfassungsansicht zum Anzeigen aggregierter Antworten
  • Bezeichnungen, die für die nativen Ansichten verwendet werden sollen, die Ihre benutzerdefinierten Ansichten kapseln

Weitere Informationen finden Sie unter Paketmanifestschema im JSON-Format.

App-Modell

Das App-Modell gibt die Funktionen der Kaizala-Aktion an, einschließlich:

  • Das Datenmodell für das Form-Objekt, das zur Nutzung der Kaizala-Aggregationsdienste verwendet werden soll
  • Eigenschaften für das Formularobjekt
  • Dem Form-Objekt zugeordnete Einstellungen

Weitere Informationen finden Sie unter App-Modellschema im JSON-Format.

Webressourcen

Wie oben erwähnt, muss das Kaizala-Paket alle Ressourcen enthalten, auf die innerhalb des Pakets verwiesen wird. Dies umfasst alle HTML-, JavaScript-, CSS- und Bildressourcen.

Die grundlegendste Kaizala-Aktion besteht aus drei HTML-Seiten, die angezeigt werden, wenn

  • Die Kaizal-Aktion wird über die Aktionspalette in der Client-App – Erstellungsansicht aufgerufen.
  • Ein Benutzer versucht, auf eine aktion Karte instance zu reagieren, die auf der Chat-Canvas in der Client-App – Antwortansicht veröffentlicht wurde
  • Ein Benutzer versucht, die Zusammenfassung aller Antworten anzuzeigen, die für eine bestimmte Aktion gepostet wurden – Zusammenfassungsansicht

Für die Interaktion mit der Kaizala-Client-App können Sie die von uns bereitgestellteKASClient.js JavaScript-API verwenden.