configuring

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

Option	Description	Required
ewbDataPath	The path to the ewb data directory.	Yes
pofConfigFile	The path to the PoF configuration used by this tool.	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**](#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
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]
transformerClasses	A list of component class IDs for all other 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]
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]
switchClasses	A list of component class IDs for all other switch types.	[int]
siteClasses	A list of component class IDs for site components.	[int]
feederClasses	A list of component class IDs for feeder start points.	[int]
transformerTypes	Object that holds transformer types config. Refer to Transformer Types Config below.	{}
businesses	Object that holds businesses config. Refer to Business Config below.	{}
worlds	A list of world IDs to be included in the extract.	int[]
equalLatLonCheck	Flag to indicate if the latitudes and longitude for a component should be checked to see if they have the exact same value.	boolean
undergroundPattern	Regular expression used to determine if a cable is underground from the component class name. Defaults to hvugc.	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

Transformer Types Config

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

TODO: document object

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.	[string]

Sample Configuration File

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

system.

{
  "regulatorClassesReversible": [
    732,
    733
  ],
  "regulatorClassesNonReversible": [
    831,
    849
  ],
  "zoneTransformerClasses": [
    327
  ],
  "transformerClasses": [
    825,
    828
  ],
  "feederCbClasses": [
    50,
    51,
    52
  ],
  "cbClasses": [
    70,
    72,
    321
  ],
  "fuseClasses": [
    316,
    338
  ],
  "isolatorClasses": [
    305,
    657
  ],
  "recloserClasses": [
    339,
    710
  ],
  "faultIndicatorClasses": [
    502,
    839
  ],
  "brokenBridgeClasses": [
    893,
    905
  ],
  "generatorClasses": [
    895
  ],
  "capacitorClasses": [
    829
  ],
  "hvSupplyPointClasses": [
    894
  ],
  "switchClasses": [
    36,
    300
  ],
  "siteClasses": [
    845,
    898
  ],
  "feederClasses": [
    788
  ],
  "transformerTypes": [
    {
      "type": "P",
      "rating_min": 100000,
      "rating_max": 999999999,
      "cyclic_rating_factor": 1.5,
      "power_factor": 0.9
    },
    {
      "type": "K",
      "rating_min": 100000,
      "rating_max": 100000,
      "cyclic_rating_factor": 1.25,
      "power_factor": 0.9
    }
  ],
  "businesses": [
    {
      "name": "Business 1",
      "roots": [
        "B000001dbCOMP"
      ]
    },
    {
      "name": "Business 2",
      "roots": [
        "G00003e63COMP",
        "G00003e64COMP"
      ]
    }
  ],
  "worlds": [
    510,
    700
  ],
  "equalLatLonCheck": "true"
}

---

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