Search

User Manual

GETTING STARTED


MODULES AND PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


GLOSSARY


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support
SDK Documentation
SDK Examples

ALL USER MANUAL VERSIONS

Ignition 8.1
Ignition 7.9
Ignition 7.8

Deprecated Pages

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: published 8.0.16 info


Session Props

Session Properties, as the name implies, are available for use throughout Perspective Sessions. Sessions of a given project will have the same list of properties, however, the actual values are unique and independent for each running Session.

Each Session creates its own instance of these properties. This makes them very useful as in-project variables for passing information between views or browser tabs, and between other parts of the Session, such as scripting.

The Property Editor displays Session Properties when viewed from the Perspective Start Screen. Each session contains a series of properties with unique values. These properties provide some useful information about where the session is running. Additionally, custom properties may be added, providing a way for a session to store additional values which can be used in bindings and scripts, and are also important for passing parameters from one view to another.

System Properties

Some session props are intentionally restricted with a System property and cannot be changed or removed. These properties have a System  icon displayed next to them in the Property Editor as you can see in the image below.  


On_this_page



Iulink
URLhttps://www.inductiveuniversity.com/videos/session-props/8.0
NameSession Props




Session Properties Table

The identity provider's ID. Replaced by the idp

Name

Description

Property Type

idUnique session identifier.value: string
host


New_in
Version8.0.1


Reflects the connecting system's IP address or hostname.

value: string
themeThe 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
localeThe current locale of this session.value: string
timeZoneIdTimezone identification code, for example America/Los_Angeles.value: string
auth

Represents the user's authentication and authorization for this session. 

Contains information about the user, if they are authenticated.

A timestamp representing the last time the current user authenticated against the Identity Provider. 

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.

Expand
titleClick here to see the auth properties...


On 8.0.16 release, replace the expand macro and table with the following:

Expand
titleClick here to see the auth properties...
NameDescriptionProperty Type
authenticatedTrue if the user is authenticated. False if the user is unauthenticated. Null if the user's authentication status is unknown.value: boolean
user
NameDescriptionProperty Type
id

The IdP's unique identifier for this user. Null if the user is not authenticated.

value: string
userNameThe user's username. Null if the user is not authenticated.value: string
firstNameThe 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
lastNameThe 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
New_in
Version8.0.14
value: timestampobjectsecurityLevels
NameDescriptionProperty Type
nameThe name for this security level. Must be unique among its siblings.value: string
childrenSecurity levels which descend from this security level.array
arrayidpId
Deprecated
Version8.0.6
NameDescriptionProperty Type
authenticatedTrue 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.

NameDescriptionProperty Type
id

The IdP's unique identifier for this user. Null if the user is not authenticated.

value: string
userNameThe user's username. Null if the user is not authenticated.value: string
firstNameThe 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
lastNameThe 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


New_in
Version8.0.14


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.

NameDescriptionProperty Type
nameThe name for this security level. Must be unique among its siblings.value: string
childrenSecurity levels which descend from this security level.array


array
idpId


Deprecated
Version8.0.6


The identity provider's ID. Replaced by the idp

 property
value: string
idpThe name of the Identity Provider configuration set on the project. value: string
Editor_notes

 property

value: string
idpThe name of the Identity Provider configuration set on the project. value: string
idpAttributes


New_in
Version8.0.16


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. 

Info

The Designer does not authenticate against identity providers in Ignition 8.0, so this object will always appear empty in the designer. Use the Test Login page to determine the shape of this property, or use a simple binding to something visual (i.e. a label) display and parse the results while developing your project. 


object




objectgateway

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.


Expand
titleClick here to see the Gateway properties


NameDescriptionProperty Type
addressRemote host address of the connected Gateway.value: string
timezone

Document providing time zone information.

NameDescriptionProperty Type
idTime zone identification code, for example America/Los_Angeles.value: string
nameName of the timezone.value: string
utcOffsetOffset of the current timezone relative to UTC, in hours.value: numeric


object
connected


New_in
Version8.0.2


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



objectdevice

