MES Changelog Viewer

Sepasoft MES Module Suite

Changelog Viewer | Vision

This component displays the historical record of all property-value changes made to any MES Object. It provides a variety of filtering properties, to allow for creating specific results that can be reviewed in the table or exported as a .csv file for off-line analysis or reporting.

This component can be found on the Production component palette and is installed with the production-module.modl which is licensed with either the OEE Downtime or Track & Trace modules.


Features

NameDescription

Filters

Begin DateOmit changelog entries prior to this date and time.
End DateOmit changelog entries after this date and time.
Property PathFilter changelog entries for the specified equipment path.
SourceFilter changelog entries for changes that happened at a specific server by providing the equipment path of that server. Requires setting an Equipment Name in the MES Enterprise Settings page on the gateway.
Change Event Type

Change Event Types

Change Event TypeDescription
ArtifactValueGenerated when an artifact value changes.
ChildAddedGenerated when an object has a new child object assigned.
ChildRemoved

Generated when an object has a child removed.

CoalescingPropertyValue

Generated when property values are changed by specific server operations. This applies to properties (currently only the begin/end time of an operation request, and the count of an operation response) that changes frequently. Sequential updates of this type are continually merged together to form one entry that represents the sum difference old_value -> new_value after all the changes at the end of the sequence of changes.

Example

Instead of one recorded entry for each time a schedule is delayed in starting:

CHANGE #      OLD VALUE      NEW VALUE
1 ------------------  12:00:00  --------  12:01:00
2 ------------------  12:01:00  --------  12:02:00
3 ------------------  12:02:00  --------  12:03:00

... the CoalescingPropertyValue entry will instead be:

CHANGE #      OLD VALUE      NEW VALUE
1 ------------------  12:00:00  --------  12:03:00

ComplexPropertyAddedGenerated when an object has a new complex property added.
ComplexPropertyRemovedGenerated when an object has a complex property removed.
ComplexPropertyRenamedGenerated when a complex property's name changes.
CustomPropertyAddedGenerated when an object has a custom property added.
CustomPropertyDataTypeGenerated when an custom property's data type changes.
CustomPropertyDescriptionGenerated when a custom property's description changes.
CustomPropertyProductionVisibleGenerated when the production visible flag on a custom property changes.
CustomPropertyRemovedGenerated when an object has a custom property removed.
CustomPropertyRenamedGenerated when a custom property's name changes.
CustomPropertyRequiredGenerated when the required flag on a custom property changes.
CustomPropertyUnitsGenerated when a custom property's units change
CustomPropertyValueGenerated when the value of a custom property changes.
ParentAddedGenerated when an object has a parent object assigned.
ParentRemovedGenerated when an object has a parent object removed.
PropertyValueGenerated when a property value changes.
Changed ByFilter to see only changes by a user that matches the provided pattern. Search by the first and last name of the user that made a change. * matches 0 or more of any character, ? matches a single character.
By UUID / By MES ObjectRadio buttons (exactly one selected at all times) to choose whether to filter results by a UUID or by an MES Object.
UUIDFilter to see only changes to a specific MESObject by UUID.
MES Object TypeFilter to see only changes to a specific type of MESObject.
MES Object NameFilter to see only changes to objects that match the given name pattern. * matches 0 or more of any character, ? matches a single character.
MES ObjectA dropdown that is populated with the objects of the type that match the MESObjectType filter to select a specific object.

Data Functions

Load DataLoads the table with changelog entries based on the filter parameters above.
Max RowsLimits the number of entries in the table to the selected number. This is a drop-down menu that includes the following selections: 5, 25, 50, 100, 250, 500, 1000, 2000
ResetResets all filter fields to their default (blank) states.
ExportExports the results displayed in the table as a comma-separated values file (.csv). A pop-up dialog box appears to browse to the desired destination folder for the file. If no entries are currently in the table, an error message will indicate that there is no data to export, so no file was created.

Table Features

Changelog entries displayed in the table can be sorted (if enabled), edited (if enabled) and filtered (if enabled), as well as formatted visually (text alignment and formatting). Refer to the Table Customizer section below for details on configuring the table display, editing and sorting features for each column.



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

Code
event.source.parent.getComponent('MES Changelog Viewer').componentEnabled = False


Common

NameScriptingProperty TypeDescription
NamenameStringName of the component.
EnabledcomponentEnabledBooleanIf true, component is enabled.
VisiblevisibleBooleanIf true, component is visible.
BorderborderBorderType of border around the component.

Data

