---
alias: user-guide-create-substrate-map-mask
tags:
- mapping
description: "Create a Substrate Map Mask to define regions and values for application"
---

# Create Substrate Map Mask

:lock: SubstrateMapMask.**Create**

## Overview

This operation is used to create a **Substrate Map Mask**. A **Substrate Map Mask** represents a region and a value to be applied in that region.

## Setup

No specific setup is required other than to meet the preconditions of the transaction.  

## Preconditions

* The **Mapping** module (if part of CM MES) or **App** license (if part of an Application) must be properly licensed.
* The **Substrate Map Mask** name must be unique.

## Sequence of Steps

!!! info
    See [[user-guide-substrate-map-mask-index]] for mask content restrictions, and [[user-guide-substrate-map-mask-page]] for an [[user-guide-substrate-map-mask-page#example-of-substrate-map-mask-file|Example of Substrate Map Mask File]].

## Create Substrate Map Mask Using a File

### Step 1: General Data

1. In the **Substrate Map Mask** entity, **Business Data** menu, select **New** on the top ribbon.
2. Enter the **Name** (must be unique).
3. Enter the **Description**.
4. Optionally, specify a **Loss Reason**/**Bonus Reason**.
5. Enter the `xml` file with the mask content:

    ![Screenshot showing an XML file input field with a filename hint "create submap mask 01".](images/create_submap_mask_01.png)

6. Select **Create** to complete the operation:

    ![Screenshot showing a UI with "Create" button selected.](images/create_submap_mask_02.png)

    !!! info
        When creating a **Substrate Map** the system validates that the uploaded file is compliant with SEMI E142.

## Create Substrate Map Mask Using a Substrate Map

### Step 1: General Data

1. In the **Substrate Map**, go to the [[user-guide-substrate-map-page#content-view|Content View]], and select the Bin Code Map Overlay.
2. Enable the **Select Mode**.
3. Select a region by selecting multiple units, and the **Create Mask** button becomes available on the top ribbon:

    ![Screenshot showing a UI with a highlighted "Create Mask" button on the top ribbon.](images/create_submap_mask_03.png)

4. Select **Create Mask** to call the **Create Substrate Map Mask** wizard.
5. Enter the **Name** (must be unique).
6. Enter the **Description**.
7. Enter the **Set Value** for the mask - this is the value that will be set for the Bin Definition where `BinQuality="Set Value"`.
8. Optionally, specify the **Apply New Value To** option:

      * All Selected Bin Values (default)
      * Single Bin Value - if selected, a **Bin Value** must be supplied

        !!! note
            The Set Value and Bin Value must comply with the currently selected `BinCodeMap` Overlay Bin Type.

9. Optionally, specify a **Loss Reason**/**Bonus Reason**.
10. Select **Create** to complete the operation:

    ![Screenshot showing a UI with a button labeled "Create" to complete an operation.](images/create_submap_mask_04.png)