Search…
CreateIncidentReceipt Fields
We will utilise the Field & Field Map records to configure the Message Scripts for the CreateIncidentReceipt 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.
The Field Maps we shall use for our CreateIncidentReceipt Field records are:
    Message Header
    Receipt Status
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>
*
Integration
The integration this field map is associated with.
<Your Integration>
*This field is automatically populated.
*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.
Repeat the process for the Receipt Status Field Map.

Field: message.message_header

From the CreateIncidentReceipt 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.
'CreateIncidentReceipt'
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.
'IG - 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.
'message_header'
*
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 'message_header' New Field modal should look like this:
9) Submit the record.
You will be redirected back to the Fields page of the CreateIncidentReceipt Message.

Field: message.transaction_details

Click New.
The fields to be configured for our transaction_details New Field modal are as follows:
#
Field
Description
Value
*
Message
The Message this Field record is linked with.
(automatically populated)
10
Description
Describe what this field is for and any specific details that might help you in future.
'Used to send and receive transaction process errors'
*
Active
Set to true to use this Field record for processing.
<true>
11
Field map
The Field Map this Field record is linked with.
'IG - Receipt Status'**
12*
Map to field
Use this Field record to represent a field on a source/target table.
<false>
13
Path
Where in the payload the data will be placed.
'message'
14
Property
The property in the payload the data will be written to.
'transaction_details'
*
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 'transaction_details' New Field modal should look like this:
15) Submit the record.
You will be redirected back to the Fields page of the CreateIncidentReceipt Message.

Build

Now that we’ve configured the Field records for the CreateIncidentReceipt message, we are ready to build our message scripts.
The following Field records should now be in place for your CreateIncidentReceipt messsage:
Feature Alert: In the picture above you will notice that a 'Build Integration' button has appeared in the banner at the top of the page. Whenever a change is made to a Field record that is associated to a Message (whether that is being created, updated, or deleted) the button will be available and acts as a visual reminder that changes have been made and Message Script(s) need to be built. We will talk more about this feature in the Build Integration Level page.
16) Navigate to Advanced > Script Editor.
When you first open the Script Editor, you will see the following:
Having visibility of your message scripts in the one pane makes scripting so much more efficient.
17) Click on Build Message.
You will see the 'Message build successful' Info Message.
Your Script Editor fields should now look like this:
You can click View to adjust the layout and change the view to show various combinations of, or individual script fields.

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!
Once you have finished examining the code, click 'Close' to navigate back to the Fields page of the CreateIncidentReceipt Message.
We are now ready to configure our CreateIncident Message.
Last modified 3mo ago