1 of 4

Resolve Scenario

For each of our Scenarios we will need to configure the relevant Messages & Fields. This scenario will need to be tested before moving on to the next.

The Message we shall be configuring for the Resolve Scenario is:

ResolveIncident

We will define which Field records require configuring for that Message at the appropriate time.

The scenario will need to be successfully tested before we can say it is complete.

We shall look in detail at the Message and its respective Fields in turn over the next few pages, before moving on to Test.

ResolveIncident Message

The ResolveIncident Message is an update type message that we will configure to deal specifically with our resolve scenario (resolve the bonded records).

Again, after clicking the 'Messages' icon, you are directed to the following screen (note: the four previously configured messages are now visible in the list):

Click the ellipsis to the right of the UpdateIncident Message & then click Copy.

It is now easier than ever to create the ResolveIncident Message. Rather than create it from scratch, it will be quicker to copy the UpdateIncident Message and make some minor changes.

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

Your Copy Message modal should look like this:

Click Copy.

You will be redirected to the Details page of the newly created ResolveIncident Message.

Bond Fields

Navigate to Message > Bond.

The Bond fields to be edited are as follows:

Your Bond form should look like this:

Navigate to Outbound > Trigger.

Outbound Trigger Fields

The Outbound Trigger (as required)* fields to be edited are as follows:

*Outbound condition (as required):

It is not necessary for you to enter a condition. The value given is an example. You may create any condition (or not) to align with your business process requirements. In this case, it makes sense to send the ResolveIncident Message when the state changes to Resolved.

Your Outbound Trigger form should look like this:

Click Save.

We are now ready to configure the Fields for the ResolveIncident Message.

ResolveIncident Fields

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

The 'incident.comments', 'incident.work_notes' and 'incident.short_description' Field records are already in place because they were also copied when we copied the Message. We can choose to include, or exclude as many of those and the Integration level ones that are available depending on our requirements (by either activating or deactivating the relevant Fields). We will choose to keep the existing Message level Fields and add the available incident.state (Integration level) Field.

Field: incident.state (Message level)

By simply setting the Active flag to true on the Integration level Field record listed on the Message, Unifi will automatically create the Message level counterpart.

Navigate to Message > Fields.

Your ResolveIncident Message Fields page should look like this:

Find the incident.state (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).

We will now configure Field records for the two remaining Incident record field elements which are required.

Fields & Field Maps

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.close_code (Message level)

There is no need to 'Generate field choices' for Message level Field records because the Field Map always looks for them on an Integration level Field which has the same name.

As with 'incident.state' the 'incident.close_code' Field record is a Choice 'type' Field. We will, therefore, configure the choices once at the Integration level. We'll first configure the Message level Field and then move on to configure the choices on its Integration level counterpart.

From the Fields page, click New.

The fields to be configured for our incident.close_code (Message level) 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 'incident.close_code' (Message level) New Field modal should look like this:

Submit the record.

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

Field: incident.close_code (Integration level)

We will need to 'Generate field choices' for this Integration level Choice 'type' Field.

Navigate to the 'Fields' icon to open the Fields page.

Click to open the incident.close_code (Integration level) Field record (the one where Message is empty).

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

Navigate to Field > Field Choices.

Click Generate field choices.

Click Generate on the 'Generate field choices' modal which displays.

The Field Choices are generated & now visible in the list.

Field: incident.close_notes

Because the incident.close_notes Field record is the same 'type' (PI - String) & the majority of the settings are the same as the incident.work_notes Field, it will be quicker to copy that Field & make a few minor changes.

From the ResolveIncident Message, navigate to Message > Fields.

Click the ellipsis next to the incident.work_notes Field record & click Copy.

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

*This field is automatically populated.

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

Click Copy.

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

The "This message inherits its configuration from the integration-level field..." 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 edit the integration-level because it makes more sense to have the same settings for each message-level incident.close_notes Field (i.e. each will be mandatory).

For more information on Field Inheritance click here.

Navigate to the 'Fields' icon to open the Fields page.

Click to open the incident.close_notes (Integration level) Field record (the one where Message is empty).

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

Navigate to Field > Settings.

Set Mandatory to true.

Click Save.

Build

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

Navigate to the ResolveIncident message, then navigate to Message > Fields.

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

