ArcFM Desktop Developer Guide
CYMDIST Supported Attributes
Automatic Attributes are listed at the bottom of this page.
The CYMDIST analysis tool supports certain settings for each network feature included in the XML to be imported into CYMDIST. The tables below show the tables and attributes that can be imported by the CYMDIST API if they are included in the XML document. Network Adapter exports domain codes, rather than values. The CYMDIST API supports the domain codes for the attributes in the tables listed below.
NOTE: If you deviate from the attributes, feature class names, subtype codes, domain values, or relationship structures listed below, you must also modify the XML using an XSL style sheet.
If the attribute is not exported from the geodatabase or provided by the Implementation, the CYMDIST 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 CYMDIST API to correctly load data.
The CYMDIST API supports the following domain values for the attributes in the tables listed below.
|
Domain |
Supported Codes |
|---|---|
|
PhaseDesignation |
1 = C; 2 = C; 3 = BC; 4 = A; 5 = AC; 6 = AB; 7 = ABC |
|
HighSideConfig |
D = cymD, Y = cymY, OD = cymDO, OY = cymYO, LG = cymY, LL = cymD |
|
LowSideConfig |
Y = cymY or cymYO, 3D = cymD or cymDO, 4D = cymD, SP = Y |
|
RegulatorConfig |
D = cymD, L = cymD, S = cymYg, O = cymOpenDelta, Y = cymY |
|
Status |
0 = off; 1 = on |
|
True/False |
0 = false; 1 = true |
|
CapacitorConfig |
D = cymD, L = cymD, SLG = cymYg, SLL = cymD, S = cymYg, 2PY = cymY, Y = cymY |
Junctions (Required by CYMDIST API for results display at junctions)
The CYMDIST 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 CYMDIST. 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.
All Feature Tables
|
Attribute |
CYMDIST Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
FeederID |
(feature classes only) |
text |
|
|
FeederID2 |
(feature classes only) |
text |
|
|
Exclude |
(If TRUE, the parent equipment feature is excluded from the import to CYMDIST, but its load is still included) |
TRUE or FALSE |
FALSE |
Conductor (PriOHElectricLineSegment, PriUGElectricLineSegment, BusBar)
|
Attribute |
CYMDIST Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
PhaseDesignation |
Phase |
PhaseDesignation domain |
|
|
EquipmentID |
LineOrCableReferenceID |
text |
DEFAULT |
|
Length |
Length to use instead of geometric length (use LengthSource property when exporting) |
numeric |
geometric length |
Transformer
Exported Transformer subtypes:
Subtype 7: power transformer
Subtype 8: step transformer
|
Attribute |
CYMDIST Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
PhaseDesignation |
No corresponding property |
PhaseDesignation domain |
upstream phase |
|
HighSideConfiguration |
ConnectionConfiguration |
HighSideConfig domain |
Y |
|
LowSideConfiguration |
ConnectionConfiguration |
LowSideConfig domain |
Y |
|
HighSideGround Resistance |
PrimaryGroundingResistance |
numeric |
0 |
|
HighSideGround Reactance |
PrimaryGroundingReactance |
numeric |
0 |
|
LowSideGround Resistance |
SecondaryGrounding |
numeric |
0 |
|
LowSideGround Reactance |
SecondaryGrounding |
numeric |
0 |
|
TapSettingPercent |
TapSettingPercent |
0-100 |
100 |
|
OpenYDConfiguration |
OpenYDConfiguration |
PhaseDesignation domain |
|
|
EquipmentID |
EquipmentID |
text |
DEFAULT |
|
EquipmentNumber |
EquipmentNumber |
text |
ClassID.ObjectID |
|
A_kWh |
A_kWh |
double |
|
|
B_kWh |
B_kWh |
double |
|
|
C_kWh |
C_kWh |
double |
|
|
A_NumCustomers |
A_NumCustomers |
long |
|
|
B_NumCustomers |
B_NumCustomers |
long |
|
|
C_NumCustomers |
C_NumCustomers |
long |
|
Voltage Regulator
|
Attribute |
CYMDIST Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
PhaseDesignation |
ControlStatus |
PhaseDesignation domain |
4 (A) |
|
BuckPercent |
BuckPercent |
0-100 |
10 |
|
BoostPercent |
BoostPercent |
0-100 |
10 |
|
HighSideConfiguration |
ConnectionConfiguration |
RegulatorConfiguration domain |
Y |
|
LeadingUnit |
LeadingUnit |
PhaseDesignation domain |
|
|
EquipmentID |
EquipmentID |
text |
DEFAULT |
|
EquipmentNumber |
EquipmentNumber |
text |
ClassID.ObjectID |
VoltageRegulatorUnit (related table for VoltageRegulator)
(No additional attributes supported at this time, but export the feature to get RegulatorControl related objects)
RegulatorControl (related table for VoltageRegulatorUnit)
|
Attribute |
CYMDIST Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
BandWidth |
SetBandWidth |
numeric |
2 |
|
CTPrimary |
CTPrimary |
numeric |
5 |
|
PTRatio |
PTRatio |
numeric |
1 |
|
VoltageSetting_A |
DesiredVoltageA |
numeric |
121.21 |
|
VoltageSetting_B |
DesiredVoltageB |
numeric |
121.21 |
|
VoltageSetting_C |
DesiredVoltageC |
numeric |
121.21 |
|
RSetting_A |
RSettingA |
numeric |
0 |
|
RSetting_B |
RSettingB |
numeric |
0 |
|
RSetting_C |
RSettingC |
numeric |
0 |
|
XSetting_A |
XSettingA |
numeric |
0 |
|
XSetting_B |
XSettingB |
numeric |
0 |
|
XSetting_C |
XSettingC |
numeric |
0 |
|
TapSetting_A |
TapSettingA |
numeric |
0 |
|
TapSetting_B |
TapSettingB |
numeric |
0 |
|
TapSetting_C |
TapSettingC |
numeric |
0 |
DynamicProtectiveDevice** (CircuitBreaker, Recloser, and Sectionalizer)
Exported DynamicProtectiveDevice subtypes:
Subtype 1: Exports as circuit breaker
Subtypes 3-7: exports as recloser
Subtypes 8-11: exports as sectionalizer
Subtype 2 (fault interrupter) is NOT exported
|
Attribute |
CYMDIST Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
SubtypeCD |
No corresponding property |
DPD domain |
|
|
PhaseDesignation |
No corresponding property |
PhaseDesignation domain |
upstream phase |
|
PresentPosition_A |
ActualStatus |
Status domain |
1 (on) |
|
PresentPosition_B |
ActualStatus |
Status domain |
1 (on) |
|
PresentPosition_C |
ActualStatus |
Status domain |
1 (on) |
|
NormalPosition_A |
NormalStatus |
Status domain |
1 (on) |
|
NormalPosition_B |
NormalStatus |
Status domain |
1 (on) |
|
NormalPosition_C |
NormalStatus |
Status domain |
1 (on) |
|
Restriction |
Restriction |
True/False domain |
0 (false) |
|
RemoteControlled |
RemoteControlled |
True/False domain |
0 (false) |
|
EquipmentID |
EquipmentID |
text |
DEFAULT |
|
EquipmentNumber |
EquipmentNumber |
text |
ClassID.ObjectID |
|
TCCDeviceID |
TCCDeviceID |
text |
|
|
GroundTripRating |
GroundTripRating |
numeric |
|
|
PhaseTripRating |
PhaseTripRating |
numeric |
|
|
AlternateGroundTripRating |
AlternateGroundTripRating |
numeric |
|
|
AlternatePhaseTripRating |
AlternatePhaseTripRating |
numeric |
|
|
UseAlternate |
UseAlternate |
True/False domain |
0 (false) |
CircuitSource (related table for CircuitBreaker)
|
Attribute |
CYMDIST Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
ID |
ID of Feeder |
text |
|
|
SubstationID |
SubstationID of Feeder |
text |
|
|
FeederColor |
Color of Feeder |
numeric |
|
Fuse**
|
Attribute |
CYMDIST Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
PhaseDesignation |
No corresponding property |
PhaseDesignation domain |
upstream phase |
|
PresentPosition_A |
ActualStatus |
Status domain |
1 (on) |
|
PresentPosition_B |
ActualStatus |
Status domain |
1 (on) |
|
PresentPosition_C |
ActualStatus |
Status domain |
1 (on) |
|
NormalPosition_A |
NormalStatus |
Status domain |
1 (on) |
|
NormalPosition_B |
NormalStatus |
Status domain |
1 (on) |
|
NormalPosition_C |
NormalStatus |
Status domain |
1 (on) |
|
Restriction |
Restriction |
True/False domain |
0 (false) |
|
RemoteControlled |
RemoteControlled |
True/False domain |
0 (false) |
|
EquipmentID |
EquipmentID |
text |
FALSE |
|
EquipmentNumber |
EquipmentNumber |
text |
ClassID.ObjectID |
|
TCCDeviceID |
TCCDeviceID |
text |
|
|
GroundTripRating |
GroundTripRating |
numeric |
|
|
PhaseTripRating |
PhaseTripRating |
numeric |
|
|
AlternateGroundTripRating |
AlternateGroundTripRating |
numeric |
|
|
AlternatePhaseTripRating |
AlternatePhaseTripRating |
numeric |
|
|
UseAlternate |
UseAlternate |
True/False domain |
0 (false) |
Switch and OpenPoint** (OpenPoints are loaded to CYMDIST as Switches)
CYMDIST does not allow phase-specific switch positions on switchable devices.
|
Attribute |
CYMDIST Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
PhaseDesignation |
No corresponding property |
PhaseDesignation domain |
upstream phase |
|
PresentPosition_A |
ActualStatus |
Status domain |
1 (on) |
|
PresentPosition_B |
ActualStatus |
Status domain |
1 (on) |
|
PresentPosition_C |
ActualStatus |
Status domain |
1 (on) |
|
NormalPosition_A |
NormalStatus |
Status domain |
1 (on) |
|
NormalPosition_B |
NormalStatus |
Status domain |
1 (on) |
|
NormalPosition_C |
NormalStatus |
Status domain |
1 (on) |
|
Restriction |
Restriction |
True/False domain |
0 (false) |
|
RemoteControlled |
RemoteControlled |
True/False domain |
0 (false) |
|
EquipmentID |
EquipmentID |
text |
DEFAULT |
|
EquipmentNumber |
EquipmentNumber |
text |
ClassID.ObjectID |
|
TCCDeviceID |
TCCDeviceID |
text |
|
|
GroundTripRating |
GroundTripRating |
numeric |
|
|
PhaseTripRating |
PhaseTripRating |
numeric |
|
|
AlternateGroundTripRating |
AlternateGroundTripRating |
numeric |
|
|
AlternatePhaseTripRating |
AlternatePhaseTripRating |
numeric |
|
|
UseAlternate |
UseAlternate |
True/False domain |
0 (false) |
PFCorrectingEquipment (Shunt Capacitor)
Exported PFCorrectingEquipment subtypes
Subtypes 1-2: exported as shunt capacitor
Subtypes 3 and above (series capacitor and shunt reactor) are NOT exported
|
Attribute |
CYMDIST Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
SubtypeCD |
No corresponding property |
PFCorrecting domain |
|
|
PhaseDesignation |
Phase |
PhaseDesignation domain |
|
|
Connection Configuration |
ConnectionConfiguration |
CapacitorConfig domain |
Y |
|
Capstatus |
Status |
Status domain |
1 (on) |
|
EquipmentID |
CapacitorID |
text |
DEFAULT |
CapacitorControl (related table for Shunt Capacitor)
If no CapacitorControl is provided to the CYMDIST API, the capacitor will use a manual capacitor control by default.
Exported CapacitorControl subtypes:
Subtype 1: current controlled
Subtype 2: kVAR controlled
Subtype 3: temperature controlled
Subtype 4: timed
Subtype 5: voltage controlled
Any other subtype code: manual controlled
|
Attribute |
CYMDIST Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
SubtypeCD |
capacitor control type |
CapacitorControl domain |
0 (manual) |
|
OnSetting |
On... |
numeric |
|
|
OffSetting |
Off... |
numeric |
|
ServicePoint
(No additional attributes supported at this time, but export the feature to get InductionMotor related objects)
InductionMotor (related table for ServicePoint)
|
Attribute |
CYMDIST Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
PhaseDesignation |
Phase |
PhaseDesignation domain |
|
|
SoftStartReactance |
KVARCapacitor Assistance |
numeric |
0 |
|
SoftStartResistance |
OhmsResistorAssistance |
numeric |
0 |
|
SoftStartTap |
VoltageReduction Assistance |
numeric |
100 |
|
EquipmentID |
EquipmentID |
text |
DEFAULT |
|
|
status |
Status domain |
0 (off) |
Generator
|
Attribute |
CYMDIST Property |
Domain/Data Type |
Default Value |
|---|---|---|---|
|
*NominalVoltage |
DesiredKVLL |
Generator Nominal Voltage |
25 |
|
KW |
KWActiveGeneration |
numeric |
100 |
|
PowerFactor |
PFPercent |
numeric |
85 |
|
MaxReactive Generation |
MaxReactiveKVAR |
numeric |
50 |
|
GroundResistance |
GroundingResistanceOhms |
numeric |
0 |
|
GroundReactance |
GroundingReactanceOhms |
numeric |
0 |
|
EquipmentID |
EquipmentID |
text |
DEFAULT |
|
|
status |
Status domain |
1 (on) |
|
|
VoltageRegulation |
True/False domain |
0 (false) |
|
|
MinReactiveKVAR |
numeric |
0 |
* 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.
** CYMDIST exports the Normal Position value of only the first phase it encounters. For example, it will export the B phase Normal Position value as the Normal Position value for a BC switch.
Some attributes of CYMDIST objects are set automatically as network features and loaded by the CYMDIST 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.
The client can provide a unique text string to the CYMDIST API using the UniqueText property of the IMMXMLData::ImportDataFromDOM method. This string is used for some CYMDIST attributes, and is referred to below as ‘unique text.’
|
CYMDIST Object |
Attribute |
Value |
|---|---|---|
|
Feeder |
Head Node ID |
ClassID.ObjectID of Feature containing the CircuitSource relationship |
|
Feeder |
ID |
Value of ID field for the CircuitSource object, followed by unique text. |
|
Section |
FeederID |
Feeder ID described above |
|
Section |
ID |
ClassID.ObjectID.EdgeID of conductor edge, followed by unique text. |
|
Section |
To Node ID |
Section ID described above |
|
Section |
From Node ID |
Section ID (set for first section in feeder only) |
|
Section |
Overhead Line |
1 for primary overheads, 0 for primary undergrounds and bus bars |
|
Equipment |
Location |
cymTo |
|
Regulator |
Load Center ID |
Section ID |
