Eligibility Rules for Catalogs

A catalog is a collection of catalog items. A catalog is a set of requires and excludes eligibility rules evaluated against the catalog items.

A catalog item can be standalone or belong to one or more catalogs.

Data Plan Catalog

Create a catalog that returns the list of catalog items with eligibility feature Plan Type = Data. In this example, Plan Type = Data is an existing eligibility feature assigned to catalog items.
  1. Create an eligibility rule CatalogItemDataPlan, select Catalog Item as the Object Type, and select Feature as the Entity Type.
  2. Select Plan Type from the Feature drop-down menu, and enter the value Data.
  3. Create a catalog Data Plan Catalog.
  4. Scroll down to the Requires Rules table, and add CatalogItemDataPlan to Requires Rules.
When defining an eligibility rule, if you define the Object Type as Catalog Item and the Entity Type as Attribute, you select the MATRIXX Data Container (MDC) MtxCatalogItemRev, select the MDC MtxCatalogItemRev, and select from the available MDC fields. MtxCatalogItemRev MDC Fields lists the MDC fields available in the MtxCatalogItemRev MDC container.
Table 1. MtxCatalogItemRev MDC Fields
Field Data Type
ContractId UINT64
Description String
Name String
PurchaseState UINT32 (enum)
TemplateId UINT64
TemplateVersion UINT32
TemplateVersionId UINT64

Enforcing Eligibility Rules

Eligibility rules are enforced during catalog item purchases, cancelations, and queries. If a catalog item does not pass the eligibility check, the catalog item purchase fails. Eligibility rule dependencies determine which catalog items are excluded based on items owned or being purchased.

An eligibility rule is a rule on an attribute or a feature. Rules in the Requires Rules list on a catalog item are evaluated using the AND condition, and rules in the Excludes Rules list on a catalog item are evaluated using the OR condition. Only rules that apply to the object type of the SubMan API request—subscription, group, or device—are evaluated.

You can query catalogs based on eligibility using the SubMan APIs. Eligibility rules are evaluated and enforced during catalog queries. All require and exclude rules must pass for a catalog item to be included in the query response. For information about querying detailed information about a specific catalog, including a list of catalog items that satisfy the eligibility rules for the catalog, see the discussions about the eligibility rules API, catalog REST APIs, and catalog APIs in MATRIXX Subscriber Management API. For information about configuring eligibility rules, see the discussion about eligibility in My MATRIXX Help.