Production Overview

Overview

• What you’ll learn:
  • How to define Bills of Materials (BOMs) using MPPProductBOM and MPPProductBOMLine, including BOM types, BOM use, and phantom assemblies
  • How to create and configure MProduction documents, including setting products, quantities, locators, and movement dates
  • How production lines are automatically generated from BOMs via the createLines() method, including the difference between end-product lines and component consumption lines
  • How the DocAction workflow drives production documents from Draft through Completion, triggering inventory transactions
• Prerequisites: Familiarity with iDempiere product management, warehouses, and basic document processing (Lessons 1–23)
• Estimated reading time: 20 minutes

Introduction

Production is the process of transforming raw materials and components into finished goods. For companies that produce their own products — whether assembling electronics, fabricating metal parts, mixing chemicals, or packaging food — an ERP production module is essential for planning, executing, and costing production activities.

iDempiere provides a robust production system through the MProduction model class. This system integrates with Bills of Materials (BOMs) to automatically calculate component requirements, generates inventory transactions upon completion, and follows the standard DocAction document workflow. In this lesson, we focus on the foundational concepts: BOM definition, production order creation, line generation, and the completion workflow.

Bills of Materials (BOM)

A Bill of Materials is the recipe for producing a product. It lists every component, sub-assembly, and raw material needed, along with the required quantities. In iDempiere, BOMs are managed through MPPProductBOM (the header) and MPPProductBOMLine (the components), both in the org.eevolution.model package.

Historical note: The original Compiere/ADempiere used M_Product_BOM (a flat table, one BOM per product). In iDempiere 9 (IDEMPIERE-1250), the PP_Product_BOM tables from the Libero Manufacturing module were integrated into core, enabling multiple BOMs per product. The old M_Product_BOM table now exists as a database VIEW for backward compatibility, and the MProductBOM class is marked @Deprecated.

BOM Header (MPPProductBOM)

The BOM header ties a BOM definition to a specific finished product. Key fields include:

A product can have multiple BOMs. The system uses MPPProductBOM.getDefault(product, trxName) to retrieve the master BOM (BOMUse=’A’, BOMType=’A’).

BOM Lines (MPPProductBOMLine)

Each BOM line represents a single component:

Phantom Assemblies

A phantom assembly is a sub-assembly that exists in the BOM for organizational purposes but is never physically stocked. When the system encounters a component with ComponentType = 'Phantom' during production line generation, it expands through the phantom’s own BOM and includes the phantom’s components directly. This simplifies complex BOMs — you define a sub-assembly BOM once and reference it from multiple parent BOMs without creating separate production orders for the sub-assembly.

Note: “Phantom” exists at three levels in iDempiere:

• Product level: MProduct.isPhantom() — a boolean on M_Product marking the product itself as a virtual sub-assembly (typically isStocked() = false).
• BOM line level: PP_Product_BOMLine.ComponentType = 'PH' — tells MRP/production to expand this line into the sub-assembly’s own BOM components. Check via MPPProductBOMLine.COMPONENTTYPE_Phantom.equals(line.getComponentType()).
• BOM header level: PP_Product_BOM.BOMUse = 'D' (Phantom/Disassemble) — classifies the entire BOM’s purpose.

In practice, a phantom BOM line typically references a product that is also marked IsPhantom = Y, but they are stored independently on different tables.

Creating a BOM with Java API

import org.eevolution.model.MPPProductBOM;
import org.eevolution.model.MPPProductBOMLine;

// Create a BOM header for a finished product
MPPProductBOM bom = new MPPProductBOM(ctx, 0, trxName);
bom.setM_Product_ID(finishedProductId);
bom.setName("Standard Assembly BOM");
bom.setValue("STD-ASSY-001");
bom.setBOMType(MPPProductBOM.BOMTYPE_CurrentActive);    // 'A'
bom.setBOMUse(MPPProductBOM.BOMUSE_Manufacturing);       // 'A'
bom.saveEx();

