Follow these steps to install or upgrade Unifi.
Unifi is exclusively available through the ServiceNow Store with a limited trial or paid subscription.
To install Unifi on your instance, you will need to ensure it has been given entitlement to the application. You must do this through the ServiceNow Store.
Once you have setup entitlement, you can use the Application Manager in your ServiceNow instance to install and upgrade Unifi. You can find more information on how to Install a ServiceNow Store Application in the ServiceNow Product Documentation.
When upgrading, make sure you also install the latest versions of Global Utility and Hotfix.
Unifi has some powerful features that will only work with access to the global scope. Access is granted through the Unifi Global Utility.
Full details can be found on the Global Utility page.
Unifi has the ability to be patched between releases by using a special Script Include called hotfix.
Full details can be found on the Hotfixes page.
You're good to start building your first integration or import one you already have.
If you’re new to Unifi then you might like to follow one of our integration guides. You can access the Integration Guides from the menu.
Unifi has some functionality that requires access to methods not available to scoped applications. We grant Unifi access to those methods through a single global utility Script Include which you can install via Update Set.
With version 4.0, the Update Set also includes a queue processing job Unifi dataset events process which is necessary for Datasets to be processed.
It is strongly advised that you install this utility to get the most out of Unifi.
Download Unifi Global Utility.
Import the file as an update set, then preview and commit it. You can find more information on how to Load customizations from a single XML file in the ServiceNow Product Documentation.
Method: snd_eb_util.executeNow(job)
This is necessary for Datasets to execute their associated ServiceNow Import Job.
Method: snd_eb_util.getSoapResponseElement(xml)
When working with Scripted SOAP Services, it’s important to be able to set the soapResponseElement directly in order to preserve the exact payload to be sent back to the calling system. This can only be done with the Global Utility.
Method: snd_eb_util.moveAttachments(attachment_ids, record)
The ServiceNow scoped attachment API does not support moving attachments from one record to another. This is necessary for inbound attachments which initially reside on the HTTP Request and are then moved to the Target record.
Method: snd_eb_util.runAsUser(user, fn)
On occasion, Unifi needs to run some code as the given user. This is necessary things like replaying requests.
Method: snd_eb_util.runJelly(jelly_code, vars)
Jelly processing is not supported in the ServiceNow scoped API’s, however it is very useful for XML processing. Use of the Global Utility drastically improves XML payload capabilities if you are working with XML payloads.
Method: snd_eb_util.validateScript(script, scope)
Used by the Unifi Integration Diagnostic to check scripts for errors.
Method: snd_eb_util.writeAttachment(record, filename, content_type, data)
The Scoped Attachment API does not support writing binary attachments which can cause problems when receiving things like Word documents or PDF’s. This method allows Unifi to use the global attachment API to write those files to the database meaning they will work properly.
Method: snd_eb_util.packager.*
The packager methods included in the global utility allow Unifi to automatically export all the components of an integration in one easy step. The packager methods will allow Unifi to create an update set for the integration, add all the configuration records to that update set, and export it as a file download from the Integration page on the Unifi Integration Designer portal.
Method: snd_eb_util.web_service.*
The web service methods included in the global utility allow Unifi to automatically create and update REST Methods used by Unifi integrations.
Method: snd_eb_util.trigger_rule.*
The trigger methods included in the global utility allow Unifi to automatically create a Trigger Business Rule on a table if one doesn't already exist.
Method: snd_eb_util.datasetCreateDataSource(dataset, attachment)
Create a data source for datasets to use when importing data.
Method: snd_eb_util.datasetDeleteScheduledImport(scheduled_import_id)
Delete a scheduled import that belongs to and was created by a Dataset. Used when deleting a Dataset.
Method: snd_eb_util.datasetDeleteTransformMap(transform_map_id)
Delete a transform map that belongs to and was created by a Dataset. Used when deleting a Dataset.
Method: snd_eb_util.datasetEnsureTransformMap(dataset)
Update a transform map for a Dataset to use when importing data. Used when building a Dataset.
Method: snd_eb_util.datasetUpdateTransformMapFields(dataset)
Update the coalesce fields for a transform map. Used when building a Dataset.
The current hotfix version is 4.1.2.3.
Unifi can be patched between releases by using a special Script Include called hotfix. If you find a bug in Unifi we may issue an update to hotfix so you can get the features you need without having to upgrade.
When upgrading Unifi, you can revert to the latest version of hotfix included in the upgrade. We reset hotfix with each release when the fixes become part of the main application.
We occasionally release a hotfix when minor issues are found. Simply replace the script in the hotfix Script Include with the one shown below and you will instantly have access to the fixes.
These hotfixes will be shipped as real fixes with the next version of Unifi, so make sure you have the correct hotfix for your version.