Equipment
Overview
The Equipment entity represents an actual piece of equipment within a factory or manufacturing environment. While
EquipmentClass defines categories like "Forklift" or "Saw," the Equipment entity models individual instances of
those categories, such as a specific forklift used on a production line. This allows tracking of each piece of equipment
independently for operational, maintenance, and reporting purposes.
Table Structure
The following table outlines the SQL columns for the equipment table, providing a brief description of each, along
with sample data where applicable.
| Column | Type | Description | Example |
|---|---|---|---|
id | String (ULID) | Unique identifier for the entity. | 01JAP8RJBN-8ZTPXSGY-J9GSDPE1 |
enabled | Boolean | If the entity is enabled or not. | true |
created_date | DateTime | Date the entity was created. | 2024-12-31T19:48:44Z |
created_by | String | Person who created the entity. | TamakiMES |
modified_date | DateTime | Date the entity was modified. Value is null upon creation, and gets initially populated upon the first edit. | 2024-12-31T19:48:44Z |
modified_by | String | Last person to modify the entity. Value is null upon creation, and gets initially populated upon the first edit. | TamakiMES |
notes | String | Notes about the entity. | This entity has these extra notes |
spare1 | String | The first spare column that can be used for additional context on the entity. | some extra context 1 |
spare2 | String | The second spare column that can be used for additional context on the entity. | some extra context 2 |
spare3 | String | The third spare column that can be used for additional context on the entity. | some extra context 3 |
equipment_class_id | String (ULID) | References the equipment class to which this item belongs. See equipment_classes. | 01JAP8R5RT-3FPXQABY-7KQZT6VF |
location_id | String (ULID) | Indicates where the equipment is stored or currently in use. See locations. | 01JAP8RJBN-4VYZUKE1-LY2QHV8X |
name | String | The name of the specific equipment item, unique within the equipment class. | Forklift #12 |
description | String | Detailed description of the equipment item. | Electric forklift used for material handling |
status | String (Enum) | Current operational status of the equipment. Possible values: OPERATIONAL, DOWN, UNDER_MAINTENANCE, UNKNOWN, as defined by the EquipmentStatus enum. | OPERATIONAL |
Field Details
equipment_class_id
References the EquipmentClass that this item belongs to, allowing the equipment to inherit properties and attributes
defined by the class.
See equipment_classes for details.
location_id
Links to the Location entity, specifying the physical location of the equipment. This enables tracking of where the
equipment is deployed or stored within the facility.
See locations for details.
name
The name field provides a unique identifier for the equipment within the context of its class, such as "Forklift #12."
This allows easy differentiation of multiple equipment items in the same category.
description
An optional field for a more detailed description of the equipment, with a character limit of 2048. This can provide additional context about the equipment’s purpose or specifications.
status
Represents the current operational state of the equipment, based on the EquipmentStatus enum, with possible values:
- OPERATIONAL: Equipment is fully functional and in use.
- DOWN: Equipment is not operational.
- UNDER_MAINTENANCE: Equipment is currently undergoing maintenance.
- UNKNOWN: Equipment status is not known.