Setting Up Oracle Utilities Customer to Meter
The following sections provide details into the Oracle Utilities Customer to Meter configurations needed to facilitate the integration. Some configurations described may be required for general functionality and do not necessarily relate directly to the integration; however these are called out as particularly significant configuration items. The inclusion of such items does not mean that other general items that are not mention do not need to be configured.
For more information on configuring and working with Oracle Utilities Customer to Meter, see the Oracle Utilities Customer to Meter documentation.
At a high-level, you will complete the following steps in Oracle Utilities Customer to Meter to support the integration:
Configuring Administrative Tables
This section describes unique setup issues specifically related to configuring your system for the integration.
Characteristic Types
The following characteristic types must be defined to facilitate the integration. For Oracle Utilities Customer Care and Billing and Oracle Utilities Meter Data Management (separate instance) implementations, the Critical Customer characteristic type is defined in Oracle Utilities Meter Data Management. The remaining characteristic types are defined in Oracle Utilities Customer Care and Billing.
 
Characteristic Type
Guideline
Characteristic Entity Collection
Corresponding DVM
Critical Customer
• Service Point characteristic used to define the critical customer for the service point.
• Pre-defined characteristic type
• The critical customer pre-defined values listed here must be defined in the NMS Sync Integration master configuration, under the Critical Customer Types Characteristics Mapping section.
Include Service Point
 
Location City
• Characteristic used to identify the location city for an outage without a premise.
• Adhoc characteristic type
Include Service Task
N/A
Location State
• Characteristic used to identify the location state for an outage without a premise.
• Adhoc characteristic type
Include Service Task
N/A
Location 1
• Characteristic used to identify a location used for an outage without a premise. (The location would be either a street name for location type street segment or intersection street1 for location type street intersection).
• Adhoc characteristic type
Include Service Task
N/A
Location 2
• Characteristic used to identify a location (intersection street2) used to for an outage without a premise if the location type is a street intersection.
• Adhoc characteristic type
Include Service Task
N/A
Block Number
• Characteristic used to identify a block number used for an outage without a premise if the location type is a street segment.
• Adhoc characteristic type
• The Block Number adhoc value must be numeric.
Include Service Task
N/A
Contact Name
• Characteristic used to identify a contact name used for an outage without a premise.
• Adhoc characteristic type
Include Service Task
N/A
Contact Number
• Characteristic used to identify a contact number used for an outage without a premise.
• Adhoc characteristic type
Include Service Task
N/A
Call Identifier
• Characteristic used to identify a call identifier used for an outage without a premise.
• Adhoc characteristic type
Include Service Task
N/A
Outage Codes
1 - N
• These characteristics are used to describe the outage problem.
• Create at least one and up to N pre-defined characteristic type. N being the number of outage codes needed by the implementation.
• For each characteristic type, define its list of valid values
Include Service Task
N/A
Feature Configuration
To create a new feature configuration complete the following:
Schema Constants
To create new feature configuration with Schema Constants:
1. Navigate to Admin > General > Feature Configuration.
2. Create new feature configuration with Schema Constants as the Feature Type or select a feature configuration with Schema Constants as the Feature Type if one already exists.
3. Enter required option types and values needed:
Option
Notes
Home Phone Type
The user defined home phone number type code. The Option Value must be set as a valid Phone Number Type defined in the Phone Type table.
Business Phone Type
The user defined business phone number type code. The Option Value must be set as a valid Phone Number Type defined in the Phone Type table.
Device Geographic Type
The user defined device ID geo type code. The Option Value must be set as a valid Geographic Type defined in the Geographic Type table.
Outage Call Contact Name Characteristic Type
The characteristic type code your implementation uses to capture a contact name on a trouble call. The Option Value must be set as a valid Characteristic Type defined in the Characteristic Type table.
Outage Call Contact Number Characteristic Type
The characteristic type code your implementation uses to capture a contact number on a trouble call. The Option Value must be set as a valid Characteristic Type defined in the Characteristic Type table.
Outage Call Identifier Characteristic Type
The characteristic type code your implementation uses to capture a call identifier on a trouble call. The Option Value must be set as a valid Characteristic Type defined in the Characteristic Type table.
Outage Call Street Name Characteristic Type
The characteristic type code your implementation uses to capture a street name on a trouble call. The Option Value must be set as a valid Characteristic Type defined in the Characteristic Type table.
Outage Call Cross Street Name Characteristic Type
The characteristic type code your implementation uses to capture a cross street name on a trouble call. The Option Value must be set as a valid Characteristic Type defined in the Characteristic Type table.
Outage Call Block Number Characteristic Type
The characteristic type code your implementation uses to capture a block number on a trouble call. The Option Value must be set as a valid Characteristic Type defined in the Characteristic Type table.
Outage Call City Characteristic Type
The characteristic type code your implementation uses to capture a city on a trouble call. The Option Value must be set as a valid Characteristic Type defined in the Characteristic Type table.
Outage Call State Characteristic Type
The characteristic type code your implementation uses to capture a state on a trouble call. The Option Value must be set as a valid Characteristic Type defined in the Characteristic Type table.
Master Configuration
To create new master configuration with the Oracle Utilities Network Management System integration:
1. Navigate to Admin > General > Feature Configuration.
2. Create a new master configuration for the NMS Outage Integration Master Config or broadcast the master configuration if one already exists. Refer to the embedded help for more information.
For Oracle Utilities Customer Care and Billing and Oracle Utilities Meter Data Management (separate instance) implementations, this is configured in Oracle Utilities Customer Care and Billing.
3. Create a new master configuration for the NMS Sync Integration Master Config or broadcast the master configuration if one already exists. Refer to the embedded help for more information.
4. For Oracle Utilities Customer Care and Billing and Oracle Utilities Meter Data Management (separate instance) implementations, this is configured in Oracle Utilities Meter Data Management.
Service Type
Every service point type references a service type. The service type defines the type of service you provide to your customer (i.e. electric, water, gas).
The codes defined here must exactly match the values defined in the DVM specified below.
Navigation
Guideline
Corresponding DVM
Admin > General > Service Type
Define your service types
OUC2M_OUNMS_AccountType
Device Type
Every meter or item references a device type. The device type defines the type of service and common characteristics shared by its meters and items.
The codes defined here must match the values defined in the DVM specified below.
Navigation
Guideline
Corresponding DVM
Admin > Device > Device Type
Define your device types.
OUC2M_OUNMS_MeterType
Configuring the Sync Request Process
The Sync Request Process is used to synchronize customer data from Oracle Utilities Customer to Meter to Oracle Utilities Network Management System.
For Oracle Utilities Customer Care and Billing and Oracle Utilities Meter Data Management (separate instance) implementations, this is configured in Oracle Utilities Meter Data Management.
Batch Code
This is the batch process to run the sync request. It is a generic batch process that is used for different sync processes. It has a couple of parameters that can be used to control which sync request BOs to process.
Batch
Description
F1-SYNRQ
Sync Request Monitor Process
 
