Attribute rules

Attribute rules enhance the editing experience and improve data integrity for geodatabaseA geodatabase is a spatial data storage format that can contain multiple datasets of geographic features and non-spatial tabular data, as well as attachments, field domain definitions, and relationships between layers/tables.Learn more datasets. They are user-defined rules that can automatically populate attributesAttributes are fields and values for a single feature or non-spatial record. They are typically stored in a database or service such as a feature service.Learn more, restrict invalid edits during edit operations, and perform data validation checks on existing features. Attribute rules are defined using ArcGIS ProArcGIS Pro is a professional desktop GIS application that can explore, visualize, analyze, and manage 2D and 3D data.Learn more and are written with the ArcadeArcade is a lightweight and secure expression language used in ArcGIS products and APIs. Arcade expressions are commonly used to calculate or format field values for data-driven visualizations, labels, and popups. The expressions work against data stored in data services.Learn more expression language. See the ArcGIS Pro documentation for an Introduction to attribute rules and Attribute rule script expression examples.

When editing a dataset with attribute rules, there is no additional code required to leverage rule evaluation in your app. Any add, update, or delete feature operation may trigger rule evaluation depending on how you've configured the rule.

Support for attribute rules

Attribute rules are supported in the following feature tablesA feature table is a database table of a single geometry type, such as point, line, or polygon, that stores features that conform to the schema of the table.Learn more and geodatabasesA geodatabase is a spatial data storage format that can contain multiple datasets of geographic features and non-spatial tabular data, as well as attachments, field domain definitions, and relationships between layers/tables.Learn more:

• A ServiceFeatureTable read directly from a web mapA web map is a map stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web map specification.Learn more or web sceneA web scene is a scene stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web scene specification.Learn more.
• A ServiceFeatureTable created directly from a ServiceGeodatabase by calling ServiceGeodatabase.getTable().
• A sync-enabled mobile Geodatabase downloaded using the GeodatabaseSyncTask or OfflineMapTask. ArcGIS Enterprise 11.4 or newer feature services are required to support the download of attribute rules.
• A Geodatabase exported from ArcGIS ProArcGIS Pro is a professional desktop GIS application that can explore, visualize, analyze, and manage 2D and 3D data.Learn more and side loadedSideloading is the process of deploying a file or package to a device without using a network.Learn more onto the device.

Attribute rules are not supported in a ServiceFeatureTable created using any of its constructors. These stand-alone service feature tables lack the context of their parent geodatabase, which is required to evaluate attribute rules.

Attribute rule evaluation on the client

Using ArcGIS ProArcGIS Pro is a professional desktop GIS application that can explore, visualize, analyze, and manage 2D and 3D data.Learn more, you can define whether your attribute rules are evaluated immediately, or whether they are evaluated at a specified time (deferred). Deferred rules are useful if you want to perform data validation on existing features on the feature service. Rules that run immediately are evaluated during editing after a feature is added, updated, or deleted. You can control whether attribute rules are evaluated by your app, by following the ArcGIS Pro instructions in Evaluate attribute rules. For your app to evaluate attribution rules, you must also ensure their Exclude from application evaluation is disabled.

If the rule's Exclude from application evaluation is disabled, every time you edit a feature from one of the supported feature tables, the attribution rule will be evaluated locally in your app.

If the rule's Exclude from application evaluation is enabled, the attribution rule will not be evaluated in your app but they will be evaluated on the feature server, or data source, when ServiceGeodatabase.applyEditsAsync() is called or when SyncGeodatabaseJob completes. Edits made by the feature server due to rule execution are automatically reflected in your app if you use a ServiceGeodatabase or in the replica version of the sync-enabled Geodatabase. However, these updates in the replica version will only be available for download to your app once they have been reconciled and posted to the default branch version. For more information, see the Synchronize with a replica version documentation.

If your app is editing features from a stand-alone Geodatabase exported from ArcGIS Pro, all attribute rules will be evaluated. The stand-alone Geodatabase, unlike a sync-enabled mobile geodatabase that is only a client to a backend feature service, is operating as the data source so every attribute rule is evaluated even if its Exclude from application evaluation value is enabled.