Building applications in source code

  • Release version: Zurich
  • Updated June 2, 2026
  • 4 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Building applications in source code

    This guide explains how to create and develop custom scoped applications in source code using ServiceNow’s development tools: the ServiceNow IDE on the AI Platform and the ServiceNow SDK for local development with Visual Studio Code. Both environments utilizeServiceNow Fluent, a domain-specific language with APIs to define application metadata. Developers can also create JavaScript modules and incorporate third-party libraries to enhance code reuse within scoped applications.

    Show full answer Show less

    Developing applications in source code allows you to work in familiar environments, manage source control effectively, and detect errors during build time, improving application quality and collaboration.

    Note: The Global scope and global applications are not supported in the Zurich release for these tools.

    ServiceNow IDE vs ServiceNow SDK

    • ServiceNow IDE: An online development environment based on Visual Studio Code for the Web, integrated with the ServiceNow AI Platform. Supports real-time collaboration, Git integration, application conversion, ServiceNow Fluent language server, JavaScript modules, Now Assist for Code, and Build Agent accessed via a chat panel.
    • ServiceNow SDK: Enables local development using Visual Studio Code Desktop, including offline work. Supports full Git functionality, application conversion, ServiceNow Fluent language server (via extension), JavaScript modules, and Build Agent from version 4.6.0. It does not support Now Assist for Code.

    Application Structure in Source Code

    Applications created with the IDE or SDK follow a structured layout similar to Node.js/npm packages, defined by package.json and now.config.json. Key directories and files include:

    • .vscode: Recommended VS Code extensions
    • dist: Build artifacts, including metadata XML (app) and static assets (static)
    • metadata: XML metadata such as table schemas and business rules (should not be edited directly)
    • nodemodules: Third-party Node.js dependencies
    • src: Source code with subdirectories for client-side UI (client), ServiceNow Fluent code (fluent), and server-side JavaScript modules (server)
    • target: Installable package (.zip) for instance upload
    • Configuration files such as .eslintrc, .gitignore, now.config.json, and package.json

    The now.config.json file enables customization of application settings to suit development needs.

    Practical Benefits for ServiceNow Customers

    • Work in a familiar IDE or locally with Visual Studio Code for efficient application development and debugging.
    • Leverage ServiceNow Fluent for clear, API-driven metadata definition, improving maintainability.
    • Use source control integration to collaborate effectively and manage application versions.
    • Incorporate JavaScript modules and third-party libraries to optimize code reuse and functionality.
    • Generate installable packages to deploy applications seamlessly to ServiceNow instances.
    • Utilize tooling such as ESLint for improved code quality and Build Agent for build automation.

    Create and develop custom applications in source code using familiar development tools and processes.

    Overview of development in source code

    You can create scoped applications in code using the ServiceNow IDE on the ServiceNow AI Platform or locally in Visual Studio Code Desktop with the ServiceNow SDK.

    In either development environment, you use ServiceNow Fluent, a domain-specific programming language, to define the metadata that makes up applications. ServiceNow Fluent includes APIs for defining the different types of metadata.

    With the ServiceNow IDE or ServiceNow SDK, you can also create JavaScript modules and use third-party libraries in your application to optimize code reuse in scripts within a scoped application.

    Developing and maintaining applications in source code enables you to work in familiar development environments, create and modify complex applications, manage code in source control more easily, and catch errors at build time.

    Note:
    The ServiceNow IDE and ServiceNow SDK don't support the Global scope or global applications in the Zurich release.

    Comparison of the ServiceNow IDE and the ServiceNow SDK

    Feature ServiceNow IDE ServiceNow SDK
    Development environment Online ServiceNow instance Local development and the ability to work offline
    User interface IDE based on Visual Studio Code for the Web Visual Studio Code Desktop
    Collaboration View any user's changes in real time in code or embedded ServiceNow AI Platform user interfaces.

    Collaborate with other developers on applications in source control.

    		 Download changes from an instance and install local changes to an instance using the ServiceNow SDK CLI to collaborate with other users.

    Collaborate with other developers on applications in source control.
    Source control Supports the most common Git functionality and integrating with a Git provider of your choice.

    One concurrent branch per repository per instance (or developer sandbox).

    		 Full support
    Application conversion Support for converting existing scoped applications not created with the ServiceNow IDE or ServiceNow SDK. Support for converting existing scoped applications not created with the ServiceNow IDE or ServiceNow SDK.
    ServiceNow Fluent Full support

    The ServiceNow Fluent Language server is included with the ServiceNow IDE.

    		 Full support

    The ServiceNow Fluent Language server can be installed from the Visual Studio Code Extension Marketplace.
    JavaScript modules and third-party libraries Full support Full support
    Now Assist for Code Code auto-complete support for scripts.

    For information about activation, see Now Assist for Code.

    		 Not supported
    Build Agent Full support. Build Agent is accessed from a chat panel in the ServiceNow IDE.

    For information about activation, see Build Agent.

    		 Build Agent skills are available beginning with ServiceNow SDK version 4.6.0.

    Application structure

    Custom scoped applications created with the ServiceNow IDE or ServiceNow SDK include source code files and metadata XML files. The package.json and now.config.json files define the application structure, which is similar to that of Node.js applications or Node Package Manager (npm) packages.

    Figure 1. Default structure of an application created in the ServiceNow IDE
    Structure of an application created in the ServiceNow IDE

    By default, applications include the following directories and files. You can modify certain aspects of the application structure to suit your needs in the now.config.json file.

    Table 1. Application structure in source code
    Directory or file Description
    .vscode Directory containing recommended Visual Studio Code extensions.
    dist Directory containing the build artifacts for packaging. This directory includes the following subdirectories:
    • app: Directory containing the built metadata XML files.
    • static: Directory containing the built static asset files.
    metadata

    Directory containing the application metadata (XML) of the application, such as table schemas and business rules, organized in the same directory structure as existing ServiceNow applications.

    Note:
    Application metadata shouldn't be edited from the XML files. Edit application metadata in the source code or on the ServiceNow AI Platform.
    node_modules Directory containing the third-party Node.js modules on which your application depends.
    src Directory containing the source code of your application. This directory includes the following subdirectories:
    • client: Directory containing the client-side files for developing user interfaces.
    • fluent: Directory containing ServiceNow Fluent code in .now.ts files. The generated subdirectory contains the application files converted to ServiceNow Fluent.
    • server: Directory containing JavaScript module code in .js or .ts files.
    target Directory containing an installable package (.zip file) to upload to an instance.
    .eslintrc File containing the ESLint configuration. ESLint helps identify and fix issues in the application code.
    .gitignore File containing a list of directories or files for Git to ignore. These files aren't tracked in source control.
    now.config.json File containing the ServiceNow application configuration. The now.config.json file must be in the base directory for an application. You can configure aspects of an application by adding support parameters. For more information, see Custom application configuration in source code.
    now.prebuild.mjs Auto-updated file containing complete information about dependencies and their versions. This file is only available with the ServiceNow SDK.
    package-lock.json Auto-updated file containing complete information about dependencies and their versions. This file is only available with the ServiceNow SDK.
    package.json File containing information about your application and custom or third-party module dependencies. The package.json file must be in the base directory for an application. On an instance, the package.json path is specified in the Package JSON field of the custom application record [sys_app] in the format <scope>/<package-name>/<version>/package.json.

    Related applications and features

    JavaScript APIs
    Use JavaScript APIs in scripts that you write to change the functionality of applications or when you create applications.