Initial Measurements and Device Events

The usage and event data exported from the AMI head-end system is loaded into Oracle Utilities as initial measurement and device event data. You can customize processing of this by configuring the following base product OSB projects:

  1. SGG-DG-CSV-BASE contains components that are not to be changed on customer site. They implement functions specific to the CSV format processing such as validation and transformation.

  2. SGG-DG-CSV-CM allows for customization and simplifies future upgrades.

  3. SGG-DG-XML-BASE contains components that are not to be changed on customer site. They implement functions specific to the IMD and event upload format processing such as validation and transformation.

  4. SGG-DG-XML-CM allows for customization and simplifies future upgrades.

The runtime configuration settings for the SGG-DG-CSV-CM project are stored in the EnvironmentSettings.xq xquery file. You can use this file to adjust initial measurement and 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 SGG-DG-CSV-CM EnvironmentSettings.xq file:

Element

Description

Valid Values

populateRaw

Determines if the initial measurement 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

destinationRootElementEvent

Holds the name of inbound web service for the device event seeder.

destinationRootElementIMD

Holds the name of inbound web service for the IMD seeder.

The runtime configuration settings for the SGG-DG-XML-CM project are stored in the EnvironmentSettings.xq xquery file. You can use this file to adjust initial measurement and 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 SGG-DG-XML-CM EnvironmentSettings.xq file:

Element

Description

Valid Values

populateRawIMD

Determines if the initial measurement 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 IMD seeder.

For additional information about the sample OSB implementation included in the Oracle Utilities Smart Grid Gateway Adapter Development Kit, see Oracle Service Bus Processing.

Processing Large Input Files

In some environments, the OSB project may begin processing a large input file before it has been completely copied to the input directory. To prevent this, configure the MinimumAge property in the “InboundProxyService” proxy service for the SGG-DG-CSV-CM and SGG-DG-XML-CM projects. The MinimumAge property specifies the minimum age of files to be retrieved, based on the last modified time stamp. This enables large files to be completely copied to the input directory before they are retrieved for processing.

Processing Data in the Adapter Development Kit Native Format

Usage and event data exported from the AMI head-end system can be loaded into Oracle Utilities in the “native” initial measurement and device event data formats (the format of the initial measurement and device event seeder business objects). You can customize processing of this by configuring the following base product OSB projects:

  1. SGG-DG-SEEDER-BASE contains components that are not to be changed on customer site. They implement functions specific to the IMD and event upload format processing such as validation and transformation.

  2. SGG-DG-SEEDER-CM allows for customization and simplifies future upgrades.

The runtime configuration settings for the SGG-DG-SEEDER-CM project are stored in the EnvironmentSettings.xq xquery file. You can use this file to adjust initial measurement and 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 SGG-DG-SEEDER-CM EnvironmentSettings.xq file:

Element

Description

Valid Values

callPreProcessing

Determines if the preprocessing proxy service is called.

true

false

callPostProcessing

Determines if the postprocessing proxy service is called.

true

false

destinationRootElementInterval

Holds the name of inbound web service for the interval IMD seeder.

destinationRootElementScalar

Holds the name of inbound web service for the scalar IMD seeder. In most cases it is the same as destinationRootElementInterval.

destinationRootElementEvent

Holds the name of inbound web service for the device event seeder.

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

filterUsage

Determines if usage should be filtered.

true

false

See The Adapter Development Kit Native Format for more information about the ADK “native” format.

Publishing Initial Measurement Data and Device Events

The Adapter Development Kit can be configured to publish initial measurement data and 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 Data 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-DG-SEEDER-CM OSB project are used in publishing measurement data and device events 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 Publishing Output

The SGGDRIntegration BPEL composite handles publishing the data to Oracle DataRaker or other systems.

Initial measurement and device event data is published in the “native” initial measurement data format (the format of the initial measurement and device event seeder business objects). This format includes normalized unit of measure, condition, and device event codes. See the Oracle Utilities Smart Grid Gateway Adapter Development Kit Administrative User Guide for more details about this format.
Note: Initial measurement data published via this feature is published prior to VEE processing. In addition, filtering can NOT be applied to initial measurement or device event data 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 Initial Measurement Data

The Adapter Development Kit can be configured to filter initial measurement data passed into Oracle Utilities Smart Grid Gateway and Meter Data Management. Filtering data is enabled by setting the <filterUsage> element in the EnvironmentSettings.xq file to “true” as follows:
<filterUsage>true</filterUsage>

When filtering is enabled, only measurements whose <externalUOM> matches one of the values defined in the ADK - UOM Code to Standard UOM Mapping extendable lookup (DG-HeadendUOMLookup) are passed into the system for processing.

Filtering Events

The Adapter Development Kit can be configured to filter device events passed into Oracle Utilities Smart Grid Gateway and Meter Data Management. Filtering data is enabled by setting the <filterEvents> 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 ADK - Device Event Mapping extendable lookup (DG-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-D3-CIM-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 colulmn.

  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.