User Guide: Reveal Objects and Unique Identifiers

The purpose of this user guide is to enable Reveal integration developers with an understanding of how to create standard integration objects through the Reveal UI as well as how to update and modify unique identifiers that are critical to working with the Reveal APIs.

 

Terms

Reveal Objects

Any object that will be referenced via the API has a counterpart within the Reveal UI.Standard Reveal objects include:

        Vehicles Ė can only be modified via the UI and API, cannot be created

        Drivers

        Users

        Groups

        Geofences

Some Reveal objects can be referenced within the Reveal UI, but can only be created in Reveal via the API:

        Work Orders

        Work Order Statuses

        Work Order Types

 

Reveal Unique Identifiers

All objects within Reveal that are connected to the APIs will have a unique identifier that is managed by the Reveal account or user.The unique identifier is not a mandatory field within Reveal, but when populated is required to be unique.All APIs call the unique identifiers for objects, so having the Reveal account updated with this information is critical for integration success.

 

Reveal Object

Unique Identifier

Vehicle

Vehicle Number

Driver

Driver Number

User

Employee ID

Group

Group ID

Geofence

Place ID

Work Order

Work Order Number

Work Order Status

Work Order Status Code

Work Order Type

Work Order Type Code

 

 

Creating Reveal Objects & Unique Identifiers

In this section, when you are going through the steps to create a Reveal object, this also includes the instructions to update the objectís unique identifier.

 

Reveal Admin Objects

The following objects are created using the Admin section of Reveal:

        Drivers

        Users

        Groups

To create a driver or user visit the Reveal Admin section:

To create:

        Driver select CREATE A NEW DRIVER

        User select CREATE USER, when creating a new user within Reveal the First Name, Last Name, and Email address fields are mandatory.An email address can only exist 1 time within Reveal.

        Groups select GROUPS, highlight the group in the hierarchy where you want the group to be created underneath and select Add Group.You will then enter the New Groupís Name, Group ID, balloon type, and color.

Also, within the Admin section you can modify Vehicles as needed.

Creating Geofences

To create a new Geofence within Reveal, you will need to go to the Places tab to Create a New Place.

When creating a new Geofence in Reveal you will want to make sure you also supply the Place ID, a field within the Advanced Options.

 

Reviewing Reveal Objects

For Reveal objects that can only be created via the API, you can review the objectís details within the UI:

        Work Orders

        Work Order Statuses

        Work Order Types

Work Orders can be reviewed by searching on the Live Map by the Work Order Number:

 

Work Order Statuses and Types can both be reviewed within the Admin > Work Order Map Preferences section.