Skip to content

Glossary

Account — Your organization in Oclavex: your catalog, customers, licenses and usage.

Catalog — Everything you author before anyone is licensed: products and their versions, the feature catalog, monitored assets, suites, plan sets, offers, add-ons and rating campaigns. It is what the Catalog group in the portal contains, and what catalog transfer exports as a single portable file.

Product — Something you license, identified by a product code plus a version: one to four dot-separated numbers (1, 1.0, 1.2.3.4), or empty. Not SemVer — prerelease and build suffixes are rejected. Each version is a separate product in a lineage, with its own features, metrics and plans.

Feature — A capability of a product, identified by a dotted feature code (e.g. api-calls.total) and a data type. Defined once in the product’s feature catalog.

Feature catalog — The per-product set of feature definitions — the single source of truth for what each feature code means.

Plan — A named package (e.g. Basic, Pro) that sets each feature’s value, or its quota tiers, for the customers on it. A plan is not called a tier: tier in this product always means a usage band, never a package (see Quota tier).

Plan set — The collection of plans for one suite; moves through Draft → Published → Retired. Exactly one is live per suite at a time.

Suite — The commercial unit: an ordered group of products sold and priced together, and the owner of the plan sets that price them. A product priced alone gets its own suite, containing only that product.

Member — A product belonging to a suite. Each plan says whether a member is included and what value each of its features is set to.

Add-on — A named set of feature adjustments, scoped to a suite, granted on top of a customer’s existing plan.

Offer — What your orders start from. A pre-assembled deal (products, plan, policies) that an order turns into an entitlement. Catalog-internal: an end user never sees an offer, only what was ordered from it.

Entitlement — A customer’s grant: which product and features they may use, under which plan and policies, for how long. Its features are a snapshot taken when the product is added.

Metric — A measured quantity on a product. Its typeCumulativeCounter, TotalCounter, Gauge or UpDownCounter — sets how readings aggregate.

Monitored asset — A product metric paired with a usage configuration: quota tiers and, optionally, a credit balance.

Quota tier — A usage band for a metric, carrying a level (Normal, Warning, Critical, OverUsage) and an enforcement policy (NotifyOnly, AllowWithOverage, AllowWithGrace, RateLimit, Deny, SuspendUsage).

Credit balance — A prepaid account in a currency and unit you choose, drawn down as priced usage is consumed — separate from raw metric counts.

License — Ambiguous by design, so used carefully: the onboarding pages call the entitlement “one customer’s license”; the activation pages call the session “the license.” Both are correct for different questions: what a customer is granted, versus what is currently active on a device.

Activation — Turning an entitlement into a running license on a device or for a user, producing a session.

Session — An active license claim: a session id, a device fingerprint, a signed session token, and a lease renewed via heartbeats.