소스 코드로 애플리케이션 빌드

  • 릴리스 버전: Zurich
  • 업데이트 날짜 2025년 01월 30일
  • 소요 시간: 13분

    • 익숙한 개발 도구 및 프로세스를 사용하여 소스 코드로 사용자 지정 애플리케이션을 생성하고 개발합니다.

    소스 코드 개발 개요

    를 사용하여 ServiceNow IDEServiceNow AI Platform 코드에서 범위가 지정된 애플리케이션을 만들거나 데스크톱ServiceNow SDK에서 Visual Studio Code 로컬로 만들 수 있습니다.

    두 개발 환경 모두 도메인별 프로그래밍 언어인 를 사용하여 ServiceNow Fluent애플리케이션을 구성하는 메타데이터를 정의합니다. ServiceNow Fluent 에는 다양한 유형의 메타데이터를 정의하기 위한 API가 포함되어 있습니다.

    또는 ServiceNow SDK를 사용하여 ServiceNow IDE JavaScript 모듈을 만들고 애플리케이션에서 타사 라이브러리를 사용하여 범위가 지정된 애플리케이션 내의 스크립트에서 코드 재사용을 최적화할 수도 있습니다.

    소스 코드로 애플리케이션을 개발하고 유지 관리하면 익숙한 개발 환경에서 작업하고, 복잡한 애플리케이션을 생성 및 수정하고, 소스 통제에서 코드를 보다 쉽게 관리하고, 빌드 시간에 오류를 포착할 수 있습니다.

    주:
    ServiceNow IDE 및 현재 ServiceNow SDK 전역 범위 또는 전역 애플리케이션을 지원하지 않습니다.

    의 비교 ServiceNow IDEServiceNow SDK

    기능 ServiceNow IDE ServiceNow SDK
    개발 환경 온라인 ServiceNow 인스턴스 로컬 개발 및 오프라인 작업 가능
    사용자 인터페이스 웹용 기반 IDE Visual Studio Code Visual Studio Code 데스크톱
    공동 작업 메타데이터 탐색기의 코드 또는 포함된 ServiceNow AI Platform 사용자 인터페이스에서 사용자의 변경 내용을 실시간으로 봅니다.

    소스 통제 애플리케이션에 대해 다른 개발자와 공동 작업을 진행합니다.

    		 인스턴스에서 변경을 다운로드하고 CLI를 사용하여 ServiceNow SDK 인스턴스에 로컬 변경을 설치하여 다른 사용자와 공동 작업합니다.

    소스 통제 애플리케이션에 대해 다른 개발자와 공동 작업을 진행합니다.
    소스 통제 가장 일반적인 Git 기능을 지원하고 선택한 Git 공급자와 통합합니다.

    인스턴스 (또는 개발자 샌드박스)당 리포지토리당 하나의 동시 분기.

    		 전체 지원
    애플리케이션 변환 ORServiceNow SDK로 ServiceNow IDE 생성되지 않은 기존 범위가 지정된 애플리케이션 변환 지원 . ORServiceNow SDK로 ServiceNow IDE 생성되지 않은 기존 범위가 지정된 애플리케이션 변환 지원 .
    ServiceNow Fluent 전체 지원

    언어 서버는 ServiceNow FluentServiceNow IDE.

    		 전체 지원

    언어 서버는 ServiceNow Fluent 확장 마켓플레이스에서 Visual Studio Code 설치할 수 있습니다.
    JavaScript 모듈 및 타사 라이브러리 전체 지원 전체 지원
    코드용 Now Assist 스크립트에 대한 코드 자동 완성 지원입니다.

    활성화에 대한 자세한 내용은 다음 문서를 참조하십시오 Now Assist for Code.

    		 지원되지 않음
    빌드 에이전트 전폭 지원. 의 채팅 패널 ServiceNow IDE에서 에이전트 빌드에 액세스할 수 있습니다.

    활성화에 대한 자세한 내용은 다음 문서를 참조하십시오 ../../build-agent/concept/build-agent.html.

    		 지원되지 않음

    애플리케이션 구조

    소스 코드 파일 및 메타데이터 XML 파일을 포함하거나 ServiceNow IDEServiceNow SDK 사용하여 생성된 사용자 지정 범위가 지정된 애플리케이션입니다. package.json 및 now.config.json 파일은 Node.js 애플리케이션 또는 npm(노드 패키지 관리자) 패키지와 유사한 애플리케이션 구조를 정의합니다.

    그림 1. 에서 작성된 애플리케이션의 기본 구조 ServiceNow IDE
    에서 생성된 애플리케이션의 구조 ServiceNow IDE

    기본적으로 애플리케이션에는 다음과 같은 디렉터리와 파일이 포함됩니다. now.config.json 파일의 필요에 맞게 애플리케이션 구조의 특정 측면을 수정할 수 있습니다.

    .vscode
    권장 Visual Studio Code 확장이 포함된 디렉터리입니다.
    배포
    패키징할 빌드 아티팩트가 포함된 디렉터리입니다. 이 디렉터리에는 다음과 같은 하위 디렉터리가 포함되어 있습니다.
    • app: 빌드된 메타데이터 XML 파일이 포함된 디렉터리입니다.
    • static: 빌드된 정적 자산 파일이 포함된 디렉터리입니다.
    메타데이터

    테이블 스키마 및 비즈니스 규칙과 같은 애플리케이션의 애플리케이션 메타데이터(XML)가 포함된 디렉터리로, 기존 ServiceNow 애플리케이션과 동일한 디렉터리 구조로 구성되어 있습니다.

    주:
    애플리케이션 메타데이터는 XML 파일에서 편집해서는 안 됩니다. 소스 코드 또는 에서 애플리케이션 메타데이터를 편집합니다.ServiceNow AI Platform
    node_modules
    애플리케이션이 의존하는 외부 공급업체 Node.js 모듈이 포함된 디렉터리입니다.
    src
    애플리케이션의 소스 코드가 포함된 디렉터리입니다. 이 디렉터리에는 다음과 같은 하위 디렉터리가 포함되어 있습니다.
    • client: 사용자 인터페이스 개발을 위한 클라이언트 측 파일이 포함된 디렉터리입니다.
    • fluent: .now.ts 파일에 코드가 포함된 ServiceNow Fluent 디렉터리입니다. 생성된 하위 디렉터리에는 로 변환된 ServiceNow Fluent애플리케이션 파일이 포함되어 있습니다.
    • server: .js 또는 .ts 파일의 JavaScript 모듈 코드를 포함하는 디렉터리입니다.
    대상
    인스턴스에 업로드할 설치 가능한 패키지(.zip 파일)가 들어 있는 디렉터리입니다.
    .eslintrc.json
    ESLint 구성을 포함하는 파일입니다. ESLint는 애플리케이션 코드에서 문제를 식별하고 수정하는 데 도움이 됩니다.
    .gitignore
    Git이 무시할 디렉터리 또는 파일 목록이 포함된 파일입니다. 이러한 파일은 소스 통제에서 추적되지 않습니다.
    now.config.json
    애플리케이션 구성을 포함하는 파일입니다 ServiceNow . now.config.json 파일은 애플리케이션의 기본 디렉터리에 있어야 합니다.
    다음 매개변수를 추가하여 애플리케이션의 디렉터리 구조를 구성할 수 있습니다. 예: 
    {
  "scope": "x_snc_example_app",
  "scopeId": "2f8400eb07426110f736e28f69d3017a",
  "name": "ExampleApp",
  "dependencies": {
    "global": {
      "tables": ["incident"],
      "roles": ["admin"],
    },
    "x_custom": {
      "tables": ["custom_table"]
    }
  },
  "metadataDir": "metadata",
  "fluentDir": "src/fluent",
  "generatedDir": "generated",
  "serverModulesDir": "src/server",
  "clientDir": "src/client",
  "appOutputDir": "dist/app",
  "staticContentDir": "dist/static",
  "packOutputDir": "target",
  "modulePaths": {
      "src/server/*.ts": "dist/server/*.js",
    },
  "staticContentPaths": {
      "src/client/*.html": "dist/static/*.html",
    },
  "ignoreTransformTableList": ["ua_table_licensing_config", "sys_embedded_help_role"],
  "taxonomy": {
        "mapping": {
            "sys_script": "scripts/server/rules",
            "custom_table": "my-custom-folder/my-nested-folder"
        },
        "fallbackFolderName": "unclassified" 
    }
}
    표 1. 지원되는 now.config.json 매개변수
    매개변수 설명
    의존성 애플리케이션이 종속된 다른 애플리케이션 범위의 항목입니다. 애플리케이션 범위와 의존성 유형 및 이름 또는 sys_ids 지정해야 합니다.
    "dependencies": {
    "<scope>": {
      "<type>": ["<sys_id or name>"],
      ...
    },
    ...
}

    자세한 내용은 애플리케이션 종속성 다운로드 ServiceNow Fluent 문서를 참조하십시오.
    metadataDir 애플리케이션의 메타데이터를 XML 파일로 포함하는 디렉터리입니다.

    기본값: 메타데이터
    fluentDir 소스 코드에서 애플리케이션 메타데이터를 정의하는 파일(.now.ts)이 포함된 ServiceNow Fluent 디렉터리입니다.

    기본값: src/fluent
    generatedDir 코드로 변환된 기존 애플리케이션 메타데이터를 포함하여 생성된 ServiceNow Fluent 파일이 포함된 디렉터리입니다.ServiceNow Fluent 이 디렉터리는 매개변수로 fluentDir 정의된 디렉터리를 기준으로 합니다.

    기본값: generated
    serverModulesDir 서버 측 스크립트에서 사용하기 위해 JavaScript 모듈에 빌드할 JavaScript 또는 TypeScript 파일이 들어있는 디렉터리입니다.

    기본값: src/server
    클라이언트디렉터리 React로 사용자 인터페이스를 개발하기 위한 클라이언트 측 파일이 포함된 디렉터리입니다.

    기본값: src/client
    appOutputDir

    패키징을 위해 빌드 아티팩트를 출력할 디렉터리입니다. pack 및 install 명령은 이 디렉터리 패키지 아티팩트를 참조합니다.

    기본값: dist/app
    staticContentDir 사용자 인터페이스 개발에 사용되는 정적 자산 파일을 출력하는 디렉터리입니다.

    기본값: dist/static
    packOutputDir 애플리케이션을 빌드할 때 설치 가능 패키지(.zip 파일)를 출력할 디렉터리입니다. 설치 명령은 이 디렉터리를 참조하여 패키지를 설치합니다.

    기본값: 대상
    serverModulesIncludePatterns JavaScript 모듈을 빌드할 때 포함할 파일 패턴 목록입니다.
    기본값: 
    [
  "**/*.ts",
  "**/*.tsx",  
  "**/*.js",
  "**/*.jsx",
  "**/*.cts",
  "**/*.cjs",
  "**/*.mts",
  "**/*.mjs",
  "**/*.json"
]
    serverModulesExcludePatterns JavaScript 모듈을 빌드할 때 제외할 파일 패턴의 목록입니다.
    기본값: 
    [
  "**/*.test.ts",
  "**/*.test.js",
  "**/*.d.ts"
]
    modulePath 애플리케이션을 빌드하기 전에 사용자 지정 변환 단계를 사용하는 경우 모듈 소스 파일을 해당 출력 파일에 매핑합니다. 자세한 내용은 JavaScript 모듈에서 TypeScript를 사용하여 ServiceNow SDK 문서를 참조하십시오.
    경고:
    이 매개변수와 tsconfigPath 매개변수는 사용할 수 없습니다. 둘 다 구성하면 오류가 발생합니다.
    staticContentPaths 정적 자산 파일의 출력 경로에 대한 클라이언트 측 소스 파일의 맵입니다.
    tsconfig경로 빌드 프로세스 중에 TypeScript를 JavaScript로 변환하기 위한 사용자 지정 옵션이 있는 tsconfig.json 파일의 경로입니다. tsconfigPath를 지정하면 tsconfig.json 파일을 사용하여 TypeScript에서 진단 결과가 생성됩니다.
    경고:
    이 매개변수와 modulePaths 매개변수는 사용할 수 없습니다. 둘 다 구성하면 오류가 발생합니다.

    기본값: .
    ignoreTransformTableList 애플리케이션 메타데이터를 소스 코드로 변환할 때 무시할 테이블 목록입니다.
    tableOutputFormat 코드에서 생성된 테이블 메타데이터 XML에 대한 빌드 아티팩트 유형입니다 ServiceNow Fluent .
    유효한 값은 다음과 같습니다.
    • bootstrap: 빌드 프로세스는 테이블의 루트 요소인 <database> , 필드 레이블 XML 파일 [sys_documentation], 라이선싱 구성 XML 파일 [ua_table_licensing_config] 및 자동 번호 매기기 XML 파일 [sys_number]이 포함된 부트스트랩 XML 파일을 출력합니다.
    • 구성 요소: 빌드 프로세스는 테이블 API의 각 구성요소에 대한 XML 파일을 출력합니다.

    기본값: bootstrap
    세분화 생성된 ServiceNow Fluent 파일을 구성하기 위한 구성으로, 테이블 이름을 디렉터리에 매핑하고 대체 디렉터리를 정의합니다. 기본 분류 구성은 표준 테이블 분류를 사용하여 ServiceNow 메타데이터가 처음에 코드로 ServiceNow Fluent 변환될 때 Fluent/생성된 디렉터리 내의 논리적 디렉터리 구조에 생성된 ServiceNow Fluent 파일을 추가합니다. 예:
    • 비즈니스 규칙[sys_script]이 fluent/generated/server-development/business-rule 디렉터리에 추가됩니다.
    • 스크립트 포함 [sys_script_include]이 fluent/generated/server-development/script-include 디렉터리에 추가됩니다.

    기본 매핑을 재정의하거나 추가 매핑을 구성할 수 있습니다. 다음 예시에서 구성은 비즈니스 규칙 [sys_script]의 기본 디렉터리와 폴백 폴더를 재정의하고 사용자 지정 테이블의 메타데이터에 대한 추가 매핑을 구성합니다.

    "taxonomy": {
        "mapping": {
            "sys_script": "scripts/server/rules",
            "custom_table": "my-custom-folder/my-nested-folder"
        },
        "fallbackFolderName": "unclassified"
}
    • 매핑: 테이블 이름을 디렉터리에 매핑하는 객체입니다. 디렉터리 경로는 매개변수로 generatedDir 구성된 디렉터리를 기준으로 하며 하위 디렉터리를 구분하기 위해 소문자, 숫자, 하이픈, 밑줄 및 슬래시만 포함해야 합니다.
    • fallbackFolderName: 기본 또는 사용자 지정 매핑이 구성되지 않은 테이블에 사용할 디렉터리의 이름입니다. 이 디렉터리 ServiceNow Fluent 내에서 파일은 src/fluent/generated/other/x-unmapped-table/과 같이 테이블의 이름을 딴 하위 디렉터리에 추가됩니다.

    기본: 기본 분류 매핑은 모든 표준 ServiceNow 테이블에 대해 정의되며 애플리케이션의 now.config.json 에 사용자 지정 구성이 정의되지 않은 경우 자동으로 적용됩니다. 기본값은 fallbackFolderNameother입니다.
    now.prebuild.mjs
    종속성과 해당 버전에 대한 전체 정보를 포함하는 자동 업데이트된 파일입니다. 이 파일은 ServiceNow SDK.
    package-lock.json
    종속성과 해당 버전에 대한 전체 정보를 포함하는 자동 업데이트된 파일입니다. 이 파일은 ServiceNow SDK.
    package.json

    애플리케이션 및 사용자 지정 또는 타사 모듈 종속성에 대한 정보가 포함된 파일입니다. package.json 파일은 애플리케이션의 기본 디렉터리에 있어야 합니다. 인스턴스에서 package.json 경로는 사용자 지정 애플리케이션 기록 [sys_app]의 패키지 JSON 필드에 <scope>/<package-name>/<version>/package.json 형식으로 지정됩니다.

    관련 애플리케이션 및 기능

    JavaScript API
    애플리케이션의 기능을 변경하기 위해 또는 애플리케이션을 생성할 때 작성하는 스크립트에 JavaScript API를 사용합니다.