Abilitazione delle notifiche di eventi per IBM OpenPages

L'amministratore di IBM OpenPages potrebbe voler inviare notifiche di eventi in IBM OpenPages ad altri utenti o a destinazioni umane, utilizzando e-mail, SMS o altri canali di consegna supportati. Inoltre, potresti voler inviare queste notifiche di eventi ad altre applicazioni per creare la logica utilizzando la programmazione basata sugli eventi che utilizza i webhook, ad esempio. Ciò è reso possibile dall'integrazione tra IBM OpenPages e IBM Cloud® Event Notifications.

Per inviare informazioni a Event Notifications, devi collegare la tua istanza IBM OpenPages a Event Notifications. Per ulteriori informazioni sull'utilizzo di Event Notifications, vedi Introduzione a Event Notifications.

Come vengono raccolti e inviati gli eventi da IBM OpenPages

Quando si verifica un evento di interesse nella tua istanza IBM OpenPages, IBM OpenPages comunica con un'istanza Event Notifications connessa per inoltrare una notifica a una destinazione supportata.

Attualmente, IBM OpenPages supporta solo destinazioni email.

IBM OpenPages utilizza un modello di eventi semplificato in cui tutte le notifiche di allarme vengono inviate utilizzando un unico tipo di evento (com.ibm.cloud.openpages.event). La differenziazione tra i diversi tipi di notifiche avviene a livello di contenuto all'interno del payload dell'evento, che segue la specifica CloudEvents v1.0.

Eventi per IBM OpenPages

La tabella seguente elenca gli eventi di IBM OpenPages. Tutti gli eventi sono nel sottotipo com.ibm.cloud.openpages.event.

Azioni che generano notifiche di eventi
Tipo di evento	Descrizione
`com.ibm.cloud.openpages.event`	Evento generico IBM OpenPages per tutte le notifiche di avviso

Formato del carico utile dell'evento

IBM OpenPages invia notifiche secondo le specifiche di CloudEvents v1.0. Ogni evento contiene informazioni strutturate sulla notifica, compresi i dettagli del destinatario e il contenuto completo dell'e-mail.

Struttura del carico utile

L'esempio seguente mostra la struttura di un payload di evento inviato da IBM OpenPages a Event Notifications:

{
  "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>", ...]
}

Proprietà payload

La tabella seguente descrive le proprietà del payload di notifica dell'evento:

