Contents
Contents

OnAckReceive (OnReceive)

Struggling to bridge the legacy gap? Cedar Hills Group provides specialized PeopleSoft integration consulting to help teams design, build, and optimize their connection strategies.

The OnAckReceive handler executes on the publishing system when an asynchronous acknowledgment or response message is received back from a subscribing node. In the PeopleSoft Service Operation Handler definition page, this handler type is designated by Handler ID RECV and labeled “On Receive”.

It allows the publisher to inspect subscriber acknowledgments, check for remote errors or SOAP faults, track delivery status against custom application staging tables, or trigger automated retries.

Interface Definition

Any application class registered as an OnAckReceive handler must implement the PS_PT:Integration:IReceiver interface:

import PS_PT:Integration:IReceiver;

class MyAckReceiver implements PS_PT:Integration:IReceiver
   method OnAckReceive(&message As Message) Returns integer;
   method OnError(&request As Message);
end-class;

Method Return Codes

The OnAckReceive method must return an integer status constant:

  • %Operation_Done (DONE): Indicates the acknowledgment was successfully processed.
  • %Operation_Error (ERROR): Indicates an error processing the acknowledgment; marks the transaction in error in IB Monitor.
  • %Operation_Retry (RETRY): Available when the service operation delivery mode is Guaranteed. Prompts IB to retry the transaction. If returned when delivery mode is Best Effort, IB changes the status to DONE_NOACK.
  • %Operation_DoneNoAck (DONE_NOACK): Applicable only when delivery mode is Best Effort.

Reading Status on Best Effort Operations

For Best Effort operations, inspect &message.ResponseStatus:

  • If &message.ResponseStatus = %IB_Status_Success, the status is DONE.
  • If not successful, the status is DONE_NOACK, and the underlying issue can be retrieved from &message.IBException.

Delivered Implementation Example

The delivered workflow service operation CREATE_WORKLIST_ITEM registers handler class PT_WF_WORKLIST:OnAckForMarkedWorkedResp. This handler parses incoming SOAP response acknowledgments and records delivery status against PSPT_WSWORKLIST using the publisher’s transaction ID (&message.ParentTransactionId):

import PS_PT:Integration:IReceiver;

class OnAckForMarkedWorkedResp implements PS_PT:Integration:IReceiver
   method OnAckReceive(&message As Message) Returns integer;
   method OnError(&request As Message);
end-class;

method OnAckReceive
   /+ &message as Message +/
   /+ Returns Integer +/
   /+ Extends/implements PS_PT:Integration:IReceiver.OnAckReceive +/
   
   Local integer &retVal = %Operation_Done;
   Local string &respStatus = "4"; /* 4 indicates response was sent successfully */
   
   Local XmlDoc &xmlResp = &message.GetXmlDoc();
   
   If &xmlResp <> Null And &xmlResp.DocumentElement <> Null Then
      Local array of XmlNode &faultNodes = &xmlResp.DocumentElement.GetElementsByTagNameNS("http://schemas.xmlsoap.org/soap/envelope/", "Fault");
      
      If &faultNodes <> Null And &faultNodes.Len > 0 Then
         &retVal = %Operation_Error;
         &respStatus = "3"; /* 3 indicates response error */
      End-If;
   End-If;
   
   /* Update custom worklist transaction tracking table using ParentTransactionId */
   SQLExec("UPDATE PSPT_WSWORKLIST SET PT_WS_RESP_SENT = :1 WHERE IBPUBTRANSACTID = :2", &respStatus, &message.ParentTransactionId);
   
   Return &retVal;
end-method;

method OnError
   /+ &request as Message +/
   /+ Extends/implements PS_PT:Integration:IReceiver.OnError +/
end-method;
psLens Platform
psLens Operations & Intelligence

Look up any record, field, page, or component, audit security, and monitor Integration Broker across every database — in seconds.

  • 30+ object types browsable
  • 16 real-time alert types
  • Read-only by design
  • No App Designer or SQL required
Learn More
psLens Platform
psLens Operations & Intelligence

A web console built for the PeopleSoft community — operational monitoring, security auditing, and metadata browsing in one tool.

  • Sub-second object search
  • Catch stuck IB messages before users do
  • Audit service permissions from one screen
  • Works in any browser
Learn More
psLens Platform
psLens Operations & Intelligence

On-demand security and operational reports for your PeopleSoft environment — no client install required.

  • 14 on-demand reports
  • Markdown export for AI/LLM workflows
  • No shared tenancy
  • Built on 25+ years of PeopleSoft expertise
Learn More
psLens Platform
psLens Operations & Intelligence

Research any PeopleSoft object and monitor system health from a single browser tab — no App Designer, no SQL.

  • 30+ PeopleSoft object types browsable
  • Real-time alerts before users report problems
  • Read-only and secure
  • Private alpha — early access now
Learn More
Author Profile
Chris Malek

Chris Malek is a PeopleTools® Technical Consultant with over two decades of experience. He is available for consulting engagements.

Work with Chris
Subscribe to Updates
SWS Bolt-On
PeopleSoft Simple Web Services

SWS turns SQL into production REST APIs — ready for AI, modern apps, and partner integrations. One install, unlimited potential.

  • Configuration-driven, no coding required
  • JSON, XML, and CSV output
  • Works across all PeopleSoft pillars
  • Built on 25+ years of PeopleSoft expertise
Read More & Purchase
SWS Bolt-On
PeopleSoft Simple Web Services

A powerful PeopleSoft bolt-on that makes REST web services easy. You bring the SQL, SWS handles the rest.

  • Go from idea to production in minutes
  • Zero code migrations after install
  • JSON, XML, and CSV output supported
  • No PeopleCode or Integration Broker expertise required
Read More & Purchase
SWS Bolt-On
PeopleSoft Simple Web Services

Traditional PeopleSoft web services cost $3,600–$13,000 each to develop. SWS deploys production REST APIs in under 5 minutes through configuration alone.

  • No PeopleCode or Integration Broker expertise required
  • Works across Campus Solutions, HCM, and Financials
  • Built-in pagination, caching, and nested data structures
  • Trusted by institutions across higher education and government
Read More & Purchase
SWS Bolt-On
PeopleSoft Simple Web Services

Turn PeopleSoft data into clean REST APIs for AI integrations, modern applications, and vendor data feeds. Configuration-driven — no PeopleCode required.

  • Deploy production APIs in under 5 minutes
  • AI and LLM ready (RAG, chatbots, intelligent search)
  • JSON, XML, and CSV output
  • Zero modifications to delivered PeopleSoft objects
Read More & Purchase