Description

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. 

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.

event.source.parent.getComponent('MES Analysis Selector').previousDrillDownEnabled = True

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

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

Refer the Setting Values section.

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.

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.

Using Parameters

Both the Analysis Selector and Analysis Controller support parameter passing to filters in two different ways.

1. You can use the getParameterValue() extension function to pass the value to the named parameter
2. You can add a custom property to the component with the same name as the filter parameter and populate it with the value you want to use for the filter
   
   

Parameters that are added as custom properties will appear in the Parameter drop down in the filter configuration panel. They will not appear if added to the getParameterValue() extension function but can be typed in. This is filtered to custom properties with the same data type as the analysis item selected to be filtered.  

Points to remember while using custom property method

• Custom property name should not have the preceding @ character that appears in the filter expression. 
• Parameters can be manually typed in the filter expression. 
• All parameters start with the @ character. 
• When the analysis is executed, all parameter references in the filter expression will be resolved in the following order. First, a check to see if the custom property exists. If it does, the value will be assigned to the parameter. Second, the getParameterValue extension function will be called. If a value was assigned from the custom property step, then it will be passed into the extension function. The extension function can change the parameter value or return None to keep the current value.

For example, filtering on Equipment Path will only show custom properties with String data types. When filtering on the Schedule Rate analysis item, then custom properties with numeric data types will be shown. 

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.

For details on using a Custom Property as a variable for the Equipment Path in the MES Analysis Selector component, refer to the Knowledge Base page Using a Custom Property for Equipment Path in MES Analysis.

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

Extension Functions

def getParameterValue(self, name):
	
	##In this case, we check for the parameter named "eqPath", short for Equipment Path.
	##Return the parameter value as the Equipment Item Path of the MES Object Selector in the root container.
	##Note that this enables the use of the Stored Analysis in a Report (with parameter "@eqPath") and in Vision Module
	##screens with this Extension Function.
	if name == 'eqPath':
	
		return self.parent.getComponent('MES Object Selector').equipmentItemPath

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'