CatalogClientScript : inclus dans le périmètre

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 3 minutes de lecture

    • L’API CatalogClientScript fournit des méthodes qui vous permettent de créer, de modifier ou de supprimer des enregistrements de script client de catalogue.

    Pour utiliser cette classe dans une application incluse dans le périmètre, utilisez l’identificateur d’espace de noms sn_sc. Le module d’extension Service Catalog Scoped API (ID : com.glideapp.servicecatalog.scoped.api), qui est activé par défaut, est requis pour accéder à l’API CatalogClientScript .

    CatalogClientScript : CatalogClientScript()

    Crée une instance de la classe CatalogClientScript.

    Tableau 1. Paramètres
    Nom Type Description
    Aucun 
    var catalogClientScript = new sn_sc.CatalogClientScript();

    CatalogClientScript : addScript(script de chaîne)

    Ajoute un script au script client du catalogue.

    Tableau 2. Paramètres
    Nom Type Description
    script Chaîne Script à ajouter au script client du catalogue.
    Tableau 3. Renvoie
    Type Description
    nul

    Cet exemple montre comment appeler cette méthode.

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

    CatalogClientScript : appliesToCatalogItem (marqueur booléen)

    Spécifie si le script client du catalogue s’exécute sur un élément de catalogue.

    Tableau 4. Paramètres
    Nom Type Description
    marqueur Booléen Si vrai, le script client du catalogue s’exécute sur l’élément de catalogue. Si la valeur est définie sur faux, le script client du catalogue ne s’exécute pas sur l’élément de catalogue.
    Tableau 5. Renvoie
    Type Description
    nul 
    var catalogClientScript = new sn_sc.CatalogClientScript();
catalogClientScript.appliesToCatalogItem(true);

    CatalogClientScript : appliesToCatalogTask(marqueur booléen)

    Spécifie si le script client du catalogue s’exécute sur une tâche de catalogue.

    Tableau 6. Paramètres
    Nom Type Description
    marqueur Booléen Si vrai, le script client du catalogue s’exécute sur la tâche de catalogue. Si la valeur est définie sur faux, le script client du catalogue ne s’exécute pas sur la tâche de catalogue.
    Tableau 7. Renvoie
    Type Description
    nul

    Cet exemple montre comment appeler cette méthode.

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

    CatalogClientScript : appliesToRequestedItem(marqueur booléen)

    Spécifie si le script client du catalogue s’exécute sur un élément demandé.

    Tableau 8. Paramètres
    Nom Type Description
    marqueur Booléen Si vrai, le script client du catalogue s’exécute sur l’élément demandé. Si la valeur est définie sur Faux, le script client du catalogue ne s’exécute pas sur l’élément demandé.
    Tableau 9. Renvoie
    Type Description
    nul

    Cet exemple montre comment appeler la méthode.

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

    CatalogClientScript : appliesToTargetRecord (marqueur booléen)

    Spécifie si le script client du catalogue s’exécute sur un élément demandé.

    Tableau 10. Paramètres
    Nom Type Description
    marqueur Booléen Si vrai, le script client du catalogue s’exécute sur l’enregistrement cible. Si la valeur est définie sur faux, le script client du catalogue ne s’exécute pas sur l’enregistrement cible.
    Tableau 11. Renvoie
    Type Description
    nul

    Cet exemple montre comment appeler la méthode.

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

    CatalogClientScript : créer (standard booléen)

    Insère le script client du catalogue défini dans la table catalog_script_client.

    Tableau 12. Paramètres
    Nom Type Description
    standardUpdate (Mise à jour standard) Booléen Marqueur indiquant s’il faut activer l’exécution des moteurs et du workflow.
    Valeurs valides :
    • true : activez les moteurs et le workflow.
    • false : n’activez pas les moteurs et le workflow.
    Tableau 13. Renvoie
    Type Description
    Chaîne Sys_id du script client du catalogue.

    Cet exemple montre comment appeler la méthode.

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

    Sortie :

    039c516237b1300054b6a3549dbe5dfc

    CatalogClientScript : deleteRecord(String sys_id, booléen standardUpdate)

    Supprime le script client du catalogue défini.

    Tableau 14. Paramètres
    Nom Type Description
    sys_id Chaîne Sys_id du script client du catalogue.
    standardUpdate (Mise à jour standard) Booléen Marqueur indiquant s’il faut activer l’exécution des moteurs et du workflow.
    Valeurs valides :
    • true : activez les moteurs et le workflow.
    • false : n’activez pas les moteurs et le workflow.
    Tableau 15. Renvoie
    Type Description
    nul

    L’exemple suivant montre comment supprimer un script client de catalogue.

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

    CatalogClientScript : setAttributes(Mapper les attributs)

    Définit les valeurs d’attribut du script client du catalogue.

    Tableau 16. Paramètres
    Nom Type Description
    attributs Carte Objet JSON qui dispose d’un mappage pour les paires de champ et de valeur.
    Tableau 17. Renvoie
    Type Description
    nul

    Cet exemple montre comment appeler la méthode.

    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)

    Associe un élément de catalogue au script client du catalogue.

    Tableau 18. Paramètres
    Nom Type Description
    sys_id Chaîne Sys_id de l’élément de catalogue.
    Tableau 19. Renvoie
    Type Description
    nul

    Cet exemple montre comment associer un élément de catalogue au script client actuel du catalogue.

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

    CatalogClientScript : setOnChangeVariable(String sys_id)

    Exécute le script client du catalogue lorsqu’une valeur de variable est mise à jour.

    Tableau 20. Paramètres
    Nom Type Description
    sys_id Chaîne Sys_id de la variable.
    Tableau 21. Renvoie
    Type Description
    nul

    Cet exemple montre comment appeler la méthode.

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

    CatalogClientScript : setVariableSet(String sys_id)

    Associe un jeu de variables au script client du catalogue.

    Tableau 22. Paramètres
    Nom Type Description
    sys_id Chaîne Sys_id du jeu de variables.
    Tableau 23. Renvoie
    Type Description
    nul

    Cet exemple montre comment appeler la méthode.

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