On this page
The table action task profile defines one of the tasks the application should perform, if they select a table command.
Profile variables
Variable name | Type | Description |
---|---|---|
$map | FeatureSetCollection | The list of layers in the web map. Can be used with the FeatureSetByName or FeatureSetById function to get a particular layer in the map. This can then be queried. |
$userId | Text | The unique user ID of the editor who is logged into the application. |
$userName | Text | The full name of the editor who is logged into the application. |
$userIdentity | Text | Provides a credential instance. This can be used when accessing external layers with the FeatureLayer function. The credentials represent the user’s logged in credentials. |
$session | Dictionary | A dictionary containing key value pairs. The dictionary contains all the session variables that have been configured in the app. When the application first launches, the user will be asked for values for the session variables. They can also (if configured) change session variables in the application. This provides programmatic access to the user’s choices / settings. |
$selection | FeatureSetCollection | The list of layers in the web map. Can be used with the FeatureSetByName or FeatureSetById function to get a particular layer in the map. It will only contain the features from each layer selected on the map. This can then be queried. |
$currentMapExtent | Extent | The current map extent. This value is not available for all scripts. |
$currentTool | Text | The type of tool selected. Will be one of new , add , effects , reshape , subtract , pan , select , unprotect . This value is not available for all scripts. It also represents the current state, not the state for why the script is running. |
$action | Dictionary | The selected table row will be in $action.row |
$targetLayer 1 | FeatureSet | The layer that is either being filtered, or records are being added, deleted or updated in |
1 : This option is only available for certain task types.
Return types
The return value will depend on the type of task being configured.
Example
Please see section Execution tasks and subsections for examples and further information.