Setup
The instructions on this page will enable you to get up and running with Unifi as quickly and efficiently as possible.
Overview
Follow these steps to install Unifi and get your system up and running quickly.
Install Unifi
Install Global Utility
Install Hotfix
Configure Your Integrations
1. Install Unifi
If you have purchased Unifi, you will need to ensure the instance you want to install Unifi on has been given entitlement to the application. You can manage this through the Store.
Once you have setup entitlement, you can use the Application Manager in ServiceNow to install Unifi. You can find more information on how to Install a ServiceNow Store Application in the ServiceNow Product Documentation.
If you have not yet purchased Unifi, you can request a trial from the ServiceNow Store.
2. Install Global Utility
Unifi has some enhanced 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.
It is strongly advised that you install this utility to get the most out of Unifi.
Download Unifi Global Utility 3.0
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.
Features
Moving Attachments
Method: snd_eb_util.moveAttachments
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.
Jelly Processing
Method: snd_eb_util.runJelly
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.
SOAP Response Element
Method: snd_eb_util.getSoapResponseElement
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.
Binary Attachment Handling
Method: snd_eb_util.writeAttachment
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.
Update Set Packaging
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.
Web Service Creation
Method: snd_eb_util.web_service
The web service methods included in the global utility allow Unifi to automatically create and update REST Methods.
Trigger (Business Rule) Creation
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.
3. Install Hotfix
Unifi has the ability to be patched between releases by using a special Script Include called hotfix.
Please go to the hotfixes page where you can see the hotfixes that have been made and apply them to Unifi.
4. Configure Your Integrations
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.
Last updated