oracle utilities custom er care and billing …...oracle utilities custom er care and billing...

39
Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper Release 12.2 Media Pack E67051-01 July 2016 Implementation Whitepaper

Upload: others

Post on 10-Mar-2020

15 views

Category:

Documents


0 download

TRANSCRIPT

Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

Release 12.2 Media Pack

E67051-01

July 2016

Implementation Whitepaper

Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper, Release 12.2 Media Pack

Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

Primary Author: Oracle Corporation

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Contents - i Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

Implementation Whitepaper

Preface..................................................................................................................................... ivAudience ............................................................................................................................................................................................ivDocumentation Accessibility .........................................................................................................................................................iv

Part 1:Understanding the Integration

Chapter 1Overview ........................................................................................................................................ 1-1

Additional Resources..................................................................................................................................................... 1-1Abbreviations.................................................................................................................................................................. 1-2Prerequisites .................................................................................................................................................................... 1-2About the Integration Product .................................................................................................................................... 1-2

About the Products ................................................................................................................................................ 1-2Supported Business Processes ..................................................................................................................................... 1-3

Integration Points by Business Process............................................................................................................... 1-3

Chapter 2Understanding the Integration Process...................................................................................... 2-1

Technical Overview ....................................................................................................................................................... 2-1Oracle Utilities Customer Care and Billing Initiated Flow............................................................................... 2-1Oracle DataRaker Initiated Flow ......................................................................................................................... 2-2Directory Structure................................................................................................................................................. 2-3

Integration Points........................................................................................................................................................... 2-3Lead Segmentation Processes ............................................................................................................................... 2-3.........................................................................................................................................Business Flag Processes 2-7Common Processes .............................................................................................................................................. 2-10

Part 2:Implementing the Integration Product

Chapter 3Configuring the Integration.......................................................................................................... 3-1

Integration Configuration Checklist............................................................................................................................ 3-1Oracle Utilities Customer Care and Billing Configuration............................................................................... 3-1Oracle DataRaker Configuration ......................................................................................................................... 3-1Integration Product Configuration ...................................................................................................................... 3-1

Setting up Oracle Utilities Customer Care and Billing ............................................................................................. 3-2Setting up Oracle DataRaker........................................................................................................................................ 3-2Setting up the Process Integration............................................................................................................................... 3-2

Setting JDeveloper for the Integration Layer..................................................................................................... 3-2

Contents

Contents - ii Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

Setting Service Endpoint for the Integration ..................................................................................................... 3-4Setting Domain Value Maps for the Integration ............................................................................................... 3-4Setting Error Notification for the Integration ................................................................................................... 3-7Setting FTP User Account for the Integration Layer ....................................................................................... 3-8

Chapter 4Monitoring and Troubleshooting................................................................................................. 4-1

Monitoring from Oracle Utilities Customer Care and Billing................................................................................. 4-1Monitoring from Oracle DataRaker............................................................................................................................ 4-1Monitoring from the Integration ................................................................................................................................. 4-1

Monitoring Using WebLogic Logs ...................................................................................................................... 4-1Monitoring the Queues Using WebLogic Console ........................................................................................... 4-2

Troubleshooting ............................................................................................................................................................. 4-2Oracle Utilities Customer Care and Billing Initiated Messages ....................................................................... 4-2Oracle DataRaker Initiated Messages.................................................................................................................. 4-4

Chapter 5Customization Options................................................................................................................. 5-1

Chapter 6Security.......................................................................................................................................... 6-1

Preface - iv Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

1Preface

AudienceThis document is intended for anyone implementing the Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker.

Documentation AccessibilityFor information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle SupportOracle customers have access to electronic support through My Oracle Support. For information, visit: http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info

or

http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Part 1 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

Part 1 Understanding the Integration

This section provides an overview of the participating applications and information regarding the business processes addressed by this integration.

The section includes the following chapters:

• Overview

• Understanding the Integration Process

Part 1 - Understanding the Integration

Overview 1-1 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

Chapter 1Overview

This document provides configuration and administration information for the integration between Oracle Utilities Customer Care and Billing (CCB) and Oracle DataRaker.

• Additional Resources

• Abbreviations

• Prerequisites

• About the Integration Product

• Supported Business Processes

1.1 Additional ResourcesFor more information regarding this integration, foundation technology and the edge applications, refer to the following documents:

Note: For specific edge application patch level details, refer to the Oracle Utilities Integrations page at:

http://my.oracle.com/site/tugbu/productsindustry/productinfo/utilities/integration/index.htm

Note: The latest versions of these documents are available on the Oracle Technology Network at http://docs.oracle.com/cd/E72219_01/documentation.html

Topic Description

Edge application documentation:

Oracle Utilities Customer Care andBilling documentation

Oracle DataRaker documentation

Refer to the Oracle applications documentation page:http://docs.oracle.com/cd/E72219_01/ documentation.html

Oracle SupportAccess the support site for the Certification Matrix for Oracle Utilities Products (Doc ID 1454143.1)

Visit the My Oracle Support at https://support.oracle.com website at regular intervals to keep apprise of changes.

Oracle Universityfor training opportunities

http://education.oracle.com/

Abbreviations

Overview 1-2 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

1.2 AbbreviationsThe following abbreviations are used in this guide:

