Skip to end of metadata
Go to start of metadata

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.

Watch the Video


Component Palette




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
event.source.parent.getComponent('MES Analysis Selector').previousDrillDownEnabled = True

 Data
NameScriptingProperty TypeDescription
Refresh on Settings ChangerefreshOnSettingsChangebooleanIf true, automatically refresh when analysis settings values change.
DatadataDatasetDataset that contain the analysis results.
Ignition DatasetignitionDatasetDatasetAnalysis 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 OptionsdrillDownOptionsDatasetDataset containing drill down options.
Previous Drill Down EnabledpreviousDrillDownEnabledbooleanIf true, then prevDrillDown.
MessagemessageStringMessage returned with the analysis results.
Drill Down Bread CrumbdrillDownBreadCrumbStringA string representing the drill down path.
showMessageShow MessagebooleanIf true, show the message returned with the analysis results.
Start DatestartDateDateTimeStart date to get filter values.
End DateendDateDateTimeEnd date to get filter values.
Execution Time (ms)executionTimelongAnalysis execution time in milliseconds.
 Appearance
NameScriptingProperty TypeDescription
Title FonttitleFontFont

Font to use for the title bar.

Title Foreground ColortitleForegroundColorForeground color of the title bar.
Title Background ColortitleBackgroundColorBackground color of the title bar.
slidePanelWidthSlide Panel WidthintWidth of the slide panel.


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 settings. 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

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.

The Filter By expression character length is limited to 256 in version 2.9.1 SP2 and earlier.  From 2.9.2 onwards, the character count is limited to 1000.

Wildcards

'*' can be used as a wildcard in your expressions. When filtering using the Equipment Path datapoint with a wildcard, data will be only be returned either at the line level or the 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

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

You can't use both methods at the same time. If you use the custom property method, do not use the getParameterValue() extension function at the same time.


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.


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.



Event Handlers

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

 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

 getParameterValue
  • Description

Called to get a parameter value.

  • Parameters

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

name - The parameter name as a string.

  • Return

The parameter value.

  • Scope

Client

Code Snippet
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
 beforeUpdate
  • Description

Called just before analysis data is refreshed.

  • Parameters

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

  • Return

Nothing

  • Scope

Client

 afterUpdate
  • Description

Called just after analysis data is refreshed.

  • Parameters

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

data - The dataset that contains the new analysis data.

  • Return

Nothing

  • 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

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()
  • Description

Removes the drill down history.

  • Parameters

None

  • Return

Nothing

  • Scope

Client

 drillDown(compareByName, filterValue)
  • Description

Sets all the analysis selections to new state dictated by the drill down definition.

  • Parameters

String compareByName - The compareBy definition to base the drill down.

String filtervalue - The value for filtering the analysis selections.

  • Return

Nothing

  • Scope

Client

 prevDrillDown
  • Description

Sets all the analysis selections to the previous state before the last drill down.

  • Parameters

None

  • Return

Nothing

  • Scope

Client

 exectuteAnalysis()
  • Description

Causes analysis results to update with current result.

  • Parameters

None

  • Return

Nothing

  • Scope

Client



Data Points and Settings

Analysis Data Points and Settings are used by Live Analysis, the MES Analysis Selector and MES Analysis Controller components, the MES Analysis Data Source for reporting and the MES Analysis Settings object.

Watch the Video




Equipment Data Points

Data PointData TypeDescriptionUnits
Equipment

Equipment Cell Order

Int4Integer value that determines the cell order of the equipment within the line. Is set to null for the line. Is set to 0 for first cell within each cell group.N/A

Equipment Name

StringName of the equipment as defined in the production model.N/A
Equipment NoteStringAny note that has been recorded for this piece of equipment through the Note tag collector path in the Production model will be exposed here.N/A
Equipment Operation BeginDateTimeStart Date Time of the currently running operation on this equipment.N/A

Equipment Operation Sequence

Int4The ordinal number (integer) of operation.N/A

Equipment Path

StringProduction model path for this equipment.N/A

Equipment Type

StringCan be Line, Cell Group or Cell.N/A
Execution Time (ms)Int8Time taken to execute and update the Live Analysis. Used mainly for performance debugging.milliseconds
From Time StampDateTimeStart Date Time of current data point results.N/A

Infeed Units

StringSee Infeed Units for more details.This could be Cans, Bottles, etc.

Is Key Cell

BooleanSee Key Reason for more details.N/A

Operation UUID