Batch Parameters
Parameter Description
Value
maintenanceObject
Sync Request maintenance object
F1-SYNC REQ
(The defaulted value.)
isRestrictedByBatch
Code
The value of true restricts processing to sync requests whose current state is linked to this batch code.
 
restrictToBusiness
Object
Enter a business object code here to limit the process to sync requests linked to this business object.
D1-NMSSP
CustomerSyncRequest
(To run only the NMS customer sync request, populate this value)
restrictToBOStatus
Enter a status code here to limit the process to sync requests in this state.
PENDING
(To only process sync request, in Pending status, populate this value)
This is the batch process to run the initial load sync request. It has a couple of parameters that can be used to control which sync request BOs to process.
Batch
Description
D1-NMSSP
NMS SP Customer Sync Initial Load
 
Batch Parameters
Parameter Description
Value
syncRequestMO
Maintenance Object
D1-SP
(This is the defaulted value.)
syncRequestBO
Enter a business object code here to limit the process to sync requests linked to this business object.
D1-NMSSPCustomerSync
Request
filterAlgorithm
Enter a filter algorithm here to limit the process to sync requests that should be sent to Oracle Utilities Network Management System.
D1-NMSSPCustomerSync
Request
(This algorithm filters for eligible service point types as defined in the NMS Sync Integration Master Configuration.)
MO Algorithms
Configure the MO Audit algorithms. MO Audit algorithms contain the logic to instantiate a sync request (as long as one does not already exist in the initial state for the MO-Primary Keys combination). A generic algorithm F1-GCHG-CDCP comes with the base product and is plugged in on MOs that need to instantiate sync requests for the same MO. This algorithm instantiates the BOs defined in the Sync Request BO MO Option (see Maintenance Objects below). For MOs that need a sync request instantiated for a different MO (For example: changes to the Person or Account MO need to be communicated via an SP sync request) need unique algorithms that contain this logic.
Algorithm Type
Description
D1-CUSCDCSP
This algorithm instantiates SP-based sync request whenever a change to the Contact MO is detected (updating a person record in C2M triggers an internal sync to the contact record, which in turn will trigger this audit algorithm). Define the D1-NMSSPCustomerSyncRequest sync request BO to be instantiated in the algorithm's parameters.
D1-USCDCSP
This algorithm instantiates SP-based sync request whenever a change to the Usage Subscription MO is detected (updating a SA record in C2M triggers an internal sync to the usage subscription record, which in turn will trigger this audit algorithm). Define the D1-NMSSPCustomerSyncRequest sync request BO to be instantiated in the algorithm's parameters.
D1-SPIE-CDCP
This algorithm instantiates SP-based sync request whenever a change to the Install Event MO is detected. Define the D1-NMSSPCustomerSyncRequest sync request BO to be instantiated in the algorithm's parameters.
D1-SPDV-CDCP
This algorithm instantiates SP-based sync request whenever a change to the Device MO is detected. Define the D1-NMSSPCustomerSyncRequest sync request BO to be instantiated in the algorithm's parameters.
Maintenance Objects
Maintenance Objects
Description
D1-CONTACT
Specify the MO Audit algorithm configured in the previous section.
D1-US
Specify the MO Audit algorithm configured in the previous section.
D1-INSTLEVT
Specify the MO Audit algorithm configured in the previous section.
D1-DEVICE
Specify the MO Audit algorithm configured in the previous section.
D1-SP
Specify the generic MO Audit algorithm F1-GCHG-CDCP. Also, specify the D1-NMSSPCustomerSyncRequest BO in the Sync Request BO MO Option.
Business Objects
Business Object
Description
D1-NMSSPCustomer
SyncRequest
This business object defines the behavior of the outbound sync request for NMS. It contains the schema elements monitored and synchronized to NMS.
 
