Skip to main content
Version: 2.12.0

Running the Application

Configuration options for the GIS Network Extractor are provided as command line arguments.

Command Line Options​

UsageDescriptionDefault
-tc <FILE>The file containing the cable types JSON or SINCAL standard types database../cable-types.json
-n <FILE>Path to the network hierarchy specification json file../network-hierarchy.json
-e <PATH>The root path to be used for the output of the extractor (EWB network data)../ewb
-ep <true or false>Controls if the phase information will be extracted from the source data. If disabled everything will be extracted as ABC.true
-g <PATH>Path where the input GIS JSON files are located../gis
-m <PATH>The path where the input meter mappings csv files are located../meter_mappings
-pl <FILE>Path to the poles data json file../poles.json
-nc <FILE>Path to the nodes config json file../nodes-config.json
-lvt <NUMBER>Defines the LV voltage upper limit in volts (inclusive)1000
-mmdp <PATTERN>Specifies the pattern used to represent dates for the records in the meter mappings csv files.yyyyMMdd
-mmfp <REGEX>Specifies the file name pattern for meter mapping files.NMI_TX_MAPPING_(\d8).*[.]csv
-pof <HOST> <PORT> <INSTANCE>PowerOn Fusion database connection configuration (Used for CRO extraction).NULL
-dlFlag to enable detailed logging of processing errors.false
-dscFlag to disable running of the conductor stitching processor.false
-hFlag to display help message with the available command line optionsfalse

Environment Variables​

If the option for processing PowerOn Fusion is enabled, the following environment variables must be set to connect to the PowerOn Fusion database.

VariableDescriptionDefault
ENMAC_USERThe user for the PoF Oracle database.enmac
ENMAC_PASSWORDThe password for the PoF Oracle database.password

To run the tool, execute the following command at a terminal.

java -Xmx<heap size> -Xms<heap size> -jar <path to gis-network-extractor> -c <path to cable types file> -n <path to network hierarchy file> -g <path to gis input files directory> -e <path to output ewb data directory>  -pof <PoF Oracle host> <PoF Oracle port> <PoF Oracle instance>

where:

  • PoF databse connection environment variables have been defined. e.g. ENMAC_USER=enmac; ENMAC_PASSWORD=password;

  • heap size is the desired size of the heap. e.g. 16g

Heap Size Estimation​

PoF system with 2.5 million components requires around 10GB

The LV Mapping data requires around 2GB

Together with the process overhead, the recommended heap size is 16GB