1.3 PrerequisitesAll participating applications (namely Oracle Utilities Customer Care and Billing, Oracle DataRaker and the integration) must be installed, set up, and working properly.

1.4 About the Integration ProductThis section provides general information about the functionality and processing of Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker accelerator pack. This is an Integration accelerator pack using Oracle Service Bus.

1.4.1 About the ProductsThe following products are involved in the integration:

• Oracle Utilities Customer Care and Billing

• Oracle DataRaker

1.4.1.1 Oracle Utilities Customer Care and BillingOracle Utilities Customer Care and Billing is a customer and billing system that manages all aspects of customer service needed by most utilities to operate their business. Basic objects form the core of the system: person, account, premise, service agreement, and service point. These objects hold demographic, geographic, and financial information about a company's customers and properties. Related to these objects are the processes that they manage: bills, payments, meter readings, field activities, etc.

Note: Refer to the Additional Resources section for current application version details.

Abbreviation Expansion

OSB Oracle Service Bus

MDS Metadata Store

JMS Java Message Service

EM Enterprise Manager

DVM Domain Value Map

SOA Service Oriented Architecture

XSD XML Schema Definition

WSDL Web Service Definition Language

XSL T Extensible Stylesheet Language Transformations

DataRaker Oracle DataRaker

CC&B or CCB Oracle Utilities Customer Care and Billing

Supported Business Processes

Overview 1-3 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

1.4.1.2 Oracle DataRakerOracle DataRaker provides unmatched depth and breadth of proven support for utilities' most critical business areas with preconfigured analytics for the most complex use cases. It also displays advanced analytics using a powerful, intuitive interface.

Note: Refer to the Additional Resources section for current application version details.

1.5 Supported Business ProcessesThis integration allows DataRaker to perform segmentation on leads generated by Oracle Utilities Customer Care and Billing’s Program Management. Although Oracle Utilities Customer Care and Billing has numerous criteria related to customer data, Oracle DataRaker analysis on more detailed data helps the target customers efficiently.

The integration allows Oracle DataRaker to send various customer related flags to Oracle Utilities Customer Care and Billing and Oracle Utilities Customer Care and Billing provides feedback on the reported exception.

1.5.1 Integration Points by Business ProcessThe integration points for each of the business processes are listed below.

1.5.1.1 Lead Segmentation• Generated Lead Flow

• Prioritized Lead Flow

• Lead Outcome Flow

The following diagram provides a visual representation of this business process:

Lead Segmentation Process

Supported Business Processes

Overview 1-4 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

1.5.1.2 Business Flag Processing• Business Flag Request Flow

• Business Flag Response Flow

The following diagram provides a visual representation of this business process:

Business Flag Process

Understanding the Integration Process 2-1 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

Chapter 2Understanding the Integration

Process

This section outlines the overall technical overview, business processes, and specific integration points handled by the integration.

• Technical Overview

• Integration Points

2.1 Technical OverviewThis integration is built as an Integration Accelerator Pack. It has two patterns where the integration flow is initiated either by Oracle Utilities Customer Care and Billing or by Oracle DataRaker.

2.1.1 Oracle Utilities Customer Care and Billing Initiated Flow

The end-to-end integration processes are asynchronous. The Oracle Utilities Customer Care and Billing initiated flow details are as follows:

• Oracle Utilities Customer Care and Billing sends the messages to the integration OSB web service. Each message is a single record from Oracle Utilities Customer Care and Billing.

• The integration OSB process writes the generated leads messages in a JMS queue.

• The OSB process:

• Reads the messages from the queue.

• Transforms them into the Oracle DataRaker format.

• Writes the transformed messages to an XML file.

• The file writing is controlled by the:

• Time the file adapter has to wait for incoming messages.

• Number of records being written to the file.

• Size of the file.

• The OSB process then moves the generated files (via FTP) to a folder accessible to Oracle DataRaker.

Technical Overview

Understanding the Integration Process 2-2 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

• WebLogic JMS is used as a queuing mechanism in the integration layer.

The following diagram provides a graphical representation of this processing:

Oracle Utilities Customer Care and Billing Initiated Flow

2.1.2 Oracle DataRaker Initiated FlowThe end-to-end integration processes are asynchronous. The Oracle DataRaker initiated flow details are as follows:

• Oracle DataRaker puts the XML file(s) with multiple messages into an FTP folder.

• The integration OSB process gets the file(s) from the FTP folder to a local folder.

• The integration OSB process:

• Reads the records in the file, one by one/.

• Transforms the records from the Oracle DataRaker format to the Oracle Utilities Customer Care and Billing format.

• Writes the transformed messages to a JMS queue.

• The messages are read from the queue and sent one by one to an Inbound web service in Oracle Utilities Customer Care and Billing.

• WebLogic JMS is used as a queuing mechanism in the integration layer.

Integration Points

Understanding the Integration Process 2-3 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

The following diagram provides a graphical representation of this processing:

Oracle DataRaker Initiated Flow

2.1.3 Directory StructureOracle Utilities Customer Care and Billing provides Web service interfaces for data exchange, but Oracle DataRaker uses the XML files. The integration requires the following directory structure:

Integration Directory Structure

2.2 Integration PointsThe integration supports the following business processes:

• Lead Segmentation Processes

• Business Flag Processes

• Common Processes

2.2.1 Lead Segmentation ProcessesThe integration incorporates the following integration points:

