CatalogClientScript - com escopo

A API CatalogClientScript permite criar, modificar ou excluir registros de script do cliente do catálogo.

Para usar essa classe em uma aplicação com escopo, use o identificador de namespace sn_sc. O plug-in API com escopo do Catálogo de serviços (ID: com.glideapp.servicecatalog.scoped.api) que está habilitado por padrão é necessário para acessar a API CatalogClientScript.

CatalogClientScript com escopo - addScript(cadeia de caracteres script)

Adiciona um script ao client script do catálogo.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
script	Cadeia de caracteres	Script a ser adicionado ao client script do catálogo.

Tabela 2. Retorna

Tipo	Descrição
vazio

Exemplo

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

CatalogClientScript com escopo - applyToCatalogItem(booliano sinalizador)

Especifica se o script do cliente do catálogo é executado em um item do catálogo.

Tabela 3. Parâmetros

Nome	Tipo	Descrição
sinalizador	Booliano	Se for verdadeiro, o script do cliente do catálogo será executado no item do catálogo. Se for falso, o script do cliente do catálogo não será executado no item do catálogo.

Tabela 4. Retorna

Tipo	Descrição
vazio

Exemplo

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

CatalogClientScript com escopo - applyToCatalogTask(booliano sinalizador)

Especifica se o script do cliente do catálogo é executado em uma tarefa de catálogo.

Tabela 5. Parâmetros

Nome	Tipo	Descrição
sinalizador	Booliano	Se for verdadeiro, o script do cliente do catálogo será executado na tarefa do catálogo. Se for falso, o script do cliente do catálogo não será executado na tarefa do catálogo.

Tabela 6. Retorna

Tipo	Descrição
vazio

Exemplo

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

CatalogClientScript com escopo - applyToRequestedItem(booliano sinalizador)

Especifica se o script do cliente do catálogo é executado em um item solicitado.

Tabela 7. Parâmetros

Nome	Tipo	Descrição
sinalizador	Booliano	Se for verdadeiro, o script do cliente do catálogo será executado no item solicitado. Se for falso, o script do cliente do catálogo não será executado no item solicitado.

Tabela 8. Retorna

Tipo	Descrição
vazio

Exemplo

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

CatalogClientScript com escopo - applyToTargetRecord(boolean sinalizador)

Especifica se o script do cliente do catálogo é executado em um item solicitado.

Tabela 9. Parâmetros

Nome	Tipo	Descrição
sinalizador	Booliano	Se for verdadeiro, o script do cliente do catálogo será executado no registro de destino. Se for falso, o script do cliente do catálogo não será executado no registro de destino.

Tabela 10. Retorna

Tipo	Descrição
vazio

Exemplo

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

CatalogClientScript com escopo - CatalogClientScript()

Cria uma instância da classe CatalogClientScript.

Tabela 11. Parâmetros

Nome	Tipo	Descrição
Nenhum

var catalogClientScript = new sn_sc.CatalogClientScript();

CatalogClientScript com escopo - create(Boolean standardUpdate)

Insere o client script do catálogo definido na tabela catalog_script_client.

Tabela 12. Parâmetros

Nome	Tipo	Descrição
padrãoAtualizar	Booliano	Sinalizador que indica se a execução de mecanismos e fluxo de trabalho deve ser habilitada. Valores válidos: verdadeiro: habilitar mecanismos e fluxo de trabalho. falso: não habilite mecanismos e fluxo de trabalho.

Tabela 13. Retorna

Tipo	Descrição
Cadeia de caracteres	Sys_id do client script do catálogo.

Exemplo

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

Saída

039c516237b1300054b6a3549dbe5dfc

CatalogClientScript com escopo - deleteRecord(cadeia de caracteres sys_id, booliano standardUpdate)

Exclui o client script do catálogo definido.

Tabela 14. Parâmetros

Nome	Tipo	Descrição
sys_id	Cadeia de caracteres	Sys_id do client script do catálogo.
padrãoAtualizar	Booliano	Sinalizador que indica se a execução de mecanismos e fluxo de trabalho deve ser habilitada. Valores válidos: verdadeiro: habilitar mecanismos e fluxo de trabalho. falso: não habilite mecanismos e fluxo de trabalho.

Tabela 15. Retorna

Tipo	Descrição
vazio

O exemplo a seguir mostra como excluir um client script de catálogo.

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

CatalogClientScript com escopo - setAttributes(Maptributes)

Define valores de atributo para o client script do catálogo.

Tabela 16. Parâmetros

Nome	Tipo	Descrição
atributos	Mapa	Um objeto JSON que tem mapeamento para os pares de campo e valor.

Tabela 17. Retorna

Tipo	Descrição
vazio

Exemplo

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

CatalogClientScript com escopo - setCatalogItem(cadeia de caracteres sys_id)

Associa um item do catálogo ao client script do catálogo.

Tabela 18. Parâmetros

Nome	Tipo	Descrição
sys_id	Cadeia de caracteres	Sys_id do item do catálogo.

Tabela 19. Retorna

Tipo	Descrição
vazio

Este exemplo mostra como associar um item do catálogo ao client script do catálogo atual.

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

CatalogClientScript com escopo - setOnChangeVariable(cadeia de caracteres sys_id)

Executa o client script do catálogo quando um valor de variável é atualizado.

Tabela 20. Parâmetros

Nome	Tipo	Descrição
sys_id	Cadeia de caracteres	Sys_id da variável.

Tabela 21. Retorna

Tipo	Descrição
vazio

Exemplo

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

CatalogClientScript com escopo - setVariableSet(cadeia de caracteres sys_id)

Associa um conjunto de variáveis ao client script do catálogo.

Tabela 22. Parâmetros

Nome	Tipo	Descrição
sys_id	Cadeia de caracteres	Sys_id do conjunto de variáveis.

Tabela 23. Retorna

Tipo	Descrição
vazio

Exemplo

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