Table of Contents

• Title and Copyright Information
• Preface
  • Audience
  • Documentation Accessibility
  • Diversity and Inclusion
• Part I About the Billing Care SDK
  • 1 About Billing Care SDK
    • About the Billing Care SDK
      • About the references Directory
    • Installing the Billing Care SDK
  • 2 About Billing Care Architecture
    • About Billing Care Architecture
      • About the Billing Care REST Framework
      • About Open Source Libraries Used by Billing Care
• Part II Basic Billing Care SDK Components
  • 3 Setting Up the Development Environment
    • About the Billing Care Development Environment
    • Configuring NetBeans IDE for Billing Care Development
      • Downloading and Installing NetBeans IDE
      • Configuring the NetBeans IDE Connection to WebLogic Server
      • Setting Up a Billing Care Customization Project
        • Creating the Billing Care SDK Directory Structure
        • Creating the Billing Care NetBeans IDE Project
  • 4 Customizing Billing Care
    • About Billing Care Customization Concepts
    • About Billing Care Modules
      • About Views
      • About View Models
      • About Data Binding between Views and View Models
    • About the customModule.properties File
    • About the Configuration.xml File
    • About the Registry File
      • Managing Billing Care Modules Using the Registry File
    • About Billing Care View Model JavaScript Framework
      • Access to the Open Account
      • About AJAX Calls
      • Object IDs
    • About Error Handling in REST Operations
      • Invoking Error Handing in Customizations
    • About Custom Resource Authorization
      • Performing Authorization in the Actions Menu
      • Performing Authorization on the UI
      • Performing Authorization on the REST Framework
      • Using REST Authorization without Obligations
      • Using REST Authorization with Obligations
  • 5 Customizing Billing Care Templates
    • About Billing Care Templates
    • Customizing Templates
      • Removing Columns from a Template
      • Adding Columns to a Template
      • Extending the REST Framework to Support New Column Fields
      • Creating a customModule.properties File
    • Example 1: Event Template Customization
    • Example 2: Event Template Customization with New Fields
    • Example 3: Newsfeed Template Customization
  • 6 Customizing Billing Care Themes and Logo
    • About Billing Care Themes and Logo
    • About Customizing Billing Care Themes
    • Adding a New Theme
    • Overriding Themes
    • Setting Which Billing Care Theme to Use
    • Changing the Default Logo
  • 7 Editing the Billing Care Configuration File
    • About the Billing Care Configuration File
    • Creating a Custom Configuration File
    • Default Configuration File Entries
  • 8 Using an Exploded Archive during Customization
    • About Using an Exploded Archive
    • Configuring WebLogic Server to Use an Exploded Archive
      • Creating a Manifest for your Shared Library
        • Rebuilding your Project after Creating the Manifest File
      • Creating a New Deployment Plan for Billing Care with your Shared Library
      • Deploying your Shared Library on your Billing Care Domain
      • Redeploying Billing Care to Use your Shared Library
  • 9 Packaging and Deploying Customizations
    • About Packaging and Deploying Customizations for Production
    • Creating Production Versions of the Manifest File and Deployment Plan
    • Using the Java JAR Utility to Package Your Shared Library
    • Deploying the Shared Library .war
    • Redeploying Billing Care to Use Your Shared Library