Click on Build Message.

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

Navigate to Advanced > Script Editor to view the auto-generated code.

Your Script Editor fields should look like this:

Message Scripts

The newly auto-generated code will appear between a Begin & End Comment immediately prior to any code that was already there.

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

(New auto-generated code will appear here)

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

(Old pre-existing code will appear here)

We will now examine our new, auto-generated Message Scripts.

Source to Stage:

//===== [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=06fe6b771b193c1090dfdb9ebd4bcbe0]", 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 = '' + (source.short_description || default_value);
  } else if (source.short_description != '') {
    $stage.short_description = '' + source.short_description;
  }

});


x_snd_eb.ws_console.execute("Mapping incident.state [x_snd_eb_field.do?sys_id=f2db33f71b193c1090dfdb9ebd4bcbc5]", function () {
  log.debug("Field map: PI - Choice [x_snd_eb_field_map.do?sys_id=c7b97f7a1b51b81090dfdb9ebd4bcb62]");
  
  var default_value = (function () {
    return '';
  })();
  
  var field_choice;
  var is_mandatory = false;  
  
  if (!source.state.nil()) {
    field_choice = new GlideRecord('x_snd_eb_field_choice');
    field_choice.addQuery('table',         '=', 'incident');
    field_choice.addQuery('element',       '=', 'state');
    field_choice.addQuery('integration',   '=', '27be43a91b9db41090dfdb9ebd4bcb2e');
    field_choice.addQuery('field.message', '=', '');
    field_choice.addQuery('direction',     '=', 'Outbound');
    field_choice.addQuery('value',         '=', source.state);
    field_choice.addQuery('active',        '=', 'true');
    field_choice.query();
  
    if (field_choice.next()) {
      $stage.state = '' + field_choice.external_value;
    }
  } 
  
  if (!$stage.state) {
    $stage.state = '' + (source.state || '');
  }
  
  if (is_mandatory) {
    $stage.state = '' + (source.state || '');
  }

});


x_snd_eb.ws_console.execute("Mapping incident.comments [x_snd_eb_field.do?sys_id=79fe6b771b193c1090dfdb9ebd4bcbcd]", 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.comments = '' + (source.comments || default_value);
  } else if (source.comments != '') {
    $stage.comments = '' + source.comments;
  }

});


x_snd_eb.ws_console.execute("Mapping incident.work_notes [x_snd_eb_field.do?sys_id=4efe6b771b193c1090dfdb9ebd4bcbd1]", 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.work_notes = '' + (source.work_notes || default_value);
  } else if (source.work_notes != '') {
    $stage.work_notes = '' + source.work_notes;
  }

});


x_snd_eb.ws_console.execute("Mapping incident.close_code [x_snd_eb_field.do?sys_id=eaaff7bb1b193c1090dfdb9ebd4bcb6f]", function () {
  log.debug("Field map: PI - Choice [x_snd_eb_field_map.do?sys_id=c7b97f7a1b51b81090dfdb9ebd4bcb62]");
  
  var default_value = (function () {
    return '';
  })();
  
  var field_choice;
  var is_mandatory = true;  
  
  if (!source.close_code.nil()) {
    field_choice = new GlideRecord('x_snd_eb_field_choice');
    field_choice.addQuery('table',         '=', 'incident');
    field_choice.addQuery('element',       '=', 'close_code');
    field_choice.addQuery('integration',   '=', '27be43a91b9db41090dfdb9ebd4bcb2e');
    field_choice.addQuery('field.message', '=', '');
    field_choice.addQuery('direction',     '=', 'Outbound');
    field_choice.addQuery('value',         '=', source.close_code);
    field_choice.addQuery('active',        '=', 'true');
    field_choice.query();
  
    if (field_choice.next()) {
      $stage.close_code = '' + field_choice.external_value;
    }
  } 
  
  if (!$stage.close_code) {
    $stage.close_code = '' + (source.close_code || '');
  }
  
  if (is_mandatory) {
    $stage.close_code = '' + (source.close_code || '');
  }

});


x_snd_eb.ws_console.execute("Mapping incident.close_notes [x_snd_eb_field.do?sys_id=0bd508401b693c1090dfdb9ebd4bcb5a]", 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 = true;
  
  if (is_mandatory) {
    $stage.close_notes = '' + (source.close_notes || default_value);
  } else if (source.close_notes != '') {
    $stage.close_notes = '' + source.close_notes;
  }

});

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

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