• Generated Lead Flow Integration Process

• Prioritized Lead Flow Integration Process

• Lead Outcome Flow Integration Process

Integration Points

Understanding the Integration Process 2-4 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

2.2.1.1 Generated Lead Flow Integration ProcessThe Generated Lead flow is a one-way asynchronous process triggered from the Oracle Utilities Customer Care and Billing system.

Technical Details

Oracle Utilities Customer Care and Billing sends the generated lead information in the form of XML messages. These messages are transformed by the integration layer, and then sent to Oracle DataRaker.

The integration artifacts for Generated Lead flow are as follows:

OSB Processes

Process Name Description

CCBDRGeneratedLead Processes Oracle Utilities Customer Care and Billing Generated lead messages into Oracle DataRaker file format and sends the file to Oracle DataRaker

JMS Queues

Queue Name Description

CCBDRGeneratedLead Used to store the Oracle Utilities Customer Care and Billing Generated lead messages

CCBDRGeneratedLeadError Error queue for the Generated lead queue

Directory Structure

The Generated Lead XML file is generated by integration in the files/Outbound/GeneratedLead directory. The sub-directories in the GeneratedLead directory are listed below:

Directory Name Description

archive Archive directory. It can be used by Oracle DataRaker for archiving the files picked up for processing.

error Error directory where files are moved if there are errors during processing.

error/jms Directory if there are JMS errors. It is used internally by the process.

ftpArchive If the FTP services are used, then this directory is used for archiving files post successful FTP.

ftpError If the FTP services are used, then this directory is used for moving files if there are FTP errors.

outbound Directory where XML files for Oracle DataRaker are moved. This directory has files which can be consumed by Oracle DataRaker. Oracle DataRaker can either read files from this folder or FTP the file to a location where the file can be read from.

Integration Points

Understanding the Integration Process 2-5 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

2.2.1.2 Prioritized Lead Flow Integration ProcessThe Prioritized Lead flow is a one-way asynchronous process triggered from the Oracle DataRaker system.

Technical Details

Oracle DataRaker sends the prioritized lead information in the form of a file containing XML messages. These messages are transformed by the integration layer, and then sent to the Oracle Utilities Customer Care and Billing system.

The integration artifacts for Prioritized Lead Flow are as follows:

OSB Processes

Process Name Description

DRCCBPrioritizedLead Processes the Oracle DataRaker file containing multiple prioritized lead messages to the Oracle Utilities Customer Care and Billing format and sends the messages (one at a time) to Oracle Utilities Customer Care and Billing.

JMS Queues

Queue Name Description

DRCCBPrioritizedLead Used to store the prioritized lead messages coming from Oracle DataRaker and transformed into the Oracle Utilities Customer Care and Billing format. The messages from queue are then sent to Oracle Utilities Customer Care and Billing.

DRCCBPrioritizedLead Error Error queue for the prioritized lead queue.

Directory Structure

The Prioritized Lead XML file is generated by Oracle DataRaker and placed in the files/Inbound/PrioritizedLead directory. The sub-directories in the PrioritizedLead directory are as follows:

stage Staging directory. It is used internally.

temp Directory for storing intermediate temporary files.

Directory Name Description

archive Archive directory. It is used by integration for archiving files coming from Oracle DataRaker picked up for processing.

error Error directory where files are moved if there are errors during processing.

Directory Name Description

Integration Points

Understanding the Integration Process 2-6 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

2.2.1.3 Lead Outcome Flow Integration ProcessThe Lead Outcome flow is a one-way asynchronous process triggered from the Oracle Utilities Customer Care and Billing system.

Technical Details

Oracle Utilities Customer Care and Billing sends the Lead Outcome information in the form of XML messages. These messages are transformed by the integration layer, and then sent to Oracle DataRaker.

The integration artifacts for Lead Outcome flow are as follows:

OSB Processes

Process Name Description

CCBDRLeadOutcome Processes Oracle Utilities Customer Care and Billing Lead Outcome message to the Oracle DataRaker file format and sends the file to Oracle DataRaker.

JMS Queues

Queue Name Description

CCBDRLeadOutcome Used to store the Oracle Utilities Customer Care and Billing Lead Outcome message.

CCBDRLeadOutcomeError Error queue for the Lead Outcome queue.

error/jms Directory if there are JMS errors. It is used internally by the process.

ftpArchive If the FTP services are used, then this directory is used for archiving files post successful FTP.

ftpError If the FTP services are used, then this directory is used for moving files if there are FTP errors.

inbound Directory where XML files for Oracle DataRaker are placed. This directory has files which can be consumed by integration.

stage Staging directory. It is used internally.

temp Directory for storing intermediate temporary files.

Directory Name Description

Integration Points

Understanding the Integration Process 2-7 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

Directory Structure

The Lead Outcome XML file is generated by integration in the files/Outbound/LeadOutcome directory. The sub-directories in the LeadOutcome directory are as follows:

2.2.2 Business Flag ProcessesThe integration incorporates the following integration points:

• Business Flag Request Flow Integration Process

• Business Flag Response Flow Integration Process

2.2.2.1 Business Flag Request Flow Integration Process The Business Flag request flow is a one-way asynchronous process triggered from the Oracle DataRaker system.

Technical Details

