Data Object and Field Reference

English | 简体中文

Applies to DecisioWorks v1.4.0. Current templates and validators remain authoritative for type and required-field rules.

Data-object and field reference

The standardized data interface models business objects and relationships before source-system columns. This page explains the main fields. Check types, nullability, and defaults against the template version in use. A field being present, a relationship being valid, a model applying it, and a run obtaining a feasible solution are different findings.

Time, demand, and products

See the complete field reference for every field's definition, type and nullability, and the Standardized Data Interface Guide for semantics and configuration exercises. This page remains a quick reference for commonly used fields.

Object.field	Meaning	Validation
time_unit.id	Time-unit identifier	Referenced by due dates, capacity, material availability, and results
time_unit.offset	Sequence offset relative to the planning origin	Separate from the primary key; differences between IDs are not elapsed minutes
time_unit.scale	Time-unit duration in seconds	An hour is 3,600 seconds; define the shift behind a working-day window
time_unit.status	1 normally available, 0 unavailable, -1 special or optional	The planning configuration defines whether optional periods are used
product.code/name	Stable product identity	Code remains stable within a scenario
product.property_1..3	Mapped business attributes	Define color, model, mold, family, or another real meaning
order_info.priority	Order-header priority	Does not replace line-item due dates or rules
order_item.product	Demanded product	Resolves to product
order_item.delivery_time	Due time unit	Resolves to time_unit
order_item.number	Demand quantity	Valid nonnegative business quantity
order_info.created_at	Order creation timestamp	Preserve the source timestamp rather than using it as the due-period reference
product.vin	Unique code of the finished item to which the product belongs	Express assembly quantities and material consumption separately

The attribute mechanism supports additional dimensions. property_1..3 are three instances in the current template and reference attribute records rather than directly storing labels such as a color. name/code/value/is_key specify name, code, value, and key-attribute status. When a rule uses an attribute, confirm that it has been loaded and mapped.

Routing and capacity

Object.field	Meaning	Validation
process_route.product	Product owning the route	Supports one or more candidate routes
process.route	Route owning the operation	Resolves to a valid route
process.operation_number	Operation identifier within a route	Unique within that route, separate from execution order
process.seqno	Operation sequence value	Equal values impose no precedence by themselves; parallel execution also depends on resources and other conditions
process_adaptor.process/workcenter	Executable resource mapping	Connects an operation to a work center
process_adaptor.productivity	Output per cycle for discrete processing; output per unit time for continuous processing	Define units such as pieces/cycle or liters/hour and the capability's interpretation
process_adaptor.processing_time/setup_time	Standard processing duration / process changeover duration	The current interface uses seconds; define initial preparation and repeated changeovers without double counting
process_adaptor.batch_size	Output quantity processed as a batch	For discrete processing, an integer multiple of output per cycle; demand need not already be a whole batch
process_adaptor.OEE	Overall equipment effectiveness	The current template defaults to 100 as a percentage; identify where the loss is applied
process_adaptor.wip_buffer_size	Work-in-process buffer capacity	Define its unit, default, and actual model interpretation
process_adaptor.binding	Joint-processing relationship	Distinct from shared-resource contention and material dependencies
capacity.used	Occupied or unavailable fraction, including maintenance accounted for on that basis	From 0 to 1; not utilization calculated from the new plan
workcenter.parallelism/station_count	Parallel capacity and station count	Avoid counting capacity twice
workcenter.parent_id	Parent work center	Supports hierarchy, attribute inheritance, rules at different levels, and aggregate analysis, without creating extra capacity
workcenter.equipping_time	Resource configuration or preparation time	Define its accounting scope separately from process changeover time
shared_resource.binding/to	Shared-resource work center / work center depending on it	A shared resource has its own calendar; multiple dependency links do not create multiple copies of its capacity

The complete capacity expression is scale×(1−used)×|status|. For normal periods it simplifies to scale×(1−used). Optional periods retain an availability quantity, while planning policy determines whether to use them. Choose time granularity for the planning level and execution need, balancing precision, computational size, and adjustment flexibility.

Operation-level material and kitting

Object.field	Meaning	Validation
ingredient.process	Consuming operation	The key operation-level BOM relationship
ingredient.material	Required material	Resolves to a material record
ingredient.number	Material consumption per declared unit of operation output	Multiply by output quantity, not processing-cycle count
kitting_information.time_unit	Material-availability time	Uses the same time coordinate as the plan
kitting_information.number	Ready or available quantity at a time point	Map period increments, cumulative supply, and stock balances explicitly for the selected execution chain
material.substitute	Substitution relationship	Confirm its scope and selection priority
material.binding	Material dependency or coordinated selection	Explain separately from substitution groups
material.vendor/extend	Supplier / reserved extension information	extend may represent supplier priority; it is not inherently a foreign key
inventory_limit.upper_bound_acc/lower_bound_acc	Cumulative receipt quantity bounds	Derived from opening stock, flows, and storage requirements, not closing inventory balances
inventory_limit.binding/urgency	Shared-inventory marker / urgency	Define common units, capacity allocation, and priority rules

Results

planning_result uses workcenter, time_unit, process, and number for operation-level results. number is output quantity, not a processing-cycle count. Adding outputs across operations does not establish finished-product delivery. value_1..3 are reserved fields; cycle number and position within a cycle are example interpretations.

The demonstration page's current-run result starts empty and updates after solving. A sample database may contain historical results, which must not be presented as a new run. Standardized results can inform the next input. Default dispatch preserves the source business database and uses separate result output; an explicitly configured write-back should preserve data and result versions.

Minimum Relationship Checks

Demanded products exist; products have routes; operation order is valid; operations have executable work centers. When material constraints are enabled, operation requirements link to the relevant materials and times. All time and quantity units are explicit. Map differing source names without changing field meanings to fit a scenario.

See the Glossary for common terms and the Standardized Data Interface for configuration relationships.