StringUnique Identifier for currently running operation.N/A

Outfeed Units

StringSee Outfeed Units for more details.This could be Cans, Bottles, etc.

Product Code

StringProduct code currently being processed on this equipment.N/A

Rate Period

StringSee Rate Period for more details.Options: Hours or Minutes

Reject Units

StringSee Reject Units for more details.This could be Cans, Bottles, etc.
To Time StampDateTimeEnd Date Time of current data point results.N/A

Work Order

StringWork order currently being processed on this equipment.N/A





Equipment Count Data Points

Data PointData TypeDescriptionUnits
Equipment\Count*Any defined counters for the production item will also appear in this folder

Equipment Infeed Scale

Float8See Infeed Count Scale for more details.N/A

Equipment Package Count

Float8See Package Count for more details.N/A

Equipment Reject Scale

Float8See Reject Count Scale for more details.N/A



Equipment Cycle Time Data Points

The Cycle Time data points provide a number of metrics that can be used to measure the amount of time required to produce one piece. It is often used to gain an understanding of variations in production. The Cycle Time calculations are based on the Cycle Count value provided to the system.  Analysis provides Target, Normal, Overall, and Precise Cycle Time metrics.  Details of the calculations are described below.


Included in AnalysisNot Included in Analysis

States Analyzed Per Cycle Metric

Cycle Time Metric

Running

Unplanned Downtime

Planned Downtime

Starved

Blocked

Idle

Disabled

Overall Cycle Time








Normal Cycle Time








Precise Cycle Time









 Cycle Time In Detail...

Cycle Time Calculations

There are 3 different representations of cycle time that are available to users when using Analysis. Each filters run state date differently.

Overall Cycle Time Calculations

Overall Cycle Time

Overall Cycle time is defined as including all time in which the equipment is in any state except a disabled state.

overallCycleTime = analysisRowTime - disabledTime

Maximum Overall Cycle Time

Maximum Overall Cycle Time is defined as the cycle with the largest overall time in the scope of the analysis row.

Look at each of the cycles time periods, subtract any time the equipment was in a disabled state, then select the largest value.

Minimum Overall Cycle Time

Minimum Overall Cycle Time is defined as the cycle with the smallest overall time in the scope of the analysis row.

Look at each of the cycles time periods, subtract any time the equipment was in a disabled state, then select the smallest value.

Average Overall Cycle Time

Average Overall Cycle Time is defined as the average overall time per completed cycle in the scope of the analysis row.

averageOverallCycleTime = overallCycleTime / numberOfCompletedCycles



Normal Cycle Time Calculations

Normal Cycle Time

Normal Cycle time is defined as including all time in which the equipment is in any state except for disabled, idle, planned downtime, blocked, or starved.

normalCycleTime = analysisRowTime - (disabledTime + blockedTime + starvedTime)

Maximum Normal Cycle Time

Maximum Normal Cycle Time is defined as the cycle with the largest normal time in the scope of the analysis row.

Look at each of the cycles time periods, subtract any time the equipment was in a disabled, idle, planned downtime, blocked, or starved state, then select the largest value.

Minimum Normal Cycle Time

Minimum Normal Cycle Time is defined as the cycle with the smallest normal time in the scope of the analysis row.

Look at each of the cycles time periods, subtract any time the equipment was in a disabled, idle, planned downtime, blocked, or starved state, then select the smallest value.

Average Overall Cycle Time

Average Normal Cycle Time is defined as the average normal time per completed cycle in the scope of the analysis row.

averageNormalCycleTime = normalCycleTime / numberOfCompletedCycles



Precise Cycle Time Calculations

Precise Cycle Time

Precise Cycle time is defined as including all time in which the equipment is in the running state only.

preciseCycleTime=analysisTime-(anyTimeNotRunning)

Maximum Precise Cycle Time

Maximum Precise Cycle Time is defined as the cycle with the largest precise time in the scope of the analysis row.

Look at each of the cycles time periods, subtract any time the equipment was not in a running state, then select the largest value.

Minimum Precise Cycle Time

Minimum Precise Cycle Time is defined as the cycle with the smallest precise time in the scope of the analysis row.

Look at each of the cycles time periods, subtract any time the equipment was not in a running state, then select the smallest value.

Average Precise Cycle Time

Average Precise Cycle Time is defined as the average precise time per completed cycle in the scope of the analysis row.

averagePreciseCycleTime = preciseCycleTime / numberOfCompletedCycles



Example:

The diagram below represents an analysis sample looking at a scope of 50 minutes. Each sample varies in complexity of calculation of cycle time and counts.



Important Things to Note

  • Each Time Tick represents 1 minute.

  • The scope of each Analysis Row (delimited by Analysis Endpoints) is 10 minutes.

  • Each part takes 2 minutes of Production Time to make.

  • Minimum, Maximum, and Average Cycle Time calculations only look at the completed cycles within the analysis rows. Cycle times can span previous rows.



Calculation Complexity Definitions

Complexity

Description

Low

Very simple to calculate all different cycle times. (Overall, Normal, and Precise the same)

Medium

A little more difficult to calculate different cycle times. (At least 2 types have different results.) May have cycles extending past the analysis scope.

High

The most difficult to calculate different cycle times. (All types have different results.) Has cycles extending past the analysis scope.



 Sample 1 (High Complexity)


Sample 1 (High Complexity)

Cycle Time Length

Type

Time Calculation

Value

Overall Cycle Time

tanalysis

10 minutes

Normal Cycle Time

tanalysis - t2

9 minutes

Precise Cycle Time

tanalysis - (t2 + t6)

7 minutes

Min Cycle Time (note)

Type

Cycle Time Calculation

Min Cycle Time (mins)


Min Overall Cycle Time

C1overall: t0 = 2 mins

C2overall: t1+t2+t3 = 3 mins

C3overall: t4 = 2 mins


2 minutes


Min Normal Cycle Time

C1normal: t0 = 2 mins

C2normal: t1+t3 = 2 mins

C3normal: t4 = 2 mins


2 minutes


Min Precise Cycle Time

C1precise: t0 = 2 mins

C2precise: t1+t3 = 2 mins

C3precise: t4 = 2 mins


2 minutes

Max Cycle Time (note)

Type

Cycle Time Calculation

Max Cycle Time (mins)

Max Overall Cycle Time

Same as Min Cycle Time

3 minutes

Max Normal Cycle Time

Same as Min Cycle Time

2 minutes

Max Precise Cycle Time

Same as Min Cycle Time

2 minutes

Average Cycle Time (note)

Type

Avg Time Calculation

Avg Value

Average Overall Cycle Time

(C1overall + C2overall + C3overall) / 3 cycles

(2 mins + 3 mins +2 mins) / 3 cycles

2.33 minutes

Average Normal Cycle Time

(C1normal + C2normal + C3normal) / 3 cycles

(2 mins + 2 mins + 2 mins) / 3 cycles

2.00 minutes

Average Precise Cycle Time

(C1precise + C2precise + C3precise) / 3 cycles

(2 mins + 2 mins + 2 mins) / 3 cycles

2.00 minutes



 Sample 2 (Medium Complexity)


Sample 2 (Medium Complexity)

Type

Time Calculation

Value

Overall Cycle Time

tanalysis

10 minutes

Normal Cycle Time

tanalysis

10 minutes

Precise Cycle Time

tanalysis - t9

6 minutes

Min Cycle Time (note)

Type

Cycle Time Calculation

Min Cycle Time (mins)


Min Overall Cycle Time

C4overall: t7+t8+t9+t10 = 8 mins

C5overall: t11 = 2 mins

C6overall: t12 = 2 mins


2 minutes


Min Normal Cycle Time

C4normal: t7+t8+t9+t10 = 8 mins

C5normal: t11 = 2 mins

C6normal: t12 = 2 mins


2 minutes


Min Precise Cycle Time

C4precise: t7+t10 = 2 mins

C5precise: t11 = 2 mins

C6precise: t12 = 2 mins


2 minutes

Max Cycle Time (note)

Type

Cycle Time Calculation

Max Cycle Time (mins)

Max Overall Cycle Time

Same as Min Cycle Time

8 minutes

Max Normal Cycle Time

Same as Min Cycle Time

8 minutes

Max Precise Cycle Time

Same as Min Cycle Time

2 minutes

Average Cycle Time (note)

Type

Avg Time Calculation

Avg Value

Average Overall Cycle Time

(C4overall + C5overall + C6overall) / 3 cycles

(8 mins + 2 mins +2 mins) / 3 cycles

4.00 minutes

Average Normal Cycle Time

(C4normal + C5normal + C6normal) / 3 cycles

(8 mins + 2 mins + 2 mins) / 3 cycles

4.00 minutes

Average Precise Cycle Time

(C4precise + C5precise + C6precise) / 3 cycles

