Software Configuration

Support for Encrypted Configuration Parameters

Some configuration parameters that are stored in the CES_PARAMETERS database table contain sensitive information, such as authentication credentials, which should be protected. To protect this data, the VALUES column can be encrypted using the Oracle WebLogic Server encrypt utility. This utility encrypts cleartext strings for use with Oracle WebLogic Server. Its output can then be used to populate values in CES_PARAMETERS database table.

Note: For detailed information, see "encrypt" in the Oracle WebLogic Server Command Reference documentation.

Configuration Parameters

Entries in the CES_PARAMETERS database table for the Oracle Utilities Network Management System - ODIN Adapter should have the value 'ODINInterface' in the APP column. The column ATTRIB should contain the name of the configuration parameter and the column VALUE should contain its value.

General Parameters

Parameter	Description
config.enabled	Enable/disable. Default: true (enabled)
config.strict_odin_format	Strictly adhere to the ODIN outage data format. Default: true
config.publish.url	URL for publishing outage information.
config.publish.format	Format for publishing outage information. Valid values: • xml - outage information is published as XML document • json - outage information is published in JSON format Default: xml in strict mode (required by ODIN), otherwise json.
config.publish.period	Period for publishing outage information in minutes. Default: 15 minutes
config.publish.timeout	Timeout in seconds for web service operations. Default: 30 seconds
config.outage_id_format	Outage ID format. Format for generating outage identifiers for point outages. The '%d' string in the format is replaced with the NMS outage identifier (event index). When publishing to the Outage Data Initiative Nationwide (ODIN) website the specified format must make the outage ID globally unique. Default: %d
config.include_spatial_info	Include spatial information with outage data. Implicitly disabled (set to ‘none’) if config.strict_odin_format is set to 'true'. Valid values: • outage - include for point outages • area - include for area outages • all - include for point and area outages • none - do not include spatial information Default: none

Utility Identifier and Name

When publishing to Outage Data Initiative Nationwide (ODIN) website utility name and id information must be provided.

Parameter	Description
config.utility_id	Utility ID. Preferably, it is the unique identifier used by the Energy Information Administration for reporting.
config.utility_id_authority	Name of the authority responsible for managing utility ID (Utility, EIA, NERC, and so forth).
config.utility_name	Utility name. Preferably, it is the unique identifier used by the Energy Information Administration for reporting.
config.utility_name_authority	Name of the authority responsible for managing the utility name (Utility, EIA, NERC, and so forth).

Authentication

Parameter	Description
config.auth.url	URL of OAuth server. If provided then the credentials specified by the config.auth.user and config.auth.pwd parameters will be used when contacting the OAuth server and the obtained token is then used when publishing outage information. If not provided, then the configured credentials are used directly when publishing outage information using the basic HTTP authentication mechanism.
config.auth.scope	The scope value used when requesting OAuth token.
config.auth.user	Username/client id.
config.auth.pwd	Password/client secret. This parameter should be stored in encrypted form.

Geographic Area Mapping

These parameters map outage area types defined in the ODIN specification (borough, county, parish, serviceArea, state, township, ward, zipcode) to the value in the AREA_TYPE column in the GEOGRAPHIC_OUTAGE_AREAS database view.

NULL value indicates that outage area type is not used.

Note: the same column cannot be mapped to multiple area types.

Parameter	Description
config.area_type.zipcode	Value of the GEOGRAPHIC_OUTAGE_AREAS.AREA_TYPE column for the ‘zipcode’ area type.
config.area_type.county	Value of the GEOGRAPHIC_OUTAGE_AREAS.AREA_TYPE column for the ‘county’ area type.
config.area_type.state	Value of the GEOGRAPHIC_OUTAGE_AREAS.AREA_TYPE column for the ‘state’ area type.
config.area_type.township	Value of the GEOGRAPHIC_OUTAGE_AREAS.AREA_TYPE column for the ‘township’ area type.
config.area_type.ward	Value of the GEOGRAPHIC_OUTAGE_AREAS.AREA_TYPE column for the ‘ward’ area type.
config.area_type.parish	Value of the GEOGRAPHIC_OUTAGE_AREAS.AREA_TYPE column for the ‘parish’ area type.
config.area_type.borough	Value of the GEOGRAPHIC_OUTAGE_AREAS.AREA_TYPE column for the ‘borough’ area type.
config.area_type.serviceArea	Value of the GEOGRAPHIC_OUTAGE_AREAS.AREA_TYPE column for the ‘serviceArea’ area type.