To set up a scheduled poll that will query the remote system at regular intervals, check whether any new records have been created and then pass that data to Unifi, we will need to configure the following records:

• Poll Processor

• Poller

Once those records are configured, we will need to configure the relevant inbound and outbound messages to process and respond to the returned data. We will also need to make some further changes before we can test our create scenario (in order to identify which records to poll for). We will look at the polling records in turn over the next couple of pages.

Before configuring those polling records, let's first look at Connection Variables.

The Poll Processor is a configuration record which contains the logic that will be applied when polling a remote system for data. There are three main scripts which are used to setup, execute and process the Poll Requests. The scripts given here are examples of how you might configure your Poll. The details of yours may differ depending on your requirements.

New Poll Processor

In Unifi Integration Designer, click the 'Poll Processors' icon & then New.

The fields to be configured for the New Poll Processor modal are as follows:

Your New Poll Processor modal should look like this:

Submit and view to further configure the Poll Processor.

Setup Script

The Setup Script is the first script to run (it runs at the point in time the Poll Request is created). It is used to build the environment for the poll and define what it will do. We will use it to setup the URL that will be called.

Navigate to Scripts > Setup Script.

The Setup script field is to be configured as follows:

The code in the Setup script field should look like this:

// Configure the new Poll Request record
(function(poll_request, poller, params) {

    var gdt = new GlideDateTime();
    gdt.addSeconds(-1800);

    var connection = poller.getIntegration().getActiveConnection();
    var cvar = connection.getVariables();

    var user = connection.getBasicAuthUser();
    var time = connection.getData('last_update_time', (gdt + ''));
    var group = cvar.external_group + ''; //Poller Integration Support 
    var fields = cvar.base_fields + ',' + cvar.data_fields;

    var query = [
        'active=true',
        'correlation_idISEMPTY',
        'assignment_group=' + group,
        'sys_updated_by!=' + user,
        'sys_updated_on>' + time,
        'ORDERBYsys_updated_on'
    ];

    var uri_query = query.map(function(c) {
        return encodeURIComponent(c);
    }).join('%5E');

    poll_request.endpoint_url += '/table/incident?sysparm_query=' + uri_query +
        '&sysparm_fields=' + encodeURIComponent(fields) + '&sysparm_display_value=true' + '&sysparm_limit=10';

})(poll_request, poller, params);

Your Setup Script form should look like this:

Navigate to Request Script.

Request Script

The Request Script is used to reach into the remote system and execute the request. We will use the ServiceNow RESTMessageV2() web service to make a REST call to the URL defined in the Setup Script.

The Request script field is to be configured as follows:

The code in the Request script field should look like this:

// Process the request e.g. by executing a web service and returning the response
(function(poll_request, poller, connection, params) {

    var rm = new sn_ws.RESTMessageV2();
    rm.setEndpoint(poll_request.endpoint_url);
    rm.setHttpMethod('GET');
    rm.setRequestHeader('Accept', 'application/json');
    rm.setRequestHeader('Content-type', 'application/json');
    rm.setBasicAuth(connection.getBasicAuthUser(), connection.getBasicAuthPassword());

    // rm.setRequestBody(JSON.stringify(body));
    var resp = rm.execute();

    answer = resp.getBody() + '';

})(poll_request, poller, connection, params);

Your Request Script form should look like this:

Navigate to Response Script.

Response Script

The Response Script is used to process the information returned from the remote system. We will pass this data to Unifi to process.

The Response script field is to be configured as follows:

The code in the Response script field should look like this:

// Process the response returned by the request script
// The 'answer' variable from the request script is passed in here as the 'response' parameter 
(function(poll_request, poller, response, params) {

    var body = JSON.parse(response);

    // Process the result
    var conn = poller.getIntegration().getActiveConnection();
    var cvars = conn.getVariables();

    var poll_helper = new x_snd_eb.PollHelper(poll_request);
    var info = [];

    if (body.result.length == 0) {
        status = 'No Incident found';
        poll_request.response_status = status + '\n\n' + JSON.stringify(body, null, 2);
        return;
    }

    body.result.forEach(function(inc) {

        // Set up the payload object
        var pl = {
            message: {
                name: 'CreateIncidentInbound',
                source_reference: inc.sys_id
            },
            detail: {
                caller_id: inc.caller_id,
                short_description: inc.short_description,
                description: inc.description,
                state: inc.state,
                impact: inc.impact,
                urgency: inc.urgency
            }
        };

        // Set up the options object for message submission
        var opts = {
            //message_name: 'CreateIncidentInbound',
            payload: JSON.stringify(pl)
        };

        poll_helper.processInbound(opts);

        var inc_time = inc.sys_updated_on;
        info.push('Incident : ' + inc.number + ' (' + inc_time + ')');

        // Set last update time (if later)
        var conn_time = conn.getData('last_update_time', "");
        info.push('Conn Time : ' + conn_time);
        if (inc_time > conn_time) {
            conn.setData('last_update_time', inc_time);
        }

    });

    poll_request.response_status = info.join('\n') + '\n\n' + JSON.stringify(body, null, 2);

})(poll_request, poller, response, params);

var poll_helper = new x_snd_eb.PollHelper(poll_request);

poll_helper.processInbound(opts);

Your Response Script form should look like this:

Save the Poll Processor.

Now let's move on and configure the Poller.

A Poller is a configuration record which defines the frequency of polling and which logic to use (the logic itself is defined in the Poll Processor). Each time it is run, it creates a corresponding Poll Request record.

New Poller

Click the 'Pollers' icon & then New.

The fields to be configured for the New Poller modal are as follows:

*These fields are mandatory, or automatically defaulted to true.

Your New Poller modal should look like this:

Submit and view to further configure the Poller.

Details

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

Your Details form should look like this:

Navigate to Scheduling.

Scheduling

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

*This field is mandatory.

Your Scheduling form should look like this:

Save the Poller.

In order to process and respond to the inbound Requests, we next need to configure our Messages.

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.

Icons

The icons are:

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

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

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

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

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

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

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

Assignment Group

In your PDI, navigate to User Administration > Groups. Click New.

The fields to be configured for the Group New record are as follows:

Your Group New record should look like this:

Submit the record.

Variable: external_group

This variable will contain the sys id of the group created above. It will be used in the Poll Processor Setup script to identify which non-bonded Incidents to query.

To open Unifi Integration Designer, navigate to [ws] 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 'external_group' New Connection Variable fields to be configured are as follows:

*Value: Value may vary. Use the sys id of the group created in your PDI.

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

Click Submit.

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

Variable: base_fields

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

Click New.

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

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

Click Submit.

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

Variable: data_fields

This variable will contain fields which will be retrieved from the remote system, in addition to the required base_fields. We have chosen a sample selection of fields. You may choose different fields if you wish. However, the fields you select here must also be mapped with corresponding Field Records (more on that on the CreateIncidentInbound Fields page).

Click New.

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

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

Click Submit.

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

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