(2 mins + 2 mins + 2 mins) / 3 cycles

2.00 minutes



 Sample 3 (Medium Complexity)


Sample 3 (Medium Complexity)

Cycle Time Length

Type

Time Calculation

Value

Overall Cycle Time

tanalysis

10 minutes

Normal Cycle Time

tanalysis - t20

9 minutes

Precise Cycle Time

tanalysis - t20

9 minutes

Min Cycle Time (note)

Type

Cycle Time Calculation

Min Cycle Time (mins)



Min Overall Cycle Time

C7overall: t14+t15 = 2 mins

C8overall: t16 = 2 mins

C9overall: t17 = 2 mins

C10overall: t18 = 2 mins

C11overall: t19 = 2 mins



2 minutes



Min Normal Cycle Time

C7normal: t14+t15 = 2 mins

C8normal: t16 = 2 mins

C9normal: t17 = 2 mins

C10normal: t18 = 2 mins

C11normal: t19 = 2 mins



2 minutes



Min Precise Cycle Time

C7precise: t14+t15 = 2 mins

C8precise: t16 = 2 mins

C9precise: t17 = 2 mins

C10precise: t18 = 2 mins

C11precise: t19 = 2 mins



2 minutes

Max Cycle Time (note)

Type

Cycle Time Calculation

Max Cycle Time (mins)

Max Overall Cycle Time

Same as Min Cycle Time

2 minutes

Max Normal Cycle Time

Same as Min Cycle Time

2 minutes

Max Precise Cycle Time

Same as Min Cycle Time

2 minutes

Average Cycle Time (note)

Type

Avg Time Calculation

Avg Value

Average Overall Cycle Time

(C7overall + C8overall + C9overall + C10overall + C11overall)/ 5 cycles

(2 mins + 2 mins + 2 mins + 2 mins +2 mins) / 5 cycles

2.00 minutes

Average Normal Cycle Time

(C7normal + C8normal + C9normal + C10normal + C11normal)/ 5 cycles

(2 mins + 2 mins + 2 mins + 2 mins +2 mins) / 5 cycles

2.00 minutes

Average Precise Cycle Time

(C7precise + C8precise + C9precise + C10precise + C11precise)/ 5 cycles

(2 mins + 2 mins + 2 mins + 2 mins +2 mins) / 5 cycles

2.00 minutes



 Sample 4 (Medium Complexity)


Sample 4 (Medium Complexity)

Cycle Time Length

Type

Time Calculation

Value

Overall Cycle Time

tanalysis

10 minutes

Normal Cycle Time

tanalysis - t22

6 minutes

Precise Cycle Time

tanalysis - t22

6 minutes

Min Cycle Time (note)

Type

Cycle Time Calculation

Min Cycle Time (mins)


Min Overall Cycle Time

C12overall: t21+t22+t23 = 7 mins

C13overall: t24 = 2 mins

C14overall: t25 = 2 mins


2 minutes


Min Normal Cycle Time

C12normal: t23 = 2 mins

C13normal: t24 = 2 mins

C14normal: t25 = 2 mins


2 minutes


Min Precise Cycle Time

C12precise: t23 = 2 mins

C13precise: t24 = 2 mins

C14precise: t25 = 2 mins


2 minutes

Max Cycle Time (note)

Type

Cycle Time Calculation

Min Cycle Time (mins)

Max Overall Cycle Time

Same as Min Cycle Time

7 minutes

Max Normal Cycle Time

Same as Min Cycle Time

2 minutes

Max Precise Cycle Time

Same as Min Cycle Time

2 minutes

Average Cycle Time (note)

Type

Avg Time Calculation

Avg Value

Average Overall Cycle Time

(C12overall + C13overall + C14overall)/ 3 cycles

(7 mins + 2 mins + 2 mins) / 3 cycles

3.67 minutes

Average Normal Cycle Time

(C12normal + C13normal + C14normal)/ 3 cycles

(2 mins + 2 mins + 2 mins) / 3 cycles

2.00 minutes

Average Precise Cycle Time

(C12precise + C13precise + C14precise)/ 3 cycles

(2 mins + 2 mins + 2 mins) / 3 cycles

2.00 minutes



 Sample 5 (Low Complexity)


Sample 5 (Low Complexity)

Cycle Time Length

Type

Time Calculation

Value

Overall Cycle Time

tanalysis

10 minutes

Normal Cycle Time

tanalysis

10 minutes

Precise Cycle Time

tanalysis

