Services#

ValidatePlacementList#

A BOM is Valid if:

• All the Reference Designators match MES BOM's Designators;
• All Products or a subset of them exist in the MES BOM.

The configuration entry, /SMT/PreBomCheck/UseCaseSensitive, determines whether case sensitivity is enforced when comparing the Product Name and Reference Designator lists from the equipment with those defined in the BOM. By default, this setting is set to false.

Error Translations#

The localized messages used by the service are:

• IoTValidatePlacementListDuplicateComponentName
  • Component list of reference has a duplicate component name
• IoTValidatePlacementListDuplicateReferenceDesignator
  • Placement list has a duplicate reference designator
• IoTValidatePlacementListSubstituteBOMEntryMismatch
  • The reference designators of the substitute BOM entry don't match the parent BOM entry's reference designators.

Pre Conditions:#

• Material must exist in system;
• Resource must exist in system;
• PlacementLists cannot be empty;
• BOMContext SmartTable must be correctly configured for the current Step and BOM material product;
• Designators are unique and the Substitutes have the same designator or empty.

At MES, similar BOM items should be grouped by Designator field. Check this example:

If you have Substitute Products configured they must not have Designator filled or have the same Designator as parent Product:

BOM Context smart table should be correctly defined, for example:

SearchMaterials#

The SearchMaterials service retrieves a list of Materials based on the provided filters and relations.
This service is responsible for dynamically constructing and executing search queries that filter out irrelevant or invalid Materials - such as Templates or Terminated ones - while supporting pagination and query customization.

The service underpins the Search Materials functionality in SMT, providing flexibility for various search contexts such as by Product, Area, Resource, or Hold status.

• Base Filters Applied Automatically:

  • Excludes Template Materials;
  • Excludes Terminated Materials.

• Pagination:

  • Supports configurable PageNumber and PageSize for large datasets.

• Dynamic Query Behavior:

  • Additional filters and relations can be appended dynamically from the UI or process layer.
  • The query results are enriched by resolving Material relations (Resources, Containers, Lines, etc.) into a single structured dataset.

Pre Conditions#

• The FilterCollection or RelationCollection must be properly constructed and valid;
• The Material entity type and related entity definitions must exist in the MES;
• The Material objects should be accessible for read operations;
• Pagination parameters (PageNumber, PageSize) should be within valid limits.

IoTMaterialOperation#

Error Translations#

The localized messages used by the service are:

• IoTMaterialNotDispQueuedAtResource
  • Material '{Material Name}' is not Dispatched/Queued at Resource '{Resource Name}' on Operation '{Operation}'
• IoTNoMaterialsDispQueuedAtResource
  • No Materials Dispatched/Queued at Resource '{Resource Name}' on Operation '{Operation}'
• IoTMaterialNotInProcess
  • Material '{Material Name}' is not InProcess on Operation '{Operation}'
• IoTNoMaterialsInProcess
  • No Materials InProcess on Operation '{Operation}'
• IoTMaterialNotInProcess
  • Material '{Material Name}' is not InProcess on Operation '{Operation}'
• InvalidMaterialOperation
  • Material Operation is invalid

GetMaterialRecipe#

The GetMaterialRecipe Service retrieves a Recipe associated to a Material.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• N/A

LoadComponents#

The LoadComponents Service is used for loading single components or a feeder table into a station.

Error Translations#

The localized messages used by the service are:

• SMTIoTLoadUnloadComponentsConsumableFeedStepWithoutService - Step {0} doesn't have any associated Service

Pre Conditions:#

• N/A

UnloadComponents#

The UnloadComponents Service is used for unloading components from a station.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• N/A

StartMaterialsForProductionOrder#

The StartMaterialsForProductionOrder service is designed to Start Materials under the Production Order.

Error Translations#

The localized messages used by the service are:

• SMTProductionOrderFulfilled - The Production Order is already fulfilled
• SMTProductionOrderOverFulfilling - The quantity is over fulfilling the Production Order
• SMTProductNoMaterialStartMode - The Product doesn't have the attribute MaterialStartMode defined.

Pre Conditions:#

• N/A

GetDataForStartMaterialsForProductionOrderWizard#

The GetDataForStartMaterialsForProductionOrderWizard service is designed to get Data for Wizard Start Materials under the Production Order.

Error Translations#

The localized messages used by the service are:

• SMTGUIElementDefaultValueInvalidFormat
  • Value '{0}' in GUIElementDefaultValue table is not in the correct format for Context '{1}' and Element '{2}'.

Pre Conditions:#

• N/A

GetDataForValidationWizardStep#

The GetDataForValidationWizardStep service is designed to Retrieve Panels and Boards genealogy for validation on Serialization Track-Out wizard.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• N/A

CreateAndAttachRawMaterials#

The CreateAndAttachRawMaterials service is designed to create and attach the input Raw Materials into the designated resource.

Error Translations#

The localized messages used by the service are:

• SMTNotEnoughFreeFeeder - Not enough free feeders to attach the raw materials
• SMTNoFeeders - No Feeders
• SMTRawMaterialsWereAttached

Pre Conditions:#

• N/A

RemoveItemsFromPackingContainer#

The RemoveItemsFromPackingContainer service is used to remove Items from a Packing Container.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• N/A

ClosePackingContainer#

The ClosePackingContainer service is used to close a Packing Container and to print its Labels.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• N/A

OpenPackingContainer#

The OpenPackingContainer service is used to close a Packing Container and to print its Labels.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• N/A

AddItemsToPackingContainer#

The AddItemsToPackingContainer service is used to close a Packing Container and to print its Labels.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• N/A

ResolvePackingContainerProducts#

The ResolvePackingContainerProducts service is used to close a Packing Container and to print its Labels.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• Smart Table SMTMaterialPackingContext is configured.

DockFeederTableToResource#

The DockFeederTableToResource service is used to close a Packing Container and to print its Labels.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• N/A

AssembleMaterialFromConsumptionSummary#

The AssembleMaterialFromConsumptionSummary service is used to close a Packing Container and to print its Labels.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• N/A

ProcessAssembleMaterialFromConsumptionSummary#

The ProcessAssembleMaterialFromConsumptionSummary service is used to Process Assemble or Combine (depends on Input operation) Material with Materials and Quantity from Consumption Summary.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• N/A

AttachMaterialToConsumableFeed#

The AttachMaterialToConsumableFeed service is used to Create a Resource (if it doesn't exist) with the name received (FeederId) and attach all received ReelIds (if they exist) to that resource.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• N/A

AddFeedersToFeederTables#

The AddFeedersToFeederTables service is used to add Feeders to FeederTable Containers.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• N/A

RemoveFeedersFromFeederTables#

The RemoveFeedersFromFeederTables service is used to remove Feeders to FeederTable Containers.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• N/A

ManageDefectActions#

The ManageDefectActions service is used to create, update or remove defect actions.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• N/A

GetProductDefectActions#

The GetProductDefectActions service is used to get a specific Product Defect Action.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• N/A

GetVirtualInkspotHandlingData#

The GetVirtualInkspotHandlingData service returns the VirtualInkspotHandling Data for a given material.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• N/A

StartMsdMaterial#

The StartMsdMaterial service starts floor life counter of MSD material on MES.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• N/A

CalculateRequiredBakingHours#

The CalculateRequiredBakingHours service is used to add calculate Required Baking Hours.

Error Translations#

The localized messages used by the service are:

• Generic Table SMTMaterialBakingTable has a row defined for the input material.

Pre Conditions:#

• N/A

StartMaterialsBaking#

The StartMaterialsBaking service is used to start the baking of the input materials.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• Generic Table SMTMaterialBakingTable has a row defined for the input material.

StopMaterialsBaking#

The StopMaterialsBaking service is used to stop the baking of the input materials.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• N/A

CalculateRemainingBakingHours#

The CalculateRemainingBakingHours service is used calculate Remaining Baking Hours for a given list of materials.

Error Translations#

The localized messages used by the service are:

• N/A

Pre Conditions:#

• Generic Table SMTMaterialBakingTable has a row defined for the input material.
• Material is in baking.

ReturnMaterialsFromRework#

The ReturnMaterialsFromRework service is used to return materials processed in Rework back into production.

The destination is determined by the value set in the ReturnType property:

• SameLine – returns the materials to their original production line.
• DifferentLine – returns the materials to a different compatible line.
• OfflineStation – returns the materials to an offline station.

The grouping of materials is determined by the value set in the ValidationType property:

• SameProduct – groups materials by the same product.
• SameProductGroup – groups materials by the same product group.
• SameProductionOrder – groups materials by the same production order.
• NoGrouping – no grouping is applied.

When returning materials to a different line, the target line must be compatible with the material's production context.

Return to the same line#

Materials are returned to the same line and production context from which they originated.

The service first attempts to reuse the parent material stored in the material off-flow information. If that parent material is no longer valid, another suitable parent material is selected from the destination line. When no suitable parent material exists, a new parent material is automatically created, dispatched, and tracked-in to the return flow path.

Return to a different line#

Materials are returned to the line specified in the Resource parameter.

When returning materials to a different line:

• The destination line replaces the original return line stored in the material off-flow information.
• The destination lane can be specified using ReturnLineLane.
• Existing off-flow records are recreated to reflect the new destination line.
• A suitable parent material is reused whenever possible.
• A new parent material is automatically created when no suitable parent material exists.
• Materials are advanced to the next step and inserted into the destination line at the appropriate production point, determined by resolving the StepLineFlowContext smart table.
• Any residual off-flow records created during the advance step are removed from materials that end up in Queued state.

Return to an offline station#

Materials are returned to the offline station specified in the Resource parameter.

Note

This return type is currently not implemented.

Error Translations#

The localized messages used by the service are:

• SMTMaterialsMustBeInRework
• SMTMaterialsMustBeInState
• SMTMaterialsMustHaveNoOpenDefects
• SMTMaterialsMustBeInSameContainer
• SMTEntityAttributeMustBeEnabled
• SMTEntityAttributeMustBeSetTo
• SMTInvalidLineResource
• SMTLineResourceNotCompatibleWithProduct
• SMTDifferentLineNotAvailable

Pre Conditions#

• The materials must be in rework.
• The materials must have been processed.
• The materials must not have open defects, unless the configuration entry /SMT/MaterialRework/AllowReturnWithOpenDefects is enabled.
• All materials must originate from the same last processed resource.
• All materials must satisfy the selected ValidationType grouping criteria.
• If the materials are in a container, they must all belong to the same container.
• The last processed resource must have the SMTIsReworkStation attribute enabled.
• The material form used when searching for or creating lot material(s) must be configured in /SMT/StartMaterialsForProductionOrder/SMTStartMaterialsForProductionOrderForm.

GetMaterialsInReworkProcessData#

The GetMaterialsInReworkProcessData service retrieves the materials currently in rework for a given resource. It queries the system for materials participating in the rework workflow for the specified resource and enriches the result with relevant information such as product, production order, container, and rework limits.

Error Translations#

The localized messages used by the service are:

• SMTResourceAttributeNotEnabled – Thrown when the resource is not configured as a rework station.

Pre Conditions:#

• The input Resource must be valid.
• The input Resource must have the SMTIsReworkStation attribute enabled.