Contents
Contents

Introduction to Handlers

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

Service Operations in PeopleSoft have a concept of a handler. The handler is application logic that responds to events across the Integration Broker messaging lifecycle. While most integrations rely primarily on OnNotify (asynchronous) or OnRequest (synchronous), PeopleTools provides specialized handler hooks for routing, payload mutation, staging table management, and delivery acknowledgments.

Handler Types and Interfaces

In PeopleTools, the underlying translate table (PSXLATITEM.HANDLERID) and application class records (PSOPRHDLR, PSOPERATIONAC) define these handler types:

Handler ID PeopleTools UI Label Interface Primary Method Purpose
NOTF OnNotify PS_PT:Integration:INotificationHandler OnNotify(&Msg) Main asynchronous subscription logic
RQST OnRequest PS_PT:Integration:IRequestHandler OnRequest(&Msg) Returns Message Main synchronous inbound request/response
RECV OnReceive / OnAckReceive PS_PT:Integration:IReceiver OnAckReceive(&Msg) Returns integer Asynchronous publication acknowledgment handler
ROUT OnRouteSend / OnRouteReceive PS_PT:Integration:IRouter OnRouteSend(&Msg) / OnRouteReceive(&Msg) Dynamic node routing & inbound message filtering
SEND OnRequestSend PS_PT:Integration:ISend OnRequestSend(&Msg) Returns Message Pre-transmission outbound payload/connector mutation
PRNF OnPreNotify PS_PT:Integration:IPrePostNotification OnPreNotify(&Msg) Runs before subscription contracts execute
PTNF OnPostNotify PS_PT:Integration:IPrePostNotification OnPostNotify(&Msg) Runs after all subscription contracts complete
Method OnError Implemented across handler interfaces OnError(&Msg) Custom error formatting and HTTP fault status codes

Note on OnReceive vs OnAckReceive: In the PeopleSoft PIA UI, HANDLERID = 'RECV' is labeled “On Receive”. However, its backing Application Class interface is PS_PT:Integration:IReceiver, and its required execution method is OnAckReceive. They refer to the exact same handler.

Asynchronous Message Lifecycle

  sequenceDiagram
    autonumber
    participant App as PeopleCode / App Engine
    participant PubIB as Publishing Integration Broker
    participant SubIB as Subscribing Integration Broker
    participant DB as Target Database Tables

    Note over App,PubIB: Outbound Publishing Node
    App->>PubIB: %IntBroker.Publish(&MSG)
    PubIB->>PubIB: OnRouteSend (IRouter)<br/>Decides target nodes (ALL, SOME, NONE)
    PubIB->>PubIB: OnRequestSend (ISend)<br/>Mutates outbound payload & headers

    Note over PubIB,SubIB: Network Transmission / Gateway
    PubIB->>SubIB: HTTP / JMS Delivery

    Note over SubIB,DB: Inbound Subscribing Node
    SubIB->>SubIB: OnRouteReceive (IRouter)<br/>Accepts or rejects message locally
    SubIB->>DB: OnPreNotify (IPrePostNotification)<br/>Table truncation / staging prep
    SubIB->>DB: OnNotify (INotificationHandler)<br/>Main subscription logic (CI, SQL, App Class)
    SubIB->>DB: OnPostNotify (IPrePostNotification)<br/>Post-processing cleanup / batch sync

    Note over SubIB,PubIB: Async Acknowledgment (Guaranteed / Best Effort)
    SubIB-->>PubIB: Acknowledgment Status / Response
    PubIB->>PubIB: OnAckReceive (IReceiver)<br/>Tracks parent transaction status & errors

Synchronous Message Lifecycle

  sequenceDiagram
    autonumber
    participant Client as External Client / Caller
    participant Gateway as Integration Gateway
    participant Handler as OnRequest Handler (IRequestHandler)
    participant Error as OnError Handler

    Client->>Gateway: HTTP POST / GET (REST or SOAP)
    Gateway->>Gateway: OnRouteReceive (IRouter)<br/>Pre-execution authorization / filtering
    alt Message Accepted
        Gateway->>Handler: OnRequest(&Msg)
        Handler-->>Gateway: Returns &ResponseMsg
        Gateway-->>Client: HTTP 200 OK with Response Payload
    else Execution Error / Exception
        Handler-->>Error: OnError(&Msg)
        Error-->>Gateway: Custom Error String & Status Code
        Gateway-->>Client: HTTP 4xx/5xx or SOAP Fault
    end
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