Skip to content

/AWS1/CL_UNTNOTIFEVENTSCHEMA

A NotificationEvent is a notification-focused representation of an event. They contain semantic information used by Channels to create end-user notifications.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_schemaversion TYPE /AWS1/UNTSCHEMAVERSION /AWS1/UNTSCHEMAVERSION

The schema version of the Notification Event.

iv_id TYPE /AWS1/UNTNOTIFICATIONEVENTID /AWS1/UNTNOTIFICATIONEVENTID

The unique identifier for a NotificationEvent.

io_sourceeventmetadata TYPE REF TO /AWS1/CL_UNTSOURCEEVENTMET /AWS1/CL_UNTSOURCEEVENTMET

The source event metadata.

io_messagecomponents TYPE REF TO /AWS1/CL_UNTMESSAGECOMPONENTS /AWS1/CL_UNTMESSAGECOMPONENTS

Describes the components of a notification message.

iv_notificationtype TYPE /AWS1/UNTNOTIFICATIONTYPE /AWS1/UNTNOTIFICATIONTYPE

The type of event causing the notification.

  • Values:

    • ALERT

      • A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

    • WARNING

      • A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

    • ANNOUNCEMENT

      • A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

    • INFORMATIONAL

      • A notification about informational messages. For example, recommendations, service announcements, or reminders.

it_textparts TYPE /AWS1/CL_UNTTEXTPARTVALUE=>TT_TEXTPARTS TT_TEXTPARTS

A list of text values.

it_media TYPE /AWS1/CL_UNTMEDIAELEMENT=>TT_MEDIA TT_MEDIA

A list of media elements.

Optional arguments:

iv_sourceeventdetailurl TYPE /AWS1/UNTURL /AWS1/UNTURL

The source event URL.

iv_sourceeventdeturldsptext TYPE /AWS1/UNTSTRING /AWS1/UNTSTRING

The detailed URL for the source event.

iv_eventstatus TYPE /AWS1/UNTEVENTSTATUS /AWS1/UNTEVENTSTATUS

The assessed nature of the event.

  • Values:

    • HEALTHY

      • All EventRules are ACTIVE and any call can be run.

    • UNHEALTHY

      • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

iv_aggregationeventtype TYPE /AWS1/UNTAGGREGATIONEVENTTYPE /AWS1/UNTAGGREGATIONEVENTTYPE

The aggregation type of the NotificationConfiguration.

  • Values:

    • AGGREGATE

      • The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.

    • CHILD

      • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

    • NONE

      • The notification isn't aggregated.

iv_aggregatenotifeventarn TYPE /AWS1/UNTNOTIFICATIONEVENTARN /AWS1/UNTNOTIFICATIONEVENTARN

If the value of aggregationEventType is not NONE, this is the Amazon Resource Event (ARN) of the parent aggregate notification.

This is omitted if notification isn't aggregated.

io_aggregationsummary TYPE REF TO /AWS1/CL_UNTAGGREGATIONSUMMARY /AWS1/CL_UNTAGGREGATIONSUMMARY

Provides additional information about how multiple notifications are grouped.

iv_starttime TYPE /AWS1/UNTTIMESTAMP /AWS1/UNTTIMESTAMP

The notification event start time.

iv_endtime TYPE /AWS1/UNTTIMESTAMP /AWS1/UNTTIMESTAMP

The end time of the event.

iv_organizationalunitid TYPE /AWS1/UNTORGANIZATIONALUNITID /AWS1/UNTORGANIZATIONALUNITID

The unique identifier of the organizational unit associated with the notification event.

Queryable Attributes

schemaVersion

The schema version of the Notification Event.

Accessible with the following methods

Method Description
GET_SCHEMAVERSION() Getter for SCHEMAVERSION, with configurable default
ASK_SCHEMAVERSION() Getter for SCHEMAVERSION w/ exceptions if field has no value
HAS_SCHEMAVERSION() Determine if SCHEMAVERSION has a value

id

The unique identifier for a NotificationEvent.

Accessible with the following methods

Method Description
GET_ID() Getter for ID, with configurable default
ASK_ID() Getter for ID w/ exceptions if field has no value
HAS_ID() Determine if ID has a value

sourceEventMetadata

The source event metadata.

Accessible with the following methods

Method Description
GET_SOURCEEVENTMETADATA() Getter for SOURCEEVENTMETADATA

messageComponents

Describes the components of a notification message.

Accessible with the following methods

Method Description
GET_MESSAGECOMPONENTS() Getter for MESSAGECOMPONENTS

sourceEventDetailUrl

The source event URL.

Accessible with the following methods

Method Description
GET_SOURCEEVENTDETAILURL() Getter for SOURCEEVENTDETAILURL, with configurable default
ASK_SOURCEEVENTDETAILURL() Getter for SOURCEEVENTDETAILURL w/ exceptions if field has n
HAS_SOURCEEVENTDETAILURL() Determine if SOURCEEVENTDETAILURL has a value