Oracle DataRaker sends the Business flag request information in the form of a file containing XML messages. These messages are transformed by the integration layer, and then sent to the Oracle Utilities Customer Care and Billing system.

Directory Name Description

archive Archive directory. It can be used by Oracle DataRaker for archiving files picked up for processing.

error Error directory where files are moved if there are errors during processing.

error/jms Directory if there are JMS errors. It is used internally by the process.

ftpArchive If the FTP services are used, then this directory is used for archiving files post successful FTP.

ftpError If the FTP services are used, then this directory is used for moving files if there are FTP errors.

outbound Directory where XML files for Oracle DataRaker are moved. This directory has files which can be consumed by Oracle DataRaker. Oracle DataRaker can either read files from this folder or FTP the file to a location where the file can be read from.

stage Staging directory. It is used internally.

temp Directory for storing intermediate temporary files.

Integration Points

Understanding the Integration Process 2-8 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

The integration artifacts for the Business Flag Request flow are as follows:

OSB Processes

Process Name Description

DRCCBBusinessFlagRequest Processes the Oracle DataRaker file containing multiple Business flag request messages to Oracle Utilities Customer Care and Billing format and sends the messages (one at a time) to Oracle Utilities Customer Care and Billing.

JMS Queues

Queue Name Description

DRCCBBusinessFlagRequest Used to store the Business flag request messages coming from Oracle DataRaker and transformed into the Oracle Utilities Customer Care and Billing format. The messages from queue are then sent to Oracle Utilities Customer Care and Billing.

DRCCBBusinessFlagRequestError Error queue for the Business flag request queue.

Directory Structure

The Business Flag Request Lead XML file is generated by Oracle DataRaker and placed in the files/Inbound/BusinessFlagRequest directory. The sub-directories in the BusinessFlagRequest directory are as follows:

Directory Name Description

archive Archive directory. It can be used by integration for archiving files coming from Oracle DataRaker picked up for processing.

error Error directory where files are moved if there are errors during processing.

error/jms Directory if there are JMS errors. It is used internally by the process.

ftpArchive If the FTP services are used, then this directory is used for archiving files post successful FTP.

ftpError If the FTP services are used, then this directory is used for moving files if there are FTP errors.

inbound Directory where XML files for Oracle DataRaker are placed. This directory has files which can be consumed by the integration.

stage Staging directory. It is used internally.

temp Directory for storing intermediate temporary files.

Integration Points

Understanding the Integration Process 2-9 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

2.2.2.2 Business Flag Response Flow Integration ProcessThe Business Flag Response flow is a one-way asynchronous process triggered from the Oracle Utilities Customer Care and Billing system.

Technical Details

Oracle Utilities Customer Care and Billing sends the Business Flag Response information in the form of XML messages. These messages are transformed by the integration layer, and then sent to Oracle DataRaker.

The integration artifacts for Business Flag Response Flow are as follows:

OSB Processes

Process Name Description

CCBDRBusinessFlagResponse Processes the Oracle Utilities Customer Care and Billing Business Flag Response message to Oracle DataRaker file format and sends the file to Oracle DataRaker.

JMS Queues

Queue Name Description

CCBDRBusinessFlagResponse Used to store the Oracle Utilities Customer Care and Billing Business Flag Response message.

CCBDRBusinessFlagResponseError Error queue for the Business Flag Response queue.

Directory Structure

The Business Flag Response XML file is generated by integration in the files/Outbound/BusinessFlagResponse directory. The sub-directories in the BusinessFlagResponse directory are as follows:

Directory Name Description

archive Archive directory. It can be used by Oracle DataRaker for archiving files picked up for processing.

error Error directory where files are moved if there are errors during processing.

error/jms Directory if there are JMS errors. It is used internally by the process.

ftpArchive If the FTP services are used, then this directory is used for archiving files post successful FTP.

ftpError If the FTP services are used, then this directory is used for moving files if there are FTP errors.

outbound Directory where XML files for Oracle DataRaker are moved. This directory has files which can be consumed by Oracle DataRaker. Oracle DataRaker can either read files from this folder or FTP the file to a location where the file can be read from.

Integration Points

Understanding the Integration Process 2-10 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

2.2.3 Common ProcessesThe integration has few common OSB processes that are used by the integration point specific OSB processes. The following common processes are part of the integration package:

• Resources Process

• Error Notification Process

• FTP Services Process (Optional)

2.2.3.1 Resources Process

Process Name Description

CCBDRResources Common integration process that contains the DVM, XSLT, WSDL and XSD files required for the integration.

The Resources process is a common OSB process that contains the DVM, XSLT, WSDL, and XSD files required for the integration. This way the customizations for schema and transformations used in the integration can be isolated to the Resources process.

OSB Processes

2.2.3.2 Error Notification ProcessThe Error Notification process is a common OSB process that is used to send email messages for error notifications. The OSB processes related to specific business process call the error notification process when there is an error, and error notification as email needs to be sent to the Administrator.

OSB Processes

Process Name Description

CCBDRErrorNotification Common Integration OSB process used to send out Error notification emails to Administrator.

2.2.3.3 FTP Services Process (Optional)The FTP Services process is a common OSB process used to FTP the Oracle DataRaker files that are processed by the integration or files that are created by the integration for Oracle DataRaker processing.

This is an optional process and is required only if the implementation requires it.

