Model object dictionary

The Model object dictionary includes the following:

• Asset Object
• ProcessLot Object
• SiteProductSource Object
• AssetUnit Object
• ProcessRouting Object
• TimeDuration Object
• BillOfMaterial Object
• Product Object
• TransportationMode Object
• BOMItem Object
• Shipment Object
• Waypoint Object
• ConsignmentList Object
• ShippingItem Object
• WorkCenter Object
• Customer Object
• ShippingItemDetail Object
• WorkProcess Object
• CustomerProduct Object
• ShippingRoute Object
• WorkResource Object
• Lane Object
• Site Object
• WorkStep Object
• Model Object
• SiteLocation Object
• Enumerations
• Order Object
• SiteProduct Object

 
• OrderDetails Object
• SiteProductDestination Object

 

Asset Object

Attribute DataType Writeable Comments
assettype Integer   Enumeration: Asset Type
assetvolume Float    
assetweight Float    
availableunitcount Float    
availableunits Collection   AssetUnit Object objects
custom1 String String  
custom2 String String  
destroyedunitcount Float    
name String    
objecttype String   “TRANSPORTATIONASSET”
quantitycapacity Float Float  
quantityfilllevel Float Float  
scheduleddownunitcount Float    
setupunitcount Float    
speed Float Float  
unitcount Float    
units Collection   AssetUnit Object objects
unscheduleddownunitcount Float    
utilizedunitcount Float    
volumecapacity Float Float  
volumefilllevel Float Float  
vulnerabiltiyfactor Float    
waitingshipmentsqueue Collection   Shipment Object objects
weightcapacity Float Float  
weightfilllevel Float Float  

AssetUnit Object

Attribute DataType Writeable Comments
asset Object   Asset Object
currentlocation Object   SiteLocation Object
currentmode Object   TransportationMode Object
currentroute Object   ShippingRoute Object
currentshipment Object   Shipment Object
currentstate Integer   Enumeration: Asset State
custom1 String    
custom2 String    
homelocation Object   SiteLocation Object
nextlocation Object   SiteLocation Object
objecttype String   “ASSETUNIT”
previouslocation Object   SiteLocation Object
previousstate Integer   Enumeration: Asset State
totalavailabletime Float    
totaldestroyedtime Float    
totalscheduleddowntime Float    
totalsetuptime Float    
totalunscheduleddowntime Float    
totalutilizedtime Float    

BillOfMaterial Object

Attribute DataType Writeable Comments
items Collection   BOMItem Object objects
name String    
objecttype String   “BILLOFMATERIAL”

BOMItem Object

Attribute DataType Writeable Comments
bomtype Integer   Enumeration: BOM Type
name String    
objecttype String   “BOMITEM”
quantity Float    

ConsignmentList Object

Attribute DataType Writeable Comments
count Integer    
items Collection   ShippingItem Object objects
objecttype String   “CONSIGNMENTLIST”
totalquantity Float    
totalvolume Float    
totalweight Float    

Customer Object

Attribute DataType Writeable Comments
custom1 String String  
custom2 String String  
isgroup Boolean    
latitude Float Float  
longitude Float Float  
name String    
objecttype String   “CUSTOMER”
products Collection   CustomerProduct Object objects

CustomerProduct Object

Attribute DataType Writeable Comments
allowbackorders Boolean    
cancelledorderquantity Float    
cancelledorders Float    
currentlyorderedquantity Float    
currentorders Float    
customer Object   Customer Object
demandquantity Float    
intransitinboundquantity Float    
isgroup Boolean    
lostdemand Float    
lostrevenues Float    
objecttype String   “CUSTOMERPRODUCT”
ontimeorderquantity Float    
ontimeorders Float    
ordercycletime Float    
probabilityofbalking Float    
product Object   Product Object
sources Collection   SiteProductSource Object objects
sourcingpolicy Integer   Enumeration: Sourcing Policy
totaldemand Float    
totalorderedquantity Float    
totalorders Float    
totalrevenues Float    

Lane Object

Attribute DataType Writeable Comments
consignmentlist Object   ConsignmentList Object
destination Object   Site Object or Customer Object
isoverflow Boolean    
ispooled Boolean    
modes Collection   TransportationMode Object objects assigned to the lane
modeselectionpolicy Integer Integer Enumeration: Mode Selection Policy
modeselectionscript String String  
name String    
objecttype String   “LANE”
pendingmodelist Collection   ShippingItem Object objects
setmode Method String Lane.setmode(mode name as String)
source Object   Site Object
totalquantitypendingmode Float    
totalvolumependingmode Float    
totalweightpendingmode Float    
zone String String  

