Welcome

We are really excited about the many new features introduced in Unifi 2.0. In this Guide, we will look at two new configuration records - namely, Fields and Field Maps. We will look at what they are, why they were introduced (the benefits they bring) and guide you through the process of configuring and using them when building your integration.

Definitions

Both Fields and Field Maps allow the action of a Message and its Message Scripts to be broken down into smaller, reusable components. They both define discrete items of processing.

Fields

A Field record defines how an individual record field is handled. It often also defines objects that will carry other Transaction specific data (e.g. Name, Time stamp, Source reference, Target reference).

Field Maps

The Field Map defines the behaviour, or ‘type’ of a Field, and how it will be processed. It specifies the template code to be used by a Field and has a template script field for each of the Message Script types (Source to Stage, Stage to Request, Payload to Stage, Stage to Target).

We will predominantly be using String & Choice types (Field Maps) because that is all the table API supports. In other integrations you can specify other types.

For a fuller definition of Fields & Field Maps, please see their relevant pages in our Technical Documentation.

Benefits

Using Fields and Field Maps offers the ability to rapidly create integrations through simple configuration with no scripting involved. Unifi comes with a number of predefined Field Maps which you can use immediately in your integrations. For more complex mapping scenarios, a custom Field Map can be created so you can do whatever needs to be done with a Field of that type.

Having these configuration records means we can report on the use of fields by Messages and show whether a field is affected by an Integration. It is also what makes viewing what fields are in a Message very clear, and the added benefit of auto-generation of documentation is possible.

Scope

This Outbound Incident Fields Supplement is supplementary to the ‘Outbound Incident Guide’. It assumes that you have already configured your Process, Integration & Messages.

In the ‘Outbound Incident Guide’, you were previously shown how to configure each of the Message Scripts individually - manually entering the code for the CreateIncidentResponse, CreateIncident & UpdateIncident Messages. This Guide will show you how to configure those same Message Scripts by using the new, Field & Field Map records instead. As such, this Guide fits precisely at the points (in each of those Messages) where scripting was required and where appropriate, replaces those scripting elements.

As with the ‘Outbound Incident Guide’, this is intended to be a simple demonstration of an integration to a table API as an example to aid in getting started using Unifi.