• Part III Customizing Billing Care Screens and Fields
  • 10 Customizing the Billing Care Account Home Page
    • Customizing the Billing Care Account Home Page
    • About Customizing the Billing Care Home Tab
      • Customizing the Billing Care Home Tab
      • Creating a Summary and Detailed Link View
      • Creating an All Bill Units Summary View
      • Creating a Bill Unit Summary View
      • Overriding the Billing Care Home Tab Theme
      • Configuring the Custom Home Tab in the Registry
      • Creating a HomeTabBillUnitsViewModel
    • About Customizing the Bills Graph
      • Customizing Bills Graph
      • Creating Custom Home Tab View Model
      • Creating Custom View Model HTML Template for Customizing Bills Graph
      • Configuring Custom View Models for Customizing Bills Graph in the Registry
  • 11 Customizing the Billing Care Account Banner
    • About the Billing Care Account Banner
    • Customizing the Billing Care Account Banner
      • Creating Configuration Files for Account Banner Customization
    • Rearranging Account Banner Tiles
    • Removing Account Banner Tiles
  • 12 Customizing the Balances Area
    • About Customizing the Balances Area
    • Replacing the Balances Area with Custom Account Information
      • Customizing the Balances Area
      • Creating a View for the Balances Area
      • Creating a Custom Balances Area View Model
      • Configuring the Custom Balances Area in the Registry
    • Customizing the Data Displayed in the Balances Area
      • Creating Custom View Model HTML Template for the Balances Area
      • Adding customBalancesView and CustomBalancesViewModel to the Registry
  • 13 Adding Custom Payment Types
    • About Custom Payment Types
    • Creating Custom Payment Types in BRM
      • Creating Custom Payment Type Event Subclasses
      • Updating the /config/paymenttool Object with Custom Payment Types
      • Updating the /config/payment Object with Custom Payment Type Event
    • Customizing Billing Care to Support Custom BRM Payment Types
    • Generating XSD and JSON Files for Custom Payment Types
    • Extending the Billing Care Data Model with XSD and JSON Files
    • Adding the XSD and JSON Files to NetBeans Project
    • Enabling Custom Payment Types in Batch Payment Processing
    • Deploying Customizations
  • 14 Customizing the Make a Payment Screen
    • About the Make a Payment Screen
    • Customizing the Fields Displayed for a Payment Method
      • Creating a Custom View Model for a Payment Method
      • Configuring the Custom Payment Type in the Registry
  • 15 Displaying Success Toast Messages in Billing Care
    • About Displaying Success Toast Messages
    • Adding Success Toast Messages to Billing Care Screens
      • Creating a Success Toast Message View
      • Creating a Custom View Model for Success Toast Messages
      • Creating a Custom View Model for Your Payment and Adjustment Screens
      • Configuring the Registry for Success Toast Messages
      • Specifying the Path to Check Mark Graphic
  • 16 Customizing Purchase Deal and Assets Action Menu
    • About Customizing Purchase Deal Configuration and Assets Action Menu
    • Customizing Purchase Deal Configuration
      • Extending the Data Model With the XSD and Java Class files
      • Creating a Custom Purchase Deal Configuration View Model
      • Creating Custom Purchase Configure View Model HTML Templates
    • Customizing Assets Action Menu
      • Creating a Custom Asset View Model
      • Creating Custom Asset View Model HTML Templates
    • Deploying Customizations
  • 17 Customizing Billing Care to Display Child Accounts
    • About Displaying Child Accounts
    • Customizing Billing Care to Display Child Accounts
    • Customizing the Organization Hierarchy Screen
    • Creating Custom View Models
    • Creating Custom View Model HTML Templates
    • Configuring a Custom Module in the Registry
    • Adding the Data Model JAR File
    • Deploying Customizations
  • 18 Customizing Billing Care Invoice Presentation
    • About Billing Care Invoice Presentation
    • Customizing Billing Care Invoice Presentation
      • Setting Up NetBeans IDE for Customizing Invoice Presentation
    • Presenting Invoices in a Dialog Box
    • Retrieving Invoices from Third-Party Repositories
  • 19 Customizing Reason Codes List in Event Adjustments
    • About Displaying Reason Codes
    • Customizing Reason Codes List in Event Adjustments
    • Creating the Custom Event Adjustment View Model
    • Configuring the Custom Event Adjustment View Model in the Registry
    • Deploying Customizations
  • 20 Restricting Debit and Credit Event Adjustment Options
    • About Debit and Credit Event Adjustments
    • Restricting Debit and Credit Adjustment for Events
    • Creating a Custom View Model for Restricting Debit and Credit Adjustments
    • Configuring the Custom View Model for Debit and Credit Adjustments
  • 21 Customizing Billing Care to Display Only Event Adjustments
    • About Displaying Event Adjustments
    • Customizing Billing Care to Display Only Event Adjustments
    • Creating Custom View Models to Display Only Event Adjustments
    • Configuring Custom Bill and Bill Item View Models in the Registry
  • 22 Customizing Account Creation Service Fields
    • About Customizing Account Creation
    • Creating Custom View Models
      • Extending the New Account Configuration View Model
      • Creating a Custom Service Configuration View Model
    • Creating a Custom Service View Model HTML Template
    • Extending the Service Validator for Custom Fields
    • Configuring a Custom Module in the Registry
    • Deploying Customizations
  • 23 Creating Custom Billing Care Credit Profiles
    • About Credit Profiles
    • Customizing Billing Care to Store Credit Profiles
    • Creating Custom Profile Storable Classes in BRM
      • Importing Credit Profile Class Definitions into BRM
      • Creating Credit Profile Objects Using Developer Center
        • Creating the Credit Profile Class and Field
        • Generating the Required JAR File and Infranet.properties
    • Extending the Billing Care Data Model with XSD and JSON Files
    • Adding the Required Files to the NetBeans Project
      • Updating the MANIFEST.MF File
      • Adding the Required View Module and Configuration Files
      • Adding the Required JAR and JSON Files
    • Deploying Customizations
  • 24 Customizing the Billing Care Actions Menu
    • About the Billing Care Actions Menu
      • Mapping Label and Description Key Values to the Resource Bundle
    • About Customizing the Actions Menu
      • Setting Up NetBeans IDE for Customizing the Actions Menu
    • Removing Actions Menu Items
      • Removing an Existing Actions Menu Submenu
      • Removing an Existing Actions Menu
    • Rearranging Actions Menu Items
      • Rearranging Actions Menu Submenu Items
      • Rearranging Actions Menu Items
    • Renaming Actions Menu and Submenu Items
      • Renaming Actions Menu Submenu Items
      • Renaming Actions Menu Items
    • Adding Actions Menu Items
    • Adding Action Menu Items in Payment Suspense
  • 25 Opening Custom Views From Landing Page
    • About Customizing the Landing Page
    • Customizing the Landing Page
      • Creating a Custom Landing Page View Model
      • Creating a Custom Landing Page View Model HTML Template
    • Opening Custom Views in Full Screen Mode
      • Creating a Custom Full Page View Model
      • Creating a Custom Full Page View Model HTML Template
      • Creating a Custom Router View Model
      • Creating a Custom Router Helper
      • Configuring the Custom Full Page View Model in the Registry
    • Opening a Dialog Box From Landing Page
      • Creating a Custom Dialog View Model
      • Creating a Custom Dialog View Model HTML Template
      • Configuring the Custom Dialog View Model in the Registry
  • 26 Customizing Billing Care Labels
    • About the Billing Care Resource Bundle
    • Customizing the Resource Bundle
      • Creating a Custom XLF File
      • Modifying Existing Labels
      • Adding New Labels
      • Creating Required JavaScript Files for Deployment
    • Localizing Billing Care into Other Languages
  • 27 Customizing Billing Care to Disable Links in the Bills Tab
    • About Disabling Links
    • Disabling Links in the Bills Tab
    • Creating Custom View Models to Disable Links in the Bills Tab
    • Configuring Custom Bill, Charges, and Payment Detail View Models in the Registry
  • 28 Separating Event Adjustment Amount and Percentage Fields
    • About Event Adjustments using Amount and Percentage
    • Separating Amount and Percentage Fields
    • Creating Custom View Model to Separate Amount and Percentage Fields
    • Adding CustomEventAdjustmentViewModel to the Registry
  • 29 Embedding Billing Care Screens in External Applications
    • About Embeddable Billing Care Screens
    • Embedding Billing Care Screens
      • Understanding the index_embedded.html File
      • Configuring Your External Application to Access Billing Care
    • Configuring Security for External Application Access
