ArcGIS IPS Information Model

Available for an ArcGIS organization licensed with the IPS extension.

The ArcGIS IPS Information Model supports the management of indoor positioning information necessary to share properly configured web maps and mobile map packages for use with the ArcGIS IPS Setup app and other indoor positioning-enabled apps. Additionally, it contains necessary data structures to assess the indoor positioning performance.

The information model consists of two parts:

  • The IPS Core Model includes tables and feature classes necessary to enable indoor positioning and maintain up-to-date information about the beacon infrastructure.
  • The IPS Quality Dataset contains two point feature classes that are used to get an insight about the performance of an installation.

It also leverages additional data that comes from the ArcGIS Indoors Information Model, including the following:

  • Floor plan data—Includes the Sites, Facilities, Levels, Units, and Details feature classes, which contain data that describes floor plans and indoor spaces.
  • Transitions—In the Indoors model, the Transitions feature class contains features representing transitions between floors, such as stairs and elevators. The model extends this feature class by using a domain to include transitions between indoor and outdoor spaces.
  • Pathways—Linear features that represent traversable space. When marked for use with the IPS, path snapping is enabled to enhance the blue dot experience.

IPS Core Model

You can use the Enable Indoor Positioning tool to create the IPS Core Model in an existing workspace. The model includes the positioning table and the recordings feature class, which are necessary for the setup and the enablement of the IPS. The recordings feature class can be used to plan and store surveys of the environment. The Generate Indoor Positioning File tool is used to compile recordings into so-called positioning files, which contain all necessary information to enable the IPS and are consumed to obtain a position indoor. They are stored as attachments to the positioning table.

The core model also includes a Beacons feature class that can be used to maintain information about the configuration of a Bluetooth beacon infrastructure, in case of a Bluetooth-based installation.

IPS Quality Dataset

You can use the tools contained in the Quality Assessment toolset to create and populate this dataset. The Create IPS Quality Dataset tool creates the dataset in an existing workspace. This dataset consists of the following:

  • Reference Positions feature class
  • Computed Positions feature class

The Compute Positioning Quality tool transforms quality recordings into reference positions and computed positions features, which encode information about the performance of an installation. Reference positions denote points for which a quality assessment is available, while computed positions represent the indoor positions generated by the IPS Engine for each of these references.

IPS Core Model feature classes

NameDescription

IPS Recordings

A linear feature class used by the ArcGIS IPS Setup app to store indoor positioning survey recordings. This feature class is also the input for the Generate Indoor Positioning and Compute Positioning Quality tools.

Beacons

A point feature class that describes the geographic location and attributes of beacons located in a facility.

IPS Core Model tables

NameDescription

IPS Positioning

The output table that is populated by the Generate Indoor Positioning File tool and contains file attachments to enable indoor positioning within IPS Setup and custom IPS apps via the IPS Engine.

IPS Quality dataset feature classes

NameDescription

Reference Positions

A point feature class that represents the actual positions of the surveyor along a quality recording at a specific time.

Computed Positions

A point feature class that represents the positions of the surveyor calculated by the IPS Engine along a quality recording at a specific time and a specific positioning file. Computed positions can be matched with the corresponding reference positions by recording GUID and IPS Time attributes.

IPS Core Model feature classes

The following feature classes are included in the IPS Core Model:

IPS Recordings

Field nameTypeIs nullableDescription

SITE_ID

Text

True

Records the unique ID of the feature’s associated site and can be used to identify the feature’s associated site feature in floor-aware maps. A feature can only be related to a single site using the Site ID field.

FACILITY_ID

Text

True

Records the unique ID of the feature’s associated facility and is used to identify the feature’s associated facility feature in floor-aware maps. A feature can only be related to a single facility using the Facility ID field.

LEVEL_ID

Text

True

Records the unique ID of the feature’s associated level and is used to identify the feature’s associated level feature in floor-aware maps. A feature can only be related to a single level using the Level ID field.

SURVEY_DATE

Date

False

Records the date on which the survey path was recorded in the setup app.

COMMENT

Text

True

Records the user’s comment about the recording when it was created using the setup app.

