Espace de travail API : ServiceNow Fluent

L’API Workspace définit des expériences d’espace de travail configurables pour organiser et partager visuellement des données.

Remarque :

Pour obtenir la documentation et des exemples d’API les plus récents ServiceNow Fluent , consultez les ServiceNow Fluent Référence API et référentiel d’exemples de SDK ServiceNow sur GitHub.

L’API de l’espace de travail crée des métadonnées d’application dans les tables suivantes en fonction de la définition de l’espace de travail : application UX [sys_ux_page_registry], configuration d’application UX [sys_ux_app_config], catégorie d’application UX M2M [sys_ux_registry_m2m_category], propriété de page UX [sys_ux_page_property], collection d’écrans UX [sys_ux_screen_type], chemin de l’application UX [sys_ux_app_route], Écran UX [sys_ux_screen] et Définition du macroponent UX [sys_ux_macroponent].

Les tableaux de bord peuvent être utilisés comme page d’accueil d’un espace de travail en faisant référence à un ou plusieurs espaces de travail à partir du tableau de visibilités de l’objet Tableau de bord . Pour créer un tableau de bord, reportez-vous à API du tableau de bord : ServiceNow Fluent.

Pour des informations générales sur les espaces de travail, reportez-vous à la section Configurable Workspace UI.

Concepts associés

• ServiceNow Fluent

Objet d’espace de travail

Créez un espace de travail pour la gestion des entités d’entreprise dans une zone de travail spécifique unique qui permet aux utilisateurs d’effectuer l’intégralité d’une tâche.

Tableau 1. Propriétés

Nom	Type	Description
$id	Chaîne ou numéro	Requis. ID unique pour l’objet de métadonnées. Lorsque vous créez l’application, cet ID est haché en une sys_id unique. Pour en savoir plus, consultez ServiceNow Fluent Constructions linguistiques. Format : Now.ID['chaîne' ou numéro]
Titre	Chaîne	Requis. Nom de l’espace de travail qui apparaît dans la navigation et les en-têtes.
chemin d'accès	Chaîne	Requis. Le segment de chemin d’accès de l’URL de l’espace de travail. Les URL d’espaces de travail suivent le modèle /now/<path>/<landingPath> et utilisent le ticket kebab. Les espaces de travail nécessitent des listes de contrôle d’accès (ACL) pour sécuriser les acheminements des espaces de travail. La propriété de champ d’un objet ACL doit correspondre à la valeur de cette propriété avec un modèle générique : {workspace.path}.*.
tables	Tableau	Requis. Une liste de noms de tables à gérer dans l’espace de travail.
config liste	Référence	Requis. L’identificateur de variable d’un objet UxListMenuConfig qui définit la structure de navigation de l’espace de travail. Pour plus d'informations, consultez Objet UxListMenuConfig.
landingPath	Chaîne	Le segment du chemin d’accès de l’URL de la page de destination. Les URL d’espaces de travail suivent le modèle /now/<path>/<landingPath> et utilisent le ticket kebab. Par défaut : accueil
actif	Booléen	Marqueur indiquant si l’espace de travail est accessible aux utilisateurs. Par défaut : true

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
})

La configuration du menu de la liste UX référencée est définie à l’aide de l’objet UxListMenuConfig .

Objet UxListMenuConfig

Définissez une configuration de menu de liste UX [sys_ux_list_menu_config] pour la structure de navigation et les vues de liste d’un espace de travail.

Une configuration de menu de liste UX organise les données en catégories et en listes, ce qui permet aux utilisateurs d’accéder à différentes vues des données métier avec le filtrage, la sélection de colonnes et la visibilité basée sur les rôles. Cette structure apparaît dans le panneau de navigation de l’espace de travail et permet d’accéder de manière organisée aux différentes vues de données.

Tableau 2. Propriétés

