PickRequestEntity

📊 Overview: 10 Functions

7 Getters

Extends: Entity

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

---

📑 Table of Contents

• ⚙️ Functions
  • Regular Functions
    • modify → $Modified : Boolean 🖥️
    • cancel
    • despatch 🖥️
    • despatchOrder (1 param) 🖥️
    • despatchConsignment 🖥️
    • getNotInStockWorksOrders → $WorksOrderSelection : cs.WorksOrderSelection 🖥️
    • getWorksOrderSummaryListboxCollection → $Collection : Collection 🖥️
    • getPickedStockListboxObject → $Object : Object 🖥️
    • sendNotification
    • sendPickedNotification
  • Computed Attributes (Getters/Setters/Query/OrderBy)
    • MovementPickRequest 🔍 → Boolean
    • OrderPickRequest 🔍 → Boolean
    • PartsRequested 🔍 → Boolean
    • Picked 🔍 🔎 → Boolean
    • PickingStarted 🔍 → Boolean
    • Status 🔍 → Text
    • StatusColor 🔍 → Integer
• 🔗 Related Items

---

Functions

Regular Functions

modify

[🖥️ local]

Function modify -> $Modified : Boolean

Opens UI dialog to create or modify pick request details; allows customer/date selection; returns true if saved successfully

Returns: Boolean

---

cancel

Function cancel

Cancels pick request and releases all associated stock back to BoxLabels and Pallets; unlocks and drops all related entities

---

despatch

[🖥️ local]

Function despatch

Validates picking is complete and checks unpicked items, creates Advice Note with transport details, and saves despatch transaction; displays alerts for validation errors

---

despatchOrder

[🖥️ local]

Function despatchOrder($Advice_NoteEntity : cs.Advice_NoteEntity)

Moves picked boxes and pallets to Advice Note, updates customer orders with pallet/box assignments, marks orders as picked, and unlocks all entities after transaction commit

Parameters:

Name	Type	Optional	Description
$Advice_NoteEntity	cs.Advice_NoteEntity	-	-

---

despatchConsignment

[🖥️ local]

Function despatchConsignment

Not yet implemented; would handle movement/consignment despatch workflow

---

getNotInStockWorksOrders

[🖥️ local]

Function getNotInStockWorksOrders -> $WorksOrderSelection : cs.WorksOrderSelection

Returns works orders in pick request that don’t have enough available stock; used for validation before despatch

Returns: cs.WorksOrderSelection

---

getWorksOrderSummaryListboxCollection

[🖥️ local]

Function getWorksOrderSummaryListboxCollection -> $Collection : Collection

Returns collection of works order objects with picked quantities and color-coded stock availability for UI listbox display

Returns: Collection

---

getPickedStockListboxObject

[🖥️ local]

Function getPickedStockListboxObject -> $Object : Object

Returns object with collection of picked boxes/pallets, metadata (box count, pallet count) for UI listbox display

Returns: Object

---

sendNotification

Function sendNotification

Sends HTML email notification with pick request details, order summary, and transport instruction attachment to distribution group

---

sendPickedNotification

Function sendPickedNotification

Sends HTML email with detailed table of picked boxes including pallet IDs, box numbers, works orders, and quantities for each order

---

Computed Attributes (Getters/Setters/Query/OrderBy)

MovementPickRequest

[🔍 get only]

Function get MovementPickRequest -> Boolean

Returns true if this pick request is for inventory movement (Type 2); used to determine warehouse transfer workflow

Returns: Boolean

---

OrderPickRequest

[🔍 get only]

Function get OrderPickRequest -> Boolean

Returns true if this pick request is for customer orders (Type 0 or 1); used to determine pick request workflow

Returns: Boolean

---

PartsRequested

[🔍 get only, 🖥️ local]

Function get PartsRequested -> Boolean

Returns true if any order in pick request has quantity requested (sum > 0); indicates non-empty pick request

Returns: Boolean

---

Picked

[🔍 get, 🔎 query, 🖥️ local]

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

Returns true if all items in pick request have been picked (QuantityToPick sum = 0); indicates pick complete

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

---

PickingStarted

[🔍 get only, 🖥️ local]

Function get PickingStarted -> Boolean

Returns true if any items have been picked (QuantityPicked sum > 0); indicates picking has begun

Returns: Boolean

---

Status

[🔍 get only, 🖥️ local]

Function get Status -> Text

Returns formatted status text with emoji indicating pick request state (Modifying/Ready To Pick/Picking In Progress/Ready To Process/Despatched)

Returns: Text

---

StatusColor

[🔍 get only, 🖥️ local]

Function get StatusColor -> Integer

Returns color code for status indicator matching current pick request state

Returns: Integer

---

Related Items

🗂️ Tables

• PickRequest - ORDA Entity class for PickRequest table

� Related Classes

• PickRequest - ORDA DataClass class for PickRequest table

� Forms

• %2AOrderPicking - Data source for %2AOrderPicking form

---

Generated from PickRequestEntity.4dm