14 Creating Custom Billing Care Credit Profiles

This chapter provides an overview on customizing Oracle Communications Billing Care to store subscriber credit profiles.

About Credit Profiles

Billing Care uses credit profiles to store subscriber information related to credit worthiness including social security numbers and credit scores. By default, Billing Care does not store or display credit profile information. You customize Billing Care to display credit profile information stored in Oracle Communications Billing and Revenue Management (BRM) using the SDK.

Customizing Billing Care to Store Credit Profiles

Support for credit profiles requires customizations in both BRM and Billing Care.

To add credit profile support in Billing Care:

  1. Create the required credit profile objects in BRM either by importing the sample configuration provided by the SDK, or manually creating the objects using Oracle Communications Billing and Revenue Management Developer Center. See "Creating Custom Profile Storable Classes in BRM" for more information.

  2. Generate the required XSD and JSON files using the Data Model Generator utility. See "Extending the Billing Care Data Model with XSD and JSON Files" for more information.

  3. Add the generated XSD and JSON files, and Java JAR file to your NetBeans IDE project. See "Adding the Required Files to the NetBeans Project" for more information.

  4. Deploy your custom payment type projects to your application server. See "Deploying Customizations" for more information.

The Billing Care SDK includes a sample credit profile customization in the SDK_home/BillingCare_SDK/samples/EndToEndUseCase directory, where SDK_home is the directory where you installed the SDK. The credit profile sample stores only the social security number and credit score. Extend the sample with additional fields if required by your business. Use this sample to assist you in customizing Billing Care with credit profile support

Creating Custom Profile Storable Classes in BRM

Credit profile support requires creating the credit profile object in the BRM database where Billing Care stores subscriber credit profile data. The SDK sample includes a PODL file containing the credit profile object definitions which can be imported into BRM using the pin_deploy utility. Alternatively, you can create the required objects manually using Developer Center.

To create the credit profile object in the BRM database, select one of the following methods:

Importing Credit Profile Class Definitions into BRM

To import the sample PODL definition file into BRM:

  1. Copy the credit_profileObj.podl file located in SDK_home/BillingCare_SDK/samples/EndToEndUseCase/BRM_CreditProfileObject , where SDK_home is the directory where you installed the SDK, to your BRM _HOME/test folder, where BRM_HOME is the home directory of your BRM installation.

  2. Run the following command:

    pin_deploy create credit_ProfileObj.podl

  3. Start Developer Center.

  4. Open the Class Browser and verify that the /profile/credit_check object is present.

The SDK sample includes a pre-compiled JAR file that must be added to your NetBeans IDE project for Billing Care to use the new credit profile class. This JAR is located in the SDK_home/BillingCare_SDK/samples/EndToEndUseCase/web/WEB-INF/lib folder.

Creating Credit Profile Objects Using Developer Center

Use Developer Center to manually create the credit profile object and fields in BRM. See "Creating the Credit Profile Class and Field" for more information on using Developer Center to create the required object and fields.

If you choose to create the credit profile class manually, you must use the Generate Custom Fields Source utility to create source files containing the new custom fields. Compile these source files into a JAR file and add the JAR file to your NetBeans IDE project. See "Generating the Required JAR File and Infranet.properties" for more information on generating the required JAR file.

Creating the Credit Profile Class and Field

Create the credit profile object and fields in BRM using Developer Center. This section provides a high level overview of the process including a general overview on how to create and update the required objects. For detailed information on using the Developer Center to create a custom credit profile see "Creating Custom Fields and Storable Classes" in Oracle Communications Billing and Revenue Management Developer's Guide.

To create the credit profile class:

  1. Start Developer Center.

  2. Open the Class Browser.

  3. Create the /profile/credit_check class.

  4. Commit the new class.

To create the required fields for the new credit profile class:

  1. Open the Storable Class Editor.

  2. Create the following required fields listed in Table 14-1 for the credit profile class:

    Table 14-1 /profile/credit_check Class Fields

    Field Type

    PIN_FLD_CREDIT_INFO

    SUBSTRUCT

    PIN_FLD_SSN

    STRING

    PIN_FLD_CREDIT_SCORE

    INT


  3. Commit the subclass changes to the database.

To add the created fields to the new credit profile class:

  1. Open the Class Browser.

  2. Select the /profile/credit_check class.

  3. Add the fields listed in Table 14-1 to the credit profile class:

  4. Commit the subclass changes to the database.

