# CreateIncidentReceipt Fields

## Copy Field Maps

{% hint style="info" %}
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.
{% endhint %}

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

![](https://2404534899-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MQBk35gIi557UHt7QlJ%2F-MdXV7-qGxYWCBobD_Co%2F-MdaPODp9ZT5XeOsS7c1%2FBAIG%20-%20CreateIncidentReceipt%20Fields%201.png?alt=media\&token=b8ab8833-85d5-4034-8df2-13efcdeb386e)

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

{% hint style="success" %}
*\*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).*
{% endhint %}

*Your Copy Field Map modal should look like this:*

![](https://2404534899-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MQBk35gIi557UHt7QlJ%2F-MdXV7-qGxYWCBobD_Co%2F-MdaQSHiYQSzeRdLM-Pq%2FBAIG%20-%20CreateIncidentReceipt%20Fields%202.png?alt=media\&token=c2e2e653-b1d5-46e8-80d4-1b9c17c97ebb)

3\) Click **Copy**.

You will be redirected to the Details page of the newly created Field Map.

{% hint style="success" %}
**Repeat** the process for the **Receipt Status** Field Map.
{% endhint %}

## Field: message.message\_header

From the **CreateIncidentReceipt** Message, navigate to **Message > Fields**. Click **New**.

![](https://2404534899-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MQBk35gIi557UHt7QlJ%2F-MdXV7-qGxYWCBobD_Co%2F-MdaMoHYYY8iGTlXxd5X%2FBAIG%20-%20CreateIncidentReceipt%20Fields%203.png?alt=media\&token=b0ced66a-3afa-4793-a0ca-67f4d9b4120c)

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

![](https://2404534899-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MQBk35gIi557UHt7QlJ%2F-MdXV7-qGxYWCBobD_Co%2F-MdaSJT8cadFfJ7N3m4S%2FBAIG%20-%20CreateIncidentReceipt%20Fields%204.png?alt=media\&token=5170a30d-7cb4-4d4f-a11c-e594a09a10b4)

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

![](https://2404534899-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MQBk35gIi557UHt7QlJ%2F-MdXV7-qGxYWCBobD_Co%2F-MdaVRK8zeVTXn2GAvQX%2FBAIG%20-%20CreateIncidentReceipt%20Fields%205.png?alt=media\&token=2ca190e0-eba1-46f2-a400-5d9cbb3882c6)

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

![](https://2404534899-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MQBk35gIi557UHt7QlJ%2F-MdXV7-qGxYWCBobD_Co%2F-MdaY8oNLefcK3VRJlFs%2FBAIG%20-%20CreateIncidentReceipt%20Fields%206.png?alt=media\&token=0d1778c2-42e1-4b36-bd64-bb951ebab62c)

{% hint style="success" %}
**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](https://docs.sharelogic.com/unifi/3.0/integration-guides/bidirectional-asynchronous-incident-guide/build-integration-level) page.
{% endhint %}

16\) Navigate to **Advanced > Script Editor**.

*When you first open the Script Editor, you will see the following:*

![](https://2404534899-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MQBk35gIi557UHt7QlJ%2F-MdXV7-qGxYWCBobD_Co%2F-MdaYrDYreUO9oBKjH9s%2FBAIG%20-%20CreateIncidentReceipt%20Fields%207.png?alt=media\&token=0f7cffc1-5d86-4a14-81d9-580fbd26f86f)

{% hint style="success" %}
Having visibility of your message scripts in the one pane makes scripting so much more efficient.
{% endhint %}

17\) Click on **Build Message**.

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

![](https://2404534899-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MQBk35gIi557UHt7QlJ%2F-MQxfgO8mw1gUB1Ab5bb%2F-MR-q0v-I-k77qv4tvEf%2FV2%20-%20Fields%20CreateIncidentReceipt%205.png?alt=media\&token=73d8dfdd-ce82-40ae-984f-dc1f0b616820)

*Your Script Editor fields should now look like this:*

![](https://2404534899-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MQBk35gIi557UHt7QlJ%2F-MdXV7-qGxYWCBobD_Co%2F-MdacNrDd94BWaUJ_S_7%2FBAIG%20-%20CreateIncidentReceipt%20Fields%208.png?alt=media\&token=ac8e6251-1c88-4968-8872-fa61f0726c18)

You can click **View** to adjust the layout and change the view to show various combinations of, or individual script fields.

![](https://2404534899-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MQBk35gIi557UHt7QlJ%2F-MdXV7-qGxYWCBobD_Co%2F-MdadYBZNaRYdP7Sl7H4%2FBAIG%20-%20CreateIncidentReceipt%20Fields%209.png?alt=media\&token=0dc068ac-1a73-43c4-a3f8-ec3f6fc5dc81)

## Message Scripts

{% hint style="info" %}
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).
{% endhint %}

```javascript
//===== [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)
```

&#x20;Once you have finished examining the code, click **'Close'** to navigate back to the Fields page of the CreateIncidentReceipt Message.

![](https://2404534899-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MQBk35gIi557UHt7QlJ%2F-MdXV7-qGxYWCBobD_Co%2F-Mdalki7UfUsb0_i53Si%2FBAIG%20-%20CreateIncidentReceipt%20Fields%2010.png?alt=media\&token=bfe480a5-c328-4fd1-b791-cbcbaa9df027)

We are now ready to configure our **CreateIncident** Message.
