Skip to content

Display Service#

Available from SMT Template version 3.1.0 onwards

Overview#

To enhance visibility of MES response error messages, the goal is to display these messages on individual station screens along the production line. Currently, these error messages are only accessible through the BoardGateKeeper software on the line computer or within the logs.

How To configure#

To enable DisplayService messaging functionality, configure the extension as described below:

IoTMetadataDefinition Area Level Configuration#

Set the following keys at the Area level:

Name Type Possible Values Default Value Description
oib_DisplayService_disabled String true
false		 true This will enable or disable the extension.
oib_DisplayService_enablemode String None
OnePerEnterprise
OnePerSite		 None How should activate DisplayService instance:
None - No instance will be used
OnePerEnterprise - One Instance for all Lines (Enterprise level)
OnePerSite - One Instance for all Lines (Site level)
OIB_LineNameStationName_Line name_Station name String Link from OIB Line and Station names to MES Resource name.
Example
Resource      ResourceType Area Name                     Value                   
                   SMT_Production Line   oib_DisplayService_disabled false  
                 SMT_Production Line   oib_DisplayService_enablemode OnePerEnterprise    
                 SMT_Production Line   OIB_LineNameStationName_Line - TQ & TX2 & SX2_TX2 SMT_Pick_Place_1    

Replace with the appropriate values depending on your setup.

IoTMetadataDefinition Resource Level Configuration#

At the Resource level, configure the key useOIBToDisplayService with the OIB features that should send error messages through DisplayService.

Supported values:

  • MES
  • BoardRequest
  • BoardTracking
  • BoardReleased
  • BoardProcessed
  • BoardProduced
  • TraceabilityData
Example

To enable MES, BoardRequest, and BoardProcessed, configure:

Resource      ResourceType Area Name                     Value                   
SMT_Pick_Place_1                    useOIBToDisplayService MES;BoardRequest;BoardProcessed

How To Use#

If the feature is enabled for the respective OIB feature, the error message is retrieved and sent to the corresponding Station based on the triggering event.

You can, for example, set useOIBToDisplayService to BoardRequest. When a validation request is triggered by the station and the material is not present in MES, the operator will receive a message on the station display explaining the reason for the rejected result.

Sending Messages via Message Bus#

To send a message from MES through message bus, publish to the respective Automation Controller Instance the topic:

SMTTemplate.DisplayService.Command.SendMessageToViewers

Message Data Format#

{
  "Message": "Message you want to send.",
  "Line": "ASM Line Path where the Station is.",
  "Station": "ASM Station Name where you want to send the message to."
}

Ensure Line and Station accurately reflect the ASM Line and Station.

Implementation Details#

During Equipment Setup, a new client registration request is sent to the Line Station. This registration becomes the endpoint through which messages are delivered.

  • If a previous registration exists, its ID is stored in the persistent key DisplayServiceClientRegistrationId and reused to avoid redundant client entries.

Each OIB feature workflow that supports DisplayService will call the sub-workflow doDisplayService when an error is detected. This sub-workflow:

  1. Verifies if DisplayService is enabled for the calling OIB feature.
  2. If enabled, sends the error message to the associated Station using:
DisplayService.Command.SendMessageToStationPath