Version: 2.9.0

Config File

Configuration for the PoF Network Extractor is specified in a JSON file.

Option	Description	Required
`pofConfigFile`	The path to the PoF configuration used by this tool. Refer to PoF Configuration below.	Yes
`ewbDataPath`	The path to the ewb data directory.	Yes
`meterSourceType`	Indicates the source of meters. One of `TCS` or `MAPPING_FILE`. Default: `MAPPING_FILE`	No
`meterMappings`	Object that holds meter mapping related config if meter source is `MAPPING_FILE`. Refer to Meter Mapping Config below.	No
`connectionPointIdentifier`	Name to use for the connection point identifier. E.g. `NMI` in Australia or `ICP` in New Zealand. Default: `NMI`.	No

Meter Mapping Config

The PoF extractor can take meter mapping files to provide a mapping of meters and supply points to transformers. Each file is required to have its date in the file name so the appropriate mapping file can be used. All the options in this config object are required if it is included.

Option	Description
`path`	The path to the directory containing meter mapping files.
`filePattern`	A regex to match meter mapping files. This needs to have a single group capture that captures the date in the file name.
`datePattern`	The pattern of the date captured from the file name.

If any paths in the configuration are given as relative paths, they will be relative to the working directory of the JVM.

The following is a sample configuration file

Sample Configuration File

{
  "ewbDataPath": "/users/release/ewb/data",
  "pofConfigFile": "/users/release/ewb/conf/pof_config.json",
  "meterMappings": {
    "path": "/path/to/directory/with/mapping/files",
    "filePattern": "NMI_TX_MAPPING_(\\d{8}).csv",
    "datePattern": "yyyyMMdd"
  }
}

PoF Configuration

The following describes PowerOn Fusion specific data configuration that allows the PoF Network Extractor to convert components from PoF to EWB network model assets.

Option	Description	Type
`distTransformerClasses`	A list of component class IDs for all distribution transformers.	[int]
`isoTransformerClasses`	A list of component class IDs for all isolation transformers.	[int]
`regulatorClassesReversible`	A list of component class IDs for reversible regulators.	[int]
`regulatorClassesNonReversible`	A list of component class IDs for non reversible regulators.	[int]
`zoneTransformerClasses`	A list of component class IDs for zone transformers.	[int]
`feederCbClasses`	A list of component class IDs for feeder circuit breakers.	[int]
`cbClasses`	A list of component class IDs for all other circuit breakers.	[int]
`fuseClasses`	A list of component class IDs for fuses.	[int]
`isolatorClasses`	A list of component class IDs for isolaters.	[int]
`recloserClasses`	A list of component class IDs for reclosers.	[int]
`switchClasses`	A list of component class IDs for all generic switch types. Only use this list if the switch does not fall into one of the explicit categories.	[int]
`faultIndicatorClasses`	A list of component class IDs for fault indicators.	[int]
`brokenBridgeClasses`	A list of component class IDs for broken bridges.	[int]
`generatorClasses`	A list of component class IDs for generators.	[int]
`capacitorClasses`	A list of component class IDs for capacitors.	[int]
`hvSupplyPointClasses`	A list of component class IDs for HV supply points.	[int]
`poleClasses`	A list of component class IDs for poles.	[int]
`ignoreSources`	A list of component class IDs which cannot be converted to sources.	[int]
`feederClasses`	A list of component class IDs for feeder start points.	[int]
`siteClasses`	A list of component class IDs for site components.	[int]
`worlds`	A list of world IDs to be included in the extract.	[int]
`zoneCloneIds`	A list of component IDs that zones were cloned from. This is used to find the zone elements in the component hierarchy.	[string]
`businesses`	Object that holds businesses config. Refer to Business Config below.	{}
`transformerTypes`	Object that holds transformer types config. Refer to Transformer Types Config below.	{}
`equalLatLonCheck`	Flag to indicate if the latitudes and longitude for a component should be checked to see if they have the exact same value. Defaults to `false`.	boolean
`treatUnknownLengthAsZero`	Flag to indicate if conductors with a missing length should have their length set to 0 rather than being left as `null`. Defaults to `false`.	boolean
`eastingNorthingStoreLongLat`	Flag to indicate if the Easting/Northing fields actually contain Longitude/Latitude values. Defaults to `false`.	boolean
`undergroundPattern`	Regular expression used to determine if a cable is underground from the component class name. Defaults to `hvugc`.	string
`txRatingAttribute`	The name of the attribute that stores the transformer rating. Defaults to `Rating (kVA)`.	string
`conductorNaming`	Choose which `COMPONENT_HEADER` field to use as the conductor name (`COMPONENT_PATHNAME`, `COMPONENT_ALIAS` or `COMPONENT_ID`). Defaults to `COMPONENT_PATHNAME`.	string
`geoGraphicsInterpolatorTraceStopVoltage`	The voltage to stop at when tracing the network for interpolating missing geographic points. Defaults to `66000`.	int
`attributeMapping`	Object that holds attribute mapping config. Refer to Attribute Mapping Config below.	{}

