Generate Update Related Attribute Rule (Data Management Tools)
Summary
Generates an attribute rule that updates related records in other classes when updates are made to an input table. This can be based on one or more of the following: utility network associations, relationship classes, match fields, and spatial relationships.
Usage
After the tool has been run, import the attribute rule and apply it to the dataset. If the dataset is in an enterprise geodatabase, you must be the data owner to apply the output template attribute rule.
If the Input Table parameter value or the Search Options parameter's Target Layer value is not a utility network class or table, the Search Type value cannot be a utility network association type.
If the Input Table parameter value or the Search Options parameter's Target Layer value is a table, the Search Type value cannot be Spatial Only.
If the Input Table parameter value and the Search Options parameter's Target Layer value do not participate in a relationship class with each other, the Search Type value cannot be Relationship Class.
The table or feature class that will have the new rule applied.
Table View
Output Folder
The folder where the output will be saved.
Folder
Search Options
Updates a related value in the target layer using either a utility network association, relationship class, match fields, or spatial relationship between the input class and any target classes.
Value table columns:
Target Layer—The layer to which the search option will be applied.
Target Field—The field in the target layer that will be updated by the attribute rule.
Search Type—The search type that will be applied to the input table and target table.
Relationship Class—A related value in the target class will be updated using a relationship class between the input class and any target classes.
Match Fields—A field in the target classes will be updated based on updates to a field in the input class based on a match field (primary or foreign key relationship).
Spatial Only—A field in a target layer will be updated based on the intersection between features from the input class and any output classes.
Connected (UN Association)—The features connected to the specified feature through a connectivity association will be returned.
Container (UN Association)—The features containing the specified feature through a containment association will be returned.
Content (UN Association)—The features containing the specified feature through a containment association will be returned.
Structure (UN Association)—The feature that the specified feature is attached to through a structural attachment association will be returned.
Attached (UN Association)—The features attached to the specified feature through a structural attachment association will be returned.
Junction Edge (UN Association)—The features connected to the specified feature through a junction-edge connectivity association will be returned.
Midspan (UN Association)—The features connected to the specified feature through a junction-edge midspan connectivity association will be returned.
Input Field or Value—The field or value that will be edited in the input class.
Operator—The method that will be used to relate the target and input fields.
Set Value—The value in the target field will be updated with the value from the input field.
Concatenate—The existing value in the target field will be updated by concatenating with the value in the source field. By default, the values will concatenated with a hyphen (-) character.
Bitwise Or—A bitwise operation will be performed on the existing value in the target field with the incoming value from the source field. Both the source and target fields must be numeric.
Search Distance—The maximum distance from an input feature that a target feature can be. Only features within this distance will be updated.
Target Match Fields—The foreign key field from the target class that links to the Input Match Field value in the input class.
Input Match Fields—The primary key field from the source class that links to the Target Match Field value in the target class.
Value Table
Expression
An SQL expression that will be used to limit the features from the input that will participate in the attribute rule.
SQL Expression
Derived output
Label
Explanation
Data type
Output CSV File
The output .csv file containing the template attribute rule.
The table or feature class that will have the new rule applied.
Table View
out_folder
The folder where the output will be saved.
Folder
search_options[search_options,...]
Updates a related value in the target layer using either a utility network association, relationship class, match fields, or spatial relationship between the input class and any target classes.
Value table columns:
Target Layer—The layer to which the search option will be applied.
Target Field—The field in the target layer that will be updated by the attribute rule.
Search Type—The search type that will be applied to the input table and target table.
RELATIONSHIP_CLASS—A related value in the target class will be updated using a relationship class between the input class and any target classes.
MATCH_FIELDS—A field in the target classes will be updated based on updates to a field in the input class based on a match field (primary or foreign key relationship).
SPATIAL_ONLY—A field in a target layer will be updated based on the intersection between features from the input class and any output classes.
UN_CONNECTED—The features connected to the specified feature through a connectivity association will be returned.
UN_CONTAINER—The features containing the specified feature through a containment association will be returned.
UN_CONTENT—The features containing the specified feature through a containment association will be returned.
UN_STRUCTURE—The feature that the specified feature is attached to through a structural attachment association will be returned.
UN_ATTACHED—The features attached to the specified feature through a structural attachment association will be returned.
UN_JUNCTION_EDGE—The features connected to the specified feature through a junction-edge connectivity association will be returned.
UN_MIDSPAN—The features connected to the specified feature through a junction-edge midspan connectivity association will be returned.
Input Field or Value—The field or value that will be edited in the input class.
Operator—The method that will be used to relate the target and input fields.
SET_VALUE—The value in the target field will be updated with the value from the input field.
CONCATENATE—The existing value in the target field will be updated by concatenating with the value in the source field. By default, the values will concatenated with a hyphen (-) character.
BITWISE_OR—A bitwise operation will be performed on the existing value in the target field with the incoming value from the source field. Both the source and target fields must be numeric.
Search Distance—The maximum distance from an input feature that a target feature can be. Only features within this distance will be updated.
Target Match Fields—The foreign key field from the target class that links to the Input Match Field value in the input class.
Input Match Fields—The primary key field from the source class that links to the Target Match Field value in the target class.
Value Table
where_clause
An SQL expression that will be used to limit the features from the input that will participate in the attribute rule.
SQL Expression
Derived output
Name
Explanation
Data type
out_rule_csv
The output .csv file containing the template attribute rule.
File
Code sample
GenerateUpdateRelatedAttributeRule example (Python window)
The following example demonstrates the use of the GenerateUpdateRelatedAttributeRule function.
import arcpy
arcpy.management.GenerateUpdateRelatedAttributeRule(
in_table="A_Table",
out_folder=r"C:/project/path/to/folder",
search_options="Test Field 'Match Fields' Field 'Set Value' '20 Feet' Field_1 Field_1"
)
Environments
This tool does not use any geoprocessing environments.