MES Monitor

Sepasoft MES Module Suite

MES Monitor Component | Vision

This component displays statistics about operations on each server in the Enterprise. It can be used to measure from either server boot-up or a reset point, or across a specified time period. Timers and counters are provided, to support quantifying measurements and debugging activities. Tags are created for various metrics, to allow live monitoring and control via Ignition components, MES components, and scripts.

This component can be found on the Production component palette and is installed with the production-module.modl which is licensed with all MES modules.

MES Monitor interface

Main View

The Main View graphically displays the current system-wide server architecture and interconnections, from the main Enterprise-level server displayed at the top downward to individual Site servers and Line servers (if present).

The graphical display can be manipulated with various mouse actions (refer to the Help section below).

Hovering over any server in the Main View brings up basic server information in a tool tip box (see image below):

• Uptime – Total time since the server was started or rebooted.
• Live Analysis Count – Total number of Live Analyses currently running on the server.
• Recent Exception Count – The total number of exceptions that have occurred on the server since metrics were started or reset.

When hovering the mouse over a server in the Main View, data related to that server appears in the Metrics Table.

Data displayed in the Metrics Table:

The following sections describe the various sections and data-display options on the Details View:

Health Statistics

Data displayed in the Health Statistics area:

Database Statistics

Data displayed in the Database Statistics area:

Managed Equipment

This pane displays a hierarchy tree of the Equipment Items created on this server. It is provided for reference only. No actions occur by clicking on the items.

Metric Categories and Metric Details

This pane displays various metric categories and their related entities:

• MES exceptions
• Custom timers
• Custom values
• Database accesses
• Gateway connections
• MES Object Manager activity
• Analyses (named and unnamed)
• Scripted analyses (named and unnamed)
• Live Analyses
• MES Schedule Manager activity

Categories for which no entities exist on this server will not be shown in the Metric Categories list.

Recent MES Exceptions

This metric category displays the Ignition and MES exceptions that have occurred on this server since metrics were started or reset.

Data displayed in Metric Details section for the Database selection:

Copy Exception Row

Right-clicking anywhere on an exception row brings up the Copy function. Click it to copy the description text to the clipboard (example: "java.lang.NullPointerException").

You can also copy by clicking to highlight a row and using Ctrl-C.

Database

This metric category displays information about MES database accesses.

Data displayed in Metric Details section for the Database selection:

Copy Database Access Row

Right-clicking anywhere on an MES database access row brings up the Copy function. Click it to copy the description text to the clipboard (example: "ALTER TABLE MESPersonnelProperty DROP INDEX IX_O_MESPersonnelProperty").

You can also copy by clicking to highlight a row and using Ctrl-C.

Database - Execution Time

This metric category displays all the same information as the Database selection (see above), but also includes a Last Value metric.

Gateway Connections

This metric category displays information about gateway connections.

Data displayed in Metric Details section for the Gateway Connections selection:

Copy Gateway Connection Row

Right-clicking anywhere on a gateway connection row brings up the Copy function. Click it to copy the description text to the clipboard (example: "Gateway Connections ignition-site-1").

You can also copy by clicking to highlight a row and using Ctrl-C.

Gateway Connections - (Site)

This metric category displays information about gateway connections for the selected Site. It has all the same information as the Gateway Connections selection (see above), but also includes a Last Value metric and a graph of execution times for the selected Site on this server since metrics were started or reset.

Execution Times Graph

A graph displays the execution times for the selected Site on this server since metrics were started or reset. Various display functions are available:

Gateway Connections - (Line)

This metric category displays information about gateway connections for the selected Line. It has all the same information metric fields as the Gateway Connections - (Site) selection (see above).

MESObjectManager

This metric category displays information about MES Object actions (e.g. creation, saving, editing properties, etc).

Data displayed in Metric Details section for the MESObjectManager selection:

Copy Exception Row

Right-clicking anywhere on an exception row brings up the Copy function. Click it to copy the description text to the clipboard (example: "java.lang.NullPointerException").

You can also copy by clicking to highlight a row and using Ctrl-C.

MESObjectManager - (MES Object Manager action)

This metric category displays information about a specific MES Object action (e.g. creation, saving, editing properties, etc). It has all the same information metric fields as the MESObjectManager selection above, but also includes a Last Value metric.

Named Analysis

This metric category displays information about various types of named analyses currently running or previously running on the server since metrics were started or reset. The analyses category also includes the sub category for scripted named analyses.

Data displayed in Metric Details section for the Named Analysis selection:

Copy Exception Row

Right-clicking anywhere on an exception row brings up the Copy function. Click it to copy the description text to the clipboard (example: "java.lang.NullPointerException").

You can also copy by clicking to highlight a row and using Ctrl-C.

Copy Gateway Connection Row

Right-clicking anywhere on a gateway connection row brings up the Copy function. Click it to copy the description text to the clipboard (example: "java.lang.Exception: The value for the (Equipment Path) filter item cannot be blank.").

You can also copy by clicking to highlight a row and using Ctrl-C.

Named Analysis - (named analysis)

This metric category displays information about a specific named analysis currently running or previously running on the server since metrics were started or reset. It has all the same information metric fields as the Named Analysis selection above, but also includes a Last Value metric.

Named Analysis - Scripting

This metric category displays information about various types of scripted named analyses currently running or previously running on the server since metrics were started or reset. It has all the same information metric fields as the Named Analysis selection above.

Named Analysis - Scripting - (analysis)

This metric category displays information about a specific scripted named analysis currently running or previously running on the server since metrics were started or reset. It has all the same information metric fields as the Named Analysis selection above, but also includes a Last Value metric.

[Code]

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'

end = system.date.now()
begin = system.date.addHours(end, -8)

analysis = system.mes.analysis.createMESAnalysisSettings('analysis')
analysis.setDataPoints("Equipment Path,OEE Infeed Count,OEE Outfeed Count,OEE Availability,OEE Performance,OEE Quality,OEE")
analysis.setFilterExpression("Equipment Path LIKE 'Manufacturing\*\Packaging\*'")
analysis.setGroupBy("Equipment Path")
# system.mes.analysis.executeAnalysis() returns an MES Analysis Results object
# For documentation, see: https://help.sepasoft.com/docs/display/MHD/MES+Analysis+Results
results = system.mes.analysis.executeAnalysis(begin, end, analysis)

if results.hasMessage():
	count = results.getMessageCount()
	message_list = [str(results.getMessage(index)) for index in range(count)]

# getDataset() returns an Ignition Dataset
# For documentation, see: https://docs.inductiveautomation.com/display/DOC79/Datasets
dataset = results.getDataset()

sep = ",\t"
print sep.join(dataset.getColumnNames())
for row in range(dataset.getRowCount()):
	print sep.join(map(str, dataset.getRow(row)))

Schedule Manager

This metric category displays information about MES Schedule Manager component actions (e.g. creation, saving, editing properties, etc).

Data displayed in Metric Details section for the Schedule Manager selection:

Schedule Manager - (schedule)

This metric category displays information about a specific MES Schedule Manager component action (e.g. creation, saving, editing properties, etc). It has all the same information metric fields as the Schedule Manager selection above, but also includes a Last Value metric.

Custom Timers

For performance monitoring and debugging, custom timers are available in the MES Monitoring component, which allow users to start and stop a timer via scripting, to capture server performance metrics for the specified duration.

Custom Timer

This metric category displays information about the custom timers that have been created.

Data displayed in Metric Details section for the Custom Timer selection:

Custom Timer - (timer)

This metric category displays information about a specific custom timer. It has all the same information metric fields as the Custom Timer selection above (except Longest Running Custom Timer - Top 5), but also includes a Last Value metric.

Refer to system.mes.monitor.start for information on creating and starting a custom timer.

Custom Values

For monitoring-related activities and debugging, custom value entries are available in the MES Monitoring component, which allow users to save string or numeric values and calculate metrics based on their creation times.

Custom Value

This metric category displays information about the custom values that have been created.

Data displayed in Metric Details section for the Custom Value selection:

Custom Value - (value)

This metric category displays information about a specific custom value. It has all the same information metric fields as the Custom Value selection above (except Longest Running Custom Value - Top 5), but also includes a Last Value metric.

Refer to system.mes.monitor.value for information on creating a custom value.

Tags

Tags are created for for each metrics category in the Metrics Categories pane, to allow live monitoring and control via Ignition components, MES components, and scripts.

All metrics tags are created and updated as type String by the MES Monitor component, regardless of whether they are numeric in nature (example: the .increment (n) and .decrement(n) Counter object methods treat them locally as integers, but their associated tags remain as type String).

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 Monitor').componentEnabled = False

Common

Data

Appearance

Custom Properties

The custom properties can be used to add user defined properties.

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.

propertyChange

propertyChange

[Code]

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'

[Code]

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'

Scripting Functions

Component Objects

This component does not have objects associated with it.

Sepasoft MES Module Suite