Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Recipe Management

View the Procedure tab

  • Last UpdatedMay 16, 2024
  • 9 minute read

On the Execution details page, Equipment that are assigned a Recipe will display the Procedure tab. The Procedure tab shows the SFC panel and also the grid view panel when a Capability or Transition is selected.

During execution of the Recipe, the SFC panel shows the statuses for Capabilities and/or Transitions that are executing or finished executing.

  • For Capabilities, the following are shown:

    • Alias Name

    • Capability Name

    • Status

    • Tooltip

      • Capability Name

  • For Transitions, the following are shown:

    • Status

    • Tooltip

      • Alias Name

      • Expression

You can select a tile to view the additional information.

Capability Grid View Panel

During Recipe execution, you can select a Capability to view its associated parameters in the grid view. The parameters are displayed in the nested tabs as per their grouping. The Grid view is collapsed if you unselect the Capability in the SFC panel.

When you select a Capability, the following grid view information is shown:

Column Name

Description

Parameter

Name of the parameter

New Target

Displays the Capability parameter targets. You can edit the value when the Equipment is in Assigned status.

NOTE: You can update the Capability parameters only when the specific instance of Capability is not being executed.

Current Target

Displays a current target value when the Capability is being executed.

Actual

Displays an actual value.

NOTE:

  • If the Capability has not started yet, the value is blank.

  • When the Capability is running, the value is Bold.

  • When the Capability is Complete/Stopped/Aborted, the value is Italic, because its value is coming from history.

Min Value

Displays the minimum value assigned to the parameters.

Max Value

Displays the maximum value assigned to the parameters.

UOM

Displays the Units of Measure for the parameters.

Edit

Click the edit icon to edit the target values for the Capabilities which are in idle status.

NOTE: You cannot edit target values of Capabilities when the Recipe is started, and the Capability is in running status. However, you can edit the Actual or Extension values of a "running", "waiting for required edits", or "waiting for ack" manual Capability parameter if it does not have IO defined for the actual or extension. Also, you can only change the Parameter Extensions associated with Groups if you have permission.

Transition/Loop Grid View Panel

When you select a transition, the following grid view information is shown:

NOTE: The expression used by the Transition/Loop is displayed on top of the Grid view.

Column Name

Description

Variables

Name of the variable used by the expression.

Value

Displays an actual value.

NOTE:

When the transition is in an inactive state, the value is blank.

When the transition is Running/Repeating, the variable value is Bold.

When the transition is Complete/Stopped/Aborted the value is Italic, because its value is coming from history.

NOTE: "???" is displayed for Actuals if the IO is reporting bad quality or connection is lost with the IO layer. Recipe execution treats 0xC0 as good quality. If the quality is updated along with vendor quality information, like (0x1C0, 0x2C0, or 0x3C0) by the Control System, the vendor information is masked, and the resultant quality is treated as 0xC0 by the recipe execution.

You can adjust the height of the SFC panel and the Grid view panel. The SFC and Grid view panel height ratio is saved in the system. You can also manually collapse and expand the Grid view.

In the SFC View, the behavior of the auto scroll also changes as per your selection. If you select a Capability or transition, the auto scroll is temporarily turned off and the Disable Auto Scroll and Enable Auto Scroll buttons are not available. You can also manually disable the auto scroll by clicking the Disable Auto Scroll button. To revert to the auto scroll option, click Enable Auto Scroll. By default, auto scroll is available on the Procedure tab of the Execution details page.

When you execute the Procedure, the auto scroll mode becomes active and the SFC view is automatically scrolled horizontally or vertically to display the newly executed Capability in the middle of the SFC view. The auto scroll is stopped and the Enable Auto Scroll button is hidden when the Recipe is aborted, stopped or completed.

NOTE: The horizontal auto scroll is active and shows the active Capability even if the SFC is very wide.

When a Capability or transition executes within a loop or branch, the auto scroll is only triggered at the start of its execution, not on subsequent state changes.

The Recipe execution exposes the following:

