Add Event Entry Dialog Box
NOTE: If you are modifying an existing Scheduler event-based entry, the title of this dialog box changes to "Modify Event Entry."
The Add Event Entry dialog box displays the following items:
Schedule Info
Item |
Description |
Name |
Allows you to specify a name for an event-based Scheduler entry. The name can be any alphanumeric name up to 64 characters and must begin with a letter. Do not use names that contain VBA reserved words. See the Microsoft VBA help system for more information on VBA reserved words. |
Description |
Allows you to provide a description of up to 80 characters for an event-based Scheduler entry. |
Event Data Source
Allows you to enter a data source or expression for this Data link. The term data source refers to a reference to a source of information, such as iFIX tagnames and historical files, or other OPC-compliant data servers. A data source may also consist of iFIX objects (such as shapes, charts, and variables) or 3rd party OLE controls. The term expression refers to constants, data sources, or a combination of constants and data sources that are connected with one or more operators. Use the Browse (...) button to open the Expression Builder dialog box. Use the Quick Modify button to modify a database block directly without launching the Database Manager.
Event Properties Tab
Event Type
Allows you to select the condition that must be met for the event-based script to fire. The options are:
Option |
Description |
On True |
Evaluates a Boolean expression in the Data Source field and fires the entry if the expression evaluates to a non-zero value. |
On False |
Evaluates a Boolean expression in the Data Source field and fires the entry if the expression evaluates to zero. |
On Data Change |
Fires the entry every time the value in the Data Source field changes. |
While True |
Evaluates a Boolean expression in the Data Source field and fires the entry at the specified interval for as long as the expression evaluates to a non-zero value. |
While False |
Evaluates a Boolean expression in the Data Source field and fires the entry at the specified interval for as long as the expression evaluates to zero. |
Interval
Allows you to specify the duration of time between each triggering of a While True or While False event-based entry. The entry will fire for as long as the expression in the Data Source field evaluates to one or zero, respectively.
Historical Properties Tab
The Historical Properties tab allows you to set the parameters for a query that fetches historical data from Proficy Historian. The tab contains the following items:
NOTE: The following fields, with the exception of the Update Rate fields, are only available if you select a Historical Mode other than Current Value.
Start Date
Item |
Description |
Fixed Date |
Specifies whether to enter a specific start date for the query of the data source. |
Days Before Now |
Specifies whether to enter the number of days prior to today to fetch data from Proficy Historian. For example, if you want to display data collected for the data source two days ago, enter 2. |
Start Time
Item |
Description |
Fixed Time |
Specifies whether to designate a specific time to start, based on a 24-hour clock. |
Lock Time |
Locks the fixed time, even if you change the time zone in the Date and Time Properties dialog box in the Control Panel. This field is available only when you designate a specific time to start using the Fixed Time field. |
Duration Before Now |
Specifies whether to enter the duration prior to the current time to start. The minimum duration is 0 seconds; the maximum is 23 hours, 59 minutes, and 59 seconds. |
Time Zone
Item |
Description |
Time Zone |
Allows you to select the time zone to associate with the start time. You can select the client time (time zone for your computer), the server time (time zone used by the Historian server), or the tag time (uses the time zone bias of the tag, which is set in Historian). The default time zone is that of the client machine. This field is available only when Historian is used. |
Adjust for Daylight Savings Time |
Adjusts the time if the zone you selected is experiencing daylight saving. This field works only if you selected the Automatically adjust clock for daylight saving changes check box located on the Time Zone tab of the Date/Time Properties dialog box in the Control Panel. |
Historical Mode
Allows you to determine how iFIX selects and fetches data from a historical data source and, determines what each displayed value represents. The options are:
- Sample – The last valid value found, up to and including the start of the specified interval.
- Avg – The average of all valid data found during the specified interval.
- High – The highest valid data point value found during the specified interval.
- Low – The lowest valid data point value found during the specified interval.
- Interpolated – The data is interpreted by assuming that the line between two values is a straight line. All points along that line are estimated except the starting point and the ending point.
- Current Value – The
current value of the data point.
IMPORTANT: The Current Value may update at a rate different from the rate set in the Update Rate field. The update rate is not set solely by the rate entered in the Update Rate field. It also depends on the collection rate, the rate for querying Historian, and the time required to request an update from the Historian server and send it back to the client. As a result, the time it takes to display the updates may be longer than anticipated. Additionally, please be aware that the timestamp for this mode represents the timestamp from the Historian server, not the client.
- Standard Deviation – The standard deviation of all valid data found during the specified interval.
- Total – The total of all valid data found during the specified interval.
Duration
The duration determines the time range for the historical data source. The minimum duration for a fetch is one second; the maximum is 999 days, 23 hours, 59 minutes, and 59 seconds.
Item |
Description |
Days |
Allows you to enter the number of days. This field can be used in conjunction with the other fields in this area. |
Hours |
Allows you to enter the number of hours for the duration for the data fetch query. This field can be used in conjunction with the other fields in this area. |
Mins |
Allows you to enter the number of minutes for the duration for the data fetch query. This field can be used in conjunction with the other fields in this area. |
Secs |
Allows you to enter the number of seconds for the duration for the data fetch query. This field can be used in conjunction with the other fields in this area. |
Update Rate
Allows you to specify the rate at which the data is updated. The default rate is five seconds. Zero is permitted for a one-time fetch. The fastest update rate is five seconds, the slowest, 1:59:59.
Item |
Description |
Hours |
Allows you to enter the number of hours for the rate of data update. This field can be used in conjunction with the other fields in this area. |
Mins |
Allows you to enter the number of minutes for the rate of data update. This field can be used in conjunction with the other fields in this area. |
Secs |
Allows you to enter the number of seconds for the rate of data update. This field can be used in conjunction with the other fields in this area. |
Action Info
Item |
Description |
Operation |
Displays the command(s) currently scheduled to trigger when the defined event occurs. If the field is blank, you can specify one or more commands by clicking the Run Wizard button to open the Multiple Command Script Wizard, or the VB Editor button to open the VB Editor. If more than one command is specified, the Operation field will display "Multiple Commands". If you specify a command using the VB Editor, the Operation field will display "Custom Script". |
Run Wizard |
Opens the Multiple Command Script Wizard to automatically create a VBA script for the current event-based entry. |
VB Editor |
Launches the Visual Basic Editor to display the script, if any exists, for the current event-based entry. If no script exists, you can use the VB Editor to create one. |