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 required 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 the data structures required to assess indoor positioning performance.

The information model consists of two parts:

  • ArcGIS IPS core model—Includes the tables and feature classes required to enable indoor positioning and maintain up-to-date information about the beacon infrastructure.
  • The ArcGIS IPS quality dataset—Contains point feature classes that are used to assess the performance of an ArcGIS IPS deployment.

The information model can also use the following data from the ArcGIS Indoors Information Model:

  • Floor plan data—Includes the Sites, Facilities, Levels, Units, and Details feature classes that contain floor plan and indoor spaces data.
  • Transitions—In the Indoors model, the Transitions feature class contains features that represent transitions between floors, such as stairs and elevators. The ArcGIS IPS 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 ArcGIS IPS app, path snapping is enabled to enhance positioning accuracy.

ArcGIS IPS core model

You can use the Enable Indoor Positioning tool to create the ArcGIS IPS core model in an existing workspace. The core model includes the positioning table and the IPS Recordings feature class, which are required to set up and enable the indoor positioning system. The IPS Recordings feature class is also used to plan and store surveys and quality recordings of the indoor environment. The Generate Indoor Positioning File tool is used to create positioning files from survey recordings, which contain all necessary information to enable indoor positioning. The positioning files are stored as attachments in the Positioning table. The model also includes the Beacons feature class that is used to plan and maintain the configuration details of Bluetooth beacon infrastructure for Bluetooth-based deployments. The Generate Indoor Positioning File Without Survey tool can also be used to create positioning files from beacon and floor plan data. The Beacons feature class is an input for this tool.

Feature classes

The following table lists the feature classes that are included in the core model:

Feature classDescription

IPS Recordings

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

Beacons

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

IPS Recordings

The following table lists the fields that are included in the IPS Recordings feature class:

Field nameTypeIs nullableDescription

SITE_ID

Text

True

Records the unique ID of the feature’s associated site and can be used to identify the 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 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 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 the survey path was recorded in the IPS Setup app.

COMMENT

Text

True

Records the user’s comments about the recording when it was created using the IPS Setup app.

SURVEYOR

Text

True

Records the username of the user who was signed in to the IPS Setup app when the survey was performed.

DEVICE

Text

True

Records the device name and model that was used to create the recording.

APP_VERSION

Text

False

Records the version of the IPS Setup app that was used to create the recording.

RECORDING_TYPE

Text

True

Specifies the type of recording.

The DOM_IPS_RECORDING_TYPE domain defines the following allowed field values:

  • Survey
  • Quality

BLUETOOTH

Long

True

Specifies whether the recording contains Bluetooth data.

The DOM_BOOLEAN domain defines the following allowed field values:

  • 0—False
  • 1—True

WIFI

Long

True

Specifies whether 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 feature is created in the feature class.

Beacons

The following table lists the fields that are included in the Beacons feature class:

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. The format may vary based on the beacon vendor.

UUID

Text

True

A proximity Universally Unique Identifier (UUID) 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.

Pursuant to the iBeacon protocol, the same UUID is associated with a subset of a beacon network and is part of the 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 with a Bluetooth beacon.

Pursuant to 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 field must be an integer value between 1 and 65535.

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

MINOR

Long

True

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

Pursuant to 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 field must be an integer value between 1 and 65535.

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

The field must be an integer value between -120 and 0.

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 a beacon's signal was last observed.

PLACEMENT_DATE

Date

True

The date and time 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.

Table

The following table's one item is the table that is included in the core model:

TableDescription

IPS Positioning

The output table that is populated by the Generate Indoor Positioning File or Generate Indoor Positioning File Without Survey tool and contains file attachments to enable indoor positioning in IPS Setup, Indoors, Field Maps, or any other custom mobile apps that use ArcGIS Maps SDKs for native apps.

IPS Positioning

The following table lists the fields that are included in the IPS Positioning table:

Field nameTypeIs nullableDescription

SITE_ID

Text

True

Records the unique ID of the feature’s associated site and can be used to identify the 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 that the indoor positioning file was created.

COMMENT

Text

True

Records comments specified in the Generate Indoor Positioning File tool.

BLUETOOTH

Long

True

Specifies whether the positioning file supports Bluetooth positioning.

The DOM_BOOLEAN domain defines the following allowed field values:

  • 0—False
  • 1—True

WIFI

Long

True

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

ArcGIS IPS quality dataset

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

  • Reference Positions
  • Computed Positions

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 ArcGIS IPS engine for each of these references.

Feature classes

The following table lists the feature classes that are included in the quality dataset:

Feature classDescription

Reference Positions

A point feature class that contains a surveyor's actual position at a specific time during a quality recording survey.

Computed Positions

A point feature class that contains a surveyor's computed position based on a specific positioning file at a specific time during a quality recording survey. The computed positions can be matched with their corresponding reference positions by the RECORDING_GUID and IPS_TIME attributes.

Reference Positions

The following table lists the fields that are included in the Reference Positions feature class:

Field nameTypeIs nullableDescription

LEVEL_ID

TEXT

True

Records the unique ID of the feature’s associated level and is used to identify the 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 that was used to perform the quality recording survey from which the reference positions feature was generated.

BLUETOOTH_POSITIONING

LONG

True

Specifies whether the positioning file used during the quality recording supports Bluetooth positioning.

The DOM_BOOLEAN domain describes the allowed values:

  • 0—FALSE
  • 1—TRUE

WIFI_POSITIONING

LONG

TRUE

Specifies whether 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 and the corresponding computed positions feature. When there is a level mismatch with corresponding computed positions, the value is set to NULL.

ACCURACY_LEVEL

SHORT

True

Specifies the calculated accuracy level based on the DISTANCE_TO_COMPUTED field.

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 meters.
  • Medium—LEVEL_MATCH is TRUE and DISTANCE_TO_COMPUTED is between 5 and 10 meters.
  • High—LEVEL_MATCH is TRUE and DISTANCE_TO_COMPUTED is less than 5 meters.

LOS_TO_COMPUTED

LONG

True

Specifies whether the reference positions feature is visible from the matching computed positions feature. The value is TRUE if the reference positions feature is on the same floor as the corresponding computed positions feature and there is no obstacle between them. The value is set to NULL if not computed.

The DOM_BOOLEAN domain describes the allowed values:

  • 0—FALSE
  • 1—TRUE

LEVEL_MATCH

LONG

True

Specifies whether the reference positions feature and the corresponding computed positions feature are on the same level.

The DOM_BOOLEAN domain describes the allowed values:

  • 0—FALSE
  • 1—TRUE

LOCATION_SOURCE

SHORT

True

Specifies the type of positioning source used by the ArcGIS 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 ArcGIS IPS

Computed Positions

The following table lists the fields that are included in the Computed Positions feature class:

Field nameTypeIs nullableDescription

LEVEL_ID

TEXT

True

Records the unique ID of the feature’s associated level and is used to identify the 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 ArcGIS IPS engine.

Related topics