10 minutes

Min Cycle Time (note)

Type

Cycle Time Calculation

Min Cycle Time (mins)



Min Overall Cycle Time

C15overall: t26 = 2 mins

C16overall: t27 = 2 mins

C17overall: t28 = 2 mins

C18overall: t29 = 2 mins

C19overall: t30 = 2 mins



2 minutes



Min Normal Cycle Time

C15normal: t26 = 2 mins

C16normal: t27 = 2 mins

C17normal: t28 = 2 mins

C18normal: t29 = 2 mins

C19normal: t30 = 2 mins



2 minutes



Min Precise Cycle Time

C15precise: t26 = 2 mins

C16precise: t27 = 2 mins

C17precise: t28 = 2 mins

C18precise: t29 = 2 mins

C19precise: t30 = 2 mins



2 minutes

Max Cycle Time (note)

Type

Cycle Time Calculation

Min Cycle Time (mins)

Max Overall Cycle Time

Same as Min Cycle Time

2 minutes

Max Normal Cycle Time

Same as Min Cycle Time

2 minutes

Max Precise Cycle Time

Same as Min Cycle Time

2 minutes

Average Cycle Time (note)

Type

Avg Time Calculation

Avg Value

Average Overall Cycle Time

(C15overall + C16overall + C17overall + C18overall + C19overall)/ 5 cycles

(2 mins + 2 mins + 2 mins + 2 mins +2 mins) / 5 cycles

2.00 minutes

Average Normal Cycle Time

(C15normal + C16normal + C17normal + C18normal + C19normal)/ 5 cycles

(2 mins + 2 mins + 2 mins + 2 mins +2 mins) / 5 cycles

2.00 minutes

Average Precise Cycle Time

(C15precise + C16precise + C17precise + C18precise + C19precise)/ 5 cycles

(2 mins + 2 mins + 2 mins + 2 mins +2 mins) / 5 cycles

2.00 minutes





Data PointData TypeDescriptionUnits
Equipment\Cycle Time

Relative Cycle Count

String

Relative Cycle Count is the change in cycle count that occurred during an analysis row.

The scope of this is comparing the difference between the current and previous row.
N/A

Target Cycle Time

Float8Also known as Takt time, it is how often a piece must be produced to meet customer demand. It is often used to pace a production line, and it is a calculated number in minutes. This is defined a 1/Standard Rate.minutes
Total Cycle CountString

Total Cycle Count is cumulative and represents the total change in cycle count since the beginning of the analysis period.

This value persists across rows. For example, you have had 10 cycles so far. You have another 5 cycles in the next period. The analysis row will read 15 cycles and continue to be a summation.
N/A

Equipment\Cycle Time\Normal

Normal Cycle Time calculations include Running and Unplanned Downtime states and ignore all other states like Starved, Blocked, Planned Downtime etc.

Average Normal Cycle Time

Float8Average Normal cycle time in minutes.minutes

Max Normal Cycle Time

Float8Max Normal cycle time in minutes.minutes

Min Normal Cycle Time

Float8Min Normal cycle time in minutes.minutes

Normal Cycle Time

Float8Time spent cycling that includes Running and Unplanned Downtime states and ignores all other equipment states.minutes

Equipment\Cycle Time\Overall

Overall Cycle Time calculations include all equipment states except Disabled.

Average Overall Cycle Time

Float8Average Overall cycle time in minutes.minutes

Max Overall Cycle Time

Float8Max Overall cycle time in minutes.minutes

Min Overall  Cycle Time

Float8Min Overall cycle time in minutes.minutes

Overall Cycle Time

Float8Time spent cycling that includes all equipment states except Disabled.minutes

Equipment\Cycle Time\Precise

Precise Cycle Time calculations only include equipment Running states.

Average Precise Cycle Time

Float8Average Precise cycle time in minutes.minutes

Max Precise  Cycle Time

Float8Max Precise cycle time in minutes.minutes

Min Precise Cycle Time

Float8Min Precise cycle time in minutes.minutes

Precise Cycle Time

Float8Time spent cycling that only includes equipment Running states.minutes



Line Data Points

The Line Data points returns data for the line regardless of the Equipment the Live Analysis has been set up for.

Data PointData TypeDescriptionUnits
Line/Downtime

Line Downtime Equipment Name

StringName of the equipment that is responsible for causing line downtime.N/A

Line Downtime Equipment Path

StringProduction model equipment path for equipment that is responsible for causing line downtime.N/A

