In order to process the data that is returned from the remote system, we will need to create the appropriate messages in Unifi. To satisfy the requirements of this Guide, we will only need to configure the one message:

• UpdateIncidentInbound

We shall look in detail at how to configure that message and the appropriate message scripts over the next couple of pages.

Let's begin by configuring the UpdateIncidentInbound Message.

New Message Modal

Click the 'Messages' icon, then New.

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

Your UpdateIncidentInbound New Message modal should look like this:

5) Click Submit and view to further configure the Message.

Response Fields

Navigate to Message > Response.

The Response fields to be configured are as follows:

*This field is automatically defaulted to true.

Your Response form should look like this:

8) Navigate to Message > Bond.

Bond Fields

The Bond fields to be configured are as follows:

*These fields are automatically populated.

Your Bond form should look like this:

10) Navigate to Inbound > Settings.

Inbound Settings Fields

The Inbound Settings fields to be configured are as follows:

Your Inbound Settings form should look like this:

12) Click Save.

We are now ready to configure the Fields for our UpdateIncidentInbound Message.

Copy Field Maps

Some Field Maps should already have been copied for this Integration whilst following the Outbound Incident Guide. Those that aren't will need to be copied. The Field Maps we shall use for our UpdateIncidentInbound Field records are:

• Message Header

• String

To copy the Message Header Field Map, navigate to the 'Field Maps' icon.

1) Click on the ellipsis to the right of the Message Header Field Map & then click Copy.

Copy Field Map Modal

The fields to edit for the Copy Field Map modal are as follows:

Your Copy Field Map modal should look like this:

3) Click Copy.

You will be redirected to the Details page of the newly created Field Map.

If necessary, repeat the process for the String Field Map.

Field records can represent the handling of two categories of data: either a data object which carries transaction specific data (e.g. name, time stamp, source id etc.), or a field element on the bonded record (e.g. Short description). We will begin by configuring a Field record to deal with the transaction specific data.

Field: message.header

Back in the UpdateIncidentInbound Message, navigate to Message > Fields. Click New.

The fields to be configured for our message_header New Field modal are as follows:

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

**Field map: Value may vary. Choose the copy Field Map you created for your Integration.

Your 'message.header' New Field modal should look like this:

10) Submit the record.

You will be redirected back to the Fields page of the UpdateIncidentInbound Message.

Fields & Field Maps

Depending on your requirements, you will need to create Field records for each of the relevant Incident record field elements you wish to map. As we have only chosen to include the short_description & description elements in both the Setup script & Response script of the Poll Processor, this Guide will focus on those two. If you wish, however, you are free to configure other Field records as required (ensuring you also define them in both the Setup Script & Response script of the Poll Processor).

For a full description of the available Field Maps, please see the relevant page in our technical documentation.

The table below lists the Incident record field elements we will map and the relevant Field Maps required to configure each Field record.

*Field map: Values may vary (dependent on your configuration of the copies). Choose the copy Field Maps you created earlier.

Field: incident.short_description

From the UpdateIncidentInbound Message, navigate to Message > Fields.

Your UpdateIncidentInbound Fields page should look like this:

11) Find the incident.short_description (Integration level) Field & set Active to true.

By setting the Active flag to true on the Integration level Field record listed on the Message, Unifi has automatically created the Message level counterpart.

12) Click to open the incident.short_description (Message level) Field to make a few minor changes.

The incident.short_description Field record opens to the Details page.

13) Navigate to Field > Settings.

Edit the incident.short_description Field record as follows:

Your incident.short_description Field record should look like this:

17) Save the record.

Field: incident.description

To quickly navigate to the UpdateincidentInbound Message from the Details page of the incident.short_description Field record...

...click the 'Preview' icon to the left of the Message field.

From the UpdateIncidentInbound Message, navigate to Message > Fields.

18) Click the ellipsis next to the incident.short_desscription Field record & click Copy.

The fields to edit for the Copy Field modal are as follows:

*This field is automatically populated.

Your 'incident.description' Copy Field modal should look like this:

21) Click Copy.

You will be redirected to the Details page of the newly created incident.description Field record.

Build

Now that we’ve configured the Field records for the UpdateIncidentInbound message, we are ready to build our message scripts.

To quickly navigate to the UpdateIncidentInbound message from the Details page of the newly created incident.description Field record…

...click the 'Preview' icon to the left of the Message field.

The following Field records should now be in place for your UpdateIncidentInbound messsage:

22) Click on Build Message.

You will see the 'Message build successful' Info Message.

23) Navigate to Advanced > Script Editor > View > Inbound to view the auto-generated code.

Your Script Editor fields should look like this:

Message Scripts

The Message Scripts reflect the mappings as per this Guide. Your scripts might differ depending on which Fields you chose to map (& defined in the payload). We will look at the Message Scripts in turn.

