Aktivieren von Ereignisbenachrichtigungen für IBM OpenPages

Als Administrator von IBM OpenPages möchten Sie möglicherweise Benachrichtigungen über Ereignisse in IBM OpenPages an andere Benutzer oder menschliche Ziele senden, indem Sie E-Mails, SMS oder andere unterstützte Übermittlungskanäle verwenden. Darüber hinaus können Sie diese Ereignisbenachrichtigungen an andere Anwendungen senden, um eine Logik zu erstellen, indem Sie z. B. eine ereignisgesteuerte Programmierung mit Webhooks verwenden. Ermöglicht wird dies durch die Integration von IBM OpenPages und IBM Cloud® Event Notifications.

Um Informationen an Event Notifications zu senden, müssen Sie Ihre Instanz IBM OpenPages mit Event Notifications verbinden. Weitere Informationen zum Arbeiten mit Event Notifications finden Sie unter Erste Schritte mit Event Notifications.

Wie Ereignisse gesammelt und gesendet werden von IBM OpenPages

Wenn ein interessantes Ereignis in Ihrer IBM OpenPages Instanz stattfindet, kommuniziert IBM OpenPages mit einer verbundenen Event Notifications Instanz, um eine Benachrichtigung an ein unterstütztes Ziel weiterzuleiten.

Derzeit unterstützt IBM OpenPages nur E-Mail-Ziele.

IBM OpenPages verwendet ein vereinfachtes Ereignismodell, bei dem alle Warnmeldungen unter Verwendung eines einzigen Ereignistyps versandt werden (com.ibm.cloud.openpages.event). Die Unterscheidung zwischen den verschiedenen Arten von Benachrichtigungen erfolgt auf der Inhaltsebene innerhalb der Ereignis-Nutzlast, die der Spezifikation CloudEvents v1.0 folgt.

Ereignisse für IBM OpenPages

In der folgenden Tabelle sind die Ereignisse von IBM OpenPages aufgeführt. Alle Ereignisse befinden sich unter dem Subtyp com.ibm.cloud.openpages.event.

Aktionen, die Ereignisbenachrichtigungen erzeugen
Ereignistyp	Beschreibung
`com.ibm.cloud.openpages.event`	Generisches Ereignis IBM OpenPages für alle Alarmbenachrichtigungen

Format der Ereignis-Nutzdaten

IBM OpenPages sendet Benachrichtigungen gemäß der Spezifikation CloudEvents v1.0. Jedes Ereignis enthält strukturierte Informationen über die Benachrichtigung, einschließlich Empfängerdetails und den vollständigen E-Mail-Inhalt.

Struktur der Nutzlast

Das folgende Beispiel zeigt die Struktur eines Ereignis-Payloads, der von IBM OpenPages an Event Notifications gesendet wird:

{
  "specversion": "1.0",
  "id": "crn:v1:staging:public:openpages:global:a/2ac0a95fe03740b6977da3d5333898f3:eb51158d-405e-404c-a1c7-79bf2122dc9c::1967579992",
  "source": "openpages",
  "type": "com.ibm.cloud.openpages.event",
  "ibmensourceid": "crn:v1:staging:public:openpages:global:a/2ac0a95fe03740b6977da3d5333898f3:eb51158d-405e-404c-a1c7-79bf2122dc9c::",
  "ibmendefaultshort": "<truncated body>",
  "ibmendefaultlong": "<truncated body>",
  "message_subject": "<email subject>",
  "message_html_body": "<!DOCTYPE HTML> <html> <head></head> <body style=\"font-family: ibm-plex-sans,HelveticaNeue,Helvetica,Arial,sans-serif; font-size: 14px;\"> <h1 style=\"font-size: 20px; font-weight: 300; padding: 22px 24px;\"><span style=\"font-weight: 600\">IBM OpenPages</span></h1> <hr style=\"margin: 0; border-bottom: 2px solid #0f62fe\" /> <div style=\"padding: 8px 24px 32px; background-color: #f3f3f3;\"> <h2 style=\"font-size: 14px; font-weight: 600; margin: 24px 0 8px;\">Workflow name:</h2> <p style=\"margin: 0\">Requirement Evaluation</p> <h2 style=\"font-size: 14px; font-weight: 600; margin: 24px 0 8px;\">Object type:</h2> <p style=\"margin: 0\">Requirement Evaluation</p> </div> <div style=\"padding: 8px 24px 160px;\"> <h2 style=\"font-size: 14px; font-weight: 600; margin: 24px 0 8px;\"> Number of object (evaluated):</h2> <p style=\"margin: 0\">13</p> <h2 style=\"font-size: 14px; font-weight: 600; margin: 24px 0 8px;\"> Number of workflow started successfully:</h2> <p style=\"margin: 0\">0</p> <h2 style=\"font-size: 14px; font-weight: 600; margin: 24px 0 8px;\"> Number of workflow skipped (applicability, locked, already in workflow):</h2> <p style=\"margin: 0\">13</p> <div style=\"display:none\"> <h2 style=\"font-size: 14px; font-weight: 600; margin: 24px 0 8px;\"> Number of workflow failed to start:</h2> <p style=\"margin: 0\">0</p> <h2 style=\"font-size: 14px; font-weight: 600; margin: 24px 0 8px;\"> Failed workflows (first 100 objects):</h2> <ul>  </ul> </div> </div> <hr style=\"margin: 0; border-bottom: 1px solid #767676\" /> <div style=\"padding: 32px 24px;\">This email was automatically generated by IBM OpenPages.</div> </body> </html>",
  "ibmenmailto": ["<recipient1>", "<recipient2>", ...]
}

