Create a Balance State Update Component

You can create a balance state update component to extend the end date of a G/L balance according to the rules in the balance state update profile.

Before you begin

Create the balance state update profile(s) that the balance state update component will use.

About this task

Virtual balances cannot be extended or shortened.

Procedure

  1. In Balance State Update, click the Balance State Update Components tab, and click New Component.
  2. In Create New Balance State Update Component:
    1. In Name, enter a unique name.
    2. (Optional) In Description, enter descriptive information about the item.
    3. (Optional) In External ID, enter any alphanumeric character to serve as a unique ID on this pricing object. The external ID can be used for any reason that is meaningful to your implementation of MATRIXX Engine. External IDs are saved to the pricing configuration file and loaded into the Pricing database.
    4. Click Create.
  3. In Start Date/Time, use the date picker to select the date on which the object becomes active in the Pricing database and is first available for use, or enter the date in the format YYYY-MM-DD. Optionally, enter a time for when the object becomes active. The default start date/time is 2000–01–01 00:00:00. If applicable, the range in which the start date/time must fall is listed. For example:
    • Select a date on or before 2021–12–01.
    • Select a date on or after 2020–01–27.
    • Select a date between 2000–01–02 and 2021–10–04.
    Note: If you are creating a new revision of this object, the start date/time must be after the start date/time of the preceding revision and before the start date/time of the next revision. If you are making a copy of this object, the start date/time is not copied. The new object is the first revision, so it has the default start date/time of 2000–01–01 00:00:00.
  4. In Application, select the application type.
    • purchase — The balance state update component applies to catalog item purchases only.
    • auto_renew — The balance state update component applies to product offer auto-renew only. For information about auto-renew, see the discussion about auto-renew in MATRIXX Pricing and Rating.
    • balance_threshold — The balance state update component applies to balance-threshold based pricing only. For more information about balance-threshold based pricing, see the discussion about balance-threshold based pricing in MATRIXX Pricing and Rating.
    • purchased_item_activation — The balance state update component is applied when a product offer or bundle purchased in a pre-active state is activated.
      Important: Product offers and bundles with activation components must be purchased in a pre-active state or the purchase will fail.
    • resume — The balance state update component is applied when a product offer or bundle, purchased in a pre-active state, is resumed.
      Note: When an offer is resumed, the proration types are used to calculate the amount of recurring charge and grant. Upon offer resumption, a new cycle with a new interval ID is established per the existing cycle definition.
    • suspend — The balance state update component is applied when a product offer or bundle, purchased in a pre-active state, is suspended.
      Note: When an offer is suspended, no refund or forfeiture is issued at the time of offer suspension, and no recurring charge or grant at the time of offer resumption.
  5. (For balance_threshold application type only) If the balance state update component applies to balance-threshold based pricing:
    1. For Balance, click Select Balance and select the balance whose threshold, when crossed during rating, triggers the component to apply for balance-threshold based pricing.
    2. In Threshold, select the threshold (of the specified balance) that when crossed, triggers the component to apply for balance-threshold based pricing.
      Note: If the threshold is updated, then the balance must be reselected by clicking Select Balance to refresh the threshold.
    3. For Is Instance Specific:
      • Select this option if the balance-threshold based pricing configuration for the component applies to only balance instances created by the containing offer.
      • Deselect this option if the balance-threshold based pricing configuration for the component applies to all balance instances in the balance template.
  6. (Optional) In Tier, select a required group tier to which the balance state update component applies.
  7. (Optional) In Limit Balance Extension to, set the amount to limit the amount of extension that can be applied to a balance. The value you set here limits the end time of a balance instance to a maximum duration; it is a limit (cap) for balance instance end time, relative to the time the component is evaluated (for example as a purchase or auto-renewal).
  8. (Optional) In Extension Limit Units, set the unit value of the balance extension to be limited (minutes, hours, days, weeks, months, or years).
  9. (Optional) In Extension Limit Policy, select the policy to allow or deny the balance extension. The policy determines, when the limit is exceeded, whether to allow the operation to proceed with the limited extension quantity or to fail the extension.
  10. In Reduction Policy, select the reduction policy:
    • Allow Reduction Up To Now — The current balance is adjusted even if a date earlier than the current balance end time is calculated (note that this cannot be a date in the past).
    • Deny Reduction — The current balance end time does not change if a date earlier than the current balance end time is calculated.
  11. Click Save.
  12. In the Balance State Update Tables pane, click New Balance State Update Table to create a new update table.
  13. In Create New Balance State Update Table, do the following:
    1. In Name, enter a unique name.
    2. (Optional) In Description, enter descriptive information about the item.
    3. (Optional) In External ID, enter any alphanumeric character to serve as a unique ID on this pricing object. The external ID can be used for any reason that is meaningful to your implementation of MATRIXX Engine. External IDs are saved to the pricing configuration file and loaded into the Pricing database.
    4. Click Create.
  14. In the Balance State Update Tables pane, click the name of the newly created balance state update table.
  15. In Default Result, select a default profile or SKIP to use when the normalization values present during rating do not match any of the results defined in the decision table.
  16. For Balance Class and Balance, click Select Balance and select the balance template from which the G/L balance instances to extend when created. When the product offer is purchased, only the balance end time of the balance that expires last is extended. You can select simple or periodic balances.
  17. Click Save.
  18. In the Decision Table pane, do one of the following.
    • To add an existing decision table, click Select Decision Table, click the name of the decision table to add, and click Select.
      Tip: To filter the list of decision tables available, enter the decision table ID or name in the Search field.
    • To create a new decision table, click Create New Table and define the new decision table. For information about creating decision tables, see the discussion about creating a decision table.
    After a decision table is applied to the component table, its ID and name display as a hyperlink in the Decision Table pane. To change the applied decision table, click the hyperlink to open Edit Decision Table. After making and saving changes, click Cancel to return to the component table.
  19. For each row in the balance state update table, click the balance state update profile cell (the result cell) and select a balance state update profile or SKIP.
    If the row selected during rating has a SKIP value, it is not applicable and the next balance state update table is examined if one exists.
  20. (Optional) To add additional balance state update tables to this balance state update component, use the breadcrumbs to go back to Edit Balance State Update Component.
    Note: During rating, the balance state update tables are examined in the order they are listed. To change the order in which multiple tables are listed, click and drag a table to the new position in the list.