Manually Define Equipment States in Citect Studio

System Model > Equipment > Configure Equipment in Citect Studio > Manually Define Equipment States

Manually Define Equipment States

You can manually add equipment states to a Citect SCADA project and associate them with your equipment definitions.

To manually define an equipment state:

In the System Model activity, select Equipment.
On the menu below the Command Bar, select States.

The list of equipment states will display in the Grid Editor.

Add a row to the Grid Editor.
Type the required information in each column, or in the Property Grid (see below for a description of the properties).
Click Save.

Equipment State Properties

General Properties

UNINTENDED EQUIPMENT OPERATION

Do not use the Scheduler in situations where equipment state actions must be executed. The engine does not ensure that defined actions are executed for every state transition. The scheduler engine will not be able to run actions when other state actions for the same equipment take longer time to complete or a communication fault occurs.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

Property	Description
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.

Property

Description

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.

Actions Properties

Property	Description
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.
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 Properties

Property	Description
Project	The project in which the equipment state is configured.

Note:Updates made to the fields on Equipment States will come into effect at runtime once the project is compiled and reloaded.

Note: If the report server is run in single process mode and no user is logged in, all tag writes attempted by the scheduler when actions are run will not succeed. We recommend running the report server(s) in multi-process mode to avoid this issue (the server user will be logged in), or setting the citect.ini parameter [Client]AutoLoginMode to either 2 or 6 to insure a user is always logged in.