Search…
CreateIncident Fields
We will utilise the Field & Field Map records to configure the Message Scripts for the CreateIncident Message.

Field: message.message_header

The ‘message.message_header’ Field record is visible and inactive. It is an Integration level Field which was automatically created by Unifi at the time we created the Message level record (as per the 'CreateIncidentReceipt Fields' page). We’ll talk more about Integration level & Message level Fields in the 'Field: incident.state' section.
It is now easier than ever to create a Message level Field record for its Integration level counterpart.
From the CreateIncident Message, navigate to Message > Fields.
1) Find the message.message_header (Integration level) Field & set Active to true.
Feature Alert: The ‘Build Integration’ button becomes visible in the banner and 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). Note: the empty 'circle icon' indicates that the Integration level Field is available to add to the Message.
By simply setting the Active flag to true on the Integration level Field record listed on the Message, Unifi has automatically created the Message level counterpart. The Integration level record still exists (and can be seen when you click on the ‘Fields’ icon to navigate to the Fields page), but is no longer visible in the list view on the Message because the Message level record has been created.)
Hints & Tips: Unifi automatically creates Integration level Fields when we first create the Message level equivalent records; those Integration level Fields are visible on the Fields list of the Messages we subsequently create. Therefore, if a Field is required for multiple Messages, create it once for the first Message and then simply set active to true for its Integration level counterpart from the Fields list of each of the relevant Messages that Field is required on.
We will now configure Field records for a select few Incident record field elements.

Fields & Field Maps

Depending on your requirements, you will need to create Field records for each of the relevant Incident record field elements (see the table below for an example). For the sake of brevity, this Guide will focus on a select few. If you wish, however, you are free to continue & configure the remaining Field records. The table below lists an example of the Incident record field elements you may wish to map and the relevant Field Maps required to configure each Field record. For a fuller definition of available Field Maps, please see the relevant page in our technical documentation.
Incident Field
Field Map
caller_id
Reference
short_description
String
description
String
category
Choice
impact
Choice
urgency
Choice
state
Choice
comments
Journal field
work_notes
Journal field
The Field records we will focus on will be for Caller (Reference), Short description (String) and State (Choice).

Copy Field Maps

If you haven't already, you will need to copy the relevant additional Field Maps for the CreateIncident Field records as follows:
    Reference
    String
    Choice
See Copy Field Maps (on the 'CreateIncidentReceipt Fields' page) for details.

Field: incident.caller_id

From the CreateIncident Message, navigate to Message > Fields. Click New.
The fields to be configured for the incident.caller_id New Field modal are as follows:
#
Field
Description
Value
*
Message
The Message this Field record is linked with.
'CreateIncident'
2
Description
Describe what this field is for and any specific details that might help you in future.
'The caller on this incident'
*
Active
Set to true to use this Field record for processing.
<true>
3
Field map
The Field Map this Field record is linked with.
'IG - Reference'**
*
Map to field
Use this Field record to represent a field on a source/target table.
<true>
*
Table
The primary source/target table that this Field record is mapped to.
'Incident' [incident]
4
Element
The field on the source/target table this Field record is mapped to.
'Caller'
5
Path
Where in the payload the data will be placed.
'detail'
*
Property
The property in the payload the data will be written to.
Automatically populated
*
Inbound
Set to true to use for inbound Messages.
<true>
*
Outbound
Set to true to use for outbound Messages.
<true>
*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.caller_id' New Field modal should look like this:
6) Submit the record.
You will be redirected back to the Fields page of the CreateIncident Message.

Field: incident.short_description

