--- sourceDocument: zurich Combined Product Files sourceDocumentLink: https://www.servicenow.com/docs/r/zurich/delta-yokohama-zurich Release : - zurich ft:locale : - en-US ft:publication_title : - zurich Combined Product Files ft:clusterId : - delta3zy bundleId : - delta3zy --- # Combined ServiceNow SDK release notes for upgrades from Yokohama to Zurich # Combined ServiceNow SDK release notes for upgrades from Yokohama to Zurich {#ariaid-title1} Release version: Zurich Updated October 8, 2026 ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 9 minutes to read Summarize ![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) 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 Combined ServiceNow SDK Release Notes for Upgrades from Yokohama to Zurich This document consolidates all key updates, new features, changes, deprecations, and upgrade instructions for the ServiceNow SDK from the Yokohama to Zurich releases. It is designed to help ServiceNow customers prepare for and execute upgrades smoothly while leveraging the latest SDK capabilities for application development and integration with ServiceNow instances. Show full answer Show less ## Important Upgrade Information * **Upgrade commands:** Use `now-sdk upgrade` to update between versions; note that the `now-sdk upgrade` command was deprecated in Zurich and replaced by updated upgrade procedures. * **Version support:** ServiceNow SDK versions 3.0 and 4.0 support integration with instances starting at the Washington DC release. * **Credential changes:** On Windows, after upgrading to SDK 4.3 or later, stored credentials must be re-added using `now-sdk auth --add` due to Keytar deprecation. * **Prerequisites:** Node.js and npm must be installed prior to SDK installation or upgrade. ## New Features * **Command enhancements:** The `now-sdk init` command replaces create and convert commands to initialize custom scoped applications and transform metadata into source code. * **ServiceNow Fluent APIs:** Introduced APIs for Flow, Service Catalog, Email Notification, Service Level Agreement, Dashboard, Workspace, Import Sets, UI Policy, Script Action, Script Include, Service Portal, UI Action, and UI Page to define and automate various ServiceNow components through source code. * **Custom directory mapping:** Configure metadata output directories and taxonomy-based directory structures to organize generated Fluent code efficiently. * **React integration:** Build full-stack user interfaces using React combined with ServiceNow UI Page API. * **Access control:** Manage trusted third-party modules accessing ServiceNow APIs via the `trustedModules` parameter. * **Enhanced type validation:** Utility functions provide build-time validation for complex property types like Duration, Time, Field List, and Template Value. * **Automated Test Framework API:** Supports additional test steps for comprehensive test automation. * **Improved dependency management:** Control download scope for dependencies and TypeScript definitions, including script includes used in JavaScript modules. ## Key Changes * **Authentication:** Parameters replaced subcommands in `now-sdk auth` to simplify credential management. * **Command renaming:** The `deploy` command was renamed to `install` for application installation and updates. * **Build process:** The `now-sdk build` command now compiles source files without packaging; packaging is done using `now-sdk pack` or `now-sdk install`. * **Two-way synchronization:** Automated Test Framework tests support syncing changes between source code and ServiceNow metadata. * **Table API enhancements:** Support for licensing configurations and remote tables added. * **Client-side TypeScript support:** Full-stack apps now support type checking and validation of client-side .ts and .tsx files. ## Deprecations and Removed Features * The `now-sdk convert` and `now-sdk fetch` commands were removed; use `now-sdk init` and `now-sdk transform` instead. * The `now-sdk upgrade` command was deprecated in Zurich; follow updated upgrade instructions for SDK version management. * The `$id` property in List and Role APIs is deprecated. * Snake case property names are deprecated in all ServiceNow Fluent APIs; use camel case equivalents. * No features were removed in Zurich or Yokohama releases outside these deprecations. ## Activation and Installation The ServiceNow SDK is distributed as a Node Package Manager (npm) package available publicly and installed locally. Installation requires Node.js and npm. For detailed installation and activation instructions, refer to the official ServiceNow SDK installation guides. ## Practical Benefits for ServiceNow Customers * Streamlined CLI commands simplify application creation, transformation, and deployment workflows. * Expanded Fluent APIs enable defining complex ServiceNow components in source code, improving automation and maintainability. * TypeScript support and utility types enhance code quality and validation both server- and client-side. * React integration supports modern UI development for full-stack applications. * Improved dependency and credential management increase security and ease of use. ## Next Steps * Review and complete all pre- and post-upgrade tasks before upgrading to Consolidated page of all release notes for ServiceNow SDK from Yokohama to Zurich. ## 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 Yokohama to Zurich. 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 Zurich Before you upgrade to Zurich, review these pre- and post-upgrade tasks and complete the tasks as needed. {#dfrn3-servicenowsdk-summary__entry__2} | Release | Release notes | |-|-| | Yokohama | Upgrade information : Upgrade to the latest version of the ServiceNow SDK with the `now-sdk upgrade` command. For more information, see [Upgrade the ServiceNow SDK](https://www.servicenow.com/docs/access?context=upgrade-servicenow-sdk&family=yokohama&ft:locale=en-US). 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](https://www.servicenow.com/community/servicenow-ide-sdk-and-fluent/tkb-p/ide-sdk-fluent-articles) in the ServiceNow Community. | | Zurich | Upgrade information : To upgrade to the latest version of the ServiceNow SDK globally or within an application, see [Upgrade the ServiceNow SDK](https://www.servicenow.com/docs/access?context=upgrade-servicenow-sdk&family=zurich&ft:locale=en-US). ServiceNow SDK version 4.0 supports integration with ServiceNow instances beginning with the Washington DC release. On Windows systems, after upgrading to ServiceNow SDK version 4.3 or later, existing stored credentials aren't supported due to the deprecation of Keytar. Users on Windows systems must add their user credentials again using the `now-sdk auth --add` command to authenticate with instances. For more information, see [Authenticate](https://www.servicenow.com/docs/access?context=authenticate-instance-now-sdk&family=zurich&ft:locale=en-US). Note: For more information about minor releases of the ServiceNow SDK, see the [ServiceNow SDK repository](https://github.com/ServiceNow/sdk/releases) on GitHub. | [ ] ## New features Between your current release family and Zurich, new features were introduced for ServiceNow SDK. {#dfrn3-servicenowsdk-summary__entry__8} | Release | Release notes | |-|-| | Yokohama | [Init command replaces create and convert commands](https://www.servicenow.com/docs/access?context=now-sdk-create-command&family=yokohama&ft:locale=en-US) : 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](https://www.servicenow.com/docs/access?context=now-sdk-transform-command&family=yokohama&ft:locale=en-US) : 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](https://www.servicenow.com/docs/access?context=servicenow-fluent&family=yokohama&ft:locale=en-US) : 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](https://www.servicenow.com/docs/access?context=servicenow-fluent-api-reference&family=yokohama&ft:locale=en-US) : 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](https://www.servicenow.com/docs/access?context=building-applications-source-code&family=yokohama&ft:locale=en-US) : 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. | | Zurich | [Flow API - ServiceNow Fluent](https://www.servicenow.com/docs/access?context=servicenow-fluent-api-reference&family=zurich&ft:locale=en-US) : Use the Flow API to create flows and subflows \[sys_hub_flow\] that automate business processes with reusable multiple-step components. [Service Catalog API - ServiceNow Fluent](https://www.servicenow.com/docs/access?context=servicenow-fluent-api-reference&family=zurich&ft:locale=en-US) : Use the Service Catalog API to define catalog items \[sc_cat_item\] and related aspects of service catalogs. [Email Notification API - ServiceNow Fluent](https://www.servicenow.com/docs/access?context=servicenow-fluent-api-reference&family=zurich&ft:locale=en-US) : Use the Email Notification API to define notifications \[sysevent_email_action\] that send automated emails. [Service Level Agreement API - ServiceNow Fluent](https://www.servicenow.com/docs/access?context=servicenow-fluent-api-reference&family=zurich&ft:locale=en-US) : Use the Service Level Agreement API to define service level agreements (SLAs) \[contract_sla\] that set the amount of time for a task to reach a specified condition. [Dashboard API - ServiceNow Fluent](https://www.servicenow.com/docs/access?context=servicenow-fluent-api-reference&family=zurich&ft:locale=en-US) : Use the Dashboard API to define dashboards \[par_dashboard\] for organizing and sharing data visually. [Workspace API - ServiceNow Fluent](https://www.servicenow.com/docs/access?context=servicenow-fluent-api-reference&family=zurich&ft:locale=en-US) : Use the Workspace API to define configurable workspace experiences for organizing and sharing data visually. [Allow access to ServiceNow APIs for third-party modules](https://www.servicenow.com/docs/access?context=building-applications-source-code&family=zurich&ft:locale=en-US) : Configure which third-party library modules to identify as trusted and have access to ServiceNow APIs with the `trustedModules` parameter in an application's now.config.json file. [Import Sets API](https://www.servicenow.com/docs/access?context=fluent-import-sets-api&family=zurich&ft:locale=en-US) : Use the Import Sets API to define transform maps \[sys_transform_map\] that specify how to transform and map data from the import set staging table to target tables. [UI Policy API](https://www.servicenow.com/docs/access?context=fluent-ui-policy-api&family=zurich&ft:locale=en-US) : Use the UI Policy API to define user interface policies \[sys_ui_policy\] that dynamically change the behavior of information on a form and control custom process flows for tasks. [Attach user images to records from source code](https://www.servicenow.com/docs/access?context=fluent-constructs&family=zurich&ft:locale=en-US) : Attach user images to records associated with metadata defined in source code with the `Now.attach` construct. [Use utility functions for additional type validation](https://www.servicenow.com/docs/access?context=servicenow-fluent-api-reference&family=zurich&ft:locale=en-US) : Use utility types that help validate values for properties that support the Duration (Duration()), Time (Time()), Field List (FieldList()), and Template Value (TemplateValue()) field types in ServiceNow Fluent APIs. Utility types provide validation at build time for tables both within and outside of an application. [Generated ServiceNow Fluent code organized in taxonomy-based directories](https://www.servicenow.com/docs/access?context=building-applications-source-code&family=zurich&ft:locale=en-US) : Configure a custom directory structure for metadata transformed into ServiceNow Fluent code with the `taxonomy` parameter in an application's now.config.json file. By default, generated ServiceNow Fluent files are organized in a taxonomy-based directory structure within the fluent/generated directory. [Specify which files to build as JavaScript modules](https://www.servicenow.com/docs/access?context=building-applications-source-code&family=zurich&ft:locale=en-US) : Configure which files to include or exclude when building JavaScript modules with the `serverModulesIncludePatterns` and `serverModulesExcludePatterns` parameters in an application's now.config.json file. [Develop a user interface with React](https://www.servicenow.com/docs/access?context=ui-development-react&family=zurich&ft:locale=en-US) : Develop a user interface with the React library and the UI Page API to build a full-stack application in source code. [Script Action API](https://www.servicenow.com/docs/access?context=fluent-script-action-api&family=zurich&ft:locale=en-US) : Use the Script Action API to define script actions \[sysevent_script_action\] that run when an event occurs. [Script Include API](https://www.servicenow.com/docs/access?context=fluent-script-include-api&family=zurich&ft:locale=en-US) : Use the Script Include API to define script includes \[sys_script_include\] that store JavaScript functions and classes for use by server-side scripts. [Service Portal API](https://www.servicenow.com/docs/access?context=fluent-service-portal-api&family=zurich&ft:locale=en-US) : Use the Service Portal API to create custom widgets \[sp_widget\] for portal pages. [UI Action API](https://www.servicenow.com/docs/access?context=fluent-ui-action-api&family=zurich&ft:locale=en-US) : Use the UI Action API to configure custom user interface actions \[sys_ui_action\], such as buttons, links, and context menu items on forms and lists. [UI Page API](https://www.servicenow.com/docs/access?context=fluent-ui-page-api&family=zurich&ft:locale=en-US) : Use the UI Page API to configure custom user interface pages \[sys_ui_page\] that display forms, dialogs, lists, and other UI components. [Download application metadata from an instance](https://www.servicenow.com/docs/access?context=servicenow-sdk-cli-commands&family=zurich&ft:locale=en-US) : Download application metadata (XML) from a ServiceNow instance to compare it with the metadata in your local application using the `now-sdk download` command. [Clean or package an application](https://www.servicenow.com/docs/access?context=servicenow-sdk-cli-commands&family=zurich&ft:locale=en-US) : Remove the build artifacts that were output with the previous build using the `now-sdk clean` command. You can also package the build artifacts that were output with the previous build into an installable ZIP file using the `now-sdk pack` command. | [ ] ## Changes Between your current release family and Zurich, some changes were made to existing ServiceNow SDK features. {#dfrn3-servicenowsdk-summary__entry__14} | Release | Release notes | |-|-| | Yokohama | [Subcommands replaced with parameters on the auth command](https://www.servicenow.com/docs/access?context=now-sdk-auth-command&family=yokohama&ft:locale=en-US) : Configure authentication credentials with the `--add`, `--delete`, `--list`, and `--use` parameters of the `now-sdk auth` command. [Dependencies command installs type definitions](https://www.servicenow.com/docs/access?context=now-sdk-dependencies-command&family=yokohama&ft:locale=en-US) : 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](https://www.servicenow.com/docs/access?context=now-sdk-build-command&family=yokohama&ft:locale=en-US) : 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](https://www.servicenow.com/docs/access?context=now-sdk-deploy-command&family=yokohama&ft:locale=en-US) : Install or update an application on a ServiceNow instance using the `now-sdk install` command. [Automated Test Framework Test API supports two-way synchronization](https://www.servicenow.com/docs/access?context=atf-test-now-ts&family=yokohama&ft:locale=en-US) : 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](https://www.servicenow.com/docs/access?context=table-api-now-ts&family=yokohama&ft:locale=en-US) : 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](https://www.servicenow.com/docs/access?context=table-api-now-ts&family=yokohama&ft:locale=en-US) : Create a remote table with the scriptable_table property in a Table object. | | Zurich | [Get type checking and validation of client-side TypeScript files](https://www.servicenow.com/docs/access?context=ui-development-react&family=zurich&ft:locale=en-US) : Full-stack TypeScript applications support type checking and validation of .ts and .tsx files in the src/client directory when building applications. [Manage dependencies with additional parameters on the dependencies command](https://www.servicenow.com/docs/access?context=now-sdk-dependencies-command&family=zurich&ft:locale=en-US) : Control which dependencies and TypeScript definitions to download with additional parameters on the `now-sdk dependencies` command. [Use additional column types with ServiceNow Fluent](https://www.servicenow.com/docs/access?context=table-api-now-ts&family=zurich&ft:locale=en-US) : Use the following additional types of table columns with ServiceNow Fluent APIs: Password2Column, GuidColumn, JsonColumn, NameValuePairsColumn, UrlColumn, EmailColumn, HTMLColumn, FloatColumn, MultiLineTextColumn, DurationColumn, TimeColumn, FieldListColumn, SlushBucketColumn, TemplateValueColumn, and ApprovalRulesColumn. [Download TypeScript definitions for script includes used in JavaScript modules](https://www.servicenow.com/docs/access?context=download-script-dependencies&family=zurich&ft:locale=en-US) : Download TypeScript definitions for script includes imported in JavaScript modules from an instance using the `now-sdk dependencies` command. [Apply a template to an existing application](https://www.servicenow.com/docs/access?context=now-sdk-create-command&family=zurich&ft:locale=en-US) : Add template files and directories for development in ServiceNow Fluent using the `--template` parameter with the `now-sdk init` command in an existing application. [Automated Test Framework API supports additional test steps](https://www.servicenow.com/docs/access?context=atf-test-now-ts&family=zurich&ft:locale=en-US) : Use the following test steps with the ServiceNow Fluent Automated Test Framework API. * atf.form.addAttachmentsToForm * atf.form_SP.addAttachmentsToForm * atf.server.addAttachmentsToExistingRecord * atf.server.runServerSideScript * atf.server.setOutputVariables [Build command doesn't package build artifacts](https://www.servicenow.com/docs/access?context=servicenow-sdk-cli-commands&family=zurich&ft:locale=en-US) : Use the `now-sdk pack` or `now-sdk install` commands to package build artifacts. The `now-sdk build` command compiles the source files but doesn't package the build artifacts. | [ ] ## Removed Between your current release family and Zurich, some ServiceNow SDK features or functionality were removed. {#dfrn3-servicenowsdk-summary__entry__20} | Release | Release notes | |-|-| | Yokohama | No updates for this release. | | Zurich | No updates for this release. | [ ] ## Deprecations Between your current release family and Zurich, some ServiceNow SDK features or functionality were deprecated. {#dfrn3-servicenowsdk-summary__entry__26} | Release | Release notes | |-|-| | 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. | | Zurich | * The `now-sdk upgrade` command has been removed. To upgrade the version of the ServiceNow SDK, see [Upgrade the ServiceNow SDK](https://www.servicenow.com/docs/access?context=upgrade-servicenow-sdk&family=zurich&ft:locale=en-US). * The $id property is deprecated in the List API and Role API. * Property names that use snake case are deprecated in all ServiceNow Fluent APIs. Use the equivalent property name in camel case instead. | [ ] ## Activation information Review information on how to activate ServiceNow SDK. {#dfrn3-servicenowsdk-summary__entry__32} | Release | Release notes | |-|-| | Yokohama | Activation information : The ServiceNow SDK is available as a Node Package Manager (npm) package from the [public npm registry](https://www.npmjs.com/package/@servicenow/sdk) and installed locally. For information about installing the ServiceNow SDK, see [Install the ServiceNow SDK](https://www.servicenow.com/docs/access?context=install-servicenow-sdk&family=yokohama&ft:locale=en-US). | | Zurich | Activation information : The ServiceNow SDK is available as a Node Package Manager (npm) package from the [public npm registry](https://www.npmjs.com/package/@servicenow/sdk) and installed locally. For information about installing the ServiceNow SDK, see [Install the ServiceNow SDK](https://www.servicenow.com/docs/access?context=install-servicenow-sdk&family=zurich&ft:locale=en-US). | [ ] ## Additional requirements If any additional requirements were introduced or changed for ServiceNow SDK we have noted them here. {#dfrn3-servicenowsdk-summary__entry__38} | Release | Release notes | |-|-| | Yokohama | 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](https://www.servicenow.com/docs/access?context=install-servicenow-sdk&family=yokohama&ft:locale=en-US). | | Zurich | 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](https://www.servicenow.com/docs/access?context=install-servicenow-sdk&family=zurich&ft:locale=en-US). | [ ] ## Browser requirements If any specific browser requirements were introduced or changed for ServiceNow SDK we have noted them here. {#dfrn3-servicenowsdk-summary__entry__44} | Release | Release notes | |-|-| | Yokohama | No updates for this release. | | Zurich | No updates for this release. | [ ] ## Accessibility information Review details on accessibility information for ServiceNow SDK, such as specific requirements or compliance levels. {#dfrn3-servicenowsdk-summary__entry__50} | Release | Release notes | |-|-| | Yokohama | No updates for this release. | | Zurich | No updates for this release. | [ ] ## Localization information If there are specific localization considerations for ServiceNow SDK we have noted them here. {#dfrn3-servicenowsdk-summary__entry__56} | Release | Release notes | |-|-| | Yokohama | No updates for this release. | | Zurich | No updates for this release. | [ ] ## Highlight information If there are specific highlight considerations for ServiceNow SDK we have noted them here. {#dfrn3-servicenowsdk-summary__entry__62} | Release | Release notes | |-|-| | 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](https://www.servicenow.com/docs/access?context=servicenow-sdk-landing&family=yokohama&ft:locale=en-US) for more information. | | Zurich | * Develop a user interface (UI) with React to build a full-stack application in source code. * Define flows, service catalogs, UI pages and more in source code with ServiceNow Fluent APIs. See [ServiceNow SDK](https://www.servicenow.com/docs/access?context=servicenow-sdk-landing&family=zurich&ft:locale=en-US) for more information. | [ ]