Creating Push Notification Events

Add Events Page

Use the Add Events page to maintain the events associated with an event collection.

Image: Add Events page

This example illustrates the fields and controls on the Add Events page.

Publishing an Event for KeyValue Pairs

This example demonstrates the publishing of the event PROCESSSTATUSCHANGE with the keys PROCESSID and RUNSTATUS and recipient user, VP1.

1. Create the event object.

   Local object &EventObject;
   &EventObject = CreateObject("PSEvent");
   

2. Set values for the keys defined in the event

   &EventObject.SetKeyValuePair("PROCESSID", PSPRCSSTATUS.PROCESSID);
   &EventObject.SetKeyValuePair("STATUS", PSPRCSSTATUS.RUNSTATUS);
   

3. Add a recipient user for the event.

   In this case, the event will be sent only to user VP1 (if VP1 has subscribed to the event).

   &EventObject.AddRecipient("VP1", 1)

   The the parameters for AddRecipient are:

   Field or Control	Definition
   recipient	Specify the recipient using either a user name or a role name.
   recipient type	Use a value of 1 to indicate a user. Use a value of 2 to indicate a role.

4. Publish the event.

   &EventObject.Publish("PROCESSSTATUSCHANGE");

Publishing an Event for a PeopleCode Rowset

If the data type is PeopleCode rowset, you set the values for the fields in the record and add a recipient.

This example illustrates publishing an event for a PeopleCode rowset. In this example, WORKFLOWAPPROVAL is the server event for which name and status fields are defined. All users assigned the role of Workflow Administrator are added as recipients.

1. Create the event object.

   Local object &EventObject;
   &EventObject = CreateObject("PSEvent");
   

2. Set the PeopleCode Rowset for the event.

   Local object &EventObject;
   &rs = CreateRowset(Record.PSPTWKLAPPVL);
   &rs.InsertRow(&i);
   &rs(&i).PSPTWKLAPPVL.NAME.Value = "Test Workflow";
   &rs(&i).PSPTWKLAPPVL.STATUS.Value = 1;
   &EventObject.SetRowsetData(&rs);
   

3. (Optional) Add a recipient role for the event.

   In this case, the event will be sent only to users who have subscribed to the event and belong to the role: Workflow Administrator.

   &EventObject.AddRecipient("Workflow Administrator", 2);

4. Publish the event.

   &ret = &EventObject.publish("WORKFLOWAPPROVAL");

Publishing to the Notification Window

For example, the Notification window endpoint is delivered with a subscription to the PUSHNOTIFICATIONWINDOW event collection as seen previously on the Define Server Event Collections page. Once you have defined and added your custom event to the PUSHNOTIFICATIONWINDOW event collection, you can instantiate and use the PTPN_PUBLISH:PublishToWindow application class to publish your custom event to the Notification window.

The following PeopleCode excerpt illustrates the publication of a notification of type alert:

import PTPN_PUBLISH:PublishToWindow;

/* Creates and publishes an alert notification to the current user. */
Local string &KEY = "Student_ID" | PSU_STUDENT_TBL.STUDENT_ID.Value;
Local string &MSGINFO1;
&MSGINFO1 = "You added a new student named " | PSU_STUDENT_TBL.STUDENT_NAME.Value | " with ID " | PSU_STUDENT_TBL.STUDENT_ID.Value | ".";
Local PTPN_PUBLISH:PublishToWindow &newStdnt_alert = create PTPN_PUBLISH:PublishToWindow("NEW_STUDENT", "Student Data");
&newStdnt_alert.SetCategoryTypeFyi(); /* Type for alerts. */
&newStdnt_alert.AddRecipient(%UserId, 1);
&newStdnt_alert.SetMsgKey(&KEY);
&newStdnt_alert.SetMsgInfo(&MSGINFO1);
&newStdnt_alert.SetMsgStateNew();
&newStdnt_alert.SetPriority("3"); /* Low priority */
&newStdnt_alert.Publish("");

Subscribing to an Event Using JavaScript

Use the Subscribe JavaScript function to subscribe an endpoint to an event:

Subscribe(EVENT_NAME, Callback_Function_Name)

For example:

Subscribe("PRCSEVENTS", ProcessHandler);

The ProcessHandler JavaScript function is then defined in the code:

function ProcessHandler(EventName, EventData)
{	
    if(EventName == "PRCSEVENTS")
// Actual code omitted here ...
}

Subscribing to an Event Collection Using JavaScript

Use the SubscribeCollection JavaScript function to subscribe an endpoint to an event collection:

SubscribeCollection(COLLECTION_NAME, Callback_Function_Name)

For example, the Notification window has been subscribed to the PUSHNOTIFICATIONWINDOW event collection using this JavaScript code:

SubscribeCollection("PUSHNOTIFICATIONWINDOW",UpdatePNUI);

The UpdatePNUI JavaScript function is defined as follows:

function UpdatePNUI(EventName, EventData) {
    try {
        var parentNode = document.getElementById('PT_NOTIFY');
         var parentNode_classic=top.document.getElementById('pthdr2notify_div');
        if (parentNode != null  || parentNode_classic!=null) {
            NewNotification(EventData);
        }
    } catch (e) {}
}

Subscribing to an Event Using PeopleCode

For custom endpoint subscriptions, create an object of the PSEvent class to subscribe to the event. Use the Subscribe method, which requires an application class method be defined as the callback:

APPLICATION_PACKAGE:ApplicationClass:MethodName

For example, the following code creates a subscription for the PRCSEVENTS event:

Local object &EventObject = CreateObject("PSEvent");
Local boolean &SubscriptionHandle = &EventObject.Subscribe("PRCSEVENTS", "PT_CONQRS:CQTEMPTABLES:OnEvent");

Then, implement an application class that defines the callback method for the event subscription:

method OnEvent
   /+ &EventObject as Object +/
   Local object &EventNotifObject = CreateObject("PSEvent");
   /* Actual code omitted here */
end-method;

Subscribing to an Event Using Interwindow Communication (IWC)

Use IWC to subscribe a PeopleSoft page to a published event, where the event model is mapped to page elements, such as fields and grids. Creating a subscription does not require any changes to the page. When the event is published from the server, the page is updated automatically with the event data.

To subscribe to an event through IWC:

1. In the browser, select PeopleTools > Portal > Structure and Content.

2. Navigate through the portal registry folders and select the content reference definition for the component.

3. Click theIWC Message Events link on the Content Ref Administration page.

4. Select the Add a New Value tab, and click Add.

5. Add a new row on the IWC Message Events page, specifying these values:

   • Event Name: Enter the name of a defined event.

   • Message Event Type: Select Server Sub.

6. Click the Map to display the Map Events Data to Page Elements page.

Image: Map Events Data To Page Elements Page

On the Map Events Data To Page Elements page you can map the data of a defined event to a page element.