Device Events
The device event data exported from the head-end system as a file in NES format is loaded into Oracle Utilities as a Device Event. One of your configuration tasks is to customize the device events processing.
The required functionality is delivered in the base product as two OSB projects:
1. SGG-D4-EVENT-BASE contains components responsible for the actual processing of incoming data. This should not be modified during configuration.
2. SGG-D4-EVENT-CM allows you to segment your customizations so that future upgrades of base functionality implemented in SGG-D4-EVENT-BASE do not affecting the customization and environment settings.
The runtime configuration settings for the SGG-D4-EVENT-CM project are stored in the EnvironmentSettings.xq XQuery file. You can use this file to adjust device event data processing. For example, if you want to load raw data you would specify “true” for the content of the populateRaw element.
The following table describes the elements included in the EnvironmentSettings.xq file:
Element | Description | Valid Values |
|---|
populateRaw | Determines if the device event data is populated as raw data. | true false |
callPreProcessing | Determines if the preprocessing proxy service is called. | true false |
callPostProcessing | Determines if the postprocessing proxy service is called. | true false |
destinationRootElement | Holds the name of inbound web service for the device event seeder. | |
serviceProviderExternalId | The External ID of the NES service provider. | |
publishServices/service | Specifies the name of the business service within the OSB project used to publish data for external systems (such as Oracle DataRaker). | |
filterEvents | Determines if events should be filtered. | true false |
Publishing Events
The NES adapter can be configured to publish device events for use in Oracle DataRaker or other external systems. This functionality is supported through a combination of OSB components and BPEL composites.
Enabling Device Event Publishing
Publishing data is enabled by referencing a publisher business service in the publishServices/service element in the EnvironmentSettings.xq file as follows:
<publishServices>
<service>[publisherBusinessService]</service>
</publishServices>
The following components provided with the SGG-D4-EVENT-CM OSB project are used in publishing device events data to Oracle DataRaker:
• The DataRakerBusinessService business service is used to send data to a pre-configured JMS queue (defined as an Endpoint URI), from which the data will be published. This is the business service that should be specified in the EnvironmentSettings.xq file.
• The DataRakerServiceAccount service account is used to define and maintain the user name and password needed to access the JMS queue defined in the DataRakerBusinessService business service.
Configuring Device Event Publishing Output
The SGGDRIntegration BPEL composite handles publishing the data to Oracle DataRaker or other systems. Device event data is published in the “native” device event data format (the format of the device event seeder business object). This format includes normalized device event codes. See the Oracle Utilities Smart Grid Gateway Adapter Development Kit Administrative User Guide for more details about this format.
Note:
In addition, filtering can NOT be applied to device events published via this feature.
The following parameters can be used to configure details of how the data is provided to Oracle DataRaker, including the directory where files are posted for Oracle DataRaker to consume, number of records per file, polling frequency, etc. These parameters are defined during installation. See the Oracle Utilities Smart Grid Gateway Installation Guide for more details about defining values for these parameters.
Parameter | Description | Default Value |
|---|
SGG_DR_INT_QUEUE | JNDI name of queue to publish SGG payloads. This is the JMS queue defined in the DataRakerBusinessService business service. This should NOT be changed. | DataRakerQueue |
SOA_DR_PUBLISH_SIZE | The number of records (SGG payloads) to accumulate in a published file. | 100 |
SOA_DR_FILE_SIZE | The maximum file size for the accumulated (SGG payloads) file in kilobytes. | 524288 |
SOA_DR_ELAPSED_TIME | The period of time in second which, when exceeded, causes a new outgoing file to be created. | 600 |
SOA_DR_POLLING_FREQ | The polling frequency in seconds of the staging directory for new files. | 60 |
SOA_DR_STAGING_DIR | Mount point/directory for the staging directory for accumulated SGG payload files. This is used internally and should NOT be changed. | /spl/sploutput/staging |
SOA_DR_INTEGRATION_DIR | Mount point/directory from which Oracle DataRaker will consume the converted XML files. | /spl/sploutput/int |
Filtering Events
The SGG adapter can be configured to filter initial measurement data passed into SGG and the Oracle Utilities Meter Data Management application. Filtering data is enabled by setting the <filterUsage> element in the EnvironmentSettings.xq file to “true” as follows:
<filterEvents>true</filterEvents>
When filtering is enabled, only device events whose <externalEventName> matches one of the values defined in the NES Device Event Mapping extendable lookup (D4-DeviceEventMappingLookup) are passed into the system for processing.
Prioritized Device Event Processing
The SGG adapter prioritizes processing of device events created from smart meter commands and/or completion events by setting the Execution Method flag in these types of device events to “Real Time” (D1RT). In addition, device events received with the Execution Method flag set to “Real Time” will be processed in real time rather than via batch processing. See Device Event Prioritization in the Oracle Utilities Meter Data Management / Smart Grid Gateway Business User Guide for more information.
Configuring Payload Processing Notifications
By default, Payload Statistics, Payload Error Notification, and Payload Summary notification activities are sent to the Notification Queue within Oracle Service Bus. Smart Grid Gateway adapters can be configured to restrict sending these activities by defining optional JCA transport dynamic properties in the appropriate OSB project. The following optional JCA transport dynamic properties can used to control if these notification activities are sent:
• SGG_SEND_STATISTICS: Controls sending Payload Statistic activities (true: send, false: do not send)
• SGG_SEND_ERROR: Controls sending Payload Error Notification activities (true: send, false: do not send)
• SGG_SEND_SUMMARY: Controls sending Payload Summary activities (true: send, false: do not send)
When these properties are set to false, the corresponding payload notification will not be sent to the JMS Queue. Note these properties are not populated by default, and default to true if omitted.
To create these properties:
1. Navigate to the SGG-D4-EVENT-CM project in the Oracle Service Bus Console.
2. Expand the Proxy Services folder.
3. Select the InboundProxyService proxy service (not the Pipeline or WSDL).
4. Click Create to create a new session.
5. Select Transport Details.
6. Click the plus sign in the Dyanmic EndPoint Properties section. An empty row will appear.
7. Enter the property you wish to define in the Property column.
8. Enter "false" in the value column.
9. Repeat steps 6-8 for each property you wish to define.
10. Click Activate to save and activate your changes.
Note:
These properties are only used if the SGG_EXT_ID_PATTERN is not present or the regular expression captures nothing. The SGG_EXT_ID_PATTERN will override these properties when the regular expression captures group data.
Parent topic