Static WSDL script include example
Summarize
Summary of Static WSDL Script Include Example
This example illustrates how to implement a static WSDL-style scripted web service in ServiceNow using a Script Include namedFakeStockValue. It demonstrates processing SOAP requests by parsing incoming XML, identifying the requested function, and returning appropriate XML responses or SOAP faults.
Show less
Key Features
- initialize(requestXML): Converts the incoming SOAP request XML string into an XML Document object for easy navigation and manipulation.
- process(): Extracts the first child element from the SOAP body to determine the requested function. It supports multiple functions by evaluating this element, though the example includes only one function, TradePriceRequest.
- fakeOutTradePriceRequest(funcNode): Implements the sole WSDL function. It retrieves the authenticated user's username and the stock symbol from the SOAP request, then returns a custom XML response message including these details. This method can be extended to perform real business logic such as querying stock prices.
- generateSoapFault(str): Creates and returns a SOAP fault XML element to indicate errors such as unsupported API calls.
Practical Application for ServiceNow Customers
ServiceNow customers can use this pattern to create scripted web services that handle SOAP requests with static WSDLs. By parsing the SOAP XML, identifying the requested operation, and returning structured XML responses or faults, customers can integrate external systems that rely on SOAP-based communication.
This example provides a foundation for building more complex SOAP services by expanding the process() method to support additional functions and enhancing response methods to perform real backend operations.
This example demonstrates the FakeStockValue script include that implements much of the static WSDL behavior.
var FakeStockValue = Class.create();
FakeStockValue.prototype = {
initialize : function(requestXML) {
//Use some backend XML utilities...you could use string tools if you wish
this.xmlutil = Packages.com.glide.util.XMLUtil;
//converting the string to an XML Document
this.fSoapDoc = new XMLDocument(requestXML);
},
process : function() {
var soapBody = this.fSoapDoc.getNode("/Envelope/Body");
//Our WSDL was formatted to have the only first child element be the function
var funcNode = this.xmlutil.getFirstChildElement(soapBody);
var nodeName = this.xmlutil.getNodeNameNS(funcNode);
//If the function for this SOAP request is TradePriceRequest, perform the necessary actions
if (nodeName == "TradePriceRequest") {
return this.fakeOutTradePriceRequest(funcNode);
}
//Couldn't find any supported functions in this SOAP request
return this.generateSoapFault("un-supported API call: " + nodeName);
},
fakeOutTradePriceRequest : function (funcNode) {
//Create the beginnings of our XML response
var r = new XMLDocument("<GetLastTradePriceOutput xmlns='https://www.service-now.com/vws/FakeStockValue'/>");
//Do the necessary actions here...we're going to get the USER ID of the user
//used to make this SOAP call. Then we will return the
//stock symbol they were asking about
var usersysid = gs.getUserID();
var now_GR = new GlideRecord("sys_user");
gr.get(usersysid);
var username = gr.user_name;
var quoteSymbol = this.xmlutil.getText(funcNode);
//Create a "message" element to store our response message
r.createElement("message", username + ", You were looking for a quote on "+quoteSymbol);
return r.getDocumentElement();
},
generateSoapFault : function (str) {
var f = "<SOAP-ENV:Fault>" +
"<faultcode xsi:type='xsd:string'>SOAP-ENV:FakeStockValue</faultcode>" +
"<faultstring xsi:type='xsd:string'>" + str +
"</faultstring>" +
"</SOAP-ENV:Fault>"
var s = new XMLDocument(f);
return s.getDocumentElement();
}
}
initialize function
The initialize function takes the XML request string and converts it to an XML Document object that you can navigate and manipulate using libraries. Alternatively, you can leave the XML request as a string and navigate it using regular expressions.
process function
The process function is called by the scripted web service. This function grabs the first child element in the XML after the body element. The WSDL uses this child element to determine which function to use. In this WSDL there is only one possible function but most WSDLs provide many functions. If more functions were available, there would be more "if" statements that tested the first child element for the various function names.
fakeOutTradePriceRequest function
The fakeOutTradePriceRequest function is the implementation of the only available function in the WSDL. This function looks up the user that the SOAP request authenticated as and retrieves the user_name then returns it to the SOAP client. The fakeOutTradePriceRequest function could be expanded to perform useful activities, such as looking up a stock symbol and returning the last traded price.
generateSoapFault function
The generateSoapFault function returns a SOAP error that can be called if there are problems.