Generating the Required JAR File and Infranet.properties

To create the required JAR containing the compiled credit profile Java source code:

  1. Open the Class Browser.

  2. Select the /profile/credit_check class.

  3. Select File, then Generate Custom Fields Source. See "Making Custom Fields Available to Your Applications" in Oracle Communications Billing and Revenue Management Developer's Guide for more information on this utility.

    The utility generates the required Java class files and the InfranetPropertiesAdditions.properties file.

  4. Copy the contents of the InfranetPropertiesAdditions.properties file into the Infranet.properties file located in the home directory of the Billing Care WebLogic Server administrative user.

  5. Compile the Java class files into a JAR file named Custom.jar. Include the SDK_home/BillingCare_SDK/lib/pcm.jar, where SDK_home is the location of your SDK installation, in the classpath option when compiling.

Extending the Billing Care Data Model with XSD and JSON Files

The Billing Care SDK includes a Data Model Generator utility for generating the required XSD and JSON files containing the credit profile definitions. The Data Model Generator is located in the SDK_home/BillingCare_SDK/samples/data_model_generator directory, where SDK_home is the directory where you installed the SDK.

Note:

The Data Model Generator utility requires an Infranet.properties file configured with BRM connection information in the local user's home directory. The utility connects to the BRM system defined in this file to retrieve the object configuration before generating the required XSD and JSON files. See "Copying Configuration File to the Domain Administrative User's Home Directory" in Oracle Communications Billing Care Installation Guide for more information.

To create the required XSD and JSON files for credit profile:

  1. Open a command-line interface on the system where the Billing Care SDK is installed.

  2. Change to the SDK_home/BillingCare_SDK/samples/data_model_generator directory.

  3. Run the DatamodelGenerator.bat (Windows) or DataModelGenerator.sh (Linux) script to generate the XSD and JSON files.

The Data Model Generator outputs the extensionDataModel.jar containing the XSD files and an XSD file containing the definition of your custom payment type. Add these files to your NetBeans IDE project. See "Adding the Required Files to the NetBeans Project" for more information on adding the files to your project.

Adding the Required Files to the NetBeans Project

The EndToEndUseCase sample includes sample customized JavaScript view modules (views, view models, validators, and HTML view template files) for Billing Care to properly render the credit profile in the account banner. Additionally, the sample also includes customized Action Menu and Configuration XML files enabling the entry and display of credit profile fields.

Sample JavaScript and configuration files can be customized to your needs. See "About Billing Care Modules" for more information on customizing view modules. See "Customizing the Billing Care Actions Menu" and "Editing the Billing Care Configuration File" for more information about customizing the configuration files.

The following sections indicate the locations for where the sample files should be added in your NetBeans IDE project. Place customized versions of the view module or configuration files in the same locations. See "Setting Up a Billing Care Customization Project" for more information on creating the proper project directory structure.

Updating the MANIFEST.MF File

To update the NetBeans IDE project MANIFEST.MF file:

  1. Open the project's MANEFEST.MF file and append the contents of the SDK_home/BillingCare_SDK/samples/EndToEndUseCase/src/conf/MANIFEST.MF, where SDK_HOME is the home directory of your SDK installation, to the end of the file.

  2. Save the file.

Adding the Required View Module and Configuration Files

To add the sample view module and configuration files to your NetBeans IDE project:

  • Copy the files located in SDK_home/BillingCare_SDK/samples/EndToEndUseCase/, where SDK_HOME is the home directory of your SDK installation, into their corresponding NetBeans IDE project directories. For example, copy the SDK_home/BillingCare_SDK/samples/EndToEndUseCase/web/custom directory to your myproject/web/custom directory where myproject is your NetBeans IDE project directory.

Adding the Required JAR and JSON Files

To add required JAR files to your NetBeans IDE project:

  1. Copy the extensionDataModel.jar and Custom.jar to your Billing Care customization NetBeans IDE project myproject/web/lib directory where myproject is the project directory of your Billing Care customizations NetBeans IDE project.

  2. Copy the JSON file to myproject/web/custom/jsons where myproject is the project directory of your Billing Care customizations NetBeans IDE project.

Deploying Customizations

Package and deploy your customizations using one of the methods described in "Using an Exploded Archive during Customization" or "Packaging and Deploying Customizations".