Client Script API - ServiceNow Fluent

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 4 min. de leitura

    • A API de script do cliente define scripts do lado do cliente [sys_script_client] que executam JavaScript no cliente (navegador da web) quando ocorrem eventos baseados em cliente, como quando um formulário é carregado, após o envio do formulário ou quando um campo muda de valor.

    Para obter informações gerais sobre scripts de cliente, consulte Client scripts.

    Objeto ClientScript

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

    Tabela 1. Propriedades
    Nome Tipo Descrição
    id Cadeia de caracteres ou número Necessário. Um ID exclusivo para o objeto de metadados. Quando você cria a aplicação, este ID é hash em um sys_id exclusivo. Para obter mais informações, consulte ServiceNow Fluent construções de linguagem.

    Formato: Now.ID['Cadeia de caracteres' ou número]

    tabela Cadeia de caracteres Necessário. O nome da tabela na qual o script do cliente é executado.
    nome Cadeia de caracteres Necessário. O nome do script do cliente.
    ativo Booliano Sinalizador que indica se o script do cliente está habilitado.
    Valores válidos:
    • Verdadeiro: O script está habilitado.
    • Falso: O script não está habilitado.

    Padrão: verdadeiro
    Aplicações Estendidas 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
    UIType Cadeia de caracteres A interface do usuário à qual o script do cliente se aplica.
    Valores válidos:
    • desktop
    • mobile_or_service_portal
    • tudo

    Padrão: Desktop
    descrição Cadeia de caracteres Uma descrição da funcionalidade e da finalidade do script do cliente.
    mensagens Cadeia de caracteres Cadeias de caracteres de texto que estão disponíveis para o script do cliente como mensagens localizadas usando getmessage('[message]') . Para obter mais informações, consulte Traduza uma mensagem de script do cliente .
    IsolateScript Booliano Sinalizador que indica se o script é executado em modo estrito, com acesso ao DOM direto, jQuery, protótipo e ao objeto window desativado.
    Valores válidos:
    • Verdadeiro: Isole o script e não o execute no modo estrito.
    • Falso: Execute o script no modo estrito.

    Padrão: falso
    script Script Um script do lado do cliente que é executado no navegador. Esta propriedade oferece suporte a JavaScript em linha ou a uma referência a outro arquivo na aplicação que contém um script.
    Formato:
    • Para usar conteúdo de texto de outro arquivo, consulte um arquivo na aplicação usando o seguinte formato: Now.include('path/to/file') . Para obter mais informações, consulte ServiceNow Fluent construções de linguagem.
    • Para fornecer um script em linha, use literais de cadeia de caracteres ou literais de modelo para várias linhas de código: "Script" ou "Script" .
    global Booliano Sinalizador que indica em quais exibições da tabela o script do cliente é 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 em que o script do cliente é executado. Esta propriedade se aplica somente quando global a propriedade está definida como falsa.
    tipo Cadeia de caracteres O tipo de client script, que define quando ele é executado. Para obter mais informações sobre os tipos compatíveis, consulte Client scripts.
    Valores válidos:
    • OnCellEdit: É executado quando o editor de lista muda o valor de uma célula.
    • Onchange: É executado quando um determinado valor de campo muda no formulário.
    • OnLoad: É executado quando o sistema renderiza o formulário pela primeira vez e antes que os usuários possam inserir dados. Em geral, OnLoad() os scripts de cliente executam a manipulação do lado do cliente do formulário atual ou definem valores de registro padrão.
    • OnSubmit: É executado quando um formulário é enviado. Em geral, OnSubmit() os scripts validam itens no formulário e garantem que o envio faça sentido. Um OnSubmit() o script do cliente pode cancelar o envio do formulário retornando um valor falso.
    Assunto: Cadeia de caracteres Um campo na tabela ao qual o script do cliente se aplica. Esta propriedade se aplica somente quando tipo A propriedade está definida como onChange ou onCellEdit.
    meta Objeto Metadados dos metadados da aplicação.
    Com o. Método de instalação , você pode mapear os metadados da aplicação para um diretório de saída que carrega somente em circunstâncias específicas.
    $meta: {
      installMethod: 'String'
}
    Valores válidos para Método de instalação :
    • Demonstração: Gera os metadados da aplicação para o. metadados/unload.demo diretório a ser instalado com a aplicação quando Carregar dados de demonstração a opção está selecionada.
    • Primeira instalação: Gera os metadados da aplicação para o. metadados/descarregamento diretório a ser instalado somente na primeira vez que uma aplicação for instalada em uma instância.
    		 
    import { ClientScript } from '@servicenow/sdk/core'

export const cs = ClientScript({
   $id: Now.ID['my_scripts'], 
   name: 'my_scripts',
   table: 'incident',
   active: true, 
   appliesExtended: false, 
   global: true,
   uiType: 'all', 
   messages: '', 
   isolateScript: false, 
   type: 'onLoad',
   script: Now.include('../client/client-script.js'),
})
    O script do cliente é definido no client-script.js arquivo referenciado a partir de script propriedade. Por exemplo:
    function onLoad() { 
    const x = 'util' g_form.addInfoMessage(x) 
}