Capability:

  • You can Hold/Restart, Pause/Resume, Stop, and Abort Capability if the Capabilities have the respective Control IO tags defined and you have the appropriate privileges.

Transitions:

The engine will evaluate the transition expression using the Equipment variables defined on the Equipment. Since the Equipment variables are not defined with a datatype, the datatype used by the engine will come from the IO layer. So if your Tag/Attribute/IO is defined as a string, then it will be used as a string when evaluating the expression.

  • Transitions that are running can be forced true (if you have the appropriate privileges).

  • Transition is in "Running" status when the expression is being evaluated.

  • Transition is in "Complete" status when the expression is evaluated to true.

  • Transition cannot be individually requested to Hold/Pause/Stop/Abort, however, if the Recipe is requesting Hold/Pause/Stop/Abort, the transition will enter those states.

Loops

  • If there is a loop in the procedure, the loop gets repeated until it gets evaluated to false.

  • When a loop repeats the status is set to "Repeating" and the status of the Capabilities and transitions inside the loop are cleared.

Execute one branches

  • The first leg to evaluate to true gets executed.

  • The transition on the "winning" leg will report a status of "Complete".

  • The transition on the "losing" leg will report a status of "Aborted".

Execute All branches

  • All the branches will execute at the same time but multiple instances of the same Capability will not be executed at once.

In the case of Capabilities which require operator intervention

The manual Capabilities that you defined in the procedure change to the “Waiting For Req Edits” during execution if the Editable At Runtime is set to Yes during the configuration of Parameter Extensions and the Edit Actual Required is set to Yes for the Capability Parameters. When the Capability is in the “Waiting for Req Edits state”, the Capability status color changes to “Yellow” and status text shows “Waiting For Req Edits”. You must either acknowledge or abort the selected manual Capability before you can move forward with the procedure execution.

In this state, you must manually enter the actual values. The Capability status is updated to Yellow and the actual value cell in the grid is highlighted. The Acknowledge Capability button is hidden in this state.

NOTE: If you set the Target values to 0 during assignment of Recipe, the Actual value cell in the grid is not highlighted during execution and are not mandatory. Similarly, no Parameter Extensions will be highlighted and is not mandatory (unless the actual is edited to non-zero). For more information, refer to the Zero Target or Zero Actual Value topic.

A new notification appears on the top right of the window to inform the operator action if edit is needed. The count of the notification depends on the number of Capability parameters that require operator intervention. The count is also updated on the Equipment tile in the Execution summary page.

If you click the notification, a slide-in window appears with a list of activities that requires operator intervention. You can click the selected Capability to edit the value. After the operator intervention is completed and the Capability value is edited, the Acknowledge Capability button appears, and the status text shows "Waiting For Ack".

  • The operator can acknowledge a Capability by clicking on the “Acknowledge Capability” button. This button is shown only when the Capability is in the “Waiting For Ack” state and any "Required Edit" is completed.

  • Capability goes to the "Complete" state only when the operator acknowledge the Capability.

  • Editing actual values and acknowledging Capabilities requires the appropriate privileges.

In the case of Parameter Extensions for which Actual Value is required

If the Actual Value Required property is set to Yes for a Parameter Extension during the Configuration phase, then the user can edit the parameter extension after an Ack On Exit Capability starts and if the user has permission to edit the Parameter Extension group.

When the Actual Value Required property of Parameter Extension is updated to Yes, and the Capability is in running or waiting for ack state and if no IO is defined for the extension and if the value is currently blank, then the Parameter Extension is highlighted in yellow color in the Execution page while running the recipe. It indicates that the user needs to provide the value manually. User cannot acknowledge the capability until a valid extension value is provided. Once the user provides the valid extension value, then the highlighted yellow color will be removed.

  • The user can edit a Parameter Extension by clicking the Edit button. This button is shown only when the user has permission to edit the Parameter Extension. Otherwise, the Edit button is not available even though the Parameter Extension which requires Actual Value is highlighted in yellow.

  • A Parameter Extension that requires an Actual Value is shown in the nested tab as per the Group. Parameter Extensions that belong to "All Groups" are available to all the parameters, while Parameter Extensions that are mapped to a Group are available only to parameters with the matching group. For example, parameter extension "PE1" mapped to a group "Input" will only be available in the Input tab whereas the parameter extension "PE2" that belong to "All Groups" will be available for all the tabs.

  • If a manual capability has a Parameter Extension with Actual Value Required set to “No” and an IO reference is defined for the parameter extension, then the user cannot edit the extension value. The user can edit the extension value for this parameter only when there is no extension IO reference defined. The Extension cell will not be highlighted for this parameter.

