Reconfigure the Connections

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.

Create an Inbound User (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:

FieldDescriptionValue

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

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.

Edit the Connection (external instance)

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:

FieldDescriptionValue

Environment

The environment this connection applies to.

'Test'

Inbound user

The user profile used by the external system for authentication.

<Your Inbound user*>

*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).

Create a Test Connection (internal instance)

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:

FieldDescriptionValue

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>

Outbound Connectivity

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.

Connection Details

The fields to be configured for the Details form are as follows:

FieldDescriptionValue

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>

(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).

View Connections

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:

pageTest CreateIncidentpageTest UpdateIncidentpageTest ResolveIncident