stage Staging directory. It is used internally.

temp Directory for storing intermediate temporary files.

Directory Name Description

Integration Points

Understanding the Integration Process 2-11 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

OSB Processes

Process Name Description

CCBDRFTPServices Common Integration OSB process used FTP files for processing by integration or files created by the integration process.

Part 2 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

Part 2 Implementing the Integration

Product

This section provides details on how to configure the participating applications and middle layer for this integration. It also includes information on error handling, monitoring, customization options, and data mapping.

This section contains the following chapters:

• Configuring the Integration

• Monitoring and Troubleshooting

• Customization Options

Part 2 - Implementing the Integration Product

Configuring the Integration 3-1 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

Chapter 3Configuring the Integration

This section provides details regarding the configuration settings required for the integration, including:

• Integration Configuration Checklist

• Setting up Oracle Utilities Customer Care and Billing

• Setting up Oracle DataRaker

• Setting up the Process Integration

3.1 Integration Configuration ChecklistExtensive configuration is required to implement the integration between Oracle Utilities Customer Care and Billing and Oracle DataRaker. This section provides a list of configuration tasks that may be used as a reference or roadmap, including:

• Oracle Utilities Customer Care and Billing Configuration

• Oracle DataRaker Configuration

• Integration Product Configuration

3.1.1 Oracle Utilities Customer Care and Billing Configuration

Refer to the Oracle Utilities Customer Care and Billing documentation for the Oracle Utilities Customer Care and Billing configuration details required for this integration.

3.1.2 Oracle DataRaker ConfigurationRefer to the Oracle DataRaker documentation for the Oracle DataRaker configuration details required for this integration.

3.1.3 Integration Product Configuration

Task Description

Setup JDeveloper Setup JDeveloper to make configuration changes in the code before deploying them to the OSB server

Service Endpoint Set CC&B service endpoints using the Service Endpoint DVM

Setting up Oracle Utilities Customer Care and Billing

Configuring the Integration 3-2 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

3.2 Setting up Oracle Utilities Customer Care and BillingFor more information about the configuration guidelines, see the Oracle Utilities Customer Care and Billing user documentation.

3.3 Setting up Oracle DataRakerFor more information about the configuration guidelines, see the Oracle DataRaker user documentation.

3.4 Setting up the Process IntegrationThe following sections describe how to configure integration pack to meet the requirements for a two-way integration. Configuration steps include setting the following:

• Setting JDeveloper for the Integration Layer

• Setting Service Endpoint for the Integration

• Setting Domain Value Maps for the Integration

• Setting Error Notification for the Integration

• Setting FTP User Account for the Integration Layer

3.4.1 Setting JDeveloper for the Integration LayerThe integration resources can be edited before the deployment on OSB server using JDeveloper. The JDeveloper setup is optional and any text editor can be used for editing the OSB process files. JDeveloper provides the user interface and makes editing the files easier.

To open the OSB processes in JDeveloper follow these steps:

1. Open JDeveloper 12.2.1.

2. Navigate to File > New > Application > Service Bus Application. Click OK.

Domain Value Maps Set Domain value maps (DVMs) to map codes and other static values across applications.

Error Notification Setup error notification

FTP user account Setup FTP user account

Task Description

Setting up the Process Integration

Configuring the Integration 3-3 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

Creating Service Bus Application

3. On the Name your application screen, provide the Application Name (for example: CCB-DRServiceBusApp) and then click Finish.The Service Bus Application is created.

4. Open the projects provided as part of the package in this Service Bus Application.

5. In JDeveloper, navigate to File > Open and select the OSB process 'jpr' file (for example: CCBDRBusinessFlagResponse.jpr). Click Open.Once all the projects are opened in the Service Bus Application, the code is ready for editing.

Opening Projects in Service Bus Application

Setting up the Process Integration

Configuring the Integration 3-4 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

3.4.2 Setting Service Endpoint for the IntegrationThe integration invokes two web services in Oracle Utilities Customer Care and Billing. The endpoints for these services are configured in the CCBDRResource > Resources > DVM > ServiceEndpointConfig.dvm file. Implementers can edit the values in DVM and set the Oracle Utilities Customer Care and Billing endpoints.

1. Open the DVM in a text editor or in JDeveloper to modify the values.

2. Set the endpoint values for the following:

• CCBBusinessFlagSyncService

• CCBPrioritizedLeadsService

Mapping Endpoints

After the correct endpoints are set, the project (for example: CCBDRResources) needs to be redeployed on the OSB server.

3.4.3 Setting Domain Value Maps for the IntegrationDomain value maps (DVMs) are a standard feature of the Oracle Service Bus that maps codes and other static values across applications.

For example: “US” and “USA”

DVMs are static in nature, though Administrators can add additional maps as needed. Transactional business processes never update DVMs - they only read from them. They are stored in XML files and cached in memory at runtime.

Note: After the required DVM data is updated the CCBDRResources OSB process must be redeployed on the OSB server.

Setting up the Process Integration

Configuring the Integration 3-5 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

The following DVMs are part of the integration:

3.4.3.1 ServiceEndpointConfigThis is a common DVM used to map endpoints to service codes. The endpoints can be set for the Oracle Utilities Customer Care and Billing web services invoked by the integration processes.