Transformer Types Config

This object is a JSON version of the TRANSFORMER_TYPES table in the PowerOn Fusion database.

Option	Description	Type
`type`	The identifier of this transformer type (can be repeated).	string
`ratingMin`	The minimum rating of a transformer to match against this type. Set to `0` if this is the lowest range for the type.	int
`ratingMax`	The maximum rating of a transformer to match against this type. Set to `999999999` if this is the highest range fo the type.	int
`cyclicRatingFactor`	Multiplication factor applied to the transformers rating when running in emergency situations.	double
`powerFactor`	The power factor of this type of transformer.	double

Businesses Config

Option	Description	Type
`name`	The name to give the business in the EWB model.	string
`roots`	A list of the highest level component IDs in the hierarchy that have network assets for the specified business. All zones found under these roots will be added to this business.	[string]

Attribute Mapping Config

Defines optional mappings to override the built-in defaults. All definitions provide a list of attributes to search in priority order. For string attributes, this will be a list of attribute names, for all other stypes, this will be a list of attribute convertion objects.

Optional attributes that have a default value can be removed/suppressed by specifying the key with a null value.

note

Voltage and rating attributes will only use the multiplier if there are no recognised units in the string extracted (kV and V or kVA and MVA). A voltage string of LV is also supported.

Option	Description	Type
`acLineSegment`	Optional mapping rules for `AcLineSegment` instances. See AcLineSegment Attributes	`null`
`conductingEquipment`	Optional mapping rules for `ConductingEquipment` instances. See ConductingEquipment Attributes	`null`
`linearShuntCompensator`	Optional mapping rules for `LinearShuntCompensator` instances. See LinearShuntCompensator Attributes	`null`
`powerTransformer`	Optional mapping rules for `PowerTransformer` instances. See PowerTransformer Attributes	`null`

AcLineSegment Attributes

Option	Description	Type
`length`	Optional length of the conductor. Only used if no `DPA Length` is provided. Defaults to `Cable Length` with a multiplier of 1.	`[AttributeConvertion]`
`type`	Optional `CODE` from the `CONDUCTOR_TYPES` table. This is used to define both ratings and sequence impedance data. Defaults to `DPA Cable Code`.	`[String]`
`ratedCurrent`	Optional override containing the rated current for a conductor. If specified, this will be used rather than the current from the conductor type.	`[AttributeConvertion]`
`wireMaterialKind`	Optional conductor material. Defaults to `Phase Conductor Material`.	`[AttributeConvertion]`
`wireMaterialKindMapping`	Optional mapping between values in the `wireMaterialKind` attribute and a CIM `WireMaterialKind`.	`[WireMaterialKindMapping]`

ConductingEquipment Attributes

Option	Description	Type
`baseVoltage`	Optional nominal voltage of the conducting equipment. Defaults to `Operating Voltage` with a multiplier of 1.	`[AttributeConvertion]`
`gisId`	Optional GIS ID of the conducting equipment. Defaults to `GIS ID`.	`[String]`

LinearShuntCompensator Attributes

Option	Description	Type
`assetInfoMrid`	Optional ID stored in a SinCAL lookup database. No validation will be performed, and it will be prepended with "sci-" to ensure uniqueness. Defaults to `Sincal Element ID`	`[String]`
`sections`	Optional number of sections. If not specified, a single section will be used if `bPerSection` is specified.	`[AttributeConvertion]`
`bPerSection`	Optional susceptance for each section. Defaults to `DPA Susceptance` with a multiplier of 0.000001.	`[AttributeConvertion]`

PowerTransformer Attributes