// Add a regular component: Frame, qty = 1
MPPProductBOMLine line1 = new MPPProductBOMLine(bom);
line1.setM_Product_ID(frameProductId);
line1.setQtyBOM(new BigDecimal("1"));
line1.setLine(10);
line1.saveEx();

// Add a phantom sub-assembly: Motor Assembly
MPPProductBOMLine line2 = new MPPProductBOMLine(bom);
line2.setM_Product_ID(motorAssemblyProductId);
line2.setQtyBOM(new BigDecimal("1"));
line2.setComponentType(MPPProductBOMLine.COMPONENTTYPE_Phantom);  // Will be expanded during production
line2.setLine(20);
line2.saveEx();

// Add a regular component: Cover Panel, qty = 4
MPPProductBOMLine line3 = new MPPProductBOMLine(bom);
line3.setM_Product_ID(coverPanelProductId);
line3.setQtyBOM(new BigDecimal("4"));
line3.setLine(30);
line3.saveEx();

MProduction: The Production Document

The MProduction class represents a production order. It implements DocAction, meaning it follows the standard iDempiere document workflow (Draft → In Progress → Complete). The production document ties together a finished product, a production quantity, a warehouse locator, and the BOM to use.

Key Fields

Creating a Production Order

// Create a new production order
MProduction production = new MProduction(ctx, 0, trxName);
production.setAD_Org_ID(orgId);
production.setM_Product_ID(finishedProductId);
production.setProductionQty(new BigDecimal("10"));
production.setM_Locator_ID(locatorId);
production.setMovementDate(new Timestamp(System.currentTimeMillis()));
production.saveEx();

System.out.println("Production created: " + production.getDocumentNo());

Production Line Generation

After creating the production header, you must generate the production lines. The createLines() method reads the BOM and creates one line per component, plus a line for the finished product (the end product line).

How createLines() Works

1. End Product Line: A line is created for the finished product with a positive MovementQty (goods being received into inventory) and IsEndProduct = true.
2. Component Lines: For each BOM line, a line is created with a negative MovementQty (materials being consumed from inventory). The quantity is calculated as QtyBOM × ProductionQty.
3. Phantom Expansion: If a BOM component is a phantom, the system recursively expands through the phantom’s BOM and creates lines for its individual components instead.
4. Inventory Allocation: For stocked components, the system queries MStorageOnHand to find available inventory and may create multiple lines per component if the stock is spread across different locators or attribute set instances.

// Generate production lines from BOM
MProduction production = new MProduction(ctx, productionId, trxName);
int lineCount = production.createLines(false);  // false = don't require all stock on hand
production.setIsCreated("Y");
production.saveEx();

System.out.println("Created " + lineCount + " production lines");

// Inspect the generated lines
MProductionLine[] lines = production.getLines();
for (MProductionLine line : lines) {
    String type = line.isEndProduct() ? "END PRODUCT" : "COMPONENT";
    System.out.println(type + ": " + line.getM_Product_ID()
        + " qty=" + line.getMovementQty());
}
// Expected output for a product with 3 BOM components (qty=10):
//   END PRODUCT: [finished] qty=10
//   COMPONENT: [frame] qty=-10
//   COMPONENT: [motor] qty=-10
//   COMPONENT: [cover] qty=-40

DocAction Workflow: Completing a Production

Like all iDempiere documents, MProduction follows the DocAction workflow. The key transitions are:

Document Status Flow

Draft (DR) → In Progress (IP) → Complete (CO) → Closed (CL)
                                    ↓
                              Reversed (RE) ← Void (VO)

prepareIt() — Validation

When you call prepareIt(), the system validates:

• Production lines exist and are properly configured
• At least one end-product line is present
• The movement date is within an open accounting period
• Component costs are valid (for standard costing)

completeIt() — Execution

When completeIt() runs, the system:

