Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation WhitepaperRelease 12.2 Media Pack
E78072-01
July 2016
Implementation Guide
Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation 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 Installation Whitepaper
Overview........................................................................................................................................ 1-1Additional Resources .................................................................................................................................................... 1-1Abbreviations ................................................................................................................................................................. 1-1
Installation ..................................................................................................................................... 2-1Software Requirements................................................................................................................................................. 2-1
Participating Applications ..................................................................................................................................... 2-1Oracle Service Bus/ WebLogic Server ............................................................................................................... 2-1Oracle JDeveloper Studio Edition....................................................................................................................... 2-2
Pre-Installation Tasks.................................................................................................................................................... 2-2Installation Steps............................................................................................................................................................ 2-2Installing the Integration .............................................................................................................................................. 2-7Post-Installation Checklist............................................................................................................................................ 2-7
Verifying JMS Configuration................................................................................................................................ 2-8Verifying Directories in Product Home ............................................................................................................. 2-8
Configuring Edge Applications ................................................................................................................................... 2-9
Deploy OSB Processes ............................................................................................................... 3-1
Uninstalling the Integration ......................................................................................................... 4-1
Contents
Overview 1-1 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation Whitepaper
Chapter 1 Overview
This guide describes the installation steps that must be completed before Oracle Utilities Customer Care and Billing can be integrated with Oracle DataRaker.
Additional ResourcesFor more information regarding this integration, foundation technology and the edge applications, refer to the following documents:
AbbreviationsThe abbreviations used in this guide are listed below:
• CCB - Oracle Utilities Customer Care and Billing
• DataRaker - Oracle DataRaker
• OSB - Oracle Service Bus
Topic Description
Edge application documentation:
Oracle Utilities Customer Care and Billing documentation
Oracle DataRaker documentation
Refer to the Oracle applications documentation page:http://docs.oracle.com/cd/E72219_01/documentation.html
Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Release 12.2 Media Pack Implementation Whitepaper
Same folder as this document, with the distribution for this product or the OTN page:http://docs.oracle.com/cd/E72219_01/documentation.html
Oracle Support Access 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 apprised of changes.
Oracle University for training opportunities
http://education.oracle.com/
Installation 2-1 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation Whitepaper
Chapter 2 Installation
The following sections describe the settings and requirements for a successful installation of Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Media Pack.
This section provides information on the following:
• Software Requirements
• Pre-Installation Tasks
• Installation Steps
• Installing the Integration
• Post-Installation Checklist
• Configuring Edge Applications
2.1 Software RequirementsThe following software and platforms must be installed and configured before the integration pack can be installed.
Note: For complete details, refer to the product specific installation instructions.
2.1.1 Participating Applications• Oracle Utilities Customer Care and Billing v2.5.0.2 or higher installed on an
Oracle database with the latest supported service pack.
• Oracle DataRaker v3.8.0.2 or higher installed with the latest supported service pack.
2.1.2 Oracle Service Bus/ WebLogic Server• Oracle Service Bus 12c with Oracle Enterprise Manager 12.2.1.0.0 or higher on
WebLogic Server 12.2.1.0.0
Pre-Installation Tasks
Installation 2-2 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation Whitepaper
2.1.3 Oracle JDeveloper Studio Edition• Oracle JDeveloper Studio Edition version 12.2.1 or higher. You can install SOA
Suite 12.2.1 which comes with JDeveloper and local integrated WebLogic server.
http://www.oracle.com/technetwork/middleware/soasuite/downloads/index.html
2.2 Pre-Installation TasksThe following tasks should be completed before you install the integration media pack:
1. Ensure that Oracle Service Bus 12c (12.2.1) or higher is installed and running. For more information, refer to the documentation at: http://www.oracle.com/technetwork/middleware/soasuite/documentation/index.html#122100.
2. Login to the WebLogic Server Administration console to confirm there are no changes in Pending Activation status.
3. Restart the Enterprise Manager and the WebLogic Admin server.
4. Ensure the WebLogic Admin server and OSB are up and running.
2.3 Installation StepsPerform the following steps to complete the installation procedure:
1. Download the installation CCB-DataRaker.zip file from Oracle Software Delivery Cloud (http://edelivery.oracle.com/).
Note: For specific instructions about installing this integration on non-Windows/ Linux platforms see Oracle Support Knowledge article ID 1349320.1.
Installation Steps
Installation 2-3 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation Whitepaper
2. Extract the zip file to get the installation folder. This folder includes subfolders, such as bin, config, Install, and services.
CCB-DataRaker Product Home Directory
3. Set the following environment variables for Linux and Windows OS:
Variable Example
MW_HOME XXX/Middleware/Oracle_Home
PRODUCT_HOME Directory where CCB-DataRaker.zip is extracted.
Example:Unix/Linux: PRODUCT_HOME=/slot/oracle/CCB-DataRakerWindows: PRODUCT_HOME=D:\Oracle\CCB-DataRaker
Note: The syntax for PRODUCT_HOME changes depending on whether you are installing on Linux or Windows.
The following sections refer to this as $PRODUCT_HOME in Linux and it should be referred to as %PRODUCT_HOME% in Windows. If you are using Windows, replace $PRODUCT_HOME with %PRODUCT_HOME% throughout the document.
The following commands (setWLSEnv.sh on Linux and setWLSEnv.bat on Windows) set the environment variables used for executing the installation scripts.
• Linux:source $MW_HOME/wlserver/server/bin/setWLSEnv.sh
• Windows:cd %MW_HOME%\wlsserver\server\bin\ setWLSEnv.cmd
Installation Steps
Installation 2-4 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation Whitepaper
Below is an example to set up environment variables in a typical installation:
• Linux:export MW_HOME=/Oracle/Middleware/Oracle_Homeexport PRODUCT_HOME=/Product_Homes/CCB-DataRakersource $MW_HOME/wlserver/server/bin/setWLSEnv.sh
• Windows:SET MW_HOME=C:\Oracle\Middleware\Oracle_HomeSET PRODUCT_HOME=C:\Product_Homes\CCB-DataRakercd %MW_HOME%/wlserver/server/bin/setWLSEnv.cmd
InstallProperties.xml is an XML file under the PRODUCT_HOME/config folder. Ensure you follow XML editing standards while editing InstallProperties.xml. All XML elements need to be closed properly. XML element in InstallProperties.xml file does not contain any attribute.
The following table lists the properties available in the InstallProperties.xml file along with their usage. The default values are specified wherever applicable.
Property Description Example
<config>
<modulename> Name of the integration module.
Default: CCB-DRDo not change this value.
<OSB>
CCB Web service Information
<CCB_WS_URL> CCB Web service root path http://host:port/webservices
OSB Information
Admin Server Information
<AdminServer>
<hostname> Host name of the server where admin server hosting OSB is installed.
adminserver.example.oracle.com
<portnumber> Port number the admin server (hosting OSB) is listening to.
7001
<servername> Admin server name (hosting OSB)
AdminServer
<username> User name used to log in as an Admin server (hosting OSB) administrator.
WebLogic
<password> Password used to log in as an Admin server (hosting OSB) administrator.
<domainname> WebLogic domain name hosting OSB.
soa_domain
Installation Steps
Installation 2-5 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation Whitepaper
Managed Server Information
<ManagedServer>
<hostname> Host name of the server where managed server (hosting OSB) is installed.
managedserver.example.oracle.com
<portnumber> Port number the managed server (hosting OSB) is listening to.
8001
<servername> Managed server name (hosting OSB)
Managedserver1
<username> User name used to log in to managed server (hosting OSB) as an administrator.
WebLogic
<password> Password used to log in to managed server (hosting OSB) as an administrator.
Oracle HTTP Server Information
<OHS> In case of non-cluster environment these properties would be same as <ManagedServer> values.
<hostname> Oracle HTTP server host name
Oracle http server where cluster is managed.
<Portnumber> Oracle HTTP server port number
Port number of the Oracle http server.
<servernames> In case of multiple managed servers, provide comma separated values.
Example:osbserver1, osbserver2
JMS Information
<JMS>
<serverName> JMS server name
Note: Do not change this value.
Default: CCBDRJMSServer
<ModuleName> JMS module name Default: CCBDRJMSModule
Note: Do not change this value.
Property Description Example
Installation Steps
Installation 2-6 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation Whitepaper
<SubDeploymentName> Sub deployment name for JMS queues
Default: CCBDRSubdeployment
Note: Do not change this value.
<JMSServerTarget> WebLogic managed server name
For cluster environment give only one managed server names under the cluster or cluster name
<JMSModuleTargets> WebLogic managed server name
For cluster environment give comma separated managed server names under the cluster or multiple cluster names
<PersistentStoreType> JMS persistent store name Default: CCBDRFileStore
<PersistentStoreFilename> JMS persistent store type (FileStores or DBStore). Deployment script supports a file.
Default: FileStores
<PersistentStoreName> Directory path name where the file based persistent store should be created.
/scratch/Oracle/Product_Homes/CCB-DataRaker/bin
<JMSCFName> JMS connection factory name CCBDRConnectionFactory
<JMSCFJNDI> JMS Connection factoy jndi name
jms/CCB-DR/CCBDRConnectionFactory
Email Information
<EMAIL>
<ADMIN_EMAIL> The default FROM address (if one is not provided in the outgoing message)
mail.id@ yourdomain.com
<serverURL> The name of the SMTP server. Mandatory only if an e-mail needs to be sent.
host.yourdomain. com
<description> The SMTP server description
<portNumber> The port number of SMTP server.
465
<username> The user name used for SMTP authentication. Required only if SMTP authentication is supported by the SMTP server.
username
Property Description Example
Installing the Integration
Installation 2-7 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation Whitepaper
Also note the following:
• $PRODUCT_HOME/Install/util/ant folder contains all the ant build scripts.
• $PRODUCT_HOME/bin/InstallBuild.xml is used to install CCB-DataRaker integration code.
• $PRODUCT_HOME/bin/UnInstallBuild.xml is used to uninstall CCB-DataRaker integration code.
Note: The installation and uninstallation process may take several minutes or more to complete. Stand by until the install and uninstall processes are complete.
2.4 Installing the IntegrationAfter setting the environment variables, open a command prompt and execute the following installation scripts in Linux and Windows respectively.
Execute the following commands at the Command prompt:
• Linux: cd $PRODUCT_HOME/bin ant -f InstallBuild.xml InstallWL -DInstallProperties=$PRODUCT_HOME/config/InstallProperties.xml -l InstallWL.log
• Windows: cd %PRODUCT_HOME%\bin ant -f InstallBuild.xml InstallWL - DInstallProperties=%PRODUCT_HOME%/config/InstallProperties.xml -l InstallWL.log
These commands perform the following tasks:
• Create directory structure in the PRODUCT_HOME for the incoming and outgoing files.
• Create the JMS artifacts.
• De-tokenize the OSB artifacts in the JDeveloper application and gets it ready for deployment using JDeveloper.
2.5 Post-Installation ChecklistAfter executing the installation scripts, follow these steps to complete the installation.
1. Verify that all the JMS and JDBC resources were created. See Verifying JMS Configuration for the instructions.
2. Verify if all file directories are created. See Verifying Directories in Product Home for specific steps.
<password> The password used for SMTP authentication. Required only if SMTP authentication is supported by the SMTP server.
password
Property Description Example
Post-Installation Checklist
Installation 2-8 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation Whitepaper
2.5.1 Verifying JMS ConfigurationPerform the following steps to verify JMS configuration:
1. Open a WebLogic Admin console and navigate to Home > JMS Modules > CCBDRJMSModule.
2. Verify if the queues and CCBDRConnectionFactory were created successfully as shown in the figure below.
CCBDRJMSModule Queues
2.5.2 Verifying Directories in Product HomeVerify that the directories are created in Product Home. These directories will be used by the OSB processes.
Note: The sub folders for BusinessFlagRequest and PrioritizedLead are similar. The sub folders for BusinessFlagResponse, GeneratedLead, and LeadOutcome are similar.
Product Home Directories
Configuring Edge Applications
Installation 2-9 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation Whitepaper
2.6 Configuring Edge ApplicationsConfigure Oracle Utilities Customer Care and Billing and Oracle DataRaker installation according to the guidelines in the Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Release 12.2 Media Pack Implementation Whitepaper.
Deploy OSB Processes 3-1 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation Whitepaper
Chapter 3 Deploy OSB Processes
This section describes how to deploy individual OSB processes. JDeveloper is used to deploy OSB processes on the OSB server.
Perform the following steps to deploy the OSB processes:
1. Open JDeveloper.
2. Navigate to File > Open > PRODUCT_HOME/services/industry/Utilities/OSB/CCB-DRServiceBusApp/CCB-DRServiceBusApp.jws. The processes are displayed in the Applications pane.
Processes in the Applications Pane
3. In JDeveloper, open the Resources pane.
4. Navigate to IDE Connections > Application Server.
5. Right-click Application Server and click New Application Server Connection. The Create Application Server Connection window opens.
Deploy OSB Processes 3-2 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation Whitepaper
Create Application Server Connection Window
6. Create a connection to the OSB server by providing the Connection Name, username/password, host, port and domain name.
Creating the Connection
Deploy OSB Processes 3-3 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation Whitepaper
7. Test the connection to ensure that JDeveloper can connect to the OSB server.
Testing the Connection
8. Deploy the processes from JDeveloper to OSB server. In the Projects pane, right-click on the process and select Deploy > <ProcessName>.
Selecting the Process Name
Deploy OSB Processes 3-4 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation Whitepaper
9. In the Deployment Action page, select Deploy to Service Bus Server and click Next.
Deploying to Service Bus Server
10. In the Select Server page, select the OSB server connection and click Next.
Selecting the Server
Deploy OSB Processes 3-5 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation Whitepaper
11. On the Summary page, click Finish. This will deploy the OSB process to OSB server.
Deployment Summary
12. Open the OSB console (http://<Admin_server_host>:<Admin_port>/sbconsole) to view the deployed processes in OSB server.
Deployed Processes in OSB Server
If any changes are made in the OSB process code, it can be redeployed on the OSB server for the changes to take effect.
Below is the list of processes to be deployed to the OSB Server:
• CCBDRResources
• CCBDRErrorNotification
• CCBDRFTPServices (Optional process required if the output files need to be moved to a different location via FTP)
Deploy OSB Processes 3-6 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation Whitepaper
• CCBDRBusinessFlagResponse
• CCBDRGeneratedLead
• CCBDRLeadOutcome
• DRCCBBusinessFlagRequest
• DRCCBPrioritizedLead
Uninstalling the Integration 4-1 Oracle Utilities Customer Care and Billing Integration to Oracle DataRaker Installation Whitepaper
Chapter 4 Uninstalling the Integration
To uninstall the integration, complete the following steps:
1. Restart the WebLogic Admin server and the SOA server.
2. Set the environment variables as mentioned in the Installation Steps section.
3. Execute the commands at the Command prompt:
• Linux: cd $PRODUCT_HOME/bin ant -f UnInstallBuild.xml uninstallWL - DInstallProperties=$PRODUCT_HOME/config/InstallProperties.xml - l uninstallWL.log
• Windows:cd %PRODUCT_HOME%\bin ant -f UnInstallBuild.xml uninstallWL - DInstallProperties=%PRODUCT_HOME%/config/InstallProperties.xml -l uninstallWL.log
These commands delete the JMS resources (JMS module/ JMS persistent store/ JMS server).
After executing these commands, bounce the managed server and admin server manually.
Note: The OSB processes can be deleted manually from the OSB console. The directories created in the PRODUCT HOME should be deleted manually.