Define Equipment States in Plant SCADA Studio

Name

Name of the State. Usually this would be an 'action' the equipment could be scheduled to do. For example, a light could have the action 'on' or 'active' defined.

Cluster Name

The name of the cluster to which this State will belong.

Equipment

The equipment associated with this state. For example: "Factory.Floor.Line1.Light1".

See Equipment.

Equipment should be an existing item on the selected cluster.

Entry Action

The action the State will take when triggered. For example the entry action for light 1 could be tag_light1=1. When light 1 is scheduled, this will trigger the light to turn on. The Entry Action can be a Cicode expression.

Note: You should not enter a Cicode function that relates to a graphics page in this field, as this type of function will only execute successfully on a display client.

Be aware that long actions on this field may delay or prevent other scheduled actions from running. For example, if there is "action1" for startup and "action2" for repeat, if "action1" is an infinite loop, "action2" will be prevented from running. If "action2" takes a long time to complete, no new "action2" actions will run until the former finishes. If you need to run a long task, create an independent Cicode task using TaskNew function.

You can use the INI parameter [Scheduling]AlwaysExecuteEntryAction to specify that the entry actions for all equipment resource states are executed, regardless of whether or not their internal states are the same. By default, this parameter is set to false (0), which means only changes that have been made to the selected equipment will take effect.

Delay

The time that needs to elapse before the state will initially become active.

If delay is defined the Entry Action for the state will not occur until the delay period has elapsed. For example; this would allow you to turn on every light sequentially to avoid a power spike.

Repeat Action

An action set to run periodically when state is active. Repeat Actions can be a Cicode expression.

Note: You should not enter a Cicode function that relates to a graphics page in this field, as this type of function will only execute successfully on a display client.

Be aware that long actions on this field may delay or prevent other scheduled actions from running. For example, if there is "action1" for startup and "action2" for repeat, if "action1" is an infinite loop, "action2" will be prevented from running. If "action2" takes a long time to complete, no new "action2" actions will run until the former finishes. If you need to run a long task, create an independent Cicode task using TaskNew function.

Period

Sets the frequency of the 'Repeat Action'. For example set the repeat action to occur every hour.

Note: The repeat period will not start until the entry action has completed. The first repeat action will occur after the entry action completes plus one repeat time period. For example, if the Entry Action takes ten minutes to complete, the Repeat Action will not start until after ten minutes even though the Repeat Action is set to occur every two minutes.

Priority

Number used to determine which schedule entry will run if a schedule conflict occurs between more than one state.

Comment

Any useful comment.

DR Mode

Demand and Response (DR) mode (see Configure a Demand and Response Solution). The default DR mode value is 0.

Project

The project in which the equipment state is configured.