Model Object

Attribute DataType Writeable Comments
assets Collection   All Asset Object objects
billofmaterials Collection   All BillOfMaterial Object objects
circuityfactor Float    
currentreplication Integer    
customers Collection   All Customer Object objects
endtime Datetime    
inventorycarryingcost Float Float  
lanes Collection   All Lane Object objects
measurementsystem String    
objecttype String   “MODEL”
processes Collection   All WorkProcess Object objects
products Collection   All Product Object objects
randomnumberseed Integer Integer  
replications Integer    
resetseed Boolean Boolean  
sites Collection   All Site Object objects
startime Datetime    
statsstarttime Datetime    
transportdefaultspeed Float Float  

Order Object

Attribute DataType Writeable Comments
Backorder Boolean    
cancelwhenlate Boolean Boolean  
custom1 String String  
custom2 String String  
datecreated Datetime    
detail Object   OrderDetails Object object
details Collection   Multi-line OrderDetails Object object
duedate Datetime    
finaldestination Object   Customer Object or Site Object object
finaldestinationname String String  
makeprocessname String String  
objecttype String   “ORDER”
orderfrom Object   Site Object object
orderfromname String String  
ordernumber String String  
priority Long    
productionorder Boolean    
pushedshipment Boolean    
setordersource Method   Order.setordersource(site name as string)
shippingmethod String String  
shipto Object   Customer Object or Site Object object
shiptoname String String  
totalquantity Float    
totalvalue Float    
totalvolume Float    
totalweight Float    

OrderDetails Object

Attribute DataType Writeable Comments
objecttype String   “ORDERDETAIL”
price Float    
productname String    
quantity Float    
quantityshipped Float    
unitprice Float    
unitvolume Float    
unitweight Float    
value Float    
volume Float    
weight Float    
queuereviewscript String String Script name (if custom queue policy)

ProcessLot Object

Attribute DataType Writeable Comments
Custom1 String String  
Custom2 String String  
currentlotstate Integer   Enumeration: Process Lot State
currentquantity Float    
currentstep Object   WorkStep Object object
currentworkcenter String    
duedate Datetime    
objecttype String   “PROCESSLOT”
ordernumber String String  
orderquantity Float    
originalquantity Float    
previousstep Object   WorkStep Object object
previousworkcenter String    
priority Integer Integer  
statelastchanged Datetime   Timestamp of last state change
totalworkcost Float    
totalworktime Float    
unitvolume Float Float  
unitweight Float Float  

ProcessRouting Object

Attribute DataType Writeable Comments
movetimeperlot Object   TimeDuration Object object
movertimeperunit Object   TimeDuration Object object
objecttype String   “PROCESSROUTING”
routingparameter Float Float  
workstepname String String  

Product Object

Attribute DataType Writeable Comments
cost Float Float  
custom1 String String  
custom2 String String  
custom3 String String  
custom4 String String  
metric1 Float Float  
metric2 Float Float  
metric3 Float Float  
name String    
objecttype String   “PRODUCT”
price Float Float  
qtytype Integer   Enumeration: Quantity Type
Discrete or Continuous      
value Float Float  
volume Float Float  
weight Float Float  

Shipment Object

Attribute DataType Writeable Comments
asset Object   Asset Object object
assetunitnumber Integer    
consignments Collection   ConsignmentList Object object
custom1 String String  
custom2 String String  
graphicid Integer    
items Collection   ShippingItem Object objects
objecttype String   “SHIPMENT”
route Object   ShippingRoute Object object
totalco2 Float    
totalcost Float    
totalduty Float    
totalquantity Float    
totalunitcount Float    
totalvalue Float    
totalvolume Float    
totalweight Float    

ShippingItem Object

Attribute DataType Writeable Comments
custom1 String String  
custom2 String String  
datecreated Datetime    
datedue Datetime    
detail Object   ShippingItemDetail Object object
details Collection   Shipment Object with multiple items ShippingItemDetail object
finaldestination Object   Customer Object or Site Object object
finaldestinationname String String  
objecttype String   “SHIPPINGITEM”
orderfrom Object   Site Object object
orderfromname String String  
ordernumber String String  
priority Long    
pushedshipment Boolean    
shippedfrom Object   Site Object object
shippingmethod String String  
shipto Object   Customer Object or Site Object object
shiptoname String String  
totalquantity Float    
totalvalue Float    
totalvolume Float    
totalweight Float    

ShippingItemDetail Object

