Alter Attribute Rule (Data Management)

Summary

Alters the properties of an attribute rule.

Usage

  • Altering an attribute rule requires an exclusive lock on the dataset. Any active connections to the dataset should be closed, which may include stopping any services.

Parameters

LabelExplanationData Type
Input Table

The table containing the attribute rule to be altered.

Table View
Rule Name

The name of the attribute rule that will be altered.

String
Description
(Optional)

The description of the attribute rule. To clear the current value of the description, choose the Reset option from the drop-down menu.

  • Reset —Clear the value of the current rule description.
String
Error Number
(Optional)

The error number of the attribute rule. To clear the current value of the error number for a calculation rule, choose the Reset option from the drop-down menu. Error number is a required property for constraint and validation rules and cannot be cleared.

  • Reset —Clear the value of the current rule error number.
String
Error Message
(Optional)

The error message of the attribute rule. To clear the current value of the error message for a calculation rule, choose the Reset option from the drop-down menu. Error message is a required property for constraint and validation rules and cannot be cleared.

  • Reset —Clear the value of the current rule error message.
String
Tags
(Optional)

The tags for the attribute rule. To clear all tags, click Delete to remove each tag from the list, and select Reset from the drop-down menu.

  • Reset —Clear the tags for the rule.
String
Triggering Events
(Optional)

Specifies the editing events that will trigger the attribute rule to take effect. Triggering events are only applicable for constraint rules and calculation rules that have the Batch parameter set to false. Be aware that the new values will replace existing triggering events. To keep the current triggering events, leave this parameter empty.

  • Insert —The rule will be applied when a new feature is added.
  • Update —The rule will be applied when a feature is updated.
  • Delete —The rule will be applied when a feature is deleted.
String
Script Expression
(Optional)

An Arcade expression that defines the rule. To keep the current expression, leave this parameter empty. Be aware that if an expression is provided for this parameter, it will replace the existing Arcade expression of the rule. If you alter the script expression of a batch calculation or validation rule, the rule will need to be reevaluated.

Calculator Expression
Exclude From Client Evaluation
(Optional)

Specifies whether the rule will be evaluated before edits are applied. The default for this property corresponds to the current value set for the rule. That is, if the input rule has the exclude from client evaluation property set to false, the default for this parameter will be unchecked so as to not modify the property without you specifically choosing to do so. This parameter is not applicable for validation rules or batch calculation rules.

  • Checked—The rule will be excluded from client evaluation.
  • Unchecked—The rule will be executed for all clients.

Boolean

Derived Output

LabelExplanationData Type
Updated Table

The input table with the updated attribute rule properties.

Table View; Raster Layer; Mosaic Layer

arcpy.management.AlterAttributeRule(in_table, name, {description}, {error_number}, {error_message}, {tags}, {triggering_events}, {script_expression}, {exclude_from_client_evaluation})
NameExplanationData Type
in_table

The table containing the attribute rule to be altered.

Table View
name

The name of the attribute rule that will be altered.

String
description
(Optional)

The description of the attribute rule. To keep the current value of the description, leave this parameter empty. To clear the current value of the description, use the RESET keyword.

  • RESETClear the value of the current rule description.
String
error_number
(Optional)

The error number of the attribute rule. To keep the current value of the error number, leave this parameter empty. To clear the current value of the error number for a calculation rule, use the RESET keyword. Error number is a required property for constraint and validation rules and cannot be cleared.

  • RESETClear the value of the current rule error number.
String
error_message
(Optional)

The error message of the attribute rule. To keep the current value of the error message, leave this parameter empty. To clear the current value of the error message for a calculation rule, use the RESET keyword. Error message is a required property for constraint and validation rules and cannot be cleared.

  • RESETClear the value of the current rule error message.
String
tags
[tags,...]
(Optional)

The tags for the attribute rule. Be aware that the new values will replace all existing tags; if you want to keep any current tags, include them in this list. For multiple tags, use a semicolon delimiter, for example, Tag1;Tag2;Tag3. To keep the current tags, leave this parameter empty. To clear the current tags, use the RESET keyword.

  • RESETClear the tags for the rule.
String
triggering_events
[triggering_events,...]
(Optional)

Specifies the editing events that will trigger the attribute rule to take effect. Triggering events are only applicable for constraint rules and calculation rules that have the Batch parameter set to false. Be aware that the new values will replace existing triggering events. To keep the current triggering events, leave this parameter empty.

  • INSERTThe rule will be applied when a new feature is added.
  • UPDATEThe rule will be applied when a feature is updated.
  • DELETEThe rule will be applied when a feature is deleted.
String
script_expression
(Optional)

An Arcade expression that defines the rule. To keep the current expression, leave this parameter empty. Be aware that if an expression is provided for this parameter, it will replace the existing Arcade expression of the rule. If you alter the script expression of a batch calculation or validation rule, the rule will need to be reevaluated.

Calculator Expression
exclude_from_client_evaluation
(Optional)

Specifies whether the rule will be evaluated before edits are applied. The default for this property corresponds to the current value set for the rule. That is, if the input rule has the exclude from client evaluation property set to false, the default for this parameter will be INCLUDE so as to not modify the property without you specifically choosing to do so. This parameter is not applicable for validation rules or batch calculation rules.

  • EXCLUDEThe rule will be excluded from client evaluation.
  • INCLUDEThe rule will be executed for all clients.

Boolean

Derived Output

NameExplanationData Type
updated_table

The input table with the updated attribute rule properties.

Table View; Raster Layer; Mosaic Layer

Code sample

AlterAttributeRule example (Python window)

Alter the properties of a constraint attribute rule named constraintRuleOP.

import arcpy
arcpy.AlterAttributeRule_management("C:\\MyProject\\sdeConn.sde\\progdb.user1.GasPipes", 
                                    "constraintRuleOP",
                                    "Operating pressure cannot exceed 300",
                                    "999",
                                    "Invalid operating pressure value",
                                    "Pipeline;OP;ExceededValue")

Environments

Licensing information

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

Related topics