Line Downtime Event Sequence

Int4Every downtime event on the line is provided with an incrementing sequence number.N/A

Equipment Note

StringNote entered at the Line level.N/A

Line Downtime Occurrence Count

Int4Number of downtime events for the selected period.N/A

Line Downtime Reason

String

The line or cell group (sub line) downtime reason.

  1. When the line is down the Line Downtime Reason is the same as the Line State Name.
  2. When the line is up the Line Downtime Reason is blank.
N/A

Line Downtime Reason Path

StringThe reason name for line or cell group (sub line) downtime reasons, including Equipment State Class and any reasons above the selected reason in the state tree. E.g. Default Class/Unplanned Downtime/Mechanical Faults/Chain Slip.N/A

Line Downtime Reason Split

BooleanThe line downtime reason split indicator. True is current downtime event has been split into multiple downtime events.N/A

Line Downtime State Time Stamp

DateTimeThe time stamp for the equipment state change of the cell group (sub line) or cell that caused the line downtime events.N/A
Line/Meantime
Line MTBFFloat8

The calculated Meantime (minutes) Between Failure for the line (or subline) in the selected period and does take into account the downtime detection method.

Refer to Setting Up Equipment States - Meantime Metrics for more details.

minutes
Line Meantime Metrics EnabledBooleanReturns true if the current line (or subline) state is enabled for meantime metrics.N/A
Line/Schedule

Line Schedule Available

BooleanTrue if this operation was scheduled.N/A

Line Schedule Available Time

Float8Time in minutes for available production time adjusted for line schedule availability and mode. "Line Schedule Available Time" is not applicable to cells or cell groups.minutes

Line Standard Count

StringAmount of product that should have been produced based on the line schedule available time and line standard rate. The available time is determined from the Ignition schedules that are selected for the line. If Ignition schedules are not selected for the line, then the scheduled count will be used. Actual line downtime is not used for this calculation.N/A
Line Schedule CountDoubleScheduled count of a machine.N/A
Line Schedule DurationDoubleScheduled duration of a machine.minutes

Line Standard Count Variance

StringVariance between line standard count and line OEE outfeed count.N/A

Line Target Count

StringAmount of product that should have been produced based on the line schedule available time and line schedule rate. The available time is determined from the Ignition schedules that are selected for the line. If Ignition schedules are not selected for the line, then the scheduled count will be used. Actual line downtime is not used for this calculation.N/A

Line Target Count Variance

StringVariance between line scheduled count and line OEE outfeed count.N/A

Schedule Rate

Float8See Schedule Rate for more details.production units/unit of time
Line/State

Line State Duration

Float8

The line or cell group (sub line) downtime event duration in minutes.

Important

Line state event duration will respect the group by for the analysis query. This means that the line state duration will be constrained to be within the time slice represented by the row, even if the line state event begin time is before the from time for the row or the line state event end time is after the to time for the row.

minutes

Line State Event Begin

DateTime

The line or cell group (sub line) downtime event begin date time.

Note

For Line State Event Begin Time and Line State Event End Time the times displayed will always be the actual begin and end times, even if the times fall outside of the row to and from times.

N/A

Line State Event End

DateTime

The line or cell group (sub line) downtime event end date time.

Note

For Line State Event Begin Time and Line State Event End Time the times displayed will always be the actual begin and end times, even if the times fall outside of the row to and from times.

N/A

Line State Event Sequence

Int4The equipment state event sequence number.N/A

Line State Name

String

The line or cell group (sub line) state.

  1. When the line is down the Line Downtime Reason is the same as the state name.
  2. When the line is up the Line Downtime Reason is blank.
  3. The Line State Name may differ from the Equipment State Name for the equipment item based on the Downtime Detection Mode.
    1. E.g. Line State Tag indicates a state, but Key Reason (Cell Priority) Downtime Detection Mode overrides local Equipment State such that the Line State reflects the Key Cell State.
N/A
Line State OverriddenBooleanOverriding line downtime reasons happen at the line level. The reason for this has to do with equipment can be changed which would require several cell state to be changed to work correctly when key reason detection and / or cell groups are used. If the line state has been overridden, then it will be true.N/A

Line State Override Scope

StringThe state override scope for a line or cell group (sub line). See Setting Up Equipment - Override Scope for more details.N/A

Line State Override Type

StringThe state override type for a line or cell group (sub line). See Setting Up Equipment - Override for more details.N/A

Line State Type

