PushPulseNotification

You can use the PushPulseNotification function to send real-time notifications through ION to specific users identified by their IFS Person IDs. The function enables customizable parameters for notification context, metadata and real time notifications to the users.

When to use

You can use this function to:

  • Notify specific users when workflows require their approval or action.
  • Alert users about important status changes, such as formula approval or project completion.

When not to use

You cannot use this function when traditional email notifications are more appropriate. Use SendMail or Notify.

Syntax

int PushPulseNotification(string notificationText, string IFSpersonIDs, NameValueCollection notificationParams);

Parameters

Parameter Type Required Description
notificationText string Yes The subject or main text content of the notification.
Note: This is the primary message users can see.
IFSpersonIDs string Yes The semicolon-delimited list of IFS Person IDs (GUIDs) identifying the recipients. Each ID is a unique identifier for a user in the IFS (Infor Financial Suite) system.
notificationParams NameValueCollection Yes The collection of key-value pairs containing additional notification parameters/metadata. For example, Notification ID, Date, custom fields.

Return Value

The application returns a value greater than zero (0) if the operation is successful.

Prerequisites

  • The ION integration must be properly configured.
  • The recipients must have valid IFS Person IDs (GUIDs).
  • The notification is sent as a BOD (Business Object Document).
  • The NameValueCollection type is required for parameters.
  • No additional Optiva permissions are required beyond workflow execution.

Examples

Example 1
Send Pulse Notification with Custom Parameters to Multiple IFS Users via ION. 
using System;
using System.Diagnostics;
using System.Collections.Specialized;

class ActionScript : FcProcFuncSetEventWF
{
    public long wf_start()
    {
        // 1. Notification subject/text
        string notificationSubject = "This is text is a subject for notification";
        
        // 2. IFS Person IDs (semicolon-delimited)
        string IFSpersonIds = "e370750b-9aa4-4933-9f7d-805f74f44081; a2b3c4d5-1234-5678-9abc-def012345678; f9e8d7c6-5432-1098-fedc-ba9876543210";
        
        // 3. Create notification parameters collection
        NameValueCollection paramCollection = new NameValueCollection();
        paramCollection.Add("Notification ID", "0001");
        paramCollection.Add("Notification Date", DateTime.Now.ToString());
        
        // Send the pulse notification
        PushPulseNotification(notificationSubject, IFSpersonIds, paramCollection);
        
        MessageList("Pulse notification BOD sent.");
        
        return 111;
    }
}
Description
This example demonstrates sending a pulse notification BOD to specified IFS Person IDs with custom metadata including notification ID and timestamp.
Related topics