On this page

The trigger task profile automatically runs when any features are edited.

The trigger script can be run in response to different types of data events add, delete, modify or after all changes to a layer.

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.
`$editingLayer`	FeatureSet	The layer to which `$feature` belongs to. Can be queried to find other records.
`$targetLayer`	FeatureSet	The layer in which features are being written to, updated or deleted from.
`$feature` ¹	Feature	The feature that has been edited, added, or worked on.
`$originalFeature` ¹	Feature	The original version of the feature before it was edited. This is not available for all situations where scripting is run.
`$parentFeature` ¹	Feature	If there is a geographic contains relationship for the current feature being edited, this variable will contain the parent (or containing feature).
`$routeFeature` ¹	Feature	If the feature is a linear referencing feature, this variable will reference source route/line feature.
`$onlyCausedByCracking` ¹	Boolean	Boolean value to indicate that this feature has only been changed to add vertices to prevent slithers appearing.
`$unchangedMap` ²	FeatureSetCollection	The list of layers in the web map with data as it was originally before the current editing operation began executing. This is not available for all situations where scripting is run.
`$editedFeatures` ²	FeatureSet	The set of features that have just been edited. This works with the FeatureSetByName or FeatureSetById function, to get access to a per layer set of features. This will not contain deleted features, as they are no longer in the map.
`$originalEditedFeatures` ²	FeatureSet	The set of features that have just been edited (in their original form). This works with the FeatureSetByName or FeatureSetById function, to get access to a per layer set of features. This will contain deleted features.
`$deletedFeatures` ²	FeatureSet	The set of features that have been deleted in the operation. This works with the FeatureSetByName or FeatureSetById functions, to get access to a per layer set of features.
`$addedFeatures` ²	FeatureSet	The set of features that have been created in the operation. This works with the FeatureSetByName or FeatureSetById functions, to get access to a per layer set of features.
`$modifiedFeatures` ²	FeatureSet	The set of features that have been modified in the operation as they are now. This works with the FeatureSetByName or FeatureSetById functions, to get access to a per layer set of features.
`$originalModifiedFeatures` ²	FeatureSet	The set of features that have been modified in the operation (as they were before they were edited). This works with the FeatureSetByName or FeatureSetById functions, to get access to a per layer set of features.

1 : Only available for ‘Add, Insert, Modify’ trigger types.
2 : Only available if the type of trigger is ‘After all changes’.

Return types

The return value will depend on the type of trigger.

Example

Adding a new feature:

/** Add a new Feature
 *
 * This example creates a new feature using the Feature Arcade Function
 * and then returns it.
 * 
 * Note: 
 * 1) The attribute names must be consistent with those defined in the schema
 *  of the target layer.
 * 2) The Symbol displayed on the map is determined by the webmap.
 *
 */
 
var geom = Point({ x: 1000, y: 1000, spatialReference: { wkid: 102100 } });
return Feature(geom, { attr1: "some attribute", attr2: "another attribute" });