system.mes.analysis.getMESAnalysisSettings

Sepasoft MES Module Suite

system.mes.analysis.getMESAnalysisSettings

Get the specified stored analysis settings.

system.mes.analysis.getMESAnalysisSettings(savedSettingsName)

  • Parameters

String savedSettingsName - The name of the saved analysis settings to return.

  • Returns

MESAnalysisSettings - A MESAnalysisSettings object that contains the data points, filter expressions, group by, order by, etc.

  • Scope

All

Code Examples

Copy Code
Python
 system.mes.analysis.getMESAnalysisSettings('report')

Output

Copy Code
Code
 [report]
AnalysisSettings (250dd58f-554a-493a-9b7e-9df905fc1d29, report, 0 parents, 0 children, 0 custom properties, 2 complex properties)

system.mes.analysis.getMESAnalysisSettings(savedSettingsName, user)

  • Parameters

String savedSettingsName - The name of the saved analysis settings to return.

PyUser user - User object obtained by calling system.user.getUser(). This is optional and only available if calling this script from a Gateway Context, such as when doing analysis in a tag change event script or similar. If a user is passed in, their security settings will be used. If a user is not passed in and the script is executing from a Gateway Event script, analysis security settings will not be applied.

  • Returns

MESAnalysisSettings - A MESAnalysisSettings object that contains the data points, filter expressions, group by, order by, etc.

  • Scope

All

Code Examples

Copy Code
Code
user = system.user.getUser('UserSource', 'UserName') 
system.mes.analysis.getMESAnalysisSettings('report', user)

Output

Copy Code
Code
 [report]
AnalysisSettings (250dd58f-554a-493a-9b7e-9df905fc1d29, report, 0 parents, 0 children, 0 custom properties, 2 complex properties)

Sepasoft MES Module Suite