NameScriptingProperty TypeDescription
Column Attribute DatacolumnAttributesDataDatasetDataset describing the data attributes.
DatadataDatasetData for this table.
Data QualitydataQualityIntegerThe data code for any tag bindings on this component.
Selected RowselectedRowIntegerIndex of the first selected row, or -1 if none.

Appearance

NameScriptingProperty TypeDescription
Header FontheaderFontFontFont to use for the table header.
Header Foreground ColorheaderForegroundColorForeground color of the table header.
Header Background ColorheaderBackgroundColorBackground color of the table header.
Table Background ColortableBackgroundColorBackground color of the table body.
Row FontrowFontFontFont to use for the table header.
Row Foreground ColorrowForegroundColorForeground color of rows in the table.
Row Background ColorrowBackgroundColorBackground color of rows in the table.
Row Selection Foreground ColorselectionForegroundColorDefault foreground color of selected cells.
Row Selection Background ColorselectionBackgroundColorDefault background color of selected cells.
Auto Row Height EnabledautoRowHeightEnabledbooleanIf true, row height of the table will be adjusted automatically.
Row HeightrowHeightintIf row resizing is disabled, this will set the height of all rows.
Grid Line ColorgridColorColorColor of grid lines in the table.
Show Horizontal Grid Lines?showHorizontalLinesbooleanDisplays horizontal gridlines making it easier to read.
Show Vertical Grid Lines?showVerticalLinesbooleanDisplays vertical gridlines making it easier to read.

Along with the component properties, custom properties can also be added to this component. See Component Customizers in the Ignition Help Manual for more information.


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

Fires whenever a bindable property of the source component changes. This works for standard and custom properties of the component.

Property

Description

.source

The component that fired this event.

.newValue

The new value that this property changed to.

.oldValue

The value that this property was before it changed. Note that not all components include an accurate oldValue in their events.

.propertyName

The 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

Extension functions allow the operation of a component to be altered. Extension functions cannot be called, they are event driven. See Component Extension Functions in the Ignition Help Manual for more information.

configureHeaderStyle

  • Description

Provides a change to configure the style of each column header. Returns a dictionary of name-value pairs with the desired attributes. Available attributes include: 'font', 'foreground', 'background', 'border', 'toolTipText'..

  • Parameters

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

colIndex - The index of the column in the underlying dataset.

colName - The name of the column in the underlying dataset.

  • Return

Returns a dictionary of name-value pairs with the desired attributes.

  • Scope

Client

Example: Configure Header Style

Code
def configureHeaderStyle(self, colIndex, colName):
	from java.awt import Font
	from java.awt import Color
	from javax.swing.border import MatteBorder
	return { 'font': Font('Dialog', Font.PLAIN, 12), 
		'foreground': Color.BLUE, 
		'background': Color.YELLOW, 
		'border': MatteBorder(1, 1, 1, 1, Color(238, 236, 232)), 
		'toolTipText': colName }

getUISettings

  • Description

<<< add >>>

  • Parameters

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

uiSettings - The settings object used to customize the appearance of the MES Changelog Viewer's UI.

  • Return

<<< add >>>

  • Scope

Client

Example: Get UI Settings

Code
<<< add >>>

loadIcon

  • Description

Allows users to change an icon. based on the icon name parameter, returns the image path to the icon to use in place of the default icon.

  • Parameters

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

iconName - The name of the icon.

  • Return

Returns a dictionary of name-value pairs with the desired attributes.

  • Scope

Client

Example: Load Icon

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'


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

Table Customizer

Table Customizer manages the data entered into the MES Changelog Viewer. It will allow you to modify the data which is stored inside the MES Changelog Viewer. Thus the formatting and alignments are made easy.

Column Configuration

Header - Provide a custom name to the column header.

Hide? - Hides the column.

Editable - Allows the editing of the cell pertaining to the column.

Sortable - Allows the user to sort the table according to the selected column.

Filterable? - To make a column filter the data on user's demand.

Horiz Align - Aligns the contents of the column.

Vert Align - Aligns the contents of the column.

Wrap Text? - Data in the cell wraps to fit the column width. When you change the column width, data wrapping adjusts automatically.

Prefix - A custom text that proceeds the contents of each cell.

Suffix - A custom text that follows the contents of each cell.

Number Format - A format of the cell is the contents of the cell are number types.

Date Format -  Used if the contents of the cell are date types.

Boolean? - Changes the contents of the cell to reflect a 'check box' look and feel.

Custom Properties

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








Component Functions

This component does not have component functions associated with it.



Scripting Functions

This component does not have scripting functions associated with it.



Component Objects

This component does not have objects associated with it.


Sepasoft MES Module Suite