Espaço API - ServiceNow Fluent

. Espaço A API define experiências de espaço configuráveis para organizar e compartilhar dados visualmente.

Nota:

Para o mais recente ServiceNow Fluent Exemplos e documentação da API, consulte ServiceNow Fluent Referência de API e. Repositório de exemplos do SDK da ServiceNow ativado GitHub.

A API do espaço cria metadados da aplicação nas seguintes tabelas, dependendo da definição do espaço: Aplicação UX [sys_ux_page_registry], configuração da aplicação UX [sys_ux_app_config], Categoria da aplicação UX M2M [sys_ux_registry_m2m_category], Propriedade da página UX [sys_ux_page_property], Coleção de tela UX [sys_ux

Os painéis podem ser usados como a página inicial de um espaço consultando um ou mais espaços do visbilidades matriz de Painel objeto. Para criar um painel, consulte API do painel - ServiceNow Fluent.

Para obter informações gerais sobre espaços de trabalho, consulte Configurable Workspace UI.

Conceitos relacionados

• ServiceNow Fluent

Espaço objeto

Crie um espaço para gerenciar entidades de negócios em uma única área de trabalho focada que permita que os usuários concluam um trabalho inteiro.

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]
título	Cadeia de caracteres	Necessário. Um nome para o espaço que aparece na navegação e nos cabeçalhos.
caminho	Cadeia de caracteres	Necessário. O segmento do caminho da URL do espaço. Os URLs do espaço seguem o padrão /Now/<path>/<landingPath> e usar caso de kebab. Os espaços exigem listas de controle de acesso (ACLs) para proteger as rotas do espaço. . campo propriedade de um ACL o objeto deve corresponder ao valor desta propriedade com um padrão curinga: (espaço.caminho).* .
tabelas	Matriz	Necessário. Uma lista de nomes de tabela para gerenciar no espaço.
ListConfig	Referência	Necessário. O identificador de variável de um UxListMenuConfig objeto que define a estrutura de navegação do espaço. Para obter mais informações, consulte UxListMenuConfig objeto.
LandingPath	Cadeia de caracteres	O segmento do caminho do URL da página principal. Os URLs do espaço seguem o padrão /Now/<path>/<landingPath> e usar caso de kebab. Padrão: Página inicial
ativo	Booliano	Sinalizador que indica se o espaço está acessível aos usuários. Padrão: verdadeiro

import { Workspace } from '@servicenow/sdk/core';

const itsmWorkspace = Workspace({
    $id: Now.ID['itsm_workspace'],
    title: 'IT Service Management',
    path: 'itsm',
    tables: ['incident', 'problem', 'change_request', 'user', 'sys_user_group'],
    listConfig: incidentListConfig
})

A configuração do menu da lista de UX referenciada é definida usando UxListMenuConfig objeto.

UxListMenuConfig objeto

Defina uma configuração de menu de lista de UX [sys_ux_list_menu_config] para a estrutura de navegação e exibições de lista de um espaço.

Uma configuração de menu de lista de UX organiza os dados em categorias e listas, permitindo que os usuários acessem diferentes exibições de dados de negócios com filtragem, seleção de coluna e visibilidade baseada em função. Essa estrutura aparece no painel de navegação do espaço, fornecendo acesso organizado a diferentes exibições de dados.

Tabela 2. 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. Um nome para a configuração da lista.
descrição	Cadeia de caracteres	Uma descrição da configuração da lista.
ativo	Booliano	Sinalizador que indica se a configuração da lista está ativa. Padrão: verdadeiro
categorias	Matriz	Uma lista de agrupamentos de nível superior na configuração da lista. Para obter mais informações, consulte categorias matriz.

import { UxListMenuConfig } from '@servicenow/sdk/core';

const incidentListConfig = UxListMenuConfig({
    $id: Now.ID['incident_list_config'],
    name: 'Incident List Configuration',
    description: 'Navigation for Incident Workspace',
    categories: [
        {
            $id: Now.ID['incidents_category'],
            title: 'Incidents',
            order: 10,
            lists: [
                {
                    $id: Now.ID['incidents_open'],
                    title: 'Open',
                    order: 10,
                    condition: 'active=true^EQ',
                    table: 'incident',
                    columns: 'number,short_description,priority,state',
                    applicabilities: [
                        {
                            $id: Now.ID['incidents_open_applicability'],
                            applicability: applicability
                        }
                    ]
                }
            ]
        }
    ]
})

