API de propriedade - ServiceNow Fluent

A API de propriedade define as propriedades do sistema [sys_properties] que controlam o comportamento da instância.

Para obter informações gerais sobre propriedades do sistema, consulte Add a system property.

Conceitos relacionados

• ServiceNow Fluent

Objeto de propriedade

Adicione uma propriedade do sistema [sys_properties] para configurar um aspecto de uma aplicação.

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]
nome	Cadeia de caracteres	Necessário. O nome da propriedade que começa com o escopo da aplicação no seguinte formato: <scope>.<name> .
valor	Qualquer	Um valor para a propriedade. O valor deve ser o tipo de dados correto. Todos os valores de propriedade são armazenados como cadeias de caracteres. Ao recuperar propriedades por meio do método gs.getProperty (), trate os resultados como cadeias de caracteres. Por exemplo, uma propriedade verdadeiro|falso retorna "verdadeiro" ou "falso" (cadeias de caracteres), não o equivalente booliano.
tipo	Cadeia de caracteres	Um tipo de dados para o valor da propriedade. Valores válidos: Cadeia de caracteres, inteiro, booliano, lista de seleção, cor, date_format, imagem, senha, password2, short_string, time_format, timezone, uploaded_image
descrição	Cadeia de caracteres	Uma descrição do que a propriedade faz.
escolhas	Matriz	Uma lista separada por vírgulas de valores de escolha. Esta propriedade só se aplica se tipo a propriedade está definida como lista de escolhas . Se você precisar de um rótulo e valor de escolha diferentes, use um sinal de igual para separar o rótulo do valor. Por exemplo, "Azul", "Vermelho", "Verde"] exibido Azul , Vermelho , e. Verde na lista, e salva o valor hexadecimal correspondente no campo valor da propriedade.
funções	Objeto	Os identificadores de variáveis de Função objetos ou nomes de funções que têm acesso de leitura ou gravação à propriedade. Por exemplo: roles: { read: [activity_admin, 'app_user'], write: [admin] } Para obter mais informações, consulte API de função - ServiceNow Fluent.
IgnoreCache	Booliano	Sinalizador que indica se o flush deve ser armazenado em cache quando o valor da propriedade é definido. O sistema armazena valores de propriedade do sistema em caches do lado do servidor para evitar a consulta de definições de configuração no banco de dados. Quando você altera um valor de propriedade do sistema, o sistema limpa o cache da tabela Propriedades do sistema [sys_properties]. Use este campo para determinar se o valor desta propriedade deve ser liberado de todos os outros caches do lado do servidor. Valores válidos: Verdadeiro: O sistema ignora o flushing de alguns caches do lado do servidor, liberando somente o cache da tabela Propriedades do sistema [sys_properties] e preservando o valor da propriedade anterior em todos os outros caches. Esta opção evita o custo de desempenho de limpar todos os caches e recuperar novos valores de propriedade. Em geral, você só deve definir esta propriedade como verdadeiro Quando você tem uma propriedade do sistema que muda com mais frequência do que uma vez por mês e o valor da propriedade é armazenado somente na tabela Propriedades do sistema [sys_properties] tabela. Falso: O sistema limpa todos os caches do lado do servidor e recupera o valor da propriedade atual do banco de dados. Defina esta propriedade como falso para que todos os caches tenham o valor da propriedade atual. Padrão: falso
ÉPrivado	Booliano	Sinalizador que indica se a propriedade deve ser excluída da importação por meio de conjuntos de atualizações. Manter as propriedades do sistema privadas ajuda a impedir que as configurações em uma instância substituam valores em outra instância. Por exemplo, talvez você não queira que uma propriedade do sistema em uma instância de desenvolvimento use o mesmo valor que uma instância de produção. Valores válidos: Verdadeiro: A propriedade não está incluída nos conjuntos de atualizações. Falso: A propriedade está incluída nos conjuntos de atualizações. Padrão: falso
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 { Property } from '@servicenow/sdk/core'

Property({
   $id: Now.ID['1234'],
   name: 'x_snc_app.some.new.prop',
   type: 'string',
   value: 'hello',
   description: 'A new property',
   roles: {
      read: ['admin'],
      write: [adminRole, managerRole],
   },
   ignoreCache: false,
   isPrivate: false,
})

As funções referenciadas são definidas usando Função objeto:

import { Role } from "@servicenow/sdk/core";

const managerRole = Role({ 
   $id: Now.ID['manager_role'], 
   name: 'x_snc_example.manager' 
})

const adminRole = Role({ 
   $id: Now.ID['admin_role'], 
   name: 'x_snc_example.admin', 
   containsRoles: [managerRole] 
})