LogoLogo
AboutSupport
3.0
3.0
  • Unifi Documentation
  • Release
    • Unifi 3.0 Release Notes
      • Unifi 2.2 Release Notes
      • Unifi 2.1 Release Notes
      • Unifi 2.0 Release Notes
    • Hotfixes
    • Setup
  • Overview
    • Quick Tour
    • Supported Features
    • Application Modules
    • Data Model
  • Integration Guides
    • Outbound Incident Guide
      • Getting Started
      • Process
      • Integration
      • Connection
      • Create Scenario
        • CreateIncidentResponse Message
        • CreateIncidentResponse Fields
        • CreateIncident Message
        • CreateIncident Fields
        • Trigger
        • Test CreateIncident
      • Update Scenario
        • Response Message
        • UpdateIncident Message
        • UpdateIncident Fields
        • Test UpdateIncident
      • Resolve Scenario
        • ResolveIncident Message
        • ResolveIncident Fields
        • Test ResolveIncident
      • Build - Integration Level
      • Conclusion
    • Bidirectional Asynchronous Incident Guide
      • Getting Started
      • Process
      • Web Service
      • Integration
      • Connection
      • Create Scenario
        • Response Message
        • CreateIncidentReceipt Message
        • CreateIncidentReceipt Fields
        • CreateIncident Message
        • CreateIncident Fields
        • Trigger
        • Test CreateIncident
      • Update Scenario
        • Receipt Message
        • UpdateIncident Message
        • UpdateIncident Fields
        • Test UpdateIncident
      • Resolve Scenario
        • ResolveIncident Message
        • ResolveIncident Fields
        • Test ResolveIncident
      • Build - Integration Level
      • Build the Other Half
        • Move the Integration
        • Reconfigure the Connections
      • Conclusion
    • Incident Update Poller Guide
      • Polling
        • Poll Processor
        • Poller
      • Inbound Message
        • UpdateIncidentInbound Message
        • UpdateIncidentInbound Fields
      • Message Identification
      • Bond Identification
        • Edit Incident Form
        • Edit CreateIncident Message
      • Test Update Poll
      • Conclusion
    • Incident Multiple Message Poller Guide
      • Polling
        • Poll Processor
        • Poller
      • Inbound Messages
        • ResolveIncidentInbound Message
        • ResolveIncidentInbound Fields
      • Testing
        • Test UpdateIncidentInbound
        • Test ResolveIncidentInbound
      • Conclusion
    • Incident Create Poller Guide
      • Polling
        • Connection Variables
        • Poll Processor
        • Poller
      • Messages
        • CreateIncidentInboundReceipt Message
        • CreateIncidentInboundReceipt Fields
        • CreateIncidentInbound Message
        • CreateIncidentInbound Fields
      • Build - Integration Level
      • Test Create Poll
      • Conclusion
    • Incident Parent and Child Poller Guide
      • Polling
        • Connection Variables
        • Child Poll Processor
        • Child Poller
        • Parent Poll Processor
        • Parent Poller
      • Inbound Messages
      • Testing
        • Test UpdateIncidentInbound
        • Test ResolveIncidentInbound
      • Conclusion
    • Incident Attachment Poller Guide
      • Polling
        • Connection Variables
        • Edit Endpoint URLs
        • Get Attachment Poll Processor
        • Get Attachment Poller
        • Select Attachments Poll Processor
        • Select Attachments Poller
        • Edit Child Poll Processor
        • Edit Child Update Poller
      • Messages
        • AddAttachmentInbound Message
      • Testing
        • Test Outbound Scenarios
        • Test CreateIncidentInbound
        • Test UpdateIncidentInbound
        • Test ResolveIncidentInbound
        • Test AddAttachmentInbound
      • Conclusion
  • Feature Guides
    • Packager Feature Guide
      • Instructions
    • Error Handling Tools Feature Guide
      • Retry
      • Replay
      • Ignore
      • Repair
      • Pause and Resume
    • Unifi Test Assistant Feature Guide
      • Generating Tests
      • Running Tests
      • Exploring Results
  • Bonding
    • Bonds
    • Bonded Attachments
  • Transport
    • Transport Data Flow
    • Snapshots
    • Transactions
    • Stages
    • HTTP Requests
  • Configuration
    • Processes
    • Integrations
    • Connections
    • Messages
    • Message Scripts
    • Fields
    • Field Maps
    • Response Actions
    • Event Actions
  • Polling
    • Pollers
    • Poll Processors
    • Poll Requests
    • Large Response Payloads
  • Testing
    • Integration Tests
    • Test Scenarios
    • Test Scenario Data
    • Test Results
    • Test Scenario Results
  • Administration
    • Activity Logs
    • Data Stores
    • Properties
    • Scheduled Scripts
    • System Logs
    • Self-test
  • Scripting
    • Variables
    • Snippets
  • Attachments
    • Attachment Handling
    • Multipart Form Data
Powered by GitBook
On this page
  • Field: message.message_header
  • Field: incident.short_description
  • Fields & Field Maps
  • Copy Field Maps
  • Field: incident.comments
  • Field: incident.work_notes
  • Build
  • Message Scripts

Was this helpful?

Export as PDF
  1. Integration Guides
  2. Bidirectional Asynchronous Incident Guide
  3. Update Scenario

UpdateIncident Fields

We will utilise the Field & Field Map records to configure the Message Scripts for the UpdateIncident Message.

PreviousUpdateIncident MessageNextTest UpdateIncident

Last updated 3 years ago

Was this helpful?

Field: message.message_header

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.

Field: incident.short_description

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.

Fields & Field Maps

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

Copy Field Maps

If you haven't already, you will need to copy the relevant additional Field Maps for the UpdateIncident Field records as follows:

  • Journal field

Field: incident.comments

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.

Field: incident.work_notes

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.

Build

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:

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

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

We are now ready to Test our UpdateIncident Message.

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

See (on the 'CreateIncidentReceipt Fields' page) for details.

Copy Field Maps
Fields & Field Maps