Skip to end of metadata
Go to start of metadata

Description

A component to allow auto complete selection of MES Material Lot or MES Material Sublot objects. It contains many properties to filter the MES Material Lot or MES Material Sublot objects to include in the list. The auto complete feature will include only appropriate names that start with what the user has typed. This is very useful so scrolling of large lists does not have to be done and full lot or serial number does not have to be typed in.

There are two possible modes that the MES Lot Selector component can be used. If the Mode property is set to Lot, then the selector will be populated with MES Material Lot objects. If the Mode property is set to Sublot, then the selector will be populated with MES Material Sublot objects.

The Max Results property prevents a huge number of options from being loaded from the database along with all of the overhead of passing then to the client when the user will not use all of them. This along with the Begin Date Time and End Date Time properties, keep from taking up unneeded resources.

 

Component Palette


 

Component Properties

Info

Please go through the MES Inventory Filter for more details on each property.

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 Lot Selector').includeActiveLots= True

 Data
NameScriptingProperty TypeDescription
Include Active LotsincludeActiveLotsBooleanIf true, include lots that are currently being processed.
Include Inactive LotsincludeInactiveLotsBooleanIf true, include lots that are done being processed.
Lot Status FilterlotStatusFilterStringFilter value, including * and ? wildcard characters, to filter results by lot status.
Include Lot SequenceincludeLotSequenceBooleanIf true, include an item for each lot number and sequence combination.
Begin Date TimebeginDateTimeDateTimeThe beginning date and time to include in the results. Only valid when Include Inactive Lots property is set to true.
End Date TimeendDateTimeDateTimeThe ending date and time to include in the results. Only valid when Include Inactive Lots property is set to true.
Lot Name FilterlotNameFilterStringFilter value, including * and ? wildcard characters, to filter results by lot names.
Sublot Name FiltersublotNameFilterStringFilter value, including * and ? wildcard characters, to filter results by sublot names.
Lot Equipment Name FilterlotEquipmentNameFilterStringFilter value, including * and ? wildcard characters, to filter results by lot location names.
Lot Equipment Path FilterlotEquipmentPathFilterStringFilter value, including * and ? wildcard characters, to filter results by lot location paths.
Lot Equipment Class Name FilterlotEquipmentClassFilterStringFilter value, including * and ? wildcard characters, to filter results by class of lot location names.
Personnel Name FilterpersonnelNameFilterStringFilter value, including * and ? wildcard characters, to filter results by personnel names.
Personnel Class Name FilterpersonnelClassFilterStringFilter value, including * and ? wildcard characters, to filter results by personnel class names.
Material Name FiltermaterialNameFilterStringFilter value, including * and ? wildcard characters, to filter results by material names.
Material Class Name FiltermaterialClassFilterStringFilter value, including * and ? wildcard characters, to filter results by material class names.
Operation Name FilteroperationNameFilterStringFilter value, including * and ? wildcard characters, to filter results by operation names.
Segment Name FiltersegmentNameFilterStringFilter value, including * and ? wildcard characters, to filter results by segment names.
Segment Equipment Name FiltersegmentEquipmentNameFilterStringFilter value, including * and ? wildcard characters, to filter results by segment location names.
Segment Equipment Path FiltersegmentEquipmentPathFilterStringFilter value, including * and ? wildcard characters, to filter results by segment location paths.
Segment Equipment Class Name FiltersegmentEquipmentClassFilterStringFilter value, including * and ? wildcard characters, to filter results by class of segment location names.
Custom Property Value FiltercustomPropertyValueFilterStringList of custom property name and value to filter results by. (E.g. "MaterialLot.CustomPropertyName=Value")
Result LimitresultLimitintAmount to limit the number of lots to show in the selector.
Selected UUIDselectedUUIDStringThe selected operation UUID.
Selected NameselectedNameStringThe selected operation Name.
Selected Lot UUIDselectedLotUUIDStringThe lot UUID for the currently selected lot.
Selected Lot NameselectedLotNameStringThe lot Name for the currently selected lot.
Selected Sublot UUIDselectedSublotUUIDStringThe sublot UUID for the currently selected lot.
Selected Sublot NameselectedSublotNameStringThe sublot Name for the currently selected lot.

 

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

 lotSelected
  • Description

Called before an MES Material is selected. Return false to prevent the MES Material Lot from being started.

  • Parameters

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

mesMaterialLot - The MESMaterialLot reference object. Use mesMaterialLot.getMESObject() to get the MES Material Lot itself.

  • 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 provides the following function that can be called on it. If this component has been dropped onto the windows root container, the path and an example call would be event.source.parent.getComponent('MES Lot Selector').refresh().

 refresh()
  • Description

Updates contents to reflect any updates to the database since the object was created, or since the last refresh. By default, refresh is automatic for local operations when view navigation touches an update.

  • Parameters

None

  • Return

Nothing

  • Scope

Client

  • No labels