Connection Variables

Connection Variables can be especially useful if you have multiple connection environments - e.g. Dev, Test, Prod - each containing different data.

Although having mutiple environments may not apply to this integration, we will create Connection Variables to contain certain data values which will be substituted into the Poll Processor scripts.

Instead of scripting data values directly into the code of your Poll Processor scripts, it may be better practice to use Connection Variables in their place. Not only does it make those scripts cleaner, but it also means that changes in requirements can be more easily enacted by changing the values of the data in those variables, without having to change the code in the scripts.

We will use Connection Variables to identify the child Poller and to identify which field elements to return data from when polling.

Icons

Before continuing we would like to draw your attention to some of the relevant icons that will be visible down the left hand navigation strip in the Unifi Integration Designer.

The icons are:

a) 'Integration' icon: Opens the current integration's Details page.

b) 'Pollers' icon: Opens the current integration's Pollers page.

c) 'Poll Processors' icon: Opens the current integration's Poll Processors page.

d) 'Connections' icon: Opens the current integration's Connections page.

Variable: list_fields

This variable will contain the minimum set of fields required to identify and select records in the remote system.

To open Unifi Integration Designer, navigate to Unifi > Unifi Integration Designer, then navigate to < Your Integration > (created following the Outbound Incident Guide).

Click the 'Connections' icon, then navigate to and open < Your Connection >.

From the Connection, navigate to Connection > Variables & click New.

The 'list_fields' New Connection Variable fields to be configured are as follows:

#

Field

Description

Value

1

Key

A unique name that will be used to get the value.

'list_fields'

2

Value

The variable value to be used in the integration.

'sys_id,number,correlation_id'

3

Description

Describe what this connection variable is for and how it should be used.

<Your Description>

Your 'list_fields' New Connection Variable modal should look like this:

4) Click Submit.

You will be redirected back to the Variables page of the Connection record.

Variable: child_fields

This variable will contain all the fields which will be retrieved from the remote system by the child Poller.

Click New.

The 'child_fields' New Connection Variable fields to be configured are as follows:

#

Field

Description

Value

5

Key

A unique name that will be used to get the value.

'child_fields'

6

Value

The variable value to be used in the integration.

'sys_id,number,correlation_id,short_description,description, state,close_code,close_notes,sys_updated_on,sys_updated_by'*

7

Description

Describe what this connection variable is for and how it should be used.

<Your Description>

*The comma-separated list of fields with no spaces. (We have included a space for display purposes only - to make the list appear over two lines.)

Your 'child_fields' New Connection Variable modal should look like this:

8) Click Submit.

You will be redirected back to the Variables page of the Connection record.

Variable: incident_poller

This variable will contain the sys_id of the child Poller which we will create on the 'Child Poller' page of this Guide. Once you have created the Poller, copy the sys_id and paste it as the value in this variable.

The 'incident_poller' New Connection Variable fields to be configured are as follows:

#

Field

Description

Value

9

Key

A unique name that will be used to get the value.

'incident_poller'

10

Value

The variable value to be used in the integration.

<Your Value>*

11

Description

Describe what this connection variable is for and how it should be used.

<Your Description>

*Value may vary. Use the sys_id of the Poller you will create from the 'Child Poller' page.

Your 'incident_poller' New Connection Variable modal should look like this:

12) Click Submit.

The following Connection Variables should now be in place for your Connection:

Now let's move on and configure the Child Poll Processor.