Setting Up the Development Environment

3 Setting Up the Development Environment

Learn how to set up your Integrated Development Environment (IDE) for customizing Oracle Communications Billing Care.

Topics in this document:

About the Billing Care Development Environment

You customize Billing Care using an IDE configured to work with the Oracle WebLogic Server domain on which Billing Care is deployed. Typically, you connect to a development Billing Care domain, perform your customizations, test, and then package and deploy your customizations as a shared library to your production Billing Care domain. Billing Care references the customization shared library when rendering the user interface (UI) and performing Billing Care operations.

To increase efficiency during development and testing, use an exploded archive deployment of your customizations. Exploded archive deployments enable WebLogic Server to reference customized files on a local file system instead of a deployed customization shared library in the domain. You can change the referenced files seen in Billing Care without having to package and deploy a customizations shared library each time you make changes. See "Using an Exploded Archive during Customization" for more information on using exploded archives during customization.

Oracle recommends NetBeans IDE for customizing Billing Care. The following sections explain configuring NetBeans IDE to customize Billing Care. For more information on NetBeans IDE see:

https://netbeans.apache.org

Configuring NetBeans IDE for Billing Care Development

To use NetBeans IDE for Billing Care customization, you must complete the following tasks:

Downloading and Installing NetBeans IDE

Download and install NetBeans IDE on the same server hosting your Billing Care domain before configuring a connection to your Billing Care WebLogic server.

For detailed instructions, including additional software requirements, on downloading and installing NetBeans IDE, see:

https://netbeans.org/community/releases/80/install.html

Configuring the NetBeans IDE Connection to WebLogic Server

After installing NetBeans IDE, you configure a connection to the running WebLogic Server domain on which Billing Care is deployed. For information on installing Billing Care and starting your domain see Billing Care Installation Guide.

To configure a NetBeans IDE connection to the Billing Care domain:

Start the NetBeans IDE.
Select the Services tab.
Right-click Servers and select Add Server.
In the Choose Server screen, select Oracle WebLogic Server. Provide a name in the Name field and click Next.
In the Server Location screen, enter the path or browse to the wlserver folder of the WebLogic Server installation containing the Billing Care domain, then click Next.
In the Instance Properties screen, provide the path to the domain folder where Billing Care is deployed in the Domain field.
Enter the Username and Password for your domain's administrative user, then click Finish.

NetBeans IDE configures the connection to the domain. Verify that the connection is successful by expanding the Servers node in the Services tab. Your domain should be listed.

Setting Up a Billing Care Customization Project

You perform customizations to Billing Care in a NetBeans IDE project containing the Billing Care SDK. Complete the following required tasks to set up your Billing Care customization project:

Creating the Billing Care SDK Directory Structure

The Billing Care customization NetBeans IDE project requires a specific directory structure, described in Table 3-1, for proper packaging of the customizations shared library you build and deploy to the Billing Care domain.

To create the required directory structure on your NetBeans IDE host:

Create a project directory (For example, myproject).
Within your project directory, create the following subdirectories listed in Table 3-1.

Table 3-1 Required Billing Care Customization Directories

Directory	Description
myproject/web/custom	Location for customRegistry.js and customModule.properties used when overriding the default modules.
myproject/web/custom/css	Location for required CSS files required by your customizations.
myproject/web/custom/jsons	Location for any JSON files generated by the Data Model Generator for custom UI elements.
myproject/web/custom/images	Recommended location for image files referenced in your HTML and CSS files.
myproject/web/custom/js	Location for custom JavaScript files used by your customizations.
myproject/web/custom/js/templates/area/configure where area is the customization type.	Location for custom HTML files used by your customizations. Create a unique subdirectory in this folder for each customization type. For example, create an accountCreation folder for customizations done to the account creation HTML file.
myproject/web/custom/js/validations/area/configure where area is the customization type.	Location for custom validation files used by your customizations. Create a unique subdirectory in this folder for each customization type. For example, create an accountCreation folder for customizations done to the account creation JavaScript files.
myproject/web/custom/js/viewmodels/area/configure where area is the customization type.	Location for custom view model files used by your customizations. Create a unique subdirectory in this folder for each customization type. For example, create an accountCreation folder for customizations done to the account creation view model files.
myproject/web/lib	You must copy the contents of the BillingCare_SDK/libs folder into the myproject/web/lib directory where myproject is the project directory previously created. The libs directory contains the jar files required for customizing Billing Care provided by the Billing Care installer. See "Installing the Billing Care SDK" for information about installing the SDK.
myproject/web/META-INF	Location for the manifest file describing the name and version of the shared library containing your customizations.
myproject/web/resources/public/css	Location of the overrides-login.css file where you specify a custom logo image file for the Billing Care login page.
myproject/web/resources/public/images	Location where you copy your custom logo image file used when overriding the default Oracle log on the Billing Care login page.
myproject/web/resources/translation	Location of your custom resource bundle.
myproject/web/WEB-INF/classes/com	Location of the .class files compiled from any custom Java code used in your customizations. The directory structure in this directory reflects the package name you use in your custom Java code.
myproject/web/WEB-INF/classes/custom	Location of the customModule.properties file.
myproject/web/WEB-INF/classes/custom/configurations	Location where you place your CustomConfigurations.xml and CustomActionMenu.xml files.
myproject/src	Create custom Java files in the src directory, within any Java Package you want. However, any REST web services you create for Billing Care must be placed within the com.oracle.communications.brm.cc.ws package (myproject/src/com/oracle/communications/brm/cc/ws). This will ensure your REST web service can be deployed within the customizations shared library. Company-specific subpackages are supported and recommended, for example: `com.oracle.communications.brm.cc.ws.company` where company is your company's name.

Creating the Billing Care NetBeans IDE Project

After creating the Billing Care customization project directory structure and copying the required jars into your myproject/web/lib directory, create a new project in NetBeans IDE for your customizations.

To create a NetBeans IDE project for your Billing Care customizations:

Start the NetBeans IDE.
Select the Projects tab.
Right-click within the Projects tab and select New Project....
In the New Project window, select Java Web under Categories. Select Web Application with Existing Sources under Projects.
Click Next.
In the Name and Location screen, enter the path or browse to the myproject folder where myproject is the folder you previously created for your Billing Care customizations. Specify a name and location in the Project Name and Project Folder fields.

See "Creating the Billing Care SDK Directory Structure" for information on creating your project folder.
Click Next.
In the Server and Settings screen, select the WebLogic Server you previously connected to NetBeans IDE.

See "Configuring the NetBeans IDE Connection to WebLogic Server" for more information on configuring your NetBeans IDE connection to your Billing Care domain.
Click Next.
In the Existing Sources and Libraries screen, verify the paths to your Web Page Folder, WEB-INF Content, and Libraries Folder are correct.
Click Finish.

NetBeans IDE configures the new project. Verify that the project creation is successful by confirming your project is listed in the Projects tab.