Phase Parameters | Exposed set to True

Sepasoft MES Module Suite

Phase Parameters Exposed to Ignition Tag Ignition

Batch Phase Parameters map to OPC devices or Ignition Tags as defined in standard PLI (Phase Logic Interface).

When Phases are added to Units in the batch system, Batch Engine creates Batch Phases under the Unit in Ignition Tag Browser. Each Phase has parameters that are used to transfer data values back and forth between the Unit and the equipment module. The values going from the Unit to the equipment PLC-control component are called Output Parameters. The values coming in from the PLC-control component are called Input Parameters.

The batch system has a set of pre-defined parameters such as COMMAND and STATUS, but also allows user-defined parameters that you can configure for values such as Add Amount and Amount Added.

Note

Update in 3.81.11 SP11 and later

MES-7291

  • Documentation: A text field allowing users to provide descriptive information about the parameter's purpose, usage, or any special considerations. This field is written to Ignition tags as the "Documentation" property.

  • Engineering Units: A text field to specify the engineering units (e.g., "psi", "°C", "kg/h") for the parameter value, which will be displayed in the user interface and used for clarity in parameter configuration. This field is written to Ignition tags as the "EngUnit" property.

Phase Manager > Phase Edit > set Exposed to True.

Parameter Name Data Type
Begin_Date_Time Date Tag Type property is configurable. Set to Memory by default to create a tag in the Ignition tag browser and saves to the cache and history.
Command String

Tag Type property is configurable. Value Source is driven by Batch Engine or Manually. See Equipment PLC Commands and States and Batch Command-State Sequence for more information.

Command_Number Integer

Tag Type property is configurable. Value source is from execution. Values are not saved.

Use Command_Number to write values. The system changes the value of the Command parameter based on the value of Command_Number.

See Equipment PLC Commands and States and Batch Command-State Sequence for more information.

Complete Boolean

Tag Type property is configurable. Saved to cache and history.

Used in the handshake between phases, see Sync Flags.

Disable_Complete Boolean

True/False | When set to True the equipment does not stop when the step is complete and additional adjustments to parameter values can occur for subsequent instances of the same equipment phase.

When the Disable Complete parameter is set to False, the step waits for the State phase parameter to be set to Complete before the step completes.

Related Topic: Using a Phase in Multiple Steps.

Duration Long

Tag Type property is configurable. Saves last to history.

Time in seconds the phase was active (endDateTime - beginDateTime)

End_Date_Time Date Tag Type property is configurable. Saved to the cache and history.
Execute_Count Long

Increments each time the phase is run. Commonly used to iterate through a process.

Tag Type property is configurable. Saved to the cache and history.

Handshake_Ack Integer Tag Type property is configurable. Value source is from execution. Values are not saved.
Handshake_Valid Boolean Tag Type property is configurable. Saved to History.
Handshake_Value Integer

Tag Type property is configurable. Values are not saved.

PLC detects whether the batch engine is responding using this parameter. If not, then batch engine sets the Command the phase is set to Held.

Message String

Tag Type property is configurable. Saved to the cache and history.

  • For equipment phases, when a message is written to the Message parameter, that message is recorded in the vertical tables.
  • For other phases, exceptions can be captured and exposed in this parameter.
  • The Set Parameter phase can be used to write to another phase's Message parameter.
  • For the script phase, the parameter can be set via the return parameters.

When the Message parameter on the Equipment Phase is set to a value, it is recorded and no other functions are done. It can be set in the PLC, from script function, or using the Set Parameter phase.

Message_Ack_By String Who acknowledged the message by Ignition user roles.
Message_Ack_Confirm Boolean Confirmation flag that the message was acknowledged.
Message_Ack_Date_Time Date Time stamp of when the message was acknowledged.
Message_Date_Time Date Date stamp of message display
Message_Requires_Ack Boolean True/False to require the acknowledgement of a message.
Mode String

Tag Type property is configurable. Saved to the cache and history.

 Auto: The elements in a Batch Recipe named Transitions end automatically when the condition is True, which allows the next phase to start.

Semi Auto: Enforces that the recipe move through each Transition; You cannot force execute phases out of order.

Manual: You can force execute these phases: e-Signature, Equipment Phase, Script, Set Parameter, User Message, Value Prompt. For more information, see Execution in Manual Mode and Force Complete.

Phase_Exception
Tag Type property is configurable. Saved to History.
Propagate_Hold_To_Parent Boolean

When a Phase state changes to HELD, the HELD state is propagated to the Unit Procedure and Operation. If this parameter is set to True, then the HELD state is passed up to the parent level.

Keep in mind that when you restart the unit procedure and operation, the batch is not restarted. Restart the batch from Batch Controller or Batch Monitor.

State String

Tag Type property is configurable. Saved to the cache and history.

Use State_Number to write values. The system changes the value of the State parameter based on the value of State_Number.

See Equipment PLC Commands and States and Batch Command-State Sequence for more information.

State_Number Integer

Tag Type property is configurable. Value changes are not saved.

Available In:

Warning

MES 3.81.9 RC 5 and later

For phases that are Exposed and do not have a State_Transition_Handling parameter, the state cannot be set by the user or application.

For these phases the State_Number and therefore the State is set by Batch Engine.

Error in Logs:

Phase cannot set the State_Number manually.

Error in Tag Browser:

Error writing to State_Number.value: Bad

See Equipment PLC Commands and States and Batch Command-State Sequence for more information.

State_Number_Ack
Boolean

When a Batch recipe's Equipment Phase step's state changes, the system will now send out an acknowledgement message and echo the state to the new State_Number_Ack UDT as a flag that proves the state change has been successfully processed.

Warning Available in MES 3.81.12 SP2, 4.83.1 SP1 and later.
State_Transition_Handling Enum

Auto/PLI

Auto: The batch engine drives the states.

PLI: When set to PLI, the PLC drives the state. When a batch completes, Batch Engine sends a RESET command and waits for the input value from the PLC. Then, the batch is back to IDLE.

See State Handling Parameters for more information.

Step_Name String Tag Type property is configurable. Value changes are not saved.
Step_Sequence Integer Tag Type property is configurable. Value changes are not saved.
Unit_Path String Every phase has this parameter. The value is the unit path including its name where the phase is currently running within the Equipment Model.

Sepasoft MES Module Suite