Static WSDL script include example

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Static WSDL Script Include Example API Implementation

    This content provides a practical guide for ServiceNow customers on creating a scripted SOAP web service using a static WSDL. It features an example implementation of a script include calledFakeStockValue, which demonstrates handling SOAP requests and generating appropriate responses.

    Show full answer Show less

    Key Features

    • Initialize Function: Converts the incoming XML request string into an XML Document object for easy navigation and manipulation.
    • Process Function: Identifies the requested function from the SOAP body and directs the flow to the appropriate handler, accommodating multiple potential functions.
    • FakeOutTradePriceRequest Function: Implements the core functionality by retrieving the username of the requester and returning a response based on the requested stock symbol.
    • GenerateSoapFault Function: Produces a structured SOAP fault response for unsupported API calls or errors in processing requests.

    Key Outcomes

    By utilizing this example, ServiceNow customers can effectively implement a scripted SOAP web service that responds to specific SOAP requests. This enables them to automate interactions, manage stock quotes, and ensure proper error handling, enhancing the overall functionality of their integrations.

    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.