ProductEntity

📊 Overview: 11 Functions

3 Getters

1 Setters

Extends: Entity

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

---

📑 Table of Contents

• ⚙️ Functions
  • Regular Functions
    • getRobotHeadList (1 param) → Text 🖥️
    • getMainTool → cs.ToolsEntity 🖥️
    • getPreviousPickRequestQuantity (2 params) → Integer 🖥️
    • getFinishedStock → Integer 🖥️
    • getQuarantinedStock → Integer 🖥️
    • getWIP → Integer 🖥️
    • getPlannedProduction (1 param) → Integer 🖥️
    • getPickRequestedQuantity → Integer 🖥️
    • getAvailableStock (2 params) → Integer 🖥️
    • getMigrationRules (1 param) → $Collection : Collection 🖥️
    • syncMigrationSelections (1 param) 🖥️
  • Computed Attributes (Getters/Setters/Query/OrderBy)
    • Emoji 🔍 → Text
    • HasMigrationID 🔍 → Boolean
    • MainToolRegrind 🔍 ✏️ → Boolean
    • OurPartName 🔎
• 🔗 Related Items

---

Functions

Regular Functions

getRobotHeadList

[🖥️ local]

Function getRobotHeadList($Machine : Integer) -> Text

Returns space-separated list of robot head numbers for this product on specified machine; returns empty string if no grippers found

Parameters:

Name	Type	Optional	Description
$Machine	Integer	-	-

Returns: Text

---

getMainTool

[🖥️ local]

Function getMainTool -> cs.ToolsEntity

Returns main tool for this product, or last tool if no main tool marked; used for tool-related operations and regrind decisions

Returns: cs.ToolsEntity

---

getPreviousPickRequestQuantity

[🖥️ local]

Function getPreviousPickRequestQuantity($PickRequestEntity : cs.PickRequestEntity; $OrderPickRequestEntity : cs.OrderPickRequestEntity) -> Integer

Returns quantity of this product already requested in pick requests before the given one; used to calculate available stock for picking

Parameters:

Name	Type	Optional	Description
$PickRequestEntity	cs.PickRequestEntity	-	-
$OrderPickRequestEntity	cs.OrderPickRequestEntity	-	-

Returns: Integer

---

getFinishedStock

[🖥️ local]

Function getFinishedStock -> Integer

Returns total finished stock quantity for this product in default packing location; includes all finished goods in inventory

Returns: Integer

---

getQuarantinedStock

[🖥️ local]

Function getQuarantinedStock -> Integer

Returns total quarantined finished stock for this product; stock under quality hold

Returns: Integer

---

getWIP

[🖥️ local]

Function getWIP -> Integer

Returns work-in-progress quantity for open works orders of this product; production currently running

Returns: Integer

---

getPlannedProduction

[🖥️ local]

Function getPlannedProduction($DespatchDate : Date) -> Integer

Returns planned production quantity up to despatch date from wheel calendar; scheduled future production

Parameters:

Name	Type	Optional	Description
$DespatchDate	Date	-	-

Returns: Integer

---

getPickRequestedQuantity

[🖥️ local]

Function getPickRequestedQuantity -> Integer

Returns total unprocessed quantity in active pick requests for this product; amount already allocated to orders

Returns: Integer

---

getAvailableStock

[🖥️ local]

Function getAvailableStock($PickRequestEntity : cs.PickRequestEntity; $OrderPickRequestEntity : cs.OrderPickRequestEntity) -> Integer

Returns total available stock for picking: finished + quarantined + WIP + planned production minus previous pick requests; used for stock allocation

Parameters:

Name	Type	Optional	Description
$PickRequestEntity	cs.PickRequestEntity	-	-
$OrderPickRequestEntity	cs.OrderPickRequestEntity	-	-

Returns: Integer

---

getMigrationRules

[🖥️ local]

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

Returns collection of EntityMigrationRule objects defining how to merge this product with remote product during sync; handles field mapping and conflict resolution

Parameters:

Name	Type	Optional	Description
$RemoteEntity	cs.ProductEntity	-	-

Returns: Collection

---

syncMigrationSelections

[🖥️ local]

Function syncMigrationSelections($RemoteEntity : cs.ProductEntity)

Synchronizes all related entity selections (materials, tools, procedures, packaging, grippers, BOMs) with remote product during merge operation

Parameters:

Name	Type	Optional	Description
$RemoteEntity	cs.ProductEntity	-	-

---

Computed Attributes (Getters/Setters/Query/OrderBy)

Emoji

[🔍 get only, 🖥️ local]

Function get Emoji -> Text

Returns emoji character from associated EmojisEntity, or empty string if no emoji assigned

Returns: Text

---

HasMigrationID

[🔍 get only, 🖥️ local]

Function get HasMigrationID -> Boolean

Returns true if this product has a migration ID assigned (> 0); indicates if product is subject to data synchronization

Returns: Boolean

---

MainToolRegrind

[🔍 get, ✏️ set, 🖥️ local]

Function get MainToolRegrind -> Boolean
Function set MainToolRegrind($MainToolRegrind : Boolean)

Returns regrind status of main tool for this product; indicates if main tool requires regrinding

Setter Parameter:

Name	Type	Description
$MainToolRegrind	Boolean	-

Returns: Boolean

---

OurPartName

[🔎 query only, 🖥️ local]

Function query OurPartName($QueryEventObject : Object)

Query event handler for OurPartName attribute; maps field name from ‘Our Part No’ to proper ORDA query operator format

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	-

---

Related Items

🗂️ Tables

• Product - ORDA Entity class for Product table

� Related Classes

• Product - ORDA DataClass class for Product table

� Forms

• %2AMigration - Data source for %2AMigration form
• %2AStockControl - Data source for %2AStockControl form
• %2Atest1 - Data source for %2Atest1 form
• %2AToolEditor - Data source for %2AToolEditor form
• BOM - Data source for BOM form
• BOM_MaterialPrices - Data source for BOM_MaterialPrices form
• BOM_Output - Data source for BOM_Output form
• BOM_Packaging - Data source for BOM_Packaging form
• CapacityPlanning - Data source for CapacityPlanning form
• ChangeMaterial - Data source for ChangeMaterial form
• ConsignmentCallOff - Data source for ConsignmentCallOff form
• ConsignmentEntry - Data source for ConsignmentEntry form
• ConsignmentSSLs - Data source for ConsignmentSSLs form
• CustomerOrderEntry - Data source for CustomerOrderEntry form
• EDIgenerator - Data source for EDIgenerator form
• Forecast - Data source for Forecast form
• ForecastImporter - Data source for ForecastImporter form
• LabelPrinting - Data source for LabelPrinting form
• Manufacture - Data source for Manufacture form
• MaterialOptions - Data source for MaterialOptions form
• NewScrapEntry - Data source for NewScrapEntry form
• NSKPalletIDs - Data source for NSKPalletIDs form
• OrderDelivery - Data source for OrderDelivery form
• OrderOverview - Data source for OrderOverview form
• PackagingOptions - Data source for PackagingOptions form
• PackingLabour - Data source for PackingLabour form
• PalletTransfer - Data source for PalletTransfer form
• Pricing - Data source for Pricing form
• ProductStockTake - Data source for ProductStockTake form
• QualitySystemResults - Data source for QualitySystemResults form
• QualitySystemTolerances - Data source for QualitySystemTolerances form
• QuarantineManager - Data source for QuarantineManager form
• RTSUM - Data source for RTSUM form
• Scheduler - Data source for Scheduler form
• SIMImporter - Data source for SIMImporter form
• SNRSUMMARY - Data source for SNRSUMMARY form
• StockAtLocation - Data source for StockAtLocation form
• ToolDisplay4 - Data source for ToolDisplay4 form
• ToolStandardsReview - Data source for ToolStandardsReview form
• WarehouseOptions - Data source for WarehouseOptions form

---

Generated from ProductEntity.4dm