Payload to Stage:

Your Payload to Stage Message Script should look like this:

//===== [ws] Begin Unifi Auto Generated Code =====//

/*
 * This code (between the Begin and End comments) is generated from the
 * Field and Field mapping records which are configured as part of the integration.
 *
 * All code either above or below the comments will be automatically maintained
 * through the build cycle.
 *
 * WARNING: Do not edit the Begin or End comments.
 */

x_snd_eb.ws_console.execute("Mapping incident.description [x_snd_eb_field.do?sys_id=ca8a9a761b42d0105830db9ebd4bcbe9]", function () {
  log.debug("Field map: IS - String [x_snd_eb_field_map.do?sys_id=006de8cddbf5985094dbd7795e96191e]");
  payload = payload || {};
  payload.detail = payload.detail || {};
  var $payload = payload.detail;

  // Determines whether this instance of the field map is for a mandatory field
  var is_mandatory = false;

  if (is_mandatory && $payload.description == undefined) {
    throw 'Mandatory field description was not provided';
  } else {
    $stage.description = $payload.description;
  }

});


x_snd_eb.ws_console.execute("Mapping incident.short_description [x_snd_eb_field.do?sys_id=6098f5761bce90105830db9ebd4bcb11]", function () {
  log.debug("Field map: IS - String [x_snd_eb_field_map.do?sys_id=006de8cddbf5985094dbd7795e96191e]");
  payload = payload || {};
  payload.detail = payload.detail || {};
  var $payload = payload.detail;

  // Determines whether this instance of the field map is for a mandatory field
  var is_mandatory = false;

  if (is_mandatory && $payload.short_description == undefined) {
    throw 'Mandatory field short_description was not provided';
  } else {
    $stage.short_description = $payload.short_description;
  }

});


x_snd_eb.ws_console.execute("Mapping message.header [x_snd_eb_field.do?sys_id=d0cdedba1b8e90105830db9ebd4bcb42]", function () {
  log.debug("Field map: IS - Message Header [x_snd_eb_field_map.do?sys_id=9e0d1d7a1b4e90105830db9ebd4bcb5f]");
  payload = payload || {};
  payload.message = payload.message || {};
  var $payload = payload.message;

  // Messge identifiers
  $stage.$message_name = $payload.name;
  $stage.$time_stamp   = $payload.time_stamp;

  // Task references
  stage.internal_reference = $payload.target_reference || '';
  stage.external_reference = $payload.source_reference || '';

  // Transaction identifiers
  transaction.external_message_id = $payload.source_id || '';



});

if (x_snd_eb.ws_console.has_error) {
  var errors = x_snd_eb.ws_console.get({type: 'error'});
  if (errors.length) {
    throw errors[0];
  }
}

//===== [ws] End Unifi Auto Generated Code =====//

Stage to Target:

Your Stage to Target Message Script should look like this:

//===== [ws] Begin Unifi Auto Generated Code =====//

/*
 * This code (between the Begin and End comments) is generated from the
 * Field and Field mapping records which are configured as part of the integration.
 *
 * All code either above or below the comments will be automatically maintained
 * through the build cycle.
 *
 * WARNING: Do not edit the Begin or End comments.
 */

x_snd_eb.ws_console.execute("Mapping incident.description [x_snd_eb_field.do?sys_id=ca8a9a761b42d0105830db9ebd4bcbe9]", function () {
  log.debug("Field map: IS - String [x_snd_eb_field_map.do?sys_id=006de8cddbf5985094dbd7795e96191e]");

  var default_value = (function () {
    return '';
  })();

  // Determines whether this instance of the field map is for a mandatory field
  var is_mandatory = false;

  if (is_mandatory && $stage.description == '') {
    throw 'Mandatory field description was not provided';
  } else {
    target.description = '' + ($stage.description || default_value);
  }

});


x_snd_eb.ws_console.execute("Mapping incident.short_description [x_snd_eb_field.do?sys_id=6098f5761bce90105830db9ebd4bcb11]", function () {
  log.debug("Field map: IS - String [x_snd_eb_field_map.do?sys_id=006de8cddbf5985094dbd7795e96191e]");

  var default_value = (function () {
    return '';
  })();

  // Determines whether this instance of the field map is for a mandatory field
  var is_mandatory = false;

  if (is_mandatory && $stage.short_description == '') {
    throw 'Mandatory field short_description was not provided';
  } else {
    target.short_description = '' + ($stage.short_description || default_value);
  }

});

if (x_snd_eb.ws_console.has_error) {
  var errors = x_snd_eb.ws_console.get({type: 'error'});
  if (errors.length) {
    throw errors[0];
  }
}

//===== [ws] End Unifi Auto Generated Code =====//

Before we test, we need to make a few changes. The first is to our Integration - to allow for inbound Message Identification.