UpdateIncidentInbound Message

We will configure an inbound update message to process the data returned from the poll and update our target record.

New Message Modal

Click the 'Messages' icon, then New.

The fields to be configured for the UpdateIncidentInbound New Message modal are as follows:

FieldDescriptionValue

Message name

The message name that is unique for this integration.

'UpdateIncidentInbound'

Type

The primary purpose of the message.

'Update'

Direction

The direction(s) this message is configured to support.

'Inbound'

Description

The description for this message and the requirement it is meeting.

<Your description>

Your UpdateIncidentInbound New Message modal should look like this:

Click Submit and view to further configure the Message.

Response Fields

Navigate to Message > Response.

The Response fields to be configured are as follows:

FieldDescriptionValue

Response

The immediate synchronous response to this message.

lookup: 'Response'

Async*

Turn this option on if you want inbound processing to occur asynchronously or this message is the first of an asynchronous message pair.

<false>

*This field is automatically defaulted to true.

The 'Response' Message was previously configured (in the Outbound Incident Guide) to apply in an 'Inbound' direction. Change it to 'Bidirectional'.

Your Response form should look like this:

Navigate to Message > Bond.

Bond Fields

The Bond fields to be configured are as follows:

FieldDescriptionValue

Bond ownership*

Determine if the sender should own the bond or not in order for this message to be processed? Use 'Ignore' to process regardless of the owner flag. (Choices: Ignore, Must own, Must not own.)

'Ignore'

Bond condition type*

The type of conditional check made on the bond. (None: no checks are made. State: checks against the state are made using the conditional checkboxes. Scripted: the 'Bond condition' script is used.)

'State'

Bond open

Process this message when the bond state is Open.

<true>

*These fields are automatically populated.

Your Bond form should look like this:

Navigate to Inbound > Settings.

Inbound Settings Fields

The Inbound Settings fields to be configured are as follows:

FieldDescriptionValue

Bond reference method*

Method of searching for and validating an existing bond for incoming messages.

'External'

*Bond reference method:

Internal - lookup using the internal reference only.

External - lookup using the external reference only.

Both - lookup using both the internal and external references.

We have chosen the 'External' method because, in the payload we built, we only supplied the source_reference. If we had also supplied the correlation_id as the target_reference, then we would have chosen 'Both' (which would have offered an extra level of validation to the checking).

Your Inbound Settings form should look like this:

Click Save.

We are now ready to configure the Fields for our UpdateIncidentInbound Message.