• Part IV Customizing Searches and Filters in Billing Care
  • 30 Searching for Accounts by Payment ID
    • About Account Searches in Billing Care
    • Adding a Payment ID Field to the Account Search Screen
    • Naming the Custom Account Search Template in the CustomConfigurations.xml File
    • Creating a Custom Account Search Template
    • Creating a Custom Account Search View Model
    • Creating a Custom Search View Model
    • Creating a Custom Router View Model
    • Creating a Custom Router Helper
    • Creating a Custom Account Search View Model HTML Template
    • Replacing the Default Method for Showing Recently Opened Accounts
    • Configuring a Custom Module in the Registry
    • Creating a customized_en.xlf File Entry for Payment ID Search Field
    • Getting Payment Item POIDs from BRM
    • Deploying Customizations
  • 31 Filtering Bundles Available for Purchase
    • About Filtering Bundles
    • Filtering Bundles List in Billing Care
    • Creating CustomPCMSubscriptionModule.java Class
    • Creating CustomSubscriptionWorker.java Class
    • Updating the customModule.properties File
  • 32 Filtering Start and End Dates for Additional Purchase
    • About Customizing Purchase Configuration
    • Filtering Start and End Date Options
    • Creating a Custom Purchase Deal Configuration View Model
    • Configuring the Custom Purchase Configuration View Model in the registry
  • 33 Customizing Search Filter for Suspended Payments
    • About Suspended Payment Search Filter
    • Adding Search Criteria
    • Creating a CustompaymentSuspenseSearch.xml File
    • Creating a CustomTemplatePaymentSuspenseWorker.java Class
    • Creating CustomPCMTemplateModule.java Class
    • Creating a customModule.properties File
    • Updating Registry
    • Updating customPaymentSuspenseSearchView.html
    • Updating View Model
    • Localizing New Criteria into Other Languages
    • Creating Deployment Plan
    • Creating .war File
  • 34 Exporting Billing Care Search Results
    • About Billing Care Search
    • Enabling Search Results Export with the SDK
    • Creating Custom Search Templates
    • Creating Custom Search View Models
    • Configuring Custom Search Modules in the Registry
    • Deploying Customizations
