| id | Unique session identifier. | value: string |
| host |
The following feature is new in Ignition version 8.0.1
Click here to check out the other new features
Reflects the connecting system's IP address or hostname. | value: string |
| theme | The theme to use in the session. The default theme is light. Writing a theme name to this property will change the theme for the session. | value: string |
| locale | The current locale of this session. | value: string |
| timeZoneId | Timezone identification code, for example America/Los_Angeles. | value: string |
| auth | Represents the user's authentication and authorization for this session. Click here to see the auth properties...
| Name | Description | Property Type |
|---|
| authenticated | True if the user is authenticated. False if the user is unauthenticated. Null if the user's authentication status is unknown. | value: boolean | | user | Contains information about the user, if they are authenticated. | Name | Description | Property Type |
|---|
| id | The IdP's unique identifier for this user. Null if the user is not authenticated. | value: string | | userName | The user's username. Null if the user is not authenticated. | value: string | | firstName | The user's first name. Null if the user is not authenticated, if the IdP did not provide this attribute, or if no mapping was configured for this attribute. | value: string | | lastName | The user's last name. Null if the user is not authenticated, if the IdP did not provide this attribute, or if no mapping was configured for this attribute. | value: string | | email | The user's email address. Null if the user is not authenticated, if the IdP did not provide this attribute, or if no mapping was configured for this attribute. | value: string | | roles | The roles that the IdP assigned this user. Null if the user is not authenticated, if the IdP did not provide this attribute, or if no mapping was configured for this attribute. | value: string | | timestamp |
The following feature is new in Ignition version 8.0.14
Click here to check out the other new features
A timestamp representing the last time the current user authenticated against the Identity Provider. | value: timestamp |
| object | | securityLevels | The deepest security levels in the tree granted to the current user, starting with the children of the Public security level. The Public security level is never shown since all sessions include Public. | Name | Description | Property Type |
|---|
| name | The name for this security level. Must be unique among its siblings. | value: string | | children | Security levels which descend from this security level. | array |
| array | | idpId |
This feature was removed from Ignition in version 8.0.6
The identity provider's ID. Replaced by the idp property | value: string | | idp | The name of the Identity Provider configuration set on the project. | value: string | | idpAttributes |
The following feature is new in Ignition version 8.0.16
Click here to check out the other new features
Represents the JSON object returned by the identity provider after logging in. The structure of this object will match that of the JSON provided by the Test Login Identity Provider page. | object |
| object |
| gateway | Properties for the Gateway that this session is running on. The value of this property will not be saved with the view. Does not persist by default. Click here to see the Gateway properties | Name | Description | Property Type |
|---|
| address | Remote host address of the connected Gateway. | value: string | | timezone | Document providing time zone information. | Name | Description | Property Type |
|---|
| id | Time zone identification code, for example America/Los_Angeles. | value: string | | name | Name of the timezone. | value: string | | utcOffset | Offset of the current timezone relative to UTC, in hours. | value: numeric |
| object | | connected |
The following feature is new in Ignition version 8.0.2
Click here to check out the other new features
True when connected to a websocket. All tabs in the session must have a connected websocket to become true. If a session disconnects but is still open in the browser, the property will not change, as the property write from the Gateway can't write to the disconnected session. | value: boolean |
| object |
| device | Properties for the device that is running the session. Click here to see device properties | Name | Description | Property Type |
|---|
| type | Type of device that created this session. Read only. Options are ios, android, designer, browser. Empty string if device is unknown during loading. | value: string | | identifier | Unique ID representing this device. This is a convenience property not intended/suited for security purposes. May change via device/application re-installs or browser cache clears. | value: string | | timezone | Document providing time zone information. | Name | Description | Property Type |
|---|
| id | Time zone identification code, for example America/Los_Angeles. | value: string | | utcOffset | Offset of the current timezone relative to UTC, in hours. | value: numeric |
| object | | userAgent | User agent string of the connected device. | value: string | settings |
The following feature is new in Ignition version 8.0.7
Click here to check out the other new features
Array of settings for the device. | Name | Description |
|---|
| preventSleep | Prevents the device from sleeping while viewing project in the mobile Perspective App. Default is false. |
| array | | accelerometer | When continuous read mode is active, represents values retrieved from the accelerometer. | Name | Description | Property Type |
|---|
| timestamp | Timestamp represented as standard 'milliseconds since unix epoch'. | value: string | | x | Acceleration force (in m/s2) along the x axis (including gravity). | value: numeric | | y | Acceleration force (in m/s2) along the y axis (including gravity). | value: numeric | | z | Acceleration force (in m/s2) along the z axis (including gravity). | value: numeric |
| object |
| object |
| bluetooth |
The following feature is new in Ignition version 8.0.5
Click here to check out the other new features
Options and data provided by device Bluetooth services. Click here to see bluetooth properties | Name | Description | Property Type |
|---|
| enabled | If true, enables bluetooth capability. | value: boolean | | options | Bluetooth options. Click here to see bluetooth property options | Name | Description | Property Type |
|---|
| updateInterval | How often should the session check for new data packets. Duration in ms to buffer Bluetooth data before sending to Perspective. | value: numeric | | limit | Maximum number of packets to display. The order of packets is strongest RSSI (Received Signal Strength Indicator) to weakest. | value: numeric | | filter | Bluetooth filtering options. | Name | Description | Property Type |
|---|
| enabled | If true, will enable filtering on the packets. | value: boolean | | minimumRSSI | Minimum strength of RSSI to return. Enter 0 to ignore. | value: numeric | | altBeacon | AltBeacon format. Click here to see altBeacon properties | Name | Description | Property Type |
|---|
| exclusive | Exclude other beacon types that are not altBeacon. | value: boolean | | uuid | The 16 byte beacon identifier. Ignores packets that don't match the value specified. | value: string |
| object | | eddystone | Eddystone open beacon format. Click here to see eddystone properties | Name | Description | Property Type |
|---|
| exclusive | Exclude other beacon types that are not eddystone. | value: boolean | | nameSpaceID | Namespace identifier. Ignores packets that don't match the value specified. | value: string |
| object | | iBeacon | iBeacon format. Click here to see iBeacon properties | Name | Description | Property Type |
|---|
| exclusive | Exclude other beacon types. | value: boolean | | uuid | 16 byte proximity uuid of iBeacon. On iOS this must be specified in order to receive iBeacon data. | value: string |
| object |
|
|
| object | | data | Will populate with most recent packets from any detected beacons. | array |
| value: object |
| geolocation | Options and data provided by web or native device geolocation services. Click here to see geolocation properties | Name | Description | Property Type |
|---|
| enabled | If true, will attempt to populate location data into the 'data' property. | value: boolean | | permissionGranted | If geolocation is enabled and a geolocation permission prompt is requested, this field populates true if the user allowed permission. Otherwise, it is false. Read only. | value: boolean | | options | | Name | Description | Property Type |
|---|
| accuracy | Indicates the mode of accuracy the application uses to receive results: max, balanced, and low. Click here to see options | Name | Description | Property Type |
|---|
| max | Maximum accuracy (and highest battery use). Accurate to the level allowed by the environment/device. | value: string | | balanced | Balanced accuracy - accuracy resolves ~100m (about a city block) using a more efficient poll rate and supplementing with device data. Balanced is the default value. | value: string | | low | Low accuracy typically does not use a GPS sensor, but relies on environmental meta data (such as cell tower information, Wi-Fi connectivity, etc.). Most efficient, accurate to approximately town/3 kilometers. | value: string |
| value: boolean | | maximumAge | A positive long value indicating the maximum age in milliseconds of a possible cached position that is acceptable to return. If set to 0, it means that the device cannot use a cached position and must attempt to retrieve the real current position. If set to infinity, the device must return a cached position regardless of its age. Default is 0. | value: numeric |
|
| | data | If geolocation is enabled and the device can provide geolocation data, this will hold information about location. | Name | Description | Property Type |
|---|
| latitude | A floating point value representing the position's latitude in decimal degrees. Null if location is disabled. | value: float | | longitude | A floating point value representing the position's longitude in decimal degrees. Null if location is disabled. | value: float | | altitude | A double representing the position's altitude in meters, relative to sea level. This value can be null if the implementation cannot provide the data. | value: double | | accuracy | A double representing the accuracy of the latitude and longitude properties, expressed in meters. | value: double | | altitudeAccuracy | A double representing the accuracy of the altitude expressed in meters. May be null if device fails to provide or if geolocation is disabled. | value: double | | heading | Returns a double representing the direction in which the device is traveling. This value, specified in degrees, indicates how far off the device is from heading true north. 0 degrees represents true north, and the direction is determined clockwise (which means that east is 90 degrees and west is 270 degrees). If speed is 0, heading is NaN. If the device is unable to provide heading information, this value is null. | value: double | | speed | Returns a double representing the velocity of the device in meters per second. This value can be null. | value: double | | timestamp | Time the last location update was received. | value: string |
| object |
| object |
| appBar | Settings relevant to the bottom-docked "App Bar" which lists Gateway information.
The following feature is new in Ignition version 8.0.5
Click here to check out the other new features
Click here to see appBar properties | Name | Description | Property Type |
|---|
| togglePosition | The position of the overlaid toggle button that shows the app bar: right, left or hidden. | value: string |
| object |
icon displayed next to them in the Property Editor as you can see in the image below. 
