CatalogClientScript - スコープ指定

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：8分

    • CatalogClientScript API は、カタログクライアントスクリプトレコードを作成、変更、または削除できるようにするメソッドを提供します。

    スコープ対象のアプリケーションでこのクラスを使用するには、 sn_sc 名前空間識別子を使用します。CatalogClientScript API にアクセスするには、デフォルトで有効になっているサービスカタログスコープ付き API プラグイン (ID:com.glideapp.servicecatalog.scoped.api) が必要です。

    CatalogClientScript:CatalogClientScript()

    CatalogClientScript クラスのインスタンスを作成します。

    表 : 1. パラメーター
    名前 タイプ 説明
    なし 
    var catalogClientScript = new sn_sc.CatalogClientScript();

    CatalogClientScript - addScript(文字列スクリプト)

    カタログクライアントスクリプトにスクリプトを追加します。

    表 : 2. パラメーター
    名前 タイプ 説明
    スクリプト 文字列 カタログクライアントスクリプトに追加するスクリプト。
    表 : 3. 戻り値
    タイプ 説明
    なし

    この例は、このメソッドを呼び出す方法を示しています。

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

    CatalogClientScript - appliesToCatalogItem(ブールフラグ)

    カタログ クライアント スクリプトをカタログ アイテムで実行するかどうかを指定します。

    表 : 4. パラメーター
    名前 タイプ 説明
    フラグ ブール true の場合、カタログクライアントスクリプトはカタログアイテムで実行されます。false の場合、カタログクライアントスクリプトはカタログアイテムで実行されません。
    表 : 5. 戻り値
    タイプ 説明
    なし 
    var catalogClientScript = new sn_sc.CatalogClientScript();
catalogClientScript.appliesToCatalogItem(true);

    CatalogClientScript - appliesToCatalogTask (ブールフラグ)

    カタログクライアントスクリプトをカタログタスクで実行するかどうかを指定します。

    表 : 6. パラメーター
    名前 タイプ 説明
    フラグ ブール true の場合、カタログクライアントスクリプトがカタログタスクで実行されます。false の場合、カタログクライアントスクリプトはカタログタスクで実行されません。
    表 : 7. 戻り値
    タイプ 説明
    なし

    この例は、このメソッドを呼び出す方法を示しています。

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

    CatalogClientScript - appliesToRequestedItem(ブールフラグ)

    カタログクライアントスクリプトを要求アイテムで実行するかどうかを指定します。

    表 : 8. パラメーター
    名前 タイプ 説明
    フラグ ブール true の場合、カタログクライアントスクリプトは要求アイテムで実行されます。false の場合、カタログクライアントスクリプトは要求アイテムに対して実行されません。
    表 : 9. 戻り値
    タイプ 説明
    なし

    この例は、メソッドを呼び出す方法を示しています。

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

    CatalogClientScript - appliesToTargetRecord(ブールフラグ)

    カタログクライアントスクリプトを要求アイテムで実行するかどうかを指定します。

    表 : 10. パラメーター
    名前 タイプ 説明
    フラグ ブール true の場合、カタログクライアントスクリプトはターゲットレコードで実行されます。false の場合、カタログクライアントスクリプトはターゲットレコードで実行されません。
    表 : 11. 戻り値
    タイプ 説明
    なし

    この例は、メソッドを呼び出す方法を示しています。

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

    CatalogClientScript:create(ブール値 standardUpdate)

    定義されたカタログクライアントスクリプトをcatalog_script_clientテーブルに挿入します。

    表 : 12. パラメーター
    名前 タイプ 説明
    標準更新 ブール エンジンとワークフローの実行を有効にするかどうかを示すフラグ。
    有効な値：
    • true:エンジンとワークフローを有効にします。
    • false:エンジンとワークフローを有効にしません。
    表 : 13. 戻り値
    タイプ 説明
    文字列 カタログクライアントスクリプトのSys_id。

    この例は、メソッドを呼び出す方法を示しています。

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

    出力：

    039c516237b1300054b6a3549dbe5dfc

    CatalogClientScript - deleteRecord(文字列 sys_id, ブール値 standardUpdate)

    定義されたカタログクライアントスクリプトを削除します。

    表 : 14. パラメーター
    名前 タイプ 説明
    sys_id 文字列 カタログクライアントスクリプトのSys_id。
    標準更新 ブール エンジンとワークフローの実行を有効にするかどうかを示すフラグ。
    有効な値：
    • true:エンジンとワークフローを有効にします。
    • false:エンジンとワークフローを有効にしません。
    表 : 15. 戻り値
    タイプ 説明
    なし

    次の例は、カタログクライアントスクリプトを削除する方法を示しています。

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

    CatalogClientScript - setAttributes(マップ属性)

    カタログクライアントスクリプトの属性値を定義します。

    表 : 16. パラメーター
    名前 タイプ 説明
    属性 マップ フィールドと値のペアのマッピングを持つ JSON オブジェクト。
    表 : 17. 戻り値
    タイプ 説明
    なし

    この例は、メソッドを呼び出す方法を示しています。

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

    CatalogClientScript:setCatalogItem(文字列 sys_id)

    カタログアイテムをカタログクライアントスクリプトに関連付けます。

    表 : 18. パラメーター
    名前 タイプ 説明
    sys_id 文字列 カタログアイテムのSys_id。
    表 : 19. 戻り値
    タイプ 説明
    なし

    この例では、カタログアイテムを現在のカタログクライアントスクリプトに関連付ける方法を示します。

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

    CatalogClientScript - setOnChangeVariable(文字列 sys_id)

    変数値が更新されたときにカタログクライアントスクリプトを実行します。

    表 : 20. パラメーター
    名前 タイプ 説明
    sys_id 文字列 変数のSys_id。
    表 : 21. 戻り値
    タイプ 説明
    なし

    この例は、メソッドを呼び出す方法を示しています。

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

    CatalogClientScript:setVariableSet(文字列 sys_id)

    変数セットをカタログクライアントスクリプトに関連付けます。

    表 : 22. パラメーター
    名前 タイプ 説明
    sys_id 文字列 変数セットのSys_id。
    表 : 23. 戻り値
    タイプ 説明
    なし

    この例は、メソッドを呼び出す方法を示しています。

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