UpdateIncident Fields
We will utilise the Field & Field Map records to configure the Message Scripts for the UpdateIncident Message.
Last updated
We will utilise the Field & Field Map records to configure the Message Scripts for the UpdateIncident Message.
Last updated
The 'message_header' (Integration level) Field record should already be in place (i.e. with Active set to false). We will now create its Message level counterpart.
From the UpdateIncident Message, navigate to Message > Fields.
Your UpdateIncident Fields page should look like this:
1) Find the message.message_header (Integration level) Field & set Active to true.
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.
As before, 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.
Next, repeat the process for the incident.short_description Field.
The 'incident.short_desccription' (Integration level) Field record should already be in place (i.e. with Active set to false). We will now create its Message level counterpart.
Your UpdateIncident Fields page should look like this:
2) 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).
We will now configure Field records for two other Incident record field elements.
As with the CreateIncident Message and depending on your requirements, you will need to create Field records for each of the relevant Incident record field elements (see the table in Fields & Field Maps on the 'CreateIncident Fields' page for an example). For the sake of brevity, this Guide will focus on two of those. If you wish, however, you are free to configure other Field records as required.
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 |
comments | Journal field |
work_notes | Journal field |
If you haven't already, you will need to copy the relevant additional Field Maps for the UpdateIncident Field records as follows:
Journal field
See Copy Field Maps (on the 'CreateIncidentReceipt Fields' page) for details.
From the UpdateIncident Message, navigaate to Message > Fields & click New.
The fields to be configured for our incident.comments New Field modal are as follows:
# | Field | Description | Value |
* | Message | The Message this Field record is linked with. | 'UpdateIncident' |
3 | Description | Describe what this field is for and any specific details that might help you in future. | 'The incident's comments' |
* | Active | Set to true to use this Field record for processing. | <true> |
4 | Field map | The Field Map this Field record is linked with. | 'IG - Journal field'** |
* | 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] |
5 | Element | The field on the source/target table this Field record is mapped to. | 'Additional comments' |
6 | 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.comments' New Field modal should look like this:
7) Submit the record.
You will be redirected back to the Fields page of the UpdateIncident Message.
Because the incident.work_notes Field record is the same 'type' (IG Journal field) & the majority of the settings are the same as the previously configured Field, it will be quicker to copy the incident.comments Field & make a few minor changes.
8) Click the ellipsis next to the incident.comments Field record & click Copy.
The fields to edit for the Copy Field modal are as follows:
# | Field | Description | Value |
9 | Element | The field on the source/target table this Field record is mapped to. | 'Work notes' |
* | Property | The property in the payload the data will be written to. | Automatically populated |
10 | Description | Describe what this field is for and any specific details that might help you in future. | 'The incident's work notes' |
*This field is automatically populated.
Your Copy Field modal should look like this:
11) Click Copy.
You will be redirected to the Details page of the newly created incident.work_notes Field record.
Now that we’ve configured the Field records for the UpdateIncident message, we are ready to build our message scripts.
To quickly navigate to the UpdateIncident Message from the Details page of the newly created incident.work_notes Field record…
...click the 'Preview' icon to the left of the Message field.
From the UpdateIncident message, navigate to Message > Fields.
The following Field records should now be in place for your UpdateIncident messsage:
12) Click on Build Message.
You will see the 'Message build successful' Info Message.
13) Navigate to Advanced > Script Editor to view the auto-generated code.
Your Script Editor fields should look like this:
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).
We are now ready to Test our UpdateIncident Message.