Attribute DataType Writeable Comments
dutycost Float Float  
objecttype String   “SHIPPINGITEMDETAIL”
price Float Float  
quantityordered Float    
quantityshipped Float Float  
transportco2 Float Float  
transportcost Float Float  
unitprice Float Float  
unitvolume Float Float  
unitweight Float Float  
value Float    
volume Float    
weight Float    

ShippingRoute Object

Attribute DataType Writeable Comments
count Integer    
empty Boolean    
objecttype String   “SHIPPINGROUTE”
waypoints Collection   Waypoint Object objects

Site Object

Attribute DataType Writeable Comments
backorders Collection   Order Object due to downstream locations
componentorders Collection   Order Object due for BOM components
custom1 String String  
custom2 String String  
getsiteproduct Method   Site.getsiteproduct(productname as string) returns a SiteProduct Object object
inventorycarryingcostrate Float    
inventoryvalue Float    
inventoryvolume Float    
inventoryweight Float    
isgroup Boolean    
latitude Float Float  
longitude Float Float  
name String    
objecttype String   “SITE”
operatingstate Integer Integer Enumeration: Facility State
orderhandlingwhendown Integer Integer Enumeration: Handling Option
pendinginboundshipmentcount Integer    
pendinginboundshipments Collection   Shipment Object objects due inbound
pendingordercount Integer    
pendingorders Collection   Order Object queued for review
pendingoutboundshipmentcount Integer    
pendingoutboundshipments Collection   Shipment Object objects due outbound
productionorders Collection   Order Object due for production
products Method   Product Object attached to the site
shipmenthandlingwhendown Integer Integer Enumeration: Handling Option
workcenters Collection   WorkCenter Object objects at the site
workprocesses Collection   WorkProcess Object objects at the site
workresources Collection   WorkResource Object objects at the site

SiteLocation Object

Attribute DataType Writeable Comments
latitude Float Float  
longitude Float Float  
name String String  
objecttype String   “SITELOCATION”

SiteProduct Object

Attribute DataType Writeable Comments
allowbackorders Boolean Boolean  
allowpartialfill Boolean Boolean  
backorderquantity Float   Summed quantity of current due-out downstream orders
backorders Float   Count of current due-out downstream orders
BOMs Collection   BillOfMaterial Object objects associated with the product at the site
cancelledorderquantity Float    
cancelledorders Float    
currentorderquantity Float   Summed quantity of current due-in upstream orders
currentorders Float   Count of current due-in upstream orders
destinations Collection   SiteProductDestination Object for the product at the site
DOSforecastarrayname String String  
DOSforecastcount Integer    
DOSplanningleadtime Integer Integer  
DOSwindow Integer    
fillquantityrate Float    
fillrate Float    
inboundhandlingordercost Float    
inboundhandlingunitcost Float    
intransitinboundquantity Float    
intransitoutboundquantity Float    
intransitquantity Float    
inventory Float   Amount available to fill orders
inventorypolicy Integer Integer Enumeration: Inventory Policy
inventoryposition Float   On hand inventory + current order amount - backorder quantity
inventoryvalue Float    
inventoryvolume Float    
inventoryweight Float    
isgroup Boolean    
lostdemand Float    
objecttype String   “SITEPRODUCT”
ontimeorderquantity Float    
ontimeorders Float    
ontimequantityrate Float    
ontimerate Float    
ordercycletime Float    
outboundhandlingordercost Float    
outboundhandlingunitcost Float    
probabilityofbalking Float Float  
product Object   Product Object object
quantityinstock Float    
quantityonbackorder Float    
quantityonorder Float    
reorderpoint Float    
reorderquantity Float    
reorderupto Float    
reorderptDOS Float    
reorderqtyDOS Float    
reorderuptoDOS Float    
site Object   Site Object object
sources Collection   SiteProductSource Object for the product at the site
sourcingpolicy Integer Integer Enumeration: Sourcing Policy
stockouttime Float    
targetcount Float    
targetdatearrayname String String  
targetvaluearrayname String String  
totalbackorderquantity Float    
totalbackorders Float    
totaldemand Float    
totalorders Float    

SiteProductDestination Object

Attribute DataType Writeable Comments
name String    
objecttype String   “SITEPRODUCTDESTINATION”
transportationlane Object   Lane Object object
transportationlanename String String  

SiteProductSource Object

