Properties

None

None

Phasename_OC

None

None

Phasename_EC

Phasename_F

None

None

None

None

None

None

Phasename_W

PhasenamePnn

Phasename_P

Phasename_PD

PhasenameRnn

Phasename_RQ

PhasenameQnn

None

Phasename_SS

Phasename_ST

Phasename_SI

None

None

None

Phasename_UN

None

None

None

None

User configurable flag. When set to TRUE, a checkpoint file is updated as needed with all pertinent runtime parameters. The checkpoint file is an internal reference file that is not user-modifiable. The file is updated after each scan if a property change is seen. This file is then loaded when the phase application is started, or when the

CheckPoint

method is called. When set to FALSE, a checkpoint file is not maintained.

The default value is

TRUE

.

User configurable flag. When set to TRUE, any pending request by the phase logic is canceled when a change of state is initiated. This property should be used in conjunction with the

RestoreRequest

property. The PLI will not allow ClearRequest to be FALSE and RestoreRequest to be TRUE (the request would be issued twice in this case).

The default value is

TRUE

.

Contains the command information as received from the

FactoryTalk Batch

Server. The phase responds to this command register when the phase is in program control (owned by the

FactoryTalk Batch

Server). This parameter is reset after each PLI scan, so its contents are NOT indicative of the last command sent by the

FactoryTalk Batch

Server.

Used as the base for tag names when the

UseDefaultDDETagName

property is set = FALSE and

DDEBaseTagName

property is not null. For example, if this property is set = BOO, and the

UseDefaultDDETagName

property is FALSE, then the tag for the phase state is BOO_ST. If this property is empty, the

Name

property is used as the tag name base regardless of how the

UseDefaultDDETagName

property is set.

Flag set by the PLI if the

FactoryTalk Batch

Server has sent a DOWNLOAD command to the phase. The Server sends a DOWNLOAD command when there is a Transfer of Control condition between two consecutive equipment modules (phase instances) based on the same phase. An example would be two consecutive agitation phases where a change in agitation speed is desired when a tank level has reached a certain point.

The default value is

FALSE

.

Contains the command information as received from an external source (an HMI, for example). The phase responds to this command register when the phase is in external control (NOT owned by the

FactoryTalk Batch

Server).

The default value is

0

.

The

Failure

property is set within the phase logic as desired when there is an error condition that should cause the phase to be HELD. When this property is set to any value greater than zero, the PLI will execute the HOLDING sequence. The PLI will also set this property to the WatchdogFailureValue when the watchdog status is bad and will HOLD the phase. The valid range is 0 to 32767.

The default value is

0

.

Determines the execution interval (in milliseconds) of the PLI and phase logic. (This value should be the number of seconds multiplied by 1000.)

The default value is

1000

.

File name prefix (.LOG is added by the phase execution control) for the activity log file.

The default value is

BATCHPHS

.

Name of the equipment module. This property must match the name given to the equipment module in

FactoryTalk Batch Equipment Editor

. Parenthesis created for control arrays are ignored.

The default value is

Phase1

.

Indicates the number of parameter tags that will be available to the phase. Generally, this value will be equivalent to the number of parameter tags assigned within

FactoryTalk Batch Equipment Editor

. The valid range is 0 to 999.

The default value is

5

.

Indicates the number of report tags that will be available to the phase. Generally, this value will be equivalent to the number of report tags assigned within

FactoryTalk Batch Equipment Editor

. The valid range is 0 to 999.

The default value is

5

.

Indicates the number of request data tags that will be available to the phase. Generally, this value will be equivalent to the number of request data tags assigned within

FactoryTalk Batch Equipment Editor

. The valid range is 0 to10.

The default value is

5

.

Determines phase ownership. When set to TRUE, the phase is in

External

control and will respond to the contents of the

ExternalCommand

property. When set to FALSE, the phase is owned by the

FactoryTalk Batch

Server and will respond to the

Command

property.

The default value is

FALSE

.

Phase parameters, where the total number (N) is specified in the

NumberOfParameters

property. These are downloaded from the

FactoryTalk Batch

Server by placing the appropriate values into the

Request

property. A NULL string is returned if Initialize has not yet been called; Invalid index is returned when an illegal (out of range) index is used. (Refer to the

PCD Programmer Technical Reference Guide

for details.)

The

Pause

property (pausING) is set by the PLI when the Pause command is received, or when single-step mode is activated. (Refer to the

Server API Communications Language Reference Guide

FactoryTalk Batch

for further details).

The default value is

FALSE

.