Stage to Request:

//===== [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=06fe6b771b193c1090dfdb9ebd4bcbe0]", function () {
  log.debug("Field map: PI - String [x_snd_eb_field_map.do?sys_id=da997f7a1b51b81090dfdb9ebd4bcb5e]");
  payload = payload || {};
  var $payload = payload;
  
  // Determines whether this instance of the field map is for a mandatory field
  var is_mandatory = false;
  
  if (is_mandatory) {
    $payload.short_description = '' + $stage.short_description;
  } else if ($stage.short_description) {
    $payload.short_description = '' + $stage.short_description;
  }

});


x_snd_eb.ws_console.execute("Mapping incident.state [x_snd_eb_field.do?sys_id=f2db33f71b193c1090dfdb9ebd4bcbc5]", function () {
  log.debug("Field map: PI - Choice [x_snd_eb_field_map.do?sys_id=c7b97f7a1b51b81090dfdb9ebd4bcb62]");
  payload = payload || {};
  var $payload = payload;
  
  var is_mandatory = false;  
  
  if (is_mandatory) {
    $payload.state = $stage.state;
  } else if ($stage.state) {
    $payload.state = $stage.state;
  }

});


x_snd_eb.ws_console.execute("Mapping incident.comments [x_snd_eb_field.do?sys_id=79fe6b771b193c1090dfdb9ebd4bcbcd]", function () {
  log.debug("Field map: PI - String [x_snd_eb_field_map.do?sys_id=da997f7a1b51b81090dfdb9ebd4bcb5e]");
  payload = payload || {};
  var $payload = payload;
  
  // Determines whether this instance of the field map is for a mandatory field
  var is_mandatory = false;
  
  if (is_mandatory) {
    $payload.comments = '' + $stage.comments;
  } else if ($stage.comments) {
    $payload.comments = '' + $stage.comments;
  }

});


x_snd_eb.ws_console.execute("Mapping incident.work_notes [x_snd_eb_field.do?sys_id=4efe6b771b193c1090dfdb9ebd4bcbd1]", function () {
  log.debug("Field map: PI - String [x_snd_eb_field_map.do?sys_id=da997f7a1b51b81090dfdb9ebd4bcb5e]");
  payload = payload || {};
  var $payload = payload;
  
  // Determines whether this instance of the field map is for a mandatory field
  var is_mandatory = false;
  
  if (is_mandatory) {
    $payload.work_notes = '' + $stage.work_notes;
  } else if ($stage.work_notes) {
    $payload.work_notes = '' + $stage.work_notes;
  }

});


x_snd_eb.ws_console.execute("Mapping incident.close_code [x_snd_eb_field.do?sys_id=eaaff7bb1b193c1090dfdb9ebd4bcb6f]", function () {
  log.debug("Field map: PI - Choice [x_snd_eb_field_map.do?sys_id=c7b97f7a1b51b81090dfdb9ebd4bcb62]");
  payload = payload || {};
  var $payload = payload;
  
  var is_mandatory = true;  
  
  if (is_mandatory) {
    $payload.close_code = $stage.close_code;
  } else if ($stage.close_code) {
    $payload.close_code = $stage.close_code;
  }

});


x_snd_eb.ws_console.execute("Mapping incident.close_notes [x_snd_eb_field.do?sys_id=0bd508401b693c1090dfdb9ebd4bcb5a]", function () {
  log.debug("Field map: PI - String [x_snd_eb_field_map.do?sys_id=da997f7a1b51b81090dfdb9ebd4bcb5e]");
  payload = payload || {};
  var $payload = payload;
  
  // Determines whether this instance of the field map is for a mandatory field
  var is_mandatory = true;
  
  if (is_mandatory) {
    $payload.close_notes = '' + $stage.close_notes;
  } else if ($stage.close_notes) {
    $payload.close_notes = '' + $stage.close_notes;
  }

});

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

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

We are now ready to Test the ResolveIncident Message.

Test ResolveIncident

We will test our ResolveIncident Message.

Resolve The Incident

Navigate to < Your Incident > created in the earlier test.

Update the Incident record as follows:

