PulseNotification

This table shows the elements in PulseNotification:

Element Note
DocumentID/ID Unique identification of the notification.
CreationDateTime Date when the notification was created in Activities engine.
LastModificationDateTime Date when the notification was last modified.
Status/Code Status of the notification. Values are:
  • ASSIGNED - The initial status for a new item. The notification is assigned to each of the distribution persons.
  • DONE - Completed.
  • CANCELLED - canceled by an administrator (through ION) or by the application (through a ProcessPulseNotification BOD).
Description The description that is displayed to the end user as the summary of the notification. You can use hash tags when searching. For example: 
#Requisition 25 is approved

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. S

See the notes in Supported features.

Note Propagated notes that are added by users who worked on Tasks from the same workflow. You cannot add or remove notes from a Notification. This field is only applicable for Sync.PulseNotification for notifications that are created by Workflow.
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 notification.
Source/Type BOD: the notification was created by sending a ProcessPulseNotification BOD.

WORKFLOW: the notification was created by a workflow.

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

If Type is WORKFLOW: the name of the workflow definition that created the notification. For example, MyWorkflow.

Parameter Data of the notification that is displayed to the user. Notification parameters are always read-only.

For example: 

<Parameter sequence="1">
  <Name>OrderNumber</Name> 
  <Value>12345</Value>
  <DataType 
      listID="PulseDatatypes">STRING</DataType>
  <Label>Order Number</Label>
</Parameter>
Parameter/@sequence The sequence number of the parameter. This is used for ordering the parameters when displaying them to a user. It is only allowed to use this attribute if there are no elements of type TreeParameter in the document.
Parameter/Sequence You must specify this element in combination with TreeParameter/Sequence. This element is used to determine the order in which Parameters and TreeParameters are displayed to the user.
Parameter/Name The name that identifies the parameter within the notification. This element is required for each parameter.
Parameter/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.
Parameter/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.
Parameter/Label The label of the parameter that is used when displaying the parameter to a user. This element is required for each parameter.
Parameter/Label /@languageID The language code of the Label field.

See the notes in Supported features.

TreeParameter The TreeParameter consists of:
  • A TreeDefinition. The TreeDefinition defines a complex data structure.
  • The TreeNodes. The TreeNodes specify the data value for the structure. TreeNodes are specified after the TreeDefinition.

The TreeDefinition and the TreeNodes must be consistent.

TreeParameter/Sequence Indicates the sorting sequence in which TreeParameters and Parameters must be displayed to the user in the notification. If one Sequence is specified, all the Parameters must specify a Sequence element.
TreeParameter/TreeDefinition Definition for the data structure contained in the TreeParameter. This definition includes several unique TreeNodes with their ID, ParentID, NodeName, and TreeNodeParameters.
TreeParameter/TreeDefinition/TreeNode A node in a tree using a parent relationship and containing the definition of the properties required for the node.
TreeParameter/TreeDefinition/TreeNode/Sequence Indicates the sequence of the node within the TreeParameter. The Sequence must be specified for all the TreeNodes if this element is specified for the root TreeNode. The ordering of the TreeNodes within the structure is based on the specified Sequence. If the Sequence is not specified for the root TreeNode, the structure is sorted based on the XML.
TreeParameter/TreeDefinition/TreeNode/ID The unique identifier for this tree node within this definition of a TreeParameter.
TreeParameter/TreeDefinition/TreeNode/ParentID The ID of the node that is the parent of this node within the tree. The root TreeNode does not have a ParentID.
TreeParameter/TreeDefinition/TreeNode/NodeName This is the unique identification of a tree node.
TreeParameter/TreeDefinition/TreeNode/Label The label of the parameter that is used when displaying the parameter to a user. You must specify at least one label. You can specify several labels, each with a different languageID for translated labels.
TreeParameter/TreeDefinition/TreeNode/Label /@languageID The language code of the Label field.

See the notes in Supported features.

TreeParameter/TreeDefinition/TreeNode /TreeNodeParameter Defines a property within a TreeNode level. TreeNodeParameters are optional. Values for these properties are specified in the TreeNodes that follow the TreeDefinition.
TreeParameter/TreeDefinition/TreeNode /TreeNodeParameter/Sequence Indicates the sequence of the TreeNodeParameter within the TreeNode.
TreeParameter/TreeDefinition/TreeNode /TreeNodeParameter/Name The name of the TreeNodeParameter is used to identify this property in the tree node instances to specify its value.
TreeParameter/TreeDefinition/TreeNode/TreeNodeParameter/DataType The data type of the associated value. 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.
TreeParameter/TreeDefinition/TreeNode /TreeNodeParameter/Label The label of the node that is used when it is displayed to a user. You must specify at least one label. You can specify several labels, each with a different languageID for translated labels.
TreeParameter/TreeDefinition/TreeNode /TreeNodeParameter/Label/@languageID The language code of the Label field.

See the notes in Supported features.

TreeParameter/TreeNode A node in a tree using a parent relationship and containing properties required for the node and their values.
TreeParameter/TreeNode/ID The unique identifier for this tree node within this TreeParameter.
TreeParameter/TreeNode/ParentID The ID of the node that is the parent of this node within the tree definition.
TreeParameter/TreeNode/NodeName The unique identification of a tree node. This name must match a node name from the TreeDefinition. Several TreeNode instances with the same NodeName can exist.
TreeParameter/TreeNode/TreeNodeParameter List of properties for this TreeNode.
TreeParameter/TreeNode/TreeNodeParameter/Name The property name that must match with a property specified for this TreeNode in the TreeDefinition.
TreeParameter/TreeNode/TreeNodeParameter/Value The value for this tree node property. The value must be consistent with the data type that is defined in the tree definition.
AssignedPerson The user to which the notification is currently assigned. When a user closes the notification, the user is removed from the list of assigned persons.
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 notification. The notification is send to each of the distribution persons in parallel.
DistributionPerson/ID Identification of the distribution person within the notification.
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 notification 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 notification is distributed to all users that are members of this group at the time the notification 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 ProcessPulseNotification BOD. A SyncPulseNotification BOD can be sent after the creation of the notification. In that case, the distribution list of the notification is described using a DistributionPerson element for each user from the distribution group.