NMS Notifications Hub Adapter Configuration
To configure the NMS Notifications Hub adapter:
1. Configure the Oracle Utilities Network Management System Service Alert command-line option.
The new command-line option has been added that allows to specify the name of the contact group used to generate outage notifications for Oracle Utilities Notifications Hub.
-nhub <group name>
<group name> - Service Alert contact group name
 
2. Configure the Oracle Utilities Notifications Hub Adapter.
Configuration parameters for the application will be stored in the CES_PARAMETERS database table. The APP field contains the 'NHubInterface' value for records related to this application.
Sensitive configuration parameters (config.auth.pwd and config.auth.user) should be stored in a keystore in production environments. Keystore alias should be the string 'nhubinterface.' followed by the configuration parameter name (example: nhubinterface.config.auth.pwd).
Parameter
Description
config.enabled
Enable/disable the application.
Default: true (enabled)
config.auth.url
URL of the OAuth service used to obtain token to be used when accessing Notifications Hub. If not provided, then the Basic HTTP authentication method will be used.
config.auth.scope
The scope value used when requesting OAuth token.
config.auth.user
OAuth client ID or username for Basic HTTP authentication.
config.auth.pwd
OAuth client secret or password for Basic HTTP authentication.
config.publish.url
URL of the Notifications Hub web service.
config.ws.timeout
Timeout in seconds for web service operations.
Default: 30 seconds
config.publish.period
Period for publishing outage notifications in seconds. Cannot be set lower than 15 seconds.
 
Default: 60 seconds
config.publish.timeout
Amount of time in minutes after which notifications pending delivery are deleted from the MYC_CSS_PARAM_VIO_TEXT table. Purpose of this configuration option is to avoid old notifications being sent out after Notifications Hub integration has been down for some time. Setting the parameter to 0 disables this functionality.
 
Default: 240 minutes
config.publish.nfy_limit
Maximum number of notifications per message (per single web service call).
 
Default: 100
config.publish.size_limit
Maximum size of a single message in bytes. Valid range [100000, 50000000].
Note: If a single notification is larger than the message size limit, such notification will not be published.
 
Default: 1000000
config.publish.delete_sent
Delete notifications from the MYC_CSS_PARAM_VIO_TEXT database table once they are successfully published. Else, records are marked as sent but not deleted which can be useful for debugging purposes.
 
Default: true
3. Set up the Oracle Utilities Notifications Hub integration.
a. Configure and deploy the Oracle Utilities Notifications Hub Adapter.
b. In Service the Alert Administration tool:
a. Create a unique contact group for the Oracle Utilities Notifications Hub notification parameters.
b. Create notification parameters and assign them to the contact group. Only Outage (type 1) notifications are supported. Separate notification parameters are needed for planned and unplanned outages.
c. Make sure that the ‘Customers out’ value is set to ‘1’ so that all outages are sent to Oracle Utilities Notifications Hub.
4. In the system.dat file add the ‘-nhub <contact group>’ command-line option to the Service Alert service using the name of the contact group created in step 3.b.a.
A retry from Oracle Utilities Network Management System can be done by changing the MYC_CSS_PARAM_VIO_TEXT.CCS_NOTIFIED value to ‘Y’. If MYC_CSS_PARAM_VIO_TEXT.INSERT_TIME is older than 4 hours, the message will not be sent out, but just deleted. Also, INSERT_TIME must be updated to the current time.
For additional information about configuring Oracle Utilities Network Management System services, refer to the Services Configuration chapter in the Oracle Utilities Network Management System Configuration Guide at: https://docs.oracle.com/en/industries/energy-water/integrations-index.html