Click New.
The fields to be configured for the incident.short_description New Field modal are as follows:
#
Field
Description
Value
*
Message
The Message this Field record is linked with.
'CreateIncident'
7
Description
Describe what this field is for and any specific details that might help you in future.
'The short description of the incident'
*
Active
Set to true to use this Field record for processing.
<true>
8
Field map
The Field Map this Field record is linked with.
'IG - String'**
*
Map to field
Use this Field record to represent a field on a source/target table.
<true>
*
Table
The primary source/target table that this Field record is mapped to.
'Incident' [incident]
9
Element
The field on the source/target table this Field record is mapped to.
'Short description'
10
Path
Where in the payload the data will be placed.
'detail'
*
Property
The property in the payload the data will be written to.
Automatically populated
*
Inbound
Set to true to use for inbound Messages.
<true>
*
Outbound
Set to true to use for outbound Messages.
<true>
*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.short_description' New Field modal should look like this:
11) Submit the record.
You will be redirected back to the Fields page of the CreateIncident Message.

Field: incident.state

Field records can exist at both the Integration and the Message level (a Field record exists at the Integration level if it isn't linked to a Message i.e. the 'Message' field element is left blank). We noted previously that an Integration level Field record is automatically created when we first create one at the Message level. We will utilise and configure both when mapping 'incident.state'.
The 'incident.state' Field record is a Choice 'type' Field. These are used when you’re mapping choice field elements with static values that don't change per Message (e.g. State, Impact, Urgency) i.e. you're not going to have one set of choices/values for create and another for update.
Rather than configure choices for each Message, configure choices once at the Integration level. This means you only need define them once. The Field Map will take care of it and any 'incident.state' Field records that are set at the Message level (i.e. with a value in the 'Message' field) would use the choices configured 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.

Field: incident.state (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 CreatIncident Message, navigate to Message > Fields. Click New.
The fields to be configured for our incident.state (Message level) New Field modal are as follows:
#
Field
Description
Value
*
Message
The Message this Field record is linked with.
'CreateIncident'
12
Description
Describe what this field is for and any specific details that might help you in future.
'The incident lifecycle state'
*
Active
Set to true to use this Field record for processing.
<true>
13
Field map
The Field Map this Field record is linked with.
'IG - Choice'**
*
Map to field
Use this Field record to represent a field on a source/target table.
<true>
*
Table
The primary source/target table that this Field record is mapped to.
'Incident' [incident]
14
Element
The field on the source/target table this Field record is mapped to.
'State'
15
Path
Where in the payload the data will be placed.
'detail'
*
Property
The property in the payload the data will be written to.
Automatically populated
*
Inbound
Set to true to use for inbound Messages.
<true>
*
Outbound
Set to true to use for outbound Messages.
<true>
*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.state' (Message level) New Field modal should look like this:
16) Submit the record.
You will be redirected back to the Fields page of the CreateIncident Message.

Field: incident.state (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.
17) Click to open the incident.state (Integration level) Field record (the one where Message is empty).
The incident.state Field record opens to the Details page.
18) Navigate to Field > Field Choices.
19) Click Generate field choices.
20) Click Generate on the 'Generate field choices' modal which displays.
The Field Choices are generated & now visible in the list.
At this stage, you could carry on and configure any remaining Field records for the rest of the Incident record field elements (as per your requirements - see the Fields & Field Maps table at the top of this section). However, we will now run the Build process to auto-generate our Message Scripts.

Build

Now that we’ve configured the Field records for the CreateIncident message, we are ready to build our message scripts.
From the CreateIncident message, navigate to Message > Fields.
The following Field records should now be in place for your CreateIncident messsage:
21) Click on Build Message.
You will see the 'Message build successful' Info Message.
22) 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 may already be there (pre-existing code will be retained).
1
//===== [ws] Begin Unifi Auto Generated Code =====//
2
3
/*
4
* This code (between the Begin and End comments) is generated from the
5
* Field and Field mapping records which are configured as part of the integration.
6
*
7
* All code either above or below the comments will be automatically maintained
8
* through the build cycle.
9
*
10
* WARNING: Do not edit the Begin or End comments.
11
*/
12
13
(New auto-generated code will appear here)
14
15
//===== [ws] End Unifi Auto Generated Code =====//
16
17
(Old pre-existing code will appear here)
Copied!
We are now ready to Test our CreateIncident Message.
Before we do, let's view the Trigger which Unifi automatically created when we ran 'Build Message'.
Last modified 3mo ago