Understanding the Delete Dialog Box
Multiple calculations can be selected and deleted. A dialog box is invoked to confirm the deletion of the calculations based on one of two conditions.
1. If the deletion of calculations results in other calculations now having missing dependencies, then the following dialog box is invoked:
The dialog box indicates how many calculations will become invalid as a result of the delete operation. The dialog box has the following items:
• The Yes button deletes the selected calculations and closes the dialog box.
• The No button cancels the delete operation and closed the dialog box.
2. If deleting the selected calculations does not invalidate any existing calculations, then the following confirmation dialog box is invoked:
The dialog box has the following items:
• The Yes button deletes the selected calculations and closes the dialog box.
• The No button cancels the delete operation and closes the dialog box.
If you are viewing the details of a calculation using the Calculation Editor and the calculation is deleted, then the following dialog box is invoked:
The dialog box has the following items:
• The OK button closes the dialog box and closes the Calculation Editor for the deleted calculation.
Understanding the Inhibit Dialog Box
A calculation can be selected and inhibited through the Inhibit… menu option. A calculation cannot be inhibited if it has any of the following quality codes:
• Parse Error
• Missing Dependency
• Circular Reference
When you inhibit a calculation the following dialog box is invoked:
The dialog box consist of the following items:
• The Comment field allows you to add a reason as to why the calculation is being inhibited.
• The OK button will close the dialog and inhibit the calculation. The OK button is only available if a reason has been given in the Comment section.
• The Help… button displays Online Help for the Inhibit dialog box.
• The Cancel button closes the dialog box and cancels the inhibit operation.
Once the calculation is inhibited, its value will no longer be updated until the inhibit operation is removed. If the calculation is associated with a SCADA measurement (the calculation writes its value back to the SCADA measurement), then the SCADA measurement will also appear as inhibited in the SCADA Summary.
If you view the details of the inhibited calculation, the details are displayed in view only mode until the inhibit operation is removed.
The Comment, Who, and Comment Timestamp columns in the Calculation Summary are updated with the reason supplied in the dialog box, the operator who applied the inhibit operation, and the time the operation was applied.
The quality of the calculation is set to Inhibit.
Once the calculation is inhibited you can perform the following actions on it:
• Delete the calculation.
• Apply a Manual Override to the calculation.
• Apply a Cancel Inhibit to the calculation.
Understanding the Manual Entry Dialog Box
A calculation can be selected and a value manually entered through the Manual Entry… menu option. A calculation cannot be manually entered if it has any of the following quality codes:
• Parse Error
• Missing Dependency
• Circular Reference
• Inhibit
When you apply a manually entered value to a calculation, the following dialog box is invoked:
The dialog box consist of the following items:
• The New Value field allows you to specify a new value for the result of the calculation.
• The OK button will close the dialog and apply the manual value to the calculation.
• The Help… button displays Online Help for the Manual Entry dialog box.
• The Cancel button closes the dialog box and cancels the manual entry operation.
Once the value of a calculation is manually entered its result will be updated to the manual value. Any calculation that references it will use the manually entered value when evaluating its own value.
The manual value is automatically cleared the next time any of the calculations dependencies are updated.
If the calculation is associated with a SCADA measurement (the calculation writes its value back to the SCADA measurement), then the SCADA measurement will also appear as manually entered in the SCADA Summary.
The quality of the calculation is set to Manual.
Once the calculation is manually entered, you can perform the following actions on it:
• Delete the calculation.
• Apply an Inhibit to the calculation which will make the calculation manually overridden.
• Apply a Manual Override to the calculation.
• Apply a Cancel Manual Entry to the calculation.
Understanding the Manual Override Dialog Box
A calculation can be selected and a value manually overridden through the Manual Override… menu option. A calculation cannot be manually overridden if it has any of the following quality codes:
• Parse Error
• Missing Dependency
• Circular Reference
When you apply a manually override to a calculation the following dialog box is invoked:
The dialog box consist of the following items:
• The New Value field allows you to specify a new value for the result of the calculation.
• The Comment field allows you to add a reason as to why the calculation is being manually overridden.
• The OK button will close the dialog box and manually override the calculation. The OK button is only available if a reason has been given in the Comment field.
• The Help… button displays Online Help for the Manual Override dialog box.
• The Cancel button closes the dialog box and cancels the manual override operation.
Once the calculation is manually overridden, its value will no longer be updated until an inhibit operation or manual override is removed. If the calculation is associated with a SCADA measurement (the calculation writes its value back to the SCADA measurement), then the SCADA measurement will also appear as manually overridden in the SCADA Summary.
If you view the details of the manually entered calculation, the details are displayed in view only mode until the inhibit operation or manual override is removed.
The Comment, Who, and Comment Timestamp columns in the Calculation Summary are updated with the reason supplied in the dialog box, the operator who applied the manual override operation, and the time the operation was applied.
The quality of the calculation is set to Override.
Once the calculation is manually entered you can perform the following actions on it:
• Delete the calculation.
• Apply a new Manual Override to the calculation.
• Apply a Cancel Inhibit to the calculation which will make the calculation manually entered.
• Apply a Cancel Override to the calculation.
Understanding Cancel Inhibit
You can cancel an inhibit operation on a calculation if it is inhibited or manually overridden. Canceling an inhibit operation on an inhibited calculation shall return the calculation to its real‑time value. Canceling an inhibit operation on a manually overridden calculation shall make the calculation manually entered. The calculation shall retain its manual value until the next time one of its dependencies is updated.
Understanding Cancel Manual Entry
You can cancel a manually entered operation on a calculation if it is manually entered. Canceling the manual entry shall return the calculation to its real-time value.
Understanding Cancel Manual Override
You can cancel a manually override operation on a calculation if it is manually overridden. Canceling the manual override shall return the calculation to its real-time value.
Understanding the Variables Summary
The Variables Summary provides a list of all variables in the system. A variable is a calculation whose value is not associated with a device. Variables are typically used to hold common constant values or global values that are referenced by other calculations and variables. Both variables and calculations use the Calculation Editor when creating new or updating existing variables or calculations. Many of the operations that can be performed on a calculation can also be performed on a variable.
The Variable Summary consists of four parts:
Variable Summary Menus and Toolbar
File Menu
Sort Menu
Actions Menu
Options Menu
Help Menu
Variable Summary Quality Summary
The Quality Summary provides a count of the number of variables categorized into quality. The summary displays a count of all variables in the system. The counts are independent of any additional filtering currently selected in the Variable Summary Table or Variable Summary Filters or any truncation as a result of the MaxCalculationsToFetch Event Management Rule.
The summary displays the following information:
• Good: The number of variables with good quality.
• Parse Errors: The number of variables with syntax errors.
Variable Summary Table
The Variable Summary Table contains all the variables in the system. The table displays the following information:
• The Name of the variable.
• The Calculation definition.
• The real-time Value of the variable.
• The Quality of the variable. If this column is empty then variable is good quality otherwise it is one of the following values:
• Parse Error: There is a syntax error in the definition of the variable.
• Inhibit: The variable has been inhibited by an operator.
• Manual: The value of the variable has been manually entered by an operator.
• Override: The value of the variable has been manually overridden by an operator.
• The Error contains additional error information to facilitate understanding missing dependencies, circular references and parse errors.
• The Trigger indicates when the variable is evaluated. The value can be one of:
• On Change: The variable is evaluated every time one of its dependencies changes value.
• Periodic: The variable is evaluated periodically.
• On Change and Periodic: The variable is evaluated periodically and every time one of its dependencies changes value.
• The Periodicity is the time between periodic evaluations if the variable trigger is set to Periodic or On Change and Periodic.
• The Comment is an operator supplied comment used when the variable is inhibited or overridden.
• The Who column is the name of the operator who has inhibited or overridden the variable.
• The Comment Time column is the time at which the inhibit operation or override operation was applied.
Truncated Results
The Variable Summary Table will be truncated if too many rows are fetched from the server. The maximum number of variables that can be fetched is controlled by the MaxCalculationsToFetch Event Management Rule and defaults to 2000 rows.
Variable Summary Filters
The
Variable Summary provides a set of global filters that can be applied to the contents of the Variable Summary Table. For the full list of available filters see
The Calculation Summary Filters.
Understanding the Calculation Editor
The Calculation Editor is used to view, update, or create new calculations or variables.
The Calculation Editor consists of the following parts:
• The Calculation Title contains the id of the calculation.
• The Calculation Menus and Toolbar contains all the actions that can be performed.
• The Calculation Details holds information on the calculation properties.
• The Calculation Definition holds the definition of the calculation and real time data.
• The Calculation Functions categorizes all the calculation engines functions into groups.
The Calculation Title
The calculation title is shown in the Calculation Editor title and in the tab name. If you modify the details of a calculation but have not yet saved the calculation, then the calculation title adds an asterisk character to indicate that there are unsaved changes.
The Calculation Editor Menu and Toolbar
File Menu
Actions Menu
Help Menu
Search Box
The Search Box allows you to quickly locate search text in the calculations definition by highlighting the text. For example:
The search box can automatically highlight open and closing brackets (), or open and closing hard references [] or open and closing soft references {} by just searching for the open bracket (, open hard reference [ or open soft reference {.
The Calculation Details
The Calculation Details displays name, id and other properties of the calculation or variable. Based on whether a calculation or variable is being edited the details are slightly different.
Calculations
The calculation details contains the following information:
• The Name contains the name of the calculation.
• The ID contains the unique ID of the calculation.
• The Trigger contains the evaluation type of the calculation and can be one of the following values:
• On Change: The variable is evaluated every time one of its dependencies changes value.
• Periodic: The variable is evaluated periodically.
• On Change and Periodic: The variable is evaluated periodically and every time one of its dependencies changes value.
• The Periodicity is the time between periodic evaluations if the calculation trigger is set to Periodic or On Change and Periodic and can be one of the following values:
• 1 minute
• 5 minutes
• 10 minutes
• 15 minutes
• 30 minutes
• Hourly
• Daily
• The Device is the name of the device associated with the calculation.
• The Inheritance property of the calculation. The value can be one of:
• None: The calculation is not derived from a device class rule
• Inherited: The calculation is inherited from a device class rule
• Overridden: The calculation was inherited from a device class rule but has subsequently been modified such that its definition now differs from the device class rule it was associated with.
The Periodicity is only applicable when the Trigger is set to Periodic or On Change and Periodic and is not enabled when the Trigger is set to On Change.
The Periodicity combo box has a blank entry. If this blank entry is selected then the Trigger automatically updates to On Change. Likewise if the trigger is updated to On Change the Periodicity is automatically cleared.
Within the calculation definition you can reference the value of other calculations or SCADA measurements. The calculation or measurement can be a Hard [] or Soft {} reference. If an object is a Hard reference then its value changing will trigger a recalculation of this calculations value. If an object is a Soft reference then a change in its value will not trigger a re-evaluation. If you select to make the Trigger value Periodic the Calculation Engine will automatically change all Hard references to Soft references. Note changing the Trigger value back will not revert the Soft references back to Hard references and the references must be modified by hand.