Building the other half of our integration is much easier than you think.
If you're asking yourself, 'Do we have to do all that again?' the short answer is no, we don't. When using Unifi both ends, building the other half of the integration is a simple two-stage process.
First we Move the Integration, exporting it from one instance and importing it to the other (creating a mirror image in the other instance).
Second we Reconfigure the Connections so that each is pointed at the other.
We will look at both in more detail over the next couple of pages.
The first step to building the other half of the Integration is to export it from one instance and import it to the other.
NOTE: The ServiceNow System Administrator (admin) role is required to see the automatic download and view updates in the Update Set (and to select Application Scope - if required).
Using the Packager feature makes moving integrations between instances simpler and more efficient than ever.
In Unifi Integration Designer, navigate to and open < Your Integration >.
Click the 'Integration' icon to open the Details page.
Click Package.
The Package Integration modal is displayed.
Confirm by clicking Package.
Unifi packages the Integration into an Update Set which is automatically downloaded.
The Integration Package Worker modal is displayed.
The modal tells us how many records were processed and the name of the Update Set that was created (the integration name prepended with the date/time).
Copy the name of the Update Set.
Click Done to close the modal.
Navigate to the downloaded Update Set and Show in folder*.
*Example shown in Chrome. Other browsers may vary.
Then rename the file (using your Update Set name in order to easily identify it when uploading to the other instance).
In the Application Navigator of the external instance, navigate to System Update Sets > Retrieved Update Sets.
At the bottom of the Retrieved Update Sets list, click the Import Update Set from XML related link.
If you have the UI16 Developer Patch installed (download from Share __ by clicking here), you can navigate directly to the Import XML page from the context menu of the Update Set Picker by clicking Import from XML.
The Import XML screen is displayed:
Click Choose file to upload the previously downloaded file.
Upload.
You are redirected back to the Retrieved Update Sets list view:
Open the Update Set
Your Retrieved Update Set form is displayed:
Click Preview Update Set.
Close the Update Set Preview modal.
Click Commit Update Set.
Close the Update Set Commit progress modal.
We have successfully installed the application containing our Integration on the external instance. The vast majority of the configuration is already in place. All that remains is to make a few configuration changes and Reconfigure the Connections to enable each instance to connect with the other.
The next step in building the other half of the Integration is to reconfigure the connections.
Now that both halves of the Integration are in place, we need to reconfigure each of the Connections to point to the other instance. Before doing that though, we need to create a new Inbound User for the external instance.
To configure our Integration user:
In native ServiceNow, navigate to User Administration > Users. Click New.
The fields to be configured for the User record are as follows:
| Field | Description | Value |
|---|---|---|
The x_snd_eb.integration role gives access to the Unifi web services. You may need to assign additional roles depending on the process functionality used i.e. things like gs.hasRole(‘itil’) in business rules/scripts etc.
This Inbound user will become the Outbound user in the other instance. We will need to update the other instance accordingly.
We are going to edit the existing 'Development' Connection so that it will become our 'Test' Connection and use the Inbound user just created.
We will need to have our other instance point to this external one also (not only to itself). Therefore, we will create a new 'Test' Connection in the other instance to do that. (See the next section.)
In Unifi Integration Designer, navigate to the 'Connections' icon.
Click to open the previously created Development Connection to edit it.
Edit the values in the Connection as follows:
*Inbound user created above.
Your Connection form should look like this
We have not updated the Endpoint URL nor the Outbound User because they already contain the correct values (i.e. the internal instance's Endpoint & Inbound user).
Save the Connection.
At this stage you can carry our a basic Connection Test (as outlined on the Connection page of this guide).
Back in the internal instance, navigate to the 'Connections' icon. Click New.
We could have edited our existing 'Development' Connection to point to the external instance (instead of itself). We have chosen instead to create a new 'Test' Connection to do that. That way we have two Connections, a 'Development' Connection which points to itself and a 'Test' connection which points to the external instance.
The fields to be configured for the New Connection modal are as follows:
The entire Endpoint URL for this Test environment Connection can be easily obtained from the automatically created Message Resource on the Unifi Scripted REST API (displayed in the widget at the top of the Connections page of the external instance - as shown above).
For our Outbound User we will use the external system's Inbound User (as created above).
Your New Connection modal should look like this:
Submit and view to further configure the Connection.
Clicking ‘Submit’ will redirect you to the list view of the record you’re creating. Clicking ‘Submit and view' will redirect you to the newly created record.
The fields to be configured for the Details form are as follows:
(External) User/Password: As created above & set in the external instance.*
Your Details form should look like this:
Save the Connection.
As above, you can carry our a basic Connection Test (as outlined on the Connection page of this guide).
There will now be both a Development and a Test Connection for your Integration. Only the Test Connection should be Active.
These can be viewed by clicking the 'Connections' icon.
We have completed building the other half of the Integration. We are now ready to go back and repeat the Testing for each of the scenarios we've built.
See the following pages:
| Field | Description | Value |
|---|---|---|
| Field | Description | Value |
|---|---|---|
| Field | Description | Value |
|---|---|---|
User ID
The id of the user (to be used by the external system for authentication).
<your.integration.user>
First name
The integration user's first name.
<Your First Name>
Last name
The integration user's last name.
<Your Last Name>
Password
The user's password (to be used in basic authentication).
<Your Password>
Roles
The role required for access to the integrated records.
x_snd_eb.integration
Environment
The environment this connection applies to.
'Test'
Inbound user
The user profile used by the external system for authentication.
<Your Inbound user*>
Environment
The environment this connection applies to.
'Test'
Endpoint URL
The external system's access URL.
<External system Endpoint URL>
Active
Use this connection for the integration when true.
<true>
Authentication
The authentication method to use for this connection.
'Basic'
User*
The username used in basic authentication.
<external.system.user>
Password*
The password used in basic authentication.
<External system user password>
Inbound user
The user profile used by the external system for authentication. An active connection must be found for the user to gain access.
lookup: <Your Inbound User>
