CatalogClientScript - スコープ指定

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：8分

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

    スコープ対象のアプリケーションでこのクラスを使用するには、sn_sc 名前空間識別子を使用します。デフォルトで有効になっている Service Catalog Scoped API プラグイン (ID：com.glideapp.servicecatalog.scoped.api) は、CatalogClientScript 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. パラメーター
    名前 タイプ 説明
    standardUpdate ブーリアン エンジンとワークフローの実行を有効にするかどうかを示すフラグです。
    有効な値：
    • 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 です。
    standardUpdate ブーリアン エンジンとワークフローの実行を有効にするかどうかを示すフラグです。
    有効な値：
    • 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");