Field

Description

Value

Your Incident record should look like this:

Right-click & Save.

You should see an Info Message, confirming the ResolveIncident Message is being sent to your Integration:

The Activities stream is updated with the details:

View the Bond

Click through to the Bond record from the related list on the Incident.

Your Bond record should have been updated as follows:

Transaction:

Message: 'Resolveincident'
Direction: 'Outbound'
Transaction state: 'Complete' (The data has been successfully transported)
Process state: 'Accepted' (The transaction was accepted as within the scope of the business logic that's in place)

View the Transaction

Click through to the Transaction record from the related list on the Bond.

Your Transaction record should look like this:

Transaction details:

Table: 'Incident [incident]'
Document: < Your Incident >
Integration: < Your Integration >
Connection: < Your Connection >
Bond: < Your Bond >
Message: 'ResolveIncident'
Direction: 'Outbound'
Transaction state: 'Complete' (The data has been successfully transported)
Process state: 'Accepted' (The transaction was accepted as within the scope of the business logic that's in place)

Errors:

Error: (If there was a transactional error the Transaction state would show as 'Error' and the details would be captured here).
Process error: (If there was a process error the Process state would show as 'Rejected' and the details would be captured here)

Stage:

Direction: 'Outbound'
Message: 'ResolveIncident'
Internal reference: < ServiceNow ticket reference > (Same as 'Document')
External reference: < External system's ticket reference >

View the Stage

Click through to the Stage record from the related list on the Transaction.

Check the values in the fields match what you expect.

Your Stage record should look like this:

Stage details:

Direction: 'Outbound'
External reference: < External system's ticket reference >
Internal reference: < ServiceNow ticket reference >
Snapshot: < Snapshot record reference >
Message: 'ResolveIncident'
Transaction: < Your Transaction >
Integration: < Your Integration >

Mapped Staged Data fields:

close_code: < Your Resolution code >
close_notes: < Your Resolution notes >
state: '6'

View the HTTP Request

Click through to the HTTP Request record from the related list on the Transaction.

Your HTTP Request record should look like this:

HTTP Request details:

Integration: < Your Integration >
Connection: < Your Connection >
Transaction: < Your Transaction >
Message: 'ResolveIncident'
Direction: 'Outbound'
Request state: 'OK' (There are no errors with the HTTP Request.)
Attempt number: < Number of HTTP Request attempts > (Failed requests are retried up to the maximum attempts number as configured on the Integration.)
Endpoint URL: < The external system’s access URL >
Action Method: 'PUT'
Request headers: < The header of the request being sent >
Request payload: < The payload of the request being sent >

Response details:

Status code: '200'
Response headers: < The header of the response being received >
Response payload: < The payload of the response being received >

Compare with the External System's Incident

Navigate to the corresponding Incident in the external system.

Check the values in the fields match those you noted when you saved the Incident in the internal system.

Your external system's Incident record should look like this (depending on the system you're integrating with, your record may look different; the important matter is that the values match):

State: 'Resolved'

Activities: < Your Resolution code/notes & State > (added by < your.external.system.user >)

Navigate to the Resolution Information tab.

Your Resolution Information tab should look like this:

Resolution code: < Your Resolution code >

Resolution notes: < Your Resolution notes >

So far, when configuring our scenarios we have built the Message Scripts for each Message individually. Let's now see how we can run the Build process at the Integration level.

Test ResolveIncident

We will test our ResolveIncident Message.

Resolve The Incident

Navigate to < Your Incident > created in the earlier test.

Update the Incident record as follows:

Field

Description

Value

Your Incident record should look like this:

Right-click & Save.

You should see an Info Message, confirming the ResolveIncident Message is being sent to your Integration:

The Activities stream is updated with the details:

View the Bond

Click through to the Bond record from the related list on the Incident.

Your Bond record should have been updated as follows:

Transaction:

Message: 'Resolveincident'
Direction: 'Outbound'
Transaction state: 'Complete' (The data has been successfully transported)
Process state: 'Accepted' (The transaction was accepted as within the scope of the business logic that's in place)

View the Transaction

Click through to the Transaction record from the related list on the Bond.

Your Transaction record should look like this:

Transaction details:

Table: 'Incident [incident]'
Document: < Your Incident >
Integration: < Your Integration >
Connection: < Your Connection >
Bond: < Your Bond >
Message: 'ResolveIncident'
Direction: 'Outbound'
Transaction state: 'Complete' (The data has been successfully transported)
Process state: 'Accepted' (The transaction was accepted as within the scope of the business logic that's in place)

Errors:

Error: (If there was a transactional error the Transaction state would show as 'Error' and the details would be captured here).
Process error: (If there was a process error the Process state would show as 'Rejected' and the details would be captured here)

Stage:

Direction: 'Outbound'
Message: 'ResolveIncident'
Internal reference: < ServiceNow ticket reference > (Same as 'Document')
External reference: < External system's ticket reference >

View the Stage

Click through to the Stage record from the related list on the Transaction.

Check the values in the fields match what you expect.

Your Stage record should look like this:

Stage details:

Direction: 'Outbound'
External reference: < External system's ticket reference >
Internal reference: < ServiceNow ticket reference >
Snapshot: < Snapshot record reference >
Message: 'ResolveIncident'
Transaction: < Your Transaction >
Integration: < Your Integration >

Mapped Staged Data fields:

close_code: < Your Resolution code >
close_notes: < Your Resolution notes >
state: '6'

View the HTTP Request

Click through to the HTTP Request record from the related list on the Transaction.

Your HTTP Request record should look like this:

HTTP Request details:

Integration: < Your Integration >
Connection: < Your Connection >
Transaction: < Your Transaction >
Message: 'ResolveIncident'
Direction: 'Outbound'
Request state: 'OK' (There are no errors with the HTTP Request.)
Attempt number: < Number of HTTP Request attempts > (Failed requests are retried up to the maximum attempts number as configured on the Integration.)
Endpoint URL: < The external system’s access URL >
Action Method: 'PUT'
Request headers: < The header of the request being sent >
Request payload: < The payload of the request being sent >

Response details:

Status code: '200'
Response headers: < The header of the response being received >
Response payload: < The payload of the response being received >

Compare with the External System's Incident

Navigate to the corresponding Incident in the external system.

Check the values in the fields match those you noted when you saved the Incident in the internal system.

Your external system's Incident record should look like this (depending on the system you're integrating with, your record may look different; the important matter is that the values match):

State: 'Resolved'

Activities: < Your Resolution code/notes & State > (added by < your.external.system.user >)

Navigate to the Resolution Information tab.

Your Resolution Information tab should look like this:

Resolution code: < Your Resolution code >

Resolution notes: < Your Resolution notes >

So far, when configuring our scenarios we have built the Message Scripts for each Message individually. Let's now see how we can run the Build process at the Integration level.

ResolveIncident Fields

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

Field: incident.state (Message level)

By simply setting the Active flag to true on the Integration level Field record listed on the Message, Unifi will automatically create the Message level counterpart.

Navigate to Message > Fields.

Your ResolveIncident Message Fields page should look like this:

Find the incident.state (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).

We will now configure Field records for the two remaining Incident record field elements which are required.

Fields & Field Maps

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

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

Field: incident.close_code (Message level)

There is no need to 'Generate field choices' for Message level Field records because the Field Map always looks for them on an Integration level Field which has the same name.

From the Fields page, click New.

The fields to be configured for our incident.close_code (Message level) New Field modal are as follows:

Field

Description

Value

*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 'incident.close_code' (Message level) New Field modal should look like this:

Submit the record.

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

Field: incident.close_code (Integration level)

We will need to 'Generate field choices' for this Integration level Choice 'type' Field.

Navigate to the 'Fields' icon to open the Fields page.

Click to open the incident.close_code (Integration level) Field record (the one where Message is empty).

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

Navigate to Field > Field Choices.

Click Generate field choices.

Click Generate on the 'Generate field choices' modal which displays.

The Field Choices are generated & now visible in the list.

Field: incident.close_notes

From the ResolveIncident Message, navigate to Message > Fields.

Click the ellipsis next to the incident.work_notes Field record & click Copy.

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

Field

Description

Value

*This field is automatically populated.

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

Click Copy.

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

The "This message inherits its configuration from the integration-level field..." 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).

For more information on Field Inheritance click here.

Navigate to the 'Fields' icon to open the Fields page.

Click to open the incident.close_notes (Integration level) Field record (the one where Message is empty).

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

Navigate to Field > Settings.

Set Mandatory to true.

Click Save.

Build

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

Navigate to the ResolveIncident message, then navigate to Message > Fields.

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

Click on Build Message.

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

Navigate to Advanced > Script Editor to view the auto-generated code.

Your Script Editor fields should look like this:

Message Scripts

The newly auto-generated code will appear between a Begin & End Comment immediately prior to any code that was already there.

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

(New auto-generated code will appear here)

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

(Old pre-existing code will appear here)

We will now examine our new, auto-generated Message Scripts.

Source to Stage:

//===== [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=06fe6b771b193c1090dfdb9ebd4bcbe0]", 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 = '' + (source.short_description || default_value);
  } else if (source.short_description != '') {
    $stage.short_description = '' + source.short_description;
  }

});


