Demo Data for Skateboard Manufacturing

Introduction

Imagine you're setting up a production process to manufacture skateboards, each one built from components like decks, transfer, stickers, and more. Apache OFBiz makes this possible through its powerful Manufacturing module, which supports everything from defining product structures to tracking finished goods through production runs.

In Apache OFBiz, a production run is what many manufacturing systems refer to as a work order, a formal instruction to produce a specific quantity of a product using defined materials and processes. But for developers and business analysts alike, the real challenge often lies beneath the surface, understanding how the data flows behind these processes.

This guide is designed to help you do just that. It explains the core data model that powers manufacturing in Apache OFBiz. You’ll learn how products, Bills of Materials (BOMs), routing tasks, and production runs are structured and connected. By exploring real-world examples and key entities, this guide demystifies how Apache OFBiz represents manufacturing data internally, so you can customize it more confidently and align it with your specific business needs.

Whether you're configuring a new setup or troubleshooting an existing one, this documentation will give you a clear view into how manufacturing data is organized and used in Apache OFBiz.

Key Terms

Understanding the following entities is essential when working with manufacturing data in Apache OFBiz:

• Product
  Represents any item in the system either a finished good or a raw material. Each product is uniquely identified by a productId.
  
  
• ProductAssoc
  Defines relationships between products. It’s commonly used to link a finished product to its components, forming the structure of a Bill of Materials (BOM).
  
  
• WorkEffort
  Represents a task or activity. In the manufacturing module, it’s used to define routing tasks or an entire production run (work order). Each step in the process is stored as a separate WorkEffort record.
  
  
• WorkEffortInventoryAssign
  Links inventory items (raw materials or components) to specific WorkEffort tasks. This shows which materials are consumed during which step of the production process.
  
  
• WorkEffortInventoryProduced
  Records the finished goods created from a production run. It connects the output product to the task that produced it, enabling inventory tracking.
  
  
• WorkEffortGoodStandard: Defines the standard relationship between a work effort (routing or production run) and the product it consumes or produces. It specifies whether the product is an input (PRUNT_PROD_NEEDED) or output (PRUN_PROD_DELIV).
  
  

Prerequisites

Before starting, ensure you have a working Apache OFBiz instance with the Manufacturing module enabled. The module relies on entities defined in the Apache OFBiz framework, such as Product and WorkEffort. Loading the demo data provides sample products and configurations to follow this example.

Developer Notes

• Apache OFBiz Setup: Use the latest Apache OFBiz version (e.g., trunk or stable release) with Java 17 SDK, as outlined in the Apache OFBiz Technical Production Setup Guide. The demo data includes pre-configured entities required for manufacturing.
• Entity Engine: Apache OFBiz’s Entity Engine manages data persistence via XML-defined entities (e.g., entitymodel.xml in framework/entity). Key entities for manufacturing include Product, ProductAssoc, and WorkEffort.
• Accessing the Manufacturing Module: Log in to the Apache OFBiz web application (e.g., https://your-ofbiz-instance/manufacturing) using default admin credentials (user: admin, password: ofbiz). Change these credentials in production for security.
  

1. Defining the Product 

To assemble a Skateboard in Apache OFBiz, define its components using the Product and ProductAssoc entities. The Skateboard (STC1005) comprises components like Sticker, Warranty Card, Transfer, and Deck (a sub-assembly composed of Glue, Face, Ply, and Core), modeled as a Bill of Materials (BOM). The table below outlines the product hierarchy, with BOM Level indicating the hierarchy (0 for the final product, 1 for direct components, 2 for sub-components of the Deck).

1.1 Steps to Define the Product Components

Note: These steps are intended for developers or individuals familiar with Apache OFBiz.

To understand the basic concept and steps for setting up a Bill of Material (BOM), please refer to this introductory document.

1. Create the Main Product:
   In the Catalog Manager (e.g., https://your-ofbiz-instance/catalog/control/EditProduct), create a product for the Skateboard (productId: STC1005, productTypeId: FINISHED_GOOD).
   
   
2. Create Component Products:
   Define components as products (e.g., Sticker, Warranty Card, Transfer, Deck, Glue, Face, Ply, Core) with productTypeId set to RAW_MATERIAL, except for Deck (FINISHED_GOOD). Refer to the table above for details.
   
   
3. Define the Bill of Materials (BOM):
   Use the ProductAssoc entity to define BOM relationships, linking components to the Skateboard and Deck with productAssocTypeId: MANUF_COMPONENT and quantity: 1, as shown in the XML below.
   
   

1.2 Sample Data for Product and BOM

This XML data is generated after Step 4.5 of the Skateboard BOM setup in Apache OFBiz.

1.3 Developer Notes

• Entity Relationships: The ProductAssoc entity defines BOM relationships with productAssocTypeId=MANUF_COMPONENT. Check entitymodel.xml in applications/product/entitydef for definitions.
• Data Import: Use WebTools (e.g., https://your-ofbiz-instance/webtools/control/EntityImport) to import the XML snippet, populating the Product and ProductAssoc tables.

1.4 Entity Field Descriptions

<Product>

Defines a product, sub-assembly, or raw material.

• productId: Unique product identifier given to each product.
• productTypeId: Type of product for each product like product is Raw material or Finished Good  (FINISHED_GOOD, RAW_MATERIAL).
• internalName: This name is used within the company for internal purposes. Some business uses two different name, to show the product name like ply and internal name = plyboard
• productName: Display name for the end user.
• isVirtual: Indicates whether the product is a virtual (template) product used to group feature-based variants (Y for virtual, N for regular or variant products).
• isVariant: Indicates whether the product is a variant tied to a virtual product (Y for variant, N for standalone or virtual products).).
  
  

<ProductAssoc>

Defines component relationships used in the Bill of Materials (BOM).

• productId: Parent product being assembled.
• productIdTo: Component used in the parent product.
• productAssocTypeId: Type of relationship (MANUF_COMPONENT for BOM). 
• MANUF_COMPONENT: This product is a component used in the manufacture of another product.
• fromDate: Start date of the association.
• quantity: Quantity of the component used.

2. Configuring Manufacturing Routing & Tasks

Note: These steps are intended for developers or individuals familiar with Apache OFBiz.

To understand the basic concept and steps for routing and routing tasks in Apache OFBiz , please refer to this introductory document.

Apache OFBiz supports multi-level routings, allowing complex manufacturing flows to be broken into parent-child routing processes. This section sets up two routings:

• Skateboard Final Assembly (STC1000): For the final Skateboard assembly.
• Deck Sub-Assembly (STC1002): For the Deck sub-assembly.

2.1 Routing Process

2.2 Routing and Routing Tasks in XML

This data is generated after Step 4.2 of setting up of routing in the Apache OFBiz.

2.3 Explanation of the Process

• STC1000: Top-level routing for the Skateboard final assembly, including the Final Assembly task (STC1001).
• STC1002: Routing for the Deck sub-assembly, including sequential tasks Lamination (STC1003) and Shape Deck (STC1004).
• Each routing uses WorkEffortAssoc with ROUTING_COMPONENT to maintain the correct sequence of operations.
• This process supports nesting: STC1002 can be linked as a sub-routing in a larger production run if needed.

2.4 Developer Notes

• Routing Configuration: Routings are defined using WorkEffort entities with workEffortTypeId=ROUTING and tasks with workEffortTypeId=ROU_TASK.
• Sequence Control: The sequenceNum attribute in WorkEffortAssoc determines task order.

2.5 Entity Field Descriptions

<WorkEffort>

      Defines a routing or task used in the manufacturing process.

• workEffortId: Unique identifier for the routing or task.
• workEffortTypeId: Type of work (ROUTING for a group of tasks, ROU_TASK for individual tasks).
• currentStatusId: Status of the work effort (ROU_ACTIVE means active).
• workEffortPurposeTypeId: Purpose of the task (e.g., ROU_MANUFACTURING for production tasks).
• workEffortName: Name or description of the routing or task.
  
  

<WorkEffortAssoc>

      Defines the sequence and association between routing and its tasks.

• workEffortIdFrom: Parent routing (group of tasks).
• workEffortIdTo: Linked task within the routing.
• workEffortAssocTypeId: Type of association (ROUTING_COMPONENT means the task is part of the routing).
• sequenceNum: Execution order of the task within the routing.
• fromDate: Start date of this association.
  
  

<WorkEffortGoodStandard>

      Links a routing to a specific product.

• workEffortId: The routing linked to the product.
• productId: Product manufactured using this routing.
• workEffortGoodStdTypeId: Role of this link (ROU_PROD_TEMPLATE specifies it's a routing template for the product).
• fromDate: Effective date of the link.

3. Creating and Executing Production Runs

Note: Refer to this guide to understand the steps involved in executing a Production Run in Apache OFBiz.

A Production Run models the manufacturing process based on a routing, containing a Production Run Header (PROD_ORDER_HEADER) and Production Run Tasks (PROD_ORDER_TASK). Each run records scheduling, quantities, and execution details.

3.1 Overview of Production Runs

3.2 Demo Data: Production Run & Task Execution

This data is generated after Step 3.9 of executing the production run in Apache OFBiz.

3.3 Breakdown & Interpretation

• Production Runs (PROD_ORDER_HEADER):
• 10000: Handles Deck Sub-Assembly.
• 10003: Handles Skateboard Final Assembly.
• Tasks (PROD_ORDER_TASK):
• 10001 and 10002: Lamination and Shape Deck tasks for Deck Sub-Assembly.
• 10004: Final Assembly task for Skateboard Final Assembly.
• Execution Tracking:
• Each task and run records estimated and actual timestamps.
• quantityProduced reflects the completion of 100 units in each step.
• All tasks and runs are in PRUN_COMPLETED status.

3.4 Developer Notes

• Routing-Based Generation: Routing tasks in Production runs are typically auto-generated from routings defined in Section 2.
• Task Sequencing: Controlled by the priority attribute within each run.
• Traceability: actualStartDate and actualCompletionDate provide precise execution logs.
• Facility-Level Control: All production runs occur at WebStoreWarehouse.
• Revision Tracking: The revisionNumber tracks updates to the production run configuration, incrementing with each change.

3.5 Entity Field Descriptions

<WorkEffort>

     Defines a production run or its tasks.

• workEffortId: Unique ID for the production run or task.
• workEffortTypeId:
• PROD_ORDER_HEADER: Production run header (overall job).
• PROD_ORDER_TASK: Individual task within the run.
• currentStatusId: Current status of the run or task (PRUN_CREATED, PRUN_RUNNING, PRUN_COMPLETED, etc.).
• workEffortPurposeTypeId: Purpose of work (WEPT_PRODUCTION_RUN for production-related efforts).
• workEffortParentId: Links task to its parent production run.
• workEffortName: Name of the run or task.
• priority: Execution order for tasks (used in scheduling).
• estimatedStartDate / estimatedCompletionDate: Planned start and end time.
• actualStartDate / actualCompletionDate: Actual start and completion time.
• facilityId: Location where the run takes place.
• quantityToProduce: Planned quantity to be produced.
• quantityProduced: Actual quantity produced (used in tasks).
• revisionNumber: Version number of the production plan.

<WorkEffortStatus>

      Tracks status changes over time.

• workEffortId: Refers to a specific production run or task.
• statusId: Status type (e.g., PRUN_CREATED, PRUN_RUNNING, PRUN_COMPLETED).
• statusDatetime: Timestamp of status change.

<WorkEffortGoodStandard>

      Defines the inputs and outputs of a production run or task.

• workEffortId: Associated run or task.
• productId: Product involved (produced or consumed).
• workEffortGoodStdTypeId:
• PRUN_PROD_DELIV: Product delivered (output).
• PRUNT_PROD_NEEDED: Raw material/component needed (input).
• fromDate: Effective start date of the association.
• statusId: Status of the material usage (WEGS_CREATED, WEGS_COMPLETED).
• estimatedQuantity: Quantity required or produced.
  
  

3.6 Production Run Statuses 

4. Issuing Raw Materials to Production Tasks

The WorkEffortInventoryAssign entity links inventory items (inventoryItemId) to production tasks (workEffortId), recording material consumption for accurate inventory tracking and cost calculations.

4.1 Example: Material Assignment for Skateboard Production

4.2 Inventory Assignment Summary

4.3 Developer Notes

• Inventory Availability: Inventory items must exist and be available before assignment.
• Task-Level Assignment: Material assignments are linked to individual tasks (PROD_ORDER_TASK), not the production run header (PROD_ORDER_HEADER).
• Inventory Management: Assigned quantities are consumed based on task execution status.

4.4 Entity Field Descriptions

<WorkEffortInventoryAssign>

Links a specific production task to the inventory items it consumes during execution.

• workEffortId: ID of the production task (PROD_ORDER_TASK) using the inventory.
• inventoryItemId: ID of the inventory item consumed in the task.
• quantity: Quantity of the item assigned for use in the task.

5. Receiving Finished Goods into Inventory

The WorkEffortInventoryProduced entity links a completed production run (workEffortId) to the produced inventory item (inventoryItemId), formally recognizing the addition of finished goods to stock.

5.1 Example: Finished Goods Receipt for Skateboard

This XML data is generated after Step 3.10 of executing the production run in Apache OFBiz.

5.2 Key Interpretation

• inventoryItemId="10009" represents the finished Skateboard, now available in stock for shipping, sale, or reservation.

5.3 Developer Notes

• Automatic Creation: This record is typically auto-created upon production run completion.
• Inventory Setup: The inventory item (10009) must be configured with productId, location, and quantity.
• Traceability: Combined with WorkEffortInventoryAssign, this provides a complete trace from component consumption to task execution to finished goods creation.

5.4 Entity Field Descriptions

<WorkEffortInventoryProduced>

      Links a completed production run to the inventory item it has produced.

• workEffortId: ID of the production run (PROD_ORDER_HEADER) that generated the inventory.
  
• inventoryItemId: ID of the inventory item created as a result of the production run.

6. Conclusion

This guide showcased the demo data required to simulate a complete production process in Apache OFBiz. Rather than walking through each configuration step, it focused on presenting the essential data setup, including product definitions, Bills of Materials (BOM), routings, and routing tasks needed before a production run can begin.

It then demonstrated the execution phase using this demo data: creating a production run, approving it, issuing components to specific tasks, and completing the run to generate finished inventory.

By understanding how this demo data connects across the manufacturing module, both developers and business analysts can gain clarity on the underlying Apache OFBIz data model. This insight not only helps in setting up meaningful demo environments, but also lays the groundwork for customizing and extending the system to match real-world manufacturing workflows.

Whether you're validating a configuration, preparing a demo, or planning a live deployment, this data-centric walkthrough provides a solid foundation for working with the Apache OFBiz Manufacturing module.