SURVEYOR

Text

True

Records the username of the user logged in to the setup app.

DEVICE

Text

True

Records the device name and model with which the recording was created.

APP_VERSION

Text

False

Records the version of the setup app used to create the recording.

RECORDING_TYPE

Text

True

Specifies the type of the recording.

The DOM_IPS_RECORDING_TYPE domain defines the following allowed field values:

  • Survey
  • Quality

BLUETOOTH

Long

True

Records if the recording contains Bluetooth data.

The DOM_BOOLEAN domain defines the following allowed field values:

  • 0—False
  • 1—True

WIFI

Long

True

Records if the recording contains Wi-Fi data.

The DOM_BOOLEAN domain defines the following allowed field values:

  • 0—False
  • 1—True

GLOBALID

Global ID

False

Uniquely identifies a feature or table row in a geodatabase and across geodatabases.

It’s a store registry-style string consisting of 36 characters enclosed in curly brackets in a geodatabase.

PLANNING_DATE

Date

False

Records the date the recording path was created. This field is automatically populated by a calculation attribute rule with the current date when a new feature is created in the feature class.

Beacons

Field nameTypeIs nullableDescription

VENDOR

Text

True

The name of the beacon vendor.

BEACON_ID

Text

True

A short string that uniquely identifies a Bluetooth beacon. Its format changes based on the beacon vendor.

UUID

Text

True

A Universal Unique Identifier consists of 32 hexadecimal characters split into five groups separated by hyphens. The length of each group is 8-4-4-4-12, for example: aa72426e-955d-41fb-9aaa-d67c749198a6

UUIDs can be generated locally (there is no central authority for coordination or registration) and are configurable for Bluetooth beacons.

As per the iBeacon protocol, the same UUID is associated to a subset of a beacon network and is part of their advertised message.

The triplet (UUID, MAJOR, MINOR) identifies a specific beacon in a network.

MAJOR

Long

True

A 2-byte unsigned integer that is associated to a Bluetooth beacon.

As per the iBeacon protocol, this can be used to further distinguish a group of beacons in a network and is part of the advertised message.

The triplet (UUID, MAJOR, MINOR) identifies a specific beacon in a network.

MINOR

Long

True

A 2-byte unsigned integer that is associated to a Bluetooth beacon.

As per the iBeacon protocol, this can be used to further distinguish a group of beacons in a network and is part of the advertised message.

The triplet (UUID, MAJOR, MINOR) identifies a specific beacon in a network.

PROTOCOL

Text

True

The Bluetooth protocol used by the beacons. Only iBeacon is supported at the current release.

RSSI_1M

Float

True

The Received Signal Strength Indicator at 1 meter distance. Typically, this is configurable for each beacon. The possible values are specified by the beacon vendor.

ADVERTISING_INTERVAL_MS

Float

True

The interval in milliseconds at which the beacon broadcasts its messages.

LEVEL_ID

Text

True

The Level ID of the level feature on which the beacon is located.

BATTERY_LEVEL

Float

True

The residual battery level of the beacon as a percentage of total battery.

LAST_SEEN

Date

True

The date and time at which a beacon's signal was last observed.

PLACEMENT_DATE

Date

True

The date and time at which a beacon was deployed.

GLOBALID

Global ID

False

Uniquely identifies a feature or table row in a geodatabase and across geodatabases.

It’s a store registry-style string consisting of 36 characters enclosed in curly brackets in a geodatabase.

IPS Core Model tables

The following tables are included in the IPS Core Model:

IPS Positioning

Field nameTypeIs nullableDescription

SITE_ID

Text

True

Records the unique ID of the feature’s associated site and can be used to identify the feature’s associated site feature in floor-aware maps. A feature can only be related to a single site using the Site ID field.

DATE_CREATED

Date

False

Records the date the Generate Indoor Positioning File tool was run, and the indoor positioning file was created.

COMMENT

Text

True

Records comments specified in the Generate Indoor Positioning File tool.

BLUETOOTH

Long

True

Records if the positioning file supports Bluetooth positioning.