x_snd_eb.ws_console.execute("Mapping incident.state [x_snd_eb_field.do?sys_id=f2db33f71b193c1090dfdb9ebd4bcbc5]", function () {
  log.debug("Field map: PI - Choice [x_snd_eb_field_map.do?sys_id=c7b97f7a1b51b81090dfdb9ebd4bcb62]");
  
  var default_value = (function () {
    return '';
  })();
  
  var field_choice;
  var is_mandatory = false;  
  
  if (!source.state.nil()) {
    field_choice = new GlideRecord('x_snd_eb_field_choice');
    field_choice.addQuery('table',         '=', 'incident');
    field_choice.addQuery('element',       '=', 'state');
    field_choice.addQuery('integration',   '=', '27be43a91b9db41090dfdb9ebd4bcb2e');
    field_choice.addQuery('field.message', '=', '');
    field_choice.addQuery('direction',     '=', 'Outbound');
    field_choice.addQuery('value',         '=', source.state);
    field_choice.addQuery('active',        '=', 'true');
    field_choice.query();
  
    if (field_choice.next()) {
      $stage.state = '' + field_choice.external_value;
    }
  } 
  
  if (!$stage.state) {
    $stage.state = '' + (source.state || '');
  }
  
  if (is_mandatory) {
    $stage.state = '' + (source.state || '');
  }

});


