Katalog-Client-Skripts

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 3 Minuten Lesedauer
  • Clientseitige Skripts können Formularen dynamische Effekte und Validierungen hinzufügen. Dabei lassen sich Skripts auf Servicekatalogelemente oder Variablensätze anwenden. Administratoren können auf diese Weise dieselbe Funktionalität verwenden, die auch in anderen Formularen verfügbar ist.

    Sie können clientseitige Skripts verwenden, um:

    • Variablenwerte abzurufen oder festzulegen
    • Variablen auszublenden oder anzuzeigen
    • Variablen obligatorisch zu machen
    • Validieren Sie die Formularübermittlung.
    • dem Einkaufswagen Elemente hinzuzufügen
    • Elemente sofort zu bestellen

    Überlegungen zu Katalog-Client-Skripts

    Die folgenden Aspekte sollten Sie beachten, wenn Sie Katalog-Client-Skripts erstellen.

    • Katalog-Client-Skripts werden ausgeführt, sobald ein Benutzer ein Element aus dem Servicekatalog bestellt. Ebenso können Katalog-Client-Skripts ausgeführt werden, sobald der Benutzer ein Katalogelement anfordert und dessen Variablen oder Variablensätze angezeigt werden.
    • Damit eine Variable über ein Katalog-Client-Skript abgerufen werden kann, muss sie einen Variablennamen haben. Variablen ohne Namen werden nicht in der Liste der verfügbaren Variablen angezeigt.
    • Wenn Sie standardmäßige Client-Skripts auf Formulare des Typs „Angefordertes Element“ oder des Typs „Katalogaufgabe“ anwenden, sollten Sie auf Felder achten, die den gleichen Namen haben wie Variablen. Enthält ein Formular ein Tabellenfeld und eine Variable mit identischem Namen, wird bei der Skriptausführung das Tabellenfeld als Treffer erkannt. In diesem Fall müssen Sie gezielt die Variable abrufen, nach dem Muster variables.variablenname. (Beispiel: g_form.setValue('variables.replacement', 'false');)
    • Wenn Sie Datensatzersteller verwenden, um Variablen aus dem Servicekatalog an andere Datensatztypen zu übergeben, werden diese Variablen in den Datensätzen mit einem Variableneditor sichtbar gemacht. Ein Beispiel ist der UI-Formatierer „Change Variable Editor“ in Change Request-Formularen. Sie können diese Variablen mit standardmäßigen Client-Skript-Methoden wie setDisplay, setMandatory, setValue und getValue bearbeiten.
    • Katalog-Client-Skripts können auf Katalogelemente in Assistenten angewendet werden.
    • Sie können die API g_form.refreshSlushbucket(Feldname) verwenden, um Listensammlervariablen zu aktualisieren.

    Spezifische Eigenschaften von Katalog-Client-Skripts

    Katalog-Client-Skripts sind standardmäßigen Client-Skripts sehr ähnlich. Dennoch gibt es einige wichtige Unterschiede.

    • Statt eine Tabelle wie „Incident“ für Ihr Skript auszuwählen, wählen Sie ein Katalogelement oder einen Variablensatz aus. Da Ihr System möglicherweise über eine große Anzahl von Katalogelementen verfügt, empfiehlt es sich, das Katalogelement bzw. den Variablensatz mit einem Referenzfeld auszuwählen. Verwenden Sie keine Auswahlliste, wie sie im Formular für standardmäßige Client-Skripts verwendet wird.
    • Katalog-Client-Skripts des Typs onChange() sind mit einer bestimmten Variablen verknüpft, nicht mit einem Feld. Das System befüllt die Auswahlliste mit den Variablennamen automatisch mit allen benannten Variablen aus dem ausgewählten Katalogelement oder Variablensatz.

    Katalog-Client-Skripts erstellen

    Gehen Sie wie folgt vor, um ein Katalog-Client-Skript zu erstellen:

    Prozedur

    1. Navigieren zu Alle > Servicekatalog > Katalogverwaltung > Katalog-Client-Skripts.
      Eine Liste der aktuellen benutzerdefinierten Client-Skripts wird angezeigt.
    2. Klicken Sie auf Neu.
    3. Füllen Sie die Felder entsprechend aus (siehe Tabelle).
      Feld Beschreibung
      Name Geben Sie einen eindeutigen Namen für das Katalog-Client-Skript ein.
      Betrifft Wählen Sie aus, auf welchen Typ Element das Client-Skript angewendet werden soll:
      • Ein Katalogelement: Aktiviert das Feld „Katalogelement“.
      • Ein Variablensatz: Aktiviert das Feld „Variablensatz“.
      Aktiv Aktivieren Sie diese Checkbox, um das Client-Skript zu aktivieren. Deaktivieren Sie diese Checkbox, um das Skript zu deaktivieren.
      UI-Typ Legen Sie fest, ob das Skript auf die Desktop-Plattform, die Mobilplattform oder beide angewendet werden soll.
      Skript Geben Sie das Client-Skript ein, das auf das Servicekatalogelement angewendet werden soll.
      Typ Wählen Sie aus, wann das Skript ausgeführt werden soll, beispielsweise onLoad oder onSubmit.
      Katalogelement oder Variablensatz Wählen Sie ein Katalogelement oder einen Variablensatz aus der Liste aus. Der Feldname und die verfügbaren Optionen hängen von der Auswahl ab, die Sie im Feld Betrifft getroffen haben.
      Betrifft die Ansicht eines Katalogelements Aktivieren Sie diese Checkbox, wenn das Katalog-Client-Skript auf Katalogelemente im Bestellbildschirm des Servicekatalogs angewendet werden soll. Sie finden es in der Anfordereransicht.
      Betrifft angeforderte Elemente Aktivieren Sie diese Checkbox, wenn das Katalog-Client-Skript auf Formulare des Typs „Angefordertes Element“ angewendet werden soll, nachdem das Element angefordert wurde. Verfügbar in der Erfülleransicht. Siehe VEditor.
      Betrifft Katalogaufgaben Aktivieren Sie diese Checkbox, wenn das Katalog-Client-Skript angewendet werden soll, sobald für das betreffende Element ein Formular des Typs „Katalogaufgabe“ angezeigt wird. Verfügbar in der Erfülleransicht. Siehe VEditor.
      Gilt für den Zieldatensatz Aktivieren Sie die Checkbox, um die Katalog-UI-Richtlinie in einem Datensatz zu unterstützen, der für durch eine Aufgabe erweiterte Tabellen über Datensatzersteller erstellt wurde. Weitere Informationen finden Sie unter Standardvariablen-Editor.
    4. Klicken Sie auf Absenden.

    Beispiele für Katalog-Client-Skripts

    Nachfolgend finden Sie Beispiele für Client-Skripts, die gängige Aktionen ausführen.

    Variablenwerte abrufen

    Verwenden Sie die nachfolgende Syntax, um den Wert einer Katalogvariablen abzurufen. Beachten Sie, dass die Variable einen Namen haben muss. Ersetzen Sie variable_name durch den Namen der Variablen.

    g_form.getValue('variable_name');

    Vom Benutzer in Variablen verwendbare Zeichenanzahl einschränken

    Dieses Beispielskript wird ausgeführt, wenn die Variable angezeigt wird, nicht wenn das Element bestellt wird.

    function onLoad(){
      var sd = g_form.getControl('short_description');
      sd.maxLength=80;
    }