Balance Template Attributes Properties

You can define an attribute by entering its name, data type, and value. For example, if you enter an attribute on a balance named Display with a type Boolean and a value true, the meter is flagged with meta-data indicating it should be displayed in MATRIXX Backoffice Customer Tool.

Attributes Properties lists the attribute properties.

Table 1. Attributes Properties
Property Description
Name A descriptive name for the attribute.
Type The attribute type:
  • String
  • Integer
  • Decimal
  • Boolean
  • Long
Value The attribute value.

Balance attributes are not used for rating. They aid in the display of pricing information in MATRIXX Backoffice Customer Tool. Balance attributes can limit the balances that are displayed and set the ranges for the usage bars displayed. You can define an attribute by entering its name, data type, and value.

Balance Attributes describes the supported MATRIXX Backoffice Customer Tool balance attributes.
Table 2. Balance Attributes
Attribute Name Description Type
MtxDisplay Sets whether the balance or meter is displayed in the application, and if so, how. Values are:
  • none or hidden — Not displayed.
    Note: When MtxDisplay is set to none or hidden, SubMan wallet queries do not return information for the balance.
  • normal — Displays the balance as a usage bar that shows the amount used and amount remaining.
  • pieChart — Displays the balance as a usage bar that can be clicked to open a pie chart displaying the top four meters tracking the balance usage, showing their current amounts.
  • wedge — Indicates that a meter is to be displayed in the pie chart for a balance.
String
MtxUnits The measurement unit for the balance quantity, for example, Min or MB. String
MtxPrecision The precision in which to display balance quantities. This determines the number of integers to display to the right of the decimal point. Integer
MtxTransferrable For balances in a group wallet, indicates the credit limit can be transferred from one user in the group to another. The transfer reduces the credit limit for the from user and increases the credit limit for the to user by the amount entered.

For example, if two users in the group that each have a credit limit on the balance of 500 minutes and 100 minutes are transferred, the result is one user with a 400 minute credit limit and another with a 600 minute credit limit for that balance.

Boolean: true or false
MtxBalanceGroup When set, allows filtering of the list of balances displayed in the application. Values are:
  • data — Used for showing only the data balances.
  • voice — Used for showing only the minute balances.
String