ION Pulse events data (task, alert, notification)

ION Pulse event data is stored in these Data Fabric objects:

  • ION_PulseTaskEvent for task events
  • ION_PulseAlertEvent for alert events
  • ION_PulseNotificationEvent for notification events
  • ION_PulseParameterEvent for parameter events
  • ION_PulseNoteEvent for note events

This table shows ION Pulse events data for tasks:

Required properties: eventTimeStamp, eventType, id

Property Description Type Constraints Required Allowed values
eventTimeStamp Timestamp of the Task event string date-time; maxLength 25 Yes
eventType Task event type string maxLength 25 Yes Created, Assigned, Unassigned, Canceled, Finished, Escalated, Delegated, Redistributed, Updated
id Identifier of the Task integer minimum 0 Yes
priority Priority of the task string maxLength 25 No Low, Medium, High
dueDate The due date of the Task string date-time; maxLength 25 No
source Source of the task creation string maxLength 25 No API, Document, Workflow, Delegation
sourceName Additional info on the source string maxLength 1000 No
sourceMajorVersion Major version on the source of the task creation integer minimum 1 No
sourceMinorVersion Minor version info on the source of the task creation integer minimum 0 No
sourceId Id of the source, for example the workflow instance id integer minimum 0 No
sourceSubId SubId of the source, for example the workflow step id integer minimum 0 No
distributionUsers List of User Identities, comma separated, this item is distributed to string maxLength 4000 No
category Category of this task string maxLength 1000 No
assignee Current assignees User Identifier string maxLength 255 No
escalationType Escalation type or reason string maxLength 25 No NotAssignedInTime, NotFinishedInTime, DueDateReached
escalationLevel Escalation level integer minimum 0 No
removedUsers List of User Identities, comma separated, that were added string maxLength 4000 No
addedUsers List of User Identities, comma separated, that were removed string maxLength 4000 No
finishParameterValue Value of the result of the task string maxLength 4000 No
message Raw unexpanded message template string maxLength 4000 No
actor Who performed the action: identity2 for human actors, application logical ID for BOD actors, service name for system actors string maxLength 255 No
channel How the action was performed, e.g. Pulse UX, ION Desk, Process API, or BOD application name string maxLength 255 No

This table shows ION Pulse events data for alerts:

Required properties: eventTimeStamp, eventType, id

Property Description Type Constraints Required Allowed values
eventTimeStamp Timestamp of the Alert event string date-time; maxLength 25 Yes
eventType Alert event type string maxLength 25 Yes Created, Assigned, Unassigned, Canceled, Finished, Escalated, Delegated, Redistributed, Updated
id Identifier of the Alert integer minimum 0 Yes
dueDate The due date of the Alert string date-time; maxLength 25 No
source Source of the Alert creation string maxLength 25 No API, Document, Monitor, Alarm, Error, Delegation
sourceName Additional info on the source string maxLength 1000 No
sourceMajorVersion Major version on the source of the Alert creation integer minimum 1 No
sourceMinorVersion Minor version info on the source of the Alert creation integer minimum 0 No
distributionUsers List of User Identities, comma separated, this item is distributed to string maxLength 4000 No
category Category of this Alert string maxLength 1000 No
assignee Current assignees User Identifier string maxLength 255 No
escalationType Escalation type or reason string maxLength 25 No NotAssignedInTime, NotFinishedInTime, DueDateReached
escalationLevel Escalation level integer minimum 0 No
removedUsers List of User Identities, comma separated, that were added string maxLength 4000 No
addedUsers List of User Identities, comma separated, that were removed string maxLength 4000 No
message Raw unexpanded message template of the Alert string maxLength 4000 No
alertDetails Serialized JSON of alert detail groups string maxLength 4000 No
actor Who performed the action: identity2 for human actors, application logical ID for BOD actors, service name for system actors string maxLength 255 No
channel How the action was performed, e.g. Pulse UX, ION Desk, Process API, or BOD application name string maxLength 255 No

This table shows ION Pulse events data for notifications:

Required properties: eventTimeStamp, eventType, id

Property Description Type Constraints Required Allowed values
eventTimeStamp Timestamp of the Notification event string date-time; maxLength 25 Yes
eventType Notification event type string maxLength 25 Yes Created, Assigned, Canceled, Finished
id Identifier of the Notification integer minimum 0 Yes
source Source of the Notification creation string maxLength 25 No API, Document, Workflow, Delegation
sourceName Additional info on the source string maxLength 1000 No
sourceMajorVersion Major version on the source of the Notification creation integer minimum 1 No
sourceMinorVersion Minor version info on the source of the Notification creation integer minimum 0 No
sourceId Id of the source, for example the workflow instance id integer No
sourceSubId SubId of the source, for example the workflow step id integer No
distributionUsers List of User Identities, comma separated, this item is distributed to string maxLength 4000 No
category Category of this Notification string maxLength 1000 No
message Raw unexpanded message template of the Notification string maxLength 4000 No
actor Who performed the action: identity2 for human actors, application logical ID for BOD actors, service name for system actors string maxLength 255 No
channel How the action was performed, e.g. Pulse UX, ION Desk, Process API, or BOD application name string maxLength 255 No

This table shows standalone parameter event data for Pulse items. One record is created per parameter and can be joined to the parent Task or Notification event through pulseItemId.

Required properties: eventTimeStamp, eventType, pulseItemId

Property Description Type Constraints Required Allowed values
eventTimeStamp Timestamp of the event that produced this parameter entry string date-time; maxLength 25 Yes
eventType Whether this parameter is from the initial creation snapshot or a subsequent update string Yes Initial, Updated
pulseItemId ID of the parent Pulse item (Task or Notification) that owns this parameter integer minimum 0 Yes
name Internal parameter name string maxLength 255 No
label Display label of the parameter string maxLength 255 No
dataType Data type of the parameter value string No STRING, BOOLEAN
value Serialized parameter value string maxLength 4000 No
actor Who performed the action that triggered this event string maxLength 255 No
channel How the action was performed, e.g. Pulse UX, ION Desk, Process API string maxLength 255 No

This table shows standalone note event data for Pulse items. One record is created per note and can be joined to the parent Task, Alert, or Notification event through pulseItemId.

Required properties: eventTimeStamp, pulseItemId

Property Description Type Constraints Required Allowed values
eventTimeStamp Timestamp of the event that produced this note entry string date-time; maxLength 25 Yes
pulseItemId ID of the parent Pulse item (Task, Alert, or Notification) that owns this note integer minimum 0 Yes
text The note text content string maxLength 4000 No
author User identity of the note author (IFS identity2 format) string maxLength 255 No
dateTime Creation timestamp of the note string date-time; maxLength 25 No
actor Who performed the action that triggered this event string maxLength 255 No
channel How the action was performed, e.g. Pulse UX, ION Desk, Process API string maxLength 255 No