API de propriedade - ServiceNow Fluent

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 3 min. de leitura

    • A API de propriedade inclui objetos que definem propriedades do sistema [sys_properties].

    Objeto de propriedade

    Adicione propriedades do sistema [sys_properties] para configurar aspectos de uma aplicação.

    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.
    nome Cadeia de caracteres Obrigató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 opções, 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 opção. Esta propriedade só se aplica se a propriedade de tipo estiver definida como lista de opções.

    Se você precisar de um rótulo e valor de opção diferentes, use um sinal de igual (=) para separar o rótulo do valor. Por exemplo, ['Azul=0000FF', 'Vermelho=FF0000', 'Verde=00FF00'] exibe Azul, Vermelhoe Verde na lista e salva o valor hexadecimal correspondente no campo de valor da propriedade.
    funções Objeto Os identificadores de variáveis de objetos de função ou nomes de funções que têm acesso de leitura ou gravação à propriedade. Para obter mais informações, consulte API de função - ServiceNow Fluent.
    roles: {
   read: [activity_admin, 'app_user'],
   write: [admin]
}
    ignorarCache Booliano Sinalizador que indica se o cache deve ser liberado quando o valor da propriedade estiver 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 a liberação 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 da liberação de todos os caches e da recuperação de novos valores de propriedade. Geralmente, você só deve definir esta propriedade como verdadeira quando tiver uma propriedade do sistema que muda com mais frequência de uma vez por mês e o valor da propriedade só for armazenado na tabela da tabela Propriedades do sistema [sys_properties].
    • 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 falsa 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 de 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

    		 
    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 o objeto Função :
    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', 
   contains_roles: [managerRole] 
})