Properties Common to All Phase Parameters

Sepasoft MES Module Suite

Parameter Properties

Depending on the phase and scenario, a property may be read-only.

Note
Property NameOptionsDescription
Recording Type

All to History

Parameter values on a regular update-interval are recorded to the database for MES Analysis use.

All to Object

Parameter values are saved against the MES Objects to ensure continuity of operation in case of power outage or server restart.

All to Object and History

Parameters are saved to both the object and history.

All to Object and Last to History

See “All to Object” above.  Last values indicate only final parameter values are saved to history DB tables for analysis.  For example, rather than an accumulated counter for quantity, only the final quantity would be recorded.

Changes Not Saved

Parameter values are not recorded.

Last to History

Parameter values are saved at the end of the phase to the DB for exposure to analysis.



Value SourceRecipeGets the value from a recipe parameter before the batch starts.

Execution

Gets value at runtime, once the batch has started.

Runtime options are: the parameter value set in phase configuration, tag engine, and scripting.


Recipe and ExecutionGets the value before the batch starts AND gets  the value at runtime, once the batch has started. 

Monitor

Captures values from the equipment. Configure tags for history timeframe. 


When selecting Monitor, the parameter value becomes read-only, and a default value will not be set.


The system checks every 100 milliseconds but only writes changes to history when the value changes.


Monitor is intended for listening and recording in history values from the PLC.

An example is Actual Temperature (PV_Temp) where the PLC has complete control of changing the value and the Batch Module only listens and records the value.


Only accessible in Phase Manager.


Synchronization Manager

Set on the receiving phase within a Sync Group of Synchronize Phases.


Neither
These are parameters used internally by the Batch engine and cannot be changed via UI nor scripting.
Tag Type

Memory

Parameters are instantiated in the Phase UDT as memory tags.

OPC

Parameters are instantiated in the Phase UDT as OPC tags.

Reference

Parameters are instantiated in the Phase UDT as reference tags. You can set source tag paths for remote tags.

For example:

  • Add a new parameter to a phase and set the Tag Type to Reference.
  • Do the same for the State parameter.
  • Edit the phase UDT and set the Source Tag Path (to a referenced tag) for the parameters that were set to Reference tag type.
CalculationExpression

Used for reference to another field or parameter OR when a unit of measurement needs to be calculated.


Single line of Python. This is a function that is injected into a system Python.

(Not available with the ENUM data type.)


Start with a forward slash to set a path from the root of the procedure or recipe hierarchy. 

param(“/{}.Unit_Path”)

  • This means get the value for the Unit_Path parameter one level above the active object.


Use curly brackets to set at the current level within the hierarchy, e.g., 

param(“{}.Unit_Path”)

  • This means get the value for the Unit_Path parameter for the active object.


See Parameter Expressions.

Data Type

Possible Data Types

Data Type
Boolean




See Data Types and Formats.

Byte
Date
Double
Enum
Float
Integer
Long
Material In

Set of sub-parameters for tracking material.

Material Out

Set of sub-parameters for tracking material.

ShortSee Data Types and Formats.
String
Supplemental Equipment

Set of sub-parameters for tracking equipment used in a process.


Sepasoft MES Module Suite