Skip to main content

Location Property

Overview

The LocationProperty entity defines configurable properties that can be assigned to various locations within the manufacturing environment. These properties specify attributes or characteristics that are shared by locations of similar types, supporting customization and configuration at the property level. Each property includes a name, data type, default values, and optional metadata.

Table Structure

The following table outlines the SQL columns for the location_properties 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
data_typeString (Enum)Specifies the data type of the property, such as INTEGER or STRING.FLOAT
default_blob_valueBlobDefault binary value for the property if data_type is binary-compatible.N/A
default_date_valueDatetimeDefault date value for the property, if applicable.2024-05-01 00:00:00
default_float_valueDoubleDefault floating-point value, if applicable.10.5
default_int_valueBigIntDefault integer value for the property, if applicable.100
default_string_valueStringDefault string value for the property, if applicable.Default Value
descriptionStringOptional description of the property.Temperature setting
formatStringOptional format string for property display.#.##
high_limitDoubleHigh limit for the property's value, if applicable.100.0
low_limitDoubleLow limit for the property's value, if applicable.0.0
nameString (Unique)Unique name of the property across all properties.MaxTemperature
nullableBooleanIndicates whether the property value can be null.false
optionsStringAdditional options or constraints for the property, if any.Option1, Option2
unit_of_measure_idString (ULID)References the unit of measure for the property. See unit_of_measure.01JAP8RJBN-4VYZUKE1-LY2QHV8X

Field Details

data_type

Specifies the data type of the property, such as INTEGER, STRING, FLOAT, or DATETIME, which defines the kind of data this property holds.

default_*_value

The default value fields (default_blob_value, default_date_value, default_float_value, default_int_value, default_string_value) specify initial values for the property based on its data_type.

format

An optional field that allows formatting the display of property values, useful for data precision or specific formatting needs.

high_limit and low_limit

Defines the acceptable range for the property’s values. These constraints help enforce limits on numeric properties.

nullable

Indicates whether the property can have null values, allowing flexibility in optional or required property configurations.

unit_of_measure_id

References the unit of measure applicable to this property, such as kilograms or liters, supporting context for values as well as conversions. See unit_of_measure for details.