KatalogClientScript – Umfang

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 3 Minuten Lesedauer
  • Die KatalogClientScript Die API stellt Methoden bereit, mit denen Sie Katalog-Client-Skriptdatensätze erstellen, ändern oder löschen können.

    Um diese Klasse in einer bereichsbezogenen Anwendung zu verwenden, verwenden Sie sn_sc Namespace-Bezeichner. Das standardmäßig aktivierte Plugin „bereichsbezogene API des Servicekatalogs“ (ID: com.glideapp.servicecatalog.scoped.api) ist für den Zugriff auf erforderlich KatalogClientScript API.

    CatalogClientScript: CatalogClientScript()

    Erstellt eine Instanz der CatalogClientScript-Klasse.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine
    var catalogClientScript = new sn_sc.CatalogClientScript();

    CatalogClientScript – addScript (Zeichenfolgenskript)

    Fügt dem Katalog-Client-Skript ein Skript hinzu.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    Skript Zeichenfolge Skript, das dem Katalog-Client-Skript hinzugefügt werden soll.
    Tabelle : 3. Ergebnisse
    Typ Beschreibung
    void

    Dieses Beispiel zeigt, wie diese Methode aufgerufen wird.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.addScript("function onLoad(){Enter the script}");

    CatalogClientScript – appliesToCatalogItem (boolesche Kennzeichnung)

    Gibt an, ob das Katalog-Client-Skript für ein Katalogelement ausgeführt wird.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    flag Boolean Bei „true“ wird das Katalog-Client-Skript für das Katalogelement ausgeführt. Bei „false“ wird das Katalog-Client-Skript für das Katalogelement nicht ausgeführt.
    Tabelle : 5. Ergebnisse
    Typ Beschreibung
    void
    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.appliesToCatalogItem(true);

    CatalogClientScript – appliesToCatalogTask (boolesche Kennzeichnung)

    Gibt an, ob das Katalog-Client-Skript für eine Katalogaufgabe ausgeführt wird.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    flag Boolean Bei „true“ wird das Katalog-Client-Skript für die Katalogaufgabe ausgeführt. Bei „false“ wird das Katalog-Client-Skript nicht für die Katalogaufgabe ausgeführt.
    Tabelle : 7. Ergebnisse
    Typ Beschreibung
    void

    Dieses Beispiel zeigt, wie diese Methode aufgerufen wird.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.appliesToCatalogTask(true);

    CatalogClientScript – appliesToRequestedItem (boolesche Kennzeichnung)

    Gibt an, ob das Katalog-Client-Skript für ein angefordertes Element ausgeführt wird.

    Tabelle : 8. Parameter
    Name Typ Beschreibung
    flag Boolean Bei „true“ wird das Katalog-Client-Skript für das angeforderte Element ausgeführt. Bei „false“ wird das Katalog-Client-Skript für das angeforderte Element nicht ausgeführt.
    Tabelle : 9. Ergebnisse
    Typ Beschreibung
    void

    Dieses Beispiel zeigt, wie die Methode aufgerufen wird.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.appliesToRequestedItem(true);

    CatalogClientScript – appliesToTargetRecord (boolesche Kennzeichnung)

    Gibt an, ob das Katalog-Client-Skript für ein angefordertes Element ausgeführt wird.

    Tabelle : 10. Parameter
    Name Typ Beschreibung
    flag Boolean Bei „true“ wird das Katalog-Client-Skript im Zieldatensatz ausgeführt. Bei „false“ wird das Katalog-Client-Skript nicht im Zieldatensatz ausgeführt.
    Tabelle : 11. Ergebnisse
    Typ Beschreibung
    void

    Dieses Beispiel zeigt, wie die Methode aufgerufen wird.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.appliesToTargetRecord(true);

    CatalogClientScript – create(Boolescher Standard-Update)

    Fügt das definierte Katalog-Client-Skript in die Tabelle „catalog_script_client“ ein.

    Tabelle : 12. Parameter
    Name Typ Beschreibung
    standardUpdate Boolean Kennzeichnung, die angibt, ob die Ausführung von Engines und Workflows aktiviert werden soll.
    Gültige Werte:
    • Wahr: Engines und Workflow aktivieren.
    • Falsch: Engines und Workflow nicht aktivieren.
    Tabelle : 13. Rückgaben
    Typ Beschreibung
    Zeichenfolge SYS_ID des Katalog-Client-Skripts.

    Dieses Beispiel zeigt, wie die Methode aufgerufen wird.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.setAttributes({"name": "My Catalog Item", "applies_to": "item", "ui_type": "desktop", "type": "onLoad"});
    catalogClientScript.appliesToCatalogItem(true);
    catalogClientScript.appliesToRequestedItem(true);
    catalogClientScript.appliesToCatalogTask(true);
    catalogClientScript.appliesToTargetRecord(true);
    var catalogClientScriptId = catalogClientScript.create();
    gs.info(catalogClientScriptId);

    Ausgabe:

    039c516237b1300054b6a3549dbe5dfc

    CatalogClientScript – deleteRecord(Zeichenfolge sys_ID, boolescher Standard-Update)

    Löscht das definierte Katalog-Client-Skript.

    Tabelle : 14. Parameter
    Name Typ Beschreibung
    sys_id Zeichenfolge SYS_ID des Katalog-Client-Skripts.
    standardUpdate Boolean Kennzeichnung, die angibt, ob die Ausführung von Engines und Workflows aktiviert werden soll.
    Gültige Werte:
    • Wahr: Engines und Workflow aktivieren.
    • Falsch: Engines und Workflow nicht aktivieren.
    Tabelle : 15. Rückgaben
    Typ Beschreibung
    void

    Das folgende Beispiel zeigt, wie ein Katalog-Client-Skript gelöscht wird.

    var sys_id = "039c516237b1300054b6a3549dbe5dfc"; 
    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.deleteRecord("039c516237b1300054b6a3549dbe5dfc");

    CatalogClientScript – setAttributes(Attribute zuordnen)

    Definiert Attributwerte für das Katalog-Client-Skript.

    Tabelle : 16. Parameter
    Name Typ Beschreibung
    attributes Zuordnung Ein JSON-Objekt mit Zuordnung für die Feld- und Wertepaare.
    Tabelle : 17. Ergebnisse
    Typ Beschreibung
    void

    Dieses Beispiel zeigt, wie die Methode aufgerufen wird.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.setAttributes({"name": "My Catalog Item", "applies_to": "catalog_item", "ui_type": "desktop", "type": "onLoad"});

    CatalogClientScript – setCatalogItem(Zeichenfolge sys_ID)

    Ordnet dem Katalog-Client-Skript ein Katalogelement zu.

    Tabelle : 18. Parameter
    Name Typ Beschreibung
    sys_id Zeichenfolge SYS_ID des Katalogelements.
    Tabelle : 19. Rückgaben
    Typ Beschreibung
    void

    Dieses Beispiel zeigt, wie ein Katalogelement dem aktuellen Katalog-Client-Skript zugeordnet wird.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.setCatalogItem("039c516237b1300054b6a3549dbe5dfc");

    CatalogClientScript – setOnChangeVariable(Zeichenfolge sys_ID)

    Führt das Katalog-Client-Skript aus, wenn ein Variablenwert aktualisiert wird.

    Tabelle : 20. Parameter
    Name Typ Beschreibung
    sys_id Zeichenfolge SYS_ID der Variablen.
    Tabelle : 21. Rückgaben
    Typ Beschreibung
    void

    Dieses Beispiel zeigt, wie die Methode aufgerufen wird.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.setOnChangeVariable("039c516237b1300054b6a3549dbe5dfc");

    CatalogClientScript – setVariableSet(Zeichenfolge sys_ID)

    Ordnet dem Katalog-Client-Skript einen Variablensatz zu.

    Tabelle : 22. Parameter
    Name Typ Beschreibung
    sys_id Zeichenfolge SYS_ID des Variablensatzes.
    Tabelle : 23. Rückgaben
    Typ Beschreibung
    void

    Dieses Beispiel zeigt, wie die Methode aufgerufen wird.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.setVariableSet("039c516237b1300054b6a3549dbe5dfc");