Scripted SOAP Web Services

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 2 Minuten Lesedauer

    • Skriptbasierte SOAP-Webservices ermöglichen es einem ServiceNow -Administrator, benutzerdefinierte SOAP-Webservices zu erstellen.

    Sie können Ein- und Ausgabeparameter für den SOAP Web Service definieren und JavaScript zum Ausführen von Vorgängen verwenden. Obwohl diese Funktion sehr leistungsfähig ist, sollten Sie nach Möglichkeit direkte Webservices oder SOAP Web Service-Import Sets verwenden, da sie einfacher zu implementieren und zu warten sind.

    Sicherheit

    Geskriptete SOAP-Webservices haben die gleichen grundlegenden Sicherheitsoptionen wie alle SOAP-Webservices. Weitere Informationen zur Sicherheit von SOAP-Webservices finden Sie unter SOAP Web Services-Sicherheit.

    Wenn auf einem System strikte Sicherheit durchgesetzt wird, muss der mit HTTP authentifizierte Benutzer die Rolle soap_script haben, um den geskripteten Webservice auszuführen.

    WSDL

    Alle ServiceNow -Tabellen und Import Sets generieren dynamisch WSDL-XML-Dokumente (Web Service Definition Language), die das Tabellenschema und die verfügbaren Vorgänge beschreiben.

    WSDL-Compliance erzwingen

    Sie können erzwingen, dass die Antwort Ausgabewerte in derselben Reihenfolge auflistet, die in der WSDL definiert ist.

    Wenn Sie einen geskripteten SOAP Web Service erstellen, basiert die generierte WSDL auf den zugehörigen Listen „Eingabeparameter“ und „Ausgabeparameter“. Die eigentliche SOAP-Antwort, die vom geskripteten Service gesendet wird, wird durch die Befehlszeile Skript bestimmt. Dieses Verhalten kann dazu führen, dass das Skript Ausgabewerte in einer anderen Reihenfolge als in der WSDL definiert zurückgibt.

    Wählen Sie zum Erzwingen der Reihenfolge der Ausgabeparameter, wie in der zugehörigen Liste definiert, die Checkbox WSDL-Compliance. Wenn diese Checkbox aktiviert ist, ordnet der Webservice die vom Skript zurückgegebenen Parameter so an, dass sie der Reihenfolge in der WSDL entsprechen.
    Hinweis:
    Wenn zusätzliche Antwortparameter vom Skript zurückgegeben werden, jedoch nicht in der zugehörigen Liste „Antwortparameter“ definiert sind, werden diese Parameter bei der Antwort von der Antwort ausgeschlossen, wenn WSDL-Compliance ausgewählt ist.
    Tabelle : 1. Zugehörige Liste der Ausgabeparameter
    Parameter Reihenfolge
    Param 1 200
    Param 2 300
    Param 3 100

    Das Folgende ist das Skript, das Werte für die definierten Ausgabeparameter festlegt. Beachten Sie, dass in diesem Beispielskript die Parameter in einer anderen Reihenfolge als in der zugehörigen Liste „Ausgabeparameter“ festgelegt sind. Beachten Sie auch den zusätzlichen Parameter param4, der nicht in der zugehörigen Liste definiert ist.

    Response.param1 = 1;
Response.param4 = 4;
Response.param3 = 3;

    Wenn die Checkbox WSDL-Compliance auf false gesetzt ist, lautet die vom Skript generierte SOAP-Antwort wie folgt:

    <response>
                <param1>1</param1>
                <param4>4</param1>
                <param3>3</param1>
</response>
    Wenn die Checkbox WSDL-Compliance auf true gesetzt ist, lautet die vom Skript generierte SOAP-Antwort wie folgt:
    <response>
                <param3>3</param1>
                <param1>1</param1>
</response>

    Statisches WDSL

    Einige Webservice-Clients erfordern SOAP-Zugriff auf Ihre Instanz über ein bestimmtes WSDL-Format. Dieses erforderliche Format kann vom Standard-WSDL-Format von ServiceNow abweichen. In diesen Fällen können Sie eine statische WSDL erstellen, die dem erforderlichen Format entspricht.

    Globale Variablen

    Um die benutzerdefinierte Verarbeitung eingehender SOAP-Anforderungen zu erleichtern, stehen im Skriptkontext die folgenden globalen Variablen zur Verfügung:
    • soapRequestDocument: Java org.w3c.dom.Document-Objekt, das den eingehenden SOAP-Umschlag darstellt.
    • soapRequestXML: Zeichenfolgenobjekt, das die eingehende SOAP-Umschlag-XML darstellt.
    • request: Javascript-Objekt, das zugeordnete Werte (den Eingabeparameternamen zugeordnet) des eingehenden SOAP-Umschlags enthält.
    • response: Javascript-Objekt, mit dem Sie die Antwortwerte anpassen können. Siehe Antwort anpassen