Erstellen Sie einen anwenderdefinierten Befehl in ServiceNow CLI
Verwalten Sie Ihre anwenderdefinierte Anwendung über die Befehlszeile, indem Sie anwenderdefinierte Befehle in erstellen ServiceNow CLI.
Vorbereitungen
Erforderliche Rolle: Administrator
Warum und wann dieser Vorgang ausgeführt wird
Prozedur
-
Machen Sie einen REST-Endpunkt für verfügbar ServiceNow CLIBefehl.
- Navigieren zu Befehlszeilenschnittstelle (CLI) > Endpunkte.
-
Wählen Sie Aus Neu Und füllen Sie das Formular aus.
Feld Beschreibung Ressourcenpfad Erforderlich. Pfad zum Endpunkt in der Instanz, dem ein Befehl zugeordnet werden soll. Kann der Pfad zu einer eingehenden REST-API oder einer geskripteten REST-API sein. Beispiel: api/now/table/{table}/{sysid}. Weitere Informationen finden Sie unter Verfügbare REST-APIs Und Geskriptete REST-APIs .HTTP-Methode Erforderlich. HTTP-Methode, die verwendet werden soll, wenn der Anwender den zugehörigen Befehl ausführt. Anwendung Schreibgeschützter Anwendungsbereich für den Endpunkt.
- Wahlweise:
Erstellen Sie eine Befehlsgruppe.
Alternativ können Sie Ihren neuen Befehl einer vorhandenen Befehlsgruppe hinzufügen.
- Navigieren zu Befehlszeilenschnittstelle (CLI) > Befehlsgruppen.
-
Wählen Sie Aus Neu Und füllen Sie das Formular aus.
Feld Beschreibung Name Erforderlich. Name der Befehlsgruppe. Übergeordnete Gruppe Übergeordnete Befehlsgruppe. Referenzgruppe Befehlsgruppe, auf die verwiesen werden soll. Sie können beispielsweise eine neue Befehlsgruppe als Alias für eine vorhandene Befehlsgruppe erstellen. Wenn der Anwender einen referenzierten Befehl mit der neuen Befehlsgruppe aufruft, wird der ursprüngliche Befehl ausgeführt. Dadurch können Sie eine Befehlsgruppe erstellen, die für Ihre anwenderdefinierte Anwendung spezifisch ist und sowohl neue als auch vorhandene Befehle enthält. Kurzbeschreibung Erforderlich. Kurzbeschreibung für die Befehlsgruppe. Beschreibung Beschreibung der Befehlsgruppe, die als Hilfetext verwendet wird, wenn der Anwender ausführt --helpBefehl in der Befehlsgruppe.Anwendung Schreibgeschützter Anwendungsbereich für die Befehlsgruppe. Aktiv Wenn diese Option ausgewählt ist, ist die Befehlsgruppe aktiv.
-
Erstellen Sie einen Befehl.
- Navigieren zu Befehlszeilenschnittstelle (CLI) > Befehle.
-
Wählen Sie Aus Neu Und füllen Sie das Formular aus.
Feld Beschreibung Name Erforderlich. Name des Befehls. Befehlsgruppe Erforderlich. Befehlsgruppe, zu der der Befehl gehört. Referenzbefehl Zu referenzierender Befehl. Sie können beispielsweise einen neuen Befehl als Alias für einen vorhandenen Befehl erstellen. Wenn der Anwender den neuen Befehl aufruft, wird der ursprüngliche Befehl ausgeführt. Dadurch können Sie einen für Ihre anwenderdefinierte Anwendung spezifischen Befehl erstellen, der vorhandene Funktionen ausführt. Hinweis:Ein Befehl kann nicht auf einen Befehl verweisen, der auf einen anderen Befehl verweist, oder auf einen untergeordneten Befehl, einen Vorgängerbefehl oder einen Rückrufbefehl verweisen.API-Endpunkt Erforderlich. API-Aufruf, der ausgeführt werden soll, wenn der Anwender den Befehl ausführt. Kurzbeschreibung Erforderlich. Kurzbeschreibung des Befehls. Anwendung Schreibgeschützter Anwendungsbereich für den Befehl. Aktiv Wenn diese Option ausgewählt ist, ist der Befehl aktiv. Ist Rückrufbefehl Bei „wahr“ wird der Befehl als Rückrufbefehl festgelegt. Wählen Sie diese Option aus, um den Befehl im CLI-Client auszublenden und zu verhindern, dass Anwender ihn über die Befehlszeile aufrufen. Verwenden Sie dieses Feld mit Rückruf Abschnitt eines primären Befehls. Der Rückrufbefehl wird ausgeführt, wenn der primäre Befehl abgeschlossen ist.
Hilfetext Beschreibung Beschreibung des Befehls, der als Hilfetext verwendet wird, wenn der Anwender ausführt --helpBefehl.Beispiele Beispiele für den Befehl, der als Hilfetext verwendet wird, wenn der Anwender ausführt --helpBefehl.Ausdrücke Erfolgsausdruck Ausdruck, der verwendet wird, um die Antwort vom Server auszuwerten und zu bestimmen, ob der Befehl erfolgreich war. Beispiel: Ergebnis.Code = 1.Fehlerausdruck Ausdruck, der verwendet wird, um die Antwort vom Server auszuwerten und zu bestimmen, ob der Befehl fehlgeschlagen ist. Nachrichten Erfolgsmeldung Nachricht, die auf dem CLI-Client angezeigt wird, wenn der Befehl erfolgreich ist. Fortschrittsmeldung Nachricht, die auf dem CLI-Client angezeigt wird, wenn der Befehl ausgeführt wird. Fehlermeldung Nachricht, die auf dem CLI-Client angezeigt wird, wenn der Befehl fehlschlägt. Rückruf Rückrufausdruck Ausdruck, der verwendet wird, um zu bestimmen, ob der Rückrufbefehl ausgeführt werden soll. Sie können beispielsweise einen Ausdruck schreiben, der einen Prozess mit langer Ausführungszeit überprüft. Wenn der Ausdruck ein bestimmtes Ergebnis erzeugt, wird der Rückruf ausgeführt. Rückrufbefehl Befehl, der ausgeführt werden soll, wenn Rückrufausdruck Ist zufrieden. Muss ein Befehl mit sein Ist Rückrufbefehl Feld ausgewählt. Rückrufintervall Das Intervall zwischen den Ausführungen des Rückrufbefehls. Einheit: Millisekunden
Standard: 1.000
Max. Wiederholungen Maximale Anzahl der Ausführungen des Rückrufbefehls. Standard: 10
-
Erstellen Sie in den zugehörigen Listen Befehlsargumente alle Befehlsargumente, die für den Befehl erforderlich sind.
Erstellen Sie ein Befehlsargument, damit Anwender beim Ausführen eines Befehls Optionen festlegen können.
Feld Beschreibung Name Erforderlich. Name des Befehlsarguments, z. B. Daten.Kurzer Name Kurzname des Befehlsarguments, z. B. d.Datentyp Erforderlich. Typ der für das Befehlsargument erwarteten Daten. Verfügbare Optionen: - Zeichenfolge: Ermöglicht Anwendern die Eingabe einer Zeichenfolge als Eingabe.
- Ganzzahl: Ermöglicht Anwendern die Eingabe einer Zahl als Eingabe.
- Boolescher Wert: Ermöglicht Anwendern die Eingabe
WahrOderFalschAls Eingabe. - Dateieingabe: Ermöglicht Anwendern das Hochladen einer Datei als Eingabe. Ordnen Sie dieses Argument einem Textkörper zu Parametertyp In der zugehörigen Liste API-Endpunktargumente im nächsten Schritt. Anwender können nur-Text, YAML, JSON oder einen anderen Dateityp übergeben, der von der REST-API akzeptiert wird. Wenn der Anwender eine YAML-Datei übermittelt, konvertiert der CLI-Client standardmäßig in eine Datei im JSON-Format. Verwenden Sie Vorverarbeitung überspringen Feld zum Deaktivieren dieses Verhaltens.
- Passwort: Ermöglicht Anwendern die sichere Eingabe eines Passworts als Eingabe.
Hinweis:Für Dateitypen „Dateieingabe“ beträgt die Dateigrößenbeschränkung standardmäßig 10 MB. Sie ändern diesen Grenzwert jedoch mit glide.rest.scripted.max_inbound_content_length_mbSystemeigenschaft.Vorverarbeitung überspringen Legen Sie diese Kennzeichnung fest, um zu verhindern, dass der CLI-Client YAML-Dateien in das JSON-Format konvertiert, bevor sie in der Anforderung gesendet werden. Wann Datentyp Ist auf festgelegt Dateieingabe Und der Anwender übermittelt eine YAML-Datei. Der CLI-Client konvertiert die Datei in JSON, bevor der Befehl standardmäßig ausgeführt wird. Hinweis:Gilt nur, wenn Datentyp Ist auf festgelegt Dateieingabe .Standardwert Standardwert, der verwendet werden soll, wenn der Anwender keinen Wert übergibt. Kurzbeschreibung Erforderlich. Kurzbeschreibung des Befehlsarguments. Wird als Hilfetext verwendet, wenn der Anwender ausführt --helpBefehl.Anwendung Schreibgeschützter Anwendungsbereich für das Argument. Befehl Erforderlich. Befehl, für den das Argument gilt. Obligatorisch Wenn diese Option ausgewählt ist, muss der Anwender beim Ausführen des zugehörigen Befehls einen Wert für das Argument angeben. Aufforderung Aufforderung, Informationen vom Anwender anzufordern. Die CLI fordert Informationen auf, wenn der Anwender kein erforderliches Argument in einen Befehl einschließt. Sichtbarkeitsausdruck Ausdruck, der verwendet wird, um zu bestimmen, ob die CLI zur Eingabe des Arguments auffordern soll. Wird normalerweise verwendet, um ein Argument basierend auf dem Wert anzuzeigen, der für ein vorheriges Argument angegeben wurde. Reihenfolge Reihenfolge, in der das Argument angefordert werden soll. -
Erstellen Sie in den zugehörigen Listen API-Endpunktargumente alle API-Endpunktargumente, die für den Befehl erforderlich sind.
Ordnen Sie Befehlsargumente aus der zugehörigen Liste „Befehlsargumente“ Parametern in Ihrem REST-Endpunkt zu.
Feld Beschreibung Name Erforderlich. Name des Arguments. Wert Erforderlich. Der Wert aus dem Befehl, den Sie an den REST-Endpunkt übergeben möchten. Sie können einen statischen Wert oder einen Ausdruck wie übergeben {Flags.table}. Verwenden SieKennzeichnungenGlobale Variable für den Zugriff auf die Befehlsargumente.Parametertyp Erforderlich. Der Typ des Parameters im REST-Endpunkt, den Sie übergeben möchten Wert Bis. Beispiel: Wenn Sie auswählen Textkörper , Die CLI übergibt den Wert von Wert Feld zum REST-Endpunkt-Textkörper. Verfügbare Optionen: - Textkörper
- Header
- Pfad
- Abfrage
Anwendung Schreibgeschützter Anwendungsbereich für das Argument. Befehl Erforderlich. Befehl, für den das Argument gilt. -
Erstellen Sie in den zugehörigen Listen für Rückgabewerte alle Rückgabewerte, die für den Befehl erforderlich sind.
Erstellen Sie Rückgabewerte, um nur bestimmte Schlüssel aus der Antwort zurückzugeben.
Feld Beschreibung Pfadausdruck Erforderlich. Ausdruck, der den Pfad zum Schlüssel darstellt, den Sie zurückgeben möchten. Alias Variablenname, dem der Rückgabewert zugewiesen werden soll. Anwendung Schreibgeschützter Anwendungsbereich für den Befehl. Befehl Erforderlich. Befehl, für den der Rückgabewert gilt.