7 Editing the Billing Care Configuration File
You can customize the Oracle Communications Billing Care interface by creating a custom version of the Configurations.xml file.
Topics in this document:
About the Billing Care Configuration File
The Configurations.xml file controls the following elements of Billing Care:
-
Mappings that determine what values are displayed for module keys. See Table 7-1.
-
Flags for showing or hiding module elements. See Table 7-2.
-
Threshold values for connection timeouts and pagination. See Table 7-3.
-
Registry values that determine how Billing Care renders modules. See Table 7-4.
-
Keyval categories displayed in the newsfeed. See Table 7-5.
Creating a Custom Configuration File
To change default behavior, create a CustomConfigurations.xml file, and package it in the customizations shared library that you deploy to the Billing Care domain.
To create a CustomConfigurations.xml file:
-
Copy the SDK_home/references/Configurations.xml file to the myproject/web/custom/configurations directory.
where:
-
SDK_home is the directory in which you installed the Billing Care SDK.
-
myproject is your NetBeans IDE Billing Care customizations project.
-
-
Open the CustomConfigurations.xml file, and edit the entries you want to change.
For a list of the default configuration file entries, see "Default Configuration File Entries".
-
Save and close the file.
-
Include the CustomConfigurations.xml file when you package your customizations shared library for deployment to your Billing Care domain.
For more information on packaging and deploying your customizations, see "Packaging and Deploying Customizations".
Default Configuration File Entries
The following tables show the default values in the Configurations.xml file.
Table 7-1 lists the configurable mappings and their default values.
Table 7-1 Mapping Values in Configuration File
| Configuration Key and Description | Default Values | Types |
|---|---|---|
|
account.contact.phone.types Phone types displayed in the Account Profile overlay. Permits adding, rearranging, and renaming the phone types. |
<mapping> <key>account.contact.phone.types</key> <map> <id>1</id> <key>HOME</key> </map> <map> <id>2</id> <key>WORK</key> </map> <map> <id>3</id> <key>FAX</key> </map> <map> <id>4</id> <key>PAGER</key> </map> <map> <id>5</id> <key>MOBILE</key> </map> <map> <id>6</id> <key>POP</key> </map> <map> <id>7</id> <key>SUPPORT</key> </map> <desc></desc> </mapping> |
id: Number. key: String (must match appropriate key in the Billing Care resource bundle). |
|
account.contact.types Contact types displayed in the Account Profile overlay. Permits adding, rearranging, and renaming the contact types. |
<mapping> <key>account.contact.types</key> <map> <id>1</id> <key>PRIMARY</key> </map> <map> <id>2</id> <key>ADDITIONAL</key> </map> <map> <id>3</id> <key>ACCOUNTHOLDER</key> </map> <desc></desc> </mapping> |
id: Number. key: String (must match appropriate key in the Billing Care resource bundle). |
|
account.customer.types Customer types displayed in the Account Profile overlay. Permits adding, rearranging, and renaming the customer types. |
<mapping> <key>account.customer.types</key> <map> <id>1</id> <key>PLATINUM</key> </map> <map> <id>2</id> <key>GOLD</key> </map> <map> <id>3</id> <key>SILVER</key> </map> <map> <id>4</id> <key>BRONZE</key> </map> <desc></desc> </mapping> |
id: Number. key: String (must match appropriate key in the Billing Care resource bundle). |
|
account.locale.mapping Because browser and BRM language codes are different, this configuration acts like a mapping. |
<mapping> <key>account.locale.mapping</key> <map> <id>cs</id> <key>cz</key> </map> <map> <id>bg</id> <key>bg_BG</key> </map> <map> <id>hr</id> <key>hr_HR</key> </map> <map> <id>sl</id> <key>sl_SI</key> </map> <map> <id>nb</id> <key>no</key> </map> <map> <id>nn</id> <key>no_NY</key> </map> <map> <id>sv</id> <key>sve</key> </map> <map> <id>en_GB</id> <key>en_UK</key> </map> <map> <id>he</id> <key>iw_IL</key> </map> <desc></desc> </mapping> |
id: String that represents the browser language. key: String that represents the BRM language (BRM locale value). |
|
account.status.types Status types displayed in the Account Status overlay and the account banner. Permits rearranging and renaming the status types. |
<mapping> <key>account.status.types</key> <map> <id>10100</id> <key>ACTIVE</key> </map> <map> <id>10102</id> <key>INACTIVE</key> </map> <map> <id>10103</id> <key>CLOSED</key> </map> <desc></desc> </mapping> |
id: Number. key: String (must match appropriate key in the Billing Care resource bundle). |
|
account.taxExemptions.types Tax exemption types displayed in the Tax Setup overlay. Permits adding, rearranging, and renaming the tax exemptions. Note: Make sure BRM supports the tax exemption when you add a new type. |
<mapping> <key>account.taxExemptions.types</key> <map> <id>0</id> <key>FEDERAL</key> </map> <map> <id>1</id> <key>STATE</key> </map> <map> <id>2</id> <key>COUNTRY</key> </map> <map> <id>3</id> <key>CITY</key> </map> <map> <id>4</id> <key>SECONDARY_COUNTRY</key> </map> <map> <id>5</id> <key>SECONDARY_CITY</key> </map> <map> <id>6</id> <key>TERRITORY</key> </map> <map> <id>7</id> <key>SECONDARY_STATE</key> </map> <map> <id>8</id> <key>DISTRICT</key> </map> <map> <id>9</id> <key>SECONDARY_FEDERAL</key> </map> <desc></desc> </mapping> |
id: Number. key: String (must match appropriate key in the Billing Care resource bundle). |
|
billUnit.accountingTypes Accounting types in the Bill Unit overlay. Permits adding, rearranging, and renaming the accounting types. Note: By default, BRM supports only balance forward and open item accounting. Before adding an accounting type, do the necessary customizations in BRM. |
<mapping> <key>billUnit.accountingTypes</key> <map> <id>1</id> <key>OPEN_ITEM</key> </map> <map> <id>2</id> <key>BALANCE_FORWARD</key> </map> <desc></desc> </mapping> |
id: Number. key: String (must match appropriate key in the Billing Care resource bundle). |
|
billUnit.billingFrequencyInMonths Billing frequency in the Bill Unit overlay. Permits adding, rearranging, and renaming the billing frequency. Example: An SDK developer can add "6 months" as an option in the drop-down. |
<mapping> <key>billUnit.billingFrequencyInMonths</key> <map> <id>1</id> <key>MONTHLY</key> </map> <map> <id>2</id> <key>BI_MONTHLY</key> </map> <map> <id>3</id> <key>QUARTERLY</key> </map> <map> <id>12</id> <key>ANNUAL</key> </map> <desc></desc> </mapping> |
id: Number. key: String (must match appropriate key in the Billing Care resource bundle). |
|
billUnit.correctiveInvoiceType Corrective invoice types supported for bill units. |
<mapping> <key>billUnit.correctiveInvoiceType</key> <map> <id>0</id> <key>REPLACEMENT_INVOICE</key> </map> <map> <id>4</id> <key>CORRECTIVE_INVOICE</key> </map> <desc></desc> </mapping> |
id: Number. key: String (must match appropriate key in the Billing Care resource bundle). |
|
billunit.status The status type that represents the state of the bill units in collections. Permits rearranging and renaming of the values. |
<mapping> <key>billunit.status</key> <map> <id>0</id> <key>DEFUNCT</key> </map> <map> <id>10100</id> <key>ACTIVE</key> </map> <map> <id>10200</id> <key>INACTIVE</key> </map> <map> <id>10300</id> <key>CLOSED</key> </map> <desc></desc> </mapping> |
id: Number. key: String (must match appropriate key in the Billing Care resource bundle). |
|
collections.action.status Displays the action status for collections. |
<mapping> <key>collections.action.status</key> <map> <id>0</id> <key>PENDING</key> </map> <map> <id>1</id> <key>CANCELLED</key> </map> <map> <id>2</id> <key>COMPLETED</key> </map> <map> <id>5</id> <key>WAITING_FOR_DEPENDENTS</key> </map> <desc></desc> </mapping> |
id: Number. key: String (must match appropriate key in the Billing Care resource bundle). |
|
device.sim.status The state of the Subscriber Identity Module (SIM) in the device. |
<mapping> <key>device.sim.status</key> <map> <id>1</id> <key>NEW</key> </map> <map> <id>2</id> <key>RELEASED</key> </map> <desc></desc> </mapping> |
id: Number. key: String. |
|
device.sim.networkElement The available wireless network element that is used for associating the SIM or the device number (NUM) with the Telco service. |
<mapping> <key>device.sim.networkElement</key> <map> <id>sample_network_element_1</id> <key>SAMPLE_NETWORK_ELEMENT_1</key> </map> <map> <id>sample_network_element_2</id> <key>SAMPLE_NETWORK_ELEMENT_2</key> </map> <desc></desc> </mapping> |
id: String. key: String. |
|
device.num.status The status type that represents the state of the device number. |
<mapping> <key>device.num.status</key> <map> <id>1</id> <key>NEW</key> </map> <map> <id>4</id> <key>UNASSIGNED</key> </map> <desc></desc> </mapping> |
id: Number. key: String. |
|
device.num.category The default number of categories for the device number. |
<mapping> <key>device.num.category</key> <map> <id>0</id> <key>NONE</key> </map> <map> <id>1</id> <key>RESERVED</key> </map> <desc></desc> </mapping> |
id: Number. key: String. |
|
device.num.vanity The value of the vanity key that is used for the device number. |
<mapping> <key>device.num.vanity</key> <map> <id>0</id> <key>NONE</key> </map> <map> <id>1</id> <key>SAMPLE_VANITY_1</key> </map> <map> <id>2</id> <key>SAMPLE_VANITY_2</key> </map> <desc></desc> </mapping> |
id: Number. key: String. |
|
payment.debit.accountTypes Direct debit accounting types displayed in the Payment Setup, Make Payment, and Bill Unit overlays. Permits adding, rearranging, and renaming the direct debit types. Note: Adding an accounting type to Billing Care also requires customizations in BRM. |
<mapping> <key>payment.debit.accountTypes</key> <map> <id>1</id> <key>ACCOUNT_TYPE_CHECKING</key> </map> <map> <id>2</id> <key>ACCOUNT_TYPE_SAVINGS</key> </map> <map> <id>3</id> <key>ACCOUNT_TYPE_CORPORATE</key> </map> <desc></desc> </mapping> |
id: Number. key: String (must match appropriate key in the Billing Care resource bundle). |
|
paymentMethods.invoice.deliverPreferTypes Invoice delivery preferences in the Payment Setup and Bill Unit overlays. Permits adding, rearranging, and renaming the delivery preferences. Note: BRM supports the key FAX with the ID 2 as a preference type. You can add this mapping to the CustomConfigurations.xml file. |
<mapping> <key>paymentMethods.invoice.deliverPreferTypes</key> <map> <id>0</id> <key>EMAIL</key> </map> <map> <id>1</id> <key>POSTAL</key> </map> <desc></desc> </mapping> |
id: Number. key: String (must match appropriate key in the Billing Care resource bundle). |
|
product.customization.delayed.reasons Reasons for product or discount activation delays. |
<mapping> <key>product.customization.delayed.reasons</key> <map> <id>2</id> <key>WAITING_FOR_NETWORK_CONFIGURATION</key> </map> <map> <id>4</id> <key>WAITING_FOR_MAINTENANCE</key> </map> <map> <id>1</id> <key>WAITING_FOR_INSTALLATION</key> </map> <desc></desc> </mapping> |
id: Number. key: String (must match appropriate key in the Billing Care resource bundle). |
|
serviceTypes.icons Service icons to display in the asset cards. An icon exists for account products and for GSM services. If no icon is provided for a service, the default icon is used. The image can be placed in any folder but must be in the WAR file. Optimum image dimension is 116 x 116 pixels. |
<mapping> <key>serviceTypes.icons</key> <map> <id>serviceIp</id> <key>resources/images/star-shape.png</key> </map> <map> <id>serviceEmail</id> <key>resources/images/star-shape.png</key> </map> <map> <id>accountProduct</id> <key>resources/images/hexagon-shape.png</key> </map> <map> <id>serviceTelcoGsm</id> <key>resources/images/audio-call.png</key> </map> <map> <id>defaultService</id> <key>resources/images/star-shape.png</key> </map> <desc></desc> </mapping> |
id: String. key: Icon associated with the specified service. |
Table 7-2 lists the configurable flags and their default values.
Table 7-2 Flags in Configuration File
| Configuration Key and Description | Default Values | Types |
|---|---|---|
|
accountbanner.showcurrencycode Flag that determines whether the ISO currency code (such as USD) is displayed in the account banner. |
<flags> <key>accountbanner.showcurrencycode</key> <value>false</value> <desc></desc> </flags> |
key: String. value: Boolean. If the value is true, the code is displayed. Default value is false. |
|
account.contact.showsalutation Flag that determines whether the salutation field is displayed in the account profile, the account banner, and all dialog titles. |
<flags> <key>account.contact.showsalutation</key> <value>false</value> <desc></desc> </flags> |
key: String. value: Boolean. If the value is true, the field is displayed. Default value is false. |
|
batch.payments.autoprocess Flag that determines whether batch payment files uploaded in the UI are automatically processed. |
<flags> <key>batch.payments.autoprocess</key> <value>false</value> <desc></desc> </flags> |
key: String. value: Boolean. If the value is true, the files are automatically processed. Default value is false. |
|
billinvoice.use.modaldialog Flag that determines whether invoices viewed in Billing Care are display in a dialog box. |
<flags> <key>billinvoice.use.modaldialog</key> <value>false</value> <desc></desc> </flags> |
key: String. value: Boolean. If the value is true, invoices are display in a dialog box. Default value is false. |
|
graph.notes.indicators Flag that determines whether notes indicators are displayed on top of graphs. When accounts have lots of activity or lots of notes, too many indicators may be shown. Setting this value to false enables you to remove the indicators, reducing visual clutter. |
<flags> <key>graph.notes.indicators</key> <value>true</value> <desc></desc> </flags> |
key: String. value: Boolean. If the value is false, the indicators are not displayed. Default value is true. |
|
request.record.failure Flag that determines whether to record in the BRM database all Billing Care REST API transactions that failed. Only requests that are changing resources are recorded. |
<flags>
<key>request.record.failure</key>
<value>false</value>
<desc></desc>
</flags>
|
key: String. value: Boolean. If the value is true, failed transactions are recorded. Default value is false. |
Table 7-3 lists the configurable thresholds and their default values.
Table 7-3 Thresholds in Configuration File
| Configuration Key and Description | Default Values | Types |
|---|---|---|
|
accountsearch.limit Number of account search results shown by default. The number of search results shown can be increased or decreased by editing the value field. Note: The limit set for the account search results must be a non-zero positive integer. |
<thresholds> <key>accountsearch.limit</key> <value>50</value> <desc> </desc> </thresholds> |
key: String. value: Number. |
|
assets.servicetypes.size Maximum number of service types shown by default in Assets section. Additional service types can be shown by clicking a Show More link. |
<thresholds> <key>assets.servicetypes.size</key> <value>6</value> <desc></desc> </thresholds> |
key: String. value: Number. |
|
balances.services.size Maximum number of services shown by default in Balances section. Additional services can be shown by clicking a Show More link. |
<thresholds> <key>balances.services.size</key> <value>4</value> <desc></desc> </thresholds> |
key: String. value: Number. |
|
batch.payments.threshold Maximum percentage of payments in a batch that can be suspended. If this value is exceeded, batch processing stops. |
<thresholds> <key>batch.payments.threshold</key> <value>50</value> <desc></desc> </thresholds> |
key: String. value: Number. |
|
collections.pagination Maximum number of collections bill units displayed in a table on a page. For example, if 150 records exist, only the first 25 are initially displayed. When you click Show More, the next 25 are retrieved and appended to the initial results. You can repeat this to retrieve the remaining records. |
<thresholds> <key>collections.pagination.size</key> <value>25</value> <desc></desc> </thresholds> |
key: String. value: Number. |
|
creditcard.alert.expirydays Number of days before credit card expiration that an alert is shown in the card tile in Make Payment and Payment Setup overlays. |
<thresholds> <key>creditcard.alert.expirydays</key> <value>60</value> <desc></desc> </thresholds> |
key: String. value: Number. |
|
devicesearch.limit Number of records to be retrieved in device search dialog. By default, 50 records are displayed. The number of search results shown can be increased or decreased by editing the value field. Note:The limit set for the device search results must be a non-zero positive integer. |
<thresholds> <key>deviceearch.limit</key> <value>50</value> <desc> </desc> </thresholds> |
key: String. value: Number. |
|
package.alert.expirydays Number of days before expiration a package can be purchased during account creation or add-on package purchase. |
<thresholds> <key>package.alert.expirydays</key> <value>60</value> <desc></desc> </thresholds> |
key: String. value: Number. |
|
pagination.size Maximum number of records initially displayed in a table on a page. For example, if 150 records exist, only the first 50 are initially displayed. When you click Show More, the next 50 are retrieved and appended to the initial results. Clicking Show More one more time retrieves the final 50. All 150 records are now displayed. |
<thresholds> <key>pagination.size</key> <value>50</value> <desc></desc> </thresholds> |
key: String. value: Number. |
|
paymentsuspense.pagination.size Maximum number of records initially displayed in a table on a page in the payment suspense search results. For example, if 50 records exist, only the first 25 are initially retrieved and displayed. To see the next 25 records, you must click Show More. |
<thresholds> <key>paymentsuspense.pagination.size</key> <value>25</value> <desc></desc> </thresholds> |
key: String. value: Number. |
|
pcm.connection.timeout Maximum number of milliseconds in which an opcode must return results before the connection times out. If you change this value, you must restart the server to reinitialize the connection pool. |
<thresholds> <key>pcm.connection.timeout</key> <value>15000</value> <desc></desc> </thresholds> |
key: String. value: Number. |
|
recent.records.size Maximum number of recently opened accounts displayed in the Search overlay. |
<thresholds> <key>recent.records.size</key> <value>5</value> <desc></desc> </thresholds> |
key: String. value: Number. |
|
session.timeout.advancewarningtime Advance warning time for session time out in seconds. |
<thresholds> <key>session.timeout.advancewarningtime</key> <value>60</value> <desc></desc> </thresholds> |
key: String. value: Number. |
|
roles.batchsize Maximum number of roles that can be retrieved in a batch when a search operation is performed to find roles; for example, roles with permissions to manage suspended payments. Note: There will no visible changes to the UI for any change made for role batch size retrieval. |
<thresholds> <key>roles.batchsize</key> <value>100</value> <desc></desc> </thresholds> |
key: String. value: Number. |
Table 7-4 lists the configurable registry keys and their default values.
Table 7-4 Registry Entries in Configuration File
| Configuration Key and Description | Default Values | Types |
|---|---|---|
|
accountBannerSections Sections displayed in the account banner. Permits rearranging (by modifying the order of the registry keys), deleting, and adding sections. |
<keyvals> <key>accountBannerSections</key> <value>accountBannerContact,accountBannerAccountInfo,accountBannerCollections,accountBannerBillUnits,accountBannerVIPInfo</value> <desc></desc> </keyvals> |
key: String. value: Comma-separated strings. |
|
accountCreation.packageList Name of the package list containing the packages displayed during account creation. Default is CSR. To enable Billing Care to display a different package list, replace the default package list name with one of the following package list names:
If no package list name is specified, packages from the default-new package list are displayed. |
<keyvals> <key>accountCreation.packageList</key> <value>CSR</value> <desc></desc> </keyvals> |
key String. value: String. |
|
accountCreation.tabs Account creation framework configuration used to render train stops and labels for the footer. The key is also used as a registry entry to fetch views or view models for the corresponding train stops. |
<keyvals>
<key>accountCreation.tabs</key>
<value>
[{"key": "generalInfo", "value":{
"label":"PROFILE",
"msg":"COMPLETE_PROFILE_THEN",
"title":"PROFILE_SHORT_DESCRIPTION"
}
},
{"key": "accountCreationSelect", "value":{
"label":"SELECT",
"msg":"SELECT_THEN"
}
},
{"key": "accountCreationConfigure", "value": {
"label" : "CONFIGURE",
"msg" : "COMPLETE_CONFIGURATION_THEN",
"title": "CONFIGURE_SHORT_DESCRIPTION"
}
},
{"key": "accountCreationPay", "value": {
"label" : "PAY",
"msg" : "COMPLETE_PAYMENTINFORMATION_THEN",
"title": "PAY_SHORT_DESCRIPTION"
}
}]
</value>
<desc></desc>
</keyvals> |
key: String. value: String. |
|
accountCreation.tagsMapping Mapping for tagging a package. |
<keyvals>
<key>accountCreation.tagsMapping</key>
<value>[{"key": ".*GSM.*|.*[Mm]obile.*", "value":"Mobile"},
{"key": ".*[Cc]able.*", "value":"Cable,TV"},
{"key": ".*[Ff]iber.*|.*[Ww]eb.*|.*GPRS.*", "value": "Internet"},
{"key": ".*[Cc]orporate.*", "value": "Corporate"},
{"key": ".*[Tt]ax.*", "value": "Tax"},
{"key": "*", "value": "Uncategorized"}]
</value>
<desc></desc>
</keyvals> |
key: String. value: Regular expression. The key is a regular expression to match the package name or Uncategorized, and the value is the tag name. If a package name matches the regular expression, it is tagged with the corresponding tags. Packages that do not match mapping rules are categorized under the "*" pattern value. |
|
authorizationResourceTypes Custom authorization resource types. The resource types should be defined in OPSS. |
<keyvals>
<key>authorizationResourceTypes</key>
<value></value>
<desc></desc>
</keyvals> |
key String. value: Comma-separated string. Note: The key should not be changed here. |
|
batchPaymentsDateFormat Format of batch payment date. The default supports the following date formats: 23-December-30 23-December-2030 To abbreviate the month, change MMMM to MMM, which supports the following date formats: 23-Dec-30 23-Dec-2030 To use four digits instead of two for the date, change y to yyyy. |
<keyvals> <key>batchPaymentsDateFormat</key> <value>d-MMMM-y</value> <desc></desc> </keyvals> |
key: String. value: String. |
|
batchPaymentsDirectoryName Batch payment parent directory name. |
<keyvals> <key>batchPaymentsDirectoryName</key> <value>BatchPaymentFiles</value> <desc></desc> </keyvals> |
key: String. value: String. |
|
batchPaymentsTabs List of tabs displayed in the batch payments page. |
<keyvals>
<key>batchPaymentsTabs</key>
<value>[{"id": "active", "label": "ACTIVE"},{"id": "history", "label": "HISTORY"}]</value>
<desc></desc>
</keyvals> |
id: String. key: String. |
|
batchPaymentTypes Supported batch payment types. By default, the following payment types are supported:
|
<keyvals>
<key>batchPaymentTypes</key>
<value>[{"type": "Cash Payment Batch","code": "10011","templateName":"cash_payment_template.pit"},{"type": "Check Payment Batch","code": "10012","templateName":"check_payment_template.pit"},{"type": "Wire-Transfer Payment Batch","code": "10013","templateName":"wire-transfer_payment_template.pit"},{"type": "Inter Bank Payment order Payment Batch","code": "10014","templateName":"interbankpayorder_payment_template.pit"},{"type": "Postal order Payment Batch","code": "10015","templateName":"postalorder_payment_template.pit"},{"type": "Failed Payment Batch","code": "10017","templateName":"failed_payment_template.pit"}]</value>
<desc></desc>
</keyvals> |
key: String. value: String (includes payment type, payment ID, and the name of a template file (.pit) for batch processing). |
|
brmserver.timezone The time zone configuration for displaying the time in Billing Care. Use one of these options for the time zone:
If the value is empty, the WebLogic Server's timezone is used. |
<keyvals> <key>brmserver.timezone</key> <value>America/Los_Angeles</value> <desc></desc> </keyvals> |
key: String. value: String. |
|
collections.icon Displays the Collections icon. |
<keyvals>
<key>collections.icon</key>
<value>[{"key": "*", "value":"resources/images/collections.png"}]</value>
<desc></desc>
</keyvals> |
key: String. value: Complex array containing an icon. |
|
cssFiles All available CSS files. "activeTheme" : true represents the active theme. |
<keyvals>
<key>cssFiles</key>
<value>{"availablethemes": [{"name" :"css/theme_.css" ,"activeTheme" : true}, {"name" :"css/theme_default.css", "activeTheme" : false}]}</value>
<desc></desc>
</keyvals> |
key: String. value: Boolean. |
|
financialSetup.tabs Used to configure the page navigator. Order of each entry is the order in which the tabs are shown. |
<keyvals>
<key>financialSetup.tabs</key>
<value>[{"key": "paymentMethods", "editable": false, "subcontent":[{"key":"newPaymentMethod", "editable": true}, {"key":"editPaymentMethod", "editable": true}]} ,{"key":"billUnits","editable": false,"subcontent":[{"key":"newBillUnit", "editable": true},{"key": "editBillUnit", "editable": true}]},{"key": "taxSetup", "editable": true}]</value>
<desc></desc>
</keyvals> |
key: String. value: Boolean. "editable": true shows the Apply or Cancel link with a save message after saving. "editable": false shows the Close button. |
|
organizationHierarchyTypes Organization hierarchy types include the name, ID, and icon. |
<keyvals>
<key>organizationHierarchyTypes</key>
<value>
[
{"key": "site", "value":{"name":"SITE","value": 1,"icon":"resources/images/site.png"}},
{"key": "legalEntity", "value":{"name":"LEGAL_ENTITY","value": 2,"icon":"resources/images/legal-entity.png"}},
{"key": "billingAccount", "value": {"name" : "BILLING_ACCOUNT","value": 3,"icon" : "resources/images/billing-account.png"}},
{"key": "serviceAccount", "value": {"name" : "SERVICE_ACCOUNT","value": 4,"icon" : "resources/images/service-accounts.png"}}
]
</value>
<desc></desc>
</keyvals> |
key: String. value: Complex array containing type, ID, and an icon. |
|
paymentsuspense.excludedpaymenttypes Comma-separated list of payment types excluded from the payment suspense flow. By default, credit card and direct debit payment types (that is, 10003, 10005) are excluded because they are BRM-initiated. |
<keyvals> <key>paymentsuspense.excludedpaymenttypes</key> <value>10003,10005</value> <desc></desc> </keyvals> |
key: String. value: String. |
|
paymentSuspense.reasonMapping Mapping for two-tier suspense reason filtering. The key is a regular expression to match the detailed reason description, and the value is the higher-level reason. If a reason description matches the regular expression, the reason is grouped with corresponding higher-level reasons. Otherwise, it is grouped under Uncategorized. If an icon property is available in a resource path, corresponding grouped payments are shown with it. Otherwise, uncategorized icons are shown by default. Note: The "*" key should be the last entry in the value because it is the broadest group. |
<keyvals>
<key>paymentSuspense.reasonMapping</key>
</value>[
{"key": ".*[Tt]echnical.*", "value":"Technical", "icon": "resources/images/unable-to-process-icon.png"}
,
{"key": ".*[Bb]usiness.*", "value":"Business", "icon": "resources/images/business-rule-match-icon.png"}
,
{"key": ".*[Mm]ultiple.*", "value": "Unable to Process", "icon": "resources/images/unable-to-process-icon.png"}
,
{"key": "*", "value": "Unclassified", "icon": "resources/images/unable-to-process-icon.png"}
]</value>
<desc></desc>
</keyvals> |
key: Regular expression. value: String. |
|
paymentTypes Registry keys for rendering payment type views in the Bill Unit screen, Payment Methods screen, and Make Payment dialog box. This is also used for retrieving localized values from XLF files. Though paymentTypes has an entry for invoice, when this is used in the Make Payment dialog box, invoice payments are ignored while the payment method view is rendered. Note: Do not change these values unless you are removing a payment type not used in your environment. |
<mapping> <key>paymentTypes</key> <map> <id>10003</id> <key>creditCard</key> </map> <map> <id>10005</id> <key>directDebit</key> </map> <map> <id>10001</id> <key>invoice</key> </map> <map> <id>10018</id> <key>sepa</key> </map> <map> <id>0</id> <key>noPaymentMethod</key> </map> <desc></desc> </mapping> |
id: Number. key: String (must match appropriate key in the Billing Care resource bundle). |
|
purchase.bundleTagsMapping Mapping for tagging the bundle. |
<keyvals>
<key>purchase.bundleTagsMapping</key>
<value>[{"key": ".*GSM.*|.*[Mm]obile.*", "value":"Mobile"},
{"key": ".*[Cc]able.*", "value":"Cable,TV"},
{"key": ".*[Ff]iber.*|.*[Ww]eb.*|.*GPRS.*", "value": "Internet"},
{"key": ".*[Cc]orporate.*", "value": "Corporate"},
{"key": ".*[Tt]ax.*", "value": "Tax"},
{"key": ".*[Dd]iscount*.", "value": "Discounts"},
{"key": ".*[Ii]nternet*.", "value": "Internet"},
{"key": "*", "value": "Uncategorized"}]
</value>
<desc></desc>
</keyvals> |
key: Regular expression. value: String. The key is a regular expression to match the bundle name or Uncategorized, and the value is the tag name. If a bundle name matches the regular expression, the bundle is tagged with the corresponding tags. Bundles that do not match mapping rules are categorized under the "*" pattern value. |
|
purchase.packageList Name of the package list containing the packages displayed during purchase of an add-on package. Default is default. To enable Billing Care to display a different package list, replace the default package list name with one of the following package list names:
If no package list name is specified, packages from the default-new package list are displayed. |
<keyvals> <key>purchase.packageList</key> <value>default</value> <desc></desc> </keyvals> |
key: String. value: String. Default value is default. Other possible value is CSR. If the package list name is not specified, packages from the default-new list are displayed. |
|
purchase.tabs Product catalog framework configuration used to render the train stops and labels for the footer. The keys are also used as registry entries to fetch views or view models for the corresponding train stops. |
<keyvals>
<key>purchase.tabs</key>
<value>
[
{"key": "purchaseSelection", "value":{
"label":"SELECT",
"msg":"SELECT_PURCHASE",
"title":"SELECT_SHORT_DESCRIPTION"
}
}
,
{"key": "purchaseConfiguration", "value": {
"label" : "CONFIGURE",
"msg" : "COMPLETE_CONFIGURATION_THEN",
"title": "CONFIGURE_SHORT_DESCRIPTION",
"disabled": true
}
}
]
</value>
<desc></desc>
</keyvals> |
key: String. value: Complex string containing a label, message, and title. |
|
search.options |
<keyvals>
<key>search.options</key>
<value>[{"searchTemplateKey": "accountSearch", "searchTemplateName":"SEARCH_OPTION_ACCOUNTS", "defaultSearch": true}]</value>
<desc></desc>
</keyvals> |
key: String. value: String. searchTemplateKey acts as the value of the search drop-down option. The value of searchTemplateKey (that is, accountSearch) acts as the search template name The searchTemplateName value corresponds to the text of the search drop-down option. The value of searchTemplateName (that is, SEARCH_OPTION_ACCOUNTS) corresponds to a key in the resource bundle. |
Table 7-5 lists the configurable keyval categories and their default values.
Table 7-5 Keyvals in Configuration File
| Configuration Key and Description | Default Value | Type |
|---|---|---|
|
newsfeed.categories |
<keyvals>
<key>newsfeed.categories</key>
<value>[{"key":"ALL","newsfeedTypes": "ADJUSTMENT:true, NCR_ADJUSTMENT:true, OPEN_DISPUTE:true, CLOSED_DISPUTE:true, WRITEOFF:true, REFUND:true, COLLECTIONS:true, PAYMENT:true, PAYMENT_REVERSAL:true, PAYMENT_METHOD_ASSIGNMENT_CHANGE:true, PAYINFO:true, NAMEINFO:true, ACCT_STATUS:true, BILLINFO:true, BILLINFO_CREATED:true, BILLINFO_DELETED:true, DEFERRED:true, SRVC_STATUS:true, SRV_TO_DEV:true, PURCHASE:true, CANCEL:true, CORRECTIVE_BILL:true, RECURRING_CHARGE:true, BILL_ISSUED:true, BILL_ISSUED_MID_CYCLE:true, ONE_TIME_CHARGE:true", "selected": true},{"key": "AR", "newsfeedTypes": "ADJUSTMENT:true, NCR_ADJUSTMENT:true, OPEN_DISPUTE:true, CLOSED_DISPUTE:true, WRITEOFF:true, REFUND:true, COLLECTIONS:true"},{"key":"PAYMENTS","newsfeedTypes": "PAYMENT:true, PAYMENT_REVERSAL:true, PAYMENT_METHOD_ASSIGNMENT_CHANGE:true, PAYINFO:true"},{"key":"CHARGES","newsfeedTypes": "PURCHASE:true, CANCEL:true, CORRECTIVE_BILL:true, RECURRING_CHARGE:true, BILL_ISSUED:true, BILL_ISSUED_MID_CYCLE:true, ONE_TIME_CHARGE:true"},{"key":"ACCOUNT","newsfeedTypes": "NAMEINFO:true, ACCT_STATUS:true, DEFERRED:true, SRVC_STATUS:true, SRV_TO_DEV:true, BILLINFO:true, BILLINFO_CREATED:true, BILLINFO_DELETED:true"}]</value>
<desc></desc>
</keyvals> |
key: String. value: String (must match appropriate key in the Billing Care resource bundle). |