topic Re: Using python to Validate Network Topology in a version in ArcGIS Utility Network Questions

Using python to Validate Network Topology in a version

jclarke — Fri, 15 Sep 2023 11:44:05 GMT

Hi all,

I am trying to write a standalone python script that does something like this

arcpy.ChangeVersion_management('unnetworklayer','BRANCH', version_name, '#', 'INCLUDE')
arcpy.ValidateNetworkTopology_un('unnetworklayer', 'DEFAULT')

The documentation says both these tools accept a "Utility Network Layer" as input. But how can I make one? I have tried MakeFeatureLayer etc.

Re: Using python to Validate Network Topology in a version

RobertKrisher — Mon, 18 Sep 2023 15:08:16 GMT

You should be able to pass in the URL to the feature service and layer id of the utility network to get this information. However, for creating standalone Python scripts doing fine-grained operations against ArcGIS Enterprise my recommendation is to use the ArcGIS API for Python (read this article about pros/cons of different apis for more details).

One other important item to take into consideration, that the ArcGIS API for Python will give you but ArcPy won't, is that when you connect to a version and start making edits (or validating, reconciling, etc) you are potentially going to be competing with other users for locks. If another user is editing that version, your process will fail. If your process is running on a version than other users won't be able to edit it.

Re: Using python to Validate Network Topology in a version

jclarke — Tue, 19 Sep 2023 15:39:24 GMT

Thanks for the reply - I particularly like that pros and cons matrix in the link.

At this site many arcpy scripts are in use and not ArcGIS API for Python, so it would be great to get this script working, though its good to have that fall-back option of changing API. The edits are being applied beforehand via FME, and no-one else should be editing the version.

When using the URL to the UN layer with arcpy I cant see a way to to change version - the Validate call works on sde.default.

Re: Using python to Validate Network Topology in a version

RobertKrisher — Wed, 20 Sep 2023 15:41:35 GMT

I've been out this week so haven't had a chance to test this on my end, but are you saying if you run a standalone python script that does the following:

Create Layer (using feature service URL and giving it some unique layer name)
Change version (on layer)
Validate topology (on layer)

You are seeing that it is still only validating default? If you're performing this test in ArcGIS Pro you should make sure that the layer name you are using is unique. I can tell you that the ArcGIS API for Python does support all this.

Re: Using python to Validate Network Topology in a version

jclarke — Thu, 21 Sep 2023 16:25:02 GMT

Hi Robert - re these three steps - I cant get those to run without error

Create Layer (using feature service URL and giving it some unique layer name)
Change version (on layer)
Validate topology (on layer)

I think its the "Create Layer" step I am stuck on - its MakeFeatureLayer I am using for this, but ValidateNetworkTopology needs a Utility Network layer, not a feature layer, and so errors.

Re: Using python to Validate Network Topology in a version

RobertKrisher — Mon, 25 Sep 2023 19:09:40 GMT

The correct approach for what you want to do is to use the ArcGIS API for Python. I was able to get around some of this by saving an existing utility network layer to a file, then opening it as a layer file, accessing the first layer in the file. But I ran into problems in getting the rest the tools to behave properly, especially since they don't get me the ability to set/clear locks as I discussed above.

Re: Using python to Validate Network Topology in a version

jclarke — Tue, 26 Sep 2023 14:55:54 GMT

Thanks for your help Robert!

Re: Using python to Validate Network Topology in a version

KevinPiraino2 — Mon, 23 Sep 2024 13:44:32 GMT

I am trying to automate some of the UN admin tasks using the Python API, but I am struggling a bit with this task, namely creating the UN object (and hitting the default version). Have either of @jclarke or @RobertKrisher had any success in developing this script? Below is what I have so far.

import arcgis from arcgis.gis import GIS gis = GIS('https://myorg.gov/portal/','username', 'password') #utility network URL util_url = 'https://myorg.gov/un_fabric/rest/services/Utility_Network/Water_Distribution_Source/UtilityNetworkServer' network_url = 'https://myorg.gov/un_fabric/rest/services/Utility_Network/Water_Distribution_Source/FeatureServer/9' UN_url = 'https://myorg.gov/un_fabric/rest/services/Utility_Network/Water_Distribution_Source/FeatureServer' UN_vers = 'https://myorg.gov/un_fabric/rest/services/Utility_Network/Water_Distribution_Source/VersionManagementServer' #-------------------------------------------------------- UN_flc = arcgis.features.layer.FeatureLayerCollection(UN_url,gis) vms_from_flc = UN_flc.versions default_version = vms_from_flc.all[0] default_guid = default_version.properties.versionGuid #--------------------------------------------------------- #returns error "AttributeError: 'PropertyMap' instance has no attribute 'versionName'" df_version = arcgis.features._version.Version(url=UN_url,flc=UN_flc,gis=gis,session_guid=default_guid) UN = arcgis.features._utility.UtilityNetworkManager(url=util_url,version=default_version,gis=gis) envelope = { "xmin": 1018472.222250, "ymin": 1819952.386750, "xmax": 1105416.666750, "ymax": 1940603.168750, "spatialReference": { "wkid": 3435, "latestWkid": 102671 } } #returns error "Exception: Unable to resume a service session." UN.validate_topology(envelope) #returns error "Exception: Unable to resume a service session." UN.update_subnetwork('Water','Water System',all_subnetwork_tier=True,continue_on_failure=True) UN.update_is_connected()

