Combined ServiceNow SDK release notes for upgrades from Xanadu to Yokohama

How to use this page

To help you prepare for your upgrade, we have combined the cross-family ServiceNow SDK release notes onto one page. Read this summary of the new features, changes, and updated information for your product from Xanadu to Yokohama.

Tip:

If there were no updates for a release notes section in a certain family release, we included a short note for your reference. For example, if a product did not have any updates in Tokyo, the row says "No updates for this release."

Important information for upgrading ServiceNow SDK to Yokohama

Before you upgrade to Yokohama, review these pre- and post-upgrade tasks and complete the tasks as needed.


Release	Release notes
Xanadu	Upgrade to the latest version of the ServiceNow SDK with the `now-sdk upgrade` command. For more information, see Upgrade the ServiceNow SDK.
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 features

Between your current release family and Yokohama, new features were introduced for ServiceNow SDK.


Release	Release notes
Xanadu	Version 2.2.1 Turn off synchronizing changes to ServiceNow Fluent code Turn off synchronizing changes to ServiceNow Fluent objects or files using the `@fluent-disable-sync` or `@fluent-disable-sync-for-file` comment directives. Version 2.1.1 Authenticate to an instance using OAuth 2.0 Authenticate to a ServiceNow instance using OAuth 2.0 by setting the `type` parameter on the `now-sdk auth` command to `oauth`. Ignore ServiceNow Fluent diagnostics Suppress ServiceNow Fluent and TypeScript diagnostics using the `@fluent-ignore` comment directive. Version 2.0 Build scoped applications in source code Write source code to define the metadata that makes up applications using ServiceNow Fluent. ServiceNow Fluent is a domain-specific programming language with APIs for defining the different types of application metadata. Developing 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. ServiceNow Fluent Language server in Visual Studio Code Get language processing and validation for ServiceNow Fluent in Visual Studio Code by installing the ServiceNow Fluent Language server from the Visual Studio Code Marketplace.
Yokohama	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.

Changes

Between your current release family and Yokohama, some changes were made to existing ServiceNow SDK features.


Release	Release notes
Xanadu	Version 2.2.3 Convert command uses module project type by default The `projectType` parameter is set to `module` by default. By converting an application with the module project type, you can gradually migrate application metadata into ServiceNow Fluent code rather than converting all application metadata into code initially. Version 2.2.1 transpiledSourceDir parameter replaced with modulePaths parameter in now.config.json file Use the `modulePaths` parameter in the now.config.json file for your application to map the source directory for modules to the output directory for modules instead of the deprecated `transpiledSourceDir` parameter. The `modulePaths` parameter is used to compile TypeScript source files into JavaScript modules. Version 2.1.1 Table API includes label object Configure field labels [sys_documentation] for tables and columns with the label object in the Table API. Version 2.0.1 Create and convert commands include template parameter Specify whether to use JavaScript or TypeScript in modules with the `template` parameter on the `now-sdk create` and `now-sdk convert` commands. This parameter determines the configuration of the package.json and now.config.json files and adds a tsconfig.json file for TypeScript projects. Version 2.0 Default application structure The default application structure includes some changes to directories and files, including the addition of a .gitignore file and moving the `now` object configuration in package.json to its own now.config.json file. Create and convert commands include project-type parameter Specify the type of application to create or convert with the `project-type` parameter on the `now-sdk create` and `now-sdk convert` commands. This parameter 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`). Fetch command includes debug parameter Return debug logs generated during the fetch process by setting the `debug` parameter to true with the `now-sdk fetch` command. Deploy command includes reinstall parameter Uninstall and reinstall the application on the instance by setting the `reinstall` parameter to true with the `now-sdk deploy` command. Reinstalling an application ensures that the metadata on the instance matches the metadata in the deployment package. Warning: Metadata that is on the instance but not in your local application is removed.
Yokohama	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

Between your current release family and Yokohama, some ServiceNow SDK features or functionality were removed.


Release	Release notes
Xanadu	The `scopeId` parameter was removed from the `now-sdk convert` command, which supported converting global applications. Only scoped applications can be converted. The `mode` parameter was removed from the `now-sdk fetch` and `now-sdk deploy` commands. A complete fetch or deploy are always executed.
Yokohama	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.

Deprecations

Between your current release family and Yokohama, some ServiceNow SDK features or functionality were deprecated.


Release	Release notes
Xanadu	No updates for this release.
Yokohama	No updates for this release.

Activation information

Review information on how to activate ServiceNow SDK.


Release	Release notes
Xanadu	The ServiceNow SDK is available as an npm package from the public npm registry and installed locally. For information about installing the ServiceNow SDK, see Install the ServiceNow SDK.
Yokohama	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.

Additional requirements

If any additional requirements were introduced or changed for ServiceNow SDK we have noted them here.


Release	Release notes
Xanadu	You must have Node.js and npm installed to install the ServiceNow SDK. For more information, see Install the ServiceNow SDK.
Yokohama	You must have Node.js and Node Package Manager (npm) installed to install the ServiceNow SDK. For more information, see Install the ServiceNow SDK.

Browser requirements

If any specific browser requirements were introduced or changed for ServiceNow SDK we have noted them here.


Release	Release notes
Xanadu	No updates for this release.
Yokohama	No updates for this release.

Accessibility information

Review details on accessibility information for ServiceNow SDK, such as specific requirements or compliance levels.


Release	Release notes
Xanadu	No updates for this release.
Yokohama	No updates for this release.

Localization information

If there are specific localization considerations for ServiceNow SDK we have noted them here.


Release	Release notes
Xanadu	No updates for this release.
Yokohama	No updates for this release.

Highlight information

If there are specific highlight considerations for ServiceNow SDK we have noted them here.


Release	Release notes
Xanadu	Write source code to define the metadata that makes up applications with ServiceNow Fluent. See ServiceNow SDK for more information.
Yokohama	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.