Sepasoft MES Module Suite
When sample data changes, all of the out of control signals associated with it will be evaluated. If an out of control signal changes from Out of Control to In Control, any script in this event is run. It is provided to allow for the performance of other actions, such as alerts, when an out of control condition no longer exists.
Event Methods
getAttributeName()
Description
This script function returns the name of the attribute being evaluated.
Available In:
|
3.81.8 SP 5 and later |
Syntax
getAttributeName()
- Parameters
None
- Returns
string Returns the name of the attribute being evaluated
getDefUUID()
Description
This script function returns the definition UUID that was evaluated (See Sample Definition section more information).
Syntax
getDefUUID()
- Parameters
None
- Returns
String defUUID - The uuid that was evaluated.
getDefinitionName()
Description
This script function returns the definition name that was evaluated (See Sample Definition section more information).
Syntax
getDefinitionName()
- Parameters
None
- Returns
String Returns the definition name of the sample
getEvaluationResults()
Description
Returns a list of evaluation results. When sample data is updated for a location - sample definition combination, all of the selected signals are evaluated. This occurs for each attribute within the sample definition.
Syntax
getEvaluationResults()
- Parameters
None
- Returns
SignalEvaluationResults results - The list of results obtained during the evaluation of the signal.
getLocationPath()
Description
Gets the location path for this signal event to take place.
Syntax
getLocationPath()
- Parameters
None
- Returns
String locationPath - The location path for this signal event.
getPathSegment(segmentName)
Description
Gets the path for the specified segment.
Syntax
getPathSegment(segmentName)
- Parameters
String segmentName - Name of the segment to get the path for. Options: Enterprise, Site, Area, Line, Cell, Cell_group, Location, Storage_zone, Storage_unit.
- Returns
String pathSegment - The path segment corresponding to specified by segment name parameter.
getSampleUUID()
Description
This script function returns the UUID of the sample being evaluated.
Available In:
|
|
3.81.8 SP 5 and later |
Syntax
getSampleUUID()
- Parameters
None
- Returns
string Returns the UUID of the sample being evaluated
getSignalName()
Description
This script function returns the name of the signal being evaluated.
Available In:
|
|
3.81.8 SP 5 and later |
Syntax
getSignalName()
- Parameters
None
- Returns
string Returns the name of the signal being evaluated
isForceOutOfControl()
Description
This script function will check if forceOutOfControl property is enabled or not. The signal goes out of control whenever this is set to true.
Syntax
isForceOutOfControl()
- Parameters
None
- Returns
boolean forceOutOfControl - True if the forceOutOfControl property of this signal event is enabled and False otherwise.
isIgnoreOutOfControl()
Description
This script function will check if ignoreOutOfControl property is enabled or not. Whenever the signal goes out of control it is ignored if this is set to true.
Syntax
isIgnoreOutOfControl()
- Parameters
None
- Returns
boolean ignoreOutOfControl - True if the ignoreOutOfControl property of this signal event is enabled and False otherwise.
setForceOutOfControl(forceOutOfControl)
Description
Used to force an out of control condition.
Syntax
setForceOutOfControl(forceOutOfControl)
- Parameters
boolean ignoreOutOfControl - Set it to True in order to force an out of control condition and False otherwise.
- Returns
None
setIgnoreOutOfControl(ignoreOutOfControl)
Description
Used to override and ignore an out of control condition.
Syntax
setIgnoreOutOfControl(ignoreOutOfControl)
- Parameters
boolean ignoreOutOfControl - Set it to True if an out of control condition is to be ignored and False otherwise.
- Returns
Nothing
Sepasoft MES Module Suite