The DOM_BOOLEAN domain defines the following allowed field values:

  • 0—False
  • 1—True

WIFI

Long

True

Records if the positioning file supports Wi-Fi positioning.

The DOM_BOOLEAN domain defines the following allowed field values:

  • 0—False
  • 1—True

GLOBALID

Global ID

False

Uniquely identifies a feature or table row in a geodatabase and across geodatabases.

It’s a store registry-style string consisting of 36 characters enclosed in curly brackets in a geodatabase.

IPS Quality Dataset feature classes

The following feature classes are included in the IPS Quality Dataset:

Reference Positions

Field nameTypeIs nullableDescription

LEVEL_ID

TEXT

True

Records the unique ID of the feature’s associated level and is used to identify the feature’s associated level feature in floor-aware maps. A feature can only be related to a single level using the Level ID field.

RECORDING_GUID

GUID

True

Records the Global ID of the quality recording from which the reference positions feature was generated.

IPS_TIME

DATE

True

Defines the date and time in coordinated universal time (UTC) of the reference positions feature.

POSITIONING_GUID

GUID

True

Records the Global ID of the indoor positioning file used while performing the quality recording from which the reference positions feature was generated.

BLUETOOTH_POSITIONING

LONG

True

Records if the positioning file used during quality recording supports Bluetooth positioning. The DOM_BOOLEAN domain describes the allowed values:

  • 0 = FALSE
  • 1 = TRUE

WIFI_POSITIONING

LONG

TRUE

Records if the positioning file used during quality recording supports Wi-Fi positioning. The DOM_BOOLEAN domain describes the allowed values:

  • 0 = FALSE
  • 1 = TRUE

DISTANCE_TO_COMPUTED

DOUBLE

True

Describes the distance between the reference position feature to the corresponding computed positions feature. In case of a level mismatch with corresponding computed positions, the feature is set to NULL.

ACCURACY_LEVEL

SHORT

True

Records the calculated accuracy level, based on the DISTANCE_TO_COMPUTED. The DOM_IPS_QA_ACCURACY_LEVEL domain describes the allowed values:

  • 0 = Invalid
  • 1 = Low
  • 2 = Medium
  • 3 = High

Accuracy level is calculated as follows:

  • Invalid = LEVEL_MATCH is FALSE
  • Low = LEVEL_MATCH is TRUE and DISTANCE_TO_COMPUTED is greater than 10 m.
  • Medium = LEVEL_MATCH is TRUE and DISTANCE_TO_COMPUTED is between 5 m and 10 m.
  • High = LEVEL_MATCH is TRUE and DISTANCE_TO_COMPUTED is lower than 5 m.

LOS_TO_COMPUTED

LONG

True

Describes whether the reference positions feature is visible from the matching computed positions feature. True if the reference positions feature is on the same floor as the matching computed positions feature and there is no obstacle in between. Set to NULL if not computed.

The DOM_BOOLEAN domain describes the allowed values:

  • 0 = FALSE
  • 1 = TRUE

LEVEL_MATCH

LONG

True

Describes whether the reference positions feature, and the corresponding computed positions feature are at the same Level. The DOM_BOOLEAN domain describes the allowed values:

  • 0 = FALSE
  • 1 = TRUE

LOCATION_SOURCE

SHORT

True

Records the type of the positioning source used by the IPS Engine to compute the feature during the quality recording. The DOM_IPS_LOCATION_SOURCE domain describes the allowed values:

  • 0 = Unknown
  • 1 = Bluetooth
  • 2 = Wi-Fi
  • 3 = GNSS
  • 4 = Apple IPS

Computed Positions

Field nameTypeIs nullableDescription

LEVEL_ID

TEXT

True

Records the unique ID of the feature’s associated level and is used to identify the feature’s associated level feature in floor-aware maps. A feature can only be related to a single level using the Level ID field.

RECORDING_GUID

GUID

True

Records the Global ID of the quality recording from which the reference positions feature was generated.

IPS_TIME

DATE

True

Defines the date and time in coordinated universal time (UTC) when the reference positions feature was computed by the IPS Engine.

Related topics