Evaluate Rules (Data Management)

Summary

Evaluates geodatabase rules and functionality.

Learn more about evaluating attribute rules

Usage

  • If there is a selection in the map, only selected features within the specified extent will be evaluated.

  • When the input workspace is a file geodatabase, the entire workspace is evaluated.

  • When the input workspace is a feature service workspace, the validation capability must be enabled.

  • The tool evaluates attribute rules for the default version.

Parameters

LabelExplanationData Type
Input Workspace

A file geodatabase or feature service URL. An example of a feature service URL is https://myserver/server/rest/services/myservicename/FeatureServer.

Workspace
Evaluation Types

Specifies the types of evaluation that will be used.

  • Calculation rulesBatch calculation attribute rules will be evaluated.
  • Validation rulesValidation attribute rules will be evaluated.
String
Extent
(Optional)

The extent to be evaluated. If there is a selection in the map, only selected features within the specified extent will be evaluated.

  • Default—The extent will be based on the maximum extent of all participating inputs. This is the default.
  • Union of Inputs—The extent will be based on the maximum extent of all inputs.
  • Intersection of Inputs—The extent will be based on the minimum area common to all inputs.
  • Current Display Extent—The extent is equal to the visible display. The option is not available when there is no active map.
  • As Specified Below—The extent will be based on the minimum and maximum extent values specified.
  • Browse—The extent will be based on an existing dataset.
Extent
Async
(Optional)

Specifies whether the evaluation will run synchronously or asynchronously. This parameter is only supported when the input workspace is a feature service.

  • Checked—The evaluation will run asynchronously. This option dedicates server resources to run the evaluation with a longer time-out. Running asynchronously is recommended when evaluating large datasets that contain many features requiring calculation or validation. This is the default.
  • Unchecked—The evaluation will run synchronously. This option has a shorter time-out and is best used when evaluating an extent with a small number of features requiring calculation or validation.

Boolean

Derived Output

LabelExplanationData Type
Updated Workspace

The updated feature service workspace that has been evaluated.

Workspace

arcpy.management.EvaluateRules(in_workspace, evaluation_types, {extent}, {run_async})
NameExplanationData Type
in_workspace

A file geodatabase or feature service URL. An example of a feature service URL is https://myserver/server/rest/services/myservicename/FeatureServer.

Workspace
evaluation_types
[evaluation_types,...]

Specifies the types of evaluation that will be used.

  • CALCULATION_RULESBatch calculation attribute rules will be evaluated.
  • VALIDATION_RULESValidation attribute rules will be evaluated.
String
extent
(Optional)

The extent to be evaluated. If there is a selection in the map, only selected features within the specified extent will be evaluated.

  • MAXOF—The maximum extent of all inputs will be used.
  • MINOF—The minimum area common to all inputs will be used.
  • DISPLAY—The extent is equal to the visible display.
  • Layer name—The extent of the specified layer will be used.
  • Extent object—The extent of the specified object will be used.
  • Space delimited string of coordinates—The extent of the specified string will be used. Coordinates are expressed in the order of x-min, y-min, x-max, y-max.
Extent
run_async
(Optional)

Specifies whether the evaluation will run synchronously or asynchronously. This parameter is only supported when the input workspace is a feature service.

  • ASYNCThe evaluation will run asynchronously. This option dedicates server resources to run the evaluation with a longer time-out. Running asynchronously is recommended when evaluating large datasets that contain many features requiring calculation or validation. This is the default.
  • SYNCThe evaluation will run synchronously. This option has a shorter time-out and is best used when evaluating an extent with a small number of features requiring calculation or validation.
Legacy:

In earlier releases, this parameter was named async. At ArcGIS Pro 2.4, the parameter name was changed to run_async to avoid conflicts with the reserved Python keyword async.

Boolean

Derived Output

NameExplanationData Type
updated_workspace

The updated feature service workspace that has been evaluated.

Workspace

Code sample

EvaluateRules example (stand-alone script)

Evaluate validation rules asynchronously using the EvaluateRules function.

# import arcpy
import arcpy

# assign local variables
in_workspace = "https://myserver/server/rest/services/myservicename/FeatureServer"
extent = "-113.187897827702 38.0958054854392 -113.142166008849 38.1404599940719"

# run the evaluation
arcpy.EvaluateRules_management(in_workspace, "VALIDATION_RULES", extent, "ASYNC")

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • Basic: No
  • Standard: Yes
  • Advanced: Yes

Related topics