The DVM, out of the box, has two Oracle Utilities Customer Care and Billing service keys and web service endpoints. Implementers should not modify the existing service names as these are used in the code.

3.4.3.2 CCBDR_EmailConfigThis is a common DVM used to set the email addresses for the notifications sent by the integration for integration errors.

The DVM, out-of-the-box has different error types for an integration process, email text, email subject, to and from columns. Implementers should not modify the existing error type names as these are used in the code.

Process Name Description

ServiceEndpointConfig Common DVM used to map endpoints to service codes. The endpoints can be set for the Oracle Utilities Customer Care and Billing web services invoked by the integration processes.

CCBDR_EmailConfig Common DVM used to set the email addresses for the notifications sent by the integration for integration errors.

CCBDR_Initiative DVM used by Lead Segmentation integration. This DVM is used to map the initiative from Oracle Utilities Customer Care and Billing with fields in the Oracle DataRaker message.

CCBDR_LeadPriority DVM used by Lead Segmentation. This DVM is used to map the Lead priority between Oracle Utilities Customer Care and Billing and Oracle DataRaker.

CCBDR_BusinessFlag DVM used by the Business flag integration. This DVM is used to map the standard name from Oracle DataRaker with fields in the Oracle Utilities Customer Care and Billing message.

CCBDR_BusnFlagConfidence DVM used by the Business flag integration. This DVM is used to map the Business flag confidence between Oracle Utilities Customer Care and Billing and Oracle DataRaker.

CCBDR_BusnFlagPriority DVM used by Business flag integration. This DVM is used to map the Business flag priority between Oracle Utilities Customer Care and Billing and Oracle DataRaker.

Column Name Sample Value Description

service CCBBusinessFlagSyncService Service name

endpoint https://host:port/ webservices/F1-BusinessFlagSync

Web service endpoint URL

Setting up the Process Integration

Configuring the Integration 3-6 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

3.4.3.3 CCBDR_InitiativeThis DVM is used by Lead Segmentation integration. It is used to map the Initiative from Oracle Utilities Customer Care and Billing with fields in the Oracle DataRaker message.

The Lead data from Oracle Utilities Customer Care and Billing is mapped to FACT format provided by Oracle DataRaker. The values for description, lu, category, tb and ptc are required by Oracle DataRaker and must be configured in the DVM.

3.4.3.4 CCBDR_LeadPriorityThis DVM is used by Lead Segmentation integration. It is used to map the Lead priority between Oracle Utilities Customer Care and Billing and Oracle DataRaker.

3.4.3.5 CCBDR_BusinessFlagThis DVM is used by Business flag integration. It is used to map the Standard name from Oracle DataRaker with fields in the Oracle Utilities Customer Care and Billing message.

The values for description, lu, category, tb and ptc are required by Oracle DataRaker and must be configured in the DVM.

Column Name Sample Value Description

type GenLeadJMSError Error Type

text CCB Generated Lead Integration: Error sending JMS messages to temp file

Email Text

subject CCB-DR Integration - Generated Leads JMS Error

Email subject

to [email protected] Email will be sent to

from [email protected] Email sent from

Column Name Sample Value Description

initiative ENRGY Oracle Utilities Customer Care and Billing initiative code

description Energy Initiative Initiative description

lu INIT_ENRGY Fact lookup in Oracle DataRaker

category Initiative Fact category in Oracle DataRaker

tb DAILY Time basis of the data being provided

ptc PRMS Point type code of data being provided

Column Name Sample Value Description

DR_LeadPriority High Oracle DataRaker Lead priority code

CCB_LeadPriority C1HG Oracle Utilities Customer Care and Billing Lead priority code

Setting up the Process Integration

Configuring the Integration 3-7 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

3.4.3.6 CCBDR_BusnFlagConfidenceThis DVM is used by Business flag integration. It is used to map the Business flag confidence between Oracle Utilities Customer Care and Billing and Oracle DataRaker.

3.4.3.7 CCBDR_BusnFlagPriorityThis DVM is used by Business flag integration. It is used to map the Business flag priority between Oracle Utilities Customer Care and Billing and Oracle DataRaker.

3.4.4 Setting Error Notification for the IntegrationThe integration uses the DVM CCBDR_EmailConfig for sending out error notification emails. This DVM, out of the box, has different error types for an integration process, email text, email subject, to and from columns. Implementers should not modify the existing error type names as these are used in the code. The rest of the fields email text, email subject to and from email addresses can be modified by the implementation.

The email server configuration can be updated in the CCBDRSMTPServer.smtp file. This file is available under the JDeveloper application > System directory. In JDeveloper, the file can be viewed and modified from Application Resources > Service Bus System Resources folder.

Column Name Sample Value Description

standardName ENRGY Standard name for the business flag in Oracle DataRaker

description Energy Initiative Initiative description

lu INIT_ENRGY Fact lookup in Oracle DataRaker

catergory Initiative Fact category in Oracle DataRaker

tb DAILY Time basis of the data being provided

ptc PRMS Point type code of data being provided

Column Name Sample Value Description

DR_ BusnFlagConfidence High Oracle DataRaker Business flag confidence code

CCB_BusnFlagConfidence C1HG Oracle Utilities Customer Care and Billing Business flag confidence code

Column Name Sample Value Description

DR_ BusnFlagConfidence High Oracle DataRaker Business flag confidence code

