Skip to end of metadata
Go to start of metadata

Description

An MES Object Selector is a dropdown component that allows user selection of MES objects. It contains many properties to filter the type and name of the MES object to include in the list.

You can select the MES objects from the list. The selected object may be displayed as shown below.



Component Palette



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 Object Selector').includeMaterialDefObjects = True

NameScriptingProperty TypeDescription
Name FilternameFilterStringFilter value, including * and ? wildcard characters, to filter the objects populating the drop down selection.
Enabled State FilterenabledStateFilterbooleanFilter for MES objects. Choices are Enabled, Disabled, or Both.
Custom Property Name FiltercustomPropertyNameFilterStringFilter value, including * and ? wildcard characters, to filter results by custom property names.
Custom Property Value FiltercustomPropertyValueFilterStringList of custom property name and value to filter results by.
Equipment Item PathequipmentItemPathStringEquipment path within the production model.
Excluded Equipment PathexcludedEquipmentPathStringComma separated string list to be excluded from equipment paths.
Exclude Inactive Equipment ObjectsexcludeInactiveEquipmentbooleanIf set to True, any inactive equipment in the Equipment Model is excluded from the object list.
Include Analysis Settings ObjectsincludeAnalysisSettingsObjectsbooleanIf true, including MES analysis settings objects. See Tech Note: MES Object Selector gives flexibility to select the analysis settings
Include Equipment Class ObjectsincludeEquipmentClassObjectsbooleanIf true, includes MES equipment class objects.
Include Equipment ObjectsincludeEquipmentObjectsbooleanIf true, including MES equipment objects.
Include Material Class ObjectsincludeMaterialClassObjectsbooleanIf true, including MES material class objects.
Include Material Def ObjectsincludeMaterialDefObjectsbooleanIf true, including MES material definition objects.
Include MES Area ObjectsincludeMESAreaObjectsbooleanIf true, including MES area objects.
Include MES Enterprise ObjectsincludeMESEnterpriseObjectsbooleanIf true, including MES enterprise objects.
Include MES Line Cell Group ObjectsincludeMESLineCellGroupObjectsbooleanIf true, including MES line cell group objects.
Include MES Line Cell ObjectsincludeMESLineCellObjectsbooleanIf true, including MES line cell objects.
Include MES Line ObjectsincludeMESLineObjectsbooleanIf true, including MES line objects.
Include MES Site ObjectsincludeMESSiteObjectsbooleanIf true, including MES site objects.
Include MES Storage Unit ObjectsincludeMESStorageUnitObjectsbooleanIf true, including MES storage unit objects.
Include MES Storage Zone ObjectsincludeMESStorageZoneObjectsbooleanIf true, including MES storage zone objects.
Include Operations Definition ObjectsincludeOperationsDefinitionObjectsbooleanIf true, including MES operations definition objects.
Include Operations Request ObjectsincludeOperationsRequestObjectsbooleanIf true, including MES operations request objects.
Include Operations Response ObjectsincludeOperationsResponseObjectsbooleanIf true, including MES operations response objects.
Include Operations Segment ObjectsincludeOperationsSegmentObjectsbooleanIf true, including MES operations segment objects.
Include Person ObjectsincludePersonObjectsbooleanIf true, including MES person objects.
Include Personnel Class ObjectsincludePersonnelClassObjectsbooleanIf true, including MES personnel class objects.
Include Process Segment ObjectsincludeProcessSegmentObjectsbooleanIf true, including MES process segment objects.
Include Request Segment ObjectsincludeRequestSegmentObjectsbooleanIf true, including MES request segment objects.
Include Response Segment ObjectsincludeResponseSegmentObjectsbooleanIf true, including MES response segment objects.
Parent MES Object FilterparentMESObjectFilterStringMES Object Link to parent MES Object. Typically, this property is bound to the Selected MES Object ("selectedMESObject") of another MES Object Selector component (daisy-chaining selectors, where the upstream selector provides a category or location and the downstream selector presents a list of only the objects assigned to that category or location).
Parent MES Object PathparentMESObjectPathStringEquipment Path of the parent MES Equipment object to filter the results by. This property provides similar filtering functionality as the Parent MES Object Filter property shown in the row above, but works via a binding or entry to this property instead of coming from an upstream MES Object Selector component.
Parent MES Object Name FilterprimaryClassFilterStringName of the parent MES Class object to filter the results by. When provided with an existing Class Name, the results will be filtered to only the members of this Class.
Selected MES ObjectselectedMESObjectStringThe selected MES object link.
Selected NameselectedNameStringName of the selected MES object.
Selected UUIDselectedUUIDStringUnique identifier of the selected MES object.
Show Equipment PathshowEquipmentPathbooleanIf true, the selector will show MES equipment class names with equipment paths.


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.

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.

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.

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.

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.

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.

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.

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.

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

  • Description

Called when a MES object is selected.

  • Parameters

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

mesObjectLink - The MESObjectLink that contains a reference to the selected MES object. Use mesObjectLink.getMESObject() to get the MES object 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 provide the following functions 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 Object Selector').clearSelection().

  • Description

Deselects the previous selection.

  • Parameters

None

  • Return

Nothing

  • Scope

Client

  • Description

Returns the parent MES object to filter the results by.

  • Parameters

None

  • Return

 MESObjectLink parentMESObjectFilter - The parent MES object filter.

  • Scope

Client

  • Description

Gets the path of the parent MES object to filter the results by.

  • Parameters

None

  • Return

String path - The path of the parent MES object.

  • Scope

Client

  • Description

Returns the selected MES object.

  • Parameters

None

  • Return

MESObjectLink objLink - The link to the selected MES object.

  • Scope

Client

  • Description

Returns the selected MES object types.

  • Parameters

None

  • Return

MESObjectTypes types - The object types of the selected MES objects.

  • Scope

Client

  • Description

Sets the equipment item path.

  • Parameters

String equipmentItemPath - The path to set for the equipment item.

  • Return

Nothing

  • Scope

Client

  • Description

Excludes inactive equipment defined in the Equipment Model.

  • Parameters

Boolen - Set to True to exclude inactive equipment.

  • Return

Nothing

  • Scope

Client

  • Description

Sets the path of the equipment to be excluded.

  • Parameters

String excludedEquipmentPath - The path of the equipment to be excluded.

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes MES equipment class objects.

  • Parameters

boolean includeEquipmentClassObjects - Set to true to include MES equipment class objects.

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes MES equipment objects.

  • Parameters

boolean includeEquipmentObjects - Set to true to includes MES equipment objects.

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes MES area objects.

  • Parameters

boolean includeAreaObjects - Set to true to includes MES area objects.

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes MES enterprise objects.

  • Parameters

boolean includeEnterpriseObjects - Set to true to includes MES enterprise objects.

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes MES line cell group objects.

  • Parameters

boolean includeLineCellGroupObjects - Set to true to includes MES line cell group objects.

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes MES line cell objects.

  • Parameters

boolean includeLineCellObjects - Set to true to includes MES line cell objects

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes MES line objects.

  • Parameters

boolean includeLineObjects - Set to true to includes MES line objects

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes MES site objects.

  • Parameters

boolean includeSiteObjects - Set to true to includes MES site objects

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes MES storage unit objects.

  • Parameters

boolean includeStorageUnitObjects - Set to true to includes MES storage unit objects

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes MES storage zone objects.

  • Parameters

boolean includeStorageZoneObjects - Set to true to includes MES storage zone objects.

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes MES material class objects.

  • Parameters

boolean includeMaterialClassObjects - Set to true to includes MES material class objects

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes MES material definition objects.

  • Parameters

boolean includeMaterialDefObjects - Set to true to includes MES material definition objects.

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes operations definition objects.

  • Parameters

boolean includeOperationsDefinitionObjects - Set to true to includes MES operations definition objects

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes operations request objects.

  • Parameters

boolean includeOperationsRequestObjects - Set to true to includes MES operations request objects

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes operations response objects.

  • Parameters

boolean includeOperationsResponseObjects - Set to true to includes MES operations response objects

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes operations segment objects.

  • Parameters

boolean includeOperationsSegmentObjects - Set to true to includes MES operations segment objects.

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes person objects.

  • Parameters

boolean includePersonObjects - Set to true to includes MES person objects.

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes personnel class objects.

  • Parameters

boolean includePersonnelObjects - Set to true to includes MES personnel objects.

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes process segment objects.

  • Parameters

boolean includeProcessSegmentObjects - Set to true to includes MES process segment objects.

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes request segment objects.

  • Parameters

boolean includeRequestSegmentObjects - Set to true to includes MES request segment objects.

  • Return

Nothing

  • Scope

Client

  • Description

If set to true, includes response segment objects.

  • Parameters

boolean includeResponseSegmentObjects - Set to true to includes MES response segment objects

  • Return

Nothing

  • Scope

Client

  • Description

Sets the parent MES object to filter the results by.

  • Parameters

MESObjectLink parentMESObjectFilter - The parent MES object to filter the results by.

  • Return

Nothing

  • Scope

Client

  • Description

Set the path of the parent MES object to filter the results by.

  • Parameters

String parentMESObjectPath - The path of the parent MES object to filter the results by.

  • Return

Nothing

  • Scope

Client

  • Description

Sets the selected MES object link.

  • Parameters

MESObjectLink selectedMESObject - The selected MES object link to be set.

  • Return

Nothing

  • Scope

Client

  • Description

Sets the MES object types to be selected.

  • Parameters

String mesObjectTypes - The MES object types to be selected. This input String is comma delimited. The MES object types are listed on page: MES Object Type Name

  • Return

Nothing

  • Scope

Client

  • Description

Set to True to display equipment paths.

  • Parameters

boolean showEquipmentPath - If set to True, the equipment paths are displayed.

  • Return

Nothing

  • Scope

Client

  • Description

Sets the selected MES object link and updates the display text.

  • Parameters

MESObjectLink selectedMESObject - The selected MES object link to be set.

  • Return

Nothing

  • Scope

Client


Code Snippet
#The following script is placed in the event handler "internalFrame --> internalFrameActivated" for the window
#containing the MES Object Selector component. It will execute whenever the window is shown or focused.

#Function init() will be executed using the Ignition utility function system.util.invokeLater(). 
#It will use the method .updateSelected() to update the MES Object Selector to the MES Object held in the 
#variable uuid, and also update the MES Object Selector text display field.
def init():
	uuid = '59abcf21-241d-459c-9652-07fc01ee3fe5 '
	objLink = system.mes.getMESObjectLink(uuid)
	system.gui.getParentWindow(event).getComponentForPath('Root Container.MES Object Selector').updateSelect(objLink)
	#The method above replaces the method below so that the MES Object Selector text display field will also get updated.
	#system.gui.getParentWindow(event).getComponentForPath('Root Container.MES Object Selector').setSelectedMESObject(objLink)

#The function init() will be run after a short delay to give the MES Object Selector time to initialize. 
#Otherwise, the MES Object Selector will miss the change to any new MES object selection and its text display field
#will either remain blank or will continue to display the text for the previous MES object selection.
system.util.invokeLater(init, 250)
  • No labels