Phase logic parameters

The following parameters are specific to phase logic. Other common parameters are also used in the phase logic. Those parameters are defined in the Function block - parameters topic. The unit module also has parameters specific to the unit module level.

Table: Phase Logic-Specific Parameters

Parameter

Units

Data Type

Description

AUTO_RESTART

None

Boolean

Set to instruct the phase whether or not to auto-restart from a holding condition.

If a phase is HELD and AUTO_RESTART is set to TRUE, the phase will immediately execute its RESTART_LOGIC and go back to RUNNING (without the operator clicking Restart).

An operator can restart a phase from DeltaV Operate while the phase is still under DeltaV Batch control.

An AUTO_RESTART parameter is also provided at the unit module. When set, it propagates down to all phases in the unit module.

The default value is FALSE. The phase must be in either the HOLDING or HELD state to set this parameter to TRUE.

BATCH_ID

None

String

Records the ID of the batch for the phase at run time.

BCOMMAND

None

16-bit unsigned integer

Commands the phase to go to a particular state, as defined by the state transition diagram. This parameter is to be used exclusively by the DeltaV Batch Executive, while the phase owner is DeltaV Batch.

Caution Do not write to this parameter directly as it can cause the Batch Executive to lose control of the phase.

BSTATUS

None

Named set

Shows the state of the phase.

This parameter uses the phase_state named set.

CLASS

None

String

Returns the name of the phase class for the phase.

COMMANDMASK

None

16-bit unsigned integer

Used to displays only the set of valid commands that a user can issue.

CONFIRM_FAIL

None

Boolean

Activates confirmation of failing for the composite block. The default is False.

DOWNLOAD_REQ

None

Boolean

Indicates a Download command has been received and is still pending. This is reset by the phase logic after detection or action.

FAIL_INDEX

None

16-bit unsigned integer

Shows and defines the failure of a phase or phase interface, where 0 = No Failure and any non-zero integer = Failure.

FAIL_INDEX values are limited to the inclusive range, 0-255. Attempting to write a value outside this range will cause an "Invalid PHASE_FAILURE enumeration value" message to be displayed at the Batch Operator Interface.

However, the value 255 defaults in the PHASE_FAILURE named set as Failed. It is recommended that you do not write the 255 value to the FAIL_INDEX.

The translation string for any positive integer less than 255 can be specified in the PHASE_FAILURES named set.

Note that the hold logic executes from the first hold step when the FAIL_INDEX changes to a higher value, even when the hold logic is currently running (holding). Therefore, the Phase_Failures named set values should be configured so that the most serious condition has the highest value.

INITIAL_STATE

None

Named set

Defines the state that the SFC is in when downloaded (Sequence Active or Sequence Idle). Determines the initial state of the SFC. In a phase, it is the state when the Run logic initiates. The default is Sequence Active.

This parameter is available when you drill down into the composite block.

This parameter uses the sfc_initial_states named set.

OWNER

None

Named set

Identifies if the control mode is DeltaV Batch or if the control is External. When the batch is running External, the parameter controlling the phase's transitions is XCOMMAND, which allows the user to control the phase.

This parameter uses the phase_owner_id named set.

PAUSE_REQ

None

Boolean

Shows that the operator requested the Paused state. This is set and cleared by the Batch Executive, based on the operator Pause and Resume commands and the Single-step mode.

PAUSED

None

Boolean

Shows that the phase is in the Paused state. This is set and cleared by the phase logic, based on the PAUSE_REQ flag.

PHASE

None

String

Returns the phase short name that the operator uses for the phase. The short name is configured in the unit.

PHASE_ACT

None

Boolean

Determines whether or not an alarm is generated associated with the phase on the unit.

During each execution of the phase logic a failure condition is computed that is used to set PHASE_ACT if ALARMENB is True.

FailureCondition = TooLong || (FAILINDEX <> 0) || (PHASE_ENABLE==FALSE) where TooLong = (TOOLONGTIME > 0) && (TIME > TOOLONGTIME) and the TIME is the time that the phase has been executing.

The PHASE_ACT parameter is referenced by the associated module's alarm parameter at the module level.

PHASE_CURRENT

None

Boolean

Indicates whether a loaded phase is using the latest version of the phase definition. Typically, if you download a new phase definition to a controller with a loaded phase using an older definition, the phase continues to use the old definition until it is reloaded.

If the loaded phase is using the latest definition, PHASE_CURRENT is set to TRUE.

If the loaded phase is using an older definition, PHASE_CURRENT is set to FALSE.

This parameter is read-only.

PHASE_ENABLE

None

Boolean

Enables phase logic execution. True = enabled; False = disabled.

