Erstellen Sie einen benutzerdefinierten Befehl in ServiceNow CLI
Verwalten Sie Ihre benutzerdefinierte Anwendung über die Befehlszeile, indem Sie benutzerdefinierte Befehle im ServiceNow CLIerstellen.
Vorbereitungen
Erforderliche Rolle: admin
Warum und wann dieser Vorgang ausgeführt wird
Prozedur
-
Machen Sie einen REST-Endpunkt für einen ServiceNow CLI -Befehl verfügbar.
- Navigieren zu Befehlszeilenschnittstelle (CLI) > Endpunkte.
-
Wählen Sie Neu, und füllen Sie das Formular aus.
Feld Beschreibung Ressourcenpfad Erforderlich. Pfad zum Endpunkt in der Instanz, der ein Befehl zugeordnet werden soll. Dies 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 Scripted REST APIs.HTTP-Methode Erforderlich. Zu verwendende HTTP-Methode, wenn der Benutzer den zugeordneten 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 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 Benutzer einen referenzierten Befehl mit der neuen Befehlsgruppe aufruft, wird der ursprüngliche Befehl ausgeführt. Auf diese Weise können Sie eine für Ihre benutzerdefinierte Anwendung spezifische Befehlsgruppe erstellen, die 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 Benutzer den Befehl „ --help“für die Befehlsgruppe ausführt.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 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 Benutzer den neuen Befehl aufruft, wird der ursprüngliche Befehl ausgeführt. Auf diese Weise können Sie einen für Ihre benutzerdefinierte 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 Benutzer 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 „true“ wird der Befehl als Rückrufbefehl angegeben. Wählen Sie diese Option aus, um den Befehl auf dem CLI-Client auszublenden und zu verhindern, dass Benutzer ihn über die Befehlszeile aufrufen können. Verwenden Sie dieses Feld mit dem Abschnitt „ Callback “ 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 Benutzer den Befehl „--help“ ausführt.Beispiele Beispiele für den Befehl, der als Hilfetext verwendet wird, wenn der Benutzer den Befehl „--help“ ausführt.Ausdrücke Erfolgsausdruck Ausdruck, der verwendet wird, um die Antwort des Servers auszuwerten und festzustellen, ob der Befehl erfolgreich war. Beispiel: result.code = 1.Fehlerausdruck Ausdruck, der verwendet wird, um die Antwort vom Server auszuwerten und festzustellen, ob der Befehl fehlgeschlagen ist. Nachrichten Erfolgsmeldung Meldung, die auf dem CLI-Client angezeigt wird, wenn der Befehl erfolgreich ist. Fortschrittsmeldung Meldung, die auf dem CLI-Client angezeigt wird, wenn der Befehl ausgeführt wird. Fehlermeldung Meldung, 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 liefert, wird der Rückruf ausgeführt. Rückrufbefehl Befehl, der ausgeführt werden soll, wenn der Rückrufausdruck erfüllt ist. Muss ein Befehl sein, bei dem das Feld Ist Rückrufbefehl ausgewählt ist. 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 die für den Befehl erforderlichen Befehlsargumente.
Erstellen Sie ein Befehlsargument, damit Benutzer beim Ausführen eines Befehls Optionen festlegen können.
Feld Beschreibung Name Erforderlich. Name des Befehlsarguments, z. B. data.Kurzer Name Kurzname des Befehlsarguments, z. B. d.Datentyp Erforderlich. Typ der Daten, die für das Befehlsargument erwartet werden. Verfügbare Optionen: - Zeichenfolge: Ermöglicht Benutzern die Eingabe einer Zeichenfolge als Eingabe.
- Ganzzahl: Ermöglicht Benutzern die Eingabe einer Zahl als Eingabe.
- Boolean: Ermöglicht Benutzern die Eingabe von „
true“ oder„false“als Eingabe. - Dateieingabe: Ermöglicht Benutzern das Hochladen einer Datei als Eingabe. Ordnen Sie dieses Argument im nächsten Schritt einem Textparametertyp in der zugehörigen Liste API-Endpunktargumente zu. Benutzer können Nur-Text, YAML, JSON oder einen anderen Dateityp übergeben, der von der REST-API akzeptiert wird. Wenn der Benutzer eine YAML-Datei übermittelt, konvertiert der CLI-Client die Datei standardmäßig in das JSON-Format. Verwenden Sie das Feld Vorverarbeitung überspringen, um dieses Verhalten zu deaktivieren.
- Passwort: Ermöglicht Benutzern die sichere Eingabe eines Passworts als Eingabe.
Hinweis:Für Dateieingabe-Datentypen beträgt die Dateigrößenbegrenzung standardmäßig 10 MB. Sie können diesen Grenzwert jedoch mit der Systemeigenschaft glide.rest.scripted.max_inbound_content_length_mb ändern.Vorverarbeitung überspringen Legen Sie diese Kennzeichnung fest, um zu verhindern, dass der CLI-Client YAML-Dateien in das JSON-Format konvertiert, bevor er sie in der Anforderung sendet. Wenn der Datentyp auf Dateieingabe festgelegt ist und der Benutzer eine YAML- Datei übermittelt, konvertiert der CLI-Client die Datei standardmäßig in ein JSON-Objekt, bevor der Befehl ausgeführt wird. Hinweis:Gilt nur, wenn Datentyp auf Dateieingabefestgelegtist.Standardwert Standardwert, der verwendet werden soll, wenn der Benutzer keinen Wert übergibt. Kurzbeschreibung Erforderlich. Kurzbeschreibung des Befehlsarguments. Wird als Hilfetext verwendet, wenn der Benutzer den Befehl „--help“ ausführt.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 Benutzer beim Ausführen des zugehörigen Befehls einen Wert für das Argument angeben. Aufforderung Aufforderung, Informationen vom Benutzer anzufordern. Die CLI fordert Informationen an, wenn der Benutzer ein erforderliches Argument nicht 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 abgefragt werden soll. -
Erstellen Sie in den zugehörigen Listen API-Endpunktargumente die für den Befehl erforderlichen API-Endpunktargumente.
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 {flags.table} übergeben. Verwenden Sie die globale VariableFlags, um auf die Befehlsargumente zuzugreifen.Parametertyp Erforderlich. Der Typ des Parameters im REST-Endpunkt, an den Sie den Wert übergeben möchten. Wenn Sie beispielsweise Textkörper auswählen, übergibt die CLI den Wert des Felds Wert an den REST-Endpunkttext. 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 „Rückgabewerte“ die für den Befehl erforderlichen Rückgabewerte.
Erstellen Sie Rückgabewerte, um nur bestimmte Schlüssel aus der Antwort zurückzugeben.
Feld Beschreibung Pfadausdruck Erforderlich. Ausdruck, der den Pfad zu dem 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.