---
sourceDocument: Xanadu-API-Referenz
sourceDocumentLink: https://www.servicenow.com/docs/r/de-DE/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - de-DE

ft:publication_title :

    - Xanadu-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# KatalogClientSkript: Bereichsbezogen

# KatalogClientSkript: Bereichsbezogen {#ariaid-title1}

* Freigeben Version: Xanadu
* 
* Aktualisiert 1. August 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 Minuten Lesedauer

Die CatalogClientScript- API stellt Methoden bereit, mit denen Sie Katalog-Clientskript-Datensätze erstellen, ändern oder löschen können.

Um diese Klasse in einer bereichsbezogenen Anwendung zu verwenden, verwenden Sie den Namespace-Bezeichner `sn_sc`. Das standardmäßig aktivierte Plugin „Service Catalog Scoped API" (ID: com.glideapp.servicecatalog.scoped.api) ist für den Zugriff auf die CatalogClientScript- API erforderlich.

## CatalogClientScript: CatalogClientScript () {#ariaid-title2}

Erstellt eine Instanz der CatalogClientScript-Klasse.
{#r_CCSS-CatalogClientScript__table_hlv_q2c_1z__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 1. Parameter]

{#r_CCSS-CatalogClientScript__table_hlv_q2c_1z}  

    var catalogClientScript = new sn_sc.CatalogClientScript();

## CatalogClientScript - addScript(Zeichenfolgenskript) {#ariaid-title3}

Fügt dem Katalog-Client-Skript ein Skript hinzu.
{#r_CCSS-addScript_S__table_m1v_1ds_sy__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Skript | Zeichenfolge | Skript, das dem Katalog-Client-Skript hinzugefügt werden soll. |
[Tabelle : 2. Parameter]

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

| Typ | Beschreibung |
|-|-|
| void |   |
[Tabelle : 3. Ergebnisse]

{#r_CCSS-addScript_S__table_n1v_1ds_sy}  
In diesem Beispiel wird gezeigt, wie diese Methode aufgerufen wird.

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

## CatalogClientScript - gelten für das Katalogelement für Katalogelement(Boolean-Kennzeichnung) {#ariaid-title4}

Gibt an, ob das Katalog-Client-Skript für ein Katalogelement ausgeführt wird.
{#r_CCSS-appliesToCatalogItem_B__table_zsm_rzr_sy__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| flag | Boolean | Bei „true" wird das Katalog-Client-Skript für das Katalogelement ausgeführt. Bei „false" wird das Katalog-Client-Skript für das Katalogelement nicht ausgeführt. |
[Tabelle : 4. Parameter]

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

| Typ | Beschreibung |
|-|-|
| void |   |
[Tabelle : 5. Ergebnisse]

{#r_CCSS-appliesToCatalogItem_B__table_atm_rzr_sy}  

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

## CatalogClientScript --ApplyToCatalogTask(Boolean_Kennzeichnung) {#ariaid-title5}

Gibt an, ob das Katalog-Client-Skript für eine Katalogaufgabe ausgeführt wird.
{#r_CCSS-appliesToCatalogTask_B__table_tqp_n2s_sy__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| flag | Boolean | Bei „true" wird das Katalog-Client-Skript für die Katalogaufgabe ausgeführt. Bei „false" wird das Katalog-Client-Skript nicht für die Katalogaufgabe ausgeführt. |
[Tabelle : 6. Parameter]

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

| Typ | Beschreibung |
|-|-|
| void |   |
[Tabelle : 7. Ergebnisse]

{#r_CCSS-appliesToCatalogTask_B__table_uqp_n2s_sy}  
In diesem Beispiel wird gezeigt, wie diese Methode aufgerufen wird.

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

## CatalogClientScript -- gelten für „ApplyToRequestedItem(Boolean Flag)" {#ariaid-title6}

Gibt an, ob das Katalog-Client-Skript für ein angefordertes Element ausgeführt wird.
{#r_CCSS-appliesToRequestedItem_B__table_rsq_p1s_sy__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| flag | Boolean | Bei „true" wird das Katalog-Client-Skript für das angeforderte Element ausgeführt. Bei „false" wird das Katalog-Client-Skript für das angeforderte Element nicht ausgeführt. |
[Tabelle : 8. Parameter]

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

| Typ | Beschreibung |
|-|-|
| void |   |
[Tabelle : 9. Ergebnisse]

{#r_CCSS-appliesToRequestedItem_B__table_ssq_p1s_sy}  
In diesem Beispiel wird gezeigt, wie die -Methode aufgerufen wird.

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

## CatalogClientScript - gelten für das Zieldatensatz-Element (Boolesche Kennzeichnung) {#ariaid-title7}

Gibt an, ob das Katalog-Client-Skript für ein angefordertes Element ausgeführt wird.
{#r_CCSS-appliesToTargetRecord_B__table_hwy_44l_5z__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| flag | Boolean | Bei „true" wird das Katalog-Client-Skript im Zieldatensatz ausgeführt. Bei „false" wird das Katalog-Client-Skript nicht im Zieldatensatz ausgeführt. |
[Tabelle : 10. Parameter]

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

| Typ | Beschreibung |
|-|-|
| void |   |
[Tabelle : 11. Ergebnisse]

{#r_CCSS-appliesToTargetRecord_B__table_iwy_44l_5z}  
In diesem Beispiel wird gezeigt, wie die -Methode aufgerufen wird.

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

## CatalogClientScript -- create(Boolean standardUpdate) {#ariaid-title8}

Fügt das definierte Katalog-Client-Skript in die Tabelle „catalog_script_client" ein.
{#r_CCSS-create_B__table_kj1_xbs_kx__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| standardUpdate | Boolean | Kennzeichnung, die angibt, ob die Ausführung von Engines und Workflows aktiviert werden soll. Gültige Werte: * „wahr": Engines und Workflows aktivieren. * „falsch": Engines und Workflow nicht aktiviert. {#r_CCSS-create_B__ul_nnx_xwn_kpb} |
[Tabelle : 12. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Sys_id des Katalog-Client-Skripts. |
[Tabelle : 13. Ergebnisse]

{#r_CCSS-create_B__table_lj1_xbs_kx}  
In diesem Beispiel wird gezeigt, wie die -Methode aufgerufen wird.

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

Ausgabe:

    039c516237b1300054b6a3549dbe5dfc

## CatalogClientScript -- deleteRecord(String sys_id, Boolean standardUpdate) {#ariaid-title9}

Löscht das definierte Katalog-Client-Skript.
{#r_CCSS-deleteRecord_S_B__table_jdv_hsz_qy__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| sys_id | Zeichenfolge | Sys_id des Katalog-Client-Skripts. |
| standardUpdate | Boolean | Kennzeichnung, die angibt, ob die Ausführung von Engines und Workflows aktiviert werden soll. Gültige Werte: * „wahr": Engines und Workflows aktivieren. * „falsch": Engines und Workflow nicht aktiviert. {#r_CCSS-deleteRecord_S_B__ul_nnx_xwn_kpb} |
[Tabelle : 14. Parameter]

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

| Typ | Beschreibung |
|-|-|
| void |   |
[Tabelle : 15. Ergebnisse]

{#r_CCSS-deleteRecord_S_B__table_kdv_hsz_qy}  
Das folgende Beispiel zeigt, wie ein Katalog-Client-Skript gelöscht wird.

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

## CatalogClientScript -- setAttributes(Attribute zuordnen) {#ariaid-title10}

Definiert Attributwerte für das Katalog-Client-Skript.
{#r_CCSS-setAttributes_M__table_fyy_tyr_sy__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| attributes | Zuordnung | Ein JSON-Objekt mit Zuordnung für die Feld- und Wertepaare. |
[Tabelle : 16. Parameter]

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

| Typ | Beschreibung |
|-|-|
| void |   |
[Tabelle : 17. Ergebnisse]

{#r_CCSS-setAttributes_M__table_gyy_tyr_sy}  
In diesem Beispiel wird gezeigt, wie die -Methode aufgerufen wird.

    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}

Ordnet dem Katalog-Client-Skript ein Katalogelement zu.
{#r_CCSS-setCatalogItem_S__table_v3g_zds_sy__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| sys_id | Zeichenfolge | Sys_id des Katalogelements. |
[Tabelle : 18. Parameter]

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

| Typ | Beschreibung |
|-|-|
| void |   |
[Tabelle : 19. Ergebnisse]

{#r_CCSS-setCatalogItem_S__table_w3g_zds_sy}  
In diesem Beispiel wird gezeigt, wie ein Katalogelement dem aktuellen Katalog-Clientskript zugeordnet wird.

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

## CatalogClientScript -- setOnChangeVariable(String sys_id) {#ariaid-title12}

Führt das Katalog-Client-Skript aus, wenn ein Variablenwert aktualisiert wird.
{#r_CCSS-setOnChangeVariable_S__table_m3r_3cs_sy__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| sys_id | Zeichenfolge | Sys_id der Variable. |
[Tabelle : 20. Parameter]

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

| Typ | Beschreibung |
|-|-|
| void |   |
[Tabelle : 21. Ergebnisse]

{#r_CCSS-setOnChangeVariable_S__table_n3r_3cs_sy}  
In diesem Beispiel wird gezeigt, wie die -Methode aufgerufen wird.

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

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

Ordnet dem Katalog-Client-Skript einen Variablensatz zu.
{#r_CCSS-setVariableSet_S__table_cvz_tbs_sy__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| sys_id | Zeichenfolge | Sys_id des Variablensatzes. |
[Tabelle : 22. Parameter]

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

| Typ | Beschreibung |
|-|-|
| void |   |
[Tabelle : 23. Ergebnisse]

{#r_CCSS-setVariableSet_S__table_dvz_tbs_sy}  
In diesem Beispiel wird gezeigt, wie die -Methode aufgerufen wird.

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