ServiceNow Fluent

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 3 min. de leitura

    • Defina metadados da aplicação no código de origem usando a linguagem de programação específica do domínio ServiceNow Fluent.

    Visão geral do ServiceNow Fluent

    ServiceNow Fluent é uma linguagem específica de domínio (DSL) baseada em TypeScript para definir os arquivos de metadados [sys_metadata] que compõem as aplicações e inclui APIs para os diferentes tipos de metadados, como tabelas, funções, ACLs, regras de negócio e Automated Test Framework testes.

    Os desenvolvedores definem esses metadados em algumas linhas de código, em vez de por meio de um formulário ou interface do usuário da ferramenta do construtor. As aplicações criadas ou convertidas com ServiceNow IDE ou ServiceNow SDK são compatíveis com o desenvolvimento em ServiceNow Fluent.

    ServiceNow Fluent oferece suporte à sincronização bidirecional, o que permite que as mudanças nos metadados sejam sincronizadas de outras Now Platform interfaces de usuário no código de origem e as mudanças no código de origem sejam sincronizadas novamente com os metadados na instância.
    Nota:
    A API de teste Automated Test Framework oferece suporte somente à sincronização unidirecional. Depois de definir um teste de ATF no código de origem, se os metadados forem modificados fora do código de origem, essas mudanças não serão sincronizadas e refletidas no código de origem.

    Para começar a usar ServiceNow IDE ou ServiceNow SDK, consulte a documentação ServiceNow IDE ou ServiceNow SDK.

    APIs

    ServiceNow Fluent inclui APIs para os seguintes tipos de metadados. Você pode usar a API de registro para definir metadados de aplicações que não têm uma API dedicada.

    Para obter detalhes sobre as APIs e exemplos, consulte ServiceNow Fluent Referência de API e o repositório de exemplos do SDK da ServiceNow GitHub.

    • Listas de controle de acesso (ACLs)
    • Menus da aplicação
    • Testes Automated Test Framework
    • Regras de negócio
    • Scripts de cliente
    • Listas
    • Propriedades
    • Registros
    • Funções
    • Scripted REST APIs
    • Tabelas

    Uso

    Em arquivos com a extensão .now.ts, use objetos nas APIs ServiceNow Fluent para definir metadados na aplicação. Você também deve incluir as importações necessárias para as APIs de @servicenow/sdk/core.

    O exemplo a seguir inclui as definições de uma tabela, client script e regra de negócio na aplicação. A regra de negócio usa uma função do módulo JavaScript script.js.
    import '@servicenow/sdk/global'
import { BusinessRule } from '@servicenow/sdk/core'
import { ClientScript } from '@servicenow/sdk/core'
import { Table, DateColumn, StringColumn } from '@servicenow/sdk/core'
import { showStateUpdate } from '../server/script.js'

//creates todo table, with three columns (deadline, status and task)
export const x_snc_example_to_do = Table({
    name: 'x_snc_example_to_do',
    schema: {
        deadline: DateColumn({ label: 'deadline' }),
        state: StringColumn({
            label: 'State',
            choices: {
                ready: { label: 'Ready' },
                completed: { label: 'Completed' },
                in_progress: { label: 'In Progress' },
            },
        }),
        task: StringColumn({ label: 'Task', maxLength: 120 }),
    },
})

//creates a client script that pops up 'Table loaded successfully!!' message everytime todo record is loaded
ClientScript({
    $id: Now.ID['cs0'],
    name: 'my_client_script',
    table: 'x_snc_example_to_do',
    active: true,
    applies_extended: false,
    global: true,
    ui_type: 'all',
    description: 'Custom client script generated by Now SDK',
    messages: '',
    isolate_script: false,
    type: 'onLoad',
    script: script`function onLoad() {
        g_form.addInfoMessage("Table loaded successfully!!")
    }`,
})

//creates a business rule that pops up state change message whenever a todo record is updated
BusinessRule({
    $id: Now.ID['br0'],
    action: ['update'],
    table: 'x_snc_example_to_do',
    script: showStateUpdate,
    name: 'LogStateChange',
    order: 100,
    when: 'after',
    active: true,
})

    Depois de criar a aplicação, este código de origem gera os seguintes arquivos de metadados da aplicação na instância.

    Figura 1. Metadados da aplicação gerados a partir do código ServiceNow Fluent
    Arquivos de aplicações gerados a partir do código de exemplo.
    Dica:
    Você pode usar as seguintes diretivas em um comentário de código para ajudar a gerenciar seu código:
    • @fluent-ignore: suprime ServiceNow Fluent avisos de diagnóstico e erros na linha de código a seguir.
    • @fluent-disable-sync: desativa a sincronização de mudanças para um objeto ServiceNow Fluent. Use antes de uma expressão de chamada (por exemplo, Record({ ... })) para desativar a sincronização desse objeto e de seus objetos secundários. Use esta diretiva somente se quiser ignorar as mudanças feitas fora do código de origem no objeto e nunca atualizá-lo durante a sincronização.
    • @fluent-disable-sync-for-file: desativa a sincronização de mudanças para um arquivo ServiceNow Fluent (.now.ts). Use na primeira linha do arquivo para desativar a sincronização de todos os códigos no arquivo. Use esta diretiva somente se quiser ignorar as mudanças feitas fora do código de origem no arquivo e nunca atualizá-lo durante a sincronização.