Variables in the formula editor
System variables supported in the formula editor
The following list contains system variables that are supported in the formula editor.
Important:For a list of system variables that can be unique for each open tab in Mobile Client for HTML5, refer to About parent and child tabs.
@_ActivityID
Set by the Start Activity element, and cleared by the Stop Activity element.
Data type: String
Read only
@_AppDesc
Returns the app description.
Data type: String
Read only
@_AppID
Returns the app ID.
Data type: String
Read only
@_AppVersion
Returns the app version.
Data type: String
Read only
@_CommState
Value is 1 if communications are active, otherwise 0.
Data type: Numeric
Modifiable
@_Count
Returns the number of records stored in the main output file, which is the queue to be sent to the server.
Data type: Numeric
Read only
@_Date
Returns the current date in the format YYYYMMDD.
Note:When called as part of an app, the @_Date variable will display the current date for the device's location, not the server's location date.
Data type: StringRead only
@_Device
Returns the name assigned to the device during loading. This device name is a maximum of 10 characters.
Data type: String
Read only
@_DeviceGroup
Returns a value for the device group to which a device belongs when used in data replication on the server.
Note:Applications made with @_DeviceGroup will not return a value to the device. This system variable is used for Device Data Replications. Follow these instructions to set up a device group.
Data type: StringRead only
@_Elapsed
Returns the time (within hundredths of seconds) elapsed. This variable starts at zero when an app, subapp, or form is started.
Data type: Numeric
Modifiable
@_Env
Returns the current environment.
Data type: String
Read only
@_Event
This variable is not referenced directly. Instead, use the event members for descriptions. Examples are:
@_Event.Alt
@_Event.Ctl
@_Event.EventName
@_Event.Height
@_Event.Key
@_Event.KeyCode
@_Event.MouseX
@_Event.MouseY
@_Event.SenderID
@_Event.Shift
@_Event.Width
Data type: String
Read only
@_LanguageID
Returns a two-character identifier that indicates the current language in use.
Data type: String
Read only
@_LastErrorCode
Returns the error status returned by the last server request.
Data type: Numeric
Modifiable
@_LastErrorMessage
Returns the error message(s) from last server request.
Data type: String
Modifiable
@_LocalFilePath
Returns the locally configured path to the directory for storing binary objects on the device (including the trailing backslash).
Data type: String
Read only
@_LocalRepositoryPath
Returns the locally configured path to the local repository on the device.
Data type: String
Read only
@_Location
Returns the values of the most recent successful location acquisition. For example:
@_Location.Accuracy
@_Location.Elevation
@_Location.Latitude
@_Location.Longitude
@_Location.SystemTime
@_Location.TimeStamp
Data type: String or Numeric
Read only
@_NotificationID
Returns the notification ID of the notification message and marks the status in the UserNotificationTable.
Data type: String or Numeric
Read only
@_OrgUnit
Returns the name of the lowest level organizational unit the currently logged-on user belongs to.
Data type: String
Modifiable
@_Promo
Returns the current promotion level.
Data type: String
Read only
@_RuntimeData
Allows for supplying data to an application through a command line argument used to launch customized shortcuts to Mobile Client.
Data type: String
Read only
@_ScanCount
Provides a way for an application to know the number of scanned data entries that are currently buffered and waiting for an InputField that accepts scanned input to take them.
Data type: Numeric
Modifiable
@_ScreenColumns
Returns the screen width in number of columns.
Data type: Numeric
Read only
@_ScreenHeight
Returns the screen height in number of pixels.
Data type: Numeric
Read only
@_ScreenRows
Returns the screen height in number of rows.
Data type: Numeric
Read only
@_ScreenWidth
Returns the screen width in number of pixels.
Data type: Numeric
Read only
@_ServerFileDropDir
On an on-premise Mobile Enterprise Platform implementation, this variable returns the file drop directory configured from Communication Agent. For more information, refer to Configure Communication Agent.
On a Advanced Inventory implementation with the file drop location set to a gateway, this variable returns the file drop directory configured on that gateway. For more information refer to Edit a registered gateway.
On a Advanced Inventory implementation with the file drop location set to cloud storage, this variable is blank.
Data type: String
Read only
@_ServerSigDir
On an on-premise Mobile Enterprise Platform implementation, this variable returns the signature drop directory configured from Communication Agent. For more information, refer to Configure Communication Agent.
On a Advanced Inventory implementation with the signature drop location set to a gateway, this variable returns the signature drop directory configured on that gateway. For more information, refer to Edit a registered gateway.
On a Advanced Inventory implementation with the signature drop location set to cloud storage, this variable will be blank.
Data type: String
Read only
@_Time
Returns the current time in the format HHMMSS.
Note:When called as part of an app, the @_Time variable will display the current time for the device's location, not the server's location time.
Data type: String
Read only
@_TransactionGUID
Allows access to the GUID associated with the most recent Function Call, SQL Statement, or Output.
Data type: String
Read only
@_UserCompany
Returns the company of the user currently logged on.
This variable is not available for AIM sessions.
Data type: String
Read only
@_UserData1 - @_UserData5
References five separate 50-character work areas that can be defined in the user profile. Data stored using these variables may be modified within the application.
Data type: String
Modifiable
@_UserEmail
Returns the email address of the user currently logged on.
This variable is not available for AIM sessions.
Data type: String
Read only
@_UserFirstName
Returns the first name of the user currently logged on.
This variable is not available for AIM sessions.
Data type: String
Read only
@_UserID
Beginning in 9.0 SP8, for new apps, you should use the User variables supported in the formula editor to return the User ID or Login ID of a user.
Beginning in 9.0 SP5, this variable returns the Login ID of the user currently logged in. Previously, this variable returned the User ID.
Data type: String
Read only
@_UserLastName
Returns the last name of the user currently logged on.
This variable is not available for AIM sessions.
Data type: String
Read only
@_UserPhone
Returns the phone number of the use currently logged on.
This variable is not available for AIM sessions.
Data type: String
Read only
@_UtcDate
Returns the current UTC date in the format YYYYMMDD.
Data type: String
Read only
@_UtcTime
Returns the current UTC time in the format HHMMSS.
Data type: String
Read only
Capabilities supported in the formula editor
The following are the supported capabilities in the formula editor.
@_IsCapable.CallForm
Supports the Call Form source element.
@_IsCapable.CaptureImage
Supports the Capture Image source element.
@_IsCapable.CustomAPI
Supports the Custom API source element.
@_IsCapable.Database
Supports operations against a local device database (SQL Statement, Download, Replicate).
@_IsCapable.DevicePrinting
Supports the Device Printing source element. Device printing is currently only available for Android devices.
@_IsCapable.FileSystem
Supports operations against the local file system (Delete File, Move/Rename File, etc.).
@_IsCapable.Location
Supports obtaining device location with GPS or triangulation.
@_IsCapable.Repository
Supports retrieving and accessing files from the file repository.
@_IsCapable.Scan
Supports barcode scanning. This is 1 if the device has scanning capabilities. It is set to 0 for WinDesktop, Telnet, Web, and AIM.
@_IsCapable.ShellCommand
Supports the Shell Command source element.
@_IsCapable.SignatureCapture
Supports the Signature Capture source element and the Signature Entry form control.
Location data
Location data is used to describe a geographical location on earth in terms of latitude, longitude, and altitude
The members of the @Location.XXXX system variables, when used together, detail a geographical location on earth in terms of latitude, longitude, and altitude. They also provide a measure of accuracy in meters, reflecting the level of confidence in location ID. That accuracy can be affected by many factors, such as the number of GPS satellites whose data was used to determine the location.
Latitude and Longitude are expressed in decimal degrees as opposed to degrees, minutes, and seconds. For Latitude, positive values are north of the Equator. For Longitude, positive values are east of the Prime Meridian.
Note:For the LocalTime and SystemTime variables, the format of the time stamp is yyyymmddhhmmss. There are no delimiters included.
In the Location Capture element dialog in the Accuracy drop-down list, Fine means an accuracy of less than 20 meters, Medium means less than 100 meters, Coarse means less than 500 meters, and Very Coarse means anything 500 meters or higher.Refer to Location Data Variables Supported in the Formula Editor for more information.
Location data variables supported in the formula editor
The following are the supported location data variables.
@_Location.Accuracy
The measure in meters of how reliable this reading is.
@_Location.Elevation
The elevation in meters of the elevation.
@_Location.Latitude
The latitude in fractional degrees.
@_Location.Longitude
The longitude in fractional degrees.
@_Location.SystemTime
The time the location was captured in UTC.
@_Location.LocalTime
The time the location was captured according to the device clock.
User variables supported in the formula editor
Beginning in 9.0 SP8, you can use the following user variables in the formula editor.
@_User.UserID
Returns the User ID of the current user.
A User ID is the user identification that the system uses when managing profiles and permissions. This ID can not be edited. The 'User IDs are automatically generated' security option specifies whether the User ID is a randomly generated alphanumeric string, or a copy of the initial Login ID. For more information about User IDs, refer to User profile settings.
Data type: String
Read only
@_User.LoginID
Returns the Login ID of the current user.
Login IDs were added in Mobile Enterprise Platform 9.0 SP5 to support data compliance requirements for the EU General Data Protection Regulation (GDPR). A Login ID is the user identification that users can use to log on to Advanced Inventory Platform Manager or Mobile Client. This ID can be edited by the system administrator. For more information about Login IDs, refer to User profile settings.
Data type: String
Read only
Loading...
There was a problem loading this topic