---
alias: split-material-by-product
description: "This documentation outlines splitting a material into sub-products based on product specifications"
---

# Split Material by Product

:lock: Material.**SplitByProduct**

## Overview

This operation is used to split a **Material** according to its different **Products**.
For each different Sub-Product, it is possible that the system creates a new TopMost **Material** (with a split) or that an existing eligible Sub-Material is selected as a new Sub-Product TopMost.

## Setup

No special setup is required other than to meet the preconditions of the transaction. Note that, the **Material** must have Sub-Products.

## Preconditions

* The Main **Material** is Active.
* The Main **Material** is not On Hold and not In Transit.
* The **Material** has Sub-Products (i.e. Sub-Materials from different **Products** than the parent **Material**).
* The **Flow** and **Product** of all new **Materials** are Active and Enabled.

    !!! info
        This transaction is important for genealogy.

* If the property Use Container Restrictions in the **Step** of the **Material** is `True`, the available containers will be the ones that match the restrictions applied by the context of that **Step**. For more information, see [[step-page#contexts-view]] or [[materialcontainertypecontext-st]].

    !!! note
	      The Container Used Positions must be less than the Container Max Usable Positions.

## Sequence of Steps

### Step 1: Sub-Products

1. Verify the main **Material** information.
2. Specify the Sub-Products to Split, by checking the respective checkbox on the leftmost column, and check their details on the right-hand side of the screen.

![Screenshot showing a list of sub-products with checkboxes on the left and details on the right.](images/split_by_product1.png)

### Step 2: New Materials

1. Once again, select the Sub-Products on the left-hand side grid and specify if a new TopMost **Material** should be generated by checking the option Create New Material, in which case a name can be entered (otherwise, it will be generated by a name generator). If, instead, you decide to check the option Use Sub-Materials, existing Sub-Material(s) of that Sub-Product must be selected to be the new TopMost **Material** for that **Product**.
2. Regardless of the option selected above, a **Container** and a Position must be specified. If the selected **Container** has been configured to auto-generate positions, then the Position field will be filled in automatically. Otherwise, enter the **Container** position.
3. By selecting the Options button on the top rightmost side of the screen, you will have access to additional options:
    1. Optionally, if all Sub-Products will be Split, check the option Collapse to collapse the Main **Material** being Split by **Product**.
      2. Optionally, you can Copy Contexts to the new **Child Material**.
      3. Optionally, you can Copy Future General Actions to the new **Child Material**.
      4. Optionally, you can Copy Future Splits and Merges to the new **Child Material**.
      5. Optionally, you can Copy Future Create Send-Ahead Runs to the new **Child Material**.
      6. Optionally, check the available option Terminate Material on zero Quantity(ies) and no Sub-Materials to terminate the **Parent Material** if these two conditions are met.

      ![Screenshot showing a UI with a list of materials, possibly with checkboxes or radio buttons for selecting product options.](images/split_material_by_product_options.png)

4. Select the **Split** button to complete the operation.

![Screenshot showing a product selection interface with "Split" button highlighted.](images/split_by_product2.png)

!!! info
    It is possible to define a default value for the possible collapse, as well as copying contexts, future actions and terminating Material on zero quantity(ies) and no Sub-Materials by editing the entries under the Context = `Material.SplitByProduct` in the [[guielementdefaultvalue-gt]] Generic Table.

    When splitting a Material and opting to Copy Future Splits and Merges, note that Future Actions of type Merge will not be copied. Instead, the new Child Material will be included in the Merge Future Action linked with the Parent Material. Additionally, the system will not copy Future Actions referencing invalid Flow Paths or Logical Flow Paths.

    If you opt to Use Sub-Materials during the Material split, be aware that no Future Actions will be copied.