3 Installing Billing Care

Learn how to install Oracle Communications Billing Care.

Topics in this document:

Downloading the Billing Care Installer

You can download the Billing Care software from one of the following locations:

Search for and download the Oracle Communications Billing Care 16.26.0.x.y.0 software, where x refers to the maintenance release and y refers to the patch set release of BRM that you are installing.

The Zip archive includes the installer: BillingCare_generic.jar

Running the Billing Care Installer

Run the Billing Care installer as a user who has permissions to write to the oraInventory directory.

To install Billing Care:

  1. Verify that your Java Development Kit (JDK) is installed correctly. Ensure that you set your JAVA_HOME environment variable and that the $JAVA_HOME/bin directory is in your path.

  2. Download the Billing Care installer. See "Downloading the Billing Care Installer" for more information.

  3. From the location where you extracted the downloaded software package, run the following command to start the Billing Care installer:

    java -jar BillingCare_generic.jar

    If you are using an existing or custom Oracle inventory location, include the -invPtrLoc flag and an Oracle Inventory path location in the Java command that starts the Billing Care installer, for example: 

    java -jar BillingCare_generic.jar -invPtrLoc invPath/oraInst.loc

    where invPath is the Oracle Inventory path.

  4. In the Welcome window, click Next.

  5. In the Installation Location window, enter or browse to your Oracle Home directory and then click Next.

  6. In the Feature Sets Selection window, select the components to install from the list in Table 3-1 and then click Next.

    Table 3-1 Feature Sets Details

    Option Description

    Billing Care UI

    Installs the Billing Care UI. Selecting this component automatically selects the Billing Care REST API, which is required by the UI.

    Billing Care REST API

    Installs the Billing Care REST API and its configuration. This component provides the services used by the Billing Care UI and integrations.

    Billing Care SDK

    Installs the Billing Care Software Development Kit (SDK). Use the SDK to develop and package supported customizations and extensions for Billing Care.

    Billing Care Migration Utility

    Installs the Billing Care Migration Utility, a command-line tool for migrating Billing Care customizations to the Helidon-based runtime. It supports migration of the following:

    • authorization policy and UI authorization

    • customer configuration and configuration code

    • SDK-based customizations

    • localization code and bundle

    • Java Util Logging analysis

    It also includes an extension endpoint-catalog sample.

    If you select Billing Care UI, Billing Care REST API is selected automatically. You cannot install the UI without the REST API, but you can install the REST API without the UI.

  7. In the Server Details window, enter the details listed in Table 3-2 and then click Next.

    Table 3-2 Server Details

    Field Description

    Host Name

    Enter the host name or IP address of the system where you are installing the Billing Care REST API.

    Note: The installer always installs Billing Care on the local system where it is run. Ensure that the specified host name or IP address is configured on the local system. If you do not, the application may fail to start because it cannot bind to the specified address.

    This field is mandatory. The default value is localhost.

    Port Number

    Enter an available port number for the Billing Care application.

    This field is mandatory. The default value is 8082.

    SSL Enabled

    Select an SSL option:

    • To use one-way SSL, select Yes - One Way.

    • To use two-way SSL, select Yes - Two Way.

    • To deploy Billing Care without SSL, select No. You do not need to enter any values in the keystore and truststore fields in this window.

    This field is mandatory. The default value is Yes - One Way.

    Keystore Type

    The only type of keystore file to use to establish the SSL connection is PKCS12.

    Keystore Location

    Enter the name and path of your PKCS12 keystore file for SSL connection.

    The file must have a .p12 extension. Otherwise, a validation warning is displayed.

    This field is mandatory when one-way or two-way SSL is enabled.

    Keystore Password

    Enter the password used to establish the SSL connection.

    This field is mandatory when one-way or two-way SSL is enabled.

    Keystore Alias

    Enter the alias used to access the specific certificate in the keystore.

    This field is mandatory only if an alias was specified when the keystore was created.

    Truststore Type

    The only type of truststore file to use to establish the SSL connection is PKCS12.

    Truststore Location

    Enter the name and path of your truststore file for SSL authentication.

    Select a file with a .p12 extension. Otherwise, a warning message is displayed.

    This field is mandatory if SSL Enabled is set to Yes - Two Way and optional if SSL Enabled is set to Yes - One Way. It has no default value.

    Truststore Password

    Enter the password used to establish the SSL connection.

    This field is mandatory if SSL Enabled is set to Yes - Two Way or if SSL Enabled is set to Yes - One Way and Truststore Location is set. It has no default value.

    Wallet Password

    Enter the password for the Billing Care application wallet.

    This field is mandatory. It has no default value.

    Confirm Wallet Password

    Reenter the Billing Care application wallet password for confirmation.

    This field is mandatory. It has no default value.

  8. In the Management and Observability window, view the details listed in Table 3-3 and then click Next.

    This screen enables you to configure the settings required for Billing Care administrative operations, management, and monitoring. It is automatically populated based on the configuration specified in the previous Server Details window. You can modify the value if required.

    Table 3-3 Management and Observability

    Field Description

    Admin Port Number

    Enter an available port number for the Billing Care application to use for administrative operations.

    This field is mandatory. The default value is 8084.

    SSL Enabled

    Select an SSL option for administrative operations. It is populated with the selection from the Server Details window.

    • To use one-way SSL, select Yes - One Way.

    • To use two-way SSL, select Yes - Two Way.

    • To deploy Billing Care without SSL, select No. You do not need to enter any values in the keystore and truststore fields in this window.

    This field is mandatory. The default value is Yes - One Way.

    Keystore Type

    		 The only type of keystore file to use to establish the SSL connection is PKCS12.

    Keystore Location

    Enter the name and path of your PKCS12 keystore file for SSL authentication.

    The file must have a .p12 extension. Otherwise, a validation warning is displayed.

    This field is mandatory when one-way or two-way SSL is enabled.

    Keystore Password

    Enter the password used to establish the SSL connection for administrative operations.

    This field is mandatory if you are using PKCS12-type SSL. It has no default value.

    Keystore Alias

    Enter the alias used to access the specific certificate in the keystore for administrative operations.

    This field is mandatory only if an alias was specified when the keystore was created.

    Truststore Type

    The only type of truststore file to use to establish the SSL connection for administrative operations is PKCS12.

    Truststore Location

    Enter the name and path of your truststore file for SSL authentication for administrative operations.

    Select a file with a .p12 extension. Otherwise, a warning message is displayed.

    This field is mandatory when one-way or two-way SSL is enabled.

    Truststore Password

    Enter the password used to establish the SSL connection for administrative operations.

    This field is mandatory if SSL Enabled is set to Yes - Two Way or if SSL Enabled is set to Yes - One Way and Truststore Location is set. It has no default value.

    Enable Metrics

    Select this option to enable metrics collection for Billing Care administrative operations.

    Note:

    The Billing Care installer does not proceed until it verifies that the information you entered is valid.

  9. In the BRM Connection Details window, enter the details listed in Table 3-4 and then click Next.

    Table 3-4 BRM Connection Details

    Field Description

    Host Name

    Enter the IP address or host name of the system on which the primary BRM Connection Manager (CM) or CM Master Process (CMMP) is running.

    This field is mandatory. The default value is localhost.

    Port Number

    Enter the TCP port number of the CM or CMMP on the host system.

    This field is mandatory. The default value is 11960.

    User Name

    Enter the username for connecting to BRM.

    This field is mandatory. The default value is bc_client.0.0.0.1.

    Password

    Enter the BRM user's password.

    This field is mandatory. It has no default value.

    Service Type

    Enter the BRM service type.

    This field is mandatory. The default value is /service/admin_client.

    Service POID Id

    Enter the Portal object ID (POID) of the BRM service.

    This field is mandatory. The default value is 416.

    SSL Wallet Location

    Enter the location of the SSL wallet to use for the BRM connection. You must enter a wallet location if you want Billing Care to communicate with BRM using SSL.

    This field is optional. If it is not specified, SSL connection to BRM is disabled.

  10. In the Batch Payment Details window, enter the details listed in Table 3-5 and then click Next.

    Table 3-5 Batch Payment Details

    Field Description

    Batch Payment Files Location

    Enter the directory in which batch payment files are placed for uploading and processing by Billing Care.

    The installer creates these folders in the directory you specify: error, processed, processing, and unprocessed.

    This field is mandatory. The default value is Oracle_home/billingcare_rest/batch_payments/data_files.

    Batch Payment Templates Location

    Enter the directory in which payment file templates are installed.

    This field is mandatory. The default value is Oracle_home/billingcare_rest/batch_payments/template_files.

  11. In the Security Details window, select whether to configure Billing Care security and then click Next.

    • Select Yes to configure an OpenID Connect (OIDC) security provider. Always select this option for a production or staging environment. You can also select it for a development or testing environment. This option is the default.

      Note:

      You must select Yes if you want to use LDAP to retrieve customer-service representative (CSR) details.

    • Select No if you do not want to configure an OIDC security provider. You may select this option for a development or testing environment. If you select this option, go to step 13.

  12. In the OpenID Connect Security Provider window, enter the details listed in Table 3-6 and then click Next.

    Table 3-6 OpenID Connect Security Provider

    Field Description

    Identity URL

    Enter the identity URL of an Identity Provider.

    This field is mandatory. It has no default value.

    Scope Audience

    Enter the primary audience for the confidential OAuth application.

    This field is mandatory. It has no default value.

    Audience

    Enter a secondary audience if it is configured. Otherwise, reenter the value from the Scope Audience field.

    This field is mandatory. It has no default value.

    Client ID

    Enter the client ID of the confidential OAuth application created for Billing Care in the Identity Provider.

    This field is mandatory. It has no default value.

    Client Secret

    Enter the client secret of the confidential OAuth application.

    This field is mandatory. It has no default value.

    Cookie Encryption Password

    		 Enter the cookie encryption password used by the application or OIDC component to protect security-sensitive information stored in browser cookies.

  13. In the LDAP Connection Details window, if you want to use LDAP to retrieve customer service representative (CSR) agent logins, enter the details in Table 3-7. Otherwise, select Skip LDAP Configuration. Then click Next.

    Note:

    You must select Skip LDAP Configuration if you did not configure security using OpenID Connect. You cannot use LDAP services without OpenID Connect.

    Table 3-7 LDAP Connection Details

    Field Description

    Host Name

    Enter the host name or IP address of the LDAP server.

    This field is mandatory if you did not select Skip LDAP Configuration. The host name is auto-populated from the Server Details window.

    Port Number

    Enter the number of the port on which the LDAP server is listening.

    This field is mandatory if you did not select Skip LDAP Configuration. The default value is 1389.

    Admin User Name

    Enter the distinguished name (DN) of the LDAP user to use to connect to the LDAP server.

    This field is mandatory if you did not select Skip LDAP Configuration. The default value is cn=Directory Manager.

    Admin Password

    Enter the password for the LDAP connection user.

    This field is mandatory if you did not select Skip LDAP Configuration. It has no default value.

    User Base DN

    Enter the base DN of the tree in the LDAP directory that contains users.

    This field is mandatory if you did not select Skip LDAP Configuration. The default value is ou=people,dc=example,dc=com.

    User Name Filter

    Enter the LDAP search filter used to locate a user based on the specified user name.

    This field is mandatory if you did not select Skip LDAP Configuration. The default value is (&(uid={username})(objectClass=person)).

    Group Base DN

    Enter the base DN of the tree in the LDAP directory that contains groups.

    This field is mandatory if you did not select Skip LDAP Configuration. The default value is ou=groups,dc=example,dc=com.

    Group Name Filter

    Enter the LDAP search filter used to locate a group based on the specified group name.

    This field is mandatory if you did not select Skip LDAP Configuration. The default value is (&(cn={group})(|(objectClass=groupOfNames)(objectClass=groupOfUniqueNames))).

  14. If you selected Skip LDAP Configuration in the previous step, a confirmation message is displayed. Click OK to continue.

  15. In the Installation Summary window, confirm your Billing Care installation summary and click Install.

    The Installation Progress window appears.

  16. When installation completes, click Next.

    The Installation Complete window appears.

  17. Make note of the Billing Care links, including the Oracle Home location, log file location, OpenID Connect redirect URL (if applicable), and the link for accessing Billing Care.

  18. Click Finish.

    The Billing Care installer exits.

  19. Review the settings described in "Configuring Billing Care" and complete any additional configuration required for your environment.

  20. Start Billing Care by running the start_billingcare.sh script from the Oracle_home/billingcare_rest/bin directory. See "Starting and Stopping Billing Care".

See "Verifying the Billing Care Installation" for information about verifying the successful installation of Billing Care.

See "About Installation Logs" for information about the Billing Care installer logs.

About Installation Logs

You use installation log files to help you debug your Billing Care installation. You can check the log files in the oraInventory/logs directory. The default location of the oraInventory directory is in the /etc/oraInst.loc file.

You use the following log files to monitor the installation and postinstallation process:

  • installActionTimeStamp.log

  • oraInstallTimeStamp.err

  • oraInstallTimeStamp.out

  • launcherTimeStamp.log