작업 공간 API - ServiceNow Fluent

  • 릴리스 버전: Australia
  • 업데이트 날짜 2026년 03월 12일
  • 소요 시간: 10분

    • 작업 공간 API는 데이터를 시각적으로 구성하고 공유하기 위한 구성 가능한 작업 공간 환경을 정의합니다.

    주:
    최신 ServiceNow Fluent API 설명서 및 예제는 ServiceNow Fluent API 참조 및 ServiceNow SDK 예제 리포지토리 는 의 위치에 있습니다 GitHub.

    작업 공간 API는 작업 공간 정의에 따라 다음 테이블에 애플리케이션 메타데이터를 생성합니다. UX 애플리케이션 [sys_ux_page_registry], UX 앱 구성 [sys_ux_app_config], UX 애플리케이션 범주 M2M [sys_ux_registry_m2m_category], UX 페이지 속성 [sys_ux_page_property], UX 화면 컬렉션 [sys_ux_screen_type], UX 앱 경로 [sys_ux_app_route], UX 화면 [sys_ux_screen] 및 UX macroponent 정의 [sys_ux_macroponent]

    대시보드는 대시보드 개체의 가시성 배열에서 하나 이상의 작업 공간을 참조하여 작업 공간의 홈 페이지로 사용할 수 있습니다. 대시보드를 생성하려면 다음 문서를 참조하십시오 대시보드 API - ServiceNow Fluent.

    작업 공간에 대한 일반적인 정보는 다음 문서를 참조하십시오 Configurable Workspace UI.

    작업 공간 객체

    사용자가 전체 작업을 완료할 수 있도록 하는 단일 중점 작업 영역에서 비즈니스 엔터티를 관리하기 위한 작업 공간을 생성합니다.

    표 1. 속성
    이름 유형 설명
    $id 문자열 또는 숫자 필수 메타데이터 객체의 고유 ID입니다. 애플리케이션을 빌드할 때 이 ID는 고유한 sys_id으로 해시됩니다. 자세한 내용은 ServiceNow Fluent 언어 구성 문서를 참조하십시오.

    형식: Now.ID['문자열' 또는 숫자]
    직위 문자열 필수 탐색 및 헤더에 표시되는 작업 공간의 이름입니다.
    경로 문자열 필수 작업 공간의 URL 경로 세그먼트입니다. 작업 공간 URL은 /now/<path>/<landingPath> 패턴을 따르며 케밥 케이스를 사용합니다.

    작업 공간에는 작업 공간 경로를 보호하기 위한 ACL(접근 제어 목록)이 필요합니다. Acl 객체의 필드 속성은 와일드카드 패턴이 있는 이 속성의 값과 일치해야 합니다. {workspace.path}.*.
    tables 배열 필수 작업 공간에서 관리할 테이블 이름의 목록입니다.
    목록 구성 참조 필수 작업 공간의 탐색 구조를 정의하는 UxListMenuConfig 객체의 변수 식별자입니다. 자세한 내용은 UxListMenuConfig 객체 문서를 참조하십시오.
    방문 경로 문자열 방문 페이지의 URL 경로 세그먼트입니다. 작업 공간 URL은 /now/<path>/<landingPath> 패턴을 따르며 케밥 케이스를 사용합니다.

    기본값: home
    활성 부울 사용자가 작업 공간에 액세스할 수 있는지 여부를 나타내는 플래그입니다.

    기본값: 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
})

    참조된 UX 목록 메뉴 구성은 UxListMenuConfig 객체를 사용하여 정의됩니다.

    UxListMenuConfig 객체

    작업 공간의 탐색 구조 및 목록 뷰에 대한 UX 목록 메뉴 구성[sys_ux_list_menu_config]을 정의합니다.

    UX 목록 메뉴 구성은 데이터를 범주와 목록으로 구성하여 사용자가 필터링, 열 선택 및 역할 기반 가시성을 사용하여 비즈니스 데이터의 다양한 뷰에 액세스할 수 있도록 합니다. 이 구조는 작업 공간의 탐색 패널에 표시되어 다양한 데이터 뷰에 대한 체계적인 액세스를 제공합니다.

    표 2. 속성
    이름 유형 설명
    $id 문자열 또는 숫자 필수 메타데이터 객체의 고유 ID입니다. 애플리케이션을 빌드할 때 이 ID는 고유한 sys_id으로 해시됩니다. 자세한 내용은 ServiceNow Fluent 언어 구성 문서를 참조하십시오.

    형식: Now.ID['문자열' 또는 숫자]
    이름 문자열 필수 목록 구성의 이름입니다.
    설명 문자열 목록 구성에 대한 설명입니다.
    활성 부울 목록 구성이 활성 상태인지 여부를 나타내는 플래그입니다.

    기본값: true
    categories 배열 목록 구성의 최상위 그룹화 목록입니다. 자세한 내용은 범주 배열 문서를 참조하십시오. 
    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
                        }
                    ]
                }
            ]
        }
    ]
})

    범주 배열

    UX 목록 메뉴 구성에 대한 관련 목록 범주 [sys_ux_list_category]를 정의합니다.

    표 3. 속성
    이름 유형 설명
    $id 문자열 또는 숫자 필수 메타데이터 객체의 고유 ID입니다. 애플리케이션을 빌드할 때 이 ID는 고유한 sys_id으로 해시됩니다. 자세한 내용은 ServiceNow Fluent 언어 구성 문서를 참조하십시오.

    형식: Now.ID['문자열' 또는 숫자]
    직위 문자열 필수 탐색 메뉴에 표시할 범주의 제목입니다.
    목록 배열 필수 범주의 목록 뷰 목록입니다. 자세한 내용은 목록 배열 문서를 참조하십시오.
    순서 번호 탐색 메뉴에서 범주의 위치를 나타내는 숫자입니다. 숫자가 낮은 범주가 먼저 표시됩니다.
    활성 부울 범주가 탐색 메뉴에 표시되는지 여부를 나타내는 플래그입니다.

    기본값: true
    설명 문자열 범주에 대한 설명입니다. 
    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
            }
          ]
        }
]

    목록 배열

    UX 목록 메뉴 구성에 대한 필터링 및 열 구성을 사용하여 테이블 데이터 [sys_ux_list]의 목록 뷰를 정의합니다.

    표 4. 속성
    이름 유형 설명
    $id 문자열 또는 숫자 필수 메타데이터 객체의 고유 ID입니다. 애플리케이션을 빌드할 때 이 ID는 고유한 sys_id으로 해시됩니다. 자세한 내용은 ServiceNow Fluent 언어 구성 문서를 참조하십시오.

    형식: Now.ID['문자열' 또는 숫자]
    직위 문자열 필수 탐색 메뉴에 표시할 목록의 제목입니다.
    테이블 문자열 필수 목록에 사용할 테이블의 이름입니다.
    열 문자열 목록에 표시할 열 이름의 목록이며 콤마로 구분됩니다.
    조건 문자열 목록에 표시되는 기록을 필터링하기 위한 인코딩된 쿼리 문자열입니다.
    순서 번호 해당 범주 내에서 목록의 위치를 나타내는 숫자입니다. 숫자가 낮은 목록이 먼저 나타납니다.
    활성 부울 사용자에게 목록이 표시되는지 여부를 나타내는 플래그입니다.

    기본값: true
    적용 가능성 배열 목록을 볼 수 있는 역할을 제어하는 적용 가능성 개체의 변수 식별자 목록입니다. 자세한 내용은 적용 가능성 객체 문서를 참조하십시오. 
    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
            }
          ]
  }
]

    적용 가능성 객체

    UX 목록 메뉴 구성에서 목록을 볼 수 있는 대상 [sys_ux_applicability]을 정의합니다.

    표 5. 속성
    이름 유형 설명
    $id 문자열 또는 숫자 필수 메타데이터 객체의 고유 ID입니다. 애플리케이션을 빌드할 때 이 ID는 고유한 sys_id으로 해시됩니다. 자세한 내용은 ServiceNow Fluent 언어 구성 문서를 참조하십시오.

    형식: Now.ID['문자열' 또는 숫자]
    이름 문자열 필수 적용 가능성 규칙의 이름입니다.
    설명 문자열 대상에 대한 설명입니다.
    활성 부울 적용 가능성 규칙이 적용되었는지 여부를 나타내는 플래그입니다.

    기본값: true
    역할 배열 사용자가 목록을 보기 위해 가져야 하는 역할 객체 또는 역할 sys_ids의 변수 식별자 목록입니다. 자세한 내용은 역할 API - ServiceNow Fluent 문서를 참조하십시오.
    roleNames 문자열 사용자가 목록을 볼 수 있어야 하는 역할 이름의 목록이며 쉼표로 구분됩니다. 이 속성은 roles 속성의 대체 속성입니다. 
    import { Applicability } from '@servicenow/sdk/core';

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

    참조된 역할은 Role 객체를 사용하여 정의됩니다.

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

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