ArcFM Desktop Developer Guide
SynerGEE Supported Attributes
Automatic Attributes are listed at the bottom of this page.
SynerGEE supports certain settings for each network feature loaded to an analysis study. The following tables show the tables and attributes that can be imported by the Electric Solver API if they are included in the XML document.
 |
If you change the spelling of any of the Attribute Names listed below, you must also modify the XML. |
If the attribute is not exported from the geodatabase or provided by the Implementation, the Electric Solver API will use the default values shown in the Supported Attributes table. However, the attributes with names in bold must be included in the XML for the Electric Solver API to correctly load data.
The Electric Solver API supports the following domain values for the attributes in the tables listed below.
|
Domain |
ArcGIS Electric Domain Based On |
Supported Values |
|
Phase Designation |
Phase Designation |
1 = C; 2 = B; 3 = BC, 4 = A, 5 = AC, 6 = AB, 7 = ABC |
|
*Source Operating Voltage |
Bus Bar Nominal Voltage |
120 = 4.16, 160 = 7.2, 210 = 12.5, 230 = 13.2, 270 = 13.8, 340 = 24.9, 380 = 34.5, 80 = 2.4, 110 = 4.16, 150 = 7.2, 260 = 13.8 |
|
Source Config |
Circuit Source Connection Configuration |
D = delta, Y = wye, S = wyegnd |
|
DPD |
Subtype |
1,2 = Breaker; 3,4,5,6,7 = Recloser; 8,9,10,11 = Sectionalizer |
|
Status |
Normal Status |
0 = off, 1 = on |
|
Yes/No |
Yes/No indicator |
Y = yes, N = no |
|
Regulator Config |
Voltage Regulator Bank Connection Configuration |
D = delta; L = delta; S = wyegnd; O = opendeltaAB, opendeltaAC, or opendeltaBC; Y = wye |
|
PFCorrecting |
Subtype |
1, 2 = Capacitor Bank |
|
Capacitor Control |
Subtype |
0 = manual, 1 = current, 2 = kvar, 4 = time, 5 = voltage no LDC |
Junctions (required by Electric Solver API for results display at junctions)
The Electric Solver API can return results for any feature that acts as a junction in the feeder, even if this feature does not map to a device in the Solver. For a complex edge network, the implementer should include junction features in the network XML for results to be displayed at the downstream end of each edge.
Conductor (PriOHElectricLineSegment, PriUGElectricLineSegment, and BusBar)
|
Attribute |
Solver Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
PhaseDesignation |
phPhasing |
PhaseDesignation domain |
|
|
Length |
Length to use instead of geometric length (use LengthSource property when exporting) |
numeric |
geometric length |
|
EquipType |
sPhaseConductor |
text |
336 ACSR |
|
EquipTypeNeutral |
sNeutralConductor, phPhasing.bNeutral |
text |
same as sPhaseConductor |
|
PPSpacingMUL |
dPPSpacingmUL |
numeric |
|
|
PNSpacingMUL |
dPNSpacingMUL |
numeric |
|
|
HeightMUL |
dHeightMUL |
numeric |
|
ConductorInfo (related table for Conductor)
|
Attribute |
Solver Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
PhaseDesignation |
phPhasing |
PhaseDesignation domain |
|
|
EquipType |
sPhaseConductor |
text |
336 ACSR |
|
ConductorMaterial |
ConductorType |
text |
|
|
ConductorSize |
ConductorType |
text |
|
Transformer (step)
|
Attribute |
Solver Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
EquipType |
sType |
text |
1200LB 34.5 |
|
HighSideConfiguration |
eHighConnection |
text |
Unkown |
|
LowSideConfiguration |
eLowConnection |
text |
Unkown |
DynamicProtectiveDevice (CircuitBreaker, Recloser, and Sectionalizer)
The Phase Designation of a dynamic protective device is not forced to match the line to which it is attached. For example, a single phase device on a three-phase conductor will retain its single phase designation instead of being converted to ABC.
|
Attribute |
Solver Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
SubtypeCD |
No corresponding property |
|
|
|
PhaseDesignation |
phConnected |
|
|
|
NormalPosition_A |
bIsOpen |
|
|
|
NormalPosition_B |
bIsOpen |
|
|
|
NormalPosition_C |
bIsOpen |
|
|
|
MaxContinuousCurrent |
dAmpRating (breaker and interrupter) |
numeric |
|
|
MaxContinuousCurrent |
dActuatingAmps (sectionalizer) |
numeric |
|
|
MaxContinuousCurrent |
sAmpOrCoilRating (reclosers) |
numeric |
|
|
MaxInterruptingCurrent |
dInterruptRating (breaker and interrupter) |
numeric |
|
|
MaxInterruptingCurrent |
dInterruptAmpRating (recloser) |
numeric |
|
|
GroundFastCount |
GroundUnit.FastCount (recloser) |
numeric |
|
|
GroundSlowCount |
GroundUnit.SlowCount (recloser) |
numeric |
|
|
GroundFastCurve |
GroundUnit.FastCurve (recloser) |
text |
|
|
GroundSlowCurve |
GroundUnit.SlowCurve (recloser) |
text |
|
|
PhaseFastCount |
PhaseUnit.FastCount (recloser) |
numeric |
|
|
PhaseSlowCount |
PhaseUnit.SlowCount (recloser) |
numeric |
|
|
PhaseFastCurve |
PhaseUnit.FastCurve (recloser) |
text |
|
|
PhaseSlowCurve |
PhaseUnit.SlowCurve (recloser) |
text |
|
|
Model |
sModel |
text |
|
|
Manufacturer |
sManufacturer |
text |
|
RecloserUnit (related table for Dynamic Protective Device)
|
Attribute |
Solver Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
‡ Manufacturer |
Recloser.sManufacturer |
text |
|
|
‡ Model |
Recloser.SModel |
text |
|
‡ These unit attributes are only used if the parent bank object does not provide them.
CircuitSource (related table for CircuitBreaker)
|
Attribute |
Solver Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
ID |
sName of Feeder |
text |
|
|
SubstationID |
sSubstation of Feeder |
text |
|
|
*OperatingVoltage |
dNomKvLL |
SourceOperatingVoltage domain |
|
|
Connection Configuration |
eConnectionType |
SourceConfig domain |
|
|
UseByPhaseVoltLevel |
bUseByPhaseVoltLevel |
Yes/No domain |
|
|
Volts |
dVolts |
numeric |
|
Fuse
|
Attribute |
Solver Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
PhaseDesignation |
phConnected |
PhaseDesignation domain |
|
|
NormalPosition_A |
bIsOpen |
Status domain |
|
|
NormalPosition_B |
bIsOpen |
Status domain |
|
|
NormalPosition_C |
bIsOpen |
Status domain |
|
|
Model |
sModel |
text |
|
|
Manufacturer |
sManufacturer |
text |
|
FuseUnit (related table for Fuse)
|
Attribute |
Solver Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
PhaseDesignation |
phConnected |
PhaseDesignation domain |
|
|
LinkRating |
sAmpRating |
numeric |
|
|
‡ Model |
sModel |
|
|
|
‡ Manufacturer |
sManufacturer |
|
|
‡ These unit attributes are only used if the parent bank object does not provide them.
Switch or OpenPoint
|
Attribute |
Solver Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
PhaseDesignation |
No corresponding property |
PhaseDesignation domain |
|
|
NormalPosition_A |
bIsOpen |
Status domain |
|
|
NormalPosition_B |
bIsOpen |
Status domain |
|
|
NormalPosition_C |
bIsOpen |
Status domain |
|
|
EquipType |
sType |
text |
1200LB 34.5 |
|
ManuallyOperated |
bIsAutomaticSwitch |
Yes/No domain |
|
Voltage Regulator
|
Attribute |
Solver Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
PhaseDesignation |
phActivePhases |
PhaseDesignation domain |
|
|
PhaseDesignation |
eGangMeterPhase |
PhaseDesignation domain |
|
|
HighSideConfiguration |
eConnection |
RegulatorConfig domain |
|
|
EquipType |
sType |
text |
|
|
InManualMode |
bInManualMode |
Yes/No domain |
|
|
IsGangOperated |
bIsGangOperated |
Yes/No domain |
|
VoltageRegulatorUnit (related table for Voltage Regulator)
No additional attributes supported at this time, but export the related object to get RegulatorControl related objects.
RegulatorControl (related table for Voltage Regulator Unit)
|
Attribute |
Solver Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
VoltageSetting_A |
ForwardLDC.d120VoltSetting |
numeric |
|
|
VoltageSetting_B |
ForwardLDC.d120VoltSetting |
numeric |
|
|
VoltageSetting_C |
ForwardLDC.d120VoltSetting |
numeric |
|
PFCorrectingEquipment (bank capacitors)
|
Attribute |
Solver Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
SubtypeCD |
No corresponding property |
PFCorrecting domain |
|
|
PhaseDesignation |
No corresponding property |
PhaseDesignation domain |
|
|
TotalKVAR |
dFixedKvar |
numeric |
|
Capacitor Control (related table for PFCorrectingEquipment)
If no CapacitorContol is provided to the Electric Solver API, the capacitor will use a manual capacitor control by default.
|
Attribute |
Solver Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
SubtypeCD |
eControllerType and bManualMode |
CapacitorControl domain |
0 (manual) |
|
OnSetting |
SwitchedUnit (seMod1), dModCloseSet |
numeric |
|
|
OffSetting |
SwitchedUnit (seMod2), dModTripSet |
numeric |
|
* When an exported value doesn't match a value in a coded domain, the voltage fields by default assume values are physical voltage expressed in Volts.
Some attributes of objects in the Solver are set automatically as network features are loaded by the Electric Solver API. The implementer cannot change the value that will be set for each of the attributes listed in the table below, except the Feeder ID attribute and attributes that use unique text.
As described in the Component Design, the client can provide a unique text string to the Solver API using the UniqueText property of the IMMXMLData::ImportDataFromDOM method. This string is used for some Solver attributes, and is referred to below as ‘unique text.’
|
Solver Object |
Attribute |
Value |
|---|---|---|
|
Feeder |
sName |
Value of ID field for the CircuitSource object, followed by unique text |
|
Section |
sName |
ClassID.ObjectID.EdgeID of conductor edge |
|
Section |
From Node ID |
ClassID.ObjectID of upstream feature |
|
Section |
To Node ID |
ClassID.ObjectID of downstream feature |
|
Section |
bUseEquivalentSpacing |
TRUE |
|
Section |
phPhasing.bNeutral |
TRUE if feeder connection is wyegnd, else FALSE |
|
Section |
bAreLoadsConnectedLL |
FALSE if feeder connection is wyegnd, else TRUE |
|
devices |
sName |
ClassID.ObjectID of device |
|
protective devices |
bIsNearFromNode |
FALSE |