x_snd_eb.ws_console.execute("Mapping incident.comments [x_snd_eb_field.do?sys_id=79fe6b771b193c1090dfdb9ebd4bcbcd]", 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.comments = '' + (source.comments || default_value);
  } else if (source.comments != '') {
    $stage.comments = '' + source.comments;
  }

});


x_snd_eb.ws_console.execute("Mapping incident.work_notes [x_snd_eb_field.do?sys_id=4efe6b771b193c1090dfdb9ebd4bcbd1]", 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.work_notes = '' + (source.work_notes || default_value);
  } else if (source.work_notes != '') {
    $stage.work_notes = '' + source.work_notes;
  }

});


x_snd_eb.ws_console.execute("Mapping incident.close_code [x_snd_eb_field.do?sys_id=eaaff7bb1b193c1090dfdb9ebd4bcb6f]", function () {
  log.debug("Field map: PI - Choice [x_snd_eb_field_map.do?sys_id=c7b97f7a1b51b81090dfdb9ebd4bcb62]");
  
  var default_value = (function () {
    return '';
  })();
  
  var field_choice;
  var is_mandatory = true;  
  
  if (!source.close_code.nil()) {
    field_choice = new GlideRecord('x_snd_eb_field_choice');
    field_choice.addQuery('table',         '=', 'incident');
    field_choice.addQuery('element',       '=', 'close_code');
    field_choice.addQuery('integration',   '=', '27be43a91b9db41090dfdb9ebd4bcb2e');
    field_choice.addQuery('field.message', '=', '');
    field_choice.addQuery('direction',     '=', 'Outbound');
    field_choice.addQuery('value',         '=', source.close_code);
    field_choice.addQuery('active',        '=', 'true');
    field_choice.query();
  
    if (field_choice.next()) {
      $stage.close_code = '' + field_choice.external_value;
    }
  } 
  
  if (!$stage.close_code) {
    $stage.close_code = '' + (source.close_code || '');
  }
  
  if (is_mandatory) {
    $stage.close_code = '' + (source.close_code || '');
  }

});