Attribute DataType Writeable Comments
currentorderquantity Float    
currentorders Float    
makeprocessname String String  
name String    
objecttype String   “SITEPRODUCTSOURCE”
product Object   SiteProduct Object object
sourcesite Object   Site Object object
sourcesiteproduct Object   SiteProduct Object object
sourcingpolicyparameter Float Float  
sourcingunitcost Float    
sourcingunitdelaytime Object   TimeDuration Object object
totalorderquantity Float    
totalorders Float    
transportationlane Object   Lane Object object
transportationlanename String String  

TimeDuration Object

Attribute DataType Writeable Comments
currentvalue Float    
errormessage String    
formula String String  
formulaerror Boolean    
objecttype String   “TIMEDURATION”
unit Integer Integer Enumeration: Clock Unit
value Float    
valueinseconds Float    

TransportationMode Object

Attribute DataType Writeable Comments
assetname String String  
discountrate Float    
distance Float Float  
dutycost Float    
dutycostbasis Integer Integer Enumeration: Cost Basis
graphicid Long    
lane Object   Lane Object object
linktolane Object   Lane Object object
linktolanename String    
minimumcharge Float    
modeparameter Float    
name String    
objecttype String   “TRANSPORTATIONMODE”
overflowlane Object   Lane Object object
overflowlanename String String  
Requirereturntrip Boolean Boolean  
returntripcost Float    
returntripcostbasis Integer Integer Enumeration: Cost Basis
returntriptime Object   TimeDuration Object object
shipmentloadcharge Float    
shipmentloadtime Object   TimeDuration Object object
shipmentunloadcharge Float    
shipmentunloadtime Object   TimeDuration Object object
transportationCO2 Float    
transportationco2basis Integer Integer Enumeration: Cost Basis
transportationcost Float    
transportationcostbasis Integer Integer Enumeration: Cost Basis
transportationpolicy Integer Integer Enumeration: Transportation Policy
transportationtime Object   TimeDuration Object object
unitloadtime Object   TimeDuration Object object
unitunloadtime Object   TimeDuration Object object

Waypoint Object

Attribute DataType Writeable Comments
distance Float    
latitude Float Float  
longitude Float Float  
objecttype String   “WAYPOINT”
time Object   TimeDuration Object object

WorkCenter Object

Attribute DataType Writeable Comments
changeovertablename String String  
currentlot Object   ProcessLot Object object
currentstate Integer   Enumeration: Workcenter State
currrentproductname String    
custom1 String String  
custom2 String String  
inboundlots Collection   ProcessLot Object object
nextstate Integer Integer Enumeration: Workcenter State
objecttype String   “WORKCENTER”
overtime Boolean Boolean  
queuecapacity Float Float  
queuecapacitybasis Integer Integer Enumeration: Queue Capacity Basis
queuedlots Collection   ProcessLot Object object
queuepolicy Integer Integer Enumeration: Lot Queue Policy

WorkProcess Object

Attribute DataType Writeable Comments
currentlots Collection   ProcessLot Object objects (in process)
custom1 String String  
custom2 String String  
firststep Object   ProcessRouting Object object
lotqueuepolicy Integer Integer Enumeration: Lot Queue Policy
lotqueuereviewscript String String Script name (if custom queue policy)
objecttype String   “WORKPROCESS”
processtype Integer   Enumeration: Process Type
queuedlots Collection   ProcessLot Object objects
steps Collection   WorkStep Object objects

WorkResource Object

Attribute DataType Writeable Comments
availableunits Integer    
custom1 String    
custom2 String    
destroyedunits Integer    
name String    
objecttype String   “WORKRESOURCE”
owner Object   Site that owns the resource
queuereviewpolicy Integer Integer Enumeration: Queue Review Resource
queuereviewscript String String Script name (if custom queue policy)
unitcount Integer    
utilizedunits Integer    

WorkStep Object

Attribute DataType Writeable Comments
costperlot Float    
costperunit Float    
custom1 String String  
custom2 String String  
lotsize Float Float  
name String    
nextstepcount Integer    
nextsteps Collection   ProcessRouting Object objects indexed from 0 to nextstepcount -1
objecttype String   “WORKSTEP”
routingpolicy Integer   Enumeration: Routing Policy
workcentername String String  
workprocess Object   WorkProcess Object object
workresources Collection    
worktimeperlot Object   TimeDuration Object object
worktimeperunit Object   TimeDuration Object object
yield Float    

Enumerations

Asset State    
Object : Property Integer Result
AssetUnit Object : state 1 Available
2 Utilized
3 Setup
4 Scheduled Down (writeable)
5 Unscheduled Down (writeable)
6 Previous State (writeable)
7 Destroyed

 