The following must be configured and defined on the NMS Sync Integration master configuration as they are necessary to create the outbound sync request:
 
• Outbound Message Type: This contains a reference to the outbound message BO to use. The base package includes BO D1-NMSSPCustomerSyncReqOutMsg for the NMS SP Sync. Refer to the Defining Outbound Message Types section in the user documentation for more information.
• External System: This contains the reference to the outbound message type and its corresponding configuration for communicating with the external system. The base package includes the message D1-NMSSPCustomerSyncReqOutMsg.xsl. Refer to the External Systems section in the user documentation for more information.
• Specify the pre-processing algorithm configured in the previous section.
• Specify the time out algorithm as a monitor algorithm on the Awaiting Acknowledgement state for this BO.
• Specify the To Do creation algorithm on the Error state for this BO Depending on the technology used to communicate the sync request to the external system, you may need to create your own enter algorithm and plug it into the Send Request state.
For more information about the sync request process, the business objects, maintenance objects and other components use for this process, see the Data Synchronization section in the Oracle Utilities Framework User Guide.
Message Sender for Customer Data Sync
Perform the following steps to create a real-time Message Sender configured to communicate with the integration layer
1. Navigate to Admin > Integration > Message Server.
2. Enter a unique Message Sender and Description.
3. Populate values:
• Invocation Type: Real-time
• Message Class: SOAPSNDR (Sender for real-time HTTP / SOAP messages)
• Active: Select the checkbox
• MSG Encoding: UTF-8 message encoding
4. Select the Context tab and set values for the following context types:
• HTTP Header: SOAPAction:"process"
• HTTP Login User: User ID to access Integration BPEL process
• HTTP Password: Password to access Integration BPEL process
• HTTP Method (POST/GET): POST
• HTTP Timeout: 60
• HTTP Transport Method: SendReceive
• HTTP URL 1: Set the URL to be accessed. If the URL value does not fit, use the additional HTTP URL types to set the complete URL. This should point to the Customer Data Sync webservice.
Message Sender for Submit Trouble Call Interface
Perform the following steps to create a new Message Sender which points to the Trouble Call Interface EBF endpoint URL for the Trouble Call Interface the integration point:
1. Navigate to Admin >Integration >Message Sender.
2. Enter a unique Message Sender and Description.
3. Populate values:
• Invocation Type: Real-time
• Message Class: RTHTTPSNDR (Sender for real-time HTTP messages)
• Active: Select the checkbox
• MSG Encoding: UTF-8 message encoding
4. Select the Context tab and set values for the following Context Types:
• HTTP Login User: User ID for the URL to be accessed
• HTTP Login Password: Password for the URL to be accessed
• HTTP Header: SOAPAction: "process"
• HTTP Method (POST/GET): POST
• HTTP Proxy Host: Set the proxy server name if applicable
• HTTP Proxy Port: Port for the proxy server if applicable
• HTTP Transport Method: SendReceive
• HTTP Timeout: 60
• HTTP URL 1: Set the URL to be accessed. If the URL value does not fit, use the additional HTTP URL types to set the complete URL. This should point to the Submit Trouble Call webservice.
Example:
http://demoenv/soa-infra/services/C2M-NMS/OUC2MOUNMSSubmitTroubleCallEBF/OUC2MOUNMSSubmitTroubleCallEBF_ep
Message Sender for Job History Query
To create the Message Sender configured to communicate with the integration layer:
1. Navigate to Admin > Integration > Message Sender.
2. Enter a unique Message Sender and description.
3. Populate values:
• Invocation Type: Real-time
• Message Class: RTHTTPSNDR (Sender for real-time HTTP messages)
• Active: Select the checkbox
• MSG Encoding: UTF-8 message encoding
4. Select the Context tab and set values for the following context types:
• HTTP Login User: User ID for the URL to be accessed
• HTTP Login Password: Password for the URL to be accessed
• HTTP Header: SOAPAction: "process"
• HTTP Method (POST/GET): POST
• HTTP Proxy Host: Set the proxy server name if applicable
• HTTP Proxy Port: Port for the proxy server if applicable
• HTTP Transport Method: SendReceive
• HTTP Timeout: 60 (put timeout in seconds)
• HTTP URL 1: Set the URL to be accessed. If the URL value does not fit, use the additional HTTP URL types to set the complete URL. This should point to the Query Job History EBF.
Example:
http://demoenv/soa-infra/services/C2M-NMS/OUC2MOUNMSJobHistoryQueryEBF/ouc2mounmsjobhistoryqueryebf_client_ep
Message Sender for Trouble Call History Query
To create Message Sender for Trouble Call History Query:
1. Navigate to Admin > Integration > Message Sender.
2. Enter a unique Message Sender and Description.
3. Populate the following values:
• Invocation Type: Real-time
• Message Class: RTHTTPSNDR (Sender for real-time HTTP messages)
• Select the Active checkbox.
• MSG Encoding: UTF-8 message encoding
4. Select the Context tab and set values for the following Context Types:
• HTTP Login User: User ID for the URL to be accessed
• HTTP Login Password: Password for the URL to be accessed
• HTTP Header: SOAPAction: "process"
• HTTP Method (POST/GET): POST
• HTTP Proxy Host: Set the proxy server name if applicable
• HTTP Proxy Port: Port for the proxy server if applicable
• HTTP Transport Method: SendReceive
• HTTP Timeout: 60 (put timeout in seconds)
• HTTP URL 1: Set the URL to be accessed. If the URL value does not fit, use the additional HTTP URL types to set the complete URL. This should point to the Query Trouble Call History webservice.
Example: http://demoenv/soa-infra/services/C2M-NMS/OUC2MOUNMSTroubleCallsQueryEBF/OUC2MOUNMSTroubleCallsQueryEBF_ep
Message Sender for Planned Outages Query
Create a new Message Sender which points to the Planned Outages Query EBF endpoint URL for Planned Outages Query the integration point.
To create an HTTP sender configured to communicate with the integration layer:
1. Navigate to Admin > Integration > Message Sender.
2. Enter a unique Message Sender and Description.
3. Populate values:
• Invocation Type: Real-time
• Message Class: RTHTTPSNDR (Sender for real-time HTTP messages)
• Select the Active checkbox.
• MSG Encoding: UTF-8 message encoding
4. Select the Context tab and set values for the following Context Types:
• HTTP Login User: User ID for the URL to be accessed
• HTTP Login Password: Password for the URL to be accessed
• HTTP Header: SOAPAction: "process"
• HTTP Method (POST/GET): POST
• HTTP Proxy Host: Set the proxy server name if applicable
• HTTP Proxy Port: Port for the proxy server if applicable
• HTTP Transport Method: SendReceive
• HTTP Timeout: 60 (put timeout in seconds)
• HTTP URL 1: Set the URL to be accessed. If the URL value does not fit, use the additional HTTP URL types to set the complete URL. This should point to the Query Planned Outage webservice.
Example: http://demoenv/soa-infra/services/C2M-NMS/OUC2MOUNMSPlannedOutagesQueryEBF/ouccbounmsplannedoutagesqueryebf_client_ep
Customer Sync Interface
1. Navigate to Admin menu > O > Outbound Message Type.
2. Enter a unique Outbound Message Type and Description.
3. Populate the following values:
• Business Object: NMS-MDSYNC (Customer Sync Outbound Message BO)
• Priority: (choose from the selection)
Submit Trouble Calls Interface
1. Navigate to Admin menu > O > Outbound Message Type.
2. Enter a unique Outbound Message Type and Description.
3. Populate the following values:
• Business Object: C1-NMSOUTCAL (Submit Calls Outbound Message BO)
• Priority: (choose from the selection)
Query Job History Interface
1. Navigate to Admin menu > O > Outbound Message Type.
2. Enter a unique Outbound Message Type and Description.
3. Populate the following values:
• Business Object: C1-NMSJOBHST (Job History Query Outbound Message BO)
• Priority: (choose from the selection)
Query Trouble Call History Interface
1. Navigate to Admin menu > O > Outbound Message Type.
2. Enter a unique Outbound Message Type and Description.
3. Populate the following values:
• Business Object: C1-NMSCALHST (Call History Query Outbound Message BO)
• Priority: (choose from the selection)
Query Planned Outages Interface
1. Navigate to Admin menu > O > Outbound Message Type.
2. Enter a unique Outbound Message Type and Description.
3. Populate the following values:
• Business Object: C1-NMSPLNOUT (Planned Outages Query Outbound Message BO)
• Priority: (choose from the selection)
External System
When you place an XSL file on Outbound Message Type, search for the file/managed content entry.
Note: The system supports defining XSLs as a managed content record. For backward compatibility, the system supports defining XSL as a file in the file system. This is a system wide setting that is defined using the Feature Configuration page. The Feature Type is “External Messages” and Option Type is “XSL Location”. Set the value to “F1FL” to support XSL in the file system. The file location is configured using a system property. To support XSL in managed content, no option is needed since it is the default. You may explicitly define the “F1MC” value, if required.
To create a new External System for direct integration:
1. Navigate to Admin menu > E > External System.
2. Enter a unique External System and Description.
3. Set Our Name in Their System to C2M.
4. Define the Outbound Message Types associated to the integration.
• For Customer Data Synchronization Outbound Message Type, populate the following values:
• Outbound Message Type: (Outbound Message Type for Customer Data Synchronization)
• Processing Method: Real-time
• Message Sender: (Message Sender for Customer Data Synchronization)
• Message XSL: D1-NMSSPCustomerSyncReqOutMsg.xsl
• Response XSL:
• For Submit Trouble Calls Interface Outbound Message Type, populate the following values:
• Outbound Message Type: (Outbound Message Type for Trouble Call Interface)
• Processing Method: Real-time
• Message Sender: (Message Sender for Trouble Call Interface)
• Message XSL: CDxAddEnvelope-SOAP1-2.xsl
• Response XSL:
• For Query Job History Outbound Message Type, populate the following values:
• Outbound Message Type: (Outbound Message Type for Job History Query)
• Processing Method: Real-time
• Message Sender: (Message Sender for Job History Query)
• Message XSL: CDxAddEnvelope-SOAP1-2.xsl
• Response XSL: C1-NMSRemoveEnvelopeJobHist.xsl
• For Query Trouble Call History Outbound Message Type, populate the following values:
• Outbound Message Type: (Outbound Message Type for Trouble Call History Query)
• Processing Method: Real-time
• Message Sender: (Message Sender for Trouble Call History Query)
• Message XSL: CDxAddEnvelope-SOAP1-2.xsl
• Response XSL: C1-NMSRemoveEnvelopeCallHist.xsl
• For Query Planned Outages Outbound Message Type, populate the following values:
• Outbound Message Type: (Outbound Message Type for Planned Outages Query)
• Processing Method: Real-time
• Message Sender: (Message Sender for Planned Outages Query)
• Message XSL: CDxAddEnvelope-SOAP1-2.xsl
• Response XSL: C1-NMSRemoveEnvelopePlanOut.xsl