API de client script - ServiceNow Fluent

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 2 min. de leitura
  • A API Client Script inclui objetos que definem scripts de cliente [sys_script_client] que executam JavaScript no cliente (navegador da Web) quando ocorrem eventos baseados no cliente, como quando um formulário é carregado, após o envio do formulário ou quando um campo muda de valor.

    Objeto ClientScript

    Crie um client script [sys_script_client] para configurar formulários, campos de formulário e valores de campos enquanto o usuário está usando o formulário.

    Tabela 1. Propriedades
    Nome Tipo Descrição
    $id Cadeia de caracteres ou número Obrigatório. Um ID exclusivo para o objeto de metadados fornecido no seguinte formato, em que<value> é uma cadeia de caracteres ou um número.
    $id: Now.ID[<value>]

    Quando você cria a aplicação, esse ID é convertido em um sys_ID exclusivo.

    tabela Cadeia de caracteres Obrigatório. O nome da tabela na qual o client script é executado.
    nome Cadeia de caracteres Obrigatório. O nome do client script.
    ativo Booliano Sinalizador que indica se o client script está habilitado.
    Valores válidos:
    • verdadeiro: o script está habilitado.
    • falso: o script não está habilitado.

    Padrão: verdadeiro

    aplica-se_estendido Booliano Sinalizador que indica se o script do cliente se aplica a tabelas estendidas da tabela especificada.
    Valores válidos:
    • verdadeiro: o script se aplica a tabelas estendidas.
    • falso: o script não se aplica a tabelas estendidas.

    Padrão: falso

    iu_type Cadeia de caracteres A interface do usuário à qual o client script se aplica.

    Valores válidos: desktop, mobile_or_service_portal, all

    Padrão: desktop

    descrição Cadeia de caracteres Uma descrição da funcionalidade e da finalidade do client script.
    mensagens Cadeia de caracteres Cadeias de caracteres de texto que estão disponíveis para o client script como mensagens localizadas usando getmessage('[message]'). Para obter mais informações, consulte Traduzir uma mensagem de client script.
    isolar_script Booliano Sinalizador que indica se os scripts são executados no modo estrito, com acesso ao DOM direto, jQuery, prototype e ao objeto de janela desativados.
    Valores válidos:
    • verdadeiro: isola o script e não o executa no modo estrito.
    • falso: execute o script no modo estrito.

    Padrão: falso

    script Script Um script em linha precedido por um marcador de script no seguinte formato:
    script: script`gs.info('info')`,
    Nota:
    A importação de funções de módulos JavaScript ou bibliotecas de terceiros não é compatível com client scripts.
    global Booliano Sinalizador que indica em quais exibições da tabela o client script é executado.
    Valores válidos:
    • verdadeiro: o script é executado em todas as exibições.
    • falso: o script é executado somente nas exibições especificadas.

    Padrão: verdadeiro

    exibição Cadeia de caracteres As exibições da tabela na qual o client script é executado. Esta propriedade se aplica somente quando a propriedade global está definida como falsa.
    tipo Cadeia de caracteres O tipo de client script, que define quando ele é executado. Para obter informações sobre os tipos compatíveis, consulte Client scripts.

    Valores válidos: onCellEdit, onChange, onLoad, onSubmit

    Assunto: Cadeia de caracteres Um campo na tabela ao qual o client script se aplica. Esta propriedade se aplica somente quando a propriedade de tipo está definida como onChange ou onCellEdit.
    import { ClientScript } from '@servicenow/sdk/core'
    
    export const cs = ClientScript({
       $id: Now.ID['my_scripts'], 
       name: 'my_scripts',
       table: 'incident',
       active: true, 
       applies_extended: false, 
       global: true,
       ui_type: 'all', 
       messages: '', 
       isolate_script: false, 
       type: 'onLoad',
       script: script`function onLoad() { const x = 'util' g_form.addInfoMessage(x) }`,
    })