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

AVEVA™ Recipe Management

Add Capabilities

  • Last UpdatedMay 16, 2024
  • 5 minute read

When you create Capabilities, you can define both the Capability Parameters and the required Control/Status for the new Capability.

Setting up Parameters for the Capability

Capability Parameters contains the following attributes:

  • Parameter

  • Description

  • Edit Actual Required

  • Optional Target

  • Group

  • Data Type

  • Max Value

  • Min Value

  • UOM

To add parameters to the Capabilities

  1. From the Main menu, select Configuration > Capabilities to show the Capabilities Summary page. A list of existing Capabilities is shown as tiles.

  2. Click the Add button. The Capabilities details screen appears with a default name that you can change.

    NOTE: The Capability name cannot exceed 32 characters.

  3. In the Description box, enter a description for the Capability.
    The newly added Capability is in Draft state, and checked out to the user who is currently logged into the computer and is accessing the application.

  4. On the Parameters tab, click the Add button. A new row appears in the parameter grid.

  5. Complete the parameter fields by providing the following details:

    • Parameter: Specify the name of the parameter. The maximum length of the parameter for a Capability cannot exceed 329 characters.

    • Description: Type the description of the parameter. The maximum length of the parameter description cannot exceed 512 characters.

    • Edit Actual Required: Select Yes or No from the list. This column appears only if you set the Ack on Exit option as Yes for a Capability. By default, the Edit Actual Required value is No.

      • If it is Yes, it specifies that the operator (at execution) must edit the actual value of the parameters before acknowledging the Capability. It also means you cannot define an I/O reference for the parameters actual value in the consuming Equipment.

      • If it is No, then defining an I/O reference for the actual value is optional per consuming Equipment. If you provide an I/O reference, the actual value cannot be edited by the operator (at execution). If you do not provide an I/O reference, then editing the actual value is allowed, but is not required.

    • Optional Target: Select Yes or No from the list. By default, the Optional Target value for Capability Parameters is No.

      • Parameters with Optional Targets do not require a target value I/O reference to be defined per consuming Equipment. A target value without an I/O reference defined will still be visible to the operator (at execution) but is not written.

      • Parameters with Optional Targets do not require a mapping to the Formula when building a Recipe Procedure mapping. If no mapping is defined and the operator doesn't enter a target value (at execution), then no value will be written.

    • Group: Select a parameter group from the list, if required.

      NOTE: If you select either Input or Output from the Group column, then the Data Type column is updated to Double and is not editable.

    • Data Type: Specify the data type. If you have defined List Data Types during the configuration, the defined List Data Types appears for selection in the drop-down list below the built-in data types.

      NOTE: If you delete a List Data Type from the List Data Types page that is already assigned to a Capability Parameter, the deleted data type appears with an asterisk (*) mark in the Capability Parameter view.

    • Min Value: Specify the minimum value of the parameter. This is optional and can be overridden by the consuming Equipment.

    • Max Value: Specify the maximum value of the parameter. This is optional and can be overridden by the consuming Equipment.

      NOTE: The minimum and maximum values are not applicable if you select a defined List Data Types for the Capability Parameter.

    • UOM: Select a UOM from the list, if required.

  6. Click Update. After you have clicked the Update button, you can still Edit or Delete the parameters using the respective buttons.

    NOTE: You can Import Parameters to automatically bring in the configuration for the parameters defined in a .csv file. For more information, see Importing Capabilities Parameters.

  7. When you have added all your parameters, check in your Capability by clicking the Check In button.

    If you click Undo Check Out before your changes have been checked in for the first time, your Capability is deleted, and you return to the Capabilities Summary page.

Setting up Control/Status for the Capability

On the Control/Status tab of the Capability details page, you can set up the required control/status for a Capability. Once you set up Control/Status for the Capability, the corresponding tags appear in the IO Map tab of the Equipment consuming the Capability. These Controls/Status help you to execute the Capabilities in a procedure. For example, if you do not configure the Capability with "Abort" control/status then you cannot abort the Capability during execution as it does not have tags for abort control/status in the IO Map or App object.

By default, all Capabilities get the default Control/Status IO set. If you deselect the Default Control/Status IO set, all other IOs are disabled and are unavailable for selection.

The following list of Control/Status appears in the Capability Control/Status tab:

Function

Control/Status

Default

StatusIdle, ControlStart, StatusComplete, ControlReset

Interlocked

StatusInterlocked

Running

StatusRunning

Hold

ControlHold,StatusHolding, StatusHeld, ControlRestart, StatusRestarting

Pause

ControlPause,StatusPausing,
StatusPaused, ControlResume

Stop

ControlStop, StatusStopping, StatusStopped

Abort

ControlAbort, StatusAborting, StatusAborted

NOTE: Make sure that the Capability is checked-out before you configure Control/Status options.

To set up Control/Status options

  1. Open the existing Capability. The Capability Details page appears.

  2. On the Details page, click the Control/Status tab. The list of Control/Status appears in the grid.

  3. Click the Selected check box to set up the control/status for the Capability. To select all the control/status, click Select All.

  4. Click Update.

    Overriding Done By/Check By Settings

    The Done By/Check By Settings tab displays the default done by/check by settings for Capability. You can override the default settings by selecting the Override global settings option. If you override the global Done By/Check By settings at the Capability level, then while executing the Capability, the DoneBy/CheckBy prompts are displayed at runtime based on the settings that are selected at the Capability level. The global DoneBy/CheckBy settings are not applied for this Capability.

    For example, the Global Done By/Check By settings to Abort capability are enabled for Done By, Check By, and Comment required and then if you create a Capability Cap_001 by overriding the settings for Abort cap_001 to false for Done By, Check By, and Comment. During runtime when you try to abort the capability Cap_001, the application does not ask for Done By/Check By prompts as the Done By/Check By settings to abort capability for Cap_001 is not set.

    The Done By/Check By settings tab displays all the following Capability related Done By/Check By settings:

    • Hold Capability

    • Restart Capability

    • Abort Capability

    • Stop Capability

    • Pause Capability

    • Resume Capability

    • Acknowledge Capability

      NOTE: Make sure that the Capability is checked out before you override the Done By/Check By settings.

    To override Done By/Check By setting

    1. Open the existing Capability. The Capability Details page appears.

    2. On the Details page, click the Done By/Check By Settings tab. The default Done By/Check By settings for Capability that are inherited from Global Done By/Check By Settings appear in the grid.

    3. Click the Override global settings check box to override the Done By/Check By settings for various actions of the Capability. You can override the done by, check by, or comment for various actions individually or click Select All to override all the settings at once.

    4. Click Update.

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