Asset Type    
Object : Property Integer Result
Asset Object : assettype 0 Vehicle
1 Container
2 Convoy

 

BOM Type    
Object : Property Integer Result
BOMItem Object : BOMType 0 Input
1 Output
2 IO

 

Clock Unit    
Object : Property Integer Result
TimeDuration Object : unit 0 Second
1 Minute
2 Hour
3 Day
4 Week
5 Month
6 Year
7 Calendar

 

Cost Basis    
Object : Property Integer Result
TransportationMode Object : costbasis 0 Quantity
1 Weight
2 Cubic
3 Distance
4 Fixed
5 Distance - Quantity
6 Distance - Weight
7 Distance - Cubic
8 Value
9 Custom Duty Cost script
10 Metric1 (from Product object)
11 Metric2 (from Product object)
12 Metric3 (from Product object)
13 Distance - Metric1
14 Distance - Metric2
15 Distance - Metric3

 

Facility State    
Object : Property Integer Result
Site Object : facilitystate 0 Facility open
1 Facility down
2 Facility closed

 

Handling Option    
Object : Property Integer Result
Site Object : handlingoption 0 Queue
1 Cancel
2 Process

 

Inventory Policy    
Object : Property Integer Result
SiteProduct Object : inventorypolicy 0 R,Q
1 s,S
2 Demand flow
3 Custom Inventory Policy script
4 DOS - Demand based
5 DOS - Forecast based
6 R,Q - Targets
7 s,S - Targets
8 BaseStock
9 T,S

 

Lot Queue Policy    
Object : Property Integer Result
WorkProcess Object : lotqueuepolicy 0 FIFO
1 First Available Resource
2 Custom (scripted)
3 Queue Only

 

Mode Selection Policy    
Object : Property Integer Result
Lane Object : modeselectionpolicy 0 On Due Date
1 On Quantity
2 On Weight
3 On Cubic
4 By Probability
5 By Turn
6 Asset Available
7 Fastest Path
8 Close to Due Date
9 Random
10 Custom (scripted)
11 Queue only
12 First mode
13 Split by ratio

 

Process Lot State    
Object : Property Integer Result
ProcessLot Object : currentlotstate 0 Pending
1 Moving
2 Queued
3 Working
4 Complete

 

Process Type    
Object : Property Integer Result
WorkProcess Object : processtype 0 Process Make

 

Quantity Type    
Object : Property Integer Result
Product Object : qtytype 0 Integer
1 NonNegativeInteger
2 Truncate
3 Real
4 Continuous
5 NonNegativeReal
6 Discrete

 

Queue Capacity Basis    
Object : Property Integer Result
WorkCenter Object : queuecapacitybasis 0 Unlimited
1 By Lots
2 By Units
3 By Weight
4 By Volume

 

Queue Review Resource    
Object : Property Integer Result
Work Resource: queuereviewpolicy 0 FIFO
1 Custom (scripted)

 

Routing Policy    
Object : Property Integer Result
WorkStep Object : routingpolicy 0 Process Complete
1 Single
2 Custom (scripted)
3 Multiple first available
4 Multiple most capacity
5 Multiple by probability

 

Sourcing Policy    
Object : Property Integer Result
CustomerProduct Object : Sourcingpolicy SiteProduct Object : Soucingpolicy 0 Single Source
1 Single Source (Closest)
2 Multiple Sources (Least Cost)
3 Multiple Sources (Order of Preference)
4 Multiple Sources (Most Inventory)
5 Multiple Sources (Probability)
6 Multiple Sources (Allocate by Preference)
7 Source by Transfer
8 Multiple Sources (Fastest Path)
9 Multiple Sources (Close to Due Date)
10 Multiple Sources (Split by Ratio)
11 Custom Sourcing Policy script
12 Make
13 Make by Schedule
14 Make (Single Process)
15 Make (Probability)
16 Make (Order of Preference)
17 Custom Make policy script

 

Transportation Policy    
Object : Property Integer Result
TransportationMode Object : transportationpolicy 0 Parcel
1 LTL
2 Full TL
3 Rail
4 Ship
5 Air
6 Scheduled
7 Pooled
8 Pooled Scheduled
9 Link to Lane
10 Aggregate Container
11 Disaggregate Container
12 Join Convoy
13 Depart Convoy

 

Workcenter State    
Object : Property Integer Result
WorkCenter Object : currentstate WorkCenter Object : nextstate 0 Available
1 Scheduled down
2 Unscheduled down
3 Maintenance
4 Utilized
5 Setup
6 Idle

Last modified: Wednesday May 15, 2024

Is this useful?