sourceEventDetailUrlDisplayText

The detailed URL for the source event.

Accessible with the following methods

Method Description
GET_SOURCEEVENTDETURLDSPTEXT() Getter for SOURCEEVENTDETAILURLDSPTEXT, with configurable de
ASK_SOURCEEVENTDETURLDSPTEXT() Getter for SOURCEEVENTDETAILURLDSPTEXT w/ exceptions if fiel
HAS_SOURCEEVENTDETURLDSPTEXT() Determine if SOURCEEVENTDETAILURLDSPTEXT has a value

notificationType

The type of event causing the notification.

  • Values:

    • ALERT

      • A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

    • WARNING

      • A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

    • ANNOUNCEMENT

      • A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

    • INFORMATIONAL

      • A notification about informational messages. For example, recommendations, service announcements, or reminders.

Accessible with the following methods

Method Description
GET_NOTIFICATIONTYPE() Getter for NOTIFICATIONTYPE, with configurable default
ASK_NOTIFICATIONTYPE() Getter for NOTIFICATIONTYPE w/ exceptions if field has no va
HAS_NOTIFICATIONTYPE() Determine if NOTIFICATIONTYPE has a value

eventStatus

The assessed nature of the event.

  • Values:

    • HEALTHY

      • All EventRules are ACTIVE and any call can be run.

    • UNHEALTHY

      • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

Accessible with the following methods

Method Description
GET_EVENTSTATUS() Getter for EVENTSTATUS, with configurable default
ASK_EVENTSTATUS() Getter for EVENTSTATUS w/ exceptions if field has no value
HAS_EVENTSTATUS() Determine if EVENTSTATUS has a value

aggregationEventType

The aggregation type of the NotificationConfiguration.

  • Values:

    • AGGREGATE

      • The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.

    • CHILD

      • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

    • NONE

      • The notification isn't aggregated.

Accessible with the following methods

Method Description
GET_AGGREGATIONEVENTTYPE() Getter for AGGREGATIONEVENTTYPE, with configurable default
ASK_AGGREGATIONEVENTTYPE() Getter for AGGREGATIONEVENTTYPE w/ exceptions if field has n
HAS_AGGREGATIONEVENTTYPE() Determine if AGGREGATIONEVENTTYPE has a value

aggregateNotificationEventArn

If the value of aggregationEventType is not NONE, this is the Amazon Resource Event (ARN) of the parent aggregate notification.

This is omitted if notification isn't aggregated.

Accessible with the following methods

Method Description
GET_AGGREGATENOTIFEVENTARN() Getter for AGGREGATENOTIFEVENTARN, with configurable default
ASK_AGGREGATENOTIFEVENTARN() Getter for AGGREGATENOTIFEVENTARN w/ exceptions if field has
HAS_AGGREGATENOTIFEVENTARN() Determine if AGGREGATENOTIFEVENTARN has a value

aggregationSummary

Provides additional information about how multiple notifications are grouped.

Accessible with the following methods

Method Description
GET_AGGREGATIONSUMMARY() Getter for AGGREGATIONSUMMARY

startTime

The notification event start time.

Accessible with the following methods

Method Description
GET_STARTTIME() Getter for STARTTIME, with configurable default
ASK_STARTTIME() Getter for STARTTIME w/ exceptions if field has no value
HAS_STARTTIME() Determine if STARTTIME has a value

endTime

The end time of the event.

Accessible with the following methods

Method Description
GET_ENDTIME() Getter for ENDTIME, with configurable default
ASK_ENDTIME() Getter for ENDTIME w/ exceptions if field has no value
HAS_ENDTIME() Determine if ENDTIME has a value

textParts

A list of text values.

Accessible with the following methods

Method Description
GET_TEXTPARTS() Getter for TEXTPARTS, with configurable default
ASK_TEXTPARTS() Getter for TEXTPARTS w/ exceptions if field has no value
HAS_TEXTPARTS() Determine if TEXTPARTS has a value

media

A list of media elements.

Accessible with the following methods

Method Description
GET_MEDIA() Getter for MEDIA, with configurable default
ASK_MEDIA() Getter for MEDIA w/ exceptions if field has no value
HAS_MEDIA() Determine if MEDIA has a value

organizationalUnitId

The unique identifier of the organizational unit associated with the notification event.

Accessible with the following methods

Method Description
GET_ORGANIZATIONALUNITID() Getter for ORGANIZATIONALUNITID, with configurable default
ASK_ORGANIZATIONALUNITID() Getter for ORGANIZATIONALUNITID w/ exceptions if field has n
HAS_ORGANIZATIONALUNITID() Determine if ORGANIZATIONALUNITID has a value