Zero Target or Zero Actual Value

For Input/Output parameters that belong to manual Capabilities, if they have any Edit Actual Required behavior under normal circumstances, then they may be “Downgraded” to Edit Allowed if they have a zero Target or a zero Actual value. This will keep them from being shown in yellow and will not cause the Capability to remain in the “Wait for Required Edit” state. This applies to the Actual and the Extension values while the Capability is running. Parameters that are “Downgraded” can then be “Upgraded” if a non-zero value is entered. “Upgrading” means the parameter will behave as normal (i.e. require edit, highlight yellow, etc.). The following are the rules for this feature:

  • If a Target value is zero, then the Edit Required is downgraded to Edit Allowed. Also, in this case, all extensions are downgraded as well.

  • If an Actual value is empty (no value entered), the extensions follow the Target rules above (it is based on the Target being zero or not).

  • If an Actual value is zero, the extensions are downgraded to Edit Allowed. The above Target rules no longer apply.

  • If an Actual value is manually changed to non-zero (i.e. not including from IO), the extensions are upgraded back to their normal rules of Edit Allowed / Edit Required. The above Target rules no longer apply.

    NOTE: In this case, the manual Capability can move to the Wait for Required Edit state from the Wait For Exit Ack state.

View the Capability Instructions and Documents

You can view the documents/instructions associated with a Capability.

To view the documents

  1. Open the Execution details page and then click the Procedure tab.

  2. In the SFC view, select the Capabilities and then click View Document to see the associated instructions. The Document View Details sliding window appears.

  3. Click the Instruction tab to view the instructions associated with the selected Capability.

  4. You can also view the document by clicking the associated document label available next to the Instruction tab.

    NOTE: The Instruction and Documents tabs are available only when the selected recipe has both the instruction and document details available. Otherwise, only the Instruction tab or Document details tab is available depending on their availability for the recipe. When you open the document in full-screen, the specified document will be displayed in a new instance of the browser.

Points to remember

Only documents supported by the browser are displayed in the user interface. Please check the respective browsers’ documentation.

The following list provides some general rules:

  • Documents should be stored in an accessible location for all users and browsers, for example, under the AVEVA Recipe Management website or on Sharepoint which can be accessed by the application.

  • As AVEVA Recipe Management starts with https protocol, the Document URL also should use https.

The following describes a typical use of the Document View.

  1. Create a folder from the AVEVA Recipe Management root directory, for example, C:\inetpub\wwwroot\RecipeManagement\doc.

  2. Create a document, for example, recipe_guideline.pdf.

  3. Copy recipe_guideline.pdf to C:\inetpub\wwwroot\RecipeManagement\doc.

  4. When associating this document to a procedure’s capability in the Document URL, enter: https://machine.domain.com/RecipeManagement/doc/ recipe_guideline.pdf.

    where https://machine.domain.com:/RecipeManagement is the URL to launch AVEVA Recipe Management.

    NOTE:
    - Specify the port number if you have not configured the server with the default port number 443. For example, https://machine.domain.com:<portnumber>/RecipeManagement
    - In the new URL, the product name RecipeManagerPlus is change to RecipeManagement.

    Viewing the Full Screen mode

    You can also view the procedure container window in full-screen mode by clicking the Full Screen icon available on the Procedure tab of the Execution details page.

    NOTE: When you view the Execution full-screen, the Assign Formula button is not available.

    To exit the full screen, click Exit Full Screen.

    In This Topic
    Related Links
    TitleResults for “How to create a CRG?”Also Available in