Every domain network consists of a set of feature classes and tables with a fixed schema. When you use the Add Telecom Domain Network tool to create the telecom domain network, three additional tables (Circuit, CircuitSection, and Subcircuit) are created to support circuit management in your network.
These system-maintained tables are read-only; however, user-defined fields can be added for attribution..
The Circuit table stores information about the circuits in a telecom domain network. Each row represents a circuit and contains information about the sections that define it, when present.
The CircuitSection table stores information about the sections which define the circuits. Sections represent a collection of elements obtained through a single trace. A section can have multiple records in the table where each row represents a location (starting point, stopping point, barrier, or subcircuit) used in the section. Each section in the table must have one or more starting and stopping points.
The Subcircuit table stores information about circuit subdivisions (subcircuits) which share the capacity or bandwidth of a circuit.
Information in the circuit management tables is updated when importing circuit components, when a circuit is verified, when the topology is enabled or validated, and when changes are made to a circuit. As with the other classes in your utility network, the circuit management tables are editor tracking enabled. When working in an enterprise deployment, they are also branch versioned.
The circuit management tables are added to the map with the utility network layer and can be found in the Contents pane for the active map.
Note:
Circuit management tables are only included in the schema for utility networks which contain a telecom domain network.
Circuit table
The Circuit table stores information about the following:
- The name of a circuit.
- The circuit status (Clean, Dirty, or Invalid).
- Whether the circuit has been deleted (is deleted= true).
- The last time information about a circuit was verified or exported.
- When no sections are present (non-sectioned circuits), the starting and stopping points which define the circuit are modeled using a single record in the table.
- When sections are present, information about section ordering which defines the logical connectivity between sections in a circuit.
The Circuit table has the following attributes:
| Field name | Field alias | Description |
|---|---|---|
| OBJECTID | Object ID | The object ID for the record in the table. |
| NAME | Name | The name of the circuit. |
| SECTIONORDER | Section order | Stores the logical connectivity graph between sections from the CircuitSection table as a string. When no connection exists between sections, all sections of the circuit are interpreted as being arranged in parallel with a Role attribute value of Start and end. Beta:The Section order field is provided to support future work and is not currently in use. |
| STATUS | Status | Indicates whether the circuit is clean, dirty, or invalid. |
| ISDELETED | Is deleted | Indicates whether the circuit has been marked as logically deleted. True means the circuit has been logically deleted while false means it remains as a circuit in the telecom domain network. The Export Circuits tool is used to delete the record or records from the table when Is deleted = True and the Set export acknowledged parameter is checked. |
| LASTVERIFIED | Last verified | The last time the circuit in the table was verified using the verify operation or Verify Circuits tool. |
| LASTEXPORTED | Last exported | The last time the circuit in the table was exported using the Export Circuits tool. |
| STARTPOINTSOURCEID | Start point source ID | The source ID of the feature or object that is associated with the starting point for the circuit. This is used when modeling a non-sectioned circuit with a single starting and stopping point. This is set to Unknown when Is sectioned is True. The default is NULL. |
| STARTPOINTID | Start point ID | The global ID of the feature or object that is associated with the starting point for the circuit. This is used when modeling a non-sectioned circuit with a single starting and stopping point. This NULL when Is sectioned is True. The default is NULL. |
| STARTPOINTTERMINALID | Start point terminal ID | The terminal ID of the feature or object that is associated with the starting point in the circuit. This is used when modeling a non-sectioned circuit with a single starting and stopping point. This is NULL when Is sectioned is True. The default is NULL. |
| STARTPOINTFIRSTUNIT | Start point first unit | The first unit of the group associated with the starting point (for example, equipment unit ID). This is used when modeling a non-sectioned circuit with a single starting and stopping point. This is NULL when Is sectioned is True. The default is NULL. |
| STARTPOINTNUMUNITS | Start point number of units | Number of units in the group at the starting point (that is, the number of fiber strands that are grouped in the edge object). This is used when modeling a non-sectioned circuit with a single starting and stopping point. This is NULL when Is sectioned is True. The default is NULL. |
| STOPPOINTSOURCEID | Stop point source ID | The source ID of the feature or object that is associated with the stopping point for the circuit. This is used when modeling a non-sectioned circuit with a single starting and stopping point. This is NULL when Is sectioned is True. The default is NULL. |
| STOPPOINTID | Stop point ID | The global ID of the feature or object that is associated with the stopping point for the circuit. This is used when modeling a non-sectioned circuit with a single starting and stopping point. This is NULL when Is sectioned is True. The default is NULL. |
| STOPPOINTTERMINALID | Stop point terminal ID | The terminal ID of the feature or object that is associated with the stopping point in the circuit. This is used when modeling a non-sectioned circuit with a single starting and stopping point. This is NULL when Is sectioned is True. The default is NULL. |
| STOPPOINTFIRSTUNIT | Stop point first unit | The first unit of the group associated with the stopping point (for example, equipment unit ID). This is used when modeling a non-sectioned circuit with a single starting and stopping point. This is NULL when Is sectioned is True. The default is NULL. |
| STOPPOINTNUMUNITS | Stop point number of units | Number of units in the group at the stopping point (that is, the number of fiber strands that are grouped in the edge object). This is used when modeling a non-sectioned circuit with a single starting and stopping point. This is NULL when Is sectioned is True. The default is NULL. |
| ISSECTIONED | Is sectioned | Specifies whether the circuit is modeled with or without sections (in other words, is it a non-sectioned (simple) circuit with a single starting point and single stopping point?). The default is False. |
| CIRCUITTYPE | Circuit type | Indicates whether the circuit is a physical or virtual circuit. A circuit is considered virtual when it contains one or more sections where the Section type is Virtual. The default is Physical. |
| ROOTCONTAINERSTATE | Root container state | Used to identify whether the circuit or its related sections or subcircuits have changed since the last reconcile operation. All circuits are root containers. |
| GLOBALID | Global ID | The global ID of the row in the table. This value is referenced by the Circuit Section and Subcircuit tables as the Circuit ID where applicable. |
You can add more fields to the Circuit table to communicate additional information about the circuit, such as ownership. These fields are editable and can be updated when you create or modify a circuit.
CircuitSection table
The CircuitSection table stores information about the following:
- The information that composes a section in a circuit.
- The relationship with the circuit in which the section record participates.
- Information about the features or objects that define the section record.
The CircuitSection table has the following attributes:
| Field name | Field alias | Description |
|---|---|---|
| OBJECTID | Object ID | The object ID for the record in the table. |
| CIRCUITID | Circuit ID | The global ID of the circuit in which the section participates. Tip:The CircuitSection table can be ordered by the Circuit ID field to group all sections belonging to a single circuit. |
| SECTIONID | Section ID | The ID for the section in the circuit. |
| STARTPOINTSOURCEID | Start point source ID | The source ID of the feature or object that is associated with the starting point for the circuit section. When the circuit section is associated with a subcircuit, this references the Subcircuit table alias. The default is NULL. |
| STARTPOINTID | Start point ID | The global ID of the feature or object that is associated with the starting point for the circuit section. When the circuit section is associated with a subcircuit, this references the global ID of the subcircuit. The default is NULL. |
| STARTPOINTTERMINALID | Start point terminal ID | The terminal ID of the feature or object that is associated with the starting point in the circuit section. When the circuit section is associated with a subcircuit the value is -1. The default is NULL. |
| STARTPOINTFIRSTUNIT | Start point first unit | The first unit of the group associated with the starting point (for example, equipment unit ID) in the circuit section. When the circuit section is associated with a subcircuit the value is -1. The default is NULL. |
| STARTPOINTNUMUNITS | Start point number of units | Number of units in the group at the starting point (that is, the number of fiber strands that are grouped in the edge object) for the circuit section. When the circuit section is associated with a subcircuit the value is -1. The default is NULL. |
| STOPPOINTSOURCEID | Stop point source ID | The source ID of the feature or object that is associated with the stopping point for the circuit section. When the circuit section is associated with a subcircuit the value is NULL. The default is NULL. |
| STOPPOINTID | Stop point ID | The global ID of the feature or object that is associated with the stopping point for the circuit section. When the circuit section is associated with a subcircuit the value is -1. The default is NULL. |
| STOPPOINTTERMINALID | Stop point terminal ID | The terminal ID of the feature or object that is associated with the stopping point in the circuit section. When the circuit section is associated with a subcircuit the value is -1. The default is NULL. |
| STOPPOINTFIRSTUNIT | Stop point first unit | The first unit of the group associated with the stopping point (for example, equipment unit ID) in the circuit section. When the circuit section is associated with a subcircuit the value is -1. The default is NULL. |
| STOPPOINTNUMUNITS | Stop point number of units | Number of units in the group at the stopping point (that is, the number of fiber strands that are grouped in the edge object) for the circuit section. When the circuit section is associated with a subcircuit the value is -1. The default is NULL. |
| ROLE | Role | The role of the record in the circuit. This is used to identify the start, end, and midspan sections of a circuit. This system-maintained field is derived from the Section order field on the Circuit table. The default is Start and End. The values are as follows:
Beta:The Section order field on the Circuit table is provided to support future work and is not currently in use. This field can be used to manually specify a section's role and the ordering of sections. |
| SECTIONTYPE | Section type | Indicates whether the circuit section is physical or virtual. The default is Physical. |
| GLOBALID | Global ID | The global ID of the row in the table. |
Subcircuit table
The Subcircuit table stores information about the following:
- The name of the subcircuit.
- The name of the (provider) circuit in which the subcircuit participates.
- The name of the circuit which consumes the subcircuit.
The Subcircuit table has the following attributes:
| Field name | Field alias | Description |
|---|---|---|
| OBJECTID | Object ID | The object ID for the record in the table. |
| NAME | Name | The name of the subcircuit |
| PROVIDERID | Provider ID | The global ID of the circuit in the Circuit table in which the subcircuit participates. |
| CONSUMERID | Consumer ID | The global ID of the circuit in the Circuit table that consumes the subcircuit. |
| GLOBALID | Global ID | The global ID of the row in the table. |