Skip to end of metadata
Go to start of metadata

Description

A component that is added to Ignition windows to display material selection components for the active MES Response Segment. The material selection components that are shown depend on the configuration of the MES Operations Segment.

Info

 If more than one material resource has been defined for a MES Operations Segment, then the MES Material Selector component will automatically populate components for each material resource.

The MES Material Selector must be used in conjunction with the MES Segment Selector component. The active MES Response Segment is retrieved from the MES Segment Selector component. MES Operations Response objects are derived from MES Operations Segment objects and drive the entry components created in the MES Material Selector component. No binding is required for the two to work together. Behind the scenes, the MES Material Selector finds the MES Segment Selector and the two will communicate.

For the MES Material Selector component to find the MES Segment Selector, it must be in the same container on the window. It is okay to be in a container, they just both have to be in the same container or root container. Multiple containers can exist on the same window containing separate MES Segment Selector and MES Material Selector components in each. The components residing in the same container will work together allowing multiple segments to be controlled from the same window.

 

Component Palette

When a material lot is changed, the Prev Quantity field allows the user to enter a final quantity for the previous lot. It can't be hidden.

In the image below, a MES Operations Segment with a material resource named Raw Material caused the Raw Material header. The material resource has a material class defined causing the component to select the specific material to be added.

The location for the material is not known, so a component to select the location is added and will contain options based on the Equipment Class to store the material at.

The material resource is also configured for manual lot number source, causing a component to accept the lot number is added.

And last, the material source is configured for manual entry of the quantity causing a component to accept quantity is added.

All this is performed automatically and there is no need to create custom Ignition windows for each combination of how MES Operations Segment objects are configured.


 

Component Properties

Properties are provided that can be set to affect the operation and look of the component. They can be set through the Property Editor in the Designer or through scripting.

Example
event.source.parent.getComponent('MES Material Selector').maxLotReturnCount = 5

 Data
NameScriptingProperty TypeDescription
Name FilternameFilterStringLot names to filter on.
Max Quantity Decimal DigitsquantityMaxDecimalDigitsInt4The maximum number of decimal digits in the quantity input. Default = 0.
Max Lot Return CountmaxLotReturnCountInt4The maximum number of lots to return from equipment location. Default=2, Range 2-6.
Lot Name PatternlotNamePatternStringThe lot name pattern as a combination of LotNumber, EquipmentName, MaterialName separated by commas. Default=LotNumber,EquipmentName.
 Appearance
NameScriptingProperty TypeDescription
Modified Icon PathmodifiedIconPathStringThe relative path of an icon image to indicate modified material values.
Alert Icon PathalertIconPathStringThe relative path of an icon image to indicate alert material values.

 

Event Handlers

Event handlers provide the ability to add custom script when a user interacts with a component such as by clicking a mouse, selecting a menu item or when a component property changes.

 mouse
 mouseClicked

This event signifies a mouse click on the source component. A mouse click the combination of a mouse press and a mouse release, both of which must have occurred over the source component. Note that this event fires after the pressed and released events have fired.

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseEntered

This event fires when the mouse enters the space over the source component.

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseExited

This event fires when the mouse leaves the space over the source component.

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mousePressed

This event fires when a mouse button is pressed down on the source component.

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseReleased

This event fires when a mouse button is released, if that mouse button's press happened over this component.

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseMotion
 mouseDragged

Fires when the mouse moves over a component after a button has been pushed.

 

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseMoved

Fires when the mouse moves over a component, but no buttons are pushed.

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 propertyChange
 propertyChange

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

PropertyDescription
.sourceThe component that fired this event.
.newValueThe new value that this property changed to.
.oldValueThe value that this property was before it changed. Note that not all components include an accurate oldValue in their events.
.propertyNameThe name of the property that changed. NOTE: Remember to always filter out these events for the property that you are looking for! Components often have many properties that change.

 


 

Extension Functions

 itemSelected
  • Description

Called after an MES lot or material is selected. In this function, lot can be changed on the fly when a selection is made. Return False to ignore the change.

  • Parameters

self - A reference to the component that is invoking this function.

mesObjectLink - MESObjectLink object containing the MESMaterialLot or MESMaterialDef details. Call mesObjectLink.getMESObject() to get the instance of the MESMaterialLot or MESMatrialDef object.

  • Return

1

  • Scope

Client

 


 

Custom Methods

Custom methods allow you to add your own component functions to a component that can be called through scripting. This is a useful and clean method of re-using script that is specific to the component (say you want to update a visual aspect of the component in the same way whether a user clicks on the component or a window property value changes). See Component Custom Methods in the Ignition Help Manual for more information.

 


 

Customizers

This component does not have any custom properties.


 

Component Functions

This component does not have functions associated with it.

  • No labels