Re: Using python to Validate Network Topology in a version

RobertKrisher — Mon, 23 Sep 2024 13:54:31 GMT

It seems a little like cheating, but my preferred way to get a UN pointed as a specific version is to get it from the version itself. there is a "utility" property on each version that contains a reference to the utility network for that version (if one is present in the service).

Re: Using python to Validate Network Topology in a version

KevinPiraino2 — Mon, 23 Sep 2024 13:58:26 GMT

I think my issue currently is that I am unable to instantiate the Version object using the provided UN information from earlier in the script. Every time I try to create the Version object, the script will create it, but when calling the Version object I get the following error:

"AttributeError: 'PropertyMap' instance has no attribute 'versionName'"

I also receive this same error when trying to access the utility property from the Version object.

Re: Using python to Validate Network Topology in a version

RobertKrisher — Mon, 23 Sep 2024 14:03:30 GMT

Instead of directly accessing the internal variable that holds the version manager (_version) you should go through the front door. Here is how I get the version manager, default version, and un object in most of my scripts:

# Get the version and Utility Network reference messages.addMessage(f"Connecting to {version_service_url}") version_manager = VersionManager(version_service_url, gis=gis, flc=feature_layer_collection) messages.addMessage(f"Connecting to version: {version_name}") default_version = version_manager.get(version_name) utility_network_manager = default_version .utility

Re: Using python to Validate Network Topology in a version

KevinPiraino2 — Mon, 23 Sep 2024 14:22:09 GMT

Unfortunately, I tried something similar when troubleshooting earlier and still was unsuccessful. In both my earlier attempts and using the code block you provided, I still received the following error:

Exception: Unable to resume a service session. (Error Code: 0)

Re: Using python to Validate Network Topology in a version

RobertKrisher — Mon, 23 Sep 2024 14:27:01 GMT

Before you start reading/writing data with the version, make sure you call either start_reading or start_editing to establish a shared or exclusive lock with the version. When your script finishes/cleans up make sure you stop reading/editing in order to release locks.

Re: Using python to Validate Network Topology in a version

KevinPiraino2 — Mon, 23 Sep 2024 14:42:31 GMT

Unfortunately, no I have a different error and I am unable to start an edit session using the start_editing() method (can start reading though). Maybe its something with my UN configuration or how I am trying to instantiate the VersionManager object.

Exception: The operation is not supported by this implementation. (Error Code: 0)

Re: Using python to Validate Network Topology in a version

RobertKrisher — Mon, 23 Sep 2024 15:00:23 GMT

Try just using start_reading

Re: Using python to Validate Network Topology in a version

KevinPiraino2 — Mon, 23 Sep 2024 15:37:15 GMT

That seemed to work at least for the "update is connected" and "update subnetwork" methods. The "validate topology" method still produced an error, but its unclear to me if that is an expected error if no recent edits were performed or any dirty areas are present in the UN.

Exception: A dirty area is not present within the validate network topology input extent. A validate network topology process did not occur. (Error Code: 0)

Re: Using python to Validate Network Topology in a version

RobertKrisher — Mon, 23 Sep 2024 15:42:18 GMT

That's the expected error you get when you try and validate without checking to see if there are dirty areas that need validating in the extent. You should check for dirty areas that need validating before calling that method. Just like you should check for dirty subnetworks before calling update subnetwork. Running update isconnected is not necessary if you run UpdateSubnetwork, since subnetworks manage the isconnected field.

Re: Using python to Validate Network Topology in a version

KevinPiraino2 — Mon, 23 Sep 2024 16:03:00 GMT

I appreciate all of the help you have provided, but I'm not sure how to go about querying for dirty areas. I am unable to find any Objects in the API documentation that that would grant that this capability. As far as I can tell there aren't any methods using the VersionManager, Version, or UtilityNetworkManager Objects that provides access to any properties related to dirty areas. Would you mind pointing me in the correct direction?

Re: Using python to Validate Network Topology in a version

RobertKrisher — Mon, 23 Sep 2024 16:12:43 GMT

It is a layer, like any other in your feature service. Look at your feature service, get its layer id, and use the query method to find dirty areas with a status value that indicates they need to be validated.

Re: Using python to Validate Network Topology in a version

BruceBacia — Mon, 09 Dec 2024 16:04:57 GMT

I'm running into the exact same error. Did you ever figure out what was causing it? My code:

service_script_version = version_manager.get(version_name) utility_network_manager = service_script_version.utility validation_envelope = {'xmin': 2944897.743461, 'ymin': 9969206.089036, 'xmax': 3210005.065902, 'ymax': 10211905.345106, 'spatialReference': {'wkid': 102739, 'latestWkid': 2277} } utility_network_manager.validate_topology(envelope=validation_envelope)

Exception: Unable to resume a service session. (Error Code: 0)