Skip to content

Latest commit

 

History

History
333 lines (240 loc) · 13.2 KB

Logistics.LogisticUnitContents.md

File metadata and controls

333 lines (240 loc) · 13.2 KB
Raw
uid
Logistics.LogisticUnitContents

Logistics.LogisticUnitContents Entity

Namespace: Logistics

Theoretical or actual content of a logistic unit. Entity: Log_Logistic_Unit_Contents (Introduced in version 21.1.0.77)

Default Visualization

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

Aggregate

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

Aggregate Parent:
Logistics.LogisticUnits
Aggregate Root:
Logistics.LogisticUnits

Attributes

Name Type Description
BaseQuantity Quantity (12, 3) The quantity, expressed in the base measurement category of the product. Unit: Product.BaseMeasurementCategory.BaseUnit Required Filter(eq;ge;le)
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
ExpirationDate date nullable Expiration date of the goods. null means unknown or N/A. Filter(multi eq;ge;le)
GrossWeight decimal (12, 3) nullable Gross weight in kilograms (kg). null means unknown. Filter(eq;ge;le)
Id guid
LineNo int32 Consecutive position within the logistic unit. Required Filter(multi eq)
LotNumber string (32) nullable The production lot number. null means unknown. Filter(multi eq;like)
Notes string (max) nullable Notes for this LogisticUnitContent.
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.
Quantity Quantity (12, 3) Quantity of the product in the logistic unit. Expressed in the specified measurement unit. Unit: QuantityUnit Required Filter(multi eq;ge;le)
StandardQuantity Quantity (12, 3) The quantity, expessed in the standard measurement unit of the product. Unit: Product.BaseMeasurementCategory.BaseUnit Required Filter(eq;ge;le)

References

Name Type Description
LogisticUnit LogisticUnits The containing logistic unit. Required Filter(multi eq) Owner
Lot Lots (nullable) The lot of the product. Null means unknown or that the product does not use lots. Filter(multi eq) Introduced in version 23.1.2.0
Product Products The product, which is contained in the logistic unit. Required Filter(multi eq)
ProductVariant ProductVariants (nullable) The product variant of the product. Null means unknown or that the product does not have variants. Filter(multi eq) Introduced in version 23.1.2.0
QuantityUnit MeasurementUnits The measurement unit of the quantity. Required Filter(multi eq)
SerialNumber SerialNumbers (nullable) The serial number of the product. Null means unknown or that product is not serialized. Filter(multi eq) Introduced in version 23.1.2.0

Attribute Details

BaseQuantity

The quantity, expressed in the base measurement category of the product. Unit: Product.BaseMeasurementCategory.BaseUnit Required Filter(eq;ge;le)

Type: Quantity (12, 3)
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Front-End Recalc Expressions:
IIF( ( ( ( obj.Quantity == null) OrElse ( obj.QuantityUnit == null)) OrElse ( obj.Product == null)), obj.BaseQuantity, obj.Quantity.ConvertTo( obj.Product.BaseUnit, obj.Product))

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

ExpirationDate

Expiration date of the goods. null means unknown or N/A. Filter(multi eq;ge;le)

Type: date nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

GrossWeight

Gross weight in kilograms (kg). null means unknown. Filter(eq;ge;le)

Type: decimal (12, 3) nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Id

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

LineNo

Consecutive position within the logistic unit. Required Filter(multi eq)

Type: int32
Category: System
Supported Filters: Equals, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
( obj.LogisticUnit.Contents.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 1)

Front-End Recalc Expressions:
( obj.LogisticUnit.Contents.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 1)

LotNumber

The production lot number. null means unknown. Filter(multi eq;like)

Type: string (32) nullable
Category: System
Supported Filters: Equals, Like, EqualsIn
Supports Order By: False
Maximum Length: 32
Show in UI: ShownByDefault

Notes

Notes for this LogisticUnitContent.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
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

Quantity

Quantity of the product in the logistic unit. Expressed in the specified measurement unit. Unit: QuantityUnit Required Filter(multi eq;ge;le)

Type: Quantity (12, 3)
Category: System
Supported Filters: Equals, GreaterThanOrLessThan, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

StandardQuantity

The quantity, expessed in the standard measurement unit of the product. Unit: Product.BaseMeasurementCategory.BaseUnit Required Filter(eq;ge;le)

Type: Quantity (12, 3)
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Front-End Recalc Expressions:
IIF( ( ( ( obj.Quantity == null) OrElse ( obj.QuantityUnit == null)) OrElse ( obj.Product == null)), obj.BaseQuantity, obj.Quantity.ConvertTo( obj.Product.BaseUnit, obj.Product))

Reference Details

LogisticUnit

The containing logistic unit. Required Filter(multi eq) Owner

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

Lot

The lot of the product. Null means unknown or that the product does not use lots. Filter(multi eq) Introduced in version 23.1.2.0

Type: Lots (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Product

The product, which is contained in the logistic unit. Required Filter(multi eq)

Type: Products
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

ProductVariant

The product variant of the product. Null means unknown or that the product does not have variants. Filter(multi eq) Introduced in version 23.1.2.0

Type: ProductVariants (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

QuantityUnit

The measurement unit of the quantity. Required Filter(multi eq)

Type: MeasurementUnits
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Front-End Recalc Expressions:
obj.Product.MeasurementUnit

SerialNumber

The serial number of the product. Null means unknown or that product is not serialized. Filter(multi eq) Introduced in version 23.1.2.0

Type: SerialNumbers (nullable)
Category: System
Supported Filters: Equals, EqualsIn
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

Creates a notification and sends a real time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    The subject.
    Type: string

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

[!list limit=1000 erp.entity=Logistics.LogisticUnitContents erp.type=business-rule default-text="None"]

Front-End Business Rules

[!list limit=1000 erp.entity=Logistics.LogisticUnitContents erp.type=front-end-business-rule default-text="None"]

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Logistics_LogisticUnitContents?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Logistics_LogisticUnitContents?$top=10