ServiceNow SDK release notes

  • Release version: Yokohama
  • Updated January 30, 2025
  • 3 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 ServiceNow SDK release notes Yokohama

    The ServiceNow SDK enables developers to create and manage scoped applications in source code locally using Visual Studio Code Desktop, then upload changes to a ServiceNow instance. The Yokohama release introduces significant enhancements to improve the SDK CLI workflow, metadata handling, and integration with ServiceNow Fluent APIs, supporting development from ServiceNow releases starting with Washington DC.

    Show full answer Show less

    Key Features

    • Unified Initialization: The now-sdk init command replaces the previous create and convert commands, allowing users to create or convert scoped applications for source code development.
    • Metadata Transformation: Download application metadata (XML) from a ServiceNow instance and transform it into ServiceNow Fluent source code for streamlined development.
    • File Referencing in Fluent APIs: Use Now.include('path/to/file') syntax to reference external file content within ServiceNow Fluent APIs, enhancing modular development.
    • Custom Directory Mapping: Map application metadata to custom output directories that load under specific conditions using the $meta property in Fluent APIs.
    • Custom TypeScript Configuration: Specify a custom tsconfig.json file location via the tsconfigPath parameter in now.config.json to tailor TypeScript transpilation during builds.
    • Authentication Management: The auth command now uses parameters (--add, --delete, --list, --use) instead of subcommands to manage credentials.
    • Type Definitions Installation: The dependencies command installs TypeScript definitions for Glide APIs and script includes based on your application scripts.
    • Build Validation: The build command supports a --frozenKeys parameter to validate the keys.ts file for continuous integration scenarios.
    • Deployment Command Update: The deploy command has been renamed to install for installing or updating applications on ServiceNow instances.
    • Automated Test Framework (ATF) Two-Way Sync: Synchronize ATF test changes bi-directionally between source code and metadata.
    • Table API Enhancements: Support for licensing configurations to track subscription counts and creation of remote tables via scriptable properties.

    Important Upgrade Information

    Upgrade to the latest ServiceNow SDK Yokohama version using the now-sdk upgrade command. The SDK version 3.0 requires ServiceNow instances at least from the Washington DC release.

    Removed Commands

    • now-sdk convert command is removed; use now-sdk init and now-sdk transform instead.
    • now-sdk fetch command is removed; replace with now-sdk transform.

    Activation and Requirements

    The ServiceNow SDK is distributed as an npm package and must be installed locally. Node.js and npm are prerequisites. For installation and configuration details, refer to the SDK installation guides.

    Related ServiceNow Tools

    The ServiceNow IDE leverages the SDK for application packaging and building, utilizing the Fluent APIs for source code development. Scoped applications created or converted with either the SDK or IDE can be developed interchangeably using both tools.

    The ServiceNow® software development kit (SDK) enables developers to create scoped applications in source code locally in Visual Studio Code Desktop and upload changes to a ServiceNow instance. ServiceNow SDK was enhanced and updated in the Yokohama release.

    ServiceNow SDK highlights for the Yokohama release

    • Create and develop applications in source code using an upgraded ServiceNow SDK CLI workflow.
    • Refer to content from a file from properties in ServiceNow Fluent APIs.

    See ServiceNow SDK for more information.

    Important information for upgrading ServiceNow SDK to Yokohama

    Upgrade to the latest version of the ServiceNow SDK with the now-sdk upgrade command. For more information, see Upgrade the ServiceNow SDK.

    ServiceNow SDK version 3.0 supports integrating with ServiceNow instances beginning with the Washington DC release.
    Note:
    For more information about minor releases of the ServiceNow SDK, see the ServiceNow IDE, SDK, and Fluent articles in the ServiceNow Community.

    New in the Yokohama release

    Version 3.0
    Init command replaces create and convert commands
    Create a custom scoped application or convert an existing scoped application from a ServiceNow instance or local directory to support development in source code using the now-sdk init command.
    Download application metadata and transform it into source code
    Download application metadata (XML) from a ServiceNow instance and transform the metadata into ServiceNow Fluent source code.
    Refer to content from a file in ServiceNow Fluent APIs
    Use content from files in ServiceNow Fluent APIs by referring to the file from a property using the syntax Now.include('path/to/file').
    Map metadata to custom directories
    Map any application metadata to output directories that load only in specific circumstances using the $meta property in ServiceNow Fluent APIs.
    Specify a path to a custom tsconfig.json file
    Use the tsconfigPath parameter in the now.config.json file for your application to specify the location of a tsconfig.json file with custom options for transpiling TypeScript into JavaScript during the build process.

    Changed in this release

    Version 3.0
    Subcommands replaced with parameters on the auth command
    Configure authentication credentials with the --add, --delete, --list, and --use parameters of the now-sdk auth command.
    Dependencies command installs type definitions
    Download TypeScript type definitions for Glide APIs and script includes from a ServiceNow instance based on the scripts in your application.
    Build command includes --frozenKeys parameter
    Validate that the auto-generated keys.ts file is up to date for continuous integration (CI) builds by setting the --frozenKeys parameter to true with the now-sdk build command.
    Deploy command renamed install
    Install or update an application on a ServiceNow instance using the now-sdk install command.
    Automated Test Framework Test API supports two-way synchronization
    Synchronize changes to Automated Test Framework tests made outside of source code into source code definitions and back to metadata.
    Table API supports licensing configurations
    Create a licensing configuration [ua_table_licensing_config] to track subscription counts for a table with the licensing_config object in the Table API.
    Table API supports remote tables
    Create a remote table with the scriptable_table property in a Table object.

    Removed in this release

    • The now-sdk convert command has been removed. Use the now-sdk init and now-sdk transform commands instead.
    • The now-sdk fetch command has been removed. Use the now-sdk transform command instead.

    Activation information

    The ServiceNow SDK is available as a Node Package Manager (npm) package from the public npm registry and installed locally. For information about installing the ServiceNow SDK, see Install the ServiceNow SDK in an application.

    Additional requirements

    You must have Node.js and Node Package Manager (npm) installed to install the ServiceNow SDK. For more information, see Install the ServiceNow SDK in an application.

    Related ServiceNow applications and features

    ServiceNow IDE
    The ServiceNow IDE uses the ServiceNow SDK as its application packaging service to build applications, and the ServiceNow SDK provides the ServiceNow Fluent APIs for developing applications in source code in the ServiceNow IDE. Scoped applications created or converted with the ServiceNow SDK or ServiceNow IDE can be developed with either application.