system.mes.changelog.getChangelogData

Sepasoft MES Module Suite

getChangelogData Script Function

The getChangelogData script function makes a blocking request that returns changelog history as an Ignition Dataset. This is useful when the result needs to be bound directly to a table component or processed using Ignition's dataset utilities. Use a MESChangelogFilter (created with system.mes.changelog.createFilter()) to narrow the results.

Syntax

system.mes.changelog.getChangelogData(filter)

Required Parameters

Parameter	Type	Description
filter	MESChangelogFilter	The filter object defining search constraints. Create one with system.mes.changelog.createFilter(). Cannot be None.

Return Value

Type	Description
Dataset	An Ignition Dataset representing the changelog history. Each row corresponds to a change event record. Returns an empty dataset when no records match the filter.

Scope

Context	Availability
Client	Available in Vision Client and Designer scripts
Gateway	Available in Gateway-scoped scripts

Example Usage

Copy Code

Python

# Minimal — retrieve all changelog records as a Dataset
changelogFilter = system.mes.changelog.createFilter()
data = system.mes.changelog.getChangelogData(filter=changelogFilter)

# Realistic workflow — filter by user and populate a table component
changelogFilter = system.mes.changelog.createFilter()
changelogFilter.setChangedByNames("jsmith", "System")
changelogFilter.setDescending(True)
changelogFilter.setLimit(200)

data = system.mes.changelog.getChangelogData(filter=changelogFilter)
event.source.parent.getComponent("ChangelogTable").data = data

Related Function:

createFilter() — Creates the MESChangelogFilter required by this function.

Sepasoft MES Module Suite