Configure Indoor Positioning (Indoors)

Available for an ArcGIS organization licensed with the Indoors extension.

Summary

Writes indoor positioning system configuration information to an ArcGIS Indoors geodatabase. The values are used by ArcGIS Indoors for iOS and ArcGIS Indoors for Android.

The tool is only necessary if your organization is using the Indoo.rs positioning system.

Usage

  • The Input Geodatabase parameter value can be a geodatabase that contains an indoor dataset, created using the Create Indoor Dataset tool, or an Indoors geodatabase, created using the Create Indoors Database tool.

  • This tool creates the IndoorsConfig table in the input geodatabase if the geodatabase conforms to the Indoors model and the IndoorsConfig table does not exist.

  • In the IndoorsConfig table, the tool populates the Config Value column with values for the following Config Keys:

    • ELSS_API_KEY
    • ELSS_ENCRYPTION_KEY
    • ELSS_BUILDING_ID
    Note:

    If these Config Keys do not exist in the table, the tool will add them as new rows.

  • The ELSS_API_KEY and ELSS_ENCRYPTION_KEY values are encrypted.

  • The ELSS_ENCRYPTION_KEY can be a string value.

Parameters

LabelExplanationData Type
Input Geodatabase

The Indoors file or enterprise geodatabase for which IPS configuration information will be generated.

Workspace
Encryption Key

The key used by the tool and Indoors mobile apps to encrypt or unencrypt the API Key parameter (api_key in Python) value.

String
API Key

A unique value in the form of a GUID used by Indoors mobile apps to enable Indoo.rs indoor positioning. The API key is provided by Indoo.rs.

String
Building ID

A unique alphanumerical value used by Indoors mobile apps to link the site in the mobile map package to the Indoo.rs indoor positioning survey. The building ID is provided by Indoo.rs.

String

Derived Output

LabelExplanationData Type
Updated Geodatabase

The updated input geodatabase.

Workspace

arcpy.indoors.ConfigureIndoorPositioning(in_geodatabase, encryption_key, api_key, building_id)
NameExplanationData Type
in_geodatabase

The Indoors file or enterprise geodatabase for which IPS configuration information will be generated.

Workspace
encryption_key

The key used by the tool and Indoors mobile apps to encrypt or unencrypt the API Key parameter (api_key in Python) value.

String
api_key

A unique value in the form of a GUID used by Indoors mobile apps to enable Indoo.rs indoor positioning. The API key is provided by Indoo.rs.

String
building_id

A unique alphanumerical value used by Indoors mobile apps to link the site in the mobile map package to the Indoo.rs indoor positioning survey. The building ID is provided by Indoo.rs.

String

Derived Output

NameExplanationData Type
updated_gdb

The updated input geodatabase.

Workspace

Code sample

ConfigureIndoorPositioning example 1 (Python window)

The following Python window script demonstrates how to use the ConfigureIndoorPositioning function in immediate mode.

import arcpy

arcpy.indoors.ConfigureIndoorPositioning("C:/Indoors/ExampleCampus.gdb", "testEncrypt", "111-aaa-2222-bbbbb-3333444", "123456789")
ConfigureIndoorPositioning example 2 (stand-alone script)

The following stand-alone script demonstrates how to use the ConfigureIndoorPositioning function.

# Name: Indoors_ConfigureIPS_example2.py
# Description: Configures workspace with indoor positioning system information.

# Import system modules
import arcpy

# set geodatabase that is populated with Indoors model
in_geodatabase = 'C:/Indoors/ExampleCampus.gdb'

encrypt_key = 'testEncrypt'
api_key = '111-aaa-2222-bbbbb-3333444'
building_id = '123456789'

# run the tool
arcpy.indoors.ConfigureIndoorPositioning(in_geodatabase, encrypt_key, api_key, building_id)

Environments

Licensing information

  • Basic: Requires Indoors
  • Standard: Requires Indoors
  • Advanced: Requires Indoors

Related topics