CCB_BusnFlagConfidence C1HG Oracle Utilities Customer Care and Billing Business flag confidence code

Setting up the Process Integration

Configuring the Integration 3-8 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

Service Bus System Resources

Note: After the required DVM data or SMTP file is updated, the CCBDRResources OSB process must be redeployed on the OSB server.

3.4.5 Setting FTP User Account for the Integration LayerIf CCBDRFTPServices OSB process is used to FTP the files from and to remote server, then the FTP User account needs to be created in the Integration.

To set the details of the FTP User account in JDeveloper update the Projects > CCBDRResources > Resources > ServiceAcct > DataRakerFTPSA.sa file.

Setting Up Accounts

Note: After the required Service Account data is updated the CCBDRResources OSB process must be redeployed on the OSB server.

Monitoring and Troubleshooting 4-1 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

Chapter 4Monitoring and Troubleshooting

This section provides information on the following:

• Monitoring from Oracle Utilities Customer Care and Billing

• Monitoring from Oracle DataRaker

• Monitoring from the Integration

• Troubleshooting

4.1 Monitoring from Oracle Utilities Customer Care and BillingRefer to the Oracle Utilities Customer Care and Billing user documentation for more details about monitoring in Oracle Utilities Customer Care and Billing.

4.2 Monitoring from Oracle DataRakerRefer to the Oracle DataRaker user documentation for more details about monitoring in Oracle DataRaker.

4.3 Monitoring from the IntegrationUse any of the following to monitor the integration:

• Monitoring Using WebLogic Logs

• Monitoring the Queues Using WebLogic Console

4.3.1 Monitoring Using WebLogic LogsLogin to the machine where OSB server is installed. The OSB logs are stored in:

<WebLogic installation folder>/user_projects/domains/<OSB Domain name>/servers/<OSB Server name>/logs

For example: / Oracle/Middleware/Oracle_Home/user_projects/domains/osb_domain/servers/osb_server1/logs

Troubleshooting

Monitoring and Troubleshooting 4-2 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

4.3.2 Monitoring the Queues Using WebLogic ConsoleTo monitor the queues, follow these steps:

1. Login to WebLogic Console.

2. Navigate to Services > Messaging > JMS Modules.All queues used for the integration are available in the JMS Module “CCBDRJMSModule”.

3. Select the appropriate queue on the list and then click the Monitoring tab.

4. On the Monitoring tab, check if the message is in the queue because there are no consumers listening to the queue. Then, check how many consumers are listening to the queue.If the Consumers Current column is ‘0’, it means no consumers are listening to the queue.

5. Check the message rolled back to the error queue:

a. Select the appropriate error queue on the list and navigate to the Monitoring tab.

b. On the tab, the message is displayed.

4.4 TroubleshootingAt times, Oracle Utilities Customer Care and Billing integration to Oracle DataRaker might experience errors or issues with connection, processing, or sending or receiving messages. Following are the common scenarios that help you to troubleshoot error, if any, and find possible solutions.

4.4.1 Oracle Utilities Customer Care and Billing Initiated Messages

The administrator usually get an error email if there are any issues while sending messages from Oracle Utilities Customer Care and Billing to Oracle DataRaker.

Following are the error scenarios and actions that can be taken to rectify the issue.

1. JMS Error

Messages coming from Oracle Utilities Customer Care and Billing are stored in a JMS queue. The OSB process is unable to process these and create the Oracle DataRaker XML file due to errors. The messages in this case are moved to the integration processes error queue. Once the error problem has been fixed the messages can be moved back to the main queue for reprocessing.

To move the messages back to the Error queue, follow these steps:

a. Login to WebLogic Console.

b. Navigate to Services > Messaging > JMS Modules.

c. From the JMS Modules list, select CCBDRJMSModule.

d. From the list of Summary Resources, select the integration error queue.

Troubleshooting

Monitoring and Troubleshooting 4-3 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

Summary of Resources

e. Navigate to the Monitoring tab and click Show Messages.

f. In the JMS Messages section, click Move to select Move All.

g. In the Move JMS Messages section, click the JMS Server drop-down list and select “CCBDRJMSServer”.

h. Click Next.

i. In the Destination drop-down list, select the correct Destination queue and then click Finish.

This moves all the messages back to the main queue for reprocessing.

2. File Error

The Oracle Utilities Customer Care and Billing messages are stored in a JMS queue and then written to a Temp text file. The file error can occur while transforming the Temp file to the final XML file. In case of this error the Temp file is moved to the error directory (/files/Outbound/<integration>/error directory).

For example: /files/Outbound/GeneratedLead/error

After the error is resolved, to reprocess the file, move the file from /files/Outbound/<integration>/error directory to the /files/Outbound/ <integration> /temp directory.

3. FTP Error

This error can occur if the optional FTP process is used to move the final XML file to a remote FTP directory. If the FTP transfer fails, then the final XML file is moved to the ftpError directory (/files/Outbound/<integration>/ftpError directory).

For example: /files/Outbound/GeneratedLead/ftpError

After the error is resolved, to reprocess the file, move the XML file from /files/Outbound/<integration>/ftpError directory to the /files/Outbound/ <integration> /outbound directory.

Troubleshooting

Monitoring and Troubleshooting 4-4 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

