Reource Objects
Inventory Objects
Job Objects
Reporting Objects
Resource Objects
Plants
ColumnName | ColumnType | Description |
PublishDate | DateTime | Date when this record was published |
PlantId | Int64 | A unique identifier for Plant |
Name | String | Plant name. |
Description | String | Text for describing the object |
Notes | String | Comments or special considerations pertaining to this object. |
BottleneckThreshold | Double | If more than this percentage of Activities on a Resource’s schedule are Capacity Bottlenecked then the Resource is flagged as a bottleneck. |
HeavyLoadThreshold | Double | If a Resource has more than this percentage of its capacity allocated in the short-term then it is considered ‘Heavy Loaded’ and is flagged as such. |
ExternalId | String | Identifier for external system references. |
AttributesSummary | String | Summary of this object’s user defined Attributes. |
DepartmentCount | Int32 | Number of Departments (This is a calculated field and will not be an imported value) |
Sort | Int32 | Used for sorting in the Gantt and reports. |
StableDays | Double | This time span begins at the end of the FrozenSpan. It signifies the period of the schedule, in addition to the FrozenSpan, that should be changed as little as possible in order to provide stability to the users of the schedule. It serves as a visual guideline and global Optimizations can be set to start outside of this period. Also, data within the stable span can be protected from changes by data refresh. |
DailyOperatingExpense | Decimal | Monetary costs of operating the plant for a day; note that Resource hourly costs are also added into the OE value in the KPIs so they should either be included here or in the Resource Cost but not both. |
InvestedCapital | Decimal | Monetary value encapsulating all monies invested in the plant. (Total Assets — Non-Interest-Bearing Current Liabilities — Excess Cash) |
AnnualPercentageRate | Decimal | APR used for calculating carrying cost. |
Departments
PublishDate | DateTime | Date when this record was published |
PlantId | Int64 | ID of the Plant to which the Resource belongs |
DepartmentId | Int64 | A unique identifier for Department |
Name | String | |
Description | String | Text for describing the object. |
Notes | String | Comments or special considerations pertaining to this object. |
ExternalId | String | Identifier for external system references. |
AttributesSummary | String | Summary of this object’s user defined Attributes. |
PlantName | String | Name of the Plant to which the Resource belongs |
ResourceCount | Int32 | Number of Resources belonging to the Department |
Sort | Int32 | Used for sorting in the Gantt and reports. |
UseDepartmentFrozenSpan | Boolean | When active Department Frozen Span will override Plant Frozen Span |
DepartmentFrozenSpanDays | Double | Department specific frozen span. |
Capabilities
PublishDate | DateTime | Date when this record was published |
CapabilityId | Int64 | |
Name | String | Description |
Description | String | Text for describing the object. |
Notes | String | Comments or special considerations pertaining to this object. |
ExternalId | String | Identifier for external system references. |
Resources
PublishDate | DateTime | Date when this record was published |
PlantId | Int64 | |
DepartmentId | Int64 | |
ResourceId | Int64 | |
Name | String | Description |
Description | String | Text for describing the object. |
Notes | String | Comments or special considerations pertaining to this object. |
Bottleneck | Boolean | If more than the Plant’s Bottleneck Threshold of Activities on the Resource’s schedule are Capacity Bottlenecked then the Resource is flagged as a Bottleneck. |
BufferHours | Double | Used by the Drum-Buffer-Rope Release rule to prevent starving of this resource thus keeping its utilization high. |
CapacityType | String | If Finite then only one Activity can be performed on the Resource at any point in time. If Infinite then any number of can be performed simultaneously. |
Drum | Boolean | Whether to treat this Resource as a Drum when using the Drum-Buffer-Rope Release rule. |
OvertimeHourlyCost | Decimal | Can be used for calculating schedule quality and in scripts. |
StandardHourlyCost | Decimal | Can be used for calculating schedule quality and in scripts. |
ExperimentalDispatcher | Int64 | The Dispatcher that is experimentally used for Activity selection during Optimizations. |
NormalDispatcher | Int64 | The Dispatcher that is normally used for Activity selection during Optimizations. |
Workcenter | String | The name of the workcenter in the ERP system (or Department Name if not set). For display only. |
CanOffload | Boolean | Whether Activities can be reassigned from this Resource during Optimizations. |
CanPreemptMaterials | Boolean | Whether the Resource can drive the schedule by requesting that Material Requirements be delivered sooner than they are currently scheduled to start by ignoring them as constraints. This does NOT allow preemption of ConfirmedConstraints. See also: BaseOperation.IsConfirmedConstraint and MaterialRequirment.IsConfirmedConstraint. Only allowed outside the Scenario.KeepFeasibleSpan. |
CanPreemptPredecessors | Boolean | Whether the Resource can drive the schedule by requesting that predecessor Operations start sooner than they are currently scheduled to start by ignoring them as constraints. This does NOT allow preemption of ConfirmedConstraints. See also: BaseOperation.IsConfirmedConstraint and MaterialRequirment.IsConfirmedConstraint. This does NOT allow scheduling before the c_EarliestPossibleFinish of an Operation. Only allowed outside the Scenario.KeepFeasibleSpan. |
CanWorkOvertime | Boolean | Will cause suggestions for overtime to be generated for late activities where adding the overtime would cause the activity to complete earlier. |
CompatibilityGroup | String | Resources that are part of the same Compatibility Group can only run Operations concurrently if they have the same Compatibility Code. For example, if two machines are fed by the same material input pipe then at any point in time they can only run products that use that same material. |
CycleEfficiencyMultiplier | Double | Multiplies run time to adjust for slower/faster Resources. |
DurationDependsOnCapacity | Boolean | If true, then the length of the activities is based upon the amount of capacity available rather than only the setup/cycle/teardown times. |
HeadStartHours | Double | During Optimizations, Activities are not permitted to start before JitStartDate-(SameSetupHeadstartMultiplier*setupSpan+HeadStartSpan). This can be used to prevent excessive inventory buildup and aid in grouping same-SetupCode Activities. |
Overlap | String | Specifies when operations are considered ready to start processing on THIS Resource. |
PostActivityRestHours | Double | Specifies the amount of idle time to schedule between Activities to provide time for rest or miscellaneous tasks. |
Stage | Int32 | Used for multi-stage scheduling to allow scheduling of groups of resources stage by stage. Staging comes with the following restrictions: 1. Jobs can only have one Manufacturing Order. (the job release event only occurs once in the simulation) 2. Each operation can only have one predecessor operation and one successor operation. 3. An operation can only have one resource requirement. (to help prevent the problem of requiring resources that have different stages) 4. Resources with the same capabilities must have the same stage number. (otherwise the operation would be eligible in multiple stages, only one of the stages would be selected, and the resources from the other stages would sort of become ineligible) If any of these restrictions are violated then the simulation might fail. |
TransferHours | Double | Successor Operations cannot start before this time passes after finishing the Operation. Resource is not consumed during this time. |
ConsecutiveSetupTimes | Boolean | Whether Resource and Operation setups are done consecutively or in parallel. If true, then the Total Setup is the sum of the Resource and Operation setups. If false, then the Total Setup is the maximum of the two. This setting has no effect if Use Operation Setup is false. |
MaxSameSetupHours | Double | When using same-SetupCode Simulation rules, a setupCode change is forced after this many hours of cycle-time passes. Can be used to force periodic rotation between groups of products. |
SameSetupHeadStartMultiplier | Double | Used in the calculation of how far an operation can be scheduled before c_JITstartDate. Larger values result in Activities with longer setups being allowed to start earlier to save a setup. During Optimizations, Activities are not permitted to start more c_JITstartDate-(SameSetupHeadstartMultiplier*currentSetupSpan+headStartSpan). Can be used to prevent excessive inventory buildup and aid in grouping same-setupCode Activities. |
SetupEfficiencyMultiplier | Double | Multiplies setup time to adjust for slower/faster setups. Larger numbers mean the resource is slower at performing setups. Specify 3, for example, to mean that it takes three times longer to perform a setup than the standards indicate. |
SetupIncluded | String | Indicates the Resource’s performance in terms of speed of doing Setups. The value is the percent of standard that the Resource has taken to complete the Setups on average. Therefore lower numbers indicate better performance. Note that performance is only tracked for an Activity’s Primary Resource when the Activity is finished, when the Resource always includes setup time, and when the Operation’s standard setup time is more than zero. |
SetupHours | Double | Time that must be spent to setup this resource whenever the preceding operation did not use this resource. |
UseOperationSetupTime | Boolean | Whether to use the the Setup Span of the Operation in calculating the scheduled setup. If false then only the Resource setup is used. |
Active | Boolean | If not Active, then no new Activities can be scheduled to use this Resource. This does not affect Activities already scheduled to use the Resource. |
ProcessingStatus | String | Specifies the Resource’s status as of the last update. |
SameCell | Boolean | If set then same cell scheduling for predecessor operations is discontinued. But if this resource is part of a cell then the behavior is as usual and this resource’s cell will become the new cell to try to schedule in. |
CurrentProductSetup | String | The Product for which the Resource is currently or was most recently setup. This is used to calculate setup time for the first scheduled Activity on the Resource. |
CurrentSetupCode | String | The Operation SetupCode for which the Resource is currently or was most recently setup. This is used to calculate setup time for the first scheduled Activity on the Resource. |
CurrentSetupNumber | Double | The Operation SetupNumber for which the Resource is currently or was most recently setup. This can be used by Optimizations to sequence Operations with Setup Numbers that are near each other or in an increasing/decreasing sequence. |
Role | String | Indicates the types of Resource Requirements for which the Resource is eligible. Main Resource Requirements set the duration of the Operation. |
ResourceType | String | The type of physical entity represented by the Resource. Used for custom reports and other display groupings. |
ExternalId | String | Identifier for external system references. |
Sort | Int32 | Can be used for sorting Resources in Gantt Charts, reports, etc. |
AlwaysShowPostProcessing | Boolean | Always false (No meaning). |
AttributeCodeTableName | String | The Attribute Code Table that this Resource uses to calculate Setup Cost and Time based on sequential Operation Attribute Code changes. This value is blank if no Attribute Code Table has been assigned. |
AttributesSummary | String | Summary of this object’s user defined Attributes. |
BottleneckPercent | Double | The percent of the Resource’s scheduled Activities that are Capacity Bottlenecked. |
BufferHrs | Double | Used by the Drum-Buffer-Rope Release rule to prevent starving of this resource thus keeping its utilization high. |
CellName | String | Usually represents a physical grouping of Resources in an autonomous production line. Once an operation is scheduled in a cell successors will be scheduled within the same cell if possible. If a Resource is assigned a Cell then when an Operation is scheduled in the Cell all successor Operations attempt to schedule on Resources in the same Cell. |
DisallowDragAndDrops | Boolean | If true then drag and drop of Activities on the Resource are not allowed. |
ExcludeFromCapacityPlan | Boolean | Whether the Resource should be excluded from the Capacity Plan display. This has no effect on scheduling. |
ExcludeFromGantts | Boolean | Whether the Resource should be excluded from Resource Gantts. This is often set to true for inactive resources, etc. |
ExcludeFromReports | Boolean | Whether the Resource should be excluded from Schedule Reports. This is often set to true for inactive resources, etc. |
ExperimentalOptimizeRule | String | Name of the Experimental Optimize rule assigned to Resource. |
GanttRowHeightFactor | Int32 | Controls how tall the row is relative to other rows. Valid ranges is from 1 (shortest) to 10 (tallest). |
HeadStartDays | Double | During Optimizations, Activities are not permitted to start before JitStartDate-(SameSetupHeadstartMultiplier*setupSpan+HeadStartSpan). This can be used to prevent excessive inventory buildup and aid in grouping same-SetupCode Activities. |
HelperSetupHrs | Double | (Obsolete) |
ImageFileName | String | File name (with suffix but not path) of which image to use in the Gantt, etc to represent this Resource. |
MaxQty | Double | For the Resource to be considered eligible for an Activity the Activity RequiredFinishQty must be less than or equal to this amount. |
MaxQtyPerCycle | Double | For the Resource to be considered eligible for an Operation the Operation’s QtyPerCyle must be less than or equal to this amount. This is often used for batch processes where a Resource can hold a certain volume and that volume cannot be exceeded. |
MaxSameSetupHrs | Double | When using same-SetupCode Simulation rules, a setupCode change is forced after this many hours of cycle-time passes. Can be used to force periodic rotation between groups of products. |
MinQty | Double | For the Resource to be considered eligible for an Activity the Activity RequiredFinishQty must be at least this amount. |
MinQtyPerCycle | Double | For the Resource to be considered eligible for an Operation the Operation’s QtyPerCyle must be at least this amount. This is often used for batch processes where a Resource can hold a certain volume and there is a desire to use smaller Resources for smaller orders to avoid wasting capacity. |
NbrCapabilities | Int32 | The number of Capabilities this Resource has. |
NormalOptimizeRule | String | Name of the Normal Optimize Rule assigned to the Resource. |
OverlappingOnlineIntervals | Int32 | The number of Normal Online intervals that are overlapping. This is a warning since it’s not usually intentional to setup the data this way and the overlapping intervals will be summed during their overlaps. |
Sequential | Boolean | This property only applies to infinite resources. Makes sure that every activity scheduled finishes on or after the last scheduled block time. In the case where the activity being scheduled would have been scheduled to complete before the last block that was scheduled the scheduled finish time is adjusted so that the block is scheduled to finish at the same time as the last scheduled block. This property was added to help model conveyors. Model the minimum length of time an activity must stay on the conveyor (transfer time) using a Infinite sequential resource. And model the unloading of the conveyor as a finite resource. You may also need to place the 2 resources used to model the conveyor and predecessor resource in the same cell. Setup the unloading resource and operation so that the length of the unload matches the length of the load. |
SetupCodeTableName | String | The Setup Code Table that this Resource uses to calculate Setup Cost and Time based on sequential Operation Setup Code changes. This value is blank if no Setup Code Table has been assigned. |
SetupHrs | Double | Time that must be spent to setup this resource whenever the preceding operation did not use this resource. |
ShopViewUsersCount | Int32 | Number of ShopView Users assigned to this Resource. |
TransferHrs | Double | Successor Operations cannot start before this time passes after finishing the Operation. Resource is not consumed during this time. |
WorkcenterExternalId | String | The Id of the WorkCenter in the ERP system. |
MaxCumulativeQty | Double | Often used to model “tank capacity” or “subcontractor capacity”, this is the maximum quantity of simultaneous Activities allowed on the Resource. Violations create Block Flags. A Block is Flagged if the total Start Quantity of Activities beginning but not yet ending on the Resource exceeds this quantity. Set this value to zero to turn it off. This is not a constraint — it is a Flag only. |
ManualAssignmentOnly | Boolean | If true, Optimize won’t schedule any activities on this Resource. Scheduling Activities on the Resource manually, for example, by drag-and-drop is allowed. |
IsTank | Boolean | Whether this is a tank type of resource. |
MinNbrOfPeople | Double | This can be used by Customizations and has no standard function. |
BatchType | String | Options are: None, Percent and Volume. Percent: Batch by percent of a single cycle; Activities on such resources must fit within a single cycle. The fraction an activity consumes of a single cycle equals the activity’s quantity divided by the quantity per cycle (qty/qtyPerCycle). Volume: The volume is defined by the resource and corresponds directly to the quantity being processed by the activity scheduled for the batch. For instance if the volume of a resource is 10 Activities for quantities of 4, 2, 3, and 1 would all fit into the batch. |
BatchVolume | Double | If this is a batch by volume resource, this indicates the quantity of parts the resource can process in a single cycle. |
AutoJoinHrs | Double | When AutoJoining, only Join for Operations that start before this amount of time after the Clock. |
OmitSetupOnFirstActivity | Boolean | If true then the Setup Time on the first Activity scheduled on the Resource is always zero. |
OmitSetupOnFirstActivityInShift | Boolean | If true then the Setup Time on the first Activity scheduled on a Capacity Interval is always zero. |
ResourceCapabilities
PublishDate | DateTime | Date when this record was published |
CapabilityId | Int64 | |
PlantId | Int64 | |
DepartmentId | Int64 | |
ResourceId | Int64 |
CapacityIntervals
PublishDate | DateTime | Date when this record was published |
CapacityIntervalId | Int64 | Id of this CapacityInterval |
Name | String | Description |
ExternalId | String | ExternalIdId of this CapacityInterval |
Description | String | Text for describing the object. |
Notes | String | Comments or special considerations pertaining to this object. (Inherited from BaseObject.) |
DurationHrs | Double | The amount of calendar time between the start and end. |
EndDateTime | DateTime | Specifies when the event ends. |
IntervalType | String | Determines how the event will affect capacity. Options: NormalOnline, Overtime, PotentialOvertime, Offline, Occupied, ReservedOnline, Cleanout |
NbrOfPeople | Double | Multiplied by the duration of the event to calculate the total amount of capacity added by the event. For example, if the event duration is 8 hours and the NbrOfPeople is 2 then the even specifies an addition of 16 hours of capacity. Not used if Type=Offline. |
StartDateTime | DateTime | Specifies when the event starts. |
RecurringCapacityIntervals
PublishDate | DateTime | Date when this record was published |
CapacityIntervalId | Int64 | |
Name | String | |
ExternalId | String | |
Description | String | |
Notes | String | |
DayType | String | Specifies which occurrence of the day to use for MonthlyByDayType or YearlyByDayType Recurrence. Such as ‘Last Thursday of every month’. |
DurationHrs | Double | The amount of calendar time between the start and end. |
EndDateTime | DateTime | Specifies when the event ends. |
IntervalType | String | Determines how the event will affect capacity. Options: NormalOnline, Overtime, PotentialOvertime, Offline, Occupied, ReservedOnline, Cleanout |
NbrOfPeople | Double | Multiplied by the duration of the event to calculate the total amount of capacity added by the event. For example, if the event duration is 8 hours and the NbrOfPeople is 2 then the even specifies an addition of 16 hours of capacity. Not used if Type=Offline. |
StartDateTime | DateTime | Specifies when the event starts. |
Sunday | Boolean | Specifies whether to include Sundays in Weekly recurring events. |
Monday | Boolean | Specifies whether to include Mondays in Weekly recurring events. |
Tuesday | Boolean | Specifies whether to include Tuesdays in Weekly recurring events. |
Wednesday | Boolean | Specifies whether to include Wednesdays in Weekly recurring events. |
Thursday | Boolean | Specifies whether to include Thursdays in Weekly recurring events. |
Friday | Boolean | Specifies whether to include Fridays in Weekly recurring events. |
Saturday | Boolean | Specifies whether to include Saturdays in Weekly recurring events. |
MaxNbrRecurrences | Int32 | No events are scheduled to start after this number of events recur. Only used if RecurrenceEndType specifies MaxNbrRecurrences. |
MonthlyDayNumber | Int32 | The day of each month that the event occurs. Applies to Monthly and Yearly Recurrences only. |
MonthlyOccurrence | String | Specifies the month of a monthly occurrence. |
NbrIntervalsToOverride | Int32 | The number of Intervals in the Recurring Capacity Interval to override with the Nbr Of People Override. |
NbrOfPeopleOverride | Double | Can be used to override the Nbr Of People for a specified number of intervals at the beginning of the Recurring Capacity Interval. |
Occurrence | String | Specifies which occurrence of the day to use for MonthlyByDayType or YearlyByDayType Recurrence. Such as ‘Last Thursday of every month’. |
Recurrence | String | Specifies if and how the event repeats. |
RecurrenceEndDateTime | DateTime | No events are scheduled to start after this DateTime. Only used if RecurrenceEndType specifies RecurrenceEndDateTime. |
RecurrenceEndType | String | Specifies the indicator of when the recurrence stops. Options: NoEndDate, AfterMaxNbrRecurrences, AfterRecurrenceEndDateTime. |
RecurrenceStart | DateTime | Defines the beginning of the recurrence period. |
SkipFrequency | Int32 | Specifies how many intervals to skip between events. For example, if Recurrence is Daily and SkipFrequency is 2 then an event is scheduled then two days are skipped and then another event is scheduled. |
YearlyMonth | String | Specifies the month in which the yearly event occurs. |
RecurringCapacityIntervalRecurrences
PublishDate | DateTime | Date when this record was published |
RecurringCapacityIntervalId | Int64 | Id of this Recurring Capacity Interval |
EndDateTime | DateTime | End date time of this Recurring Capacity Interval |
StartDateTime | DateTime | Start date time of this Recurring Capacity Interval |
PublishDate | DateTime | Date when this record was published |
RecurringCapacityIntervalId | Int64 | |
ResourceId | Int64 |
CapacityIntervalResourceAssignments
PublishDate | DateTime | Date when this record was published |
CapacityIntervalId | Int64 | |
ResourceId | Int64 |
ProductRules
PublishDate | DateTime | Date when this record was published |
Item | Int64 | Id of the Item associated with this ProductRule |
PlantId | Int64 | Id of the Plant the Resource associated with this ProductRule belongs to. |
DepartmentId | Int64 | Id of the Department the Resource associated with this ProductRule belongs to. |
ResourceId | Int64 | Id of the Resource associated with this ProductRule. |
OperationName | String | If specified, then these rules only apply to Operations with this Operation Name. Otherwise, these rules apply to all Operations for any Manufacturing Order making this Product. |
SetupHrs | Double | Overrides Operation SetupSpan if UseSetupSpan is true. |
UseSetupHrs | Boolean | If true then overrides the Operation SetupSpan when the Operation is scheduled. Otherwise the Operation SetupSpan is used as is. |
CycleHrs | Double | Overrides Operation CycleSpan if UseCycleSpan is true. |
UseCycleHrs | Boolean | If true then overrides the Operation CycleSpan when the Operation is scheduled. Otherwise the Operation CycleSpan is used as is. |
QtyPerCycle | Double | Overrides Operation QtyPerCycle if UseQtyPerCycle is true. |
UseQtyPerCycle | Boolean | If true then overrides the Operation QtyPerCycle when the Operation is scheduled. Otherwise the Operation QtyPerCycle is used as is. |
PostProcessingHrs | Double | Overrides Operation PostProcessingSpan if UsePostProcessingSpan is true. |
UsePostProcessingHrs | Boolean | If true then overrides the Operation PostProcessingSpan when the Operation is scheduled. Otherwise the Operation PostProcessingSpan is used as is. |
PlanningScrapPercent | Double | Overrides Operation PlanningScrapPercent if UseScrapPercent is true. |
UsePlanningScrapPercent | Boolean | If true then overrides the Operation PlanningScrapPercent when the Operation is scheduled. Otherwise the Operation ScrapPercent is used as is. |
HeadStartHrs | Double | The Resource is only eligible to be assigned an Activity when the amount of slack time (JIT DateTime minus current time) is less than or equal to this amount. Smaller values mean the Resource won’t be used unless time is running out. |
UseHeadStartHrs | Boolean | Whether to use HeadStartHrs. |
Inventory Objects
Items
PublishDate | DateTime | Date when this record was published |
ItemId | Int64 | The Id of this Item record. |
Name | String | Name of the Item |
Description | String | Text for describing the object. |
ExternalId | String | Identifier for external system references. |
Notes | String | Comments or special considerations pertaining to this object. |
Source | String | Where the Item originates from. This is for information only and has no effect on scheduling. |
ItemType | String | RawMaterial, SubAssembly, Intermediate, FinishedGood, Resource, ByProduct, CoProduct. |
DefaultLeadTimeDays | Double | Used by Material Requirements when there is no Inventory record for the Item at any available Warehouse. |
AttributesSummary | String | Summary of this object’s user defined Attributes. |
BatchSize | Double | Jobs and Purchases must be in integer multiples of this value. |
BatchWindowDays | Double | When batching demand to create Jobs or Purchases Orders the batch should not reach out further than this value in order to reach the Max Nbr Batches. |
ItemGroup | String | Can be used for visually grouping Items into categories. |
MaxNbrBatches | Int32 | Each Job and Purchase for this item must be at no more than this number of Batches (see Batch Size). |
MinNbrBatches | Int32 | Each Job and Purchase for this item must be at least this number of Batches (see Batch Size). |
MinOrderQty | Double | Jobs and Purchase Orders must be for at least this quantity when created by MRP. If a planned Job, after rounding up by MinOrderQtyRoundupLimit, is less than this amount then it will be marked as Do Not Schedule and remain unscheduled. If a planned Purchase Order, after rounding up by MinOrderQtyRoundupLimit, is less than this amount then it will have “Less than Min Order Qty” set to true. |
MinOrderQtyRoundupLimit | Double | If a Job or Purchase Order created by MRP is less than this quantity then MRP is allowed to round-up the quantity by as much as this amount in order to reach the MinOrderQty. Take care when setting this to large values as it can create extra inventory. |
JobAutoSplitQty | Double | Jobs generated by MRP that exceed this quantity have Manufacturing Orders split off into quantities of this size until no Manufacturing Order in the Job exceeds this quantity. |
Plan | Boolean | Whether the Item should be included in the Inventory Plan. |
ShelfLifeDays | Double | The maximum amount of time that the Item can remain in inventory before being used. |
TransferQty | Double | As this product is produced it is transferred to Inventory in quantities of this size. |
RollupAttributesToParent | Boolean | If true then when MRP creates Jobs it will recursively copy Operation Attributes from supplying Job Templates to the Operation consuming the Material. This is often used to carry-up Attributes from “allergens” in materials. |
Cost | Decimal | Per unit purchase cost. This value is used to calculate the value of inventory |
PlantWarehouses
PublishDate | DateTime | Date when this record was published |
PlantId | Int64 | Id of the Plant linked to a Warehouse. |
WarehouseId | Int64 | Id of the Warehouse that is the Plant can produce to or consume material from. |
Warehouses
PublishDate | DateTime | Date when this record was published |
WarehouseId | Int64 | Id of this Warehouse. |
Name | String | Name of this Warehouse. |
Description | String | Text for describing the object. |
ExternalId | String | Identifier for external system references. |
NbrOfDocks | Int32 | Each Warehouse can have a specified number of Docks. These Docks can be used to schedule receipt of Purchases To Stock as well as Shipments. |
Notes | String | Comments or special considerations pertaining to this object. |
AttributesSummary | String | Summary of this object’s user defined Attributes. |
StorageCapacity | Double | Can be used by a Scheduling Add-In to limit scheduling based upon availability of storage space. |
AnnualPercentageRate | Decimal | APR for calculating carrying cost. |
TankWarehouse | Boolean | PublishDate |
Inventories
PublishDate | DateTime | Date when this record was published |
ItemId | Int64 | The Id of the Item whose stock is being stored. |
WarehouseId | Int64 | The Id of the Warehouse the Item is being stored at. |
InventoryId | Int64 | The Id of this Inventory record. |
LeadTimeDays | Double | The amount of time it takes between when the Item is ordered and delivered for this Warehouse. |
BufferStock | Double | The target level of this Item to have on hand at this Warehouse to support Make-to-Available inventory management. This value is used to calculate Buffer Stock penetration levels. |
SafetyStock | Double | The target level of this Item to have on hand at this Warehouse to provide the desired service level to customers. |
SafetyStockWarningLevel | Double | If a job’s classification is “Safety Stock”, then ignore the lateness if the current inventory is greater than the warning level.” If the Job’s Classification is “Safety Stock”, and the Job has Products associated with it then this value will be set to true only if the Job is later than the Safety Stock Warning Level of the Product’s Inventory.” |
OnHandQty | Double | The amount of physical inventory in stock for this Item in this Warehouse. |
PlannerExternalId | String | The External Id of the Planner responsible for monitoring and managing this Items stock level at this Warehouse. |
StorageCapacity | Double | Can be used by a Scheduling Add-In to limit scheduling based upon availability of storage space. |
SafetyStockJobPriority | Int32 | Sets the Priority for Jobs that are generated to satisfy Safety Stock. |
ForecastConsumption | String | Options for how Forecast quantities are reduced based on actual demand. |
MrpProcessing | String | Specifies how the MRP process will manage this inventory. |
MrpNotes | String | Notes stored during the last MRP run. Not stored between sessions. |
TemplateJobId | Int64 | TemplateManufacturingOrder’s Job Id. |
TemplateManufacturingOrderId | Int64 | Specifies the Manufacturing Order to be used in the creation of new Jobs. |
HaveTemplateManufacturingOrderId | Boolean | Whether TemplateManufacturingOrder has been specified. |
BufferPenetrationPercent | Double | Indicates how far short of the target Buffer Stock the current On-hand Qty is. Larger values indicate that there is greater risk of shortage. Calculated as: (BufferStock-OnHand)/BufferStock * 100. 0 if Inventory.BufferStock=0. |
AutoGenerateForecasts | Boolean | Whether to automatically regenerates forecasts when SalesOrders are modified. |
ForecastInterval | String | The periodicity (cycle of values) (e.g. monthly values with a seasonal cycle = 12) |
NumberOfIntervalsToForecast | Int32 | The number of prediction steps to forecast |
SalesOrders
PublishDate | DateTime | Date when this record was published |
SalesOrderId | Int64 | |
ExternalId | String | |
Name | String | |
Description | String | Text for describing the object. |
Notes | String | Comments or special considerations pertaining to this object. |
Cancelled | Boolean | Once a Sales Order is cancelled, its demands are ignored. If the Sales Order has a CTP Job then the Job’s Cancelled status is set to the new value as well. |
CtpJobId | Int64 | If the Sales Order was created from a CTP and a Job was created to satisfy the CTP then this is the Job. If the Sales Order is deleted then the Job is also deleted. |
Customer | String | |
Estimate | Boolean | If true then this is a quote, not a firm order. |
ExpirationDate | DateTime | If CancelAtExpirationDate is true then the Sales Order is marked as Cancelled when the PlanetTogether Clock passes this date. |
SalesAmount | Decimal | |
SalesOffice | String | Specifies the sales office or other physical location that created the demand. This has no effect on the Warehouse that satisfies the order. It is for reference only. |
SalesPerson | String | The employee in sales who is responsible for this demand. |
Planner | String | The User responsible for planning this demand if planning by demand rather than by product or location. |
Project | String | Can be used for tracking multiple demands tied to one project. |
SalesOrderLines
PublishDate | DateTime | Date when this record was published |
SalesOrderId | Int64 | |
SalesOrderLineId | Int64 | |
Description | String | |
ItemId | Int64 | |
LineNumber | String | The identifier for a line item within the sales order. |
UnitPrice | Decimal | The sale price per unit. This can be used to maximize sales revenue. |
SalesOrderLineDistributions
PublishDate | DateTime | Date when this record was published. |
SalesOrderLineId | Int64 | |
SalesOrderLineDistributionId | Int64 | |
AllowPartialAllocations | Boolean | If true then if there is not enough stock to satisfy a shipment, a portion of the requirement can’t be met from stock and a portion from either Backlog or MissedSale. If false, then the entire qty must be allocated. |
BacklogQty | Double | The qty that is not currently planned to be satisfied and will therefore result in an inventory Backlog (carry-forward of the requirement to future periods). Depends upon the Stock Shortage Rule. |
Hold | Boolean | If true then the shipment is ignored in planning. |
HoldReason | String | |
MaximumLatenessDays | Double | If using StockShortageRule of PushLater and the demand has been pushed this amount past the Required Available Date then it is marked as a Missed Sale. |
MinAllocationQty | Double | If AllowPartialAllocations is true then this is the minimum amount that must be allocated to the shipment. |
MissedSalesQty | Double | The qty that is not currently planed to be satisfied and will therefore result in lost sales. Depends upon the Stock Shortage Rule. |
MustSupplyFromWarehouseId | Int64 | Can be used to force the Line to be supplied from the specified Warehouse. If not specified then the material can come from any Warehouse. |
Priority | Int32 | Indicates the importance of the shipment. Used during the allocation process to determine which requirements to allocate to first. Shipments with lower numbers are considered more important and receive allocation before shipments with higher numbers. Allocation is based upon the Allocation Rule specified during the time a Simulation is performed. |
QtyAllocatedFromOnHandInventory | Double | The quantity that is currently planned to be satisfied from OnHand inventory. |
QtyAllocatedFromProjectedInventory | Double | The quantity that is currently planned to be satisfied from future projected inventory. (not including OnHand inventory) |
QtyNotAllocated | Double | The remaining portion of the QtyOpenToShip that is not currently covered by OnHand or Projected Inventory allocations. |
QtyOpenToShip | Double | This is the remaining qty that must be planned for. If a partial shipment is made then this is the QtyOrdered minus partial shipments. |
QtyOrdered | Double | The total qty for this Line Item Distribution on the order. This remains the same even if there is a partial shipment made. |
RequiredAvailableDate | DateTime | The date when the material must be available in stock in order to reach the customer by the Promised Delivery Date. |
SalesRegion | String | The geographic region for the shipment. For information only. |
ShipToZone | String | Specifies the geographic are where the shipment is going. For information only. |
StockShortageRule | String | Specifies what should be done in stock planning when the shipments full QtyOpenToShip cannot be satisfied. This can also be overridden during Optimizes with a global rule. |
SupplyingWarehouseId | Int64 | The Warehouse from which the material will be supplied. |
SalesOrderDistributionInventoryAdjustments
PublishDate | DateTime | Date when this record was published |
InventoryId | Int64 | Id of the Inventory affected by this adjustment. |
SalesOrderDistributionId | Int64 | Id of the SalesOrderDistribution that caused this adjustment |
AdjustmentDate | DateTime | Date of the adjustment |
AdjustmentQty | Double | Quantity of the adjustment |
AdjustmentReason | String | Localized text, describing this adjustment, with information about the SalesOrderDistribution. |
Forecasts
PublishDate | DateTime | Date when this record was published |
InventoryId | Int64 | |
Version | String | |
ForecastId | Int64 | |
Name | String | |
Description | String | Text for describing the object. |
ExternalId | String | Identifier for external system references. |
Notes | String | Comments or special considerations pertaining to this object. |
Customer | String | The company the Forecast is for. |
Planner | String | The scheduler who will manage the Forecast. |
Priority | Int32 | Sets the Priority for Jobs created by MRP to satisfy this demand. |
SalesOffice | String | Specifies the sales office or other physical location that created the demand. This has no effect on the Warehouse that satisfies the Forecast. It is for reference only. |
SalesPerson | String | The employee in sales who is responsible for this demand. |
ForecastShipments
PublishDate | DateTime | Date when this record was published |
ForecastId | Int64 | |
ForecastShipmentId | Int64 | |
RequiredDate | DateTime | The date/time when the material must be in stock to satisfy the demand. |
RequiredQty | Double | The qty demanded. |
ForecastShipmentInventoryAdjustments
PublishDate | DateTime | Date when this record was published |
InventoryId | Int64 | Id of the Inventory affected by this adjustment. |
ForecastShipmentId | Int64 | Id of the ForecastShipment that caused this adjustment |
AdjustmentDate | DateTime | Date of the adjustment |
AdjustmentQty | Double | Quantity of the adjustment |
AdjustmentReason | String | Localized text, describing this adjustment, with information about the ForecastShipment. |
PurchasesToStock
PublishDate | DateTime | Date when this record was published |
PurchaseToStockId | Int64 | The Id of this purchase order. |
InventoryId | Int64 | The Id of the Inventory location where the Items will go when received. |
Name | String | Description |
Description | String | Text for describing the object. |
ItemId | Int64 | The Id of the Item purchased. |
QtyOrdered | Double | The qty of material expected to arrive. |
ExternalId | String | Identifier for external system references. |
ScheduledReceiptDate | DateTime | The date when the material is expected to arrive. |
UnloadHrs | Double | If scheduling Docks, this is used to specify the amount of time it will take to unload the items. |
TransferHrs | Double | Material is not considered usable in production until this time has passed after the Scheduled Receipt Date. |
AvailableDate | DateTime | The time when material is available to production. This is the ScheduledReceiptDate+UnloadSpan+TransferSpan. That is, Material arrives, is unloaded, and is transferred to production. |
VendorExternalId | String | The company the parts are ordered from. |
BuyerExternalId | String | The individual responsible for this purchase. |
ShowInDockScheduleBoard | Boolean | Indicates whether the Purchase has been rescheduled in the Dock Scheduling Board. Once this is true, then external changes to Scheduled Receipt Date and Dock are ignored. |
WarehouseId | Int64 | The Warehouse where the Items will go when received. |
UnloadEndDate | DateTime | The datetime when the Purchase is expected to be finished unloading. This is calculated as the Scheduled Receipt Date plus the Unload Duration. |
ScheduledDockNbr | Int32 | The number of the Dock that the Purchase To Stock is scheduled to be unloaded on. This can be set externally or manually in the Dock Schedule Board. This value is 1-based. The first Dock in a Warehouse is Dock 1. |
Notes | String | Comments or special considerations pertaining to this object. |
RescheduledInDockSchedulingBoard | Boolean | Indicates whether the Purchase has been rescheduled in the Dock Scheduling Board. Once this is true, then external changes to Scheduled Receipt Date and Dock are ignored. |
AttributesSummary | String | Summary of this object’s user defined Attributes. |
RescheduledInSchedulingBoard | Boolean | Indicates whether the Purchase has been rescheduled in the Dock Scheduling Board. Once this is true, then external changes to Scheduled Receipt Date and Dock are ignored. |
ScheduledToDock | Boolean | Whether the Purchase To Stock has been scheduled to a specific Dock. |
Firm | Boolean | If the Purchase is Firm then the MRP logic will not modify or delete it. Users can still change Firm Purchases and imports can affect them. |
Closed | Boolean | If true then the Purchase has no effect on the plan. |
DbrReceivingBufferHrs | Double | The Receiving Buffer of the Inventory. |
DbrReceiptDate | DateTime | Material should be received by this date to avoid penetrating the material receiving buffer. The ScheduledReceiptDate minus the Receiving Buffer. |
DbrCurrentPenetrationPercent | Double | The percent of time between the DbrReceiptDate and the ScheduledReceiptDate that has been passed based on the Scenario Clock. |
PurchaseToStockDeletedDemands
PublishDate | DateTime | Date when this record was published |
PurchaseToStockId | Int64 | Id of the PurchaseToStock that was created to satisfy this Forecast demand. |
RequiredDate | DateTime | Date of demand. |
RequiredQty | Double | Quantity of the demand satisfied with by this PurchaseToStock. |
Notes | String | Textual information about this supply/demand relation. |
Description | String | Textual information about this deleted supply/demand relation. |
DateDeleted | DateTime | Date the demand was deleted |
DeletedDemandId | Int64 | Id of the demand deleted. |
PurchaseToStockForecastDemands
PublishDate | DateTime | Date when this record was published |
PurchaseToStockId | Int64 | Id of the PurchaseToStock that was created to satisfy this Forecast demand. |
ForecastShipmentId | Int64 | Id of the ForecastShipment that caused this PurchaseToStock to be created. |
RequiredDate | DateTime | Date of the ForecastShipment demand. |
RequiredQty | Double | Quantity of the demand satisfied with by this PurchaseToStock. |
Notes | String | Textual information about this supply/demand relation. |
PurchaseToStockInventoryAdjustments
PublishDate | DateTime | Date when this record was published |
InventoryId | Int64 | Id of the Inventory affected by this adjustment. |
PurchaseToStockId | Int64 | Id of the PurchaseToStock that caused this adjustment |
AdjustmentDate | DateTime | Date of the adjustment |
AdjustmentQty | Double | Quantity of the adjustment |
AdjustmentReason | String | Localized text, describing this adjustment, with information about the PurchaseToStock. |
PurchaseToStockSafetyStockDemands
PublishDate | DateTime | Date when this record was published |
PurchaseToStockId | Int64 | Id of the PurchaseToStock that was created to satisfy this Forecast demand. |
PurchaseToStockSafetyStockDemands | Int64 | Id of the Inventory with SafetyStock level that caused this PurchaseToStock to be created. |
RequiredDate | DateTime | Quantity of the demand satisfied with by this PurchaseToStock. |
RequiredQty | Double | Quantity of the demand satisfied with by this PurchaseToStock. |
Notes | String | Textual information about this supply/demand relation. |
PurchaseToStockSalesOrderDemands
PublishDate | DateTime | Date when this record was published |
PurchaseToStockId | Int64 | Id of the PurchaseToStock that was created to satisfy this Forecast demand. |
SalesOrderDistributionId | Int64 | Id of the SalesOrderDistribution that caused this PurchaseToStock to be created. |
RequiredDate | DateTime | Date of the SalesOrder demand. |
RequiredQty | Double | Quantity of the demand satisfied with by this PurchaseToStock. |
Notes | String | Textual information about this supply/demand relation. |
PurchaseToStockTransferOrderDemands
PublishDate | DateTime | Date when this record was published |
PurchaseToStockId | Int64 | Id of the PurchaseToStock that was created to satisfy this Forecast demand. |
TransferOrderDistributionId | Int64 | Id of the TransferOrderDistribution that caused this PurchaseToStock to be created. |
RequiredDate | DateTime | Quantity of the demand satisfied with by this PurchaseToStock. |
RequiredQty | Double | Quantity of the demand satisfied with by this PurchaseToStock. |
Notes | String | Textual information about this supply/demand relation. |
TransferOrders
PublishDate | DateTime | Date when this record was published |
TransferOrderId | Int64 | Id of this TransferOrder. |
Name | String | Name of this TransferOrder |
Description | String | Description of this TransferOrder |
Notes | String | Notes associated with this TransferOrder |
ExternalId | String | ExternalId of this TransferOrder. |
AttributesSummary | String | Summary of this object’s user defined Attributes. |
Firm | Boolean | Whether this TransferOrder is Firm. |
Priority | Int32 | Sets the Priority for Jobs created by MRP to satisfy this demand. |
Closed | Boolean | If Closed then the Transfer Order has no further affect on the Inventory Plan. |
TransferOrderDistributions
PublishDate | DateTime | Date when this record was published |
TransferOrderId | Int64 | Id of the TransferOrder this TransferOrderDistribution belongs to. |
TransferOrderDistributionId | Int64 | Id of this TransferOrderDistribution |
ItemId | Int64 | Item being transferred from one warehouse to another. |
FromWarehouseId | Int64 | The Warehouse from which the Inventory will subtracted. |
ToWarehouseId | Int64 | The Warehouse to which the Inventory will added. |
QtyOrdered | Double | The total quantity expected to be shipped. |
QtyShipped | Double | The quantity already removed from the inventory of the From Warehouse. |
QtyReceived | Double | The quantity already received into the To Warehouse. |
ScheduledShipDate | DateTime | The date/time when the inventory is planned to be removed from the From Warehouse. |
ScheduledReceiveDate | DateTime | The date/time when the inventory is planned to be added to the To Warehouse. |
Closed | Boolean | If Closed then the Transfer Order Distribution has no further affect on the Inventory Plan. |
TransferOrderDistributionInventoryAdjustments
PublishDate | DateTime | Date when this record was published |
InventoryId | Int64 | Id of the Inventory affected by this adjustment. |
TransferOrderDistributionId | Int64 | Id of the TransferOrderDistribution that caused this adjustment |
AdjustmentDate | DateTime | Date of the adjustment |
AdjustmentQty | Double | Quantity of the adjustment |
AdjustmentReason | String | Localized text, describing this adjustment, with information about the TransferOrderDistribution. |
JobProductTransferOrderDemands
PublishDate | DateTime | Date when this record was published |
JobProductId | Int64 | Id of the Product that was created to satisfy this Forecast demand. |
JobOperationId | Int64 | Id of the Operation the Product is associated with. |
TransferOrderDistributionId | Int64 | Id of the TransferOrderDistribution that caused this product to be created. |
RequiredDate | DateTime | Date of the TransferOrderDistribution demand. |
RequiredQty | Double | Quantity of the demand satisfied with by this Product. |
Notes | String | Textual information about this supply/demand relation. |
Job Objects
Jobs
PublishDate | DateTime | Date when this record was published |
JobId | Int64 | |
CustomerExternalId | String | Indicates the Customer that the Job is for. |
EntryDate | DateTime | Don’t use this field for simulation purposes because it uses Datetime.Now. When the Job was entered into the system. |
NeedDateTime | DateTime | When to finish by to be considered on-time. |
Classification | String | Can be used to distinguish the purpose of the work request.A value of “Safety Stock” affects the Job Late Property based on the Inventory Safety Stock Warning Level. MRP sets this value based on the reason for the creation of the Job: from Sales Order, Forecast, Transfer Order, Safety Stock or Buffer Stock Replenishment. If a Job was created with batched requirements then the earliest requirement determines this setting. Buffer Stock Replenishment Jobs are treated differently for measuring Buffer Penetration. They use the Buffer Penetration of the primary Product’s Inventory instead of the Drum or Shipping Buffer penetration. |
Commitment | String | Indicates the likelihood that the work will be executed. This value can be updated internally and will be protected from external changes that attempt to set the value “backwards” (such as from Firm to Planned). This allows the planner to advance the Commitment level internally and not have the change undone by an external system that has not been updated. |
Hot | Boolean | Means the Job is especially important. This can be used by the Balanced Composite Rule. |
HotReason | String | Explanation of why the Job is on Hot. |
Importance | Int32 | The value of the Job relative to other Jobs. This can be used by the Balanced Composite Rule. |
Cancelled | Boolean | If cancelled, the Job won’t be scheduled. |
LatePenaltyCost | Decimal | Optional currency value that specifies the cost (either actual or estimated) per day of finishing late. For display only. |
MaxEarlyDeliveryDays | Double | The customer will accept the order this amount of time before the Need Date. If Operations are scheduled with more than this amount of Slack then they are considered Early. This does not impose a constraint on Optimizations or Moves. Jobs can still be scheduled earlier than this but then they are marked as “Early”. If this value is zero then E-mail Alerts are not sent to alert of early Jobs since they cannot be accepted early. |
Priority | Int32 | Usually used to specify a combination of importance and urgency. This can be used by the Balanced Composite Rule. Lower numbers are more urgent/important. |
Type | String | Can be used to specify a free-form type for grouping. For display only. |
Revenue | Decimal | Estimated money paid for the parts produced by the Job. |
Profit | Decimal | The expected profit for the Job. This can be used by the Balanced Composite Rule. |
Scheduled | Boolean | Whether the Job is currently scheduled |
ScheduledStartDateTime | DateTime | The earliest Scheduled Start Date of all the Job’s Manufacturing Orders. |
ScheduledEndDateTime | DateTime | The latest Scheduled End Date of all the Job’s Manufacturing Orders. |
LatenessDays | Double | the larger of ‘ScheduledEnd minus NeedDate’ or 0 |
Late | Boolean | ‘True’ if the Job’s Scheduled End Date is after its Need Date. If the Job’s Classification is “Safety Stock” and the Job has Products associated with it then this value will be set to ‘True’ only if the Job is later than the Safety Stock Warning Level of the Product’s Inventory. |
Overdue | Boolean | Whether the Job’s Need Date is in the past. Don’t use this for simulation purposes since it makes use of DateTime’s UtcNow. |
Description | String | Text for describing the object. |
Notes | String | Comments or special considerations pertaining to this object. |
Finished | Boolean | Whether all Manufacturing Orders are Finished.(Overrides BaseOrder..::.Finished.) |
Name | String | Description |
DoNotDelete | Boolean | If true then the Job will not be deleted by the system. This can be used to keep Jobs that will be used as templates for copying to new Jobs. This value can be set by the interface but not updated. This is to preserve manual changes by the planner. |
ExternalId | String | Identifier for external system references. |
Locked | String | Locked Blocks cannot be moved to different Resources during Optimizations. Manual moves can be made to different Resources. |
Anchored | String | Anchored Activities tend to move less (in time) during Optimizations. Manual moves are allowed. |
OrderNumber | String | Can be used to specify the customer order number. For display only. |
OnHold | String | Operations that are On-Hold are scheduled to start after the Hold Until Date. |
OnHoldReason | String | The reason the Job was placed On-Hold |
Template | Boolean | Indicates that the Job is only used for copying to create new Jobs. Template Jobs are not scheduled. |
CustomerEmail | String | E-mail address of the customer to be alerted when the Job changes. Separate multiple addresses with semi-colons. |
AgentEmail | String | E-mail address of the sales or customer service agents to be alerted when the Job changes. Separate multiple addresses with semi-colons. |
CustomerAlert | String | Controls when E-Mail Alerts are sent to Customers, subject to system level Alert controls. |
AgentAlert | String | Controls when E-Mail Alerts are sent to Agents, subject to system level Alert controls. |
DoNotSchedule | Boolean | If true then the Job will not be scheduled. This can be used to prevent quotes or other un-firm Jobs from scheduling until a planner would like to do so. This value can be set by the interface but not updated. This is to preserve manual changes by the planner. |
Analysis | String | Special summary or troubleshooting information. |
ColorCode | String | A Color that can be used to distinguish the Job from other Jobs in the Gantt. |
EntryMethod | String | How the Job was entered into the system. |
HoldUntil | DateTime | No Activities are scheduled before this date/time. This value is only set if the Job itself is placed On Hold, not if Operations, etc. only are placed On Hold. |
PercentFinished | Int32 | The average Percent Finished of all of the Job’s Manufacturing Orders weighted by their Standard Hours. |
ScheduledStatus | String | Indicates the current status of the Operation with respect to it being scheduled. |
StandardHours | Double | The sum of the Standard Hours for all Manufacturing Orders. Only the hours from the operations that haven’t been omitted are included in this total. |
AttributesSummary | String | Summary of this object’s user defined Attributes. |
Bottlenecks | String | List of ManufacturingOrder Bottlenecks. |
CanSpanPlants | Boolean | If true, then the Operations can schedule in more than one plant. Otherwise, all operations must be scheduled in only one Plant.(Inherited from BaseOrder.) |
CommitmentPreserved | Boolean | Indicates that Commitment field was changed from within the system (as opposed to from import) and so it will be preserved to avoid future imports from updating it. |
DoNotDeletePreserved | Boolean | Indicates that DoNotDelete field was changed from within the system (as opposed to from import) and so it will be preserved to avoid future imports from updating it. |
DoNotSchedulePreserved | Boolean | Indicates that DoNotSchedule field was changed from within the system (as opposed to from import) and so it will be preserved to avoid future imports from updating it. |
EarliestDelivery | DateTime | The customer will accept the order on or after this date. |
EnteredToday | Boolean | Don’t use this field for simulation purposes because it uses Datetime.Now. True if the EntryDate (ignoring time of day) of the Job is the same as the date on the client PC. |
ExpectedRunHours | Double | Total of the Expected Run Hours for all of the Manufacturing Orders. |
ExpectedSetupHours | Double | Total of the Expected Setup Hours for all of the Manufacturing Orders. |
FailedToScheduleReason | String | If the status of the job is FailedToSchedule this will be set to a description as to why the job might not be schedulable. |
Hold | Boolean | Whether the Job was placed On-hold and work should not be done on it. |
HoldReason | String | The reason the Job was placed On-Hold |
LaborCost | Decimal | The sum of the Labor Cost for all Manufacturing Orders |
MachineCost | Decimal | The sum of the Machine Cost for all Manufacturing Orders |
MaterialCost | Decimal | The sum of the Material Cost for all Manufacturing Orders |
OverdueDays | Double | The amount of time that has passed since the Job’s Need Date. |
PercentOfStandardHrs | Int32 | If Standard Hours are specified then this is the Expected Hours divided by the Standard Hours. Smaller values mean the Job ran or is running faster than standard. |
PercentOverStandardHrs | Int32 | If the expected hours exceeds the standard hours (and Standard Hours is not zero) then this is the percent of the Standard Hours by which the Standard Hours have been exceeded. For example, if the Job should take 100 hours but is going to take 110 hours then this value is 10%. |
Product | String | The name of the Product from the first Manufacturing Order. If a Job contains multiple Manufacturing Orders then the Summary field lists all Product Names. |
ProductDescription | String | The description of the Product from the first Manufacturing Order. If a Job contains multiple Manufacturing Orders then the value is blank. |
Qty | Double | The sum of all Manufacturing Order Required Qties. |
ReportedRunHours | Double | The sum of the Reported Run Hours for all Manufacturing Orders in the Job. |
ReportedSetupHours | Double | The sum of the Reported Setup Hours for all Manufacturing Orders in the Job. |
SchedulingHours | Double | The sum of the Scheduling Hours for all Manufacturing Orders. |
Started | Boolean | Whether any of the Job’s Manufacturing orders are started. |
Summary | String | Summary of the Products being made by the Job. |
Throughput | Decimal | Calculated field equal to: Revenue – SubcontractCost – MaterialCost – ShippingCost – ExpectedLatePenaltyCost |
ShippingCost | Decimal | The cost of shipping the parts produced by the Job. |
ExpectedLatePenaltyCost | Decimal | Cost, usually charged by a customer, for delivering the Job’s products late.Set to the Job.LatePenaltyCost if the Job is Late. Otherwise set to zero. |
SubcontractCost | Decimal | The sum of the Subcontract Cost for all Manufacturing Orders |
TotalCost | Decimal | Labor Cost + Machine Cost + Subcontract Cost + Shipping Cost + Expected Late Penalty Cost. |
Printed | Boolean | Whether the Job’s Traveler Report has been Printed. |
Invoiced | Boolean | Whether an invoice has been sent for the Job. For information only. |
Shipped | String | Whether the Job has been shipped to the recipient. For information only. |
TravelerReportFileName | String | The name of the report (without path) to use for accompanying the Job on the shop floor. |
Destination | String | Indicates the geographical region or address where the products will be sent. For information only. Multiple reports can be included here by separating them with a semi-colon. |
Reviewed | Boolean | Tracks whether the Job has been reviewed by a planner. Only set during import for NEW Jobs and thereafter controlled internally. |
PercentOfMaterialsAvailable | Int32 | The percent of Material Requirements for all Manufacturing Orders that are Available. Calculation depends on the number of MaterialRequirements and their availability, not their quantities. |
SuccessorOrderNumbers | String | Returns a list of Order Number for all Jobs that this Job’s Manufacturing Orders go into via Successor Manufacturing Orders. |
ResourceNames | String | The names of the Resource(s) the Job is scheduled on if the Job is scheduled. |
ManufacturingOrders
PublishDate | DateTime | Date when this record was published |
JobId | Int64 | |
ManufacturingOrderId | Int64 | |
Name | String | Description |
RequiredQty | Double | The target quantity of good Product to be made. |
ExpectedFinishQty | Double | Usually the same as Required Qty but production problems may result in more or less than required. This is usually externally specified. However, changing quantities in the Job Dialog will update this value based on Operation completion quantities and whether the setting for Deduct Scrap from Required is set. |
Description | String | Text for describing the object.(Overrides BaseObject..::.Description.) |
ProductName | String | Name of the product being made. |
ProductDescription | String | Description of the product being made. |
Released | Boolean | Whether the MO has be approved by a planner to go into production. |
ReleaseDate | DateTime | If ManufacturingOrder is not Released, no Activities can be scheduled before this date. To reduce inventory carrying costs, this can be used to prevent Jobs from being completed too far in advance of when the customer wants the product. |
Notes | String | Comments or special considerations pertaining to this object. |
Scheduled | Boolean | Whether all schedulable operations have been scheduled |
ScheduledStart | DateTime | The earliest Scheduled Start Date of all the Manufacturing Orders’s Operations. |
ScheduledEnd | DateTime | The latest Scheduled End Date of all the Manufacturing Orders’s Operations. |
CanSpanPlants | Boolean | If true, then the Operations can schedule in more than one plant. Otherwise, all operations must be scheduled in only one Plant.(Overrides BaseOrder..::.CanSpanPlants.) |
CurrentPathId | Int64 | The Id of the current path. The Path to be used or being used currently. This is always set. |
DefaultPathId | Int64 | The Id of the default path. Default path is the initial path to be used. |
Family | String | For display only. |
Finished | Boolean | Whether all Operations are Finished.(Overrides BaseOrder..::.Finished.) |
Frozen | String | Anchored Activities move less (in time) during Optimizations and stay on the same resource. Manual moves are allowed but require confirmation. |
OnHold | String | Operations that are OnHold are scheduled to start after their Hold Until Date. |
HoldReason | String | The reason the Manufacturing Order was placed On-Hold |
Late | Boolean | True if ScheduledEnd is greater than NeedDate. |
LatenessDays | Double | The Scheduled End Date minus the Need Date. |
LeadTimeDays | Double | The amount of time between the earliest scheduled operation’s start and the latest scheduled operation’s finish. |
Locked | String | Locked Blocks cannot be moved to different Resources during Optimizations. Manual moves can be made to different Resources. |
LockedPlantId | Int64 | PlantId for the Plant this ManufacturingOrder is locked to. A ManufacturingOrder that is locked to a plant, can only schedule on the resources in that Plant. |
UOM | String | Unit of measure. For display only. |
ExternalId | String | Identifier for external system references. |
Anchored | String | This field can have three possible values: Anchored, Free or SomeActivitiesAnchored depending on Anchor state of the its Activities. |
Analysis | String | |
BreakOffSourceMOName | String | Name of the Manufacturing Order from which this Manufacturing Order was Broken Off, if this is a Break Off. If this is not a Break Off or if the original Manufacturing Order was deleted, this is an empty string. |
CopyRoutingFromTemplate | Boolean | If true then any Path information is ignored. Instead, the Path information for an existing Template Job is copied and used. The Product Name specifies which Product to copy the Paths from. If there is more than one Template for the same Product then the first one found by the system will be used. /// Setting this to true on an existing Manufacturing Order will cause any current routing information to be lost and copied in from a Template when the Manufacturing Order is saved. |
HoldUntil | DateTime | The date and time specified when the MO was placed on hold. No Activities can start before this date if the Hold is true. |
IsBreakOff | Boolean | Indicates whether this Manufacturing Order is the result of a Break Off from another Manufacturing Order. |
NeedDate | DateTime | The date and time when the M.O. should be finished to be considered on-time. If MoNeedDate is true then this is the value stored for the M.O.. Otherwise, this is the same as the Job Need Date. |
PercentFinished | Int32 | The average Percent Finished of the Manufacturing Order’s Operations weighted by their Standard Hours. This doesn’t include omitted operations. |
ProductColor | String | Can be used to visually indicate the Product being made. |
UseMONeedDate | Boolean | If true, ManufacturingOrder NeedDate is used rather than Job NeedDate. |
StandardHours | Double | The sum of the Standard Hours for all Operations. Only the hours from the operations that haven’t been omitted are included in this total. |
AttributesSummary | String | |
Bottlenecks | String | List of Operations that are bottleneck. An Operation is bottleneck if its the first Operation in the Job that is late. Unless a bottleneck Operation is scheduled sooner, it ManufacturingOrder will be late. |
DefaultPathName | String | The name of the default path. Default path is the initial path to be used. |
ExpectedRunHours | Double | Sum of all Operation Expected Run Hours. |
ExpectedSetupHours | Double | Sum of all Operation Expected Setup Hours. |
Hold | Boolean | Whether the Manufacturing Order was placed On-hold and work should not be done on it. |
IsReleased | Boolean | Whether the MO has be approved by a planner to go into production. Setting this to true sets the Release Date to the current time. |
LaborCost | Decimal | The sum of the LaborCost for all Operations in the Current Path. |
LockedPlantName | String | If specified then all work must be scheduled in this Plant. |
MachineCost | Decimal | The sum of the Machine Cost for all Operations in the Current Path. |
MaterialCost | Decimal | The sum of the Material Cost for all Operations in the Current Path. |
MoNeedDate | Boolean | If true then the Need Date can is set explicitly for the M.O.. Otherwise, the M.O. Need Date is set to the Job Need Date. |
PreserveRequiredQty | Boolean | If true then the Required Qty can only be set manually, not via ERP imports. This value is set to true automatically when the Required Qty is set internally by a planner in order to preserve the change. |
ReleaseDateTime | DateTime | No Activities can be scheduled before this date. |
ReportedRunHours | Double | The sum of the Reported Run Hours for all Operations in the Current Path. |
ReportedSetupHours | Double | The sum of the Reported Setup Hours for all Operations in the Current Path. |
RequestedQty | Double | This is the Required Qty as specified from the ERP imported values. This is usually the same as the Required Qty unless the Required Qty has been adjusted internally or PreserveRequiredQty is true. |
SchedulingHours | Double | The sum of the Scheduling Hours for all Operations. This doesn’t include omitted operations. |
AutoJoinGroup | String | Specifies which Manufacturing Orders can be AutoJoined. They must have non-blank, matching AutoJoinGroup values. |
Split | Boolean | Whether this ManufacutingOrder was split of from another ManufacturingOrder. |
SplitCount | Int32 | The number of Manufacturing Orders that were Split directly from this Manufacturing Order. |
SplitFromManufacturingOrderId | Int64 | If this Manufacturing Order is Split then this value specifies the Id of the Manufacturing Order from which it was Split. |
Started | Boolean | If any of the Operations in this ManufacturingOrder are Started. |
LockToCurrentAlternatePath | Boolean | Whether the CurrentPath is the only path the MO can be scheduled with. |
DBRShippingBufferOverride | Int64 | If set, this is the shipping buffer of the order. |
DbrReleaseDate | DateTime | The DBR Release Date of the Current Path. |
DbrShippingDueDate | DateTime | The MO NeedDate minus the Shipping Buffer. The MO should be completed by this time to avoid Shipping Buffer penetration. |
DbrBufferHrs | Double | The duration between the Drum Due Date and DBR Release Date in hours. |
ShippingBufferCurrentPenetrationPercent | Double | The Shipping Buffer Penetration at the PlanetTogether Clock. |
ShippingBufferProjectedPenetrationPercent | Double | The Shipping Buffer Penetration using the MO’s scheduled end. |
DrumBufferProjectedPenetrationPercent | Double | The penetration based on where the Drum operation’s predecessor(s) are scheduled to end or actually ended. |
DrumBufferCurrentPenetrationPercent | Double | The Drum Buffer Penetration at the PlanetTogether Clock. |
JobSuccessorManufacturingOrders
PublishDate | DateTime | Date when this record was published |
JobId | Int64 | Id of the Job with SuccessorManufacturingOrder relation. |
ManufacturingOrderId | Int64 | Id of the ManufacturingOrder with SuccessorManufacturingOrder relation. |
SuccessorJobId | Int64 | Id of the Successor Job defined in the SuccessorManufacturingOrder relation. |
SuccessorManufacturingOrderId | Int64 | Id of the Successor ManufacturingOrder defined in the SuccessorManufacturingOrder relation. |
SuccessorPathId | Int64 | Id of the Successor AlternatePath defined in the SuccessorManufacturingOrder relation. |
SuccessorOperationId | Int64 | Id of the Successor Operation defined in the SuccessorManufacturingOrder relation. |
TransferHrs | Double | The successor MO is constrained by the FinishDate of predecessor MO plus this number of ticks. |
UsageQtyPerCycle | Decimal | This much of the predecessor is used by the successor in each cycle of the successor. |
JobOperations
PublishDate | DateTime | Date when this record was published |
JobId | Int64 | |
ManufacturingOrderId | Int64 | |
OperationId | Int64 | |
Name | String | Description |
Description | String | Text for describing the object.(Inherited from BaseOperation.) |
SetupHours | Double | Time for setting up each Resource that is used during the Operation’s setup time |
RequiredStartQty | Double | The quantity to start at this Operation. This takes into account Planning Scrap Percent and so it is usually more than the Required Finish Quantity. If Whole Number Splits is checked then this value is rounded up to the nearest whole number.(Inherited from InternalOperation.) |
RequiredFinishQty | Double | The Required Finish Qty less the sum of the Reported Good Quantities of all of the Operation’s Activities. This value is never negative. If more is good parts are reported than are required then this value is zero. |
QtyPerCycle | Double | The quantity of product produced during each production cycle. |
MinutesPerCycle | Double | Number of minutes in each cycle. |
PostProcessingHours | Double | The sum of the Reported PostProcessing Hours of all the activities. |
OverlapTransferQty | Double | The number of parts moved to the next operation in each transfer batch. Smaller values can be used to shorten flow times by making material available at successor operations more quickly.(Inherited from InternalOperation.) |
CanPause | Boolean | If true then Activities can be ‘paused’ for Offline Capacity Intervals. If false, Activities won’t start until there is sufficient time to complete them in one continuous interval.(Inherited from InternalOperation.) |
CanSubcontract | Boolean | Indicates to the planner that this work can be subcontracted if necessary. For display only.(Inherited from InternalOperation.) |
DailyCarryingCost | Decimal | Cost per unit per day after this Operation is finished. This is for costs related to shrinkage, spoilage, raw materials, engineering changes and customer changes that may cause materials to be scrapped. |
CompatibilityCode | String | Used to restrict Resources to only perform compatible work at simulataneous times. If specified, then any scheduled Operation’s CompatibilityCode must match the CompatibilityCode of other Operations scheduled on Resources with the same CompatibilityGroup.(Inherited from InternalOperation.) |
BatchCode | String | On batch resources, operations with the same batch code are allowed to run in the same batch. |
SetupCode | String | Can be used to calculate sequence-dependent setup and/or to reduce frequency of setups during Optimizations. Operations that have different Setup Codes typically require some time to be spent during changeover to setup the equipment for the next run.(Inherited from InternalOperation.) |
SetupNumber | Double | (Inherited from InternalOperation.) |
DeductScrapFromRequired | Boolean | Whether Reported Scrap should be deducted from the Required Finish Qty when determining the quantity to schedule. In some cases, more material is available and additional product can be produced to make up for the scrap. In other cases this is not possible and the operation will finish short.(Inherited from InternalOperation.) |
SuccessorProcessing | String | Allows control over whether the successor operation must be scheduled on the same resource as this one. Use of this feature requires that the routing be linear within the predecessor and successor operation, that the operation only has 1 activity, and that the resource the predecessor ends up being scheduled on is eligible to perform the work required on the successor operation. KeepSuccessor means the successor operation will try to end up being scheduled on the same resource as the predecessor operation KeepSuccessorNoInterrupt means that not only will the successor operation try to end up on the same resource but it will also try to end up as the very next operation scheduled on the resource.(Inherited from InternalOperation.) |
KeepSuccessorsTimeLimitHours | Double | The length of time the SuccessorProcessing setting remains valid for. After this length of time has passed without the successor operation finding a spot on the resource’s schedule after its predecessor it may be scheduled on some other resource. |
ConstraintType | String | Whether the Operation should prevent its Successor(s) from starting before material from this Operation is finished.(Inherited from BaseOperation.) |
HoldUntilDateTime | DateTime | If the Operation is on hold then Activities for this Operation are scheduled to start after the Hold Until Date.(Inherited from BaseOperation.) |
HoldReason | String | If the Operation is on hold then this is why.(Inherited from BaseOperation.) |
Omitted | String | Omitted Operations are treated as if they take zero time. ‘OmittedByUser’ means the Operation was omitted explicitly. ‘OmittedAutomatically’ means the system omitted the Operation due to bad data (See System Options). ‘NotOmitted’ means the Operation will be included as normal.(Inherited from BaseOperation.) |
Finished | Boolean | Whether all the activities of the operations have been finished.(Inherited from InternalOperation.) |
OnHold | Boolean | Whether the Operation should not be worked on for some reason until the Hold Until Date.(Inherited from BaseOperation.) |
IsRework | Boolean | Indicates that this is work being performed to fix a problem encountered in another operation. For display only.(Inherited from BaseOperation.) |
PlanningScrapPercent | Double | Percent of parts expected to be scrapped. Used to calculate Expected Good Qty and Expected Scrap Qty.(Inherited from BaseOperation.) |
UOM | String | Indicates the meaning of one unit of this product. For display only.(Inherited from BaseOperation.) |
Notes | String | Comments or special considerations pertaining to this object. |
AutoSplit | Boolean | RESERVED FOR FUTURE USE If the operation is scheduled after its JITStartDateTime then we split the operation evenly into n activities where n is the number of eligible Resources. Resulting split Activities are scheduled independent of each other and may schedule on the same or different Resources. This also controls unsplitting. During Optimizations, if an Activity is found to have been split unnecessarily then it will be unsplit. This applies both to automatically and manually split activities.(Inherited from InternalOperation.) |
MinAutoSplitQty | Double | This is a minimum quantity for any resulting Activity of a split.(Inherited from InternalOperation.) |
WholeNumberSplits | Boolean | Whether Activities must be split into quantities with whole numbers. (Only possible if the original quantity is a whole number.)(Inherited from InternalOperation.) |
PrimaryResourceRequirementID | Int64 | Id of the Primary ResourceRequirement |
SetupColorName | String | Name of the SetupColor field. SetupColor field can be used to visually indicate whether Operations require special setup when switching from other Operations. |
TimeBasedReporting | Boolean | Specifies whether Reported Run Span is subtracted from Scheduled Run Span rather than calculating Scheduled Run Span based on the Remaining Quantity.(Inherited from InternalOperation.) |
ExternalId | String | Identifier for external system references. |
Scheduled | Boolean | Whether the Operation is currently scheduled or not. |
ScheduledStart | DateTime | The Scheduled Start Date of the earliest Activity |
ScheduledEnd | DateTime | The Scheduled End Date of the latest of the Operation’s Activities. |
NeedDate | DateTime | If the Operation has no Successors, then this is the Manufacturiong Order Need Date. Otherwise, this is the JIT Start Date of the closest Successor minus the Transfer Span.(Inherited from BaseOperation.) |
Locked | String | Locked Blocks cannot be moved to different Resources during Optimizations, Moves, or Expedites..(Inherited from InternalOperation.) |
Anchored | String | Anchored Activities cannot be moved (in time or resource) during Optimizations, Moves, or Expedites.(Inherited from InternalOperation.) |
ScheduledPrimaryWorkCenterExternalId | String | ExternalId of the Resource of the first scheduled Activity’s Primary Resource Requirement. |
TimeCustomizer | String | Optional. If using a custom Add-in to set Cycle or Setup time, then this is the Add-in Name, NOT the .dll name.(Inherited from InternalOperation.) |
AutoReportProgress | Boolean | If true then when the Clock is advanced the Operation has progress reported according to schedule. Hours are automatically added to the fields for Reported Setup, Run, and Post-Processing values — depending upon the current Production Status of the Activities. For example, if the Activity’s Production Status is Running when the Clock is advanced then the Reported Run Hours is incremented by the difference in hours between the old Clock and new Clock values. Note that in order for the Activities to have their scheduled lengths adjusted as a result of this auto reporting of progress, the Time Base Reporting value on the Operation must also be checked. To preserve the auto-computed values for Reported Setup, Run and Post-Processing, updates from Imports are ignored. However, manual updates of these fields from the user interface are applied. |
ExpectedFinishQty | Double | The value of this field is based on the most constraining finished predecessor operation. |
UseExpectedFinishQty | Boolean | Whether the finish quantities of predecessor operations will have an influence on the expected finish quantity of this operation. In the event of multiple predecessors the most limiting one determines the finish quantity.(Inherited from BaseOperation.) |
StandardHours | Double | The standard number of work hours required to complete the Operation. This value has no effect on scheduling but is used to compare scheduled versus standard hours. If this value is not set explicitly then it is set based on the scheduled hours when the operation is created. Calculated as the StandardRunSpan plus the Standard Setup Span.(Inherited from InternalOperation.) |
OutputName | String | The name of the output product produced by this operation. This is useful in cases where several predecessor operations producing the same type of material supply the same successor operation. The successor will use this field to recognize quantities of identical materials available. If this field isn’t set then the material will not be grouped with any other predecessor operations. Groups of material are used for things such as calculating the ExpectedFinishQuantity.(Inherited from BaseOperation.) |
UseCompatibilityCode | Boolean | Whether to use the compatibility code.(Inherited from InternalOperation.) |
Attributes | String | |
WorkContentHours | Double | The sum of the Work Content of the Activities |
PercentFinished | Int32 | The average Percent Finished of the Operation’s Activities.(Inherited from InternalOperation.) |
MSProjectPredecessorOperations | String | A list of Operations used for integration with MS Project. |
AttributesSummary | String | Summary of this object’s user defined Attributes. |
AutoFinish | Boolean | If true then when the Clock is advanced past the end of the Operation it is Finished automatically. |
Bottleneck | Boolean | An Operation is a Bottlneck if any of its Activities are Bottlenecks. Unless this Operation is scheduled sooner the Job or Manufacturing Order will be late.(Inherited from InternalOperation.) |
BuyDirectMaterialsList | String | Returns a list of the Material Names for all Material Requirements that are Buy Direct.(Inherited from BaseOperation.) |
BuyDirectMaterialsListNotAvailable | String | Returns a list of the Material Names for all Material Requirements that are Buy Direct where the material requirement is not Available.(Inherited from BaseOperation.) |
CarryingCost | Decimal | Cost per unit per day after this Operation is finished. This is for costs related to shrinkage, spoilage, raw materials, engineering changes and customer changes that may cause materials to be scrapped. For display only.(Inherited from InternalOperation.) |
Cycles | Int64 | The estimated number of cycles left. When scheduled the actual number of cycles may vary. Things that can affect the actual number of cycles include Product Rules and Batch Resources. |
CycleHrs | Double | Time to perform one production cycle. This is used with Qty Per Cycle to determine the run length of the Operation |
EndOfMatlPostProcDate | DateTime | (Inherited from InternalOperation.) |
EndOfResourceTransferTimeDate | DateTime | Assuming the operation is scheduled, among all activities the latest completion of Transfer Time is returned. This is based on completion of processing + material post processing + primary resource transfer time.(Inherited from InternalOperation.) |
EndOfRunDate | DateTime | If the activity has some run time scheduled then this is the time it is scheduled to end. If the activity is in the post-processing state or is finished then this is the time run was scheduled to finish or is the time run was reported to be finished.(Inherited from InternalOperation.) |
ExpectedRunHours | Double | The total number of hours expected to be worked based on current Cycle Span and quantity and hours reported. If the Operation is finished then this is the Reported Run Hours. If unfinished and scheduled, then this is the sum of the Scheduled Run Span, Scheduled Post-Processing Span, Reported Run Span, and Reported Post Processing Span of all Activities. If unfinished and unscheduled, then this is the maximum of zero and the Scheduling Hours minus the Reported Run Hours.(Inherited from InternalOperation.) |
ExpectedScrapQty | Double | The quantity expected to be scrapped. This is the Required Start Qty times the Planning Scrap Percent.(Inherited from BaseOperation.) |
ExpectedSetupHours | Double | The total number of setup hours expected to be worked based on current Cycle Span and quantity and hours reported.(Inherited from InternalOperation.) |
JITStartDate | DateTime | The latest the Operation can start and still finish by the Operation NeedDate.(Inherited from BaseOperation.) |
KeepSuccessorsTimeLimitHrs | Double | The length of time the SuccessorProcessing setting remains valid for. After this length of time has passed without the successor operation finding a spot on the resource’s schedule after its predecessor it may be scheduled on some other resource.(Inherited from InternalOperation.) |
LaborCost | Decimal | Sum of labor cost of all Activities in the Operation. |
Late | Boolean | Late if starting after JIT or ending after needdate. Takes into account system lateness threshold setting |
LatestConstraint | String | The latest (most constraining) of all constraints for the Operation including: Predecessors, Materials and ReleaseDate. This is the constraint that is limiting the Operation from moving before the Latest Constraint Date. |
LatestConstraintDate | DateTime | The date the operation became ready. |
LatestPredecessorFinish | DateTime | The latest Scheduled End Date of all of the Operation’s Predecessors. If there are no Predecessors then this is MinDate. |
MachineCost | Decimal | Sum of machine cost of all Activities in the Operation. |
MaterialCost | Decimal | Sum of machine cost of all MaterialRequirements in the Operation. |
MaterialList | String | List of all Material Requirements for the Operation. |
MaterialPostProcessingHrs | Double | Specifies the amount of time after processing that material must wait before it can be used. For instance this may represent drying time, or cooling time. This time does not consume capacity on Resources. |
MaterialsNotAvailable | String | Browsable list of all Material Requirements for the Operation that are not Available. |
MaterialsNotPlanned | String | Browsable list of all Material Requirements for the Operation that are not Available. |
MaterialStatus | String | Specifies whether the Operation has Material Requirements that are not Allocated. |
MaxDelayRequiredStartBy | DateTime | The date/time when this Operation must start in order to avoid violating any of the Predecessor Max Delay limits. If there are no Predecessors then this is Max Date. |
OperationScheduledCustomizer | String | Optional name of a .Net Assembly to use to perform custom actions after the operation has been scheduled. |
ProductsList | String | List of all products in the Operation. |
RemainingFinishQty | Double | The Required Finish Qty less the sum of the Reported Good Quantities of all of the Operation’s Activities. This value is never negative. If more is good parts are reported than are required then this value is zero. |
ReportedGoodQty | Double | The sum of the reported good quantities of all the activities. |
ReportedRunHours | Double | The sum of the Reported Run and Post Processing hours of all the activities. |
ReportedScrapQty | Double | The sum of the reported scrap quantities of all the activities. |
ReportedSetupHours | Double | The sum of the Reported Setup Hours of all the activities. |
ReportedPostProcessingHours | Double | The sum of the Reported PostProcessing Hours of all the activities. |
RequiredCapabilities | String | A list of the Capabilities required to perform the Operation. |
ResourcesUsed | String | Name of the resource(s) that the Operation is scheduled on. |
RunHrs | Double | The expected time to run the full start quantity. This is calculated by multiplying Cycles by Cycle Span |
SchedulingHours | Double | The sum of the Operation’s Setup Span, Run Span, and Post-Processing Span. |
SetupColor | String | Can be used to visually indicate whether Operations require special setup when switching from other Operations. |
Split | Boolean | Whether the Operation has been split into multiple Activities. |
StandardRunHrs | Double | If not set explicitly, this is set to the Operation RunSpan plus the PostProcessingSpan when the Operation is created or updated. Used to calculate performance by comparing against actual values. This has no effect on scheduling. |
StandardSetupHrs | Double | Used to calculate performance by comparing against actual values. This has no effect on scheduling. |
Started | Boolean | Whether any of the Operation’s Activities are Started.(Inherited from InternalOperation.) |
StockMaterialsList | String | Returns a list of the Item Names for all Material Requirements that are for stocked Items.(Inherited from BaseOperation.) |
StockMaterialsListAwaitingAllocation | String | Returns a list of the Item Names for all Material Requirements that are for stocked Items where the material requirement is not satisfied by On Hand Inventory.(Inherited from BaseOperation.) |
CommitStartDate | DateTime | The planned Operation start date to be used to measure schedule conformity. |
CommitEndDate | DateTime | The planned Operation end date to be used to measure schedule conformity. |
CycleSpanManualUpdateOnly | Boolean | Whether CycleSpan field can be updated through data import. |
QtyPerCycleManualUpdateOnly | Boolean | Whether QtyPerCycle field can be updated through data import. |
SetupTimeManualUpdateOnly | Boolean | Whether SetupSpan field can be updated through data import. |
PostProcessManualUpdateOnly | Boolean | Whether PostProcessing field can be updated through data import. |
ScrapPercentManualUpdateOnly | Boolean | Whether ScapPercent field can be updated through data import. |
MaterialsManualUpdateOnly | Boolean | Whether Operation’s Material Requirements can be updated through the data import. |
ProductsManualUpdateOnly | Boolean | Whether Operation’s Products can be updated through the data import. |
ResourceRequirementsManualUpdateOnly | Boolean | Whether Operation’s Resource Requirements can be updated through the data import. |
StoragePostProcessingHrs | Double | The length of time a Tank resource is unavailable after all the material in it has been removed. |
CurrentBufferPenetrationPercent | Double | The Current penetration percent to most relevant to the Operation. MO Drum Current Penetration if BufferType=Drum. MO Shipping Current Penetration if BufferType=Shipping. MO.Buffer Stock Penetration Percent if BufferType=Stock. |
ProjectedBufferPenetrationPercent | Double | The Projected penetration percent to most relevant to the Operation. MO Drum Projected Penetration Percent if BufferType=Drum. MO Shipping Projected Penetration Percent if BufferType=Shipping. MO.Buffer Stock Penetration Percent if BufferType=Stock. |
JITStartDateBufferDays | Double | TimeSpan is subtracted from JITStartDate to allow some slack per Operation bases. |
DBRJitStartDate | DateTime |
JobActivities
PublishDate | DateTime | Date when this record was published |
JobId | Int64 | |
ManufacturingOrderId | Int64 | |
OperationId | Int64 | |
ActivityId | Int64 | |
ProductionStatus | String | Indicates the current state of the Activity in production. This field also determines which portions of the Activity are scheduled. For example, if the status is Running then no SetupSpan will be scheduled. This value is set externally or manually, not by PlanetTogether. If the status is SettingUp, or Running then the current Resources will not be changed by an Optimization unless the job is unscheduled due to a routing change or manually. Waiting: The Activity is waiting for material, previous operations, or a release date before it will be ready to start. Ready: The Activity can be worked on as soon as the necessary Resources are available. Started: Either time or quantity has been reported for the Activity and it is currently in a Waiting or Ready state. SettingUp: The Activity is currently being setup on a Resource. Once in Setup the Activity is scheduled near the front of the schedule and connot be moved. Running: The Activity is currently being run on a Resource. If in Run status, the Activity is scheduled near the front of the schedule and cannot be moved. PostProcessing: he Activity is finished running but is now waiting for drying, cleanup, etc. If there is PostProcessing time scheduled and Post Processing Uses Resource is true then the Activity is scheduled near the front of the schedule and cannot be moved. Otherwise the Activity is removed from the schedule. Finished: The Activity is complete in production and is ready for the successor operation or is in inventory. Once Finished, it is no longer scheduled. |
RequiredFinishQty | Double | The total quantity of good parts this activity needs to produce. |
ReportedGoodQty | Double | Quantity of good product reported to have been finished. |
ReportedScrapQty | Double | Quantity of scrapped product reported to have been finished. |
ReportedRunHours | Double | Run time reported to have been spent so far. |
ReportedSetupHours | Double | Setup time reported to have been spent so far. |
ReportedPostProcessingHours | Double | PostProcessing time reported to have been spent so far. |
ZeroLength | Boolean | Whether there was any remaining time to schedule for the Activity. If no time or quantity remains then a fixed time of one minute is scheduled. An Activity can have its status set to Finished/Received to remove it from the schedule. |
ExternalId | String | Identifier for external system references. |
Locked | String | An indication of the locked status of this activity. It can be Locked, Unlocked, or, Some blocks locked. |
Anchored | Boolean | If true then Optimizations will attempt to start the Activity as close as possible to the AnchorStartDate. If manually moved or Expedited, Anchored Activities are re-anchored to their new Start Date. If moved with in Exact mode, successor Activities are re-anchored at their new Start Date only if it is earlier than their Anchor Start Date. |
AnchorStartDate | DateTime | The date and time on which the Activity is Anchored (if it is marked as Anchored). |
AnchorDriftHours | Double | If Anchored and Scheduled, this is the Scheduled Start Date minus the Anchored Start Date. This indicates by how much the Activity has “drifted” from its Anchor date. Otherwise this value is zero. |
ScheduledStartDate | DateTime | If scheduled, this is the scheduled start time of the Activity on the Main Resource. |
ScheduledEndOfSetupDate | DateTime | When setup is scheduled to end. This value is meaningless if there is no setup scheduled. |
ScheduledEndOfRunDate | DateTime | The time at which the run portion of the activity is scheduled to finish. |
ScheduledEndDate | DateTime | If scheduled, this is the scheduled end time of the Activity on the Main Resource. |
ScheduledSetupHours | Double | If scheduled, this is the total number of scheduled setup hours. Otherwise, zero. |
ScheduledRunHours | Double | If scheduled, this is the total number of scheduled run hours. Otherwise, zero. |
ScheduledPostProcessingHours | Double | If scheduled, this is the total number of post processing hours. Otherwise, zero. |
ReportedFinishDate | DateTime | This only has meaning when the BaseActivity.Finished flag has been set. |
FinishedInternally | Boolean | Indicates that the Activity was finished or partially finished from within PlanetTogether or with an ActivityFinishT from some other source, rather than from the ERP interface. Therefore future ERP Activity updates may be ignored depending upon the System Option for ERP Update of Activities Finished Internally. |
Paused | Boolean | Indicates that the current setup or run process has been temporarily suspended due to something like an operator break, end of shift, etc. Pausing the Activity does not necessarily mean it will be reschedulable. That depends upon the Activity’s Production Status and Hold status. This is primarily a visual indicator that the Activity is not currently being worked on. |
NbrOfPeople | Double | If PeopleUsage is set to UseSpecifiedNbr then this is the maximum number of people that will be allocated to the Activity. Fewer than this number will be allocated during time periods over which the Primary Resource’s Nbr Of People is less than this value. The setting is used with the Nbr Of People setting in the Resource’s Capacity Interval to determine how long the operation will take and how many Operations can be run simultaneously. The minimum of this number and the number available in the Capacity Interval are used. To allow multiple Operations to run simultaneously the Resource’s Capacity Type must be set to Multi-Tasking in which case the sum of NbrOfPeople across Operations running simultaneously must be less than or equal to the Capacity Interval’s Nbr Of People. |
PeopleUsage | String | Determines how many people are allocated to an Activity in the schedule. |
Comments | String | Text that can be entered by operators or loaded from bar code systems. |
Comments2 | String | Text that can be entered by operators or loaded from bar code systems. |
ExpectedFinishQty | Double | This is the RequiredFinishQty adjusted to take into consideration the most constraining predecessor operation. This may be a fraction of RequiredFinishQty. The value of this field = (Operation.ExpectedFinishQty)*(activity.RequiredFinishQty/Operation.RequiredFinishQty). |
JitStartDate | DateTime | The latest the Activity can start on this resource and still finish by the Operation NeedDate. Calculated by subtracting the Activity WorkContent from the Operation NeedDate when the Job is created. |
Scheduled | Boolean | Checks if the activities resource requirements have blocks and whether they’re scheduled. |
WorkContentHours | Double | If scheduled, this is Scheduled Setup + Scheduled Run + Scheduled PostProcessing. Remaining hours of work capacity required. This is not necessarily the same as the Duration. If finished, this is Reported Setup + Reported Run + Reported PostProcessing. (actual time). Otherwise this is the remaining Setup + (RemainingQty / QtyPerCycle x CycleSpan) + remaining PostProcessSpan. |
PercentFinished | Int32 | This indicates the progress reported on the Activity. This value depends upon the values of the Activity’s Reported Qty or Hours as well as the Operation’s Time Based Reporting and Deduct Scrap From Required settings. Also, this value is set to 100 percent when the Activity’s Production Status is set to Finished. |
Bottleneck | Boolean | An Activity is considered to be a bottleneck if it is late and the Operation has no Predecessors that are Late. Without moving the Activity earlier the Job cannot be ontime. |
CalendarDurationHrs | Double | The Scheduled End Date minus Scheduled Start Date. |
EndOfRunDate | DateTime | If the activity has some run time scheduled then this is the time it is scheduled to end. If it’s in post-processing or finished and ReportedEndOfRunDate has been set then that value is returned. |
ExpectedScrapQty | Double | The quantity of items expected to be scrapped given the Required Start Qty and the Operation’s Planning Scrap Percent. |
LaborCost | Decimal | The total cost of every scheduled labor resource. The cost for each Resource is calculated by Resource’s StandardHourlyCost times the length of the usage. To be included, a scheduled resource must have one of the following ResourceTypes: Employee, Engineer, Inspector, Labor, Operator, Supervisor, Team and Technician. |
Late | Boolean | Whether the activity starts after the JitStartDate or ends after the NeedDate. |
LeftLeewayHrs | Double | The amount of time that the Activity can move to the left (earlier) without hitting a constraint. |
MachineCost | Decimal | The total cost of every scheduled resource that is not labor or subcontractor. The cost for each Resource is calculated by Resource’s StandardHourlyCost times the length of the usage. To be included, a scheduled resource cannot be labor (see LaborCost) or subcontractor. |
MaxDelayRequiredStartBy | DateTime | The date/time by which the Activity must be scheduled to start in order to avoid violating the Max Delay limit of any predecessor Operations. |
MaxDelaySlackDays | Double | The amount of time the Activity can be delayed and still start before the MaxDelayRequiredStartBy date. Negative values indicate that the Activity is starting too late. |
MaxDelayViolation | Boolean | Whether the Activity is scheduled to start after the MaxDelayRequiredStartBy date. |
NbrOfPeopleAdjustedWorkContentHrs | Double | The WorkContent of the Activity divided by the NbrOfPeople. This gives a better idea of how long it will take to perform the Activity. Note that this value ignores the People Usage which is used to actually put NbrOfPeople to use in scheduling. |
QueueDays | Double | The amount of time that the Activity is schedule to be in queue from the time it is ready to the time it is scheduled to start. |
RemainingQty | Double | The number of units that must be made to bring the Reported Good Qty up to the Required Finish Qty. |
ReportedEndOfRunDate | DateTime | If the activity has some run time scheduled then this is the time it’s scheduled to end. When the state of the activity is changed to post-processing this value is set to the clock date unless you have report this value. |
ReportedMaterialPostProcessingHrs | Double | |
ReportedStartDate | DateTime | This only has meaning when Setup, Run, or PostProcessing Hours have been reported. |
RequiredStartQty | Double | The required quantity to start in order to arrive at the Required Finish Qty given the Operation’s Planning Scrap Percent. If Operation.WholeNumberSplits is checked then this quantity is rounded up to the nearest whole number. |
ResourcesUsed | String | Name of the resource(s) that the Activity is scheduled on. |
ResourceTransferHrs | Double | If the activity is scheduled, this is the TransferTime of the primary resource. If the activity is finished, this is the transfer time of the primary resource at the time the activity was finished. If the activity isn’t scheduled, this is 0. |
RightLeewayHrs | Double | The amount of time that the Activity can move to the right (later) without hitting a successor. |
SlackDays | Double | The amount of time that the Activity’s Scheduled End Date can be delayed and still be before the Operation NeedDate. |
SplitId | Int32 | Activities that were split from the same source InternalActivity have the same splitId. This is used for unsplitting. For internal use only. -1 if not from a split |
Started | Boolean | Whether the Activity’s Production Status is “Started”. |
Timing | String | ‘Early’ means the Activity finishes more than the Job.MaxEarlyDeliverySpan before the Operation NeedDate. ‘Late’ means the Activity ends after the Operation NeedDate. ‘Bottleneck’ means the Activity is Late and not due to a Predecessor making it Late. ‘Capacity Bottleneck’ means the Activity is a Bottleneck due to queuing. ‘Material Bottleneck’ means the Activity is a Bottleneck due to Materials. ‘Late Release Bottleneck’ means the Activity is a Bottleneck due to a late MO Release Date or other manual delay. |
Batched | Boolean | Whether the Activity has been Batched using the Operation Batch Code. |
CycleHrs | Double | Time to perform one production cycle. This is used with Qty Per Cycle to determine the run length of the Operation |
QtyPerCycle | Double | The quantity of product produced during each production cycle. |
SetupHrs | Double | Time for setting up each Resource that is used during the Operation’s setup time |
PostProcessingHrs | Double | The sum of the Reported PostProcessing Hours of all the activities. |
PlanningScrapPercent | Double | Percent of parts expected to be scrapped. Used to calculate Expected Good Qty and Exptected Scrap Qty.(Inherited from BaseOperation.) |
CycleSpanManualUpdateOnly | Boolean | Whether CycleSpan field can be modified through data import. |
QtyPerCycleManualUpdateOnly | Boolean | Whether QtyPerCycle field can be modified through data import. |
SetupTimeManualUpdateOnly | Boolean | Whether SetupHrs field can be modified through data import. |
PostProcessManualUpdateOnly | Boolean | Whether PostProcessing field can be modified through data import. |
ScrapPercentManualUpdateOnly | Boolean | Whether PlanningScapPercent field can be modified through data import. |
OptimizationScore | Decimal | Total Score of composite scores applicable for activity. |
OptimizationScoreDetails | String | Displays a list of all factors that contribute to the Optimization score. |
ScheduledSetupZeroLength | Boolean | True if the Activity ProductionStatus is ‘Setup’ but reported setup time exceeds the required setup time. In this case, a very small amount of time is scheduled for setup segment. |
ScheduledRunZeroLength | Boolean | True if the Activity ProductionStatus is ‘Running’ but reported run time exceeds the required run time. In this case, a very small amount of time is scheduled for run segment. |
ScheduledPostProcessingZeroLength | Boolean | True if the Activity ProductionStatus is ‘PostProcessing’ but reported PostProcessing time exceeds the required PostProcessing time. In this case, a very small amount of time is scheduled for PostProcessing segment. |
ReportedStartOfProcessingDate | DateTime |
JobActivityInventoryAdjustments
PublishDate | DateTime | Date when this record was published |
InventoryId | Int64 | Id of the Inventory affected by this adjustment. |
ActivityId | Int64 | Id of the Activity that caused this adjustment |
AdjustmentDate | DateTime | Date of the adjustment |
AdjustmentQty | Double | Quantity of the adjustment |
AdjustmentReason | String | Localized text, describing this adjustment, with information about the Product being produced and the Activity producing it. |
PublishDate | DateTime | Date when this record was published |
JobId | Int64 | Id of the consuming MaterialRequirement’s Job. |
ManufacturingOrderId | Int64 | Id of the consuming MaterialRequirement’s ManufacturingOrder. |
OperationId | Int64 | Id of th consuming MaterialRequirement’s Operation. |
MaterialRequirementId | Int64 | Id of the consuming Material Requirement. |
ActivityId | Int64 | Id of the consuming MaterialRequirement’s Activity. |
SupplyingJobId | Int64 | Id of the Job providing the needed material. |
SupplyingManufacturingOrderId | Int64 | Id of the ManufacturingOrder providing the needed material. |
SupplyingOperationId | Int64 | Id of the Operation providing the needed material. |
SupplyingActivityId | Int64 | Id of the Activity providing the needed material. |
SuppliedQty | Double | Quantity of the allocated material. |
SupplyBomLevel | Int32 | Level 0 means this Activity is directly supplying the target MR. Level 1 means it’s supplying an Activity that is a Level 0, etc. |
JobResourceCapabilities
PublishDate | DateTime | Date when this record was published |
JobId | Int64 | |
ManufacturingOrderId | Int64 | |
OperationId | Int64 | |
ResourceRequirementId | Int64 | |
CapabilityId | Int64 | |
CapabilityExternalId | String |
JobResources
PublishDate | DateTime | Date when this record was published |
JobId | Int64 | |
ManufacturingOrderId | Int64 | |
OperationId | Int64 | |
ResourceRequirementId | Int64 | |
Description | String | |
ExternalId | String | Identifier for external system references. |
UsageStart | String | The first processing step this requirement is defined to take place in. |
UsageEnd | String | The last processing step this requirement is defined to take place in. It must be greater than or equal to the UsageStart. |
AttentionPercent | Int32 | The percent of the Resource’s attention consumed by this Resource Requirement. For example, two Operations with Attention Percents of 60% and 40% could schedule “stacked” on each other in the Gantt — running simultaneously. |
IsPrimary | Boolean | |
DefaultResourceJITLimitHrs | Double | This can be used to limit the enforcement of the Default Resource within this amount of time from the Activity’s JIT Start time. This will give flexibilty during Optimization to choose other Resources if the Default Resource is unable to start the Activity on time thus minimizing the chance of it being late. |
UseDefaultResourceJITLimit | Boolean | Whether to use the DefaultResourceJITLimitHrs value. |
DefaultResourceId | Int64 | Specifies the Resource that will be used to satisfy the Resource Requirement whenever the Operation is scheduled. |
JobResourceBlocks
PublishDate | DateTime | Date when this record was published |
JobId | Int64 | |
ManufacturingOrderId | Int64 | |
OperationId | Int64 | |
ActivityId | Int64 | |
BlockId | Int64 | |
BatchId | Int64 | |
PlantId | Int64 | |
DepartmentId | Int64 | |
ResourceId | Int64 | |
ScheduledStart | DateTime | The start of the first segment, Setup, Processing or Post Processing. |
ScheduledEnd | DateTime | The end of the latest segment, PostProcessing, Processing, or Setup. |
Locked | Boolean | Obsolete (This is no longer valid. The blocks must be checked individually. This function will be deleted soon.) |
Sequence | Int64 | The 1-based index number of this block on it’s resource. |
RunNbr | Int64 | The 1-based index number of this block on it’s resource for the day it’s scheduled to start. |
ResourceRequirementId | Int64 | Obsolete(“This may be obsolete since a block can satisfy multiple resource requirements.”) |
DurationHrs | Double | The calendar time between the Scheduled Start and Scheduled End. |
LaborCost | Decimal | The labor cost of the activities in the batch. Equals the total scheduled hours multiplied by Resource’s StandardHourly cost if the scheduled Resource is a Labor (Employee, Engineer, Inspector, Labor, Operator, Supervisor, Team, Technician), zero otherwise. |
MachineCost | Decimal | The machine cost of the activities in the batch. Equals the total scheduled hours multiplied by Resource’s StandardHourly cost if the scheduled Resource is a Machine (not Labor or subcontractor), zero otherwise. |
ResourceRequirementIndex | Int32 | This is the index of the satisfied ResourceRequirement in the list of Operation ResourceRequirements. |
Scheduled | Boolean | If the block is currently scheduled. |
Batched | Boolean | Whether the Activity has been Batched on this Resource using the Operation Batch Code. |
JobResourceBlockIntervals
PublishDate | DateTime | Date when this record was published |
JobId | Int64 | |
ManufacturingOrderId | Int64 | |
OperationId | Int64 | |
ActivityId | Int64 | |
BlockId | Int64 | |
IntervalIndex | Int64 | |
OutputQty | Double | Quantity produced during this shift, if this block interval type if processing. |
ShiftStart | DateTime | Start Date of the Capacity Interval. |
ShiftEnd | DateTime | End Date of the Capacity Interval. |
ShiftName | String | Name of the Capacity Interval. |
ShiftDescription | String | Description of the Capacity Interval. |
ShiftNbrOfPeople | Double | Number of people on the Capacity Interval. |
ShiftType | String | Type of the Capacity Interval (Normal Online, Occupied, Offline, Cleanout, Overtime, Reserved Online) |
SetupStart | DateTime | Start Date of the Setup segment of the block. |
SetupEnd | DateTime | End Date of the Setup segment of the block. |
RunStart | DateTime | Start Date of the Processing segment of the block. |
RunEnd | DateTime | End Date of the Processing segment of the block. |
PostProcessingStart | DateTime | Start Date of the PostProcessing segment of the block. |
PostProcessingEnd | DateTime | End Date of the PostProcessing segment of the block. |
ScheduledStart | DateTime | The start of the first segment, Setup, Processing or Post Processing. |
ScheduledEnd | DateTime | The end of the latest segment, PostProcessing, Processing, or Setup. |
JobMaterials
PublishDate | DateTime | Date when this record was published |
JobId | Int64 | |
ManufacturingOrderId | Int64 | |
OperationId | Int64 | |
MaterialRequirementId | Int64 | |
ExternalId | String | Identifier for external system references. |
AllocatedFor | Boolean | True if the Material is satisfied by from OnHand inventory only (and not expected inventory). |
AvailableDateTime | DateTime | When the material is expected to be available for use in production. The usage of this depends on the setting for Constraint Type. This is calculated automatically during reschedules for Material Requirements for stocked Items. This can be set externally for buy-direct materials. |
ConstraintType | String | Indicates whether the Material Requirement should prevent its Operation from starting before the material arrives. NonConstraint: Doesn’t have any affect on its Operation. ConstrainedByEarlierOfLeadTimeOrAvailableDate: In the case where there is no Item associated with the MaterialRequirement: The Operation can’t start until the earlier of the Material’s AvailableDate and Clock+LeadTimeSpan. In the case where there is an Item associated with the MaterialRequirement. The AvailableDate is determined by Inventory levels not the AvailableDate field within this class. So it’s the earlier of what can be supplied through inventory or the lead-time. ConstrainedByAvailableDate: In the case where there is no Item associated with the MaterialRequirement: Operation can’t start until the AvailableDate defined within this MaterialRequirement. In the case where there is an Item associated with the MaterialRequirement: Wait on Inventory. If no material becomes available before PurchaseToStocks and Tasks run out then use the LeadTime. |
IssuedComplete | Boolean | Whether the full Total Required Qty has been issued to the floor for the Job. If this value is true then the Material is considered available and is no longer treated as a constraint. |
IssuedQty | Double | Quantity of material that has been Issued to the Operation, physically removing the material from storage and delivering it to the floor for production. |
LeadTimeDays | Double | Minimum time span needed to procure the material. If the Constraint Type is ConstrainedByEarlierOfLeadTimeOrAvailableDate then the minimum of Available Date and Now + Lead Time is used as the constraint date. If the Constraint Type is ConstrainedByAvailableDate then the Available Date is used instead and Lead Time is only used if at the end of the scheduling process there is no supply. |
MaterialName | String | Name of the required material. This is the Name of the Item for stocked Items. For buy-direct Material Requirements this can be set externally. |
MaterialDescription | String | Description of the required material. This is the Description of the Item for stocked Items. For buy-direct Material Requirements this can be set externally. |
Source | String | Can be used to describe where this material is coming from. (‘Purchase Order XYZ’ or ‘from stock’, etc.) For stocked Items, this is set automatically. For buy-direct materials, this can be set externally. |
TotalCost | Decimal | Can be used in KPIs and simulation rules to calculate WIP cost. |
TotalRequiredQty | Double | The quantity of material to be consumed by the Operation for this requirement. The full quantity is required at the beginning of each Activity for it to be able to schedule to start. (If constraining by materials.) |
UOM | String | The measuring unit in which the quantity fields are specified. For information only. |
BuyDirect | Boolean | If True, this material requirement is not tied to inventory planning system. |
QtyFromLeadTime | Double | The total quantity of material that is scheduled to be satisfied from lead time (backorder) as opposed to coming from on-hand inventory or a planned supply. |
Available | Boolean | Don’t use this field for simulation purposes because it uses Datetime.Now. Indicates whether the material should be considered available at the current time. If Available then the Material Requirement is no longer a constraint. If the Available Date is in the past or the Material Requirement is Issued Complete the this value is set to true. Otherwise it is false. |
Planned | Boolean | True if the Supply of the material is from any combination of On-Hand inventory, Jobs, and Purchases. False if partially or fully satisfied from Lead Time. |
RequirementType | String | Whether material is being directly purchased for this requirement. In this case the material has no affect on Inventory and Inventory has no affect on when this MR is satisfied. |
Supply | String | This value is calculated automatically for Material Requirements for stocked Items when the Job is scheduled and rescheduled. It indicates the source of supply for the material. |
UseOverlapActivities | Boolean | Whether to allow this Material Request to depend on material from other Manufacturing Orders that haven’t completed yet but whose material is projected to arrive in stock on time to satisfy the cycles of the operation. This may allow the operation and other operations to start earlier. If this is not checked then this Material Request may end up waiting until the expected completion of Manufacturing Orders whose material is needed. |
UseOverlapPOs | Boolean | Whether to allow this Material Request to depend on material from Purchase Orders that haven’t arrived yet but whose material is projected to arrive in stock on time to satisfy the cycles of the operation. This may allow the operation and other operations to start earlier. If this is not checked then this Material Request may end up waiting until the expected receive date of Purchase Order whose material is needed. |
TankStorageReleaseTiming | String | If the material is drawn from a Tank Resource, these values can be used to indicate the timing of when the Tank is empty NotTank – Not expected to be drawn from a tank. AtActivityStart – Release the tank when the activity consuming the material starts. AtEndOfActivitySetup – Release the tank when the activity consuming the material has finished being setup. AtEndOfProcessing – Release the tank when the activity consuming the material has finished processing. AtEndOfPostProcessing – Release the tank when the activity consuming the material in the tanks has finished its post processing. |
MultipleWarehouseSupplyAllowed | Boolean | Whether material can be satisfied by inventory from more than one Warehouse. |
FixedQty | Boolean | If true TotalRequiredQty will not change if the RequiredQuantity of the Manufacturing Order is changed for any reason (MRP, Split, etc). |
ItemExternalId | String | The Item to be used as a material for the Operation. |
WarehouseExternalId | String | The Warehouse from which this material must be supplied. If omitted then the Material Requirement can be satisfied from any Warehouse accessible by the Plant of the Primary Resource performing the work. |
JobProducts
PublishDate | DateTime | Date when this record was published |
JobId | Int64 | |
ManufacturingOrderId | Int64 | |
OperationId | Int64 | |
ProductId | Int64 | |
TotalOutputQty | Double | The total amount of the specified Item to be made by the Operation. |
ItemId | Int64 | Id of the Item being produced. |
WarehouseId | Int64 | Id of the Warehouse the item is being produced to. |
ExternalId | String | Identifier for external system references. |
InventoryAvailableTiming | String | Controls when inventory that is created is considered available in stock for use by a consuming Material Requirement. AtOperationRunStart: All produced inventory is considered available at the schedule start of the Operation’s Run time. This can be used in situations where operations consuming the material should be allowed to schedule overlapping the operation producing the material. If Material Post-Processing Time is defined the release time is delayed by that time span. AtOperationResourcePostProcessingEnd: All produced inventory is considered available at the end of the Operation and any Resource Transfer time. BasedOnTransferQty: Material becomes available as it is produced in increments equal to its transfer quantity. Since a lot of extra booking keeping is involved in this type of timing, scheduling might take longer. The advantages to running in this mode include decreased lead-times and decreased inventory of intermediate items; this is known as material overlap. To run in material overlap mode use this setting, the item being produced must have a transfer quantity, material requests that use the item must set UseOverlapActivities (there’s a corresponding flag for POs) and if possible you should also consider staging the scheduling of your resources to improve your level of overlap. The stage field is available on resources. |
StoreInTank | Boolean | If true and the Resource it’s processed on is a Tank, the material will be stored in the Resource. |
SetWarehouseDuringMRP | Boolean | If true then during MRP the Warehouse is set to the Warehouse where the demand occurs (provided that the Item is stocked in the demand’s Warehouse). |
MaterialPostProcessingHrs | Double | This is similar to Operation.MaterialPostProcessing. It’s added to the time when product will become available to determine a new availability time. |
FixedQty | Boolean | If true TotalOutputQty will not change if the Required Quantity of the Manufacturing Order is changed for any reason (MRP, Split, etc). |
JobProductDeletedDemands
PublishDate | DateTime | Date when this record was published |
JobProductId | Int64 | Id of the Product that was created for a demand but then was deleted. |
JobOperationId | Int64 | Id of the Operation that Product belong to. |
RequiredDate | DateTime | Date of demand. |
RequiredQty | Double | Quantity that was satisfied by the product. |
Notes | String | Textual information about this supply/demand relation. |
Description | String | Textual information about this deleted supply/demand relation. |
DateDeleted | DateTime | Date the demand was deleted |
DeletedDemandId | Int64 | Id of the demand deleted. |
JobProductForecastDemands
PublishDate | DateTime | Date when this record was published |
JobProductId | Int64 | Id of the Product that was created to satisfy this Forecast demand. |
JobOperationId | Int64 | Id of the Operation the Product is associated with. |
ForecastShipmentId | Int64 | Id of the ForecastShipmentId that caused this product to be created. |
RequiredDate | DateTime | Date of the ForecastShipment demand. |
RequiredQty | Double | Quantity of the demand satisfied with by this Product. |
Notes | String | Textual information about this supply/demand relation. |
JobProductSalesOrderDemands
PublishDate | DateTime | Date when this record was published |
JobProductId | Int64 | Id of the Product that was created to satisfy this SalesOrder demand. |
JobOperationId | Int64 | Id of the Operation the Product is associated with. |
SalesOrderDistributionId | Int64 | Id of the SalesOrderDistribution that caused this product to be created. |
RequiredDate | DateTime | Date of the SalesOrder demand. |
RequiredQty | Double | Quantity of the demand satisfied with by this Product. |
Notes | String | Textual information about this supply/demand relation. |
JobProductSafetyStockDemands
PublishDate | DateTime | Date when this record was published |
JobProductId | Int64 | Id of the Product that was created to satisfy this Forecast demand. |
JobOperationId | Int64 | Id of the Operation the Product is associated with. |
InventoryId | Int64 | Id of the Inventory with SafetyStock level that caused this product to be created. |
RequiredDate | DateTime | Date of this demand (usually the clock for Safety stock demand). |
RequiredQty | Double | Quantity of the demand satisfied with by this Product. |
Notes | String | Textual information about this supply/demand relation. |
JobOperationAttributes
PublishDate | DateTime | Date when this record was published |
JobId | Int64 | If of the Job this Attribute belongs to. |
ManufacturingOrderId | Int64 | Id of the ManufacturingOrder this Attribute belongs to. |
OperationId | Int64 | Id of the Operation this Attribute belongs to. |
Name | String | Name of this Attribute. |
Description | String | Text for describing the Attribute. |
Code | String | The textual value that defines the Attribute. Can be used by Resource Attribute setup tables. |
Number | Double | A numeric value that defines the Attribute. Can be used by Resource’s setup and attribute number range tables. |
ColorCodeColorName | String | Name of the Attribute Color. |
ConsecutiveSetup | Boolean | The total setup time for an Operation is calculated as the sum of the maximum non-Consecutive setup time and the various Consecutive setup times. |
SetupHrs | Double | Setup hours incurred if activated |
SetupCost | Decimal | The time to perform the setup related to this Attribute. This is only used if not using Lookup tables. |
IncurSetupWhen | String | Specifies when to include a setup time and cost for the Attribute. |
ShowInGantt | Boolean | Whether to show this Attribute in Gantt View. |
ManualUpdateOnly | Boolean | Whether to update this attribute on the next import (usually set once attribute has been modified manually in order to prevent those modifications from being overriden). |
JobPaths
PublishDate | DateTime | Date when this record was published |
JobId | Int64 | Id of the Job this AlternatePath belongs to. |
ManufacturingOrderId | Int64 | Id of the ManufacturingOrder this AlternatePath belongs to. |
PathId | Int64 | Id of this AlternatePath. |
ExternalId | String | Identifier for external system references. |
Name | String | Name of this AlternatePath. |
Preference | Int32 | This values can be used in different ways by custom algorithms and serves as a visual indicator to the planner. |
AutoUse | String | This will determine when PlanetTogether will choose an Alternate Path Node to automatically use for the Operation flow. |
AutoUsePathReleaseOffsetDays | Double | A TimeSpan that defines when the path becomes eligible for automatic selection. The Alternate Path will not be used before the default path’s release date + AutoPathSelectionReleaseOffset. For instance if a ManufacturingOrder has 2 alternate paths and the Default Path’s release date is January 1 and the second AlternatePath is setup for AutoPathSection with AutoPathSelectionReleaseOffset=1 day. Then the second path could potentially be used on or after January 2nd. The path that ends up being selected will depend on your optimization rules and resource availability. This value isn’t used to determine the release date of the Default Path. |
JobPathNodes
PublishDate | DateTime | Date when this record was published |
JobId | Int64 | Id of the Job this AlternatePathNode belongs to. |
ManufacturingOrderId | Int64 | Id of the ManufacturingOrder this AlternatePathNode belongs to. |
PathId | Int64 | Id of the AlternatePath this AlternatePathNode belongs to. |
PredecessorOperationId | Int64 | Id of the Predecessor Operation defined in this AlternatePathNode. |
SuccessorOperationId | Int64 | Id of the Successor Operation defined in this AlternatePathNode. |
UsageQtyPerCycle | Double | The quantity of the Operation that is needed for each cycle of the Successor Operation. This is used for calculating when a Successor Activity can start in an overlap situations. |
MaxDelayHrs | Double | Total hours operation can be delayed after the end of predecessor |
TransferHrs | Double | Amount of time to move material from an Operation to its Successor. The successor cannot start until this time passes.This can be specified from the ERP system or be calculated using a customizable script. When used in combination with OverlapTransferSpan the affect is additive. For instance, if TransferSpan is 1 minute and OverlapTransferSpan is 0 minutes, then the successor operation won’t start until 1 minute after the predecessor. |
OverlapType | String | NotAllowed means the Predecessor must be finished. TransferQty means parts are transferred in groups of OverlapTransferQty to the successor operation. The successor will not be scheduled to start until enough material is available to allow it to run continuously. Overlap is currently supported for linear operations that have one activity. |
OverlapTransferHrs | Double | Successor Operations can start once the TransferSpan has passed (in calendar time) after the Operation’s Scheduled Run Start. When used in combination with OverlapTransferSpan the affect is additive. For instance, if TransferSpan is 1 minute and OverlapTransferSpan is 0 minutes, then the successor operation won’t start until 1 minute after the predecessor. |
OverlapPercentComplete | Double | If “Overlap Type” is set to “Percent Complete” then the predecessor operation will only constrain the successor operation up to this level of completion. To use this feature the predecessor operation must be set for Time Based Progress reporting and the activity must not be split. |
OverlapSetups | Boolean | Whether successors can start setting up before the setup is complete on this operation. |
AllowManualConnectorViolation | Boolean | If true then Operations can be moved to Resources that are invalid based on the predecessor Resources Connectors. This can be used to allow a tempoary violation which is Flagged thus giving the user more flexibility to manually reconcile as well as make exceptions. |
TransferDuringPredeccessorOnlineTime | Boolean | Whether the transfer time occurs during the predecessor operation’s primary resource online time. |
Reporting Objects
KPIs
PublishDate | DateTime | Date when this record was published |
CalculatorName | String | Name of the KPI |
CurrentValue | Double | Value calculated for this KPI at the time of publish |
CalculatorId | Int64 | Id of this KPI |
ReportBlocks
PublishDate | DateTime | Date when this record was published |
JobId | Int64 | Id of the Job this Block belongs to. |
ManufacturingOrderId | Int64 | Id of the ManufacturingOrder this Block belongs to. |
OperationId | Int64 | If of the Operation this Block belongs to. |
ActivityId | Int64 | Id of the Activity this Block belongs to. |
BlockId | Int64 | Id of this Block. A Block represents the work of one Resource on an Activity. |
PlantId | Int64 | Id of the Plant this Block is scheduled on. |
DepartmentId | Int64 | Id of the Department this Block is scheduled on. |
ResourceId | Int64 | Id of the Resource this Block is scheduled on. |
ScheduledStart | DateTime | Start date of this Block. |
ScheduledEnd | DateTime | End date of this Block. |
Locked | Boolean | Whether this Block is Locked to the Resource it is scheduled on (A Locked block will not schedule to a different Resource when Optimized). |
Sequence | Int64 | The 1-based index number of this block on it’s resource. |
RunNbr | Int64 | The 1-based index number of this block on it’s resource for the day it’s scheduled to start. |
ResourceRequirementID | Int64 | This is the index of the satisfied ResourceRequirement in the list of Operation ResourceRequirements. |
PlantName | String | Name of the Plant this Block is scheduled on. |
DepartmentName | String | Name of the Department this Block is scheduled on. |
ResourceName | String | Name of the Resource this Block is scheduled on. |
ResourceDescription | String | Description of the Resource this Block is scheduled on. |
SetupEnd | DateTime | When setup is scheduled to end. This value is meaningless if there is no setup scheduled. |
RunEnd | DateTime | The time at which the run portion of the activity is scheduled to finish. |
JobName | String | Name of the Job this Block belongs to. |
ManufacturingOrderName | String | Name of the ManufacturingOrder this Block belongs to. |
OperationName | String | Name of the Operation this Block belongs to. |
JobNeedDate | DateTime | NeedDate of the Job this Block belongs to. |
ActivityRequiredFinishQty | Double | RequiredFinishQty of the Activity this Block belongs to. |
Customer | String | CustomerName of the Job this Block belongs to. |
Priority | Int32 | Priority of the Job this Block belongs to. |
OperationNeedDate | DateTime | NeedDate of the Operation this Block belongs to. |
SetupCode | String | SetupCode of the Operation this Block belongs to. |
SetupHours | Double | The amount of time scheduled for setup. |
RunHours | Double | The amount of time scheduled for the processing stage. |
PostProcessingHours | Double | The amount of time scheduled for post processing. |
Duration | TimeSpan | The calendar time between the Scheduled Start and Scheduled End. |
Product | String | ProductName of the ManufacturingOrder this Block belongs to. |
JobDescription | String | ProductDescription of the ManufacturingOrder this Block belongs to. |
OperationDescription | String | Description of the Operation this Block belongs to. |
OtherResourcesUsed | String | List of Resources used besides the Resource used by the Block. |
SlackDays | Double | The amount of time that the Activity’s Scheduled End Date can be delayed and still be before the Operation NeedDate. |
ReportedGoodQty | Double | ReportedGoodQty of the Activity this Block belongs to. |
ReportedScrapQty | Double | ReportedScrapQty of the Activity this Bock belongs to. |
PercentFinished | Double | PercentFinished of the Activity this Bock belongs to. |
ProductionStatus | String | ProductionStatus of the Activity this Bock belongs to. |
ActivityLate | Boolean | Whether the Activity this Block belongs to is Late. |
Anchored | Boolean | Whether the Activity this Block belongs to is Anchored (Anchored means that the Activity will try to not move during Optimization). |
Materials | String | List of all Material Requirements for the Operation this Block belongs to. |
RequiredCapabilities | String | List of all required Capabilities of the Operation this Block belongs to. |
SetupNumber | Double | SetupNumber of the Operation this Block belongs to. |
OnHold | Boolean | Whether the Operation this Block belongs to is OnHold (Whether the Operation should not be worked on for some reason until the Hold Until Date). |
HoldReason | String | HoldReason of the Operation this Block belongs to. |
HoldUntil | DateTime | HoldUntil date of the Operation this Block belongs to. |
JobNotes | String | Notes of the Job this Block belongs to. |
OperationNotes | String | Notes of the Operation this Block belongs to. |
UOM | String | UOM of the Operation. |
StandardHours | Double | StandardHours of the Operation the Block belongs to (StandardHours is the standard number of work hours required to complete the Operation). |
OpAttributes | String | AttributeSummary of the Operation the Block belongs to. |
ReportedSetupHours | Double | ReportedSetupHours of the Operation the Block belongs to. |
ReportedRunHours | Double | ReportedRunHours of the Operation the Block belongs to. |
ReportedPostProcessingHours | Double | ReportedPostProcessingHours of the Operation the Block belongs to. |
NbrOfPeople | Double | NbrOfPeople of the Activity this Block belongs to. |
ActivityComments | String | Comments of the Activity this Block belongs to. |
ActivityComments2 | String | Comments2 of the Activity this Block belongs to. |
JitStartDate | DateTime | The JitStartDate of the Activity this Block belongs to (JitStartDate is the latest the Activity can start on this resource and still finish by the Operation NeedDate). |
Schedules
PublishDate | DateTime | Date when this record was published |
ScenarioId | Int64 | Id of the Scenario published. |
ScenarioName | String | Name of the Scenario published. |
ScenarioDescription | String | Description of the Scenario published. |
PublisherUserId | Int64 | Id of the User who initiated the publish. |
PublishedEntireSchedule | Boolean | Meaningless: At the moment this is always set to false. |
Clock | DateTime | Clock date of the Scenario published. |
PublishHorizonEnd | DateTime | The cut off date for published data. Only Activities starting before this date are published. |
ScenarioType | String | Type of the Scenario published (Live, Published, What-If, CoPilot, InsertJobs). |
LastSchedulePublished | Boolean | Whether this is the most recent Scenario published. |
LastLiveSchedulePublished | Boolean | Whether this is the most recent Live Scenario published. |
LastWhatIfSchedulePublished | Boolean | Whether this is the most recent What-if Scenario published. |
LastPublishedSchedulePublished | Boolean | Whether this is the most recent Published Scenario published. |
LastNetChangeLiveSchedulePublished | Boolean | Whether this is the most recent net-change Live Scenario published. |
LastNetChangePublishedSchedulePublished | Boolean | Whether this is the most recent net-change Published Scenario published. |
LastPublishForScenario | Boolean | Whether this is the most recent version of a particular Scenario published. |
PlanningHorizonEnd | DateTime | End date of the Planning horizon (Clock + length of the Planning Horizon) |