• Part V Controlling Access to Billing Care Functionality
  • 35 Limiting Event Adjustment Percentage Entered by CSRs
    • About Adjustments
    • Limiting Event Adjustments Entered by CSRs
    • Updating CustomExtendAdjustmentModule.java Class
    • Creating CustomAdjustmentWorker.java Class
    • Creating a customized_en.xlf File Entry for the Error Message
  • 36 Setting Adjustment Limit for Event Adjustments
    • About Adjustment Limits
    • Setting Event Adjustment Limit for CSRs
    • Creating customAdjustmentResource.java Class
    • Creating the Custom Event Adjustment View Model
    • Configuring the Custom Event Adjustment View Model in the Registry
  • 37 Enabling Authorization in Test Installations
    • About Enabling Authorization in Test Installations
    • Enabling Authorization in Test Installations
    • Modifying Default Authorization Policies
    • Adding Custom Authorization Resources and Actions
    • Deploying Customizations
  • 38 Restricting Bundle Validity Based on Roles
    • About Restricting Bundle Validity
    • Restricting Bundle Validity
    • Creating CustomAccountResource.java Class
    • Creating a Custom Purchase View Model
    • Configuring the Custom Purchase View Model in the Registry
  • 39 Restricting Additional Bundles Purchase Based on Roles
    • About Restricting Bundles
    • Restricting Bundles Based on Roles
    • Creating the Custom Bundle Selection View Model
    • Configuring the Custom Bundle Selection View Model in the Registry
  • 40 Making Notes Field Mandatory
    • Making Notes Mandatory for Additional Product Purchase
      • Creating a Custom Purchase Deal View Model
      • Configuring the Custom Purchase View Model in the Registry
    • Making Notes Mandatory for Event Adjustments
      • Creating a Custom Event Adjustment View Model
      • Configuring the Custom Event Adjustment View Model in the Registry
  • 41 Customizing Suspended Payment Allocations
    • About Suspended Payment Allocation
    • Forbidding Partial Allocation of Suspended Payments
    • Creating a CustomPCMPaymentModule.java Class
    • Creating a Custom Payment Suspense View Model
    • Creating a customModule.properties File
    • Configuring a Custom Module in the Registry
    • Deploying Customizations
  • 42 Disabling Event Adjustment Options Based on Roles
    • About Event Adjustment Options
    • Disabling Event Adjustment Options Based on User Roles
    • Creating a Custom View Model for Disabling Adjustment Options
    • Configuring the Custom View Model for Disabling Event Adjustment Options
• Part VI Customizing the Billing Care REST API
  • 43 Using Custom OAuth Providers with Billing Care REST API
    • About OAuth Token Management Tools
    • Creating a Custom Token Module
    • Adding a Custom OAuth Token Module to the customModule.properties File
  • 44 Extending and Creating Billing Care REST Resources
    • About Extending and Creating Billing Care REST Resources
    • About Billing Care Sample SDK REST Customizations
    • Extending REST Services to Filter Custom Headers
      • Creating a Custom Storable Class in the BRM Data Dictionary
      • Processing Billing Care REST API Requests and Responses
      • Configuring WebLogic Server to Use an Exploded Archive
      • Sending a Test HTTP Request with the Custom Header
    • Extending REST Services
  • 45 Extending REST API Response Objects
    • About Enriching REST API Response Objects
    • Enriching Response Objects
    • Example: Enriching the Response Object for the Account Module
  • 46 Recording Billing Care REST API Request Failures
    • About Recording Billing Care REST API Request Failures
    • Enabling the Recording of REST Request Failures
    • Customizing REST Request Failure Details
      • Customizing the Request Record Logic
      • Customizing the Headers and Payload to Record
      • Overriding the Default Request Record Logic