Skip to main content

Import Circuit Definitions (Utility Network Tools)

Summary

Imports circuit information from a series of .csv files into the circuit management tables of a telecom domain network.

The .csv files generated by the Export Circuit Definitions tool can be used as input to this tool. The imported .csv files will populate the Circuit, CircuitSection, and Subcircuits tables with information about the components that compose circuits in the telecom domain network.

Learn more about importing circuit definitions

Usage

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

  • The features listed in the input .csv files must exist in the utility network.

  • The Circuit, CircuitSection, and Subcircuits names must be unique in the telecom domain network and cannot exceed 124 characters.

  • Nonsectioned circuits can be imported and created without start and stop location information; however, the start or stop location for a nonsectioned circuit may not be empty if the corresponding start or stop location is populated.

  • 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.

  • The .csv files must contain the columns described in the following tables and conform to the specified format. Additional user-defined attribute fields can be imported when a field with a matching name exists in the target circuit management table.

    • Circuit table .csv columns

      Column

      Description

      Example

      CIRCUITNAME

      The name of the circuit that will be created. This must be unique in the telecom domain network.

      23/ABC/123456/789/ER/1

      STARTLOCATIONSOURCENAME

      The name of the feature or object class to which the starting point of the circuit applies. The name maps to the source ID for the class. The name is used when modeling a nonsectioned circuit with a single starting and stopping point. The name is NULL when the ISSECTIONED field value is TRUE.

      TelcoJunctionObject

      STARTLOCATIONID

      The global ID of the feature or object that is associated with the starting point in the circuit. This is used when modeling a nonsectioned circuit with a single starting and stopping point. This is NULL when the ISSECTIONED field value is TRUE.

      {4E0AAF9B-F37B-433A-AC3B-EA385DD0AD92}

      STARTLOCATIONFIRSTUNIT

      The first unit identifier in the range for the starting point of the circuit. This is used when modeling a nonsectioned circuit with a single starting and stopping point. This is NULL when the ISSECTIONED field value is TRUE.

      1

      STARTLOCATIONLASTUNIT

      The last unit identifier in the range for the starting point of the circuit. This is used when modeling a nonsectioned circuit with a single starting and stopping point. This is NULL when the ISSECTIONED field value is TRUE.

      12

      STOPLOCATIONSOURCENAME

      The name of the feature or object class used for the stopping point in the circuit. This is used when modeling a nonsectioned circuit with a single starting and stopping point. This is NULL when the ISSECTIONED field value is TRUE.

      TelcoJunctionObject

      STOPLOCATIONID

      The global ID of the feature or object that is associated with the stopping point in the circuit. This is used when modeling a nonsectioned circuit with a single starting and stopping point. This is NULL when the ISSECTIONED field value is TRUE.

      {1877F786-AD5A-4461-83C9-8A8B12479FF8}

      STOPLOCATIONFIRSTUNIT

      The first unit identifier in the range for the stopping point of the circuit. This is used when modeling a nonsectioned circuit with a single starting and stopping point. This is NULL when the ISSECTIONED field value is TRUE.

      1

      STOPLOCATIONLASTUNIT

      The last unit identifier in the range for the stopping point of the circuit. This is used when modeling a nonsectioned circuit with a single starting and stopping point. This is NULL when the ISSECTIONED field value is TRUE.

      5

      ISSECTIONED

      Specifies whether the circuit is modeled with sections.

      • True

      • False

      False

      CIRCUITTYPE

      Specifies whether the circuit is a physical or virtual circuit. A circuit is considered virtual when it contains one or more sections in which the SECTIONTYPE field value is Virtual.

      • Physical

      • Virtual

      Physical

      SECTIONORDER

      The logical connectivity graph between sections for a sectioned circuit as a string in JSON format.

      For example with a circuit consisting of three sections (1, 2, and 3), when section 1 is connected to section 2, and section 2 is connected to section 3, the section order would be represented as {"1":[2],"2":[3],"3":[]}. Using an example with a circuit that consists of four sections (1, 2, 3, and 4), when section 1 is connected to section 2 and section 4, and section 2 is connected to section 3, the section order would be represented as {"1":[2,4],"2":[3],"3":[]}.

      When no connection exists between sections, all sections of the circuit are interpreted as being arranged in parallel, which could also be represented as {"1":[],"2":[],"3":[]}.

      If no value is provided and the ISSECTIONED field value is TRUE, an empty pair of curly braces are stored in the field to indicate that section ordering has not been defined for the sectioned circuit. This is NULL when the ISSECTIONED field value is FALSE.

      {"1":[2,4],"2":[3],"3":[]}

      GLOBALID

      The optional global ID for the circuit. A user supplied GUID can be provided to serve as the circuit's global ID. This GUID must be unique in the telecom domain network. When this field is empty, a global ID is created for the circuit.

      {6EBDCABE-571F-4DB0-AE01-4FDC81EBAE61}

    • CircuitSection table .csv columns

      Column

      Description

      Example

      CIRCUITNAME

      The name of the circuit to which the section applies.

      34/DEF/789123/456/ER/1

      STARTLOCATIONSOURCENAME

      The name of the feature or object class to which the starting point for the section record applies. This maps to the source ID for the class.

      TelcoJunctionObject

      STARTLOCATIONID

      The global ID of the feature or object that is associated with the starting point. When the circuit section is associated with a subcircuit, this should reference the global ID of the subcircuit.

      {939164F0-0EAA-4010-998F-64FAE34CA469}

      STARTLOCATIONFIRSTUNIT

      The first unit identifier in the range for the section's starting point. This is NULL when the circuit section is associated with a subcircuit.

      1

      STARTLOCATIONLASTUNIT

      The last unit identifier in the range for the section's starting point. This is NULL when the circuit section is associated with a subcircuit.

      6

      STOPLOCATIONSOURCENAME

      The name of the feature or object class used for the stopping point in the section. This maps to the source ID for the class. This is NULL when the circuit section is associated with a subcircuit.

      TelcoJunctionObject

      STOPLOCATIONID

      The global ID of the feature or object that is associated with the stopping point in the section. This is NULL when the circuit section is associated with a subcircuit.

      {33C63920-0057-44AC-AE69-8D841C6CEA2A}

      STOPLOCATIONFIRSTUNIT

      The first unit identifier in the range for the section's stopping point. This is NULL when the circuit section is associated with a subcircuit.

      2

      STOPLOCATIONLASTUNIT

      The last unit identifier in the range for the section's stopping point. This is NULL when the circuit section is associated with a subcircuit.

      5

      ROLE

      Specifies the role of the section record in the circuit. This is used to identify the start, end, and midspan sections of a circuit.

      This uses a system-maintained coded-value domain as follows:

      • Start and End

      • Start

      • End

      • Midspan

      Start and End

      SECTIONTYPE

      Specifies whether the circuit section is physical or virtual.

      • Physical

      • Virtual

      Virtual

      GLOBALID

      The optional global ID for the circuit section. A user supplied GUID can be provided to serve as the circuit section's global ID. This GUID must be unique in the telecom domain network. When this field is empty, a global ID is created for the section.

      {B3D62897-D2FF-40DD-8B23-10C9D6D4EAF4}

    • Subcircuit table .csv columns

      Column

      Description

      Example

      SUBCIRCUITNAME

      The name of the subcircuit that will be created. This must be unique in the circuit.

      32/SUB/012345/ER/15

      PROVIDERNAME

      The name of the circuit in which the subcircuit participates.

      34/DEF/789123/456/ER/2

      GLOBALID

      The optional global ID for the subcircuit. A user supplied GUID can be provided to serve as the subcircuit's global ID. This GUID must be unique in the telecom domain network. When this field is empty, a global ID is created for the subcircuit.

      {E35BFF25-3DCD-4951-AD73-10C1A02CB7F6}

Parameters

Label Explanation Data type

Input Utility Network

The utility network to which the circuit definitions will be imported.

Utility Network; Utility Network Layer

Domain Network

The telecom domain network to which the circuit definitions will be imported.

String

Input Circuits File (.csv)

(Optional)

The .csv file containing the circuit definitions that will be imported.

File

Input Circuit Sections File (.csv)

(Optional)

The .csv file containing the circuit section definitions that will be imported.

File

Input Subcircuits File (.csv)

(Optional)

The .csv file containing the subcircuit definitions that will be imported.

File

Derived output

Label Explanation Data type

Output Utility Network

The updated utility network.

Utility Network

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • Standard: Yes
  • Advanced: Yes