Apply Substrate Map Mask#
SubstrateMap.ApplyMask
SubstrateMapMask.Apply
Overview#
This operation is used to apply a Substrate Map Mask. When applying a Substrate Map, all the affected units in the designated region are changed to the Set Value as defined in the mask.
Setup#
No specific setup is required other than to meet the preconditions of the transaction.
Preconditions#
- The Substrate Map Mask exists and is Active.
- All the Substrate Maps to which the Substrate Map Mask will be applied exist, are Active, and non-template.
Sequence of Steps#
A Substrate Map Mask can be applied either from the Substrate Map page or directly from the Substrate Map Mask page. Follow the steps below according to your preferred entry point.
Apply Substrate Map Mask From a Substrate Map Page#
Raw (no Bin Converter is set)#
- In the Substrate Map, go to the Content View, and select the Bin Code Map Overlay.
-
Select Apply Mask on the top ribbon:
-
In the new window, select which Mask to apply:
Note
The selected Mask must have the same Layout Specifier, Substrate Type, Dimension X, Dimension Y, Orientation, Origin Location, and Axis Direction of the currently selected Overlay.
-
Select Apply to preview the Mask:
-
In the preview of the Mask, you can Add Units or Remove Units.
Info
If you make changes to the Mask in the preview, the changes will apply to the Map and the Mask.
-
In the Save Substrate Map wizard, you can choose to:
- Synchronize Material - enables synchronization of the Substrate Map with the Material quantity. For more information, see Set Material Substrate Map and Synchronize Material with Substrate Map.
- Copy Overlay Information - if enabled, the Substrate Map Overlay Information from the original Substrate Map are copied into the newly created Overlay. For more information, see Manage Substrate Map Overlay Information. This option is only available if you choose to Create New Version or Create New Map Name.
- Set Overlay as Active - if you choose to create a new version or a new map, you can designate the newly created Overlay as the active version.
- Create New Version - creates a new version for the currently selected Map Name.
- Create New Map Name - creates a new Map Name with version 1. When selecting this option, you must provide the following information:
- Facility - optionally, associate a Facility.
- Step - optionally, associate a Step.
- Resource - optionally, associate a Resource.
-
Once you have made your selections, choose Cancel to discard changes or Save to apply them.
Converted (a Bin Converter is set)#
-
In the Substrate Map, go to the Content View, and select the Bin Code Map Overlay:
-
If you select Apply Bin Converter on the right, a new window will open for you to select the Bin Converter:
-
Select the Bin Converter followed by Apply to access the converted Substrate Map:
-
Select Apply Mask on the top ribbon, and select which Mask to apply:
-
Select Apply to preview the Mask with the selected Bin Converter:
-
In the preview of the Mask, you can Add Units or Remove Units.
Info
If you make changes to the Mask in the preview, the changes will apply to the Map and the Mask.
-
In the Save Substrate Map wizard, you can choose to:
- Synchronize Material - enables synchronization of the Substrate Map with the Material quantity. For more information, see Set Material Substrate Map and Synchronize Material with Substrate Map.
- Copy Overlay Information - if enabled, the Substrate Map Overlay Information from the original Substrate Map are copied into the newly created Overlay. For more information, see Manage Substrate Map Overlay Information. This option is only available if you choose to Create New Version or Create New Map Name.
- Set Overlay as Active - if you choose to create a new version or a new map, you can designate the newly created Overlay as the active version.
- Create New Version - creates a new version for the currently selected Map Name.
- Create New Map Name - creates a new Map Name with version 1. When selecting this option, you must provide the following information:
- Facility - optionally, associate a Facility.
- Step - optionally, associate a Step.
- Resource - optionally, associate a Resource.
-
Once you have made your selections, choose Cancel to discard changes or Save to apply them.
Apply Substrate Map Mask From a Substrate Map Mask Page (Bulk)#
In the chosen Substrate Map Mask, select Apply Mask on the top ribbon:
Step 1: General Data#
-
Configure the optional settings:
- Synchronize Materials - enables Material synchronization. For more information, see Set Material Substrate Map and Synchronize Material with Substrate Map.
- Create New Version - creates a new version of the current Substrate Map Overlay.
- Create New Overlay - creates a new Substrate Map Overlay.
- Process Valid Only - if enabled, only valid Substrate Map Masks will be processed.
- Copy Overlay Information - if enabled, the Substrate Map Overlay Information from the original Substrate Map is copied into the newly created Overlay. For more information, see Manage Substrate Map Overlay Information. This option is only available if you choose to Create New Version or Create New Overlay.
-
Enable the Select Mode option:
- Substrate Map - select Substrate Maps directly (see Step 2: Substrate Maps below)
- Materials - select Substrate Maps indirectly (see Step 2: Materials below)
Note
The Advanced Options for the Select Modes vary. If you select Materials, you can also choose to apply the Substrate Map Mask to Sub-Materials.
-
In the Apply To Values, you can select Raw or Converted (default).
- You can also use the Map Name Filter to specify where the Substrate Map Mask should be applied.
- Select Next to continue.












