Read Only Variables

These variable definitions are pre-defined and hard-coded as part of the Interaction Designer installation, and there is no option to modify definitions through the UI. In addition, they cannot be allocated with values through the Interaction flow. Instead, they are allocated with predefined values by the server at runtime.

The Read Only variables can be viewed using the Read Only Variables tab of the Variables Definition dialog. (To access the dialog, from the Edit menu, select Variables.) As these variables cannot be modified by users, the Edit icons are disabled.

Read Only Variables Tab

Read Only variables are listed and described in the following table.

tog_minusRead Only Variables

Variable Name

Request Header

Type

Sent by
Agent App

Sent by
Mobile Web Service

Sent by Mobile Self Service

Example/Notes

Accuracy

Accuracy

Number

 

 

N/A

Example: 1414

Altitude

Altitude

Number

 

 

N/A

Example: 73

Altitude Accuracy

Altitude-Accuracy

Number

 

 

N/A

Example: 1414

Android Id

Android-Id

Text

 

 

N/A

A 64-bit number (as a hex string)  that is randomly generated on the device's first boot. This number should remain constant for the lifetime of the device.

Bearing

Bearing

Number

 

 

N/A

Compass direction degrees, e.g., 322

Brand

Brand

Text

 

 

N/A

The brand the software is customized for, if any (e.g., Samsung).

Camera Is Available

Camera-Is-Available

Boolean

 

 

N/A

True: Device has a camera

False: Device does not have a camera

Device Name

Device-Name

Text

 

 

N/A

Example: John's iphone

Device OS

Device-OS

Text

 

 

Yes

Replaces Device-Type  (used for mobile application version  validation).
Examples:

Android

iPhone OS

Device OS Version

Device-OS-Version

Text

 

 

Yes

Replaces Os-Platform-Version  (was used for mobile application version validation).

Example: 5.1.1.

Device Platform

Device-Platform

Text

 

 

N/A

Examples:

iPhone 4/5

GT-I9300

Device Serial ID

Device-Serial-ID

Text

 

 

Yes

 

ICCID

ICCID

Text

 

 

N/A

 

IMEI

IMEI

Text

 

 

Generated ID

 

IMSI

IMSI

Text

 

 

N/A

International Mobile Subscriber Identity

Interaction unique ID

user-id

Text

 

 

Yes

The server-generated unique id   (could be generated by the cover app).

JMA Module Version

JMA-Module-Version

 

 

 

 

Used for mobile application version validation.

Example: Currently 2 in iPhone, 5 in Android

JMA Version

JMA-Version

 

 

 

 

Example: 6.1.0.

Latitude

Latitude

Text

 

 

Yes

Example: 32.160454

Locale

Locale

Text

 

 

Yes

Example: en-US

Longitude

Longitude

Text

 

 

Yes

Example: 34.889416

Manufacturer

Manufacturer

Text

 

 

N/A

The manufacturer of the  product/hardware (e.g., Samsung).

Protocol Version

Protocol-Version

Text

 

 

Yes

Used for mobile application version validation.

SIM State

SIM-State

Text

 

 

N/A

 

Screen DPI

Screen-DPI

Number

 

 

N/A

Replaces UA-resolution

Screen Height

Screen-Height

Number

 

 

Yes

Pixels (replaces UA-pixels)

Screen Width

Screen-Width

Number

 

 

Yes

Pixels (replaces UA-pixels)

Speed

Speed

Number

 

 

N/A

Example: 35

Time Stamp

Time-Stamp

 

 

 

Yes

 

Time Zone

Time-Zone

Text

 

 

Yes

 

WIFI

WIFI

Boolean

 

 

N/A