Set within the phase logic as desired to place the phase in the Paused state. A Resume command must be issued to continue phase execution when the

Paused

(pausED) property is set. (Refer to the

PCD Programmer Technical Reference Guide

for details).

The default value is

FALSE

.

Report parameters, where the total number (N) is specified in the

NumberOfReports

property. Report parameters are set within the phase logic to upload report values to the

FactoryTalk Batch

Server for archiving. The phase logic must store report values to this property and then store an Upload Request to the

Request

property. A NULL string is returned if Initialize has not yet been called; Invalid index is returned when an illegal (out of range) index is used.

Used to make requests to the

FactoryTalk Batch

Server to accomplish a wide range of tasks such as downloading and uploading parameter and report values. Phase logic stores a predefined request value to this property to initiate action by the Server. This property value must be equal to zero before storing a valid request into this property. This property will return to zero when the Server has completed the requested action. (Refer to the

PCD Programmer Technical Reference Guide

for details.) The valid range is 1000 to 2147483648.

The default value is

0

.

Request data parameters, where the total number (N) is specified in the

NumberOfRequestData

property. The

RequestData

property performs two functions:

A NULL string is returned if

Initialize

has not yet been called; Invalid index is returned when an illegal (out of range) index is used. (Refer to the

PCD Programmer Technical Reference Guide

for details.)

User configurable flag. When the phase transitions from RESTARTING to RUNNING, this property (when TRUE) will cause the request that was pending at the time the phase was HELD to be restored and executed. This property should be used in conjunction with the

ClearRequest

property. The PLI will not allow ClearRequest to be FALSE and RestoreRequest to be TRUE (the request would be issued twice in this case).

The default value is

TRUE

.

Flag toggled by the PLI when it receives a SingleStep command. When single-stepping is turned ON, the

Pause

(pausING) property is set to TRUE if the phase has been in the free-running state. This combination is referred to as the single-step pausing state. When single-stepping is turned OFF, both the Pause (pausING) and Paused (pausED) properties are cleared (set to FALSE) and the phase return to the free-running state. (Refer to the

PCD Programmer Technical Reference Guide

for details).

The default value is

FALSE

.

Contains a numerical value that represents the current phase state. The following are the possible values with the corresponding state:

The default value is

100

.

Set equal to the

StepIndexInitialValue

property by the PLI when the phase is STARTed or RESET. The phase logic may use this property to control program flow.

The default value is

1

.

Used by the PLI to save the

StepIndex

property when the phase is HELD. The StepIndex is restored from the StepIndexBuffer when the phase is RESTARTED.

The default value is

0

.

Default value of the step index. The PLI initializes the

StepIndex

property to the StepIndexInitialValue value when the START or RESET command is received.

The default value is

1

.

This is the Watchdog Item Access Path as defined in a OPC server within the area model. You may define multiple OPC servers to be used with PC-based phases. They do not need to use the same topic. You may also use multiple instances of a control within one project and refer to different OPC servers. If the

Topic

property is set at runtime, it must be set before the

Initialize

method is called.

The default value is

BATCH

.

Contains the UnitID of the unit that controls the phase.

The default value is

0

.

User configurable flag. When set to TRUE, or when the

DDEBaseTagName

property is not null, the content of the

Name

property is used as the base for tag names. When set to FALSE, and the

DDEBaseTagName

property is not null, then the content of the

DDEBaseTagName

property is used.

This is the value that the Failure register is set to when the WatchdogStatus is bad. The value used here should then be defined within the phase_failure enumeration set in the area model. This property can be set to 0, which will turn off the hold on watchdog failure logic; the phase will not be HELD when the WatchdogStatus goes bad. The valid range is 0 to 2147483648.

The default value is

13

.

Current status of the watchdog between the

FactoryTalk Batch

Server and the phase. A zero (FALSE) indicates that the status is bad and communications are down. The PLI will set the

Failure

property to 13 when the

WatchdogStatus

is bad.

The default value is

FALSE

.

Interval, in seconds, between watchdog checks by the PLI. If the

WatchdogTimeout

property is set at runtime, it must be set before the

Initialize

method is called. The valid range is 5 to 1800 seconds.

The default value is

20

.

The timeout period is configurable in the

Batchsvr.ini

file, entered in milliseconds. The default settings are in the [XMAN] section: WatchdogPeriod=10000 and WatchdogCycles=5. The default time period for the

FactoryTalk Batch

is ten (10) seconds. The PCD timer should be set to a value slightly larger than the product of the

WatchdogPeriod

and the

WatchdogCycles

.