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
  • Create an Incident
  • View the Bond
  • View the Transaction
  • View the Stage
  • View the HTTP Request
  • Compare with the External System's Incident

Was this helpful?

Export as PDF
  1. Integration Guides
  2. Outbound Incident Guide
  3. Create Scenario

Test CreateIncident

We will test our CreateIncident Message.

PreviousTriggerNextUpdate Scenario

Last updated 3 years ago

Was this helpful?

Create an Incident

Navigate to Incident > Create New.

The Incident fields to configure are as follows:

#

Field

Description

Value

1*

Caller

Person who reported or is affected by this incident.

<Your Caller>

*

State

The Incident lifecycle state.

'New' - Default (Automatically populated)

2*

Short description

A brief description of the incident.

<Your Short description>

*Note: We have chosen these fields as these were the ones we mapped when creating our Field records for the CreateIncident Message. Your choices may differ depending on which Field records you created.

Your Incident form should look like this:

3) Right-click & Save.

Note the values entered (including State & Priority), so that you can check them against the mapped fields on the corresponding record in the instance being integrated to.

You should see an Info Message, confirming the CreateIncident Message is being sent to your Integration:

You should also see a note in the Activities stream:

When you scroll down to the 'Unifi Integrations' related list (you may have to configure the related lists to add it to your Incident form), notice:

4) A Bond has been created. The State remains 'Pending' until the list is refreshed.

5) Refresh the list by clicking Bonds.

You should see the External reference populated & the State changed to 'Open':

We are using a sys_id for the External reference in our example because we are integrating with the table API. If possible, it is better to use something more meaningful, like the Number of the ticket integrated with, as this aids in debugging.

6) Click the Bond Number link to open the Bond record.

View the Bond

Your Bond record should look like this:

7) Bond details:

  • Integration: < Your Integration >

  • Connection: < Your Connection >

  • Table: 'Incident [incident]'

  • Document: < Your Incident >

  • State: 'Open' (Message exchange is available)

  • Status: 'OK' (All transactions have completed)

  • Internal reference: < ServiceNow ticket reference > (Same as 'Document')

  • External reference: < External system's ticket reference >

8) Transaction:

  • Message: 'Createincident'

  • Direction: 'Outbound'

  • Transaction state: 'Complete' (The data has been successfully transported)

  • Process state: 'Accepted' (The transaction was accepted as within the scope of the business logic that's in place)

You are able to view the logs in the 'Unifi Activity Logs' related list.

9) Transaction process next queued: Logs from checking whether there are any other transactions queued and processing those.

10) Transaction sending: Logs from taking the Stage data, building the Request record & sending the Request to the integrated system.

11) Business rule: < Your Trigger >: Logs from the Business Rule that triggers Unifi.

View the Transaction

Click through to the Transaction record from the related list on the Bond.

Your Transaction record should look like this:

12) Transaction details:

  • Table: 'Incident [incident]'

  • Document: < Your Incident >

  • Integration: < Your Integration >

  • Connection: < Your Connection >

  • Bond: < Your Bond >

  • Message: 'CreateIncident'

  • Direction: 'Outbound'

  • Transaction state: 'Complete' (The data has been successfully transported)

  • Process state: 'Accepted' (The transaction was accepted as within the scope of the business logic that's in place)

13) Errors:

  • Error: (If there was a transactional error the Transaction state would show as 'Error' and the details would be captured here).

  • Process error: (If there was a process error the Process state would show as 'Rejected' and the details would be captured here)

14) Stage:

  • Direction: 'Outbound'

  • Message: 'CreateIncident'

  • Internal reference: < ServiceNow ticket reference > (Same as 'Document')

  • External reference: < External system's ticket reference >

View the Stage

Click through to the Stage record from the related list on the Transaction.

Check the values in the fields match what you expect.

Your Stage record should look like this:

15) Stage details:

  • Direction: 'Outbound'

  • External reference: < External system's ticket reference >

  • Internal reference: < ServiceNow ticket reference >

  • Snapshot: < Snapshot record reference >

  • Message: 'CreateIncident'

  • Transaction: < Your Transaction >

  • Integration: < Your Integration >

16) Mapped Staged Data fields (yours may differ depending on which Field records you created):

  • Caller ID: < Your caller.id >

  • Short description: < Your Short description >

  • State: '1'

View the HTTP Request

Click through to the HTTP Request record from the related list on the Transaction.

This is where you will find details of the data that was transported between the systems being integrated. (These records are extremely useful for developing and debugging integrations because of the immediate availability and contextual relevance to the integration you are developing.)

Your HTTP Request record should look like this:

17) HTTP Request details:

  • Integration: < Your Integration >

  • Connection: < Your Connection >

  • Transaction: < Your Transaction >

  • Message: 'CreateIncident'

  • Direction: 'Outbound'

  • Request state: 'OK' (There are no errors with the HTTP Request.)

  • Attempt number: < Number of HTTP Request attempts > (Failed requests are retried up to the maximum attempts number as configured on the Integration.)

  • Endpoint URL: < The external system’s access URL >

  • Action Method: 'POST'

  • Request headers: < The header of the request being sent >

  • Request payload: < The payload of the request being sent >

18) Response details:

  • Status code: '200'

  • Response headers: < The header of the response being received >

  • Response payload: < The payload of the response being received >

Compare with the External System's Incident

Navigate to the corresponding Incident in the external system.

Check the values in the fields match those you noted when you saved the Incident in the internal system.

Your external system's Incident record should look like this (depending on the system you're integrating with, your record may look different; the important matter is that the values match):

19) Caller: < Your Caller >

20) State: < Your State >

21) Short description: < Your Short description >

22) Activities: < Note showing activity on the Incident > (Opened by < your.external.system.user > configured in the Connection)

We are now ready to move on to the Update Scenario.