PulseAlert

This table shows the elements in PulseAlert:

Element Note
DocumentID/ID Unique identification of the alert.
CreationDateTime Date when the alert was created in Activities engine.
LastModificationDateTime Date when the alert was last modified.
Status/Code Status of the alert. Values are:
  • NEW - The initial status for a new item.
  • ASSIGNED - Assigned to a specific user.
  • UNASSIGNED - No longer assigned to a specific user.
  • DONE - Completed.
  • CANCELLED - canceled by an administrator (through ION Desk) or by the application (through a ProcessPulseAlert BOD).
IsEscalated This indicator has value true if an alert is escalated and false otherwise. This element is only supported in Sync messages.
EscalationLevel The number of levels in the organizational hierarchy to which the alert is escalated. If the alert is not escalated the value is 0. Otherwise the EscalationLevel is greater than 0.
DueDateTime

Date and time when the alert is due. This element is shown only if a due date was configured in the monitor that created this alert. This element is supported only in the Sync messages.
Description

The description that is displayed to the end user as the summary of the alert. You can use hash tags when searching. For example: 

Late shipment for #sales order 25 of customer #acme

To define a category, use ## at the end of the message.

To include values from the alert details, use square brackets around the parameter labels.

To use the actual characters for square brackets, use an escape character: \[ or \]

Description/@languageID The language code of the Description field.

See the notes in Supported features.

Note Notes that are added by people who handled the alert. Notes can be added, but cannot be modified or removed.
Note/@userID The ID (personId) of the person who added the note.
Note/@author Full name of the person who added the note.

This attribute is required when a Note is added through a ProcessPulseAlert BOD.” / “ProcessPulseTask BOD.” / “ProcessPulseNotification BOD.
Note/@entryDateTime The date/time at which the note was created.
Note/@noteID Identification of the note within the alert.
Source/Type BOD: the alert was created by sending a ProcessPulseAlert BOD.

MONITOR: the alert was created by an event monitor.

Source/Name If Type=BOD: the logical ID of the sender of the ProcessPulseAlert BOD. For example, lid://infor.erp.myerp

If Type is MONITOR: the name of the monitor that created the alert. For example, MyMonitor.

AlertDetail Details of the alert that are displayed to the user. Each AlertDetail group contains document references or trees. For example, an AlertDetail can contain one or more document references followed by a tree containing data for an order and its order lines.
AlertDetail/@sequence The sequence number of the AlertDetail group. This is used for ordering the alert details when displaying them to a user.
AlertDetail/PulseDocumentReference Reference to another business document. The format is the same as the standard DocumentReference, but additionally it has a sequence attribute.

For example: 

<PulseDocumentReference>
     type="SalesOrder" sequence="1">
 	
 <DocumentID>
  <ID accountingEntity="infor"
      location="bvld"
      lid="lid://infor.ln.440">
      ORD0015236</ID>
  <RevisionID>123</RevisionID>
 </DocumentID>
</PulseDocumentReference>

The RevisionID tag is only used if the document referred from this alert contains a RevisionID.

AlertDetail/PulseDocumentReference/@sequence Sequence number to indicate the sequence in which the document references must be displayed to the user when showing the alert details.
AlertDetail/TreeNode Node in the data tree. Alert data is a tree structure to enable multi-level data objects, such as an order header having order lines.
AlertDetail/TreeNode/@sequence If the tree node is a child of another node, the sequence attribute defines the sequence of the child nodes relative to their parent.
AlertDetail/TreeNode/ID Identification for this tree node within the alert.
AlertDetail/TreeNode/ParentID Omitted if the tree node is the top-level node in the tree. Otherwise it contains the ID of the parent node. The parent node must exist within the same AlertDetail. In an AlertDetail, all TreeNodes except one have a ParentID.
AlertDetail/TreeNode/NodeName The name of the node. This name is displayed to the user.

For example: Sales Order.

AlertDetail/TreeNode/TreeNodeParameter A parameter in a tree node, which contains a data element that can be displayed to the user who handles the alert. Alert parameters are always read-only.

For example: 

<TreeNodeParameter sequence="1">
  <Name>OrderNumber</Name> 
  <Value>12345</Value>
  <DataType 
      listID="PulseDatatypes">STRING
  </DataType>
  <Label>Order Number</Label>
</TreeNodeParameter>
AlertDetail/TreeNode/TreeNodeParameter/Name The name that identifies the parameter within the TreeNode. This element is required for each parameter.
AlertDetail/TreeNode/TreeNodeParameter/Value The (serialized) value of the parameter. The formatting depends on the DataType and is the same as the formatting that is normally used in BOD data elements.
AlertDetail/TreeNode/TreeNodeParameter/DataType The data type of the parameter. This element is required for each parameter.

You can use these data types:

  • STRING - a string value that is up to 4000 characters in length.
  • INTEGER - a numeric type that represents a whole number.
  • DECIMAL - a numeric type that has a floating precision. Values may be expressed using the scientific e-notation. For details about the scientific e-notation, see Wikipedia or other resources on the internet.
  • BOOLEAN - represents a true or false value
  • DATETIME - the date part and time part of a date/time stamp separated by "T" and ending with Z (is always UTC).
  • TIME - the time part of a date/time stamp.
  • DATE - the date part of a date/time stamp.
  • DURATION - time interval, starting with P followed by nM (minutes) or nH (hours) or nD (days). For example, P2D3H.
AlertDetail/TreeNode/TreeNodeParameter/Label The label of the parameter that is used when displaying the parameter to a user. This element is required for each parameter.
AssignedPerson The user to which the alert is currently assigned.
AssignedPerson/PersonReference Reference to a person.
AssignedPerson/PersonReference/IDs/ID Identifier of the person. The ID must be a Person ID or Contact ID as defined in IFS (case-sensitive).
AssignedPerson/PersonReference/Name Name of the person.
AssignedPerson/PersonReference/SystemUserIndicator Value is true if the person is a User in IFS.

Value is false if the person is a Contact in IFS.

DistributionPerson Person in the distribution list for the alert. If the alert is not assigned to a person, one of these persons can pick it up.
DistributionPerson/ID Identification of the distribution person within the alert
DistributionPerson/PersonReference Reference to a person.
DistributionPerson/PersonReference/IDs/ID Identifier of the person. The ID must be a Person ID or Contact ID as defined in IFS (case-sensitive). This element is required for each distribution person.
DistributionPerson/PersonReference/Name Name of the person.
DistributionPerson/PersonReference/SystemUserIndicator Value is true if the person is a User in IFS.

Value is false if the person is a Contact in IFS.

This element is required for each distribution person.

DistributionGroup Specify one or more distribution groups to which the alert must be distributed. This element can be used in addition to the DistributionPerson element, or instead of the DistributionPerson element.
DistributionGroup/Name Identifier of the distribution group as defined in Infor Ming.le User Management. The alert is distributed to all users that are members of this group at the time the alert is created.
DistributionGroup/Description Description of the distribution group. This element is optional and is not used to determine the distribution list.
DistributionGroup/Description/@languageID Describe the language code of the description element. This attribute is optional and is not used for the distribution functionality.
Note: The DistributionGroup element is supported only in the ProcessPulseAlert BOD. A SyncPulseAlert BOD can be sent after the creation of the alert. In that case, the distribution list of the alert is described using a DistributionPerson element for each user from the distribution group.