BoxLabelsEntity

📊 Overview: 8 Functions

19 Getters

Extends: Entity

🕐 Last updated: 2026-01-13T16:04:11.072Z

---

📑 Table of Contents

• ⚙️ Functions
  • Regular Functions
    • getStatesCollection → Collection
    • ModifyStatus 🖥️
    • AddComment (2 params) 🖥️
    • removeFromPallet → $Success : Boolean
    • getNextBoxPacked → cs.BoxLabelsEntity 🖥️
    • generateQR → Picture 🖥️
    • getMigrationRules (1 param) → $Collection : Collection 🖥️
    • syncMigrationSelections (1 param) 🖥️
  • Computed Attributes (Getters/Setters/Query/OrderBy)
    • AdviceNote 🔍 → Integer
    • BoxNumberColor 🔍 → Integer
    • BoxNumberDisplay 🔍 → Text
    • BoxQuantityDisplay 🔍 → Text
    • CurrentStatus 🔍 → Object
    • Despatched 🔍 🔎 → Boolean
    • GrossWeightKg 🔍 → Real
    • HasMigrationID 🔍 → Boolean
    • linkedBoxesQuantity 🔍 → Integer
    • NetWeightKg 🔍 → Real
    • PackedByDisplay 🔍 → Text
    • PartBox 🔍 🔎 → Boolean
    • partBoxSkipped 🔍 → Boolean
    • PartsFromOtherWorksOrders->$Text 🔍 → Text
    • RouteCardColor 🔍 → Integer
    • StatusText 🔍 → Text
    • TestProduct 🔍 → cs.ProductEntity
    • toolIsRunning 🔍 → Boolean
    • totalBoxQuantity 🔍 → Integer
• 🔗 Related Items

---

Functions

Regular Functions

getStatesCollection

Function getStatesCollection -> Collection

Returns collection of possible box label states: In Stock, Not Made, Removed From Stock

Returns: Collection

---

ModifyStatus

[🖥️ local]

Function ModifyStatus

Allows user to modify box status (In Stock/Not Made/Removed) with validation and permission checks

---

AddComment

[🖥️ local]

Function AddComment($Comment : Text; $StaffEntity : cs.StaffEntity)

Adds a timestamped comment to the box label’s comment history with staff member attribution

Parameters:

Name	Type	Optional	Description
$Comment	Text	-	-
$StaffEntity	cs.StaffEntity	-	-

---

removeFromPallet

Function removeFromPallet -> $Success : Boolean

Removes this box from pallet assignment; locks box, clears PalletEntity link, and saves

Returns: Boolean

---

getNextBoxPacked

[🖥️ local]

Function getNextBoxPacked -> cs.BoxLabelsEntity

Returns next box with same tool that was packed after this one; used for box sequence tracking

Returns: cs.BoxLabelsEntity

---

generateQR

[🖥️ local]

Function generateQR -> Picture

Generates QR code picture from box label data (ID, product, quantity, works order); used for barcode labels

Returns: Picture

---

getMigrationRules

[🖥️ local]

Function getMigrationRules($RemoteEntity : cs.BoxLabelsEntity) -> $Collection : Collection

Returns collection of EntityMigrationRule objects defining how to merge this box label with remote during sync

Parameters:

Name	Type	Optional	Description
$RemoteEntity	cs.BoxLabelsEntity	-	-

Returns: Collection

---

syncMigrationSelections

[🖥️ local]

Function syncMigrationSelections($RemoteEntity : cs.BoxLabelsEntity)

Synchronizes entity selection references after migration merge; updates foreign key references to maintain data integrity

Parameters:

Name	Type	Optional	Description
$RemoteEntity	cs.BoxLabelsEntity	-	-

---

Computed Attributes (Getters/Setters/Query/OrderBy)

AdviceNote

[🔍 get only]

Function get AdviceNote -> Integer

Returns advice note number from Certificate of Conformance or Pallet assignment; used for despatch tracking

Returns: Integer

---

BoxNumberColor

[🔍 get only]

Function get BoxNumberColor -> Integer

Returns color code for box number display based on status (NotMade, RemoveFromStock, LinkedBoxes, or PartBox)

Returns: Integer

---

BoxNumberDisplay

[🔍 get only]

Function get BoxNumberDisplay -> Text

Returns formatted box number text; shows box number or part box code, with linked box code if applicable

