Glossary
Canonical names and definitions for the main entities used across the Xyte platform.
This glossary defines the main entities of the Xyte platform and establishes the canonical name and capitalization used throughout this documentation. When referring to one of these entities as a named concept, use the form shown here.
Organizations and tenants
- Partner — A hardware manufacturer (OEM) or similar organization registered on the Xyte platform. Partners manage Device Models, End Customers, Digital Products, and ecommerce offerings.
- Partner Cloud — A white-labeled tenant assigned to each Partner. End Customers of a Partner sign up and operate exclusively within that Partner Cloud and cannot log into another Cloud.
- End Customer — An organization that registers through a Partner Cloud to claim, monitor, and manage their Devices, Licenses, and subscriptions. Sometimes referred to simply as a Customer or Organization.
- Lab Account — A special End Customer automatically provisioned in every Partner Cloud and used as a sandbox. Lab Accounts can claim unpublished Device Models and use Lab payment methods to test purchase flows. Multiple Lab Accounts can be created on request.
- OEM — Original Equipment Manufacturer; a category of Partner. Used interchangeably with "hardware manufacturer."
Portals
- Partner Portal — The administrative portal where Partners configure Device Models, manage End Customers, Digital Products, Orders, and platform settings. Accessed at partners.xyte.io.
- Customer Portal — The white-labeled portal where End Customers and their End Users claim and manage Devices, purchase Digital Products, and submit Tickets. Also referred to as the End Customer Portal.
Users, groups, and access
- User — A person with an account on the platform. Users are scoped to a single Cloud (with Support Users being the exception).
- Partner User — A User registered in a Partner Portal.
- End User — A User registered in a Customer Portal under a single Partner.
- Group — A collection of Users within an End Customer that shares roles and permissions. Each User and Group belongs to exactly one End Customer.
- Support Seat — A permission assigned to a Partner User that grants access to support features and to one or more End Customers.
- Space — A node in an End Customer's organizational tree. Used to scope Device ownership and to grant access to a sub-set of an End Customer's organization.
Devices and models
- Device — A piece of hardware connected to the Xyte platform that can be claimed, configured, monitored, and commanded.
- Device Model — A specification that defines a family of Devices with shared capabilities, Supported Commands, Rules, Config Schema, Digital Products, and Widgets. Each Device belongs to exactly one Device Model. Often shortened to Model.
- Sub-model — A variant within a Device Model that shares the same capabilities but has distinct visual or hardware characteristics (for example, distinct images per Sub-model).
- Hardware Key — A secret key used to securely provision and register Devices of a given Device Model.
- Firmware — The software that runs on a Device. Firmware can be uploaded as a File and distributed or upgraded remotely.
- File — An asset (Firmware image, manual, script, etc.) that a Partner can upload to be distributed to Devices or made available to End Customers.
Telemetry, rules, and operations
- Telemetry — Time-series key/value messages sent from a Device to the platform that describe its current state. Used for monitoring, analytics, and Rule evaluation.
- Rule — Logic applied to a Device's Telemetry. When a Rule's condition matches, the platform raises an Incident and may open a Ticket or trigger a Notification.
- Incident — An issue created automatically when a Rule matches Device Telemetry. Incidents are tracked and routed for resolution.
- Command — A remote operation sent to a Device to perform an action. The set of Commands a Device accepts is defined as Supported Commands on its Device Model. Custom Commands are user-defined Commands authored by the Partner.
- Custom Field — A user-defined input parameter attached to a Command. End Users fill in Custom Field values when invoking the Command from the Customer Portal.
- Ticket — A support request opened by an End Customer to the Partner's support team for a specific Device. Tickets enable two-way communication and remote diagnosis.
- Configuration — The settings stored for a Device that govern its behavior. The Partner defines a Config Schema per Device Model to describe and validate these settings.
Commerce
- Digital Product — Software-based functionality (e.g., warranty extension, premium feature) that a Partner offers for purchase against a Device or Device Model. Purchasing a Digital Product produces one or more Licenses.
- License — The artifact issued when a Digital Product is purchased and applied to a Device. Licenses can be configured as movable (reassignable across Devices) or non-movable.
- Subscription — A recurring billing arrangement for a Digital Product, billed on a monthly or yearly Payment interval.
- Order — A purchase transaction for physical Devices or Digital Products initiated by an End Customer or by a Partner User on the End Customer's behalf.
- Invoice — A financial document generated for completed payments. Sometimes called a Receipt.
- SKU — Stock Keeping Unit identifier for a Device Model, used for inventory and external sales systems.
Integration and notifications
- Module — One of the eight functional areas of the Xyte platform: Configure, Manage, Empower, Support, Analyze, Commercialize, Integrate, and Finance.
- Integration — A connection between Xyte and an external system (CRM, ERP, ticketing, messaging, etc.) used for data sync and workflow automation.
- Notification — An alert sent in response to a platform event. Notifications can be delivered by email or via a Webhook.
- Webhook — An HTTP callback that Xyte invokes on an external endpoint when a configured event occurs.
- Widget — A component on a Device's Monitoring Dashboard that displays Telemetry or exposes a Command. Widgets are configured per Device Model.
Updated about 1 hour ago