Properties for the device that is running the session. 

Expand
titleClick here to see device properties


NameDescriptionProperty Type
typeType of device that created this session. Read only. Options are ios, android, designer, browser. Empty string if device is unknown during loading. value: string
identifierUnique 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. 

NameDescriptionProperty Type
idTime zone identification code, for example America/Los_Angeles.value: string
utcOffsetOffset of the current timezone relative to UTC, in hours.value: numeric


object
userAgentUser agent string of the connected device. value: string

settings


New_in
Version8.0.7


Array of settings for the device.

NameDescription
preventSleepPrevents 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. 

NameDescriptionProperty Type
timestampTimestamp represented as standard 'milliseconds since unix epoch'.value: string
xAcceleration force (in m/s2) along the x axis (including gravity).value: numeric
yAcceleration force (in m/s2) along the y axis (including gravity).value: numeric
zAcceleration force (in m/s2) along the z axis (including gravity).value: numeric


object



objectbluetooth


New_in
Version8.0.5



Options and data provided by device Bluetooth services.

Expand
titleClick here to see bluetooth properties


NameDescriptionProperty Type
enabledIf true, enables bluetooth capability.value: boolean
options

Bluetooth options.

Expand
titleClick here to see bluetooth property options


NameDescriptionProperty Type
updateIntervalHow often should the session check for new data packets. Duration in ms to buffer Bluetooth data before sending to Perspective.value: numeric
limitMaximum number of packets to display. The order of packets is strongest RSSI (Received Signal Strength Indicator) to weakest.value: numeric
filter

Bluetooth filtering options.

NameDescriptionProperty Type
enabledIf true, will enable filtering on the packets.value: boolean
minimumRSSIMinimum strength of RSSI to return. Enter 0 to ignore.value: numeric
altBeacon

AltBeacon format.

Expand
titleClick here to see altBeacon properties


NameDescriptionProperty Type
exclusiveExclude other beacon types that are not altBeacon.value: boolean
uuidThe 16 byte beacon identifier. Ignores packets that don't match the value specified.value: string



object
eddystone

Eddystone open beacon format.

Expand
titleClick here to see eddystone properties


NameDescriptionProperty Type
exclusiveExclude other beacon types that are not eddystone.value: boolean
nameSpaceIDNamespace identifier. Ignores packets that don't match the value specified.value: string



object
iBeacon

iBeacon format.

Expand
titleClick here to see iBeacon properties


NameDescriptionProperty Type
exclusiveExclude other beacon types.value: boolean
uuid16 byte proximity uuid of iBeacon. On iOS this must be specified in order to receive iBeacon data.value: string



object





object
dataWill populate with most recent packets from any detected beacons.array



value: objectgeolocation

Options and data provided by web or native device geolocation services.

Expand
titleClick here to see geolocation properties


NameDescriptionProperty Type
enabledIf 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


NameDescriptionProperty Type
accuracy

Indicates the mode of accuracy the application uses to receive results: max, balanced, and low.

Expand
titleClick here to see options


NameDescriptionProperty Type
maxMaximum accuracy (and highest battery use). Accurate to the level allowed by the environment/device.value: string
balancedBalanced 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
lowLow 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
maximumAgeA 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. 

NameDescriptionProperty Type
latitudeA floating point value representing the position's latitude in decimal degrees. Null if location is disabled.value: float
longitudeA floating point value representing the position's longitude in decimal degrees. Null if location is disabled.value: float
altitudeA 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
accuracyA double representing the accuracy of the latitude and longitude properties, expressed in meters.value: double
altitudeAccuracyA 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
headingReturns 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
speedReturns a double representing the velocity of the device in meters per second. This value can be null.value: double
timestampTime the last location update was received.value: string


object



objectappBar

Settings relevant to the bottom-docked "App Bar" which lists Gateway information.

New_in
Version8.0.5



Expand
titleClick here to see appBar properties


NameDescriptionProperty Type
togglePositionThe position of the overlaid toggle button that shows the app bar: right, left or hidden.value: string



object