Implementation Guide for Oracle Billing Insight > Customizing the Payment Consolidator Integration Module > Creating Customized Payment Consolidation Templates >

Adding Cartridge Property Keys


Oracle Billing Insight provides some preconfigured cartridge property keys in the cartridgeProperty object. The name of the Java object that is preset in the template context is cartridgeProperty. Oracle Billing Insight uses the properties along with the templates to parse the input data files and generate the response files.

You can add any additional cartridge properties required by your payment consolidator for input data files. If you add the properties in the cartridgeProperty object for the file structure XML template, then it can be accessed by all templates. If you add it to a particular record XML template, then it is only used within that template.

Table 85 shows the cartridge property keys preconfigured the cartridgeProperty object.

Table 85. Preconfigured Cartridge Property Keys
Property Key Name
Description

com.edocs.common.pc.actiontype.enroll

The action type code to enroll or create a new account.

com.edocs.common.pc.actiontype.change

The action type code to change information on an existing account.

com.edocs.common.pc.actiontype.unenroll

The action type code to deregister an existing account. If it is not supported by the payment consolidator, then leave this key blank.

com.edocs.common.pc.statuscode.filerecord.
success

The successful status code defined by the payment consolidator in the file header record.

com.edocs.common.pc.statuscode.
detailrecord.success

The successful status code defined by the payment consolidator in the detail record.

com.edocs.common.pc.statuscode.
biller_not_exist

The status code defined by payment consolidator indicating that the biller does not exist in the payment consolidator.

com.edocs.common.pc.statusmessage.
biller_not_exist

The status message defined by payment consolidator indicating that the biller does not exist in the payment consolidator.

com.edocs.common.pc.statuscode.
consolidator_not_exist

The status code indicating that the consolidator does not exist in the payment consolidator.

com.edocs.common.pc.statusmessage.
consolidator_not_exist

The status message indicating that the consolidator does not exist in the payment consolidator.

com.edocs.common.pc.statuscode.
billingsystemid_not_exist

The status code indicating that the billing system ID does not exist in the payment consolidator.

com.edocs.common.pc.statusmessage.
billingsystemid_not_exist

The status message indicating that the billing system ID does not exist in the payment consolidator.

com.edocs.common.pc.statuscode.
account_not_exist

The status code indicating that the active account does not exist in the payment consolidator.

com.edocs.common.pc.statusmessage.
account_not_exist

The status message indicating that the active account does not exist in Payment Consolidator.

com.edocs.common.pc.statuscode.
account_not_activated

The status code indicating that the account is not activated in the payment consolidator.

com.edocs.common.pc.statusmessage.
account_not_activated

The status message indicating that the account is not activated in the payment consolidator.

com.edocs.common.pc.statuscode.
account_already_exist

The status code indicating that the account already exists in the payment consolidator.

com.edocs.common.pc.statusmessage.
account_already_exist

The status message indicating that the account already exists in the payment consolidator.

com.edocs.common.pc.statuscode.
mandatory_filed_missing

The status code indicating that a mandatory field is missing in the payment consolidator.

com.edocs.common.pc.statusmessage.
mandatory_filed_missing

The status message indicating that a mandatory field is missing in the payment consolidator.

com.edocs.common.pc.initial_status.
biller_enrollment

The initial biller enrollment status indicating whether the record is enrolled successfully with the biller. The value can be Y - Yes or N - No.

com.edocs.common.pc.initial_status.
consolidator_enrollment

The initial consolidator enrollment status indicating whether the record is enrolled successfully with the consolidator. The value can be Y - Yes or N - No.

com.edocs.common.pc.end_of_file_symbol

The end-of-line symbol while generating the output file. The default value is \r\n.

com.edocs.common.pc.
billing_account_creator

If the newly enrolled account doesn't exist in Oracle Billing Insight, then it creates a new billing account. The value of this key is the operator ID specifying who created the billing account and is stored in the CREATEDBY column in the database.

To add a new property to the cartridgeProperty object

  1. Use one of the following:

    In the file structure definition XML file:

    $cartridgeProperty.setProperty(String KeyName, String KeyValue)$

    In the record XML template file:

    %cartridgeProperty.setProperty(String KeyName, String KeyValue)%

    To reference the property values in all template files, use the following command:

    $cartridgeProperty.getProperty(String KeyName)$

Implementation Guide for Oracle Billing Insight Copyright © 2016, Oracle and/or its affiliates. All rights reserved. Legal Notices.