Option	Description	Type
`assetInfoMrid`	Optional ID stored in a SinCAL lookup database. No validation will be performed, and it will be prepended with "pti-" to ensure uniqueness. Defaults to `Sincal Element ID`.	`[String]`
`transformerUtilisation`	Optional utilisation of the transformer.	`[AttributeConvertion]`
`r`	Optional resistance of the transformer.	`[AttributeConvertion]`
`x`	Optional reactance of the transformer.	`[AttributeConvertion]`
`r0`	Optional zero-sequence resistance of the transformer.	`[AttributeConvertion]`
`x0`	Optional zero-sequence reactance of the transformer.	`[AttributeConvertion]`
`primaryRatedU`	The rated voltage for the primary end. Defaults to `Primary Voltage`.	`[AttributeConvertion]`
`secondaryRatedU`	The rated voltage for the secondary end. Defaults to `Secondary Voltage`.	`[AttributeConvertion]`
`ratedS`	The power rating for the transformer. Defaults to `Rating (kVA)`.	`[AttributeConvertion]`
`stepVoltageIncrement`	Optional voltage increment per tap step.	`[AttributeConvertion]`
`highStep`	Optional highest available tap step.	`[AttributeConvertion]`
`lowStep`	Optional lowest available tap step.	`[AttributeConvertion]`
`neutralStep`	Optional tap step when the tap changer is in a neutral position.	`[AttributeConvertion]`
`normalStep`	Optional tap step used in "normal" network operation.	`[AttributeConvertion]`
`tapControlEnabled`	Optional regulation status of the tap changer.	`[String]`
`type`	Optional lookup into the transformer types defined in the configuration.	`[String]`

Attribute Convertion

Option	Description	Type
`attribute`	The name of the attribute.	`String`
`multiplier`	The multiplication factor to apply to the attribute value to convert it into our CIM units.	`Double`

WireMaterialKind Mapping

The mappings between values in the wireMaterialKind attribute and a CIM WireMaterialKind. If no mapping is found, a direct translation is attempted, otherwise it will default to a WireMaterialKind of other.

Option	Description	Type
`wireMaterialKind` attribute value.	Case-sensitive CIM `WireMaterialKind` value.	`String`

If no mappings are specified, the following will be used by default:

Attribute Value	WireMaterialKind
`a (Al)`	`aluminum`
`AAC`	`aluminum`
`AAAC`	`aaac`
`ACSR/AZ`	`acsrAz`
`ACSR/GZ`	`acsr`
`c (Cu)`	`copper`
`CU`	`copper`
`Cd Cu`	`copperCadmium`
`SC/AC`	`aluminumSteel`
`SC/GZ`	`steel`

Sample Configuration File

Remember that this configuration is a sample. The lists for these options will likely be substantially larger than shown here for a real PoF

system.

