Utility Network properties extractor

6914
15
05-11-2021 09:09 AM
MichaelHirschheimer
Esri Contributor
12 15 6,914

June 2023:

The June 2023 release of the “Utility Network Properties Extractor” Add-in has been deployed to Esri GitHub.  The Master (3.1) and 2.9 branches have been updated with the same functionality.

What's new:

  1. Map Field Settings CSV now contains an editable column to “Reorder fields in a Web Map”.  This applies to both layers and tables
  2. Import Field Settings button will reorder the fields in the Web Map based on the CSV file
  3. Additional attributes added to the UN Featureservice CSV, including Sync capabilities
  4. Labeling range column added to the Layer Scales CSV
  5. The path to the CSV file location now includes a folder for the current map

Please use the Github link at the bottom of this blog to access the updated source code.  

============================================================

February 2023:  

In accordance with the Network Management Release Plan, the source code for a 3.1 compliant version of the Utility Network Properties Extractor Add-in has been uploaded to GitHub. 

The Master branch contains the latest code.   Branch, 2.9, was created to support those users who aren't ready to upgrade to the latest release.

Please use the Github link at the bottom of this blog to access the updated source code.

============================================================

May 2022:  New functionality has been added to the Utility Network properties extractor add-in.  

Toolbar.PNG

What's new:

  • 3 new extractor buttons that generate reports for the UN Featureservice, Layer Scales and Layer Counts
  • A new efficiency tool that displays machine info (O/S, CPU, memory, etc) and also copies that information to the clipboard
  • Additional attributes added to many of the original reports

Please use the Github link at the bottom of this blog to access the updated source code.  

============================================================

Original post from 2021:

If you are interested in extracting ArcGIS Utility Network, Geodatabase or Map properties to CSV files, the source code for a new ArcGIS Pro SDK add-in is available on Esri GitHub.   Once these properties are in Excel, filtering capabilities can be used to quickly get answers to these types of questions:

  1. Which network rules are defined for a specific Asset Group and Asset Type?
  2. Are database field names and aliases assigned consistently across multiple featureclasses?
  3. Which features are assigned to a network category? 

MichaelHirschheimer_1-1620654500401.png

You can absolutely get these answers from within ArcGIS Pro but the information is spread across many panes and it is time consuming to retrieve all of it.   The Add-in contains 21 extractor buttons that generate individual CSVs into a single folder.  There is even an “Extract All” button.

The Add-in also contains 3 efficiency tools that help setup the map.  As an example, the “Set Containment Display Filters” button will define the Display Filter on the appropriate layers with the correct SQL query. 

The Add-in is domain network agnostic.  It doesn’t matter if the Utility Network is Electric, Gas, Communications, District Heating & Cooling, Water, Sewer, or others.  The add-in determines if the map contains a Utility Network and then enables or disables buttons.

Note:  The code was written against ArcGIS Pro 2.7.   If you are using a version earlier then 2.8, you may need to comment out some sections of code.

The effort to manage a Utility Network, Geodatabase and its Maps is large.  The Add-in was written with efficiency in mind.  Get the information into CSVs and use filtering capabilities in Excel to find the answer.

https://github.com/Esri/utility-network-properties-extractor

 

 

15 Comments
MikeGoggin
New Contributor II

This is a really nice tool @MichaelHirschheimer , already seeing benefits.  Thank you for sharing.

MichaelHirschheimer
Esri Contributor

Thanks @MikeGoggin.  Glad to hear you are finding value with the Add-In!

TedCronin
MVP Honored Contributor

Is there a downloadable location for the add-in or only the source that we need to build from?

MichaelHirschheimer
Esri Contributor

@TedCronin:  Just download the source code from the GitHub Repo and compile it.  

 

CarlSunderman
Occasional Contributor

Fails to build

CS0246 CIMFeaureTemplate

CS0246 CIMFeaureTemplate

CS0234 NetworkDiagrams doesn't exist in namespace

MichaelHirschheimer
Esri Contributor

Hi @CarlSunderman:  Which version of the ProSDK are you using?

 

gpgisandsky
Occasional Contributor

Which version of ArcGIS Pro this add-in support now? May I install on ArcGIS Pro 2.9?

MichaelHirschheimer
Esri Contributor

@gpgisandsky   Yes, the Add-in will install on a ArcGIS Pro 2.9 machine.

I will be following the Network Management Release plan, so there won't be a 3.x compliant Add-in until the next Pro version is designated.

gpgisandsky
Occasional Contributor

Thank you Michael

 

ThijsBriggeman_Tensing
New Contributor III

Nevermind! This reply can be deleted.

shamsalden
New Contributor II

what are the steps to install it with arcgis pro ?

MichaelHirschheimer
Esri Contributor

Hi @shamsalden,

When you compile the code with Visual Studio, it will be automatically be installed on that machine. No additional steps are needed.

If you are distributing the compiled Add-in to others in your organization, follow these directions: https://pro.arcgis.com/en/pro-app/2.9/get-started/manage-add-ins.htm

APurviance
New Contributor

Thank you for this tool, it is awesome! But, for some reason, I am not able to extract Contingent Values. I have tried the Extract All and the Contingent Values, each, no results. Any Ideas? When I ran the Contingent Values, a window did come up showing export to the folder sub of ProSdk_CSV, but nothing actually gets exported. I am on 2.9.10.

The Extract All yielded the below outputs:

APurviance_0-1707946827268.png

 

MichaelHirschheimer
Esri Contributor

Hi @APurviance,

The Contingent Values and Attribute Rules buttons will only generate CSVs if the layers/tables in the map are from a database connection (file, enterprise, mobile).  

The Contingent Values button calls GP Tool, Export Contingent Values.  The error in screenshot is when the "target table" is from a featureservice. 

MichaelHirschheimer_0-1708049175554.png

The Attribute Rules button calls GP Tool, Export Attribute Rules.  The following error message is raised when the input table is from a Featureservice.

MichaelHirschheimer_1-1708049449419.png

 

Hope this helps,

Mike

 

 

APurviance
New Contributor

@MichaelHirschheimer , Hi Michael, thank you for the quick response, I appreciate it!