Skip to content

Object

Actions are written in standard JavaScript, but development requires the use of an action-specific object.
An object is structural data that holds data. Objects include $ui, $const, and $comp, which have preregistered properties, and $param and $session, to which properties can be added arbitrarily.
There is also $req and $res which can only be used in REST API actions.

ObjectPurposeDescription
$uiAccess to UI componentsCan set/get values for registered properties
$paramData transfer to the next uiCan set/get any property
$sessionData transfer during a sessionCan set/get any property
$constConstant ReferencePossible to retrieve registered constant values
$reqRequest dataObtain HTTP request object in REST API action
$resResponse dataSet HTTP response object in REST API action
$compDynamic component definitionCan dynamically define components within actions
See Object on the Dynamic Components page for details