StringThe line or cell group (sub line) state type. See Setting Up Equipment - State Type for more details.N/A

Line State Value

Int4The line or cell group (sub line) downtime state code. See Setting Up Equipment - State Code for more details.N/A



Equipment Mode & State Data Points

Data PointData TypeDescriptionUnits
Equipment/Mode

Equipment Mode Name

StringName of the current mode. See Equipment Modes for more details.N/A

Equipment Mode Type

StringName of the current mode type. See Equipment Modes for more details.N/A

Equipment Mode Value

Int4Name of the current mode. See Equipment Modes for more details.N/A

Mode Begin Time

DateTime

Start time of the current mode.

Note

For Mode Begin Time and Mode End Time the times displayed will always be the actual begin and end times, even if the times fall outside of the row to and from times.

N/A

Mode Duration

Float8Duration of the current mode in minutes. This is calculated as Mode End Time - Mode Begin Time.minutes
Mode End TimeDateTime

End time of the current mode.

Note

For Mode Begin Time and Mode End Time the times displayed will always be the actual begin and end times, even if the times fall outside of the row to and from times.

N/A
OEE EnabledBooleanSee Setting Up Equipment Modes - OEE Enabled for more details.N/A
Production Counts EnabledBooleanSee Setting Up Equipment Modes - Production Counts Enabled  for more details.N/A
Equipment/State
Equipment Original State ValueInt4The original value of equipment state tag collector before it is updated by using MES Value Editor component or scripting.N/A
Equipment State NameString

Current state name based on tag value provided to this tag collector.

Line Level Considerations

If this is a Line production item, the Equipment State Name and Equipment State Type will hold the value of any tag provided at the line level and may differ from the Line State Name value when the Downtime Detection Mode is set to anything other than 'Line State'.


N/A
Equipment State PathStringThe state name and address for the given status, including Equipment State Class and any states above the selected state in the state tree. E.g. Default Class/Unplanned Downtime/Mechanical Faults/Chain Slip.N/A
Equipment State SplitBooleanTrue is current downtime event has been split into multiple downtime events.N/A
Equipment State TypeStringSee Setting Up Equipment - State Type for more details.N/A
State Begin TimeDateTime

Start time of the current state.

Note

For State Begin Time and State End Time the times displayed will always be the actual begin and end times, even if the times fall outside of the row to and from times.

N/A
State DurationFloat8Duration of current state in minutes. This is calculated as State End Time - State Begin Time.minutes
State End TimeDateTime

End time of the current state.

Note

For State Begin Time and State End Time the times displayed will always be the actual begin and end times, even if the times fall outside of the row to and from times.

N/A



Note

For Mode Begin Time and Mode End Time the times displayed will always be the actual begin and end times, even if the times fall outside of the row to and from times.



Equipment Meantime Data Points

Data PointData TypeDescriptionUnits
Equipment/Meantime
Equipment MTBFFloat8The Mean Time (minutes) Between Failure for the equipment in selected period. This does take into account the downtime detection method. minutes
Equipment Meantime Metrics EnabledBooleanTrue if Equipment Meantime Metrics are enabled for the current equipment state.N/A



Equipment General Data Points

Data PointData TypeDescriptionUnits
Equipment/General
Delta Time StampFloat8Time gap (minutes) between the rows of data.minutes
From Time StampDateTimeStart time (minutes) of the current period.minutes
ShiftStringName of the current shift as set by the Ignition Schedule Management component and defined for the current line or by the value passed in the equipment shift tag collector.N/A
Shift Day TextStringName of the current day.N/A
Shift Day of MonthInt4Int value of the current day of the month.N/A
Shift Day of WeekInt4Int value of the current day of the week.N/A
Shift Day of YearInt4Int value of the current day of the year.N/A
Shift ISO Week of YearInt4Int value of the ISO week of the year.N/A
Shift Month TextStringName of the current month.N/A
Shift Month of YearInt4Int value of the current month of the year. Months are numbered 0-11. (i.e January: 0, February: 1, ..., December: 11) N/A
Shift Start DateDateTimeStart time of the current shift.N/A
Shift Week of MonthInt4Int value of the current week of the month.N/A
Shift Week of YearInt4Int value of the current week of the year.N/A
Shift YearInt4Int value of the current year.N/A
To Time StampDateTimeEndtime (minutes) of the current period.minutes
Thirty Minute Interval DateThe time for every thirty minutes starting at the analysis begin date.N/A
Fifteen Minute Interval DateThe time for every fifteen minutes starting at the analysis begin date.N/A
Top of Hour Interval DateThe time for every hour starting at the top of the hour (minutes and seconds equals 0).N/A
Hour Interval DateThe time for every hour starting at the analysis begin date.N/A
Top of Minute IntervalDateThe time for every minute starting at the top of the minute (seconds equals 0).N/A
Minute IntervalDateThe time for every minute starting at the analysis begin date.N/A



