Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

System Entities

This chapter defines the core conceptual entities used in the MyMaxwell system.
Entities are ordered from the largest organizational scope to the smallest physical unit.

Reseller Company

A Reseller Company represents an external legal entity acting as a distributor of Maxwell fluid and monitoring equipment to end clients.

Reseller Companies are responsible for:

  • Client-facing communication and coordination
  • On-site and remote support
  • Deployment and configuration of monitoring equipment
  • Ordering equipment and consumables from HTMS

Key characteristics:

  • A Reseller Company consists of one or more reseller users
  • All users within a reseller company share the same permissions
  • A Reseller Company may manage multiple Client Companies and their Sites

Relationship to clients:

  • Each Client Company is associated with exactly one Reseller Company
  • A Client Company may request a reseller change
  • Reseller change is a supported business concept but is not currently exposed as a standard UI feature

Client Company

A Client Company represents a legal entity responsible for one or more buildings where Maxwell fluid is deployed.

Client Companies are end customers of the HTMS solution.

Key characteristics:

  • A Client Company consists of one or more client users
  • Client users may have access to one or more Sites belonging to the client
  • A Client Company is always associated with exactly one Reseller Company
  • A Client Company owns one or more Sites

Constraints:

  • A Site cannot exist without a Client Company
  • A Site cannot be transferred between Client Companies through normal system behavior

Site (Installation)

A Site (also referred to as an Installation) represents a single administrative unit in the system, typically corresponding to one physical building.

A Site:

  • Always belongs to exactly one Client Company
  • Represents the primary unit for monitoring, reporting, and analysis
  • Cannot be transferred between Client Companies through normal system behavior

Operational notes:

  • A Site may be created before physical deployment
  • Correction of an incorrectly assigned Site (e.g. created under the wrong client) is considered a support-level action, not a standard UI operation

A Site may contain:

  • Zero or more monitored equipment items

Monitored Equipment

Monitored Equipment represents a logical or physical part of an HVAC system that is being monitored within a Site.

Monitored Equipment:

  • Provides context for sensor data
  • Is used for visualization, analysis, and reporting
  • Does not produce data directly

Key characteristics:

  • Monitored Equipment belongs to exactly one Site
  • Monitored Equipment is created manually, typically before physical installation
  • One monitored equipment item may have multiple associated sensor units
  • Monitored Equipment may exist without any sensor units assigned

Operational notes:

  • Monitored Equipment without assigned sensor units is valid but non-functional, as no data will be produced

Sensor Unit

A Sensor Unit represents a physical sensor unit deployed at a Site.

A Sensor Unit:

  • Measures one or more physical parameters
  • Produces time-series data points stored in the system
  • Is physically deployed and undeployed as part of site operations

Key characteristics:

  • A Sensor Unit belongs to exactly one Site
  • A Sensor Unit is associated with exactly one monitored equipment item
  • A Sensor Unit produces data at a fixed interval (currently one data point per minute)

Operational constraints:

  • Sensor Units are not reassigned between Sites
  • A Sensor Unit may be deleted from one Site and recreated under another Site to reflect physical relocation
  • Such relocation is considered an edge case and a support-level action

Entity Relationships (Summary)

  • A Reseller Company manages one or more Client Companies
  • A Client Company is associated with exactly one Reseller Company
  • A Client Company owns one or more Sites
  • A Site represents a single physical building (installation)
  • A Site contains monitored equipment
  • Monitored Equipment groups one or more sensor units
  • Sensor Units produce time-series data points
graph TD
    RESELLER[Reseller Company]
    CLIENT[Client Company]
    SITE[Site / Installation]
    EQUIP[Monitored Equipment]
    SENSOR[Sensor Unit]

    RESELLER --> CLIENT
    CLIENT --> SITE
    SITE --> EQUIP
    EQUIP --> SENSOR