Upgrading Unifi
If you are using Advanced Datasets with query scripts, please be sure to read our Advanced Dataset Upgrade guide.
Upgrading Unifi
ShareLogic recommends upgrading Unifi whenever you upgrade your ServiceNow instance. Aligning these upgrades allows integration testing to occur alongside platform upgrade testing, which helps identify issues earlier and reduces the need for separate integration testing cycles.
When ServiceNow customers perform their normal upgrade testing, they are already validating their business processes. Including Unifi upgrades at this stage ensures integrations are tested as part of those processes and any defects can be identified quickly.
ShareLogic can also provide upgrade support. If you are planning an upgrade and would like assistance or standby support, contact ShareLogic in advance so we can ensure the appropriate resources are available.
As with any ServiceNow application upgrade, you should perform upgrades sequentially through your environments:
Development
Test / QA
Production
Notifications
Customers may be notified of new Unifi releases in three ways:
ServiceNow Store Notifications ServiceNow automatically notifies registered customers via email when a new version of an installed application is published to the ServiceNow Store.
ShareLogic Release Notifications ShareLogic may also notify customers directly via email when a new version of Unifi is released.
Unifi Designer Notification Unifi performs a daily check for new application versions. When an update is available, a notification badge appears in the Unifi Designer portal to alert administrators.
The automated version check only occurs if the scheduled job responsible for update checks is enabled and outbound access is not restricted by firewall rules. No telemetry is used and no customer data or instance information is transmitted as part of this process.
Compatibility and Support
Unifi is designed to be backwards compatible wherever possible, allowing existing integrations to continue operating without modification after an update.
As with the ServiceNow platform, ShareLogic supports the current release and the previous release (n-1) of Unifi. Customers running versions older than n-1 may be required to upgrade before receiving support.
Unifi can communicate with ServiceNow instances with or without Unifi installed. If Unifi is present on both instances, the versions do not need to match. Each instance operates independently, and integrations will continue to function normally even when the connected instances are running different Unifi versions.
Customers should review the release notes published on the ShareLogic documentation site before installing an update to understand any behavioural changes or required actions.
Versioning
Unifi uses semantic versioning in the format major.minor.patch, e.g. 1.2.3.
Major versions indicate a significant improvement or change to the platform, or where there is a higher risk of a breaking change. These releases may introduce new capabilities, architectural changes, or behavioural updates.
Minor versions include general improvements, enhancements, and bug fixes. Some changes may be significant, but they are not expected to introduce breaking changes.
Patch versions are primarily used as part of the release certification process. They may occasionally be used for very minor bug fixes that do not introduce new functionality or behavioural changes.
Release Notes
Release notes for every Unifi update are published on the ShareLogic documentation site and should be reviewed before installing an update.
Upgrade Process
The Unifi upgrade process consists of four main steps.
We recommend performing this at the same time as your ServiceNow upgrade to ensure integrations continue to operate as expected following platform and application upgrades.
1. Application Update
Navigate to System Applications > All Available Applications > All in ServiceNow.
Search for and select ShareLogic Unifi.
Select the version you want to upgrade to and click Proceed to update.
ServiceNow only allows installation of application versions that support the current ServiceNow platform version. If your instance is running an unsupported platform release, you must upgrade ServiceNow before installing the latest Unifi version.
2. Update Hotfix
Unifi has the ability to be patched between releases by using a special Script Include called hotfix.
If you previously modified this script, you may need to revert or reapply changes depending on the release notes for the update.
Full details can be found on the Hotfixes page.
3. Update Global Utility
Unifi has some powerful features that will only work with access to the global scope. Access is granted through the Unifi Global Utility.
We recommend updating this with each release to ensure you have the latest compatible utility.
Full details can be found on the Global Utility page.
4. Regression Testing
Testing is a fundamental part of maintaining reliable integrations. When validating business processes, customers should ensure that integration testing is performed alongside process testing, as integrations are often triggered as part of normal platform activity.
Unifi's built in Test Assistant can also be used to help validate integrations during upgrades.
When developing integrations, tests can be generated directly from Bonds. These tests can then be replayed throughout the lifecycle of the integration.
This allows you to:
Re-run integration tests after upgrades
Quickly detect regressions
Identify changes in payloads, processors, or mappings
If issues are identified, the recorded tests make it easier to reproduce the problem and update the integration configuration.
For more information, please see our Test Overview.
Last updated
Was this helpful?