Configuring the Product Use Metrics Dashboard

This section describes the process for configuring the Product Use Metrics dashboard used with Oracle Utilities applications, including Oracle Utilities Billing Cloud Service (BCS), Oracle Utilities Customer to Meter (C2M), Oracle Utilities Customer Care and Billing (CCB), Oracle Utilities Customer Care and Billing Cloud Service (CCSBCS), Oracle Utilities Customer Cloud Service (CCS), Oracle Utilities Meter Data Management (MDM), Oracle Utilities Meter Solution Cloud Service (MSCS), Oracle Utilities Work and Asset Management (WAM), and Oracle Utilities Work and Asset Cloud Service (WACS).

The Product Use Metrics dashboard displays customer counts such as device counts, channels of an active meters, number of billable services, head end device counts, and other similar data. The data presented on each dashboard is tailored to provide summary information for management. Refer to Product / Metrics for more information about this dashboard.

The dashboard contains a number of zones based on the product you're using. The table below lists the zones and the products for which they are available.

Zone Products Uses Statistics Snapshots
Asset Count BCS, C2M, CCS, WAM, WACS No
Billable Services by CIS Division BCS, C2M, CCB, CCBCS, CCS Yes
Billable Services by SA Type BCS, C2M, CCB, CCBCS, CCS Yes
Billable Services by Service Type BCS, C2M, CCB, CCBCS, CCS Yes
Channel Counts BCS, C2M, CCS, MDM, MSCS Yes
Device Counts BCS, C2M, CCS, MDM, MSCS Yes
Head End Device Count BCS, C2M, CCS, MDM, MSCS Yes
Usage Subscription Customer Count BCS, C2M, CCS, MDM, MSCS Yes
User Count BCS, C2M, CCS, WAM, WACS No

Several of the zones on this dashboard leverage a method of pre-staging data known as Statistics Snapshots. See Understanding Statistics for more information on Statistics Snapshots.

Configuring the Product Use Metrics dashboard includes the following:

Configure Statistics Category Lookup Value

Statistic Controls (see below) reference a "Statistics Category" defined as a value for the Statistics Category lookup (STAT_​CATEGORY_​FLG). Create a value for this lookup as follows:
  • Field: PUMT
  • Description: Product Use Metrics
  • Java Field Name: productUseMetrics
  • Status: Active

Configure Statistic Control and Statistic Snapshots

Statistic Controls are the source for capturing the numbers of active devices, channels on active meters, billable services, and device counts per head end system.

Statistic Snapshots capture the numbers for each metric. Statistic Controls are configuration records that define the specific types of metrics to capture.

Statistic Snapshots are captured periodically via the F1-STATS (Statistics Control Monitor) batch program.

Configure the following Statistics Control records:

Statistics Control

Description

Category

Status

Snapshot Frequency Hours

Retention Mode

Snapshot Business Object

CHANNEL-COUNT

Channel Count

Product Use Metrics

Active

1.00

Only Retain Most Recent Snapshot

Channel Count Snapshot

DEVICE-COUNT

Device Count

Product Use Metrics

Active

1.00

Only Retain Most Recent Snapshot

Device Count Snapshot

HEAD-END-DEVICE-COUNT

Head End Device Count

Product Use Metrics

Active

1.00

Only Retain Most Recent Snapshot

Head End Device Count Snapshot

US-CUSTOMER-COUNT

Usage Subscription Customer Count

Product Use Metrics

Active

1.00

Only Retain Most Recent Snapshot

Usage Subscription Customer Count Snapshot

BILLABLE-SERVICES

Billable Services by Service Type, SA Type, and CIS Division

Product Use Metrics

Active

24.00

Retain All Snapshots

Billable Services Statistics Snapshot

See Capturing Statistics for more information about statistics.

Configure Device Count and Channel Count Snapshot Business Objects and Algorithms (Optional)

By default, the Device Count Snapshot and Channel Count Snapshot business objects check for active usage subscriptions when deriving the total count of active devices and measuring components. However, in some implementations this is not required or appropriate.

The usage subscription check can be disabled if needed by setting the "Exclude US Check (Y or N)" parameter on the "Create XXXXX Count Shapshot" Enter algorithms on the Complete state of the Snapshot business objects to "Y" (this parameter is set to "N" by default).

The table below lists the snapshot business objects and their respective algorithms.

Snapshot Business Object

Count Snapshot Algorithm

Channel Count Snapshot (D1-ChannelCountSnapshot)

Create Channel Count Snapshot (D1-CHLCNTSNP)

Device Count Snapshot (D1-DeviceCountSnapshot)

Create Device Count Snapshot (D1DVCCNTSNP)

Configure Customer Metrics Dashboard Configuration Master Configuration (Optional)

The Customer Metrics Dashboard Configuration master configuration defines properties used with the Billable Services zones in the Products Use Metrics dashboard, including:
  • Water Service Types and Waste Water Service Type
  • Excluded Billable SA Types
  • Excluded Debt Classes
  • Service Type Colors
  • CIS Division Colors

Use the Master Configuration portal to configure this master configuration as appropriate for your implementation.

Configure Statistics Control Business Object

The Statistics Control (F1-Statistics) business object should be configured to specify the "Statistics Control Monitor"  batch control in the Monitor Process drop-down list on the "Active" state.

To configure this business object, do the following:

  1. Open the Statistics Control (F1-Statistics) business object in the Business Object portal.

  2. Navigate to the Lifecycle tab, and expand the "Active" state.

  3. Select "Statistics Control Monitor" from the Monitor Process drop-down list.

  4. Click Save.

Batch Processing

The Product Use Metrics dashboard is configured to be refreshed periodically. To refresh the data used in the dashboard, the following batch processes should be processed in sequence after other regularly schedule batch processing is complete.

  • F1-STATS (Statistics Control Monitor): Used to generate Statistic Snapshots based on Statistic Controls.

Use the following parameters when running this batch process:

  • Maintenance Object (maintenanceObject): F1-STATS

  • Restrict by Business Object (restrictToBusinessObject): F1-Statistics

  • Restrict by Status Code (restrictToBOStatus): ACTIVE