{
  "distTransformerClasses": [
    1,
    2
  ],
  "isoTransformerClasses": [
    3,
    4
  ],
  "regulatorClassesReversible": [
    5,
    6
  ],
  "regulatorClassesNonReversible": [
    7,
    8
  ],
  "zoneTransformerClasses": [
    9,
    10
  ],
  "feederCbClasses": [
    11,
    12
  ],
  "cbClasses": [
    13,
    14
  ],
  "fuseClasses": [
    15,
    16
  ],
  "isolatorClasses": [
    17,
    18
  ],
  "recloserClasses": [
    19,
    20
  ],
  "switchClasses": [
    21,
    22
  ],
  "faultIndicatorClasses": [
    23,
    24
  ],
  "brokenBridgeClasses": [
    25,
    26
  ],
  "generatorClasses": [
    27,
    28
  ],
  "capacitorClasses": [
    29,
    30
  ],
  "hvSupplyPointClasses": [
    31,
    32
  ],
  "poleClasses": [
    33,
    34
  ],
  "ignoreSources": [
    35,
    36
  ],
  "feederClasses": [
    37,
    38
  ],
  "siteClasses": [
    39,
    40
  ],
  "worlds": [
    41,
    42
  ],
  "zoneCloneIds": [
    "a00000001COMP",
    "a00000002COMP"
  ],
  "businesses": [
    {
      "name": "Business 1",
      "roots": [
        "a00000003COMP"
      ]
    },
    {
      "name": "Business 2",
      "roots": [
        "a00000004COMP",
        "a00000005COMP"
      ]
    }
  ],
  "transformerTypes": [
    {
      "type": "P",
      "ratingMin": 0,
      "ratingMax": 999999999,
      "cyclicRatingFactor": 1.5,
      "powerFactor": 0.95
    },
    {
      "type": "K",
      "ratingMin": 0,
      "ratingMax": 100000,
      "cyclicRatingFactor": 1.20,
      "powerFactor": 0.9
    },
    {
      "type": "K",
      "ratingMin": 100001,
      "ratingMax": 200000,
      "cyclicRatingFactor": 1.25,
      "powerFactor": 0.9
    },
    {
      "type": "K",
      "ratingMin": 200001,
      "ratingMax": 999999999,
      "cyclicRatingFactor": 1.30,
      "powerFactor": 0.92
    }
  ],
  "equalLatLonCheck": true,
  "treatUnknownLengthAsZero": false,
  "eastingNorthingStoreLongLat": false,
  "undergroundPattern": "hvugc",
  "txRatingAttribute": "Rating (kVA)",
  "conductorNaming": "COMPONENT_PATHNAME",
  "geoGraphicsInterpolatorTraceStopVoltage": 66000,
  "attributeMappings": {
    "acLineSegment": {
      "length": [
        {
          "attribute": "Cable Length",
          "multiplier": 1.0
        }
      ],
      "type": [
        "DPA Cable Code",
        "Type"
      ],
      "ratedCurrent": [
        {
          "attribute": "Amps",
          "multiplier": 1.0
        }
      ],
      "wireMaterialKind": [
        "Phase Conductor Material"
      ],
      "wireMaterialKindMapping": {
        "a (Al)": "aluminum",
        "AAC": "aluminum",
        "AAAC": "aaac",
        "ACSR/AZ": "acsrAz",
        "ACSR/GZ": "acsr",
        "c (Cu)": "copper",
        "CU": "copper",
        "Cd Cu": "copperCadmium",
        "SC/AC": "aluminumSteel",
        "SC/GZ": "steel"
      }
    },
    "conductingEquipment": {
      "baseVoltage": [
        {
          "attribute": "Operating Voltage",
          "multiplier": 1.0
        }
      ]
    },
    "linearShuntCompensator": {
      "assetInfoMrid": null,
      "sections": null,
      "bPerSection": [
        {
          "attribute": "DPA Susceptance",
          "multiplier": 0.0001
        }
      ]
    },
    "powerTransformer": {
      "assetInfoMrid": null,
      "transformerUtilisation": null,
      "r": null,
      "x": null,
      "r0": null,
      "x0": null,
      "primaryRatedU": [
        {
          "attribute": "DPA Primary Nominal Voltage",
          "multiplier": 1000
        },
        {
          "attribute": "Primary Voltage",
          "multiplier": 1000
        },
        {
          "attribute": "Voltage",
          "multiplier": 1000
        }
      ],
      "secondaryRatedU": [
        {
          "attribute": "DPA Secondary Nominal Voltage",
          "multiplier": 1000
        },
        {
          "attribute": "Secondary Voltage",
          "multiplier": 1000
        }
      ],
      "ratedS": [
        {
          "attribute": "kVA Rating",
          "multiplier": 1000
        }
      ],
      "stepVoltageIncrement": null,
      "highStep": null,
      "lowStep": null,
      "neutralStep": null,
      "normalStep": null,
      "tapControlEnabled": null,
      "type": null
    }
  }
}

Environment Variables

The following system environment variables are used by the tool. The default is applied if the environment variable does not exist.

Variable	Description	Default
`ENMAC_USER`	The user for the PoF Oracle database.	enmac
`ENMAC_PASSWORD`	The password for the PoF Oracle database.	password

Config File

Meter Mapping Config​

Sample Configuration File​

PoF Configuration​

Transformer Types Config​

Businesses Config​

Attribute Mapping Config​

AcLineSegment Attributes​

ConductingEquipment Attributes​

LinearShuntCompensator Attributes​

PowerTransformer Attributes​

Attribute Convertion​

WireMaterialKind Mapping​

Sample Configuration File​

Environment Variables​

Meter Mapping Config

Sample Configuration File

PoF Configuration

Transformer Types Config

Businesses Config

Attribute Mapping Config

AcLineSegment Attributes

ConductingEquipment Attributes

LinearShuntCompensator Attributes

PowerTransformer Attributes

Attribute Convertion

WireMaterialKind Mapping

Sample Configuration File

Environment Variables