UpdateIncidentInbound Fields

We will utilise the Field & Field Map records to configure the Message Scripts for the UpdateIncidentInbound Message.

Copy Field Maps

It is worth copying all relevant OOTB Field Maps as are necessary for your integration before using any of them in your Field Records - thereby mitigating the risk of any potential issues with future upgrades.

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:

#	Field	Description	Value
2	Name*	The name of your field map. (If left unedited, it will append the word 'Copy' to the existing name.)	<Your Name>

*Name: We have chosen to prefix the existing Field Map Name with the initials of our Integration (you are free to choose any appropriate means of identifying/differentiating).

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:

#	Field	Description	Value
*	Message	The Message this Field record is linked with.	'UpdateIncidentInbound'
4	Description	Describe what this field is for and any specific details that might help you in future.	‘The protocol message header’
*	Active	Set to true to use this Field record for processing.	<true>
5	Field map	The Field Map this Field record is linked with.	'IS - Message Header'**
6*	Map to field	Use this Field record to represent a field on a source/target table.	<false>
7	Path	Where in the payload the data will be placed.	'message'
8	Property	The property in the payload the data will be written to.	'header'
*	Inbound	Set to true to use for inbound Messages.	<true>
9*	Outbound	Set to true to use for outbound Messages.	<false>

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

Incident Field	Field Map
short_description	'PI - String'*
description	'PI - String'*

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

Field: incident.short_description

The ‘incident.short_description’ (Integration level) Field record should already be in place (i.e. with Active set to false). This was automatically created by Unifi when we first created the Message level record when completing the Outbound Incident Guide. We will now create its Message level counterpart.

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.

The empty circle icon next to the Field name turns green & contains a green ‘check’ (to indicate that Message level configuration exists for this Field) when we set Active to true. (The ‘Build Integration’ button became visible in the banner when we created the 'message.header' Field).

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.

The following info message is also displayed (which can be closed):

Field inheritance is set to true by default. This means the record will be updated with integration-level Field values when saved (except for Active, Inherit and Message values).

You can either uncheck the Inherit field to configure locally, or edit the integration-level Field record. We will choose to uncheck the Inherit field and configure locally, because we want this inbound Field to be different to the outbound one (and the integration-level Field which was automatically created at that time).

For more information on Field Inheritance click here.

13) Set Inherit to False.

14) Save the record (the fields now become editable).

15) Navigate to Field > Settings.

Edit the incident.short_description Field record as follows:

#	Field	Description	Value
16	Path	Where in the payload the data will be placed.	‘detail’
17	Inbound	Set to true to use for inbound Messages.	<true>
18	Outbound	Set to true to use for outbound Messages.	<false>

Your incident.short_description Field record should look like this:

19) Save the record.

Field: incident.description

Because the incident.description Field record is the same ‘type’ (PI - String) & the majority of the settings are the same as the previously configured Field, it will be quicker to copy the incident.short_description Field & make a few minor changes.

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.

20) 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:

#	Field	Description	Value
21	Element	The field on the source/target table this Field record is mapped to.	'Description'
*	Property	The property in the payload the data will be written to.	Automatically populated
22	Description	Describe what this field is for and any specific details that might help you in future.	'The incident's description'

*This field is automatically populated.

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

23) 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:

24) Click on Build Message.

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

25) Navigate to Advanced > Script Editor.

Your Script Editor fields should initially look like this:

26) Navigate to View > Inbound to view the auto-generated code.

Your Script Editor fields should now 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.checkpoint("MessageScript")

x_snd_eb.ws_console.execute("Mapping message.header [x_snd_eb_field.do?sys_id=ca3a65dc1ba57c1090dfdb9ebd4bcb90]", function () {
  log.debug("Field map: PI - Message Header [x_snd_eb_field_map.do?sys_id=a225651c1ba57c1090dfdb9ebd4bcbeb]");
  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 || '';
  
  

});


x_snd_eb.ws_console.execute("Mapping incident.short_description [x_snd_eb_field.do?sys_id=168aa99c1ba57c1090dfdb9ebd4bcbee]", function () {
  log.debug("Field map: PI - String [x_snd_eb_field_map.do?sys_id=da997f7a1b51b81090dfdb9ebd4bcb5e]");
  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 incident.description [x_snd_eb_field.do?sys_id=6178b5181be57c1090dfdb9ebd4bcbb1]", function () {
  log.debug("Field map: PI - String [x_snd_eb_field_map.do?sys_id=da997f7a1b51b81090dfdb9ebd4bcb5e]");
  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;
  }

});

var error = x_snd_eb.ws_console.findCheckpointError("MessageScript");
if (error) throw error.message;

//===== [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.checkpoint("MessageScript")

x_snd_eb.ws_console.execute("Mapping incident.short_description [x_snd_eb_field.do?sys_id=168aa99c1ba57c1090dfdb9ebd4bcbee]", function () {
  log.debug("Field map: PI - String [x_snd_eb_field_map.do?sys_id=da997f7a1b51b81090dfdb9ebd4bcb5e]");
  
  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);
  }

});


x_snd_eb.ws_console.execute("Mapping incident.description [x_snd_eb_field.do?sys_id=6178b5181be57c1090dfdb9ebd4bcbb1]", function () {
  log.debug("Field map: PI - String [x_snd_eb_field_map.do?sys_id=da997f7a1b51b81090dfdb9ebd4bcb5e]");
  
  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);
  }

});

var error = x_snd_eb.ws_console.findCheckpointError("MessageScript");
if (error) throw error.message;

//===== [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.