Returns: Text

---

BoxQuantityDisplay

[🔍 get only]

Function get BoxQuantityDisplay -> Text

Returns formatted box quantity text; shows total quantity or “parts + extras” if linked box included

Returns: Text

---

CurrentStatus

[🔍 get only]

Function get CurrentStatus -> Object

Returns current status with text, background color, and foreground color based on box state

Returns: Object

---

Despatched

[🔍 get, 🔎 query]

Function get Despatched -> Boolean
Function query Despatched($QueryEventObject : Object)

Returns true if box has been despatched (has CoC or is on despatched pallet)

Query Function: Enables querying this property in ORDA query strings (e.g., .query(":1"; $Value) where :1 is the property name).

Query Parameter:

Name	Type	Description
$QueryEventObject	Object	-

Returns: Boolean

---

GrossWeightKg

[🔍 get only, 🖥️ local]

Function get GrossWeightKg -> Real

Calculates gross weight (net weight + 1kg for packaging: 800g box + 200g bags)

Returns: Real

---

HasMigrationID

[🔍 get only, 🖥️ local]

Function get HasMigrationID -> Boolean

Returns true if box has valid migration ID (non-null and non-zero); indicates entity was involved in sync operation

Returns: Boolean

---

linkedBoxesQuantity

[🔍 get only, 🖥️ local]

Function get linkedBoxesQuantity -> Integer

Returns total quantity from all linked/chained boxes; follows linked box chain to leaf

Returns: Integer

---

NetWeightKg

[🔍 get only, 🖥️ local]

Function get NetWeightKg -> Real

Calculates the net weight in kilograms based on part weight and total quantity

Returns: Real

---

PackedByDisplay

[🔍 get only]

Function get PackedByDisplay -> Text

Returns formatted text with packing staff name and datetime for box label display

Returns: Text

---

PartBox

[🔍 get, 🔎 query]

Function get PartBox -> Boolean
Function query PartBox($QueryEventObject : Object)

Returns true if this is a part box (PartBoxCode is not empty); used to identify extra/remainder boxes

Query Function: Enables querying this property in ORDA query strings (e.g., .query(":1"; $Value) where :1 is the property name).

Query Parameter:

Name	Type	Description
$QueryEventObject	Object	-

Returns: Boolean

---

partBoxSkipped

[🔍 get only, 🖥️ local]

Function get partBoxSkipped -> Boolean

Returns true if next packed box exists; indicates more boxes of this tool were packed

Returns: Boolean

---

PartsFromOtherWorksOrders->$Text {#partsfromotherworksorders->$text}

[🔍 get only]

Function get PartsFromOtherWorksOrders->$Text -> Text

Returns formatted text listing quantities of parts from other works orders in linked box chain (e.g., ‘12345: 50’)

Returns: Text

---

RouteCardColor

[🔍 get only]

Function get RouteCardColor -> Integer

Returns rotating color code for route card number (7 colors) for visual grouping in listbox

Returns: Integer

---

StatusText

[🔍 get only]

Function get StatusText -> Text

Returns formatted status text with staff name and timestamp when status was last updated; empty if no update recorded

Returns: Text

---

TestProduct

[🔍 get only]

Function get TestProduct -> cs.ProductEntity

Returns the product entity associated with this box label; exposed for testing purposes

Returns: cs.ProductEntity

---

toolIsRunning

[🔍 get only, 🖥️ local]

Function get toolIsRunning -> Boolean

Returns true if works order for this tool’s product is still in packing phase

Returns: Boolean

---

totalBoxQuantity

[🔍 get only, 🖥️ local]

Function get totalBoxQuantity -> Integer

Returns total quantity including this box and all linked boxes; used for pallet/shipment totals

Returns: Integer

---

Related Items

🗂️ Tables

• BoxLabels - ORDA Entity class for BoxLabels table

� Related Classes

• BoxLabels - ORDA DataClass class for BoxLabels table

� Forms

• %2Atest - Data source for %2Atest form
• %2Atest1 - Data source for %2Atest1 form
• CancelAdviceNote - Data source for CancelAdviceNote form
• LabelPrinting - Data source for LabelPrinting form
• NSKPalletIDs - Data source for NSKPalletIDs form
• PalletDespatchList - Data source for PalletDespatchList form
• Warehouse - Data source for Warehouse form

---

Generated from BoxLabelsEntity.4dm