Nom	Type	Description
$id	Chaîne ou numéro	Requis. ID unique pour l’objet de métadonnées. Lorsque vous créez l’application, cet ID est haché en une sys_id unique. Pour en savoir plus, consultez ServiceNow Fluent Constructions linguistiques. Format : Now.ID['chaîne' ou numéro]
nom	Chaîne	Requis. Nom attribué à la configuration de la liste.
description	Chaîne	Description de la configuration de la liste.
actif	Booléen	Marqueur indiquant si la configuration de la liste est active. Par défaut : true
Catégories	Tableau	Liste des regroupements de niveau supérieur dans la configuration de liste. Pour plus d'informations, consultez Tableau de catégories.

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
                        }
                    ]
                }
            ]
        }
    ]
})

Tableau de catégories

Définissez des catégories de listes connexes [sys_ux_list_category] pour une configuration de menu de liste UX.

Tableau 3. Propriétés

Nom	Type	Description
$id	Chaîne ou numéro	Requis. ID unique pour l’objet de métadonnées. Lorsque vous créez l’application, cet ID est haché en une sys_id unique. Pour en savoir plus, consultez ServiceNow Fluent Constructions linguistiques. Format : Now.ID['chaîne' ou numéro]
Titre	Chaîne	Requis. Un titre pour la catégorie à afficher dans le menu de navigation.
listes	Tableau	Requis. Liste des vues de listes de la catégorie. Pour plus d'informations, consultez tableau de listes.
order	Numéro	Numéro indiquant la position de la catégorie dans le menu de navigation. Les catégories avec les numéros les plus faibles apparaissent en premier.
actif	Booléen	Marqueur indiquant si la catégorie est visible dans le menu de navigation. Par défaut : true
description	Chaîne	Description de la catégorie.

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
            }
          ]
        }
]

tableau de listes

Définissez des vues de listes des données de table [sys_ux_list] avec filtrage et des configurations de colonnes pour une configuration de menu de liste UX.

Tableau 4. Propriétés

Nom	Type	Description
$id	Chaîne ou numéro	Requis. ID unique pour l’objet de métadonnées. Lorsque vous créez l’application, cet ID est haché en une sys_id unique. Pour en savoir plus, consultez ServiceNow Fluent Constructions linguistiques. Format : Now.ID['chaîne' ou numéro]
Titre	Chaîne	Requis. Titre de la liste à afficher dans le menu de navigation.
Table	Chaîne	Requis. Nom d’une table à utiliser pour la liste.
colonnes	Chaîne	Liste séparée par des virgules de noms de colonnes à afficher dans la liste.
condition	Chaîne	Chaîne de requête codée pour filtrer les enregistrements affichés dans la liste.
order	Numéro	Numéro indiquant la position de la liste dans sa catégorie. Les listes avec les numéros les plus faibles s’affichent en premier.
actif	Booléen	Marqueur indiquant si la liste est visible par les utilisateurs. Par défaut : true
Applicabilités	Tableau	Liste d’identificateurs de variables des objets d’applicabilité qui contrôlent les rôles autorisés à afficher la liste. Pour plus d'informations, consultez Objet d’applicabilité.

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
            }
          ]
  }
]

Objet d’applicabilité

Définissez l’audience [sys_ux_applicability] qui peut afficher une liste dans la configuration du menu de liste UX.

Tableau 5. Propriétés

Nom	Type	Description
$id	Chaîne ou numéro	Requis. ID unique pour l’objet de métadonnées. Lorsque vous créez l’application, cet ID est haché en une sys_id unique. Pour en savoir plus, consultez ServiceNow Fluent Constructions linguistiques. Format : Now.ID['chaîne' ou numéro]
nom	Chaîne	Requis. Nom de la règle d’applicabilité.
description	Chaîne	Description de l’audience.
actif	Booléen	Marqueur indiquant si la règle d’applicabilité est appliquée. Par défaut : true
roles	Tableau	Liste d’identificateurs de variables d’objets de rôle ou de sys_ids de rôles dont un utilisateur doit disposer pour afficher la liste. Pour plus d'informations, consultez API du rôle : ServiceNow Fluent.
roleNames	Chaîne	Une liste de noms de rôles séparés par des virgules qu’un utilisateur doit avoir pour consulter la liste. Cette propriété est une alternative à la propriété roles .

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

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

Le rôle référencé est défini à l’aide de l’objet Rôle :

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

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