PROMPT_BOOL

None

Boolean

Used to store the operator response to a Boolean prompt (where the operator selects either yes or no as a response).

PROMPT_FLOAT

None

Floating Point

Used to store the operator response to a floating point prompt (where the operator enters a real number in a blank field as a response).

PROMPT_INT

None

32-bit signed integer

Used to store the operator response to an integer prompt (where the operator enters a value in a blank field as a response).

PROMPT_STRING

None

String

Used to store the operator response to a string prompt (where the operator enters a string in a blank field as a response).

REQDATA1...5

None

16-bit unsigned integer

Used to pass request data between the phase logic and the DeltaV Batch Executive.

REQUEST

None

16-bit unsigned integer

A request to the DeltaV Batch Executive from the phase logic.

RESTART_TYPE

None

Named set

Specifies whether, upon restart, the RUN_LOGIC should resume at the first SFC step or the SFC step from which it was HELD.

This parameter uses the phase_restart_types named set.

SINGLE_STEP

None

Boolean

Shows the continuous pause request.

SIZE

None

32-bit unsigned integer

Contains an estimated size for an instantiated phase. The value of this parameter is used when phases are created to determine if there is enough memory available to start the phase(s).

STATE_TIME

Seconds

Floating point

Shows the time the module has remained in the current state.

STEP_INDEX

None

16-bit unsigned integer

Configured by the user, the STEP_INDEX can be used to indicate each step in a phase to track the phase while running. This is an integer written by the phase logic for use by recipe logic or DeltaV Operate.

A phase's STEP_INDEX is reset to zero (0) after the phase is sent a Start command.

SWITCHED_OVER

None

Boolean

Shows that the controller in which the phase is running has undergone a redundant switch over. This is cleared by the phase logic after use.

TOO_LONG_TIME

None

32-bit unsigned integer

The time after which the phase alarm will be set.

The initial value is determined when a phase is created. It subsequently can be written to by the user. A value of zero disables too long timing, which can contribute to setting a phase alarm.

UNIT

None

16-bit unsigned integer

Shows the equipment ID of the unit.

WATCHDOG

None

16-bit unsigned integer

Used to verify communication with the DeltaV Batch Executive.

The Batch Executive writes to the WATCHDOG parameter when the phase state is not idle and the owner is DeltaV Batch. The phase logic checks the WATCHDOG parameter every time it executes and clears it.

When the WATCHDOG parameter is unit based (for unit modules), the Unit's WATCHDOG parameter controls the WATCHDOG parameter for the active phases on that unit. That is, the unit phases' WATCHDOG parameters inherit the unit's WATCHDOG parameter's value.

WDOG_STATE

None

Named Set

Used to indicate the state of communication between the phase logic and the Batch Executive.

There are three states: OK, Suspect, and Failed.

If the WATCHDOG parameter is cleared, then the state is OK. If the WATCHDOG parameter is not cleared after one check, then the state is Suspect. If the WATCHDOG parameter is not cleared after the time out value is passed, then the state is Failed.

This parameter uses the phase_wdog_states named set.

WDOG_TIME

Seconds

Floating point

Records the time since the WATCHDOG parameter was last cleared.

XCOMMAND

None

Named set

Commands the phase to go to a particular state, as defined by the state transition diagram. This parameter is used when running the batch externally. See OWNER parameter.

This parameter uses the phase_command named set.

Note

The data types used in these parameters refer to standard DeltaV parameter data types.

These parameters are filtered. Refer to the following table to see how the parameters are filtered.

Table: Default Batch Parameter Filter Categories

Parameter

Filter Category

Common Configurable

Advanced Configurable

I/O References

Connectors

Online Parameters

Quick Configuration

AUTO_RESTART

X

BATCH_ID

X

BCOMMAND

X

BSTATUS

X

CLASS

X

COMMANDMASK

X

CONFIRM_FAIL

X

DOWNLOAD_REQ

X

FAIL_INDEX

X

INITIAL_STATE

X

OWNER

X

PAUSE_REQ

X

PAUSED

X

PHASE

X

PHASE_ACT

X

PHASE_ENABLE

X

PROMPT_BOOL

X

PROMPT_FLOAT

X

PROMPT_INT

X

PROMPT_STRING

X

REQDATA1…5

X

REQUEST

X

RESTART_TYPE

X

SINGLE_STEP

X

SIZE

X

STATE_TIME

X

STEP_INDEX

X

TOO_LONG_TIME

X

UNIT

X

User-configured Batch Parameter

X

X

X

X

X

X

WATCHDOG

X

WDOG_STATE

X

WDOG_TIME

X

XCOMMAND

X