Unique iPad ID

Supported in:

Kiosk Pro Basic, Plus and Enterprise

Set a unique identifier for a specific kiosk. The ability to identify a specific kiosk in the field helps inform you about your deployment.

Default Value: [empty]

We highly recommend setting a Unique iPad ID when you set up your kiosks, regardless of whether you see an immediate need for it. 

While you can generate a unique ID through a Remote Settings Control or Managed App Configuration update in our Plus and Enterprise versions, it is significantly easier to set the ID when the kiosk is first deployed.

In addition to being shown within the app's in-app settings menu, the Unique iPad ID can also be viewed as a read-only field in the iOS/iPadOS settings for the app. 

We recommend using an ID set in lowercase without spaces or special characters as these can trigger an error in certain use cases. As an example, correctly-formatted identifiers would include:

  • lobby
  • opera-house-houston
  • houston-4
  • 4

The Unique iPad ID can be used in the following ways:

To identify which device is sending an event notification

For instance, say you have an iPad with a Unique iPad ID of 'lobby' and another iPad labeled 'second-floor'; if power is lost to one iPad, the event notification sent out will contain the Unique iPad ID, indicating which iPad is in trouble.

As a variable in other app settings

In Plus and Enterprise, the Unique iPad ID can be used as a variable in the app's settings by inserting ‘$UniqueiPadID$’ (capitalized and spaced as shown, without the single quotes). This can be used to customize a URL for Remote Settings Control or to mirror the Unique iPad ID as the Kiosk ID when using the remote management server. More information is available here.

To apply specific settings to a device

The Unique iPad ID can be used in combination with our Remote Settings Control .xml file to apply specific settings to one or more devices. More information is available here.

To identify which device is accessing your content

The Unique iPad ID can be accessed through our JavaScript API, allowing you to customize your page or tag data based on that identifier. More information is available here.

Values for Remote Settings Control & Managed App Configuration

Key uniqueiPadID
Key Type string
Default Value [empty]

Note: This identifier is not included in a Remote Settings or Managed App Configuration export from within the app as it is expected to be unique to a single kiosk. As such, it must be manually added to the file if needed using the following formats:

Remote Settings Control (current V2 XML format) & Managed App Configuration

<string>ENTER ID HERE</string>

(this would be inserted alongside other settings in between an opening <dict> and closing </dict> tag within the file)

Remote Settings Control (legacy XML format)

   <key>Value</key><string>ENTER ID HERE</string>

In addition, this value cannot be overwritten with a blank value during a Remote Settings Update without additional configuration - see this article for more detail. 

Change Log

  • Included in version 1.0. Ability to use ID as a placeholder for other settings added in version 6.6

Related Articles

Still stuck? How can we help? How can we help?