View the Equipment Parameters tab
- Last UpdatedMay 16, 2024
- 4 minute read
The Equipment Parameters tab in the Execution page displays the following nested tabs: General, Input, and Output. Apart from these nested tabs, additional nested tabs appear under the Parameters tab if you have defined a number of user defined Parameter Groups. Group tabs are only displayed if they contain parameters. If the group is deleted, it will be marked with an asterisk (*).
When you assign a Formula or Recipe to the Equipment, the following information is displayed in the various tabs of the Equipment Parameters tab:
|
Column |
Description |
|---|---|
|
State |
Displays the runtime state of the Capability instance in the procedure. The color and runtime status are updated in this column when the Capability runtime state changes. |
|
Capability |
Name of the Capability. This column appears only when you assign a Recipe. |
|
Alias |
Displays the Capability instance details used in the procedure. This column appears only when you assign a Recipe. |
|
Parameter |
Name of the parameter |
|
New Target |
Displays the Capability or Equipment parameter targets. You can edit the value when the Equipment is in Assigned state. NOTE: You can update the Capability parameters only when the specific instance of Capability is not being executed. If you update the Capability or Equipment parameter value to zero (0) then the Actual value will not be mandatory. |
|
Current Target |
Displays a current target value during execution. It can be blank. |
|
Actual |
Displays the actual value during execution. It can be blank. |
|
Min Value |
Displays the minimum value assigned to the parameters. |
|
Max Value |
Displays the minimum value assigned to the parameters. |
|
UOM |
Displays the Units of Measure for the parameters. |
|
Extensions |
Displays any additional fields associated with the current Parameter Group. |
|
Edit |
Click the Edit button to edit the target values for the parameters. NOTE: You can edit the Parameter Extensions that belong to "All Groups" or to groups to which you have the permission to access. |
By default, only those parameters are shown in the list whose Frequently Used value is set to Yes while configuring the Formula Templates. You can see all the parameters by clicking the Include non-frequently used parameters check box.
NOTE: If Equipment or Capability Parameters are created with Enum or String list data types, then the targets, actuals, or parameter extensions will be displaying the list data items when you edit a parameter in Execution grids.
If any list item or list data type is deleted, then the deleted list item is appended with * in all the execution grids wherever the list data item is used.
If the actuals or targets from IO are not available in the list items then only the value is displayed. For Enum list, the IO returns an enum value but the enum key name is displayed.
If you create a Capability, Equipment, Formula, or Recipe parameters with Dynamic list data types, then the respective targets and actuals will be displaying the list data items when you edit a parameter in execution grids (Equipment Parameters, Formula Parameters, and splitter grids). The list data items are dynamically populated by calling a URL associated with the dynamic list data type. As row data, control recipe’s information and extra details are passed as arguments to the URL; different data is returned for different arguments. Further, if the TextEntryAllowed attribute is set to true in the Dynamic list configuration, users can provide a new value which is not part of the list. For parameter extensions with Dynamic list data types, the same behavior is applied during Execution.
Grid View During Execution
-
In the detail grid, the Capability Parameters are displayed as per the order of execution
-
If values cannot be retrieved from the control system or the data quality is not good, then "???" is shown in the grid for the value.
-
The target and actual IO values of the Capability parameters are displayed when the Capability in the procedure is active.
-
If the Capability is in Completed, Aborted, or Stopped state, then their actual values are populated from the history.
-
The actual values will be shown in italic font.
-
-
In a loop, if a Capability parameter has executed multiple times with different actual values, then the latest iteration actual values are picked up from the history.
-
The actual values will be shown in italic font.
-
-
Both frequently used and non-frequently used parameters appear in the grid view, however, frequently used parameters appear first.
Filtering
Filter by Parameters and Advanced filters are available for and applied to all the nested tabs in the parameter grid on the Equipment Execution details page.
You can filter by parameter using the filter text box at the top right of the parameter grid.
To clear the filter in the text box click the X.
You can also use advanced filters by clicking on the funnel icon. In the Advanced Filters dialog box, you can search parameters using any or all of the following criteria and then clicking Filter:
-
Parameter
-
Capability
-
Alias
-
Show non-frequently used parameters - When you select this check box, the system displays all the parameters that are not marked as Frequently Used. By default, only Frequently Used parameters are shown.
-
Show parameters for active Capabilities only - When you select this check box, the system displays only the parameters for active Capabilities. This helps you to focus on specific Capabilities during execution.
To clear the filters, click Clear Fields.