Depending on the trigger selected for an Expression Rule, certain global variables are pre-populated and made available to the Groovy script of a Custom Object at execution time. The following table lists and briefly describes these global variables. The table also shows the type of trigger for an Expression Rule for which these global variables are pre-populated and made available to the script.
For details about the SDK objects, refer to the Javadocs that accompany the Axeda Platform SDK and also to the Axeda® Platform API Developer's Guide.
Variable Name |
Description |
Expression Rule Triggers |
parameters |
A java.util.Map of the parameters configured by the Custom Object, keyed by parameter name, containing the values passed from the ExecuteCustomObject action used in the Expression Rule |
All Types (for a complete list, refer to Triggers (for expressions) definition |
context |
An SDK Device object (refer to the Axeda® Platform API Developer's Reference Guide for details on the SDK objects) |
Alarm, AlarmExtendedDataChange, AlarmSeverityChange, AlarmStateChange, Data, File, MobileLocation, Registration, StateChange |
alarm |
An SDK Alarm object |
Alarm, AlarmStateChange, AlarmExtendedDataChange, AlarmSeverityChange |
compressedFile |
An SDK UploadedFile object |
All Types (for a complete list, refer to Triggers (for expressions) definition |
dataItemList |
A DataValueList |
Data |
dataItems |
DEPRECATED. Do NOT use. |
N/A |
event |
An SDK Event object |
Event |
logger |
When you want to write out information using the Groovy writer object, this object is used to output the information. For a Custom Object, the information is written to the Test Results window or to its log file. For an Expression Rule that uses the action, ExecuteCustomObject, to run a Custom Object, the Debug, Info, and Error statements from the Groovy script are written to the custom object log file. |
All Types (for a complete list, refer to Triggers (for expressions) definition |
mobileLocation |
An SDK MobileLocation object |
MobileLocation |
user |
An SDK User object |
UserLogin, UserLogout |