ExportUtilityNetworkMatrix

Title  Export Matrix

Description

Creates Excel workbooks for visualizing and modifying Utility Network rules, categories, association roles, and terminal assignments.

Usage

          
Use this tool along with ImportUtilityNetworkMatrix to modify properties in bulk.
For additional information, see the help page on GitHub.


License
Standard
Toolset
Matrix

Syntax

ExportUtilityNetworkMatrix (network, workbook, matrix_options)

Parameter Explanation Data Type
network Dialog Reference

The utility network or asset package.

 		GPComposite
workbook Dialog Reference

The output workbook to create.

 		DEFile
matrix_options Dialog Reference

The properties to create.

 		GPString

Code Samples

ExportUtilityNetworkMatrix example 1 (Python window) 

Creates rule matrix from an asset package.

import arcpy

arcpy.udms.ExportUtilityNetworkMatrix("D:/data/asset_package.gdb", "D:/data/rule.xlsx", "RULES")

ExportUtilityNetworkMatrix example 2 (stand-alone script) 

Exports rules, categories, roles, and terminals from a UN to Excel workbook.

import arcpy

un = "D:/data/network.gdb/UtilityNetwork/Network"
output = "D:/data/matrix.xlsx"
choices = [
    "ASSOCIATION_ROLES",
    "CATEGORIES",
    "TERMINALS",
    "RULES",
]

arcpy.udms.ExportUtilityNetworkMatrix(
    network=un,
    workbook=output,
    matrix_options=choices,
)