MES Analysis Selector

MES Analysis Selector | Vision

The MES analysis selector component allows for ad hoc selection of analysis data. Analysis Results can be limited based on the selected Data Points, Filter By, Group By and Order By settings.

Features

Reporting

The Analysis Selector is exposed to support the configuration of "MES Analysis" data sources in the Ignition Reporting Module Data tab. Stored Analysis settings used on the operator screens may also be applied to reports. 

A difference for Reports over Screens is the use of Report Parameters to bind data automatically.

In this example the Equipment Path property will be bound to the Report parameter eqPath. This will allow an equipment path to be passed to the report and used in the analysis rather than statically assigning the path.

When selected with the Add Expression button, the filter will be shown as "Equipment Path = @eqPath". Since this notation differs slightly from custom properties in the Vision Module, check the above example for the extension function getParameterValue() which will set the parameter value so that the same Stored Analysis settings may be used for Reports and On-Screen analysis.

The rest of the features function like the Vision Module version of the Analysis Selector.

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

def loadIcon(self, iconName):
	#Return a path to a different image to replace the default delete image:
	if iconName == 'remove':
		return 'Builtin/icons/24/delete2.png'

Data

Name	Scripting	Property Type	Description
Refresh on Settings Change	refreshOnSettingsChange	boolean	If true, automatically refresh when analysis settings values change.
Data	data	Dataset	Dataset that contain the analysis results.
Ignition Dataset	ignitionDataset	Dataset	Analysis results returned in an Ignition component friendly dataset. This property is not visible from the properties tab, but is accessbile for bindings to other components.
Drill Down Options	drillDownOptions	Dataset	Dataset containing drill down options.
Previous Drill Down Enabled	previousDrillDownEnabled	boolean	If true, then prevDrillDown.
Message	message	String	Message returned with the analysis results.
Drill Down Bread Crumb	drillDownBreadCrumb	String	A string representing the drill down path.
showMessage	Show Message	boolean	If true, show the message returned with the analysis results.
Start Date	startDate	DateTime	Start date to get filter values.
End Date	endDate	DateTime	End date to get filter values.
Execution Time (ms)	executionTime	long	Analysis execution time in milliseconds.
is Public	isPublic	Boolean	If true, settings can be synchronized across Gateways based on the Synchronization Strategy. Use the property with Synchronization Strategy, Included in Sepasoft Versions: MES 3.81.3 and later MES 3.79.3 and later
Synchronization Strategy	synchronizationStrategy	String	Options: No Synchronization Child Gateways Only Parent Gateways Only Both Parent and Child Gateways Included in Sepasoft Versions: MES 3.81.3 and later MES 3.79.3 and later

Appearance

General Settings

Name

A Unique name for the analysis settings. 

Description

An optional description for the new analysis settings.

Scope 

Scope refers to the availability of an analysis settings for use by another user. The scope of Analysis Settings can be set to either public or private. 

Permissions

Roles containing invalid characters will not be displayed in the Permissions table.

You can assign permissions to Administrator and individual users to execute and/or modify the analysis settings. Check the corresponding boxes to do the same as shown. Only security roles that the current logged user belongs to will be shown in the list. After the user is added to a security role, they will have to relog into the designer or client before it will appear in the list. This is when Ignition updates the list containing security roles that we have available.

Settings

Filters

A filter can be added by selecting the  link to the right of Filter By. The window panel will open and filter categories will be displayed as shown in the screenshot. Multiple filters can be added using expressions. To add expression first select a filter and then a logical operator (horizontal list). Now select a operator (vertical list) and then add the next filter.

Filters follow a format similar to SQL in that you can use AND, OR and LIKE operators.

The Filter By expression character length is limited to 1000.

Allowable Key Words