Proprietà del payload di notifica dell'evento
Proprietà	Immettere	Descrizione
`specversion`	Stringa	CloudEvents versione delle specifiche
`id`	Stringa	Identificatore unico dell'evento: `<CRN><jobId.hashCode()>`
`source`	Stringa	Identificatore della fonte dell'evento (sempre "openpages")
`type`	Stringa	Tipo di evento (sempre " com.ibm.cloud.openpages.event ")
`ibmensourceid`	Stringa	IBM Event Notifications iD sorgente (CRN dell'istanza OpenPages )
`ibmendefaultshort`	Stringa	Messaggio di notifica breve (corpo dell'e-mail troncato)
`ibmendefaultlong`	Stringa	Messaggio di notifica lungo (corpo dell'e-mail troncato)
`message_subject`	Stringa	Riga oggetto email
`message_html_body`	Stringa	Corpo dell'e-mail completo e formattato in HTML
`ibmenmailto`	Array	Matrice JSON di indirizzi e-mail dei destinatari

Limiti di dimensione dei dati

La tabella seguente mostra i limiti di dimensione massima dei campi del payload degli eventi:

Limiti di dimensione dei dati per i campi del payload degli eventi
Campo	Dimensione massima	Troncamento applicato
`ibmendefaultshort`	1000 caratteri	Sì - troncato dal corpo dell'e-mail
`ibmendefaultlong`	3000 caratteri	Sì - troncato dal corpo dell'e-mail
`message_subject`	Nessun limite esplicito	No
`message_html_body`	Nessun limite esplicito	No
`ibmenmailto`	Nessun limite esplicito	No
`specversion`	Corretto: " 1.0 "	N/D
`source`	Corretto: "openpages"	N/D
`type`	Corretto: " com.ibm.cloud.openpages.event "	N/D

Abilitazione delle notifiche

Gli eventi generati da un'istanza del servizio IBM OpenPages possono essere inoltrati a un'istanza del servizio Event Notifications disponibile nello stesso account. Puoi configurare solo un'istanza IBM OpenPages in un'istanza del servizio Event Notifications. Tuttavia, una singola istanza del servizio Event Notifications può avere molte istanze IBM OpenPages che puntano ad essa.

La tabella seguente mostra le regioni dell'istanza di servizio IBM OpenPages e le regioni del servizio Event Notifications a cui possono inoltrare gli eventi:

IBM OpenPages regioni di istanza di servizio e le corrispondenti regioni di servizio Event Notifications
IBM OpenPages regione dell'istanza di servizio	Regione di servizio supportata Event Notifications
AWS Stati Uniti Est ( us-east-1 )	IBM Cloud Dallas ( us-sud )
AWS Europa ( eu-central-1 )	IBM Cloud Francoforte ( eu-de )
IBM Cloud Sydney (au-syd)	IBM Cloud Sydney (au-syd)

Aggiunta di un'istanza del servizio Event Notifications

Prima di poter abilitare le notifiche per IBM OpenPages, aggiungi un'istanza del servizio Event Notifications allo stesso account della tua istanza IBM OpenPages.

Vai alla IU dove gestisci la tua istanza IBM OpenPages. Per ulteriori informazioni, vedi Gestione della tua istanza IBM OpenPages.
Fai clic su Settings.
Nella sezione Event Notifications e fai clic su Connect.
Espandi Prima di iniziare.
Fare clic su Crea nuova istanza.
Nella pagina Event Notifications, selezionare un piano, fare clic sulla casella di spunta per accettare l'accordo di licenza e fare clic su Crea.

Connessione a Event Notifications

Collega l'istanza del servizio IBM OpenPages all'istanza del servizio Event Notifications utilizzando la sezione Settings> Event Notifications nella IU IBM OpenPages per connettere i servizi.

Vai alla IU dove gestisci la tua istanza IBM OpenPages. Per ulteriori informazioni, vedi Gestione della tua istanza IBM OpenPages.
Nella navigazione IBM OpenPages, fai clic su Settings.
Nella sezione Event Notifications, fai clic su Connect.
Nella sezione Event Notification instances, fai clic su Event Notifications service instance e seleziona il Event Notifications che hai creato.
Per confermare la connessione, fare clic su Salva. La sezione Event Notifications mostra la connessione tra l'istanza IBM OpenPages e l'istanza Event Notifications.
Puoi verificare che un argomento e una sottoscrizione vengano creati per la tua istanza IBM OpenPages nelle impostazioni Event Notification facendo clic sul collegamento Review.

La tua istanza IBM OpenPages è pronta per inviare notifiche.

Consegna di notifiche a destinazioni selezionate

Dopo aver abilitato le notifiche per IBM OpenPages, crea argomenti e sottoscrizioni in Event Notifications in modo che gli avvisi possano essere inoltrati e distribuiti.

Le notifiche IBM OpenPages sono in formato HTML e sono destinate al canale di consegna email.

Notifiche email

Puoi utilizzare il servizio emailIBM Cloud come canale di consegna delle notifiche di evento IBM OpenPages. Crea una sottoscrizione Event Notifications tra un argomento esistente e il servizio email IBM Cloud per inoltrare i tuoi avvisi a vari destinatari tramite email. I destinatari vengono automaticamente configurati in base all'attività all'interno di IBM OpenPages che ha causato la creazione della notifica.

Queste e-mail provengono da no-reply@cloud.ibm.com o event-notifications@cloud.ibm.com, ma è possibile specificare il proprio indirizzo di risposta.

Il contenuto dell'e-mail è fornito in formato HTML nel campo message_html_body del payload dell'evento. Per ulteriori informazioni sulla struttura del payload, vedere Formato del payload dell'evento.