Setting Up Oracle Utilities Customer Care and Billing
The following sections provide details about the Oracle Utilities Customer Care and Billing 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 Care and Billing, see the Oracle Utilities Customer Care and Billing standard documentation.
At a high-level, you will complete the following steps in Oracle Utilities Customer Care and Billing to support the integration:
Configuring Administrative Tables
This section describes unique setup issues specifically related to configuring your system for the integration.
For more information about configuring Oracle Utilities Customer Care and Billing, refer to the Setting up the System to Enable FA Integration section in the Oracle Utilities Customer Care and Billing User Guide.
Characteristic Types
The following characteristic types must be defined to facilitate the integration:
Characteristic Type
Guideline
Characteristic Entity Collection
Corresponding DVM
Critical Priority Characteristic Type
• Premise characteristic used to define the critical priority for the premise.
• Pre-defined characteristic type.
• The pre-defined values listed here must exactly match values in the DVM for CCB Critical Priority Code.
Include Premise
OUCCB_OUNMS_Serv_C_Priority
Medical Priority Characteristic Type
• Premise characteristic used to define the medical priority for the premise.
• Pre-defined characteristic type.
• The pre-defined values listed here must exactly match values in the DVM for CCB Medical Priority Code.
Include Premise
OUCCB_OUNMS_Serv_D_Priority
Key Priority Characteristic Type
• Premise characteristic used to define the key priority for the premise.
• Pre-defined characteristic type.
• The pre-defined values listed here must exactly match values in the DVM for CCB Key Priority Code.
Include Premise
OUCCB_OUNMS_Serv_K_Priority
Location City
• Characteristic used to identify the location city for an outage without a premise.
• Adhoc characteristic type.
• CCB Demo Data: CI_CITY (Sample).
Include Service Task.
N/A
Location State
• Characteristic used to identify the location state for an outage without a premise .
• Adhoc characteristic type.
• CCB Demo Data: CI_STATE (Sample).
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.
• CCB Demo Data: CI_LOCN1 (Sample).
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.
• CCB Demo Data: CI_LOCN2 (Sample)
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.
• CCB Demo Data: CI_BLKNBR (Sample)
Include Service Task.
 
N/A
Contact Name
• Characteristic used to identify a contact name used for an outage without a premise.
• Adhoc characteristic type.
• CCB Demo Data: CI_CNTNM (Sample).
Include Service Task.
 
N/A
Contact Number
• Characteristic used to identify a contact number used for an outage without a premise.
• Adhoc characteristic type.
• CCB Demo Data: CI_CNTPN (Sample).
Include Service Task.
 
N/A
Call Identifier
• Characteristic used to identify a call identifier used for an outage without a premise.
• Adhoc characteristic type.
• CCB Demo Data: CI_CALL (Sample).
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
• CCB Demo Data: CI_OUT01, CI_OUT02, CI_OUT03, CI_OUT04, CI_OUT05, CI_OUT06, CI_OUT07, CI_OUT08, CI_OUT09 (Samples)
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, perform the following steps:
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.
Critical Priority Characteristic Type
The user defined critical priority characteristic type code. The Option Value must be set as a valid Characteristic Type defined in the Characteristic Type table.
Medical Priority Characteristic Type
The user defined medical priority characteristic type code. The Option Value must be set as a valid Characteristic Type defined in the Characteristic Type table.
Key Priority Characteristic Type
The user defined key priority characteristic type code. The Option Value must be set as a valid Characteristic Type defined in the Characteristic 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.
Oracle Utilities Network Management System Integration
To create new feature configuration with the Oracle Utilities Network Management System Integration, perform the following steps:
1. Navigate to Admin > General > Feature Configuration.
2. Create a new feature configuration with NMS Integration as the Feature Type or select a feature configuration with NMS Integration as the Feature Type if one already exists.
3. Enter the required option types and values as needed:
Option
Notes
External System
Defines the external system used for query outbound messages created from the outage management information portal page. The Option Value must be set as a valid External System defined in the External System table.
Outbound Message Type - Call History
Defines the outbound message type used for the call history query outbound messages created from the outage management information portal page. The Option Value must be set as a valid Outbound Message Type defined in the Outbound Message Type table.
Outbound Message Type - Job History
Defines the outbound message type used for the job history query outbound messages created from the outage management information portal page. The Option Value must be set as a valid Outbound Message Type defined in the Outbound Message Type table.
Outbound Message Type - Call History
Defines the outbound message type used for the planned outage query outbound messages created from the outage management information portal page. The Option Value must be set as a valid Outbound Message Type defined in the Outbound Message Type table.
Outage Group Code Characteristic Type Prefix
Defines the prefix used for trouble call outage group code characteristic types. The system uses this to build a drop-down of outage group codes during trouble call processing. The Option Value must be set as a valid Characteristic Type defined in the Characteristic Type table.
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.
OUCCB_OUNMS_AccountType
Meter Type
Every meter references a meter type. The meter type defines the type of service and common characteristics shared by its meters.
The codes defined here must match the values defined in the DVM specified below.
Navigation
Guideline
Corresponding DVM
Admin > Device > Meter Type
Define your meter types.
OUCCB_OUNMS_MeterType
Configure the Sync Request Process
The Sync Request Process is used to synchronize customer data from Oracle Utilities Customer Care and Billing to Oracle Utilities Network Management System.
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
(This is the defaulted value.)
isRestrictedByBatchCode
The value of true restricts processing to sync requests whose current state is linked to this batch code.
 
restrictToBusinessObject
Enter a business object code here to limit the process to sync requests linked to this business object.
C1-NMSSPSyncRequest
(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)_.
BO Algorithms
Algorithm Type
Description
C1-CAPNMSSPI
This pre-processing algorithm creates the initial snapshot for the sync request.
Refer to the algorithm description in the system for details on how to specify the parameters below:
• Define the read BOs the algorithms use to build the initial/final snapshot. The base product provides C1-NMSPerson, C1-NMSAccount, C1-NMSSA, C1-NMSSP, MDMPremise, C1-NMSMeter, and C1-NMSItem for this purpose. If additional elements are needed in the sync request, your implementation may create a child of any of these BOs and add the element under a group called <customElements>. This ensures that the elements are included in the sync request message at the proper group nodes. With this set up any custom translation can be implemented at the integration layer.
• Define the data area that holds the elements needed in the snapshot. The base product provides C1-NMSSPBasedSnapshot for this purpose. Your implementation should not have to create a custom data area as this already provides <customElements> nodes throughout its schema to allow for the addition of any elements not included in the base solution.
C1-MDM-TMOT
This monitor algorithm sets a timeout limit on the receipt of a response from the external system. Define the number of hours your implementation wishes to wait for a response from NMS before transitioning the sync request into the Error state.
F1-TD-CREATE
This algorithm creates a To Do Entry. At a minimum, your implementation will have to define the To Do Type to use in creating the To Do Entry and the Characteristic Type For Log Entry to be used in linking the To Do Entry to the sync request via its logs. The base product provides F1-SYNRQ and F1-TODO, respectively, for this purpose. For details on the other parameters used by this algorithm, see the algorithm type description.
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
C1-PERCDCSP
This algorithm instantiates SP-based sync request whenever a change to the Person MO is detected. Define the sync request BO to be instantiated in the algorithm’s parameters.
C1-ACCTCDCSP
This algorithm instantiates an SP-based sync request whenever a change to the Account MO is detected. Define the sync request BO to be instantiated in the algorithm’s parameters.
C1-SACDCSP
This algorithm instantiates SP-based sync request whenever a change to the SA MO is detected. Define the sync request BO to be instantiated in the algorithm’s parameters.
C1-PREMCDCSP
This algorithm instantiates SP-based sync request whenever a change to the Premise MO is detected. Define the sync request BO to be instantiated in the algorithm’s parameters.
C1-SPICDCSP
This algorithm instantiates SP-based sync request whenever a change to the SP/Item MO is detected. Define the sync request BO to be instantiated in the algorithm’s parameters.
C1-SPMCDCSP
This algorithm instantiates SP-based sync request whenever a change to the SP/Meter MO is detected. Define the sync request BO to be instantiated in the algorithm’s parameters.
C1-ITEMCDCSP
This algorithm instantiates SP-based sync request whenever a change to the Item MO is detected. Define the sync request BO to be instantiated in the algorithm’s parameters.
C1-MTRCDCSP
This algorithm instantiates SP-based sync request whenever a change to the Meter MO is detected. Define the sync request BO to be instantiated in the algorithm’s parameters.
Maintenance Objects
Maintenance Objects
Description
PERSON
Specify the MO Audit algorithm configured in the previous section.
ACCOUNT
Specify the MO Audit algorithm configured in the previous section.
SA
Specify the MO Audit algorithm configured in the previous section.
SP
Specify the generic MO Audit algorithm F1-GCHG-CDCP. Also, specify the C1-NMSSPSyncRequest BO in the Sync Request BO MO Option.
PREMISE
Specify the MO Audit algorithm configured in the previous section.
SP/ITEM
Specify the MO Audit algorithm configured in the previous section.
SP/METER
Specify the MO Audit algorithm configured in the previous section.
ITEM
Specify the MO Audit algorithm configured in the previous section.
METER
Specify the MO Audit algorithm configured in the previous section.
Business Objects
Business Object
Description
C1-NMSSPSyncRequest
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 BO Options must be configured 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 C1-NMSSPSyncReqOutMsg for the NMS SP Sync. Refer to “Defining Outbound Message Types” 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 XSL C1-CCBJMSQAddNamespace.xsl. Refer to External Systems 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. The base package comes with an algorithm that creates a message and drops it into a JMS Queue. If your implementation uses this algorithm (C1-CR-OUTMSG), you must define the BO Options for External System and Outbound Message Type.
For more information about the sync request process, the business objects, maintenance objects and other components use for this process, see the section titled “Data Synchronization” in Oracle Utilities Framework User Guide.
JMS Configuration
Oracle no longer recommends using the JMS communication route. If you prefer to use it, the configuration steps are provided in Appendix D.
Message Sender for Customer Data Sync
To create a real-time Message Sender configured to communicate with the integration layer:
1. Navigate to Admin Menu > M > Message Sender.
2. Enter a unique Message Sender and Description.
3. Populate values:
• Message Sender - Sender name in Oracle Utilities Customer Care and Billing
• Description - Sender description
• Invocation Type - Real-time
• XAI Class - SOAPSNDR (Real Time Sender to route messages via HTTP)
4. Select the Active checkbox.
• MSG Encoding - UTF-8 message encoding
5. Select the Context tab and set values for the following context types:
• HTTP Login User: User ID for the integration URL to be accessed.
• HTTP Login Password: Password for the integration URL to be accessed.
• HTTP Header: SOAPAction: "process"
• HTTP Method (POST/GET): POST
• 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 Customer Sync Wrapper service.
Example: http://<SOA_Host: SOA_Port>/soa-infra/services/CCB-NMS/ OUCCBNMSSyncReqJMSWriteSvc/ouccbnmssyncreqjmswritesvc_client_ep
• Message Namespace URI: http://xmlns.oracle.com/OUCCB/RequestMessage
Message Sender for Trouble Call Interface
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 Menu > M >Message Sender.
2. Enter a unique Message Sender and Description.
3. Populate values:
Invocation Type = Real-time
XAI Class = SOAPSNDR (Sender for real-time HTTP / SOAP messages)
4. Select the Active checkbox.
MSG Encoding = UTF-8 message encoding
5. Select the Context tab and set values for the following Context Types:
• HTTP Login User - User ID for the integration URL to be accessed.
• HTTP Login Password - Password for the integration URL to be accessed.
• HTTP Header - SOAPAction: "process"
• HTTP Method (POST/GET) - POST
• 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 Trouble Call Interface EBF.
Example: http://SOA_Host:SOA_Port/soa-infra/services/CCB-NMS/ OUCCBOUNMSTroubleCallInterfaceEBF/ ouccbounmstroublecallinterfaceebf_client_ep
• Message Namespace URI - http://xmlns.oracle.com/OUCCB/Message
Message Sender for Job History Query
To create the Message Sender configured to communicate with the integration layer:
1. Navigate to Admin Menu > M > Message Sender.
2. Enter a unique Message Sender and description.
3. Populate values:
• Invocation Type = Real-time
• XAI Class = SOAPSNDR (Sender for real-time HTTP / SOAP 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 integration composite URL to be accessed.
• HTTP Login Password - Password for the integration composite URL to be accessed
• HTTP Header - SOAPAction: "process"
• HTTP Method (POST/GET) - POST
• 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://SOA_Host:SOA_Port/soa-infra/services/CCB-NMS/ OUCCBOUNMSJobHistoryQueryEBF/ouccbounmsjobhistoryquery_client_ep
• Message Namespace URI - http://xmlns.oracle.com/OUCCB/Message
Message Sender for Trouble Call History Query
To create Message Sender for Trouble Call History Query:
1. Navigate to Admin Menu > M > Message Sender.
2. Enter a unique Message Sender and Description.
3. Populate values:
• Invocation Type = Real-time
• XAI Class = SOAPSNDR (Sender for real-time HTTP / SOAP 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 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 EBF.
Example: http://SOA_Host_SOA_Port/soa-infra/services/CCB-NMS/ OUCCBOUNMSTroubleCallsQueryEBF/OU CCBOUNMSTroubleCallsQueryEBF_ep
• Message Namespace URI: http://xmlns.oracle.com/OUCCB/Message
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.
Perform the following steps to create an HTTP sender configured to communicate with the integration layer:
1. Navigate to Admin Menu > M > Message Sender.
2. Enter a unique Message Sender and Description.
3. Populate values:
• Invocation Type = Real-time
• XAI Class = SOAPSNDR (Sender for real-time HTTP / SOAP 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 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 EBF.
Example: http://SOA_Host:SOA_Port/soa-infra/services/CCB-NMS/OUCCBOUNMSJobHistoryQueryEBF/ouccbounmsjobhistoryquery_client_ep
• Message Namespace URI - http://xmlns.oracle.com/OUCCB/Message
Outbound Message Type
Customer Sync
1. Navigate to Admin menu > O > Outbound Message Type.
2. Enter a unique Outbound Message Type and Description.
3. Populate values:
• Business Object = C1-NMSSPSyncReqOutMsg (Customer Sync Outbound Message BO)
• Priority = (choose from the selection)
Trouble Calls Interface
1. Navigate to Admin menu > O > Outbound Message Type.
2. Enter a unique Outbound Message Type and Description.
3. Populate values:
• Business Object =C1-OutageCallOutboundMsg (Outage Call Outbound Message BO)
• Priority = (choose from the selection)
Query Job History
1. Navigate to Admin > O > Outbound Message Type.
2. Enter a unique Outbound Message Type and Description.
3. Populate values:
• Business Object = C1-OutageJobHistory (Job History Query Outbound Message BO)
• Priority = (choose from the selection)
Query Trouble Call History
1. Navigate to Admin menu > O > Outbound Message Type.
2. Enter a unique Outbound Message Type and Description.
3. Populate values:
• Business Object = C1-OutageCallHistory (Call History Query Outbound Message BO)
• Priority = (choose from the selection)
Query Planned Outages
1. Navigate to Admin > O > Outbound Message Type.
2. Enter a unique Outbound Message Type and Description.
3. Populate values:
• Business Object = C1-NMSPLNOUT (NMS Planned Outages Query Outbound Message BO)
• Priority = (choose from the selection)
External System
Perform the following steps to create a new External System for direct the integration:
1. Navigate to Admin menu > E > External System.
2. Enter a unique External System and Description. Example: NMS
3. Set Our Name in Their System to “CCB”.
4. Define the Outbound Message Types associated to the integration.
• For Customer Data Synchronization Outbound Message Type, populate values:
• Outbound Message Type = (Outbound Message Type for Customer Data Synchronization)
• Processing Method = Real-time
• Message Sender = (Message Sender for Customer Data Synchronization)
• Date/Time Format = XSD
• Namespace Option = Configured on Sender
• For Trouble Calls Interface Outbound Message Type, populate values:
• Outbound Message Type = (Outbound Message Type for Trouble Call Interface)
• Processing Method = Real-time
• Message Sender = (Message Sender for Trouble Call Interface/submit trouble call)
• Date/Time Format = XSD
• Namespace Option = Configured on Sender
• For Query Job History Outbound Message Type, populate values:
• Outbound Message Type = (Outbound Message Type for Job History Query)
• Processing Method = Real-time
• Message Sender = (Message Sender for Job History Query)
• Date/Time Format = XSD
• Namespace Option = Configured on Sender
• For Query Trouble Call History Outbound Message Type, populate 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)
• Date/Time Format = XSD
• Namespace Option = Configured on Sender
• For Query Planned Outages Outbound Message Type, populate values:
• Outbound Message Type = (Outbound Message Type for Planned Outages Query)
• Processing Method = Real-time
• Message Sender = (Message Sender for Planned Outages Query)
• Date/Time Format = XSD
• Namespace Option = Configured on Sender