Create or convert an application with the ServiceNow SDK

  • Versão de lançamento: Australia
  • Atualizado 12 de mar. de 2026
  • 5 min. de leitura

    • Create an application or convert an existing application to develop in source code with the ServiceNow SDK.

    Antes de Iniciar

    Install or upgrade the ServiceNow SDK using npm. For more information, see Install the ServiceNow SDK in an application or Upgrade the ServiceNow SDK.

    Use the ServiceNow SDK to authenticate to a ServiceNow instance. For more information, see Authenticating to a ServiceNow instance with the ServiceNow SDK.

    Role required: admin

    Por Que e Quando Desempenhar Esta Tarefa

    This procedure uses the ServiceNow SDK command-line interface (CLI). From a command-line tool, enter now-sdk --help to get information about the available commands and global options. To get additional information about a command and its parameters, enter the command and --help or -h. For example, now-sdk auth --help. For more information about the CLI, see ServiceNow SDK CLI.

    Procedimento

    1. Create a local directory for your application.
    2. In Visual Studio Code, open the directory.
    3. From the application directory, open an integrated Terminal window.
    4. Create an application following a guided set of prompts with the init command: 
      npx @servicenow/sdk init
      Nota:
      Using the npx command installs the ServiceNow SDK in your application directory instead of globally.
    5. Respond to the following series of prompts.
      Prompt Response
      Select a template Select a template that determines the default application structure, such as whether to create a full-stack application that supports UI development ands whether to use JavaScript or TypeScript to create modules.
      • Basic now-sdk boilerplate: An application with only the basic structure necessary for development in source code.
      • JavaScript now-sdk + basic: An application configured for development in ServiceNow Fluent and JavaScript.
      • JavaScript now-sdk + fullstack React: An application configured for development in ServiceNow Fluent, JavaScript, and React.
      • TypeScript now-sdk + basic: An application configured for development in ServiceNow Fluent and TypeScript. TypeScript source files in the src/server directory are transpiled into JavaScript modules.
      • TypeScript now-sdk + fullstack React: An application configured for development in ServiceNow Fluent, TypeScript, and React. TypeScript source files in the src/server directory are transpiled into JavaScript modules.
      Name of ServiceNow Application Enter a name for the application.
      NPM package name Enter a name for the application package used in the package.json file.

      The package name must adhere to Node Package Manager (npm) package naming standards.
      Create a Global/Scoped App? Select whether to create a scoped or global application.
      • Scoped: Create a scoped application that is protected by identifying and restricting access to application files and data.
      • Global: Create an application in the global scope to allow it to be accessible to other global applications. Global applications are supported only with instances beginning with the Australia release.
      Scope name For scoped applications, enter the scope of the application.

      The scope name must be unique on the instance, begin with x_<prefix>, and be 18 characters or fewer. For more information, see Namespace identifier.
      In the following example, a scoped application named Example App (x_snc_example_app) is created.
      $ npx @servicenow/sdk init
[now-sdk] Bootstrapping a new ServiceNow application project...
? Select a template: now-sdk + basic
? Name of ServiceNow Application:  Example App
? NPM package name:  example-app
? Scope name:  x_snc_example_app
[now-sdk] Application created successfully.
          Install the required dependencies with your preferred package manager before running "$now-sdk build".
          Ex: Run "npm install" if using npm.
    6. Install the required third-party dependencies using your preferred package manager.
      For example, if you use Node Package Manager (npm), run npm install.
    7. Build the application with the build command: 
      now-sdk build
    8. Opcional: Install the application on an instance with the install command: 
      now-sdk install --auth <alias>
    9. From the directory where you want to add an application, open a command-line tool on your system.
    10. Create a scoped application or convert an existing application for use with the ServiceNow SDK.
      OptionSteps
      Create a scoped application
      1. Create an application following a guided set of prompts using the create command:
        now-sdk create <scopeName>  --auth <alias> --interactive
        For example:
        now-sdk create x_snc_example --auth devuser1 --interactive
        Nota:
        The scope name must be unique on the instance, begin with x_<prefix>, and be 18 characters or fewer. For more information, see Namespace identifier.
      2. Respond to the following prompts:
        • Name of the scoped application: <application name>
        • Description associated with sys_app: <description>
        • Project template? Select TypeScript or JavaScript
        • NPM package name: <package name>
        • Add a sample table to the application? [Yes/No]
        • Create Fluent or JS Module project structure? Select Fluent or Module

          This option determines the default application structure based on whether you want to use ServiceNow Fluent and JavaScript modules and third-party libraries in the application (fluent) or only use JavaScript modules and third-party libraries (module).
      Convert an existing application Convert an existing application from your instance using the convert command:
      now-sdk convert <scopeName> <packageName> --auth <alias> --projectType <type>

      Use the --projectType parameter to specify the type of application to create. This option determines the default application structure based on whether you want to use ServiceNow Fluent and JavaScript modules and third-party libraries in the application (fluent) or only use JavaScript modules and third-party libraries (module).

      For example:
      now-sdk convert x_snc_example example-app --auth devuser1 --projectType fluent

      Converting an application adds the necessary files and directories for using the ServiceNow SDK locally and downloads the application metadata. The application isn't changed on the instance until you build and install it on the instance. After installing a converted application, the Package JSON field of the custom application record [sys_app] contains the path to the package.json file for the application.

    Resultado

    An application with the default application structure is available locally. For information about the application structure, see the Application structure section of the Building applications in source code topic.

    If you installed the application successfully, it’s available on the instance. For more information about installing applications, see Build and installdeploy an application with the ServiceNow SDK.

    If the application is built and installed to the instance, the CLI returns the URL to the application, such as https://myinstance.service-now.com/sys_app.do?sys_id=<sysID>. If you chose not to build and register the application on the instance during creation, the application isn’t installed to the instance until you do so. For more information, see Build and installdeploy an application with the ServiceNow SDK.

    O que Fazer Depois

    In Visual Studio Code, start developing your application in source code with ServiceNow Fluent, writing custom JavaScript modules, or adding third-party libraries. For more information, see Developing applications with the ServiceNow SDK.