---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# CatalogClientScript : inclus dans le périmètre

# CatalogClientScript : inclus dans le périmètre {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 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() {#ariaid-title2}

Crée une instance de la classe CatalogClientScript.
{#r_CCSS-CatalogClientScript__table_hlv_q2c_1z__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 1. Paramètres]

{#r_CCSS-CatalogClientScript__table_hlv_q2c_1z}  

    var catalogClientScript = new sn_sc.CatalogClientScript();

## CatalogClientScript : addScript(script de chaîne) {#ariaid-title3}

Ajoute un script au script client du catalogue.
{#r_CCSS-addScript_S__table_m1v_1ds_sy__entry__3}

| Nom | Type | Description |
|-|-|-|
| script | Chaîne | Script à ajouter au script client du catalogue. |
[Tableau 2. Paramètres]

{#r_CCSS-addScript_S__table_m1v_1ds_sy} {#r_CCSS-addScript_S__table_n1v_1ds_sy__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 3. Renvoie]

{#r_CCSS-addScript_S__table_n1v_1ds_sy}  
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) {#ariaid-title4}

Spécifie si le script client du catalogue s'exécute sur un élément de catalogue.
{#r_CCSS-appliesToCatalogItem_B__table_zsm_rzr_sy__entry__3}

| 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 4. Paramètres]

{#r_CCSS-appliesToCatalogItem_B__table_zsm_rzr_sy} {#r_CCSS-appliesToCatalogItem_B__table_atm_rzr_sy__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 5. Renvoie]

{#r_CCSS-appliesToCatalogItem_B__table_atm_rzr_sy}  

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

## CatalogClientScript : appliesToCatalogTask(marqueur booléen) {#ariaid-title5}

Spécifie si le script client du catalogue s'exécute sur une tâche de catalogue.
{#r_CCSS-appliesToCatalogTask_B__table_tqp_n2s_sy__entry__3}

| 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 6. Paramètres]

{#r_CCSS-appliesToCatalogTask_B__table_tqp_n2s_sy} {#r_CCSS-appliesToCatalogTask_B__table_uqp_n2s_sy__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 7. Renvoie]

{#r_CCSS-appliesToCatalogTask_B__table_uqp_n2s_sy}  
Cet exemple montre comment appeler cette méthode.

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

## CatalogClientScript : appliesToRequestedItem(marqueur booléen) {#ariaid-title6}

Spécifie si le script client du catalogue s'exécute sur un élément demandé.
{#r_CCSS-appliesToRequestedItem_B__table_rsq_p1s_sy__entry__3}

| 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 8. Paramètres]

{#r_CCSS-appliesToRequestedItem_B__table_rsq_p1s_sy} {#r_CCSS-appliesToRequestedItem_B__table_ssq_p1s_sy__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 9. Renvoie]

{#r_CCSS-appliesToRequestedItem_B__table_ssq_p1s_sy}  
Cet exemple montre comment appeler la méthode.

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

## CatalogClientScript : appliesToTargetRecord (marqueur booléen) {#ariaid-title7}

Spécifie si le script client du catalogue s'exécute sur un élément demandé.
{#r_CCSS-appliesToTargetRecord_B__table_hwy_44l_5z__entry__3}

| 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 10. Paramètres]

{#r_CCSS-appliesToTargetRecord_B__table_hwy_44l_5z} {#r_CCSS-appliesToTargetRecord_B__table_iwy_44l_5z__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 11. Renvoie]

{#r_CCSS-appliesToTargetRecord_B__table_iwy_44l_5z}  
Cet exemple montre comment appeler la méthode.

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

## CatalogClientScript : créer (standard booléen) {#ariaid-title8}

Insère le script client du catalogue défini dans la table catalog_script_client.
{#r_CCSS-create_B__table_kj1_xbs_kx__entry__3}

| 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. {#r_CCSS-create_B__ul_nnx_xwn_kpb} |
[Tableau 12. Paramètres]

{#r_CCSS-create_B__table_kj1_xbs_kx} {#r_CCSS-create_B__table_lj1_xbs_kx__entry__2}

| Type | Description |
|-|-|
| Chaîne | Sys_id du script client du catalogue. |
[Tableau 13. Renvoie]

{#r_CCSS-create_B__table_lj1_xbs_kx}  
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) {#ariaid-title9}

Supprime le script client du catalogue défini.
{#r_CCSS-deleteRecord_S_B__table_jdv_hsz_qy__entry__3}

| 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. {#r_CCSS-deleteRecord_S_B__ul_nnx_xwn_kpb} |
[Tableau 14. Paramètres]

{#r_CCSS-deleteRecord_S_B__table_jdv_hsz_qy} {#r_CCSS-deleteRecord_S_B__table_kdv_hsz_qy__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 15. Renvoie]

{#r_CCSS-deleteRecord_S_B__table_kdv_hsz_qy}  
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) {#ariaid-title10}

Définit les valeurs d'attribut du script client du catalogue.
{#r_CCSS-setAttributes_M__table_fyy_tyr_sy__entry__3}

| Nom | Type | Description |
|-|-|-|
| attributs | Carte | Objet JSON qui dispose d'un mappage pour les paires de champ et de valeur. |
[Tableau 16. Paramètres]

{#r_CCSS-setAttributes_M__table_fyy_tyr_sy} {#r_CCSS-setAttributes_M__table_gyy_tyr_sy__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 17. Renvoie]

{#r_CCSS-setAttributes_M__table_gyy_tyr_sy}  
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) {#ariaid-title11}

Associe un élément de catalogue au script client du catalogue.
{#r_CCSS-setCatalogItem_S__table_v3g_zds_sy__entry__3}

| Nom | Type | Description |
|-|-|-|
| sys_id | Chaîne | Sys_id de l'élément de catalogue. |
[Tableau 18. Paramètres]

{#r_CCSS-setCatalogItem_S__table_v3g_zds_sy} {#r_CCSS-setCatalogItem_S__table_w3g_zds_sy__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 19. Renvoie]

{#r_CCSS-setCatalogItem_S__table_w3g_zds_sy}  
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) {#ariaid-title12}

Exécute le script client du catalogue lorsqu'une valeur de variable est mise à jour.
{#r_CCSS-setOnChangeVariable_S__table_m3r_3cs_sy__entry__3}

| Nom | Type | Description |
|-|-|-|
| sys_id | Chaîne | Sys_id de la variable. |
[Tableau 20. Paramètres]

{#r_CCSS-setOnChangeVariable_S__table_m3r_3cs_sy} {#r_CCSS-setOnChangeVariable_S__table_n3r_3cs_sy__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 21. Renvoie]

{#r_CCSS-setOnChangeVariable_S__table_n3r_3cs_sy}  
Cet exemple montre comment appeler la méthode.

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

## CatalogClientScript : setVariableSet(String sys_id) {#ariaid-title13}

Associe un jeu de variables au script client du catalogue.
{#r_CCSS-setVariableSet_S__table_cvz_tbs_sy__entry__3}

| Nom | Type | Description |
|-|-|-|
| sys_id | Chaîne | Sys_id du jeu de variables. |
[Tableau 22. Paramètres]

{#r_CCSS-setVariableSet_S__table_cvz_tbs_sy} {#r_CCSS-setVariableSet_S__table_dvz_tbs_sy__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 23. Renvoie]

{#r_CCSS-setVariableSet_S__table_dvz_tbs_sy}  
Cet exemple montre comment appeler la méthode.

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