Skip to main content

Export Circuit Definitions (Utility Network Tools)

Summary

Exports the contents of the circuit management tables from a telecom domain network for the specified component type. The data is saved as .csv files in a specified output folder.

The output .csv files are derived from the Circuit, CircuitSection, and Subcircuit tables. These circuit management tables allow you to model and manage a collection of components that represent a dedicated path between elements in the network. The .csv files can be used as inputs to the Import Circuit Definitions tool.

Learn more about exporting circuit definitions

Usage

  • The Input Utility Network parameter must reference a utility network that contains a telecom domain network.

  • The folder specified for the Output Folder parameter must already exist.

  • Circuit definition information is output to three tables in the specified output folder as follows:

    • The tables are created in the specified output folder using the following convention:

      • <domain network name>_Circuit_<timestamp>.csv

      • <domain network name>_CircuitSection_<timestamp>.csv

      • <domain network name>_Subcircuit_<timestamp>.csv

    • The files created by the tool are dependent on the Component Type parameter value. The default is All.

  • The following tables describe the schema of the output .csv files. Any user-defined attribute fields are included in the schema for each output file:

    • Circuit table

      • CIRCUITNAME, STARTLOCATIONSOURCENAME, STARTLOCATIONID, STARTLOCATIONFIRSTUNIT, STARTLOCATIONLASTUNIT, STOPLOCATIONSOURCENAME, STOPLOCATIONID, STOPLOCATIONFIRSTUNIT, STOPLOCATIONLASTUNIT, ISSECTIONED, CIRCUITTYPE, SECTIONORDER, GLOBALID

    • CircuitSection table

      • CIRCUITNAME, STARTLOCATIONSOURCENAME, STARTLOCATIONID, STARTLOCATIONFIRSTUNIT, STARTLOCATIONLASTUNIT, STOPLOCATIONSOURCENAME, STOPLOCATIONID, STOPLOCATIONFIRSTUNIT, STOPLOCATIONLASTUNIT, ROLE, SECTIONTYPE, GLOBALID

    • Subcircuit table

      • SUBCIRCUITNAME, PROVIDERNAME, GLOBALID

  • The following requirements must be met when working with an enterprise geodatabase:

    • When working with an enterprise geodatabase, the Input Utility Network parameter value must be from a database connection established as the database utility network owner.

    • License:

      The active portal account must be assigned a license with the ArcGIS Advanced Editing user type extension to use this tool in an enterprise deployment.

Parameters

Label Explanation Data type

Input Utility Network

The utility network that contains the circuit definitions that will be exported.

Utility Network; Utility Network Layer

Domain Network

The telecom domain network that contains the circuit definitions that will be exported.

String

Component Type

Specifies the circuit definition information that will be exported.

  • All—Circuit definition information from all tables will be exported. This is the default.

  • Circuit—Circuit definition information from the Circuit table will be exported.

  • Circuit Section—Circuit definition information from the CircuitSection table will be exported.

  • Subcircuit—Circuit definition information from the Subcircuit table will be exported.

String

Output Folder

The name and location of the output folder that will store the .csv file or files created for the exported circuit definitions.

Folder

Derived output

Label Explanation Data type

Exported Circuit CSV

The output .csv file containing the circuit definitions.

String

Exported Circuit Section CSV

The output .csv file containing the circuit section definitions.

String

Exported Subcircuit CSV

The output .csv file containing the subcircuit definitions.

String

Environments

This tool does not use any geoprocessing environments.

Licensing information

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