4.4.2 Oracle DataRaker Initiated MessagesThe administrator usually gets an error email if there are any issues while sending messages from Oracle DataRaker to Oracle Utilities Customer Care and Billing.

Following are the error scenarios and actions that can be taken to rectify the issue:

1. JMS Error

Messages coming from Oracle Utilities Customer Care and Billing are stored in a JMS queue. The OSB process is unable to send the messages to Oracle Utilities Customer Care and Billing (for example: Oracle Utilities Customer Care and Billing is not up and running). The messages in this case are moved to the integration processes Error queue. Once the error has been fixed, the messages are moved back to the main queue for reprocessing.

To move the messages back to the Error queue, follow these steps:

a. Login to WebLogic Console.

b. Navigate to Services > Messaging > JMS Modules.

c. From the JMS Modules list, select CCBDRJMSModule.

d. From the list of Summary Resources, select the integration error queue.

Summary of Resources

e. Navigate to the Monitoring tab and click Show Messages.

f. In the JMS Messages section, click Move to select Move All.

g. In the Move JMS Messages section, click the JMS Server drop-down list and select “CCBDRJMSServer”.

h. Click Next.

i. In the Destination drop-down list, select the correct Destination queue and then click Finish.

This moves all the messages back to the main queue for reprocessing.

Troubleshooting

Monitoring and Troubleshooting 4-5 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

2. File Error

The Oracle DataRaker messages are read from the XML file, transformed into the Oracle Utilities Customer Care and Billing format and stored in a JMS queue. The file error can occur while transforming the XML file to JMS messages. In case of this error, the XML file is moved to the error directory (/files/Inbound/<integration>/error directory).

For example: /files/Inbound/PrioritizedLead/error

After the error is resolved, to reprocess the file, move the XML file from /files/Inbound/<integration>/error directory to the /files/Inbound/<integration >/inbound directory.

3. FTP Error

This error can occur if the optional FTP process is used to move the Oracle DataRaker XML file from remote FTP directory to the /files/Inbound/<integration>/inbound directory. If the FTP transfer fails, then the error message will be sent out.

To resolve this, manually FTP the files to the /files/Inbound/<integration>/inbound directory.

For example: /files/Inbound/PrioritizedLead/inbound

Customization Options 5-1 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

Chapter 5Customization Options

The integration provides ways for implementers to modify the messages going to Oracle Utilities Customer Care and Billing and Oracle DataRaker. As shown in the figure below there is a common CM OSB process that is used to customize the messages.

The CM OSB process contains the resources (XSD schemas, XSL transformations, and DVM files) required for message handling.

The Base OSB process JCA adapters refer to the schemas in the CM process. Also, the transformation component in the Base process refers to the DVM and XSL files in the CM process.

Implementers can modify the resources in the CM process and redeploy it to the OSB server. This way, the Base CM process does not require any changes.

Customization

The CCBDRResources OSB process is the CM process available with this integration. Implementers can update the following based on their requirements and then redeploy the CCBDRResources process to the OSB server for the changes to take effect.

Customization Options 5-2 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

Transformations

The XSL transformations are available in the CCBDRResources > XSLT directory. These can be modified if implementation wants to change the mapping between Oracle Utilities Customer Care and Billing and Oracle DataRaker.

The File Adapter and JMS Adapter schemas can also be modified which are under CCBDRResources > XSD directory.

Note: After the required updates, CCBDRResources OSB process must be redeployed on the OSB server.

Integration Transformation XSL

CCBDRGeneratedLead CCBGeneratedLead_Transform_to_DRFact.xsl

DRCCBPrioritizedLead DRPrioritizedLeadFact_Transform_to_CCBPrioritizedLead.xsl

CCBDRLeadOutcome CCBLeadOutcome_Transform_to_DRFact.xsl

DRCCBBusinessFlagRequest DRBusinessFlagReqFact_Transform_to_CCBBusinessFlagReq.xsl

CCBDRBusinessFlagResponse CCBBusinessFlagResp_Transform_to_DRFact.xsl

Security 6-1 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

Chapter 6Security

This integration uses the Oracle Web Services Manager (OWSM) policy framework to secure the integration services. Implementation can change the security policies on Proxy Services and External Services using JDeveloper. The policies can be selected as per requirement and OSB processes redeployed to the OSB Server.

The following Proxy Services and External Services can be secured via OWSM policies. The Proxy Services are secured by a service policy and External Services invoke external web service, and hence use a client policy.

Perform the following steps to attach/modify the security policies:

1. Open the OSB service in JDeveloper.

2. Select and right-click the Proxy Service or External service, and then click Configure OSB WS Policies.

Integration Point Proxy Service External Service

Generated Lead GenLeadSOAPPS NA

Lead Outcome LeadOutcomeSOAPPS NA

Prioritized Lead NA CCBPrioritizedLeadsBS

Business Flag Request NA CCBBusnFlagSyncBS

Business Flag Response BusnFlagRespSOAPPS NA

Security 6-2 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Implementation Whitepaper

Configuring OSB WS Policies

The Policy Configuration page appears.

3. Click + in the Security section. A list of security policies is displayed.

4. Select the security policy to be attached.

5. After the policy is attached, save the changes. Then, redeploy the OSB process.

Note: For more information on OWSM, see https://docs.oracle.com/middleware/1221/owsm/concepts/toc.htm.