Eigenschaften von Nutzdaten

In der folgenden Tabelle werden die Eigenschaften in der Nutzlast der Ereignisbenachrichtigung beschrieben:

Eigenschaften der Nutzlast von Ereignisbenachrichtigungen
Eigenschaft	Typ	Beschreibung
`specversion`	Zeichenfolge	CloudEvents spezifikationsversion
`id`	Zeichenfolge	Eindeutige Kennung des Ereignisses: `<CRN><jobId.hashCode()>`
`source`	Zeichenfolge	Kennung der Ereignisquelle (immer "openpages")
`type`	Zeichenfolge	Ereignistyp (immer " com.ibm.cloud.openpages.event ")
`ibmensourceid`	Zeichenfolge	IBM Event Notifications quell-ID (CRN der Instanz OpenPages )
`ibmendefaultshort`	Zeichenfolge	Kurze Benachrichtigungsnachricht (gekürzter E-Mail-Text)
`ibmendefaultlong`	Zeichenfolge	Lange Benachrichtigungsnachricht (abgeschnittener E-Mail-Text)
`message_subject`	Zeichenfolge	Betreffzeile der E-Mail
`message_html_body`	Zeichenfolge	Vollständiger HTML-formatierter E-Mail-Text
`ibmenmailto`	Array	JSON-Array von Empfänger-E-Mail-Adressen

Grenzen der Datengröße

Die folgende Tabelle zeigt die maximale Größe für Ereignis-Nutzdatenfelder:

Datengrößengrenzen für Ereignis-Nutzdatenfelder
Feld	Maximale Größe	Angewandte Trunkierung
`ibmendefaultshort`	1000 Zeichen	Ja - aus dem E-Mail-Text gekürzt
`ibmendefaultlong`	3000 Zeichen	Ja - aus dem E-Mail-Text gekürzt
`message_subject`	Keine ausdrückliche Begrenzung	Nein
`message_html_body`	Keine ausdrückliche Begrenzung	Nein
`ibmenmailto`	Keine ausdrückliche Begrenzung	Nein
`specversion`	Behoben: " 1.0 "	Nicht zutreffend
`source`	Behoben: "openpages"	Nicht zutreffend
`type`	Behoben: " com.ibm.cloud.openpages.event "	Nicht zutreffend

Benachrichtigungen aktivieren

Ereignisse, die von einer Instanz des IBM OpenPages Dienstes erzeugt werden, können an eine Instanz des Event Notifications Dienstes weitergeleitet werden, die im selben Konto verfügbar ist. Sie können nur eine IBM OpenPages Instanz für eine Event Notifications Service-Instanz konfigurieren. Eine einzelne Event Notifications-Serviceinstanz kann jedoch über viele IBM OpenPages-Instanzen verfügen, die darauf verweisen.

Die folgende Tabelle zeigt die IBM OpenPages Service-Instanz-Regionen und die Event Notifications Service-Regionen, an die sie Ereignisse weiterleiten können:

IBM OpenPages dienstinstanzregionen und ihre entsprechenden Event Notifications Dienstregionen
IBM OpenPages service-Instanz Region	Unterstützte Event Notifications Serviceregion
AWS US-Ost ( us-east-1 )	IBM Cloud Dallas ( us-süd )
AWS Europa ( eu-central-1 )	IBM Cloud Frankfurt ( eu-de )
IBM Cloud Sydney (au-syd)	IBM Cloud Sydney (au-syd)

Hinzufügen einer Event Notifications Dienstinstanz

Bevor Sie Benachrichtigungen für IBM OpenPagesaktivieren, fügen Sie eine Event Notifications-Serviceinstanz zu demselben Konto wie Ihre IBM OpenPages-Instanz hinzu.

Rufen Sie die Benutzerschnittstelle auf, in der Sie Ihre IBM OpenPages-Instanz verwalten. Weitere Informationen finden Sie unter IBM OpenPages-Instanz verwalten.
Klicken Sie auf Einstellungen.
Klicken Sie im Abschnitt Event Notifications auf Verbinden.
Erweitern Bevor Sie beginnen.
Klicken Sie auf Neue Instanz erstellen.
Wählen Sie auf der Seite "Preisgestaltung Event Notifications " einen Plan aus, klicken Sie auf das Kontrollkästchen, um der Lizenzvereinbarung zuzustimmen, und klicken Sie anschließend auf Erstellen.

Verbindung zu Event Notifications herstellen

Verbinden Sie IBM OpenPages mit der Serviceinstanz von Event Notifications über den Abschnitt Einstellungen > Event Notifications in der Benutzerschnittstelle von IBM OpenPages, um eine Verbindung zu den Services herzustellen.

Rufen Sie die Benutzerschnittstelle auf, in der Sie Ihre IBM OpenPages-Instanz verwalten. Weitere Informationen finden Sie unter IBM OpenPages-Instanz verwalten.
Klicken Sie in der Navigation unter IBM OpenPages auf Einstellungen.
Klicken Sie im Abschnitt Event Notifications auf Verbinden.
Klicken Sie im Abschnitt Ereignisbenachrichtigungsinstanzen auf Serviceinstanz fürEvent Notifications und wählen Sie die Event Notifications aus, die Sie erstellt haben.
Um die Verbindung zu bestätigen, klicken Sie auf Speichern. Im Abschnitt Event Notifications wird die Verbindung zwischen der Instanz IBM OpenPages und der Instanz Event Notifications angezeigt.
Sie können überprüfen, dass ein Thema und eine Subskription für Ihre IBM OpenPages-Instanz in den Einstellungen für Ereignisbenachrichtigung erstellt wurden, indem Sie den Link Überprüfen anklicken.

Ihre IBM OpenPages-Instanz ist zum Senden von Benachrichtigungen bereit.

Benachrichtigungen an ausgewählte Ziele zustellen

Nachdem Sie die Benachrichtigungen für IBM OpenPages aktiviert haben, erstellen Sie Themen und Abonnements in Event Notifications, damit die Benachrichtigungen weitergeleitet und zugestellt werden können.

IBM OpenPages-Benachrichtigungen liegen im HTML-Format vor und sind für den E-Mail-Zustellungskanal bestimmt.

E-Mail-Benachrichtigungen

Sie können den E-Mail-Dienst IBM Cloud als Zustellkanal für IBM OpenPages Ereignisbenachrichtigungen verwenden. Erstellen sie eine Event Notifications-Subskription zwischen einem vorhandenen Thema und dem IBM Cloud-E-Mail-Service, um Ihre Alerts per E-Mail an verschiedene Empfänger weiterzuleiten. Empfänger werden automatisch basierend auf der Aktivität in IBM OpenPages festgelegt, die die Erstellung der Benachrichtigung verursacht hat.

Diese E-Mails stammen von no-reply@cloud.ibm.com oder event-notifications@cloud.ibm.com, aber Sie können Ihre eigene Antwortadresse angeben.

Der Inhalt der E-Mail wird im HTML-Format im Feld message_html_body des Ereignis-Payloads bereitgestellt. Weitere Informationen über die Struktur der Nutzlast finden Sie unter Format der Ereignis-Nutzlast.