Catalog Item General Properties

Catalog item general properties are listed in Catalog Item General Properties.

Table 1. Catalog Item General Properties
Property Description
ID An identifier automatically created and modified by My MATRIXX.
Name A descriptive name for the catalog item that you enter. Catalog item names are displayed in My MATRIXX and in bundles.
Description Descriptive information about the catalog item's purpose.
External ID Use this field to specify the catalog item in MATRIXX pricing objects. External IDs are saved to the pricing configuration file and loaded into the Pricing database. The value of an external ID can be set to any alphanumeric character that is meaningful to your implementation. An external ID could be used, for example, to relate offers in the MATRIXX system to products in an external pricing plan. It could also be used by the Subscriber Management API to query and purchase product offers and bundles.
Start Date/Time The date and time the catalog item becomes valid.
Note: The catalog item is not returned in queries until the specified start date/time. If an attempt is made to purchase the offer before the start date/time, the following error is returned: No catalog item found.
Pricing Revision Policy The criteria used to find revisions of pricing objects to use during rating.
Note: The defined pricing revision policy does not affect the selection of MtxTaxClassObject revisions. The MtxTaxClassObject is selected using tax point or event time.
Select from the following:
  • Event Time — The event time is used to find revisions of pricing objects. This is the default.
  • Start of Cycle — The start time of the current purchased item cycle period is used to find revisions of pricing objects.
    • If the purchased item does not have a purchased item cycle defined, the purchased item owner's bill cycle is used.
    • If the subscriber/group does not have a bill cycle, the event time is used to find revisions of pricing objects. (The event time for usage rating is the quota authorization time.) This is the case when a purchased item has no cycle.
Note: For pricing objects used outside of the context of any purchased item (for example, FUI selectors), the event time is used for selecting revisions.

For more information, see the discussion about pricing revision policies for catalog items in MATRIXX Pricing and Rating.

Offer/Bundle ID The external ID of the offer or bundle used as the basis for the catalog item.
Offer or Bundle The name of the offer or bundle that is the basis for the catalog item. A Pricing User modifies the offer or bundle template fields to create a catalog item.
Contract (Finance and service contract catalog items only) The name of the contract that is the basis for the catalog item. A Pricing User modifies the contract template fields to create a catalog item.
Note: This option is displayed only if you selected a service contract or finance contract as the basis for the catalog item.
Contract ID (Finance and service contract catalog items only) The external ID of the contract used as the basis for the catalog item.
Purchase Start Date The date the catalog item is available for purchase.
Note: If an attempt is made to purchase the offer outside of these dates, the following error is returned: Catalog item with ID=x is not valid for purchase at this time.
Purchase End Date The date after which the catalog item is no longer available for purchase.
Purchase State A required state for the associated offer or bundle at purchase time. This property mainly affects purchases of offers and bundles with activation components. If such items are purchased in an Active state, all activation components are applied at purchase time.
The options are:
  • None (default) — If the offer (or offers in the bundle) assigned to the catalog item has activation pricing components, the PurchaseState attribute of the catalog item is set to pre-active in the compiled pricing file. Otherwise (that is, if the offers do not have activation pricing components), this option behaves the same as the "Specified At Purchase" option.
  • Active — The offer is purchased as active.
  • Preactive — The offer is purchased as pre-active.
  • Specified At Purchase — At purchase time, if the PreActiveState parameter of the PurchaseOffer API is set to true, the catalog item is purchased as pre-active. Otherwise (that is, if the PreActiveState parameter is set to false or is not set), the catalog item is purchased as active.
Note: After Purchase State is set for the catalog item, you can clear the purchase state to return the catalog item to its default behavior.
Purge Profile The expired offer removal period for the catalog item.
Catalog Item Template Fields The list of template fields you can change for the catalog item. These fields are specified on the Template Fields tab of the offer or bundle that the catalog item is based on. Each catalog item template field has a default value that a Catalog User can change when the user creates or changes a catalog item. The value must match the field data type.
Obsolete Template Fields Fields that are no longer valid for a catalog item. The list of catalog item fields is specified on the offer or bundle Template Fields tab. Fields are rendered obsolete if they are no longer available because the list of fields changed in the offer or bundle, or a new template was selected. Obsolete template fields have no effect on the catalog item. You can leave them or delete them as necessary.