Skip to content

Synchronize Material with Substrate Map#

🔒 Material.SynchronizeWithSubstrateMap

Overview#

This operation is used to synchronize a Material with its Substrate Map.

Setup#

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

Preconditions#

  • The Material must be Active and Non-Template.
  • The Material has a Substrate Map.

Sequence of Steps#

The Synchronize With Substrate Map wizard is called from the Details page of the selected Material. Depending on the current system status, the Synchronize With Substrate Map button may be visible on the top ribbon or under the More actions button.

Step 1: General Data#

  1. Select the Material you need.
  2. Under Mapping, select Synchronize With Substrate Map to open the wizard.
  3. If the Material synchronization properties Layout Specifier, Overlay, Units are not set, you must specify them. If they are set, you can override them, and the following may apply:

    • If more than one Layout Specifier exists for the provided Substrate in the collection of Substrate Maps for the current Material as Substrate Id of the selected Substrate Map Payload, you must specify which Layout Specifier to use.
    • If for the specified Layout Specifier (or the single Layout Specifier if there is only one), there are more than one possible Overlay Maps, you must specify the Overlay Map to use by providing the Map Name.
    • If the Material has Secondary Units, you must specify which Substrate Map Units to synchronize: the Primary Units or Secondary Units – always by name of the units.
  4. The GUI should present the quantity of units that exist in the Map as well as the delta to the Material Quantity matching units to synchronize.

  5. Verify the information to synchronize.
  6. Optionally, specify a Loss/Bonus Reason to account for negative/positive delta(s).
  7. Optionally, enter a comment.
  8. Select Synchronize to complete the operation.

Screenshot showing a substrate map with synchronization settings.

Warning

This operation will not convert bins if a Bin Converter exists for the Substrate Map. If any Pass bins are generated from the conversion, they will be excluded when determining the quantity to assign to the Material.