This section discusses a subtle practice that can add immense value for production support and debugging. It adds a metadata node to return data about the context of the request.
Let’s imagine that you have a simple request/reply asynchronous service operation.
EMPLID as a parameterEMPLID.The important part I want to highlight here is the meta element where we return:
dbname - The name of the database this ran in.toolsVer - The tools version that this ran in.psftTransactionId - The PeopleTools Integration Broker GUID that can be used to lookup the request in the IB monitoring tables.currentUser - The OPRID running the PeopleCode.responseDTTM - The date-time this was rundbType - The database type.request* - A singular node or nested node that contains the request parameters. This may not be feasible for large payloads.serverTimeZone - The time zone of the server.I have code running at different clients. When one of them experiences an issue all that information can be extremely useful and expedite troubleshooting. I often get a pasted response or screenshot of the PeopleSoft output from a user mentioning an issue. When these metadata elements are present, I have found it can answer many up front questions that may not have been provided. A user may just say “the web service is not working” and send a screenshot of the response. This response metadata can quickly provide that information up front without any back and forth. Perhaps the person has the wrong URL and is connecting to the wrong system. If you have the database name and the user they are authenticating as you can rule that out straight away. Additionally, if you echo back the request parameters typos and other simple but inevitable errors are quickly spotted.
Here is the HTTP signature of the request.
GET http://test.psft.cedarhillsgroup.com/PSIGW/RESTListeningConnector/PSFT_CS/CHG_PERSON.v1/SF0001 HTTP/1.1
Authorization: Basic .....Here is a sample response. Take a look at lines 13 to 21.
|
|
Here is a basic handler to output the meta-data.
method OnRequest
/+ &msgRequest as Message +/
/+ Returns Message +/
/+ Extends/implements PS_PT:Integration:IRequestHandler.OnRequest +/
Local Message &response;
Local Document &reqDOC = &msgRequest.GetURIDocument();
Local string &EMPLIDParameter = &reqDOC.GetElement("EMPLID").value;
&response = CreateMessage(@("Operation." | &msgRequest.OperationName), %IntBroker_Response);
Local XmlDoc &xmlout;
Local XmlNode &childNode;
&xmlout = CreateXmlDoc("<?xml version='1.0'?><response/>");
&childNode = &xmlout.DocumentElement.AddElement("emplid").AddText(&EMPLIDParameter);
Local Record &recName = CreateRecord(Record.PERSON_NAME);
&recName.EMPLID.Value = &EMPLIDParameter;
&recName.SelectByKey();
&childNode = &xmlout.DocumentElement.AddElement("name").AddText(&recName.NAME_DISPLAY.Value);
Local XmlNode &metaNode;
&metaNode = &xmlout.DocumentElement.AddElement("meta");
&childNode = &metaNode.AddElement("dbname").AddText(%DbName);
&childNode = &metaNode.AddElement("toolsVer").AddText(%ToolsRelease);
&childNode = &metaNode.AddElement("psftTransactionId").AddText(&msgRequest.IBInfo.TransactionID);
&childNode = &metaNode.AddElement("currentUser").AddText(%OperatorId);
&childNode = &metaNode.AddElement("responseDTTM").AddText(DateTimeToHTTP(%Datetime));
&childNode = &metaNode.AddElement("dbType").AddText(%DbType);
childNode = &metaNode.AddElement("serverTimeZone").AddText(%serverTimeZone);
/* echo out inbound parameters for debugging - of time errors are from invalid input */
&childNode = &metaNode.AddElement("requestEmplid").AddText(&EMPLIDParameter);
&response.SetXmlDoc(&xmlout);
Return &response;
end-method;If you spend a few extra minutes adding this or creating an application class to append this information to all responses you will benefit from it.
Chris Malek is a PeopleTools® Technical Consultant with over two decades of experience. He is available for consulting engagements.
Work with ChrisSWS turns SQL into production REST APIs — ready for AI, modern apps, and partner integrations. One install, unlimited potential.
A powerful PeopleSoft bolt-on that makes REST web services easy. You bring the SQL, SWS handles the rest.
Traditional PeopleSoft web services cost $3,600–$13,000 each to develop. SWS deploys production REST APIs in under 5 minutes through configuration alone.
Turn PeopleSoft data into clean REST APIs for AI integrations, modern applications, and vendor data feeds. Configuration-driven — no PeopleCode required.
Look up any record, field, page, or component, audit security, and monitor Integration Broker across every database — in seconds.
A web console built for the PeopleSoft community — operational monitoring, security auditing, and metadata browsing in one tool.
On-demand security and operational reports for your PeopleSoft environment — no client install required.
Research any PeopleSoft object and monitor system health from a single browser tab — no App Designer, no SQL.