General.Products.MeasurementUnits Entity

Namespace: General.Products

Contains all measurement units, grouped in categories. Each category has one base unit (with ratio 1/1) and unlimited number of derived units with fixed ratio to the base unit. Entity: Gen_Measurement_Units

Renames

Old name: General.MeasurementUnits
New name: General.Products.MeasurementUnits
Version: 24.1.5.35
Case: 35911

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
Code; Name
Code Data Member:
Code
Name Data Member:
Name
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Parent:
General.Products.MeasurementCategories
Aggregate Root:
General.Products.MeasurementCategories

Attributes

Name	Type	Description
Code	string (16) nullable	When not null, contains unique measurement unit code. `Filter(eq;like)` `ORD`
Description	MultilanguageString (max) nullable	Full multi-language description of the measurement unit.
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Divisor	decimal (9, 3)	Divisor of the relative value of the measurement unit against other units (divisor when converting to base). `Required` `Default(1)`
Id	guid
IsDefaultUnit	boolean	True if this measurement unit is the default measurement unit within the category. There can be only one default measurement unit within a category. `Required` `Default(false)` `Filter(eq)`
Multiplier	decimal (9, 3)	Multiplier of the relative value of the measurement unit against other units (multiplier when converting to base). `Required` `Default(1)`
Name	MultilanguageString (64)	Name of the measurement unit. `Required` `Filter(eq;like)`
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
SystemUnit	SystemUnit nullable	Not null only when this is one of the system measurement units. N=NetKG; G=GrossKG; V=VolumeL; H=HeightM; W=WidthM, L=LengthM, P=Piece, T=TimeH. `Filter(eq;like)`

References

Name	Type	Description
MeasurementCategory	MeasurementCategories	Base measurement category Id. `Required` `Filter(multi eq)` `Owner`

Attribute Details

Code

When not null, contains unique measurement unit code. Filter(eq;like) ORD

Type: string (16) nullable
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 16
Show in UI: ShownByDefault

Description

Full multi-language description of the measurement unit.

Type: MultilanguageString (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Divisor

Divisor of the relative value of the measurement unit against other units (divisor when converting to base). Required Default(1)

Type: decimal (9, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 1
Show in UI: ShownByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

IsDefaultUnit

True if this measurement unit is the default measurement unit within the category. There can be only one default measurement unit within a category. Required Default(false) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

Multiplier

Multiplier of the relative value of the measurement unit against other units (multiplier when converting to base). Required Default(1)

Type: decimal (9, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 1
Show in UI: ShownByDefault

Name

Name of the measurement unit. Required Filter(eq;like)

Type: MultilanguageString (64)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

SystemUnit

Not null only when this is one of the system measurement units. N=NetKG; G=GrossKG; V=VolumeL; H=HeightM; W=WidthM, L=LengthM, P=Piece, T=TimeH. Filter(eq;like)

Type: SystemUnit nullable
Category: System
Allowed values for the SystemUnit(General.Products.MeasurementUnits.md#systemunit) data attribute
Allowed Values (General.Products.MeasurementUnitsRepository.SystemUnit Enum Members)

Value	Description
GrossKilograms	GrossKilograms value. Stored as 'G'. Database Value: 'G' Model Value: 0 Domain API Value: 'GrossKilograms'
HeightMeters	HeightMeters value. Stored as 'H'. Database Value: 'H' Model Value: 1 Domain API Value: 'HeightMeters'
LengthMeters	LengthMeters value. Stored as 'L'. Database Value: 'L' Model Value: 2 Domain API Value: 'LengthMeters'
NetKilograms	NetKilograms value. Stored as 'N'. Database Value: 'N' Model Value: 3 Domain API Value: 'NetKilograms'
Pieces	Pieces value. Stored as 'P'. Database Value: 'P' Model Value: 4 Domain API Value: 'Pieces'
VolumeLiters	VolumeLiters value. Stored as 'V'. Database Value: 'V' Model Value: 5 Domain API Value: 'VolumeLiters'
WidthMeters	WidthMeters value. Stored as 'W'. Database Value: 'W' Model Value: 6 Domain API Value: 'WidthMeters'
TimeHours	TimeHours value. Stored as 'T'. Database Value: 'T' Model Value: 7 Domain API Value: 'TimeHours'

Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

MeasurementCategory

Base measurement category Id. Required Filter(multi eq) Owner

Type: MeasurementCategories
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST