Set Network Category (Utility Network)

Summary

Assigns a network category to a feature class or table at the asset type level to be used during tracing operations.

Categories are defined on asset types to constrain the beginning and end of several analytical traces.

Learn more about network categories

Learn more about how to set or modify a network category assignment

Usage

  • An asset type can participate in one or more categories. For example, a fuse asset group can be in both a disconnect and a protective category.

  • This tool can be used with the Add Network Category tool, which is used to add a new network category to the utility network.

  • The network topology must be disabled.

  • The following requirements must be met when working with an enterprise geodatabase:
    • The connected ArcGIS Enterprise portal account must be the portal utility network owner.
    • The Input Utility Network parameter value must be from a database connection established as the database utility network owner.
    • This tool must be connected to the default version to run.
      • All other sessions connected to the default version are blocked from running validate or enable operations during the enable operation.

Parameters

LabelExplanationData Type
Input Utility Network

The utility network that contains the network category.

Utility Network; Utility Network Layer
Domain Network

The domain network in the utility network that contains the network category.

String
Input Table

The utility network feature class or table to which the asset type belongs.

String
Asset Group

The asset group to which the asset type belongs.

String
Asset Type

The asset type to alter the category configuration.

String
Categories
(Optional)

The categories to be assigned to the asset type. The categories that are specified for this parameter will replace the current categories that are assigned to the asset type. To unassign a network category from an asset type, do not specify a category for this parameter.

Note:

The Subnetwork Controller system-provided network category is only available for asset types in the device feature class and junction object table. In a domain network with a partitioned tier definition, the selected asset type must also have a directional terminal configuration assigned with a minimum of one upstream and one downstream terminal.

String

Derived Output

LabelExplanationData Type
Updated Utility Network

The updated utility network.

Utility Network

arcpy.un.SetNetworkCategory(in_utility_network, domain_network, featureclass, assetgroup, assettype, {category})
NameExplanationData Type
in_utility_network

The utility network that contains the network category.

Utility Network; Utility Network Layer
domain_network

The domain network in the utility network that contains the network category.

String
featureclass

The utility network feature class or table to which the asset type belongs.

String
assetgroup

The asset group to which the asset type belongs.

String
assettype

The asset type to alter the category configuration.

String
category
[category,...]
(Optional)

The categories to be assigned to the asset type. The categories that are specified for this parameter will replace the current categories that are assigned to the asset type. To unassign a network category from an asset type, do not specify a category for this parameter.

Note:

The Subnetwork Controller system-provided network category is only available for asset types in the device feature class and junction object table. In a domain network with a partitioned tier definition, the selected asset type must also have a directional terminal configuration assigned with a minimum of one upstream and one downstream terminal.

String

Derived Output

NameExplanationData Type
out_utility_network

The updated utility network.

Utility Network

Code sample

SetNetworkCategory example 1 (Python window)

Apply the disconnect and protective categories to air-powered fuses in an electric distribution domain network.

import arcpy
arcpy.SetNetworkCategory_un("Utility Network", "ElectricDistribution", 
                            "ElectricDistributionDevice", "Fuse", "Air Powered", 
                            ["Disconnect", "Protective"])
SetNetworkCategory example 2 (Python window)

Unassign a network category for air-powered fuses in an electric distribution domain network.

import arcpy
arcpy.SetNetworkCategory_un("Utility Network", "ElectricDistribution", 
                            "ElectricDistributionDevice", "Fuse", "Air Powered")

Environments

Licensing information

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

Related topics