• Creates MTransaction records for each production line (P+ for production receipt, P- for consumption)
• Updates MStorageOnHand quantities — decreasing component inventory and increasing finished product inventory
• Processes MProductionLineMA records for lot/serial tracking
• Triggers accounting entries for the material movements

// Complete the production order
MProduction production = new MProduction(ctx, productionId, trxName);

// Step 1: Prepare — validates lines, periods, costs
String status = production.prepareIt();
if (!DocAction.STATUS_InProgress.equals(status)) {
    throw new AdempiereException("Prepare failed: " + production.getProcessMsg());
}

// Step 2: Complete — creates transactions, updates inventory
status = production.completeIt();
if (!DocAction.STATUS_Completed.equals(status)) {
    throw new AdempiereException("Complete failed: " + production.getProcessMsg());
}
production.saveEx();

System.out.println("Production " + production.getDocumentNo() + " completed");
// At this point:
//   - Component inventory has decreased
//   - Finished product inventory has increased
//   - M_Transaction records have been created
//   - Accounting entries are posted

Full Production Workflow Example

// Complete workflow: Create → Generate Lines → Complete
MProduction production = new MProduction(ctx, 0, trxName);
production.setAD_Org_ID(orgId);
production.setM_Product_ID(finishedProductId);
production.setProductionQty(new BigDecimal("10"));
production.setM_Locator_ID(locatorId);
production.setMovementDate(new Timestamp(System.currentTimeMillis()));
production.saveEx();

// Generate lines from BOM
production.createLines(false);
production.setIsCreated("Y");
production.saveEx();

// Prepare and complete
if (!production.processIt(DocAction.ACTION_Complete)) {
    throw new AdempiereException("Failed: " + production.getProcessMsg());
}
production.saveEx();

System.out.println("Production " + production.getDocumentNo()
    + " status: " + production.getDocStatus());

Key Takeaways

• Bills of Materials are defined using MPPProductBOM (header) and MPPProductBOMLine (components). Each BOM has a type, use, and validity period. Use MPPProductBOM.getDefault() to retrieve the master BOM.
• MProduction is the production document that ties together a product, quantity, locator, and BOM. It implements the DocAction interface for standard document workflow.
• Production Lines are generated via createLines(), which reads the BOM and creates end-product lines (positive qty) and component lines (negative qty). Phantom assemblies are automatically expanded.
• DocAction Workflow drives the production from Draft through Completion. prepareIt() validates the document, and completeIt() creates inventory transactions and updates on-hand quantities.
• Phantom BOMs allow you to organize complex product structures without stocking intermediate sub-assemblies. During line generation, phantoms are recursively expanded into their leaf components.

What’s Next

Now that you understand BOM definition and production order management, the next lesson — Inventory & Warehouse Management — covers how iDempiere manages warehouses, locators, on-hand inventory, and inter-warehouse inventory transfers using the MMovement API.

import org.eevolution.model.MPPProductBOM;
import org.eevolution.model.MPPProductBOMLine;

// Create a BOM header for a finished product
MPPProductBOM bom = new MPPProductBOM(ctx, 0, trxName);
bom.setM_Product_ID(finishedProductId);
bom.setName("Standard Assembly BOM");
bom.setValue("STD-ASSY-001");
bom.setBOMType(MPPProductBOM.BOMTYPE_CurrentActive);    // 'A'
bom.setBOMUse(MPPProductBOM.BOMUSE_Manufacturing);       // 'A'
bom.saveEx();

// Add a regular component: Frame, qty = 1
MPPProductBOMLine line1 = new MPPProductBOMLine(bom);
line1.setM_Product_ID(frameProductId);
line1.setQtyBOM(new BigDecimal("1"));
line1.setLine(10);
line1.saveEx();

// Add a phantom sub-assembly: Motor Assembly
MPPProductBOMLine line2 = new MPPProductBOMLine(bom);
line2.setM_Product_ID(motorAssemblyProductId);
line2.setQtyBOM(new BigDecimal("1"));
line2.setComponentType(MPPProductBOMLine.COMPONENTTYPE_Phantom);  // Will be expanded during production
line2.setLine(20);
line2.saveEx();

