Documentation

Managing BOMs

Subscription Required

Bill of Materials (BOM) diagrams identify component parts belonging to a product. Users can create and annotate BOM diagrams in Liferay Commerce that reference products in the store. BOM diagrams can then be displayed on a Site page.

BOM diagrams are comprised of two parts: the Diagram and Mapped Products.

Important

BOMs are no longer available starting from Liferay Commerce 4.0. They are replaced by a more robust Shop by Diagram feature. Read Shop by Diagram for more information.

Adding a New BOM Diagram

To add a new BOM diagram:

  1. Go to the Global Applications menu → CommerceBill of Materials.

  2. Click Add (Add Icon) then Add Definition.

  3. Click Select File or drag and drop the product image.

  4. Enter a name for the product (Generic Diesel Engine).

  5. Click Save.

Mapping Products to a BOM Diagram

Once the image has been uploaded, map the parts to the products in the catalog.

  1. Click the Entries tab.

    Click the Entries tab to view and map entries to the image.

  2. The Mapped Products pane on the right lists all subparts. When users hover the mouse over the diagram, a plus sign appears.

    A new Product can be mapped to the BOM by clicking on the plus sign.

  3. Click on the part of the diagram that is associated with product (for example, Fuel Injector 1).

  4. Enter this information:

    • Number: 1 (numeric ordering of the mapped product list)

    • Product: MIN59999 (the product name or SKU)

      Tip

      Text auto-complete shows suggestions as you type in the name of a product.

    Begin associating products in the BOM diagram.

  5. Click Save.

Continue adding the rest of the products. Each entry must have a unique numeric identifier in the list of Mapped Products, even if there is more than one of the same product. In this example, there are two fuel injectors and both have a distinct product mapping number.

Continue to associating products in the BOM diagram.

Displaying a BOM on a Site Page

The Commerce BOM widget is used to display BOM diagrams.

  1. Navigate to the desired store site page and add the BOM widget. The BOM widget displays all created BOMs and folders.

    Deploy the BOM widget on site page.

  2. In the BOM Widget, select a BOM definition by clicking a BOM thumbnail.

    The Commerce BOM widget displays the diagram.

The BOM widget displays the diagram.

Adding BOM Folders

You can create folders to group and organize your store’s BOMs.

To add a folder:

  1. Click Add (Add Icon) then Add Folder.

  2. Enter the following:

    • Name: Folder name (Car parts)

  3. Click Save.

Commerce 2.1 and Below

Adding a New BOM Diagram

To add a new BOM diagram:

  1. Navigate to the Control PanelCommerceProducts.

  2. Click BOM.

    BOM Admin menu

  3. Click Add (Add Icon) then Add Definition.

  4. Click Select File or drag and drop the product image.

  5. Enter a name for the product (Generic Diesel Engine).

  6. Click Save.

Mapping Products to a BOM Diagram

  1. Click the Entries tab.

    BOM Entries tab

  2. The Mapped Products pane on the right lists all subparts. When users hover the mouse over the diagram, a plus sign appears.

    BOM Entries tab

  3. Click on the part of the diagram that is associated with product (for example, Fuel Injector 1).

  4. Enter the following:

    • Number: 1 (numeric ordering of the mapped product list)

    • Product: MIN59999 (the product name or SKU)

      Tip

      Text auto-complete will show suggestions as you type in the name of a product.

    Begin associating products in the BOM diagram.

  5. Click Save.

Continue adding the rest of the products. Each entry must have a unique numeric identifier in the list of Mapped Products, even if there is more than one of the same product. In this example, there are two fuel injectors and both have a distinct product mapping number.

Continue to associating products in the BOM diagram.

Displaying a BOM

The Commerce BOM widget is used to display BOM diagrams.

  1. Navigate to the desired store site page and add the BOM widget. The BOM widget displays all created BOMs and folders.

    Deploy the BOM widget on site page.

  2. In the BOM Widget, select a BOM definition by clicking a BOM thumbnail.

    The Commerce BOM widget displays the diagram.

The BOM widget displays the diagram.

Adding a BOM Folder

You can create folders to group and organize your store’s BOMs.

To add a folder:

  1. Click Add (Add Icon) then Add Folder.

  2. Enter the following:

    • Name: Folder name (Car parts)

  3. Click Save.