Skip to main content

Equipment

Overview

The Equipment entity represents individual physical assets within the manufacturing environment. Each equipment record is assigned to an equipment class and may optionally be associated with a location, enabling tracking of where each asset is stationed. Equipment records support customizable properties through the equipment property value system.

Table Structure

The following table outlines the SQL columns for the equipment table, providing a brief description of each.

ColumnTypeDescriptionExample
idString (ULID)Unique identifier for the entity.01JAP8RJBN-8ZTPXSGY-J9GSDPE1
enabledBooleanIf the entity is enabled or not.true
created_dateDateTimeDate the entity was created.2024-12-31T19:48:44Z
created_byStringPerson who created the entity.TamakiMES
modified_dateDateTimeDate the entity was modified. Value is null upon creation, and gets initially populated upon the first edit.2024-12-31T19:48:44Z
modified_byStringLast person to modify the entity. Value is null upon creation, and gets initially populated upon the first edit.TamakiMES
notesStringNotes about the entity.This entity has these extra notes
spare1StringThe first spare column that can be used for additional context on the entity.some extra context 1
spare2StringThe second spare column that can be used for additional context on the entity.some extra context 2
spare3StringThe third spare column that can be used for additional context on the entity.some extra context 3
nameStringName of the equipment. Required and unique within the equipment class.Pump-101
descriptionStringOptional description of the equipment.Primary feed pump for Line 1
equipment_class_idString (ULID)References the equipment class this equipment belongs to. See equipment_classes.01JAP8R5RT-3FPXQABY-7KQZT6VF
location_idString (ULID)References the location where this equipment is stationed. Optional. See locations.01JAP8RJBN-4VYZUKE1-LY2QHV8X
pathString (unique)Unique path for the equipment, generated from the equipment class path and equipment name.Pumps/CentrifugalPumps/Pump-101

Field Details

name

The name of the equipment must be unique within its equipment class.

equipment_class_id

References the EquipmentClass that categorizes this equipment. Required. See equipment_classes for details.

location_id

References the Location where this equipment is physically stationed. This field is optional and can be null if the equipment's location is not tracked or not yet assigned. See locations for details.

path

The path is a unique identifier for the equipment, automatically generated by appending the equipment name to the equipment class path.