We will need to configure a new inbound Message to process the attachments returned from the poll. We may also utilise all the previously configured Messages in testing our Integration.
In order to process the attachments returned from the remote system we will configure a new inbound Message.
AddAttachmentInbound
If you have edited the Endpoint URLs in the Connection, the Create Poll Processor and the Parent & Child Poll Processors, it will be necessary to utilise the Messages we created in the earlier Guides in order to test the Integration and process the data that is returned from the remote system. The following Messages will be used:
CreateIncidentInbound
UpdateIncidentInbound
ResolveIncidentInbound
CreateIncidentResponse
For the same reason as above and if you have edited the outbound Message Path for the previously configured Messages, it will be necessary to test those also. The following Messages will be used:
CreateIncident
UpdateIncident
ResolveIncident
CreateIncidentInboundReceipt
Let's now configure the AddAttachmentInbound Message.
We will configure another inbound update type Message to process the attachment data returned from the poll and update our target record.
Click on the 'Messages' icon to open the Messages page. Click New.
The fields to be configured for the AddAttachmentInbound New Message modal are as follows:
Your AddAttachmentInbound New Message modal should look like this:
Click Submit and view to further configure the Message.
Navigate to Message > Response.
The Response fields to be configured are as follows:
*This field is automatically defaulted to true.
Your Response form should look like this:
Navigate to Message > Bond.
The Bond fields to be configured are as follows:
*These fields are automatically populated.
Your Bond form should look like this:
Navigate to Inbound > Settings.
The Inbound Settings fields to be configured are as follows:
*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 'Internal' method because, in the payload we built, we supplied the correlation_id
.
Your Inbound Settings form should look like this:
Navigate to Advanced > Script Editor.
Click on View > Inbound.
The Script Editor fields to be configured are as follows:
The code in the 'Payload to Stage' script field should look like this:
Your Script Editor fields should look like this:
Click Save.
We can now move on to Testing.
Field | Description | Value |
---|---|---|
Field | Description | Value |
---|---|---|
Field | Description | Value |
---|---|---|
Field | Description | Value |
---|---|---|
Field | Description | Value |
---|---|---|
Message name
The message name that is unique for this integration.
'AddAttachmentInbound'
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>
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>
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 pending
Process this message when the bond state is Pending.
<true>
Bond open
Process this message when the bond state is Open.
<true>
Bond reference method*
Method of searching for and validating an existing bond for incoming messages.
'Internal'
Payload to Stage (Inbound)
The script to run.
Replace the commented out instructions with the code below.