categorias matriz

Defina categorias de listas relacionadas [sys_ux_list_category] para uma configuração de menu de lista de UX.

Tabela 3. 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]
título	Cadeia de caracteres	Necessário. Um título da categoria a ser exibida no menu de navegação.
listas	Matriz	Necessário. Uma lista de exibições de lista na categoria. Para obter mais informações, consulte listas matriz.
pedido	Número	Um número que indica a posição da categoria no menu de navegação. As categorias com números mais baixos aparecem primeiro.
ativo	Booliano	Sinalizador que indica se a categoria está visível no menu de navegação. Padrão: verdadeiro
descrição	Cadeia de caracteres	Uma descrição da categoria.

categories: [
    {
      $id: Now.ID["incidents_category"],
      title: "Incidents",
      order: 10,
      lists: [
        {
          $id: Now.ID["incidents_open"],
          title: "Open",
          order: 10,
          condition: "active=true^EQ",
          table: "incident",
          columns: "number,short_description,priority,state",
          applicabilities: [
            {
              $id: Now.ID["incidents_open_applicability"],
              applicability: applicability
            }
          ]
        },
        {
          $id: Now.ID["incidents_all"],
          title: "All",
          order: 20,
          condition: "",
          table: "incident",
          columns: "number,short_description,priority,state",
          applicabilities: [
            {
              $id: Now.ID["incidents_all_applicability"],
              applicability: applicability
            }
          ]
        }
]

listas matriz

Defina exibições de lista de dados da tabela [sys_ux_list] com configurações de filtragem e coluna para uma configuração de menu de lista de UX.

Tabela 4. 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]
título	Cadeia de caracteres	Necessário. Um título da lista a ser exibida no menu de navegação.
tabela	Cadeia de caracteres	Necessário. O nome de uma tabela a ser usada para a lista.
colunas	Cadeia de caracteres	Uma lista separada por vírgulas de nomes de colunas para exibir na lista.
condição	Cadeia de caracteres	Uma cadeia de caracteres de consulta codificada para filtrar os registros exibidos na lista.
pedido	Número	Um número que indica a posição da lista em sua categoria. As listas com números mais baixos aparecem primeiro.
ativo	Booliano	Sinalizador que indica se a lista está visível para os usuários. Padrão: verdadeiro
aplicabilidades	Matriz	Uma lista de identificadores de variáveis de Aplicabilidade objetos que controlam quais funções podem exibir a lista. Para obter mais informações, consulte Aplicabilidade objeto.

lists: [
        {
          $id: Now.ID["assets_active"],
          title: "Active",
          order: 10,
          condition: "install_status=1",
          table: "alm_asset",
          columns: "asset_tag,display_name,model_category,assigned_to",
          applicabilities: [
            {
              $id: Now.ID["assets_active_applicability"],
              applicability: assetApplicability
            }
          ]
        },
        {
          $id: Now.ID["assets_all"],
          title: "All",
          order: 20,
          condition: "",
          table: "alm_asset",
          columns: "asset_tag,display_name,model_category,assigned_to",
          applicabilities: [
            {
              $id: Now.ID["assets_all_applicability"],
              applicability: assetApplicability
            }
          ]
  }
]

Aplicabilidade objeto

Defina o público [sys_ux_applicability] que pode exibir uma lista na configuração do menu de lista de UX.

Tabela 5. 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. Um nome para a regra de aplicabilidade.
descrição	Cadeia de caracteres	Uma descrição do público.
ativo	Booliano	Sinalizador que indica se a regra de aplicabilidade foi aplicada. Padrão: verdadeiro
funções	Matriz	Uma lista de identificadores de variáveis de Função objetos ou sys_ids de funções que um usuário deve ter para exibir a lista. Para obter mais informações, consulte API de função - ServiceNow Fluent.
roleNames	Cadeia de caracteres	Uma lista separada por vírgulas de nomes de função que um usuário deve ter para exibir a lista. Esta propriedade é uma alternativa para funções propriedade.

import { Applicability } from '@servicenow/sdk/core';

const managerApplicability = Applicability({
    $id: Now.ID['manager_applicability'],
    name: 'Managers Only',
    roles: [managerRole]
})

A função referenciada é definida usando Função objeto:

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

const managerRole = Role({
    $id: Now.ID['manager_user_role'],
    name: 'x_snc_manager.user',
    containsRoles: ['canvas_user']
})