SOAPMessageV2 – Scoped, Global

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 8 Minuten Lesedauer
  • Die SOAPMessageV2- API bietet Methoden zum Senden einer ausgehenden SOAP-Nachricht mithilfe von JavaScript.

    Verwenden Sie diese API, um die vom SOAP-Anbieter zurückgegebene Antwort zu verwalten.

    Sie können diese API in bereichsbezogenen Anwendungen oder im globalen Bereich verwenden.

    Diese API wird im Namespace sn_ws ausgeführt.

    SOAPMessageV2 – SOAPMessageV2()

    Instantiiert ein leeres SOAPMessageV2-Objekt.

    Wenn Sie ein Objekt verwenden, das auf diese Weise instantiiert wurde, müssen Sie manuell eine SOAP-Aktion und einen Endpunkt angeben.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine
    var sm = new sn_ws.SOAPMessageV2();

    SOAPMessageV2 – SOAPMessageV2(String soapMessage, String soapFunction)

    Instanziiert ein SOAPMessageV2-Objekt aus einem SOAP-Nachrichtendatensatz und einer diesem Datensatz zugeordneten Funktion.

    Werte wie der Endpunkt, die Authentifizierung oder die MID-Server -Einstellungen aus dem SOAP-Nachrichtendatensatz gelten für dieses Objekt.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    soapMessage Zeichenfolge SOAP-Nachrichtendatensatz, den Sie als Basis für dieses Objekt verwenden möchten.
    soapFunction Zeichenfolge SOAP-Funktion, die Sie ausführen möchten. Die verfügbaren SOAP-Funktionen hängen von der vom Webservice-Provider bereitgestellten WSDL ab.
    var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.

    SOAPMessageV2 – execute()

    Sendet die SOAP-Nachricht an den Endpunkt.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    SOAPResponseV2 – Scoped, Global Vom SOAP-Anbieter zurückgegebene Antwort
    var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
    var response = sm.execute(); //Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.

    SOAPMessageV2 – executeAsync()

    Sendet die SOAP-Nachricht an die ECC-Warteschlange.

    SOAP-Nachrichten in der ECC-Warteschlange werden von der Business Rule SOAPClient verarbeitet.

    Standardmäßig wird diese Business Rule nicht asynchron ausgeführt. Um diese Business Rule für die asynchrone Ausführung zu konfigurieren, legen Sie den Wert Wenn auf „Asynchron“ fest, und fügen Sie „current.update()“ am Ende vom Skript hinzu. Die Instanz wartet nicht auf eine Antwort des Webservice-Providers, wenn eine Nachricht über die ECC-Warteschlange gesendet wird.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    SOAPResponseV2 – Scoped, Global Vom SOAP-Anbieter zurückgegebene Antwort
    Hinweis:
    Wenn Sie versuchen, das SOAP-Antwortobjekt zu verwenden, bevor die Antwort verarbeitet wurde, kann dies zu einem Zeitüberschreitungsfehler führen.
    var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
    var response = sm.executeAsync();

    SOAPMessageV2 – getEndpoint()

    Ruft den Endpunkt für die SOAP-Nachricht ab.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    Zeichenfolge URL des SOAP Web Service Providers
    var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
    var endpoint = sm.getEndpoint();

    SOAPMessageV2 – getRequestBody()

    Gibt den Inhalt des SOAP-Nachrichtentexts zurück.

    Hinweis:
    Bevor Sie die Methode „getRequestBody() “ aufrufen, müssen Sie die Methode „execute( ) “ aufrufen, um das Antwortobjekt abzurufen.
    Tabelle : 9. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 10. Ergebnisse
    Typ Beschreibung
    Zeichenfolge SOAP-Nachrichtentext.
    var sm = new sn_ws.SOAPMessageV2("StockQuote","StockQuoteSoap.GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
    var response = sm.execute();
    var requestBody = response.getRequestBody();

    SOAPMessageV2 – getRequestHeader(String headerName)

    Ruft den Wert für einen vom SOAP-Client angegebenen HTTP-Header ab.

    Standardmäßig kann diese Methode den Wert für eine vom System automatisch festgelegte Kopfzeile nicht zurückgeben. Um dieser Methode Zugriff auf alle Kopfzeilen zu gewähren, setzen Sie die Eigenschaft „glide.http.log_debug“ auf „true“.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    headerName Zeichenfolge Anforderungsheader, für den Sie den Wert abrufen möchten.
    Tabelle : 12. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Wert des angegebenen Headers.
    var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
    var header = sm.getRequestHeader("Accept");

    SOAPMessageV2 – getRequestHeaders()

    Ruft HTTP-Header ab, die vom SOAP-Client festgelegt wurden, und die zugehörigen Werte.

    Diese Methode gibt keine vom System automatisch festgelegten Kopfzeilen zurück. Um diese Methode so zu konfigurieren, dass alle Kopfzeilen zurückgegeben werden, setzen Sie die Eigenschaft „glide.http.log_debug“ auf „true“.

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 14. Ergebnisse
    Typ Beschreibung
    Objekt Objekt, das den Namen jedes Headers dem zugehörigen Wert zuordnet.
    var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
    var requestHeaders = sm.getRequestHeaders();

    SOAPMessageV2 – setBasicAuth(String userName, String userPass)

    Legt Header für die Standardauthentifizierung für die SOAP-Nachricht fest.

    Durch das Festlegen der Basic Authenticationkopfzeilen mit dieser Methode werden die im SOAP-Nachrichtendatensatz definierten Basic Authenticationwerte überschrieben.

    Tabelle : 15. Parameter
    Name Typ Beschreibung
    userName Zeichenfolge Bei der Authentifizierung der SOAP-Nachricht zu verwendender Anwendername.
    userPass Zeichenfolge Passwort für den angegebenen Anwender.
    Tabelle : 16. Ergebnisse
    Typ Beschreibung
    void
    var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
    sm.setBasicAuth("username","password");

    SOAPMessageV2 – setEccCorrelator(String correlator)

    Ordnet ausgehende Anforderungen und den daraus resultierenden Antwortdatensatz in der ECC-Warteschlange zu.

    Diese Methode gilt nur für SOAP-Nachrichten, die über einen MID-Server gesendet werden. Der bereitgestellte Korrelator füllt das Feld Agenten-Korrelator im ECC-Warteschlangendatensatz für die Antwort aus. Stellen Sie für jede ausgehende Anforderung einen eindeutigen Korrelator bereit, um die richtigen Ergebnisse in der ECC-Warteschlange mit der Anforderung zu verknüpfen, wenn Sie asynchrone Automatisierung über einen MID-Server entwerfen.

    Tabelle : 17. Parameter
    Name Typ Beschreibung
    Korrelator Zeichenfolge Eindeutiger Bezeichner
    Tabelle : 18. Ergebnisse
    Typ Beschreibung
    void
    var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
    sm.setEccCorrelator("unique_id");

    SOAPMessageV2 – setEccParameter(String name, String value)

    Überschreibt einen Wert aus der Datenbank, indem in die Nutzlast der SOAP-Nachricht geschrieben wird.

    Diese Methode gilt nur für SOAP-Nachrichten, die über MID-Servergesendet werden. Verwenden Sie diese Methode, wenn ein Wert aus der SOAP-Nachricht in der Datenbank ungültig ist, z. B. wenn die Endpunkt-URL länger als die maximale SOAP-Endpunkt-Feldlänge ist.

    Dies sind gültige Werte für den Name-Parameter.
    • source: Die Endpunkt-URL.
    • name: Die auszuführende SOAP-Nachrichtenfunktion.
    Tabelle : 19. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge Name des ECC-Parameters.
    Wert Zeichenfolge Wert, der dem angegebenen ECC-Parameter zugewiesen werden soll.
    Tabelle : 20. Ergebnisse
    Typ Beschreibung
    void
    var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
    sm.setEccParameter("source","http://very.long.endpoint");

    SOAPMessageV2 – setEndpoint(String endpoint)

    Legt den Endpunkt für die SOAP-Nachricht fest.

    Standardmäßig verwendet die SOAP-Nachricht den im SOAP-Nachrichtendatensatz angegebenen Endpunkt. Verwenden Sie diese Methode, um die Standardeinstellung zu überschreiben. Sie müssen diese Methode bei Verwendung des Konstruktors SOAPMessageV2() ohne Parameter aufrufen.

    Tabelle : 21. Parameter
    Name Typ Beschreibung
    endpoint Zeichenfolge URL des SOAP Web Service Providers, mit dem Sie eine Schnittstelle herstellen möchten.
    Tabelle : 22. Ergebnisse
    Typ Beschreibung
    void
    var sm = new sn_ws.SOAPMessageV2();
    sm.setEndpoint("http://web.service.endpoint");

    SOAPMessageV2 – setHttpTimeout(Number timeoutMs)

    Legt fest, wie lange die SOAP-Nachricht auf eine Antwort vom Webservice-Provider wartet, bevor die Anforderung abläuft.

    Tabelle : 23. Parameter
    Name Typ Beschreibung
    timeoutMs Nummer Wartezeit für eine Antwort vom Webdienstanbieter in Millisekunden.
    Tabelle : 24. Ergebnisse
    Typ Beschreibung
    void
    var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
    sm.setHttpTimeout(6000);

    SOAPMessageV2 – setLogLevel(String level)

    Legt die Protokollebene für diese Nachricht und die entsprechende Antwort fest.

    Durch das Festlegen einer Protokollebene mithilfe der SOAPMessageV2-API wird die für den SOAP-Nachrichtendatensatz konfigurierte Protokollebene überschrieben. Diese Protokollebene gilt möglicherweise nicht, wenn die Endpunktdomäne ausgeschlossen ist oder wenn die Eigenschaft glide.outbound_http_log.override auf „wahr“ festgelegt ist. Um Protokolle für ausgehende Webservices anzuzeigen, navigieren Sie zu Systemprotokolle > Ausgehende HTTP-Anforderungen.

    Tabelle : 25. Parameter
    Name Typ Beschreibung
    level Zeichenfolge Die Protokollebene. Gültige Werte sind „basic“, „elevated“ und „all“.
    Tabelle : 26. Ergebnisse
    Typ Beschreibung
    void

    SOAPMessageV2 – setMIDServer(String midServerName)

    Konfiguriert, dass die SOAP-Nachricht über einen MID-Server gesendet wird.

    Standardmäßig verwendet die SOAP-Nachricht den MID-Server, der im SOAP-Nachrichtendatensatz angegeben ist. Verwenden Sie diese Methode, um die Standardeinstellung zu überschreiben.

    Tabelle : 27. Parameter
    Name Typ Beschreibung
    midServerName Zeichenfolge Name von MID-Server, über den Sie die SOAP-Nachricht senden möchten. Ihre Instanz muss einen aktiven MID-Server mit dem angegebenen Namen haben.
    Tabelle : 28. Ergebnisse
    Typ Beschreibung
    void

    SOAPMessageV2 – setMutualAuth(String profileName)

    Legt das Protokollprofil der gegenseitigen Authentifizierung für die SOAP-Nachricht fest.

    Durch das Festlegen eines Protokollprofils mit dieser Methode wird das für den SOAP-Nachrichtendatensatz ausgewählte Protokollprofil überschrieben.

    Tabelle : 29. Parameter
    Name Typ Beschreibung
    profileName Zeichenfolge Name des für die gegenseitige Authentifizierung zu verwendenden Protokollprofils.
    Tabelle : 30. Ergebnisse
    Typ Beschreibung
    void
    var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
    sm.setMutualAuth("auth_profile_name");

    SOAPMessageV2 – setRequestBody(String requestBody)

    Legt den Textinhalt fest, der an den Webdienstanbieter gesendet werden soll.

    Wenn Sie den Textkörperinhalt mit dieser Methode festlegen, werden die Parameter aus dem SOAP-Nachrichtenfunktionsdatensatz nicht durch Variablen im Textkörper ersetzt. Sie müssen alle Werte innerhalb des SOAP-Nachrichtentexts explizit definieren.

    Tabelle : 31. Parameter
    Name Typ Beschreibung
    requestBody Zeichenfolge Textkörper der SOAP-Nachricht.
    Tabelle : 32. Ergebnisse
    Typ Beschreibung
    void
    var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
    var body = "<SOAP message body>";
    sm.setRequestBody(body);

    SOAPMessageV2 – setRequestHeader(String headerName, String headerValue)

    Legt einen HTTP-Header in der SOAP-Nachricht auf den angegebenen Wert fest.

    Tabelle : 33. Parameter
    Name Typ Beschreibung
    headerName Zeichenfolge Name des Headers.
    headerValue Zeichenfolge Wert, der dem angegebenen Header zugewiesen werden soll.
    Tabelle : 34. Ergebnisse
    Typ Beschreibung
    void
    var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
    sm.setRequestHeader("Accept","Application/json");

    SOAPMessageV2 – setSOAPAction(String soapAction)

    Definiert die SOAP-Aktion, die diese SOAP-Nachricht ausführt.

    Die WSDL für Ihren Webservice-Provider listet die SOAP-Aktionen auf, die Sie ausführen können. Sie müssen diese Methode bei Verwendung des Konstruktors SOAPMessageV2() ohne Parameter aufrufen.

    Tabelle : 35. Parameter
    Name Typ Beschreibung
    soapAction Zeichenfolge SOAP-Aktion, die diese SOAP-Nachricht ausführt.
    Tabelle : 36. Ergebnisse
    Typ Beschreibung
    void
    var sm = new sn_ws.SOAPMessageV2();
    sm.setSOAPAction("GetQuote");
    //construct SOAP message by specifying endpoint and auth
    sm.execute();

    SOAPMessageV2 – setStringParameter(String name, String value)

    Legt eine Variable mit dem angegebenen Namen aus dem SOAP-Nachrichtendatensatz auf den angegebenen Wert fest.

    Reservierte XML-Zeichen im Wert werden in die entsprechenden Escape-Zeichen umgewandelt.

    Tabelle : 37. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge Name der SOAP-Nachrichtenvariablen.
    Wert Zeichenfolge Wert, der der angegebenen Variablen zugewiesen werden soll.
    Tabelle : 38. Ergebnisse
    Typ Beschreibung
    void
    var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
    sm.setStringParameter("symbol","NOW");

    SOAPMessageV2 – setStringParameterNoEscape(String name, String value)

    Legt eine Variable mit dem angegebenen Namen aus dem SOAP-Nachrichtendatensatz auf den angegebenen Wert fest.

    Diese Methode ist äquivalent zu setStringParameter, schließt reservierte XML-Zeichen jedoch nicht in Escape-Zeichen ein.

    Tabelle : 39. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge Name der SOAP-Nachrichtenvariablen.
    Wert Zeichenfolge Wert, der der angegebenen Variablen zugewiesen werden soll.
    Tabelle : 40. Ergebnisse
    Typ Beschreibung
    void
    var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
    sm.setStringParameterNoEscape("symbol","NOW");

    SOAPMessageV2 – setWSSecurity(String keystoreId, String keystoreAlias, String keystorePassword, String certificateId)

    Legt Webservice-Sicherheitswerte für die SOAP-Nachricht fest.

    Durch das Festlegen von Sicherheitswerten mit dieser Methode werden Webservice-Sicherheitswerte überschrieben, die für den SOAP-Nachrichtendatensatz definiert sind.

    Tabelle : 41. Parameter
    Name Typ Beschreibung
    keystoreId Zeichenfolge Sys_id des zu verwendenden Java- oder PKCS12-Schlüsselspeichers.
    keystoreAlias Zeichenfolge Alias, der den öffentlichen und privaten Schlüssel identifiziert.
    keystorePassword Zeichenfolge Passwort, das dem Schlüsselspeicher-Datensatz zugewiesen ist.
    certificateId Zeichenfolge Sys_id des vertrauenswürdigen Serverzertifikats.
    Tabelle : 42. Ergebnisse
    Typ Beschreibung
    void
    var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
    sm.setWSSecurity("70d65e074f3812001f6eac118110c71a","Quote keys","UXr82cqX75Z7MaSa+EyjGA==","ba969a074f3812001f6eac118110c76d");