PalletEntity

📊 Overview: 9 Functions

4 Getters

Extends: Entity

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

---

📑 Table of Contents

• ⚙️ Functions
  • Regular Functions
    • createPrintJob (2 params) → $Success : Boolean
    • getWorksOrderCollection → Collection
    • getTotalQuantity (1 param) → Integer
    • getTotalBoxes (1 param) → Integer
    • generateQR → Picture 🖥️
    • getStockListBoxObject → Object 🖥️
    • getMigrationRules (1 param) → $Collection : Collection 🖥️
    • syncMigrationSelections (1 param) 🖥️
    • transfer (1 param) → Boolean 🖥️
  • Computed Attributes (Getters/Setters/Query/OrderBy)
    • GrossWeightKg 🔍 → Real
    • HasMigrationID 🔍 → Boolean
    • NetWeightKg 🔍 → Real
    • QRObject 🔍 → Object
• 🔗 Related Items

---

Functions

Regular Functions

createPrintJob

Function createPrintJob($StaffID : Integer; $PrinterID : Integer) -> $Success : Boolean

Creates a print job for this pallet label and marks pallet as printed

Parameters:

Name	Type	Optional	Description
$StaffID	Integer	-	-
$PrinterID	Integer	-	-

Returns: Boolean

---

getWorksOrderCollection

Function getWorksOrderCollection -> Collection

Returns a collection of distinct works order IDs from all boxes on this pallet

Returns: Collection

---

getTotalQuantity

Function getTotalQuantity($WorksOrderEntity : Integer) -> Integer

Returns the total quantity of items on this pallet, optionally filtered by works order

Parameters:

Name	Type	Optional	Description
$WorksOrderEntity	Integer	-	-

Returns: Integer

---

getTotalBoxes

Function getTotalBoxes($WorksOrderEntity : Integer) -> Integer

Returns the total number of boxes on this pallet, optionally filtered by works order

Parameters:

Name	Type	Optional	Description
$WorksOrderEntity	Integer	-	-

Returns: Integer

---

generateQR

[🖥️ local]

Function generateQR -> Picture

Generates a QR code picture from the pallet QR object

Returns: Picture

---

getStockListBoxObject

[🖥️ local]

Function getStockListBoxObject -> Object

Returns an object representing this pallet for display in stock list boxes

Returns: Object

---

getMigrationRules

[🖥️ local]

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

Returns migration rules for syncing pallet data during migration

Parameters:

Name	Type	Optional	Description
$RemoteEntity	cs.PalletEntity	-	-

Returns: Collection

---

syncMigrationSelections

[🖥️ local]

Function syncMigrationSelections($RemoteEntity : cs.PalletEntity)

Syncs related box label and print job selections during migration (currently commented out)

Parameters:

Name	Type	Optional	Description
$RemoteEntity	cs.PalletEntity	-	-

---

transfer

[🖥️ local]

Function transfer($ToLocation : Integer) -> Boolean

Transfers this pallet to a new location by moving stock and updating location, within a transaction

Parameters:

Name	Type	Optional	Description
$ToLocation	Integer	-	-

Returns: Boolean

---

Computed Attributes (Getters/Setters/Query/OrderBy)

GrossWeightKg

[🔍 get only, 🖥️ local]

Function get GrossWeightKg -> Real

Returns the total gross weight in kg of all boxes plus 20kg for pallet weight

Returns: Real

---

HasMigrationID

[🔍 get only, 🖥️ local]

Function get HasMigrationID -> Boolean

Returns true if this pallet has a valid migration ID

Returns: Boolean

---

NetWeightKg

[🔍 get only, 🖥️ local]

Function get NetWeightKg -> Real

Returns the total net weight in kg of all boxes on this pallet

Returns: Real

---

QRObject

[🔍 get only]

Function get QRObject -> Object

Returns an object containing pallet data for QR code generation

Returns: Object

---

Related Items

🗂️ Tables

• Pallet - ORDA Entity class for Pallet table

� Related Classes

• Pallet - ORDA DataClass class for Pallet table
• PalletSelection - ORDA EntitySelection class for Pallet table

� Forms

• %2AMigration - Data source for %2AMigration form
• %2Atest - Data source for %2Atest form
• CancelAdviceNote - Data source for CancelAdviceNote form
• LocationManager - Data source for LocationManager form
• NSKPalletIDs - Data source for NSKPalletIDs form
• OrderDelivery - Data source for OrderDelivery form
• PalletDespatchList - Data source for PalletDespatchList form
• PalletTransfer - Data source for PalletTransfer form
• Warehouse - Data source for Warehouse form

---

Generated from PalletEntity.4dm