Skip to main content

Glossary

Key terms used across the Shoplogix IMS platform, listed alphabetically.

Alarm State​

The current condition classification for a machine in Machine Health Monitoring. A machine's alarm state is Good (below all thresholds), Alarm (one or more thresholds exceeded), or Acknowledged (alarm confirmed by a user). Alarm state transitions trigger webhook notifications and appear in the Machine Health Dashboard.

API Credentials​

A client ID and secret pair used to authenticate programmatic access to the IMS REST API. Credentials are issued per customer account and scoped to a specific set of privileges. See REST API for details.

Downsampling​

A query-time mechanism that reduces the number of readings returned from a time-series API call. A downsampleRate of N returns 1 out of every N readings by index. Useful for rendering charts over long time ranges without exceeding response size limits. See Time-Series Data.

Equipment-On Event​

A platform-generated event that records when a piece of equipment transitions from off to on, based on sensor data. For steam traps, the Equipment-On Event is derived from the steam state changing from off to on. This event is used to determine whether an unexpected cold condition is a genuine fault or an expected cold reading during a shutdown.

Eversensor​

A batteryless wireless sensor manufactured by Shoplogix. Eversensors harvest energy from their environment (heat differential for STM sensors, RF for MHM sensors) and transmit readings approximately every 60 seconds without requiring a battery or wired power connection. See Hardware.

Evergateway​

A local network gateway device that receives radio transmissions from nearby Eversensors and forwards them to the Shoplogix cloud platform over an internet connection. Each gateway covers a physical area and associates with the sensors it hears.

Facility​

A named physical site within a customer account. Equipment (steam traps and machines) is organized first by Facility, then by Location within that facility. Facility is used as a filter in both the Insights UI and API queries.

Full Time Waveform (FTWF)​

A high-resolution vibration capture that records the raw time-domain signal from a machine sensor. FTWF data is decomposed into the frequency domain (FFT) for spectral analysis, enabling diagnosis of specific fault types such as bearing wear, imbalance, and misalignment. See Spectral Analysis and Waterfall Charts.

Ground Truth​

A manually recorded observation of a steam trap's actual physical condition, entered by a field technician after an inspection. Ground truth records are used to validate and calibrate the platform's automated state detection. See the steam trap monitoring documentation for how ground truth integrates with trap state history.

integrationInfo​

An optional field on a steam trap record that links it to an asset in an external system. Contains assetId (the external system's identifier) and name (a human-readable label). When present, this field is included in webhook payloads and used by integrations such as Armstrong SAGE to route condition updates to the correct external asset.

Location​

A subdivision within a Facility used to group equipment. For example, a facility might have multiple production lines or buildings, each represented as a Location. Equipment is assigned to a Facility and Location during installation.

Operation Type​

A configuration setting on a steam trap that describes its expected duty cycle. The three operation types are:

  • Continuous — the trap should always be active when steam is on
  • Seasonal — the trap is only active during a defined date range each year
  • Intermittent — the trap operates on an irregular schedule not tied to a date range

Operation type determines whether an unexpected cold condition is suppressed when steam is present.

Service Tag​

A customer-assigned label used to identify a steam trap in the field, typically matching a physical tag on the hardware. Service tags appear in webhook payloads and Insights UI to help field teams locate the correct equipment.

Signing Secret​

A shared secret issued when a webhook subscription is created. Used by the receiving endpoint to verify HMAC-SHA256 signatures on incoming webhook requests. Store your signing secret securely and do not expose it in client-side code. See Webhooks and Webhook Integration Guide.

Steam State​

The current on/off status of steam supply to a trap or area, as determined by the platform from sensor data. A steam state of on means steam is actively flowing; off means steam supply has been interrupted. The steam state is used by the unexpected cold condition detection logic to determine whether a cold reading is anomalous.

Threshold Crossing​

An event recorded when a machine sensor reading exceeds a configured vibration threshold. Threshold crossings are the underlying data points that drive alarm state transitions. A single threshold crossing does not immediately trigger an alarm — sustained crossings over a minimum duration are required. See Alarm States.

Trap State​

The current condition classification for a steam trap, as determined by the platform from continuous sensor data. Possible values are Good, Blowthrough, Intermittent Blowthrough (Light / Medium / Heavy), Leaking By, and Unexpected Cold Condition. Trap state changes trigger webhook events and appear in the steam trap monitoring views.

UATTR (Up-and-to-the-Right Detection)​

An internal detection algorithm that identifies a characteristic temperature signature associated with a specific type of steam trap fault. The name describes the shape of the temperature trace over time when the fault pattern is present.

Unexpected Cold Condition​

A trap state indicating that the condensate side of the trap went cold unexpectedly while steam was present and the trap was expected to be operating. This typically indicates the trap has failed closed, been isolated, or is experiencing a blockage. An unexpected cold condition is only raised when the operation type and seasonal configuration confirm the trap should be active. See Webhooks for the payload shape.

Webhook​

An HTTP callback that Shoplogix sends to your endpoint when a platform event occurs — for example, a trap state change or machine alarm. Webhooks deliver a JSON payload with event details and are signed with HMAC-SHA256 so you can verify authenticity. See Webhooks for registration and payload reference.