WorksOrderEntity

📊 Overview: 7 Functions

6 Getters

Extends: Entity

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

---

📑 Table of Contents

• ⚙️ Functions
  • Regular Functions
    • setQuantityMade (2 params) → Date 🖥️
    • getQuantityMade (1 param) → Integer 🖥️
    • getQuantityPacked (1 param) → Integer 🖥️
    • getQuantityScrapped → Integer 🖥️
    • calculateProcessScrap (2 params) 🖥️
    • getMigrationRules (1 param) → $Collection : Collection 🖥️
    • syncMigrationSelections (1 param) 🖥️
  • Computed Attributes (Getters/Setters/Query/OrderBy)
    • AvailableStock 🔍 → Integer
    • ExS1Stock 🔍 → Integer
    • HasMigrationID 🔍 🔎 → Boolean
    • IsOpen 🔍 🔎 → Boolean
    • IsRunning 🔍 🔎 → Boolean
    • WIP 🔍 → Integer
• 🔗 Related Items

---

Functions

Regular Functions

setQuantityMade

[🖥️ local]

Function setQuantityMade($NewQuantity : Integer; $AdjustmentDate : Date) -> Date

Sets the quantity made for this works order by creating real-time records and calculating scrap

Parameters:

Name	Type	Optional	Description
$NewQuantity	Integer	-	-
$AdjustmentDate	Date	-	-

Returns: Date

---

getQuantityMade

[🖥️ local]

Function getQuantityMade($UseRealTimeData : Boolean) -> Integer

Returns the quantity manufactured, optionally using real-time data or RTSUM data

Parameters:

Name	Type	Optional	Description
$UseRealTimeData	Boolean	-	-

Returns: Integer

---

getQuantityPacked

[🖥️ local]

Function getQuantityPacked($InStockOnly : Boolean) -> Integer

Returns the quantity packed, optionally filtered to stock items only

Parameters:

Name	Type	Optional	Description
$InStockOnly	Boolean	-	-

Returns: Integer

---

getQuantityScrapped

[🖥️ local]

Function getQuantityScrapped -> Integer

Returns the total quantity scrapped from both scrap records and real-time stoppage records

Returns: Integer

---

calculateProcessScrap

[🖥️ local]

Function calculateProcessScrap($MachineCompleted : Boolean; $PackingCompleted : Boolean)

Calculates and records process scrap based on robot status and order completion status

Parameters:

Name	Type	Optional	Description
$MachineCompleted	Boolean	-	-
$PackingCompleted	Boolean	-	-

---

getMigrationRules

[🖥️ local]

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

Returns migration rules for syncing works order data during data migration

Parameters:

Name	Type	Optional	Description
$RemoteEntity	cs.WorksOrderEntity	-	-

Returns: Collection

---

syncMigrationSelections

[🖥️ local]

Function syncMigrationSelections($RemoteEntity : cs.WorksOrderEntity)

Syncs related entity selections during data migration (currently commented out)

Parameters:

Name	Type	Optional	Description
$RemoteEntity	cs.WorksOrderEntity	-	-

---

Computed Attributes (Getters/Setters/Query/OrderBy)

AvailableStock

[🔍 get only, 🖥️ local]

Function get AvailableStock -> Integer

Returns the total available finished stock in the default packing location for this works order

Returns: Integer

---

ExS1Stock

[🔍 get only, 🖥️ local]

Function get ExS1Stock -> Integer

Returns the quantity of stock for this works order in the ExS1 storage location

Returns: Integer

---

HasMigrationID

[🔍 get, 🔎 query, 🖥️ local]

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

Returns true if this entity has a valid migration ID from data migration

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

---

IsOpen

[🔍 get, 🔎 query, 🖥️ local]

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

Returns true if machine has started and packing has not been completed

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

---

IsRunning

[🔍 get, 🔎 query, 🖥️ local]

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

Returns true if the machine has started and production has not been completed

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

---

WIP

[🔍 get only, 🖥️ local]

Function get WIP -> Integer

Returns work in progress quantity (made minus packed minus scrapped) if order is open

Returns: Integer

---

Related Items

🗂️ Tables

• WorksOrder - ORDA Entity class for WorksOrder table

� Related Classes

• WorksOrder - ORDA DataClass class for WorksOrder table

� Forms

• %2AMigration - Data source for %2AMigration form
• %2AStockControl - Data source for %2AStockControl form
• %2ATempOEE - Data source for %2ATempOEE form
• %2Atest - Data source for %2Atest form
• ChangeRealTimeImpressions - Data source for ChangeRealTimeImpressions form
• ConsignmentCallOff - Data source for ConsignmentCallOff form
• ConsignmentSSLs - Data source for ConsignmentSSLs form
• CustomerInput - Data source for CustomerInput form
• CycleHistory - Data source for CycleHistory form
• DownTime - Data source for DownTime form
• LabelHistory - Data source for LabelHistory form
• LabelPrinting - Data source for LabelPrinting form
• MachineMaintenance - Data source for MachineMaintenance form
• Manufacture - Data source for Manufacture form
• MaterialCheck - Data source for MaterialCheck form
• NewScrapEntry - Data source for NewScrapEntry form
• OrderDelivery - Data source for OrderDelivery form
• ProductStockTake - Data source for ProductStockTake form
• Quality - Data source for Quality form
• QualitySystemResults - Data source for QualitySystemResults form
• QuarantineManager - Data source for QuarantineManager form
• RTSUM - Data source for RTSUM form
• ShiftSummaries - Data source for ShiftSummaries form
• StockTakeInput - Data source for StockTakeInput form
• test - Data source for test form
• WODateRange - Data source for WODateRange form
• WorkInProgress - Data source for WorkInProgress form
• WO_Numbers - Data source for WO_Numbers form

---

Generated from WorksOrderEntity.4dm