Connection
The Connection allows messages to be sent and received and stores all the authentication details of the Integration specific to a single environment.
Before we configure our Connection, we need to ensure we have a user in the instance to use as the Inbound user for our Integration. To configure our Integration user:
In the native ServiceNow window, navigate to User Administration > Users. Click New.
The fields to be configured for the User record are as follows:
# | Field | Description | Value |
1 | User ID | The id of the user (to be used by the external system for authentication). | <your.integration_user> |
2 | First name | The integration user's first name. | <Your First Name> |
3 | Last name | The integration user's last name. | <Your Last Name> |
4 | Password | The user's password (to be used in basic authentication). | <Your Password> |
5 | Roles | The roles required for access to the integrated records. | 'itil', 'x_snd_eb_integration' |
Roles
itil: This role is given to access the table of the bonded record.
x_snd_eb_integration: This role is given to access the automatically created Web Service.
Your User record should look like this:
You can set up many connections to enable switching between environments (one connection per environment). However, only one connection can be active for an Integration at a time.
Remember: When setting up a Connection:
- Make sure your SOAP and/or REST endpoints are unique.
- Never use your own User as the Inbound User as it will prevent the integration from working.
- Always ensure that your Inbound User is NOT used by anyone else for the same Process i.e. if you’re creating a Connection for an Integration on the Incident Process, your Inbound User has to be the only User used by an Integration within that Process.
We are going to configure a Connection for the Development environment.
Back in the Unifi Integration Designer window, after clicking the 'Connections' icon, the first thing you will notice is a widget at the top of the page which clearly displays the inbound endpoints (REST Resources) which were automatically created when the Process was configured.
Clicking the link to the right of the Endpoint URL will open the Scripted REST Resource (in native ServiceNow) in a new window.
Click New.
The fields to be configured for the New Connection modal are as follows:
# | Field | Description | Value |
6 | Environment | The environment this connection applies to. | 'Development' |
7 | Endpoint URL | The external system's access URL. | <External system Endpoint URL> |
8 | Active | Use this connection for the integration when true. | <true> |
The format of the Endpoint URL is as follows:
https://<your_instance>.service-now.com/<your_resource_path>The entire Endpoint URL 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).
For this Development environment Connection, we will set the Endpoint URL to point to our own instance and use the same Integration User for both Inbound and Outbound (as created above). Being able to connect to our own instance makes it simple and efficient to test our integration (seeing Transactions going out and coming in) before we connect to the external system.
Your New Connection modal should look like this:
9) Click Submit and view.
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:
# | Field | Description | Value |
10 | Authentication | The authentication method to use for this connection. | 'Basic' |
11 | User | The username used in basic authentication. | <external.system.user> |
12 | Password | The password used in basic authentication. | <External system user password> |
13 | 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> |
Your Details form should look like this:
Feature Alert: The widget at the bottom of the page now shows the Integration as Active.
14) Save the Connection.
At this stage you can carry our a basic connection test which verifies whether the user is authorized (i.e. whether you've configured the user/password/roles correctly). To do this, click Connection Test.
Then, on the Connection Test modal, click Test.
The results (Pass/Fail) will be displayed.
Click Done.
The main, manually configured elements are now in place for our Integration to work. We are now ready to configure and test each of our Scenarios in turn.
Remember: There is no need to manually configure a Trigger (Business Rule) on the Process table being integrated as Unifi will automatically create one for us (if one doesn't already exist).
Last modified 2yr ago