Skriptschritt

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

    • Fügen Sie benutzerdefiniertes JavaScript hinzu, um es innerhalb einer wiederverwendbaren Aktion auszuführen. Während die meisten zentralen Aktionen und Schritte für gängige Anwendungsfälle geeignet sind, können Sie einen Skriptschritt zum Ausführen von Verhalten erstellen, das von den zentralen Schritten nicht erfüllt wird.

    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.
    Hinweis:
    IntegrationHub Siehe Anforderung IntegrationHub für Informationen zur Nutzung von IntegrationHub und zu Abonnements.

    Felder

    Der Skriptschritt enthält separate Eingabe- und Ausgabevariablen, mit denen Sie JavaScript-Daten den Daten Workflow-Studio zuordnen können. Durch die Definition von Ein- und Ausgangsvariablen innerhalb des Schritts können Sie festlegen, welche Workflow-Studio-Daten in Ihrem Skript zur Verfügung stehen und welche Skriptvariablen für andere Schritte Ihrer Aktion verfügbar sind.

    Feld Beschreibung
    Erforderliche Laufzeit
    Die zur Unterstützung des Skripts erforderliche Laufzeitumgebung. Zur Auswahl stehen:
    • Instanz: Der Aktionsschritt führt das Skript von der Instanz aus. Wählen Sie diese Option, wenn das Skript Zugriff auf die ServiceNow-API oder Instanzdaten benötigt. Dies ist der Standardwert.
    • MID: Der Aktionsschritt führt das Skript vom MID-Server aus. Wählen Sie diese Option aus, wenn das Skript Zugriff auf MID Server-Skriptdateien und APIs benötigt. Bei Auswahl dieser Option wird das Feld MID-Server auswählen mithilfe von angezeigt.
    • Vanilla (Core JavaScript): Der Aktionsschritt führt das Skript entweder von der Instanz oder vom MID-Server aus. Wählen Sie diese Option aus, wenn das Skript nur die Core JavaScript-APIs und nicht die ServiceNow-API oder Instanzdaten benötigt.

    Die von Ihnen ausgewählte Laufzeit bestimmt die JavaScript-Objekte und -Methoden, die in der kontextbezogenen Hilfeangezeigt werden.

    Hinweis:
    Dieses Feld ist nur sichtbar, wenn IntegrationHub aktiviert ist.
    MID-Server mithilfe von auswählen
    Geben Sie den zu verwendenden MID Server-Auswahlprozess an. Zur Auswahl stehen:
    • Beliebiger MID Das System führt den Aktionsschritt mit einem beliebigen verfügbaren MID-Server aus.
    • Verbindungs-Alias verwenden. Das System führt die Aktion mit dem von Ihnen angegebenen Verbindungsalias aus. Bei Auswahl dieser Option wird das Feld Verbindungsalias angezeigt.
    • Inline-Auswahl verwenden. Das System führt die Aktion mit den Verbindungsdetails aus, die Sie in der Aktion angeben. Bei Auswahl dieser Option werden die Felder Host, MID-Anwendung und Funktionen angezeigt.
    Hinweis:
    Dieses Feld ist nur sichtbar, wenn IntegrationHub aktiviert ist und Sie MID aus Erforderliche Laufzeit auswählen.
    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. Es werden nur Aliasse vom Verbindungstyp Basic unterstützt.
    Hinweis:
    Dieses Feld ist nur sichtbar, wenn IntegrationHub aktiviert ist und Sie Verbindungsalias verwenden aus MID-Server auswählen mithilfe von auswählen.
    Host Der vollständig qualifizierte Domänenname des MID Servers, auf dem das System den Aktionsschritt ausführt. Zum Beispiel mid-server.domain.com.
    Hinweis:
    Dieses Feld ist nur sichtbar, wenn IntegrationHub aktiviert ist und Sie Inline-Auswahl verwenden aus MID-Server verwenden mithilfe von auswählen.
    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 MID in der Liste „Erforderliche Laufzeit“ ausgewählt wird und Inline-Auswahl verwenden in der Liste MID-Server auswählen mit ausgewählt wird.
    MID-Cluster Datenpille für den MID-Cluster, den Sie verwenden möchten. Dieses Feld ist verfügbar, wenn MID in der Liste „Erforderliche Laufzeit“ ausgewählt wird und Inline-Auswahl verwenden in der Liste MID-Server auswählen mit ausgewählt wird.
    MID-Anwendung Geben Sie die Anwendung an, die der MID Server unterstützen muss, um ausgewählt zu werden. Das System führt den Aktionsschritt von einem MID-Server aus, der die ausgewählte Anwendung unterstützt. Dieses Feld ist nur sichtbar, wenn IntegrationHub aktiviert ist, MID-Server automatisch auswählen in der Liste MID-Auswahl ausgewählt ist und Sie Inline-Auswahl verwenden unter MID-Server auswählen mithilfevon auswählen.
    Fähigkeiten Fähigkeiten, die die MID-Server unterstützen müssen, um ausgewählt zu werden. Das System führt den Aktionsschritt über einen MID-Server aus, der die ausgewählten Fähigkeiten unterstützt. Dieses Feld ist nur sichtbar, wenn IntegrationHub aktiviert ist, MID-Server automatisch auswählen in der Liste MID-Auswahl ausgewählt ist und Sie Inline-Auswahl verwenden unter MID-Server auswählen mithilfevon auswählen.
    Spezifischer MID-Server Datenpille des erforderlichen MID-Server. Dieses Feld ist nur sichtbar, wenn IntegrationHub aktiviert ist, Spezifischer MID-Server in der Liste MID-Auswahl ausgewählt ist und Sie Inline-Auswahl verwenden unter MID-Serverauswählen mit auswählen.
    Eingabevariablen Name-Wert-Paare, die Daten aus der Aktion darstellen, sodass Sie Aktionseingaben und Daten aus anderen Schritten innerhalb eines Skripts verwenden können.
    Skript
    Skript, das innerhalb der Aktion ausgeführt wird. Verwenden Sie die globalen Objekte Eingänge und Ausgänge, um auf Eingabe- und Ausgabevariablen in Ihrem Skript zuzugreifen. Zum Beispiel: inputs.myVariable.
    Hinweis:
    Die Eingabe- und Ausgabenamen des Skriptschritts dürfen keinen der folgenden reservierten Systemnamen enthalten:
    • sys_id
    • sys_created_by
    • sys_created_on
    • sys_updated_on
    • sys_updated_by
    • sys_mod_count
    Im Allgemeinen sollten Sie keine Variable erstellen, die denselben Namen wie ein Systemfeld hat. Der Skriptschritt kann eine solche Eingabevariable mit einem Feldnamen verwechseln und den falschen Wert verwenden.
    Der Skriptschritt konvertiert Daten, die in globalen Ein- und Ausgabenobjekten gespeichert sind, immer in Zeichenfolgen. Wenn Ihr Skriptschritt mit JSON-Daten arbeiten muss, können Sie das globale Eingabeobjekt verwenden, um die JSON-Daten in eine Zeichenfolge zu konvertieren. Alternativ können Sie eine JavaScript-Variable als Zeichenfolge und nicht als JavaScript-Objekt definieren. Dieses Skript veranschaulicht beispielsweise zwei Möglichkeiten zur Ausgabe von JSON-Daten.
    (function execute(inputs, outputs) {
  outputs.json_object_1 = inputs.json_input;
  var array_of_objs = '[{"name1":"value1"}, {"id":"abcd"}]';
  outputs.json_object_2 = array_of_objs;
})(inputs, outputs);

    Standardmäßig führt Workflow-Studio Skripts in der Instanz aus. Zum Ausführen eines Skripts von einem MID-Server ist ein Abonnement IntegrationHub erforderlich.

    Workflow-Studio führt das Skript in der Domäne aus, von der es ausgelöst oder initiiert wird. Weitere Informationen finden Sie unter Domain Separation und Workflow-Studio.

    Informationen zu verfügbaren Klassen und Methoden finden Sie in der kontextbezogenen Hilfe der JavaScript-API oder im API reference.
    Ausgabevariablen JavaScript-Ausgabe auf Workflow-Studio Data-Pills mappen. Definieren Sie Ausgabevariablen, wenn andere Schritte in der Aktion die Skriptausgabe verwenden sollen.

    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 Fehlerbewertung der Aktion.

    Beispiel

    In diesem Beispiel wird eine JSON-Nutzlast erstellt, die einfach aktualisiert oder geändert und einem nachfolgenden REST-Schritt hinzugefügt werden kann.

    Hinweis:
    REST-Schritt ist im Basissystem nicht verfügbar und erfordert das -Abonnement ServiceNow® IntegrationHub.

    Beispiel Script-Schritt in einer Aktion.

    Indem Sie eine Ausgabevariable erstellen, die die Nutzdaten darstellt, können Sie den Data-Pill [Payload] in den REST-Schritt des Felds Text ziehen.