x_snd_eb.ws_console.execute("Mapping incident.close_notes [x_snd_eb_field.do?sys_id=0bd508401b693c1090dfdb9ebd4bcb5a]", 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 = true;
  
  if (is_mandatory) {
    $stage.close_notes = '' + (source.close_notes || default_value);
  } else if (source.close_notes != '') {
    $stage.close_notes = '' + source.close_notes;
  }

});

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

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

Stage to Request:

//===== [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=06fe6b771b193c1090dfdb9ebd4bcbe0]", function () {
  log.debug("Field map: PI - String [x_snd_eb_field_map.do?sys_id=da997f7a1b51b81090dfdb9ebd4bcb5e]");
  payload = payload || {};
  var $payload = payload;
  
  // Determines whether this instance of the field map is for a mandatory field
  var is_mandatory = false;
  
  if (is_mandatory) {
    $payload.short_description = '' + $stage.short_description;
  } else if ($stage.short_description) {
    $payload.short_description = '' + $stage.short_description;
  }

});


x_snd_eb.ws_console.execute("Mapping incident.state [x_snd_eb_field.do?sys_id=f2db33f71b193c1090dfdb9ebd4bcbc5]", function () {
  log.debug("Field map: PI - Choice [x_snd_eb_field_map.do?sys_id=c7b97f7a1b51b81090dfdb9ebd4bcb62]");
  payload = payload || {};
  var $payload = payload;
  
  var is_mandatory = false;  
  
  if (is_mandatory) {
    $payload.state = $stage.state;
  } else if ($stage.state) {
    $payload.state = $stage.state;
  }

});


x_snd_eb.ws_console.execute("Mapping incident.comments [x_snd_eb_field.do?sys_id=79fe6b771b193c1090dfdb9ebd4bcbcd]", function () {
  log.debug("Field map: PI - String [x_snd_eb_field_map.do?sys_id=da997f7a1b51b81090dfdb9ebd4bcb5e]");
  payload = payload || {};
  var $payload = payload;
  
  // Determines whether this instance of the field map is for a mandatory field
  var is_mandatory = false;
  
  if (is_mandatory) {
    $payload.comments = '' + $stage.comments;
  } else if ($stage.comments) {
    $payload.comments = '' + $stage.comments;
  }

});


x_snd_eb.ws_console.execute("Mapping incident.work_notes [x_snd_eb_field.do?sys_id=4efe6b771b193c1090dfdb9ebd4bcbd1]", function () {
  log.debug("Field map: PI - String [x_snd_eb_field_map.do?sys_id=da997f7a1b51b81090dfdb9ebd4bcb5e]");
  payload = payload || {};
  var $payload = payload;
  
  // Determines whether this instance of the field map is for a mandatory field
  var is_mandatory = false;
  
  if (is_mandatory) {
    $payload.work_notes = '' + $stage.work_notes;
  } else if ($stage.work_notes) {
    $payload.work_notes = '' + $stage.work_notes;
  }

});


x_snd_eb.ws_console.execute("Mapping incident.close_code [x_snd_eb_field.do?sys_id=eaaff7bb1b193c1090dfdb9ebd4bcb6f]", function () {
  log.debug("Field map: PI - Choice [x_snd_eb_field_map.do?sys_id=c7b97f7a1b51b81090dfdb9ebd4bcb62]");
  payload = payload || {};
  var $payload = payload;
  
  var is_mandatory = true;  
  
  if (is_mandatory) {
    $payload.close_code = $stage.close_code;
  } else if ($stage.close_code) {
    $payload.close_code = $stage.close_code;
  }

});


x_snd_eb.ws_console.execute("Mapping incident.close_notes [x_snd_eb_field.do?sys_id=0bd508401b693c1090dfdb9ebd4bcb5a]", function () {
  log.debug("Field map: PI - String [x_snd_eb_field_map.do?sys_id=da997f7a1b51b81090dfdb9ebd4bcb5e]");
  payload = payload || {};
  var $payload = payload;
  
  // Determines whether this instance of the field map is for a mandatory field
  var is_mandatory = true;
  
  if (is_mandatory) {
    $payload.close_notes = '' + $stage.close_notes;
  } else if ($stage.close_notes) {
    $payload.close_notes = '' + $stage.close_notes;
  }

});

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

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