Consolidated page of all release notes for ServiceNow SDK from Xanadu to Australia.
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 Australia.
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 Australia
Before you upgrade to Australia, 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.
|
Zurich |
To upgrade to the latest version of the ServiceNow SDK globally or within an application, see Upgrade the ServiceNow SDK.
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.
|
Australia |
To upgrade to the latest version of the ServiceNow SDK globally or within an application, see Upgrade the ServiceNow SDK.
ServiceNow SDK version 4.4 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.
|
New features
Between your current release family and Australia, 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 |
|
Zurich |
- Version 4.3
- Flow API - ServiceNow Fluent
- 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
- Use the Service Catalog API to define catalog items [sc_cat_item] and related aspects of service catalogs.
- Email Notification API - ServiceNow Fluent
- Use the Email Notification API to define notifications [sysevent_email_action] that send automated emails.
- Service Level Agreement API - ServiceNow Fluent
- 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
- Use the Dashboard API to define dashboards [par_dashboard] for organizing and sharing data visually.
- Workspace API - ServiceNow Fluent
- Use the Workspace API to define configurable workspace experiences for organizing and sharing data visually.
- Allow access to ServiceNow APIs for third-party modules
- 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.
- Version 4.2
- Import Sets API - ServiceNow Fluent
- 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 - ServiceNow Fluent
- 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
- Attach user images to records associated with metadata defined in source code with the
Now.attach construct.
- Use utility functions for additional type validation
- 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
- 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.
- Version 4.1
- Specify which files to build as JavaScript modules
- 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.
- Version 4.0
- Develop a user interface with React
- 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 - ServiceNow Fluent
- Use the Script Action API to define script actions [sysevent_script_action] that run when an event occurs.
- Script Include API - ServiceNow Fluent
- 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 - ServiceNow Fluent
- Use the Service Portal API to create custom widgets [sp_widget] for portal pages.
- UI Action API - ServiceNow Fluent
- 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 - ServiceNow Fluent
- 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
- 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
- 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.
|
Australia |
|
Changes
Between your current release family and Australia, 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 |
|
Zurich |
- Version 4.3
- Get type checking and validation of client-side TypeScript files
- Full-stack TypeScript applications support type checking and validation of .ts and .tsx files in the src/client directory when building applications.
- Version 4.2
- Manage dependencies with additional parameters on the dependencies command
- Control which dependencies and TypeScript definitions to download with additional parameters on the
now-sdk dependencies command.
- Use additional column types with ServiceNow Fluent
- 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.
- Version 4.1
- Download TypeScript definitions for script includes used in JavaScript modules
- 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
- Add template files and directories for development in ServiceNow Fluent using the
--template parameter with the now-sdk init command in an existing application.
- Version 4.0
- Automated Test Framework API supports additional test steps
- 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
- 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.
|
Australia |
|
Removed
Between your current release family and Australia, 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.
|
Zurich |
|
Australia |
No updates for this release. |
Deprecations
Between your current release family and Australia, some ServiceNow SDK features or functionality were deprecated.
| Release |
Release notes |
Xanadu |
No updates for this release. |
Yokohama |
No updates for this release. |
Zurich |
- 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.
|
Australia |
No updates for this release. |
Activation information
Review information on how to activate 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.
|
Zurich |
You must have Node.js and Node Package Manager (npm) installed to install the ServiceNow SDK. For more information, see Install the ServiceNow SDK.
|
Australia |
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. |
Zurich |
No updates for this release. |
Australia |
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. |
Zurich |
No updates for this release. |
Australia |
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. |
Zurich |
No updates for this release. |
Australia |
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.
|
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 for more information.
|
Australia |
Create or convert applications in the global scope with instances on the Australia release.
See ServiceNow SDK for more information.
|