Equipment OEE Data Points

Data PointData TypeDescriptionUnits
Equipment/OEE
Elapsed TimeFloat8Elapsed Time of current operation.minutes
OEEFloat8OEE value for selected period.N/A
OEE General CountLongAny count value other than infeed, outfeed, reject and waste value for the selected time period.N/A
OEE Infeed CountStringEquipment infeed count value for the selected period.N/A
OEE Infeed Count Equipment PathStringInfeed count tag collector path.N/A
OEE Outfeed CountStringEquipment outfeed count value for the selected period.N/A
OEE Outfeed Count Equipment PathStringOutfeed count tag collector path.N/A
OEE Reject CountLongEquipment reject count value for the selected period.N/A
Outfeed Standard CountFloat8Calculated expected outfeed based on standard rate and runtime. The runtime is based on the elapsed time, planned downtime and unplanned downtime. The Ignition schedules are not used when calculating the Outfeed Standard Count.N/A
Planned DowntimeFloat8Planned Downtime duration (Double) for selected period.minutes
RuntimeFloat8Runtime is the duration where the production item is in the run state. Runtime = Elapsed time minus Downtime.minutes
Short Stop TimeFloat8Short stop duration (Double) for selected period.minutes
Standard RateFloat8Standard rate of a machine (per minute).N/A
Standard Rate for HourDoubleStandard rate of a machine (per hour).N/A
Target Changeover TimeFloat8Amount of time in minutes set for Target Changeover. See Changeover Duration for more details.minutes
Unplanned Downtime Float8Unplanned Downtime duration (Double) for selected period.minutes
Equipment/OEE/Availability
Is Short StopBooleanTrue if current equipment state is consider a shortstop. See Short Stop Threshold for more details.N/A
OEE AvailabilityFloat8OEE Availability value for selected period.N/A
Equipment/OEE/Performance
OEE PerformanceFloat8OEE Performance value for selected period.N/A
Infeed Standard CountFloat8Calculated expected infeed based on standard rate, runtime, and package count. The runtime is based on the elapsed time, planned downtime and unplanned downtime. The Ignition schedules are not used when calculating the Infeed Standard Count.N/A
Equipment/OEE/Quality

OEE Quality

Float8OEE Quality value for selected period.N/A





Setting Values

The analysis results that are returned can be modified through the use of settings. Setting values provide a number of keywords as listed below.

Format for entering the keywords is keyword1=True, keyword2=100.0, keyword3=10.

Settings like Enable Totalized Mode, Include Future, Last Values and Rollup Time span are meant for the Analysis Selector component only and not for Live Analysis.

SettingDescriptionUseExample
Date FormatDate format fields can be customized with this setting e.g. 'yyyy-MM-dd HH:mm:ss'AllDate Format = 2017-11-15 17:04:00
Enable Totalized ModeThis setting accumulates the count. Useful for charts where you wish to display the accumulated production count over time.Not valid for Live AnalysisEnable Totalized Mode = True
Include FutureAllows for count values to be calculated in the future. Useful for charts where you want to display target counts for future runs.Not valid for Live AnalysisInclude Future = True
Last ValuesOnly the latest values are shown.Not valid for Live AnalysisLast Values = True
OEE Availability CapThe maximum value calculated can be capped with this setting.AllOEE Availability Cap = 1
OEE Performance CapThe maximum value calculated can be capped with this setting.AllOEE Performance Cap = 1
OEE Quality CapThe maximum value calculated can be capped with this setting.AllOEE Quality Cap = 1
Rollup Time Span

If the time (seconds) between downtime events is less than the rollup time and it is the same equipment and reason, then it will rollup the event into one row in the results and will increase the occurrence count.

Not valid for Live AnalysisRollup Time Span = 30
Row LimitThe analysis can be limited to a certain number of rows.AllRow Limit = 10
Descending OrderAnalysis results will be ordered in descending order if set to True.AllDescending Order = True
Include ChildrenSpecifies whether or not children of specified equipment are included in analysis calculationsAllInclude Children = True

  • No labels