Integration Processes
This section provides detailed business process overviews and technical overviews of each of the business processes facilitated by the integ ration. These include the following:
Customer Data Synchronization Process
The customer data is synchronized in one direction from Oracle Utilities Customer to Meter to Oracle Utilities Network Management System to support the following functionality.
Refer to the Customer Data Synchronization Process section for message mapping information for this integration point.
Supported Functionality
This integration point supports the following functionalities:
• Sends customer data from Oracle Utilities Customer to Meter to Oracle Utilities Network Management System.
• Initial Sync (or Full Initial Load): It is the first load of data to create a Customer Data model in Oracle Utilities Network Management System.
• Incremental Sync: The changes since the last synchronization to the customer information in Oracle Utilities Customer to Meter are sent to Oracle Utilities Network Management System overwriting the last synchronized information.
• Only relevant and current electric customer data which is stored and maintained in Oracle Utilities Customer to Meter and that is needed to create the Oracle Utilities Network Management System customer model is synchronized. This involves getting data from the Person, Account, Premise, Service Point, Facility, Service Agreement, and Device tables in Oracle Utilities Customer to Meter.
The following diagram shows a graphical representation of the Customer Data Synchronization process: 
Creation and Update of Customer Data
Customer information is created and updated in Oracle Utilities Customer to Meter and this application is always the owner of customer data. Customer information must be kept up to date in Oracle Utilities Network Management System so that outage information can be properly synchronized with the appropriate customers and service points.
Initial Synchronization/Incremental Updates
At the start of the implementation, the current customer data is synchronized from Oracle Utilities Customer to Meter to Oracle Utilities Network Management System by batch processing which is run on initial load from Oracle Utilities Customer to Meter. Oracle Utilities Customer to Meter then keeps the data in sync with Oracle Utilities Network Management System using periodic incremental updates.
Oracle Utilities Customer to Meter sends one message for every customer that needs to be synchronized in Oracle Utilities Network Management System. This message contains the entire customer related data load or updates for the customer relevant to Oracle Utilities Network Management System (person, account, premise, SP, SA, meter/item information).
Only current customer information from Oracle Utilities Customer to Meter is synchronized when the following criteria is satisfied:
• The customer has an active or pending stopped service agreement (SA)
• The SA has an effective SA/SP link
• The SP linked to the SA is connected and in service
When Oracle Utilities Customer to Meter sends an update to Oracle Utilities Network Management System, the message may contain customer data with meter information or customer data with the item information.
Meter Information Updates
The messages containing the customer data with the meter information are processed and sent over to Oracle Utilities Network Management System.
Inactive Customer Data
When a customer becomes inactive in Oracle Utilities Customer to Meter, this information is sent so that Oracle Utilities Network Management System can mark the customer as inactive. This update only indicates that the customer is inactive, but does not provide details regarding whether the customer is inactive due to disconnection of service, for non-payment or if the customer has moved out.
Integration Process and Technical Details
This integration point supports a-synchronous data synchronization from Oracle Utilities Customer to Meter to Oracle Utilities Network Management System with the following processing:
• Oracle Utilities Customer to Meter sends synchronization message to OUC2MOUNMSCustomerSyncJMSWriteSvc integration service. This integration service is exposed as a web service.
• OUC2MOUNMSCustomerSyncJMSWriteSvc integration process sends the synchronization message to Oracle Utilities Customer to Meter Request JMS Queue in the integration layer to consume and process.
• OUC2MOUNMSCustomerSyncEBF integration process consumes messages from the JMS Queue, transforms the message to the equivalent Oracle Utilities Network Management System field format, invokes the Customer Update REST service to insert/update the customer information in the Oracle Utilities Network Management System and sends the response or error messages to JMS Queues.
• WebLogic JMS queues are used as a queuing mechanism in the integration layer between Oracle Utilities Customer to Meter and BPEL processes. Four JMS queues support this integration.
• Oracle Utilities Customer to Meter Request Queue: For Oracle Utilities Customer to Meter to add messages to this queue which are picked up by the integration for processing.
• Oracle Utilities Customer to Meter Response Queue: The business errors in the integration and success or failure of request service insert/update operations are written to this queue.
• Oracle Utilities Customer to Meter Request Error Queue: The technical errors encountered in the integration request process are written to this queue.
• Oracle Utilities Customer to Meter Response Error Queue: The technical errors encountered when Oracle Utilities Customer to Meter reads the messages from the Oracle Utilities Customer to Meter response queue are written to this queue.
• OUC2MOUNMSCustomerSyncEBF integration BPEL process with the following components processes the message.
• JMS Consumer reads messages from the Oracle Utilities Customer to Meter request queue.
• JMS Producer writes to the Oracle Utilities Customer to Meter response queue.
• Transformation converts the message from the source format to the target format. DVMs are used for the transformation.
• Rest Adapter interacts with the Oracle Utilities Network Management System REST service to invoke update-customers to insert/update customer information in the Oracle Utilities Network Management System customer related.
• Customization inserts placeholders for custom xsl and calls to pre and post transformation extension points for each transformation.
• OUC2MOUNMSCustomerSyncJMSReadSvc integration process consumes the message from JMS response queue, and invokes F1-pdateAndTransitionSyncRequest IWS in Oracle Utilities Customer to Meter.
• In case of any errors, the error message returned by Oracle Utilities Network Management System is sent to Oracle Utilities Customer to Meter with the sync request ID associated with it.
In case of success, Oracle Utilities Network Management System update-customers REST service will not return any response. Integration will send the sync request ID back to Oracle Utilities Customer to Meter.
Assumptions and Constraints
• Device information for each customer or service point must be setup in Oracle Utilities Customer to Meter first before the customer synchronization batch is run. Device ID used in Oracle Utilities Customer to Meter must be in the Oracle Utilities Network Management System Supply Nodes table. Oracle Utilities Customer to Meter stores the device information in the SP Facility record and Oracle Utilities Network Management System stored it in Device ID.
• The Oracle Utilities Customer to Meter Customer Data synchronization is driven by SP and the data to be synchronized to Oracle Utilities Network Management System can be filtered by SP Type(s). The Oracle Utilities Customer to Meter NMS Sync Integration master configuration filters the data to be synchronized by SP Type. Implementation teams can configure the SP Type(s) that need to be synchronized in the master configuration and only those specified are synchronized over to Oracle Utilities Network Management System. In a multi CIS Division environment supporting separate Oracle Utilities Network Management System instances per division, implementation teams can also configure the SP Type(s) that need to be synchronized by division. If nothing is specified in the master configuration, all SP Types are synchronized over.
Note: Refer to the Data Synchronization section in the Oracle Utilities Framework User Guide for more information.
Successful Update
When the Oracle Utilities Network Management System tables are successfully updated, the integration layer sends a positive acknowledgment to the Oracle Utilities Customer to Meter response queue for Oracle Utilities Customer to Meter to process.
Business Process Errors
When a business error is encountered during the execution to insert or update one of the customer related data, the customer-update service returns an error to the integration layer and a negative acknowledgment is sent to the Oracle Utilities Customer to Meter response queue. Oracle Utilities Customer to Meter fixes the error and resends the message. The Oracle Utilities Network Management System customer-update service issues a rollback on all successful activities that were issued.
Technical Errors
When a technical error is encountered the message is sent to the Oracle Utilities Customer to Meter JMS error queue and processing fails.The common technical errors would be if the Oracle Utilities Network Management System is down or if there are connectivity errors.
Integration Service
These values are cross referenced in the Service Configurations section.
Name | Description |
OUC2MOUNMSCustomerSyncEBF | C2M-NMS Customer Data Sync BPEL Process This BPEL process reads messages from the request queue and merges the customer data to the NMS Customer Related Staging tables after successful transformation. The BPEL process includes transformations, extensions and error notifications. |
Adapter Services
Name | Description |
OUC2MCustomerSyncReqJMS Consumer | C2M Customer Sync Request JMS Consumer This is the JMS consumer service in BPEL responsible for listening to the C2M Request Queue. This is created as part of the BPEL process. |
OUC2MCustomerSyncResponseJMS Producer | C2M Customer Sync Response JMS Producer This is the JMS producer service in BPEL responsible for adding a response message to the C2M Response Queue. This is created as part of the BPEL process. |
OUCCBOUNMSUpdateCustomersRest AdapterRef | NMS REST Adapter - update-customer service. This is created as part of the BPEL process. |
JMS Queues
Name | Description |
OUC2MCustomerDataSyncRequest | C2M Customer Data Sync Request Queue |
OUC2MCustomerDataSyncRequest Error | C2M Customer Data Sync Request Error Queue |
OUC2MCustomerDataSyncResponse | C2M Customer Data Sync Response Queue |
OUC2MCustomerDataSyncResponse Error | C2M Customer Data Sync Response Error Queue |
Integration Wrapper Services
Composite Name | Description |
OUC2MOUNMSCustomerSyncJMS WriteSvc | C2M-NMS Customer Data Sync JMS Write BPEL Process This BPEL process receives messages from the C2M customer sync outbound message and writes the message to customer sync request JMS queue. |
OUC2MOUNMSCustomerSyncJMS ReadSvc | C2M-NMS Customer Data Sync JMS Read BPEL Process This BPEL process reads messages from the customer sync response JMS queue and sends the message to F1-UpdateAndTransitionSyncRequest IWS in C2M. |
C2M Services
Service Name | Operation Name | Description |
F1-UpdateAndTransitionSyncRequestService | F1-UpdateAndTransitionSyncRequest | Update and Transition Master Data Sync Request |
Trouble Call Entry Process
This process is a real-time synchronous interface of the trouble calls created in Oracle Utilities Customer to Meter.
Oracle Utilities Network Management System is the central repository for trouble calls. However, trouble calls may originate in Oracle Utilities Customer to Meter and these trouble calls are sent to Oracle Utilities Network Management System.
Mapping
Trouble code mapping must be synchronized between the edge applications so that the trouble code sent from Oracle Utilities Customer to Meter is interpreted similarly when the trouble code is received by Oracle Utilities Network Management System. Refer to the Data Mapping section for more details. Refer to the Trouble Call Entry Process section for message mapping information for this integration point.
Supported Functionality
The integration point supports the following functionalities:
• Transmit to Oracle Utilities Network Management System trouble calls created in Oracle Utilities Customer to Meter. The following types of calls are interfaced:
• Electric trouble calls for a particular customer (known premise/service point)
• Fuzzy calls
When a fuzzy call is created, at least one of the following call identifiers must be provided:
When a fuzzy call is created, at least one of the following call identifiers must be provided:
• The caller's name
• The caller's phone number
• The caller's ID (911 reference ID provided by the caller (911))
• Location must also be provided. A Location can be a:
• Street intersection (provide two street names)
• Street segment (provide a block number and a street name)
• City and State are optional
The following process diagram shows a graphical representation of the trouble call entry process:
New Trouble Calls Created in Oracle Utilities Customer to Meter
When a trouble call is created in Oracle Utilities Customer to Meter, the contact name and contact phone passed to Oracle Utilities Network Management System are not always used as the customer name and customer phone stored in the incident record.
If the Generic IVR Adapter, which processes trouble calls received from Oracle Utilities Customer to Meter is run with the 'command line option '-docustquery' for customers that exist in the Oracle Utilities Network Management System Customer Model, the system uses the customer name and customer phone stored in the Oracle Utilities Network Management System customer model rather than the contact name and contact phone coming from Oracle Utilities Customer to Meter.
Make sure that when running the Generic IVR Adapter in Oracle Utilities Network Management System that the command-line option '-docustquery' is not used if you want to store the contact name and contact number from Oracle Utilities Customer to Meter.
For more information on configuring this option, refer to the section Setting Up Oracle Utilities Network Management System in Chapter 3.
Updates
The edge applications determine which fields can be updated and which fields are restricted. Depending on the needs of the customer, this decision is implementation specific since some customers are very sensitive about the ability to modify customer reported information so they require new calls to be entered for significant changes to a reported call while some only allow certain fields to be updated. No restrictions are applied as default.
Updating Phone Numbers
When Oracle Utilities Customer to Meter passes a contact phone to the integration layer, the integration layer removes all delimiters and characters, and only passes the numeric value to Oracle Utilities Network Management System.
Integration Process and Technical Details
This integration point supports trouble calls created or updated in Oracle Utilities Customer to Meter and sent to Oracle Utilities Network Management System with the following processing:
When a trouble call is created in Oracle Utilities Customer to Meter as a Service Task, a synchronous xml message is sent to the BPEL Process. The BPEL process transforms the message to the equivalent Oracle Utilities Network Management System field format and invokes the submit call REST Service to insert/update the trouble call information in the Oracle Utilities Network Management System Trouble Calls table. The BPEL process handles the following:
• Request Message transformation from the source (C2M) to the target (NMS) application format. DVMs are used for the transformation.
• Insert/Update of trouble calls in the Trouble Calls table using a REST Adapter to interact with the Oracle Utilities Network Management System to invoke the Oracle Utilities Network Management System trouble calls Rest Service submit-calls that inserts/updates the trouble call record to the Trouble Calls table.
• Customization inserts placeholders for custom XSL and calls to pre and post transformation extension points for each transformation.
Successful Update
When the Oracle Utilities Network Management System tables are successfully updated, the integration layer sends a positive acknowledgment to the Oracle Utilities Customer to Meter response queue.
Errors
When a business or technical error is encountered, the integration layer synchronously responds with an error to Oracle Utilities Customer to Meter.
Integration Service
These values are cross referenced in the Service Configurations section.
Name | Description |
|---|---|
OUC2MOUNMSSubmitTroubleCall EBF | C2M-NMS Trouble Call Interface BPEL Process This is the main BPEL process that transforms the incoming C2M trouble call message to NMS format and inserts or updates the trouble call record in NMS. The BPEL process includes transformations, extensions and error notifications. |
Adapter Services
Name | Description |
OUCCBOUNMSSubmitTroubleCallRestAdapterRef | NMS REST Adapter: Insert Trouble Calls using NMS Rest API submit-calls. This is created as part of the BPEL process. |
Job History Query Process
This process is a real-time synchronous interface from Oracle Utilities Customer to Meter to retrieve job history information from Oracle Utilities Network Management System for a particular customer, location or call identifier and display the results back in Oracle Utilities Customer to Meter.
Refer to the Job History Query Process section for message mapping information for this integration point.
Supported Functionality
The job history query supports the following functionalities:
• Query and view job history details from Oracle Utilities Customer to Meter using any of the search criteria:
• Standard outage job history query for known customers: Search by IDs:
• Service Point ID
• Account ID
• Premise ID
• Nearby Outage Job History Query: Search by location:
• Query by Street Intersection: The possible inputs to the query are:
• Street Intersection (street name and cross street)
• City (optional)
• State (optional)
• Query by Street Segment: The possible inputs to the query are:
• Street segment (street name and block number)
• City (optional)
• State (optional)
• Fuzzy Call Identifier Query: This query can find the job details for a fuzzy call that was placed. This requires first looking up the fuzzy call from the Call History using any of the following criteria and finding the associated jobs.
• Caller's Name
• Caller's Phone Number
• Call Reference Identifier Number (911 Call Identifier)
• External ID (Outage Call ID in Oracle Utilities Customer to Meter or IVR ID)
• Oracle Utilities Customer to Meter default display order of trouble calls with most recent at top.
The following process diagram shows a graphical representation of the job history query process:
Integration Process and Technical Details
Oracle Utilities Customer to Meter sends the query information in the form of xml messages which are transformed by the integration and sent to Oracle Utilities Network Management System. Oracle Utilities Network Management System responds with the Job History results based on the input criteria that it received. The response is transformed by the integration layer and sent to Oracle Utilities Customer to Meter. 
Assumptions and Constraints
• When searching Job History by contact phone, the integration layer removes all delimiters and characters from the contact phone that Oracle Utilities Customer to Meter and only passes the numeric value to Oracle Utilities Network Management System.
• To make the name search and street name search compatible, a wildcard character (%) must be added at the end of the value. Example. Smith%
Errors
If the integration layer or Oracle Utilities Network Management System returns a business error while processing the inbound message, an error message is returned in the response message to Oracle Utilities Customer to Meter.
Integration Service
These values are cross referenced in the Service Configurations section.
Name | Description |
OUC2MOUNMSJobHistoryQueryEBF | Query NMS for the Job History BPEL Process. This is a synchronous BPEL process to transform the incoming C2M message to NMS format and transform the response from NMS back to C2M format. This BPEL process receives the C2M request messages and invoke NMS REST Service job-history using REST Adapter. The response from NMS is sent as response back to C2M after appropriate transformations. |
Adapter Services
Name | Description |
OUC2MOUNMSJobHistoryQueryRestAdapterReference | Query NMS job-history. This is the REST Adapter Service to invoke job-history from NMS. |
Trouble Call History Query Process
This process is a real-time synchronous interface from Oracle Utilities Customer to Meter to retrieve trouble call history information from Oracle Utilities Network Management System for a particular customer, location or call identifier and display the results back in Oracle Utilities Customer to Meter.
Refer to the Trouble Call History Query Process section for message mapping information for this integration point.
Supported Functionality
The trouble call history query supports the following functionalities:
• Query and view call history details from Oracle Utilities Customer to Meter using any of the search criteria:
• Standard Trouble Calls History Query for known customers: Search by IDs:
• Service Point ID
• Account ID
• Premise ID
• Nearby Outage Job History Query: Search by location:
• Query by Street Intersection: The possible inputs to the query are:
• Street Intersection (street name and cross street)
• City (optional)
• State (optional)
• Query by Street Segment: The possible inputs to the query are:
• Street segment (street name and block number)
• City (optional)
• State (optional)
• Fuzzy Call Identifier Query. This query can find the trouble call details for a fuzzy call (calls that are not associated with a customer or with a device in Oracle Utilities Network Management System). Search by call identifiers:
• Caller's Name
• Caller's Phone Number
• Call Identifier Number (911 Call Identifier)
• External ID (Outage Call ID in Oracle Utilities Customer to Meter or IVR ID)
• Oracle Utilities Customer to Meter default display order of trouble calls with most recent at top.
The following process diagram shows a graphical representation of the trouble call history query process:
Integration Process and Technical Details
Oracle Utilities Customer to Meter sends the query information in the form of xml messages which are transformed by the integration layer and sent to Oracle Utilities Network Management System. Oracle Utilities Network Management System responds with the Trouble Calls History based on the input criteria that it received. The response is transformed by the integration layer and sent to Oracle Utilities Customer to Meter.
Assumptions and Constraints
• When searching Trouble Call History by contact phone, the integration layer removes all delimiters and characters from the contact phone that Oracle Utilities Customer to Meter passes to the integration and only passes the numeric value to Oracle Utilities Network Management System.
• To make the name search and street name search compatible, a wildcard character (%) must be added at the end of the value.
Example: Smith%
Errors
If the integration layer or Oracle Utilities Network Management System returns a business error while processing the inbound message, an error message is returned in the response message to Oracle Utilities Customer to Meter.
Integration Service
These values are cross referenced in the Service Configurations section.
Name | Description |
|---|---|
OUC2MOUNMSCallHistoryQueryEBF | Query NMS for the Trouble Calls History BPEL Process. This is the synchronous BPEL process to transform the incoming C2M message to NMS format and transform the response from NMS back to C2M format. This BPEL process receives the C2M request messages and invoke NMS REST call-history service using REST Adapter. The response from NMS is sent as response back to C2M after appropriate transformations. |
Adapter Services
Name | Description |
OUCCBOUNMSCallHisoryQueryRest AdapterRef | Query NMS for the Trouble Calls History. This is the REST Adapter to invoke NMS call-history service. |
Planned Outages Query Process
The primary owner of the planned outage data is Oracle Utilities Network Management System.
This process is a real-time synchronous interface from Oracle Utilities Customer to Meter to retrieve planned outages from Oracle Utilities Network Management System for a particular customer and display the results back in Oracle Utilities Customer to Meter.
Refer to the Planned Outages Query Process section for message mapping information for this integration point.
Supported Functionality
The planned outage query supports the following functionalities:
• Query and view planned outage jobs from Oracle Utilities Customer to Meter given a Service Point.
• Retrieve from Oracle Utilities Network Management System for display in Oracle Utilities Customer to Meter information for future, current and historical planned outages that affects or have affected that service point.
• Whether or not to retrieve all planned outages affecting the customer (past, present, and future), or only “active” ones (current and future, not past) is configurable.
The following process diagram shows a graphical representation of the planned outages query process:
Integration Process and Technical Details
Oracle Utilities Customer to Meter sends the query information in form of xml messages, which are transformed by the integration and sent to Oracle Utilities Network Management System.
Oracle Utilities Network Management System responds back with the Planned Outage Jobs based on the input criteria that it received. The response is transformed by the integration layer and sent to Oracle Utilities Customer to Meter.
Errors
If the integration layer or Oracle Utilities Network Management System returns a business error while processing the inbound message, an error message is returned in the Response message to Oracle Utilities Customer to Meter.
Integration Service
These values are cross referenced in the Service Configurations section.
Name | Description |
OUC2MOUNMSPlannedOutages QueryEBF | Query NMS for the Planned Outage Jobs BPEL Process. This is a synchronous BPEL process to transform the incoming C2M message to NMS format and transform the response from NMS back to C2M format. This BPEL process receives the C2M request messages and invoke NMS Rest service using REST Adapter. The response from NMS is sent as response back to C2M after appropriate transformations. |
Adapter Services
Name | Description |
OUCCBOUNMSPlannedOutagesQueryRestAdapterRef | Query NMS for Planned Outages Adapter Service. This is the REST Adapter to invoke NMS Rest switching-history service. |