CatalogClientScript- Scoped

The CatalogClientScript API provides methods that enable you to create, modify, or delete catalog client script records.

To use this class in a scoped application, use the sn_sc namespace identifier. The Service Catalog Scoped API plugin (ID: com.glideapp.servicecatalog.scoped.api) that is enabled by default is required to access the CatalogClientScript API.

Parent Topic:Server API reference

CatalogClientScript - CatalogClientScript()

Creates an instance of the CatalogClientScript class.

var catalogClientScript = new sn_sc.CatalogClientScript();

CatalogClientScript - addScript(String script)

Adds a script to the catalog client script.

This example shows how to call this method.

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

CatalogClientScript - appliesToCatalogItem(Boolean flag)

Specifies if the catalog client script runs on a catalog item.

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

CatalogClientScript - appliesToCatalogTask(Boolean flag)

Specifies if the catalog client script runs on a catalog task.

This example shows how to call this method.

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

CatalogClientScript - appliesToRequestedItem(Boolean flag)

Specifies if the catalog client script runs on a requested item.

This example shows how to call the method.

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

CatalogClientScript - appliesToTargetRecord(Boolean flag)

Specifies if the catalog client script runs on a requested item.

This example shows how to call the method.

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

CatalogClientScript - create(Boolean standardUpdate)

Inserts the defined catalog client script in the catalog_script_client table.

This example shows how to call the method.

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);

Output:

039c516237b1300054b6a3549dbe5dfc

CatalogClientScript - deleteRecord(String sys_id, Boolean standardUpdate)

Deletes the defined catalog client script.

The following example shows how to delete a catalog client script.

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

CatalogClientScript - setAttributes(Map attributes)

Defines attribute values for the catalog client script.

This example shows how to call the method.

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

CatalogClientScript - setCatalogItem(String sys_id)

Associates a catalog item with the catalog client script.

This example shows how to associate a catalog item with the current catalog client script.

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

CatalogClientScript - setOnChangeVariable(String sys_id)

Runs the catalog client script when a variable value is updated.

This example shows how to call the method.

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

CatalogClientScript - setVariableSet(String sys_id)

Associates a variable set with the catalog client script.

This example shows how to call the method.

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