// Add a regular component: Cover Panel, qty = 4
MPPProductBOMLine line3 = new MPPProductBOMLine(bom);
line3.setM_Product_ID(coverPanelProductId);
line3.setQtyBOM(new BigDecimal("4"));
line3.setLine(30);
line3.saveEx();

// Create a new production order
MProduction production = new MProduction(ctx, 0, trxName);
production.setAD_Org_ID(orgId);
production.setM_Product_ID(finishedProductId);
production.setProductionQty(new BigDecimal("10"));
production.setM_Locator_ID(locatorId);
production.setMovementDate(new Timestamp(System.currentTimeMillis()));
production.saveEx();

System.out.println("Production created: " + production.getDocumentNo());

// Generate production lines from BOM
MProduction production = new MProduction(ctx, productionId, trxName);
int lineCount = production.createLines(false);  // false = don't require all stock on hand
production.setIsCreated("Y");
production.saveEx();

System.out.println("Created " + lineCount + " production lines");

// Inspect the generated lines
MProductionLine[] lines = production.getLines();
for (MProductionLine line : lines) {
    String type = line.isEndProduct() ? "END PRODUCT" : "COMPONENT";
    System.out.println(type + ": " + line.getM_Product_ID()
        + " qty=" + line.getMovementQty());
}
// Expected output for a product with 3 BOM components (qty=10):
//   END PRODUCT: [finished] qty=10
//   COMPONENT: [frame] qty=-10
//   COMPONENT: [motor] qty=-10
//   COMPONENT: [cover] qty=-40

Draft (DR) → In Progress (IP) → Complete (CO) → Closed (CL)
                                    ↓
                              Reversed (RE) ← Void (VO)

// Complete the production order
MProduction production = new MProduction(ctx, productionId, trxName);

// Step 1: Prepare — validates lines, periods, costs
String status = production.prepareIt();
if (!DocAction.STATUS_InProgress.equals(status)) {
    throw new AdempiereException("Prepare failed: " + production.getProcessMsg());
}

// Step 2: Complete — creates transactions, updates inventory
status = production.completeIt();
if (!DocAction.STATUS_Completed.equals(status)) {
    throw new AdempiereException("Complete failed: " + production.getProcessMsg());
}
production.saveEx();

System.out.println("Production " + production.getDocumentNo() + " completed");
// At this point:
//   - Component inventory has decreased
//   - Finished product inventory has increased
//   - M_Transaction records have been created
//   - Accounting entries are posted

// Complete workflow: Create → Generate Lines → Complete
MProduction production = new MProduction(ctx, 0, trxName);
production.setAD_Org_ID(orgId);
production.setM_Product_ID(finishedProductId);
production.setProductionQty(new BigDecimal("10"));
production.setM_Locator_ID(locatorId);
production.setMovementDate(new Timestamp(System.currentTimeMillis()));
production.saveEx();

// Generate lines from BOM
production.createLines(false);
production.setIsCreated("Y");
production.saveEx();

// Prepare and complete
if (!production.processIt(DocAction.ACTION_Complete)) {
    throw new AdempiereException("Failed: " + production.getProcessMsg());
}
production.saveEx();

System.out.println("Production " + production.getDocumentNo()
    + " status: " + production.getDocStatus());

import org.eevolution.model.MPPProductBOM;
import org.eevolution.model.MPPProductBOMLine;

// Create a BOM header for a finished product
MPPProductBOM bom = new MPPProductBOM(ctx, 0, trxName);
bom.setM_Product_ID(finishedProductId);
bom.setName("Standard Assembly BOM");
bom.setValue("STD-ASSY-001");
bom.setBOMType(MPPProductBOM.BOMTYPE_CurrentActive);    // 'A'
bom.setBOMUse(MPPProductBOM.BOMUSE_Manufacturing);       // 'A'
bom.saveEx();

// Add a regular component: Frame, qty = 1
MPPProductBOMLine line1 = new MPPProductBOMLine(bom);
line1.setM_Product_ID(frameProductId);
line1.setQtyBOM(new BigDecimal("1"));
line1.setLine(10);
line1.saveEx();

// Add a phantom sub-assembly: Motor Assembly
MPPProductBOMLine line2 = new MPPProductBOMLine(bom);
line2.setM_Product_ID(motorAssemblyProductId);
line2.setQtyBOM(new BigDecimal("1"));
line2.setComponentType(MPPProductBOMLine.COMPONENTTYPE_Phantom);  // Will be expanded during production
line2.setLine(20);
line2.saveEx();

// Add a regular component: Cover Panel, qty = 4
MPPProductBOMLine line3 = new MPPProductBOMLine(bom);
line3.setM_Product_ID(coverPanelProductId);
line3.setQtyBOM(new BigDecimal("4"));
line3.setLine(30);
line3.saveEx();

// Create a new production order
MProduction production = new MProduction(ctx, 0, trxName);
production.setAD_Org_ID(orgId);
production.setM_Product_ID(finishedProductId);
production.setProductionQty(new BigDecimal("10"));
production.setM_Locator_ID(locatorId);
production.setMovementDate(new Timestamp(System.currentTimeMillis()));
production.saveEx();

System.out.println("Production created: " + production.getDocumentNo());

// Generate production lines from BOM
MProduction production = new MProduction(ctx, productionId, trxName);
int lineCount = production.createLines(false);  // false = don't require all stock on hand
production.setIsCreated("Y");
production.saveEx();

System.out.println("Created " + lineCount + " production lines");

// Inspect the generated lines
MProductionLine[] lines = production.getLines();
for (MProductionLine line : lines) {
    String type = line.isEndProduct() ? "END PRODUCT" : "COMPONENT";
    System.out.println(type + ": " + line.getM_Product_ID()
        + " qty=" + line.getMovementQty());
}
// Expected output for a product with 3 BOM components (qty=10):
//   END PRODUCT: [finished] qty=10
//   COMPONENT: [frame] qty=-10
//   COMPONENT: [motor] qty=-10
//   COMPONENT: [cover] qty=-40

Draft (DR) → In Progress (IP) → Complete (CO) → Closed (CL)
                                    ↓
                              Reversed (RE) ← Void (VO)

// Complete the production order
MProduction production = new MProduction(ctx, productionId, trxName);

// Step 1: Prepare — validates lines, periods, costs
String status = production.prepareIt();
if (!DocAction.STATUS_InProgress.equals(status)) {
    throw new AdempiereException("Prepare failed: " + production.getProcessMsg());
}

// Step 2: Complete — creates transactions, updates inventory
status = production.completeIt();
if (!DocAction.STATUS_Completed.equals(status)) {
    throw new AdempiereException("Complete failed: " + production.getProcessMsg());
}
production.saveEx();

System.out.println("Production " + production.getDocumentNo() + " completed");
// At this point:
//   - Component inventory has decreased
//   - Finished product inventory has increased
//   - M_Transaction records have been created
//   - Accounting entries are posted

// Complete workflow: Create → Generate Lines → Complete
MProduction production = new MProduction(ctx, 0, trxName);
production.setAD_Org_ID(orgId);
production.setM_Product_ID(finishedProductId);
production.setProductionQty(new BigDecimal("10"));
production.setM_Locator_ID(locatorId);
production.setMovementDate(new Timestamp(System.currentTimeMillis()));
production.saveEx();

// Generate lines from BOM
production.createLines(false);
production.setIsCreated("Y");
production.saveEx();

// Prepare and complete
if (!production.processIt(DocAction.ACTION_Complete)) {
    throw new AdempiereException("Failed: " + production.getProcessMsg());
}
production.saveEx();

System.out.println("Production " + production.getDocumentNo()
    + " status: " + production.getDocStatus());