CatalogClientScript – Scoped

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 3 Minuten Lesedauer
  • Mit der CatalogClientScript- API können Sie Katalog-Client-Skriptdatensätze erstellen, ändern oder löschen.

    Um diese Klasse in einer bereichsbezogenen Anwendung zu verwenden, verwenden Sie den Namespace-Identifier sn_sc. Das standardmäßig aktivierte Plugin „Service Catalog Scoped API“ (ID: com.glideapp.servicecatalog.scoped.api) ist für den Zugriff auf die CatalogClientScript- API erforderlich.

    Scoped CatalogClientScript – addScript(String script)

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

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

    Beispiel

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

    Scoped CatalogClientScript – appliesToCatalogItem(Boolean flag)

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

    Tabelle : 3. 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 : 4. Ergebnisse
    Typ Beschreibung
    void

    Beispiel

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

    Scoped CatalogClientScript – appliesToCatalogTask(Boolean flag)

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

    Tabelle : 5. 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 : 6. Ergebnisse
    Typ Beschreibung
    void

    Beispiel

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

    Scoped CatalogClientScript – appliesToRequestedItem(Boolean flag)

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

    Tabelle : 7. 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 : 8. Ergebnisse
    Typ Beschreibung
    void

    Beispiel

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

    Scoped CatalogClientScript – appliesToTargetRecord(Boolean flag)

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

    Tabelle : 9. 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 : 10. Ergebnisse
    Typ Beschreibung
    void

    Beispiel

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

    Scoped CatalogClientScript – CatalogClientScript()

    Erstellt eine Instanz der CatalogClientScript-Klasse.

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

    Scoped CatalogClientScript – create(Boolean standardUpdate)

    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:
    • true: Engines und Workflow aktivieren.
    • false: Engines und Workflow nicht aktivieren.
    Tabelle : 13. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Sys_id des Katalog-Client-Skripts.

    Beispiel

    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

    Scoped CatalogClientScript – deleteRecord(String sys_id, Boolean standardUpdate)

    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:
    • true: Engines und Workflow aktivieren.
    • false: Engines und Workflow nicht aktivieren.
    Tabelle : 15. Ergebnisse
    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");

    Scoped CatalogClientScript – setAttributes(Map attributes)

    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

    Beispiel

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

    Scoped CatalogClientScript – setCatalogItem(String 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. Ergebnisse
    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");

    Scoped CatalogClientScript – setOnChangeVariable(String 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. Ergebnisse
    Typ Beschreibung
    void

    Beispiel

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

    Scoped CatalogClientScript – setVariableSet(String 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. Ergebnisse
    Typ Beschreibung
    void

    Beispiel

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