Operator expression key words inside string parameters (in either upper or lower or mixed case), such as 'AND', 'OR', 'LIKE', 'IS NULL', 'IS NOT NULL' and 'IN' will be safely ignored. Therefore, these key words are permissible (example: Equipment Path = 'My Enterprise\Site\Area\Line\Block and Tackle').

Deleted Equipment

When equipment items are deleted, they will no longer appear in the Analysis Selector filter lists.

Wildcards

'*' can be used as a wildcard in your expressions. When filtering using the Equipment Path datapoint with a wildcard, data can be returned at the Enterprise, Site, Area, Line or Cell level. 

Example:

• Equipment Path LIKE 'Nuts Unlimited\Folsom\Mixing\Mixing Line*' will only return data at the line level (not cell) for lines in the mixing area that begin with 'Mixing Line...'.
• Equipment Path LIKE 'Nuts Unlimited\Folsom\Mixing\Mixing Line 1\*' will only return data for cells under Mixing Line 1.
  
• Equipment Path LIKE 'Nuts Unlimited\Folsom\*\*' will return totals for all Lines in all Areas in the Folsom site.
• Equipment Path LIKE 'Nuts Unlimited\*\*\*' will return totals for all Lines in all Areas in all Sites of the "Nuts Unlimited" Enterprise.

As such, if you create an Analysis with the datapoints "OEE", "OEE Availability", "OEE Performance", and "OEE Quality", and set your Filter Expression to Equipment Path LIKE '*\*\*\*', the Analysis engine will produce the OEE values for the entire Enterprise.

Filter By Equipment Path

It is required to include Equipment Path in the Filter By expression in some form. Doing so will help analysis operate more efficiently. As a reminder, an Info message will appear if an analysis is run (e.g. using the Refresh Analysis button  ) without including Equipment Path.  It is recommended that Equipment Path be the first expression in the total Filter By expression. Note: In the MES Analysis Controller component, the Error Message field will contain the reminder message:

Filter Example

Operation UUID != ''  AND Equipment Path = @LinePath  AND Shift LIKE @ShiftName

Click the link by the filter category and specific filter items will be displayed.

When selected they will be added to the filters as shown below.

To minimize the number of filter options, only the options for the selected date range defined by the Start Date and End Date properties will be shown.

Compare By and Data Points work similarly to Filter By except there are no categories for these selections, just items. Selections can be removed by clicking icon and unchecking the appropriate box. Analysis settings can be deleted by hitting the delete icon.

Group By

The Group By will not accept the following data points (they will be excluded from the available choices):

• Line Downtime Occurrence Count
• Line Schedule Count
• Line Schedule Duration
• Schedule Rate

Drill Down

When the MES Analysis Selector is bound to a Sepasoft Analysis Table component, data drill down capabilities become available for any row in the table (the Analysis Table is basically an Ignition Table component with Drill Down capability added). This provides further-refined Analysis Results based on selecting an additional drill-down Data Point. Once a Data Point is selected from the Drill Down menu, the MES Analysis Selector component is triggered to run a new Analysis using the selected Data Point in place of the first Data Point currently listed in the Data Points field. The first column in the Analysis table becomes the selected Drill Down Data Point.

Drill Down Example

Event Handlers

Event handlers provide the ability to add custom script when a user interacts with a component.

propertyChange

Extension Functions

afterUpdate

beforeUpdate

getParameterValue

def loadIcon(self, iconName):
	#Return a path to a different image to replace the default delete image:
	if iconName == 'remove':
		return 'Builtin/icons/24/delete2.png'

loadIcon

def loadIcon(self, iconName):
	#Return a path to a different image to replace the default delete image:
	if iconName == 'remove':
		return 'Builtin/icons/24/delete2.png'

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

Custom Properties

The custom properties can be used to add user defined 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 Analysis Selector').clearDrillDownHistory().

clearDrillDownHistory()

drillDown(compareByName, filterValue)

prevDrillDown

executeAnalysis()

Data Points and Settings

See: Analysis Data Points and Settings