SOAP-Schritt

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 6 Minuten Lesedauer

    • Ermöglichen Sie Aktionsdesignern, ausgehende SOAP-Web Service-Anfragen an externe Systemen zu senden.

    Hinweis:
    SOAP-Schritt ist im Basissystem nicht verfügbar und erfordert das -Abonnement ServiceNow® IntegrationHub. Nachdem das erforderliche Plugin aktiviert wurde, wird der Schritt unter Integrationen angezeigt.

    Rollen und Verfügbarkeit

    • Verfügbar als Workflow-Studio-Aktionsschritt. Benutzer mit der Rolle „action_designer“ können eine anwenderdefinierte Aktion mit einem oder mehreren Aktionsschritten erstellen.
    • Aktionsdesigner benötigen die Rolle „web_service_admin“, um diese Webservice-Aufgaben auszuführen.
      • WSDL auswählen
      • Neue WSDL laden
      • WS-SecurityPolicy auswählen
    • ServiceNow® MID-Server unterstützt keine WS-Security-Richtlinien.

    Felder

    Feld Beschreibung
    Verbindungsdetails
    Verbindung Die Art der zu verwendenden Verbindung.
    • Verbindung Inline definieren: Definieren Sie die Verbindungsinformationen innerhalb des Aktionsschritts.
    • Verbindungs-Alias verwenden: Definieren Sie die Verbindungsinformationen mithilfe der Tabelle „Verbindungsalias“. Wenn Sie einen Alias verwenden, müssen Sie nicht mehrere Anmeldeinformations- und Verbindungsinformationsprofile konfigurieren, wenn Sie eine Aktion in mehreren Umgebungen verwenden. Ebenso müssen Sie Ihre benutzerdefinierte Aktion nicht aktualisieren, wenn sich die Verbindungsinformationen ändern.

    Weitere Informationen zu Verbindungen und Anmeldeinformationen finden Sie unter Einführung zu Anmeldeinformationen, Verbindungen und Aliassen.
    Verbindungsalias Aliasdatensatz für Verbindungen und Anmeldeinformationen, den das System zum Ausführen des Aktionsschritts verwendet. Benutzer mit der Rolle „flow_designer“ oder „admin“ können einen zugehörigen Verbindungsdatensatz erstellen oder auswählen. Wenn Sie einen Alias verwenden, müssen Sie nicht mehrere Anmeldeinformations- und Verbindungsinformationsprofile konfigurieren, wenn Sie eine Aktion in mehreren Umgebungen verwenden. Ebenso müssen Sie Ihre anwenderdefinierte Aktion nicht aktualisieren, wenn sich die Verbindungsinformationen ändern. Weitere Informationen zu Verbindungen und Anmeldeinformationen finden Sie unter Anmeldeinformationen, Verbindungen und Aliasnamen. Der Wert der Anmeldeinformationen wird als Datenpille Passwort (zweifach verschlüsselt) im Datenbereich angezeigt.
    Hinweis:
    Dieses Feld ist verfügbar, wenn Verbindungsalias verwenden aus der Verbindungsliste ausgewählt wird.
    Anmeldeinformationsalias Anmeldeinformationsalias, den das System zum Ausführen des Aktionsschritts verwendet. Benutzer mit der Rolle „flow_designer“ oder „admin“ können einen zugehörigen Verbindungsdatensatz erstellen oder auswählen. Wenn Sie einen Alias verwenden, müssen Sie nicht mehr mehrere Anmeldeinformationen konfigurieren, wenn Sie eine Aktion in mehreren Umgebungen verwenden. Auch wenn sich die Anmeldeinformationen ändern, müssen Sie Ihre anwenderdefinierte Aktion nicht aktualisieren. Weitere Informationen zu Verbindungen und Anmeldeinformationen finden Sie unter Anmeldeinformationen, Verbindungen und Aliasnamen. Der Wert der Anmeldeinformationen wird als Datenpille Passwort (zweifach verschlüsselt) im Datenbereich angezeigt.
    Hinweis:
    Dieses Feld ist verfügbar, wenn Verbindung inline definieren aus der Verbindungsliste ausgewählt wird.
    MID verwenden Option zur Verwendung eines MID-Server zum Ausführen des SOAP-Schritt. Aktivieren Sie dieses Kontrollkästchen, um die Felder MID-Auswahl,MID-Anwendungund Fähigkeiten anzuzeigen.
    Hinweis:
    Dieses Feld ist verfügbar, wenn Verbindungsalias verwenden aus der Verbindungsliste ausgewählt wird.
    Endpunkt Der URL-Endpunkt für die SOAP-Anforderung. Wenn „Verbindungsalias verwenden“ ausgewählt ist, ist dieses Feld schreibgeschützt und zeigt die dem Alias zugeordnete Endpunkt-URL an. Wenn „Verbindung inline definieren “ ausgewählt ist, geben Sie eine Endpunkt-URL für die Verbindung ein.
    SOAP-Schritt testen Schaltfläche zum Testen des SOAP-Schritts. Wählen Sie zum Testen die Schaltfläche SOAP-Schritt testen aus. Geben Sie die erforderlichen Eingabewerte ein, und wählen Sie die Schaltfläche Run Test (Test ausführen). Nach dem Ausführen des Tests werden im Abschnitt „Testergebnisse“ des Testfensters alle Schrittausgaben oder Fehlermeldungen angezeigt.
    Verbindungszeitüberschreitung Anzahl der Millisekunden, die das System auf eine erfolgreiche Hostverbindung wartet. Wenn der Schritt während dieser Zeit keine erfolgreiche Verbindung herstellt, kommt es zu einer Zeitüberschreitung der Verbindungsanforderung. Wenn „Verbindung inline definieren“ ausgewählt ist, geben Sie einen Timeout-Wert für die Verbindung ein. Lassen Sie dieses Feld leer, um den Standard-Zeitüberschreitungswert für Verbindungen zu verwenden.
    MID-Auswahl Option zum Auswählen des spezifischen MID-Servers oder MID-Clusters.
    • MID-Server automatisch auswählen: Wählt den MID-Server automatisch aus.
    • Spezifischer MID-Server: Verwendet den ausgewählten MID-Server.
    • Spezifischer MID-Cluster: Verwendet den ausgewählten MID-Cluster.
    Dieses Feld ist verfügbar, wenn „Inline definieren“ in der Verbindungsliste ausgewählt wird und „MID verwenden“ aktiviert ist.
    MID-Cluster Datenpille für den MID-Cluster, den Sie verwenden möchten. Dieses Feld ist verfügbar, wenn Inline-Verbindung definieren in der Verbindungsliste ausgewählt ist, MID verwenden aktiviert ist und Spezifischer MID-Cluster in der Liste MID-Auswahl ausgewählt ist.
    Details anfordern
    Umschlag erstellen Die beim Erstellen des SOAP-Umschlags zu verwendende Methode.
    • Aus WSDL: Wählen Sie diese Option, um die Felder WSDL auswählen und Operation anzuzeigen.
    • Manuell: Wählen Sie diese Option aus, um WSDL-Text manuell einzugeben oder einzufügen.
    WSDL auswählen Die zum Erstellen des SOAP-Umschlags zu verwendende WSDL. Wählen Sie einen vorhandenen WSDL-Datensatz aus, oder klicken Sie auf Neue WSDL laden, um eine WSDL-Datei herunterzuladen oder manuell einzugeben. Die ausgewählte WSDL füllt die Werte der Felder Vorgang, SOAP-Aktionund SOAP-Umschlag aus.
    Hinweis:
    Dieses Feld ist verfügbar, wenn Sie Aus WSDL in der Liste Build-Umschlag auswählen.
    Neues WSDL laden Option zum Herunterladen oder manuellen Eingeben einer WSDL-Datei.
    Vorgang Der über die ausgewählte WSDL auszuführende Vorgang. Jede WSDL hat eine eigene Liste von verfügbaren Vorgängen.
    SOAP-Aktion Die URL zum Ausführen der SOAP-Aktion. Wenn „Umschlag erstellen“ auf „ Aus WSDL“ festgelegt ist, ist dieses Feld schreibgeschützt und zeigt die URL zum Ausführen der SOAP-Aktion an. Wenn „Umschlag erstellen“ auf Manuellfestgelegt ist, geben Sie eine URL ein, um die SOAP-Aktion auszuführen.
    Anforderungstyp Format der Anforderung. Verfügbare Optionen:
    • Text: Eine Anforderung in JSON, XML oder einem anderen Textformat.
    • Binär: Eine Anfrage in einem binären Dateiformat.
    SOAP-Umschlag Der an den Endpunkt gesendete XML-Text. Wenn „Umschlag erstellen“ auf Aus WSDLfestgelegt ist, fügt das System die erforderliche XML-Datei für den von Ihnen ausgewählten Vorgang hinzu. Wenn „Umschlag erstellen“ auf Manuellfestgelegt ist, geben Sie den XML-Text ein, den Sie verwenden möchten. Geben Sie die Werte des Datensatzes in die entsprechenden Elemente des SOAP-Umschlags ein. Geben Sie beispielsweise eine Incident-Kurzbeschreibung in das Element <short_description> ein.
    Hinweis:
    Dieses Feld ist verfügbar, wenn der Anforderungstyp auf Textfestgelegt ist.
    Anhang Anhangsdatensatz, der die Anforderung enthält. Sie können diesen Datensatz in einem vorherigen Schritt suchen oder erstellen und als Eingabevariable definieren. Erstellen Sie sie mithilfe der APIs JSONStreamingBuilder und XMLStreamingBuilder im Schritt Skript.
    Hinweis:
    Dieses Feld ist verfügbar, wenn der Anforderungstyp auf Binärfestgelegt ist.
    Umschlag zurücksetzen Option zum Verwerfen aller manuellen Änderungen, die Sie am SOAP-Umschlag vorgenommen haben. Aktivieren Sie dieses Kontrollkästchen, um den SOAP-Umschlag in seinen ursprünglichen Status zurückzusetzen.
    Hinweis:
    Dieses Feld ist verfügbar, wenn Sie Aus WSDL in der Liste Build-Umschlag auswählen.
    Neue WSDL
    Name Der Name des WSDL-Datensatzes, den Sie erstellen möchten.
    Importmethode Die Methode zum Eingeben von WSDL.
    • Von URL herunterladen: Wählen Sie diese Option, um die Felder WSDL-URL, Anwendernameund Passwort anzuzeigen, um die WSDL von einer externen Quelle abzurufen, in der Regel vom Webservice-Provider.
    • WSDL-Inhalt manuell ausfüllen: Wählen Sie diese Option aus, um das Feld WSDL-Inhalt anzuzeigen und WSDL-Text manuell einzugeben oder einzufügen.
    WSDL-URL Die URL des SOAP Web Service.
    Hinweis:
    Dieses Feld ist verfügbar, wenn Sie Von URL herunterladen in der Liste Importmethode auswählen.
    Anwendername Der Benutzername zur Authentifizierung mit dem SOAP Web Service.
    Hinweis:
    Dieses Feld ist verfügbar, wenn Sie Von URL herunterladen in der Liste Importmethode auswählen.
    Passwort Das Passwort zur Authentifizierung mit dem SOAP Web Service. Das System maskiert Passwörter in der Benutzeroberfläche immer und verhindert, dass sie als Nur-Text exportiert werden.
    Hinweis:
    Dieses Feld ist verfügbar, wenn Sie Von URL herunterladen in der Liste Importmethode auswählen.
    WSDL-Inhalt Das XML-Dokument zur Beschreibung des SOAP Web Service und der zugehörigen Vorgänge.
    Hinweis:
    Dieses Feld ist verfügbar, wenn Sie WSDL-Inhalt manuell ausfüllen in der Liste Importmethode auswählen.
    Import Option zum Hinzufügen der SOAP-Webservice-WSDL zur Instanz.
    WS-Sicherheit verwenden
    WS-Sicherheitsrichtlinie aktivieren Option, den SOAP-Webservice auf eine Sicherheitsrichtlinie zu beschränken. Aktivieren Sie dieses Kontrollkästchen, um das Feld Richtlinie anzuzeigen.
    Richtlinie Der Richtliniendatensatz, den Sie zum Einschränken von Webdienstverbindungen verwenden möchten. Wählen Sie einen vorhandenen Richtliniendatensatz aus.
    Wiederholungsrichtlinie
    Wiederholungsrichtlinie aktivieren Option zum Aktivieren der Wiederholungsrichtlinie. Weitere Informationen finden Sie unter Wiederholungsrichtlinie.
    Standardrichtlinie für Alias überschreiben Option zum Überschreiben der Standardwiederholungsrichtlinie. Dieses Kontrollkästchen ist nicht verfügbar, wenn in der Verbindungsliste die Option Verbindung inline definieren ausgewählt ist.
    Wiederholungsrichtlinie Standardwiederholungsrichtlinie, die dem Verbindungsalias zugeordnet ist. Wenn Standardrichtlinie für Alias überschreiben ausgewählt ist, können Sie die Standardwiederholungsrichtlinie überschreiben und eine andere vorhandene Neuversuchsrichtlinie basierend auf Ihrer Anforderung auswählen.
    Erweiterte Optionen
    Header Die Name/Wert-Paare, die als HTTP-Header in die SOAP-Nachricht aufgenommen werden sollen. Klicken Sie auf das Plussymbol Plussymbol, um Header hinzuzufügen. Fügen Sie für jeden HTTP-Header einen Namen und einen Wert hinzu.
    Header > Wenn leer, auslassen Option zum Ausschließen eines Headers, wenn der Wert leer oder NULL ist.
    Hinweis:
    Dieses Kontrollkästchen ist verfügbar, nachdem Sie auf den Abwärtspfeil geklickt haben, um die erweiterten Optionen anzuzeigen.

    Fehlerbewertung der Aktion

    Wenn dieser Schritt fehlschlägt
    Datentyp: Choice

    Option, um den nächsten Schritt auszuführen oder zur Fehlerauswertung zu wechseln. Informationen zur Verwendung des Schrittstatuscodes oder der Nachricht für eine anwenderdefinierte Aktionsfehlerbedingung finden Sie unter Action error evaluation.

    Größenbeschränkungen für SOAP-Antworten

    Das System schränkt die Größe von SOAP-Antworten auf 5 MB ein. Direkte SOAP-Antworten, die diesen Grenzwert überschreiten, erzeugen einen Fehler. Um größere Antworten zu unterstützen, erhöhen Sie die Größenbeschränkung für Antworten mit der Systemeigenschaft glide.pf.soap.response_payload_max_size. Diese Systemeigenschaft unterstützt einen maximalen Wert von 10 MB.