Contents

OnAckReceive (OnReceive)

TODO: This page needs some work.

/*  OnAckReceive will pass in a message to your
derived application class method.
In order to access the data, you must use &message.GetContentString()
which will return the data in string format.

The possible return values of this method are:
DONE -(%Operation_Done)
ERROR -(%Operation_Error)
RETRY -(%Operation_Retry) if the Delivery Mode is Guaranteed. If RETRY is returned
when Delivery Mode is Best Effort, the the status will be changed to DONE_NOACK.
DONE_NOACK -(%Operation_DoneNoAck) Only Applicable if Delivery Mode is Best Effort.
If the Delivery Mode is Guaranteed then status will be changed to DONE.

For the case when Delivery Mode is Best Effort, in order to determine passed in status of transaction check the ResponseStatus property on Message Object.  If ResponseStatus is %IB_Status_Success then the status passed is DONE.  If the Status is not successful then the status passed
is DONE_NOACK, and the actual exception can be determined by the IBException object within the
Message Object.

If an error occurs the OnError method if implemented will be
automatically invoked. The type of exception can be viewed by using the
Message object to retrieve the Exception object (&Message.IBException).
Please see the PeopleCode Language Reference guide for
more information about the Exception class.
*/

interface IReceiver
   method OnAckReceive(&message As Message) Returns integer;
   method OnError(&request As Message);

end-interface;

Author Info
Chris Malek

Chris Malek is a PeopleTools® Technical Consultant with over two decades of experience working on PeopleSoft enterprise software projects. He is available for consulting engagements.

Work with Chris
PeopleSoft REST APIs in Minutes, Not Months
PeopleSoft Simple Web Services (SWS)

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
Looking for pain-free PeopleSoft web services?
PeopleSoft Simple Web Services (SWS)

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
Stop Building PeopleSoft Web Services the Hard Way
PeopleSoft Simple Web Services (SWS)

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
PeopleSoft REST APIs for AI, Modern Apps, and Integrations
PeopleSoft Simple Web Services (SWS)

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