Basic Concepts

AVEVA Recipe Management includes the following basic concepts:

• Capability: A Capability represents, in accordance with the design for the Equipment, a Phase, Operation, or Unit Operation, within one or many pieces of Equipment. A Capability, though versioned, does not require formal approval before it can be used. Capabilities are available within the AVEVA Recipe Management Professional Edition only.

• Capability Parameter: A Capability Parameter defines the physical constraints for parameter values that belong to a specific Capability. Each of the parameters for a Capability are instantiated for a piece of Equipment when the Capability is assigned to that specific Equipment.

• Equipment: A piece of Equipment represents any machinery at your plant or any application that needs a set of parameters to run. You can assign Capabilities to Equipment. Capabilities must exist before assigning them to Equipment.

• Equipment Parameter: An Equipment Parameter represents a parameter that belongs to a specific piece of Equipment. The Equipment Parameters are necessary for Formula Download scenarios, and wherever you need to indicate Equipment - specific parameters. Values are written by AVEVA Recipe Management when the user selects "Download Formula."

• Equipment Variables: An Equipment Variable represents a parameter that belongs to a specific piece of Equipment. Values are read by AVEVA Recipe Management and are used for logical expressions within Transitions. Equipment Variables are available within the AVEVA Recipe Management Professional Edition only.

AVEVA Recipe Management also includes the following Templates:

• Formula Templates: A Formula Template contains, at least, the parameters (including a default value for each parameter) used for a piece of Equipment. A Formula Template is not used in production – though versioned; a Formula Template does not require formal approval before it can be used.

• Recipe Templates: A Recipe Template defines a procedure to be executed, and allows mapping the content of a specific Formula Template to any of the Capabilities used within the procedure. That way, a Recipe Template represents the base from which variations for specific products produced using the template's procedure can be created using different sets of parameter values. Recipe Templates are available within the AVEVA Recipe Management Professional Edition only.

Besides these concepts, AVEVA Recipe Management also provides the following other important elements:

• Formulas: Formulas are derived from Formula Templates and allow you to override any default values provided by the Formula Template. After you create a Formula, you must Approve it before you can use the Formula in production.

• Recipes: Recipes are the mapping of a Formula to a procedure. Mapping is done by matching a Formula to a Recipe Template (representing the procedure with the base Formula Template mapping).

• Security: Security in AVEVA Recipe Management is managed through a built-in security service login mechanism, which allows using SSL and digital certificates to make your system robust and secure against cyber-attacks. AVEVA Recipe Management provides four pre-configured roles that can be expanded if required. Each role features a set of typical authorizations to perform tasks for that role.

Check In/Check Out

In AVEVA Recipe Management, you must check out an item before you make changes to it. Changes are stored locally but not committed to the system's database until you check in the item again. To omit any change you made, click Undo Check Out. Changes are stored even if you navigate to other areas of the product, or close the browser. A checked-in item is available for you to set its state and then use it in production, such as Formula Templates or Recipe Templates do not require formal approval as opposed to Formulas and Recipes. You can perform check out and check in of items either individually or in "bulk" (selecting multiple items) using the Multi-Select feature. For more information, see Multi Select Feature.

NOTE: AVEVA Recipe Management updates the LastCheckInTime value in UTC date time format for that item when you perform a check-in.

If an item has already been checked out by another user, you can see its current state, including all changes that were made by the other user, but you cannot have full access to the item unless you are granted permission to override an existing checkout. Permissions are defined on the Roles page. For more information about Roles, refer to Working with Roles.

If you have the Override Checkout permission for an item and another user has checked out that item, the Override Checkout button is shown on the details page of the instance. When you click the Override Checkout button, you take over control of the checked out item and other user's changes are discarded. You can then make changes to the item and check it in.

In the case of the checked list items such as the Equipment Capability tab, Users/Groups Roles tab, Users/Groups Equipment tab, Users/Groups Parameter Groups tab, Formula Equipment tab, and Roles Permissions, make sure to update the changes before performing a check-in. Otherwise, a warning message would appear and prompt you to save the changes.

Duplicating Entities

Duplicating entities can create a copy of an existing AVEVA Recipe Management entity. You must check-in the existing entity before making a duplicate of it. Duplicating entities copies all the entity properties to the newly created entity which starts a version number 1, and the recently created entity name is by default based on the existing entity. For example, an existing entity with a name Mixer will create a duplicate Mixer_001.

AVEVA Recipe Management allows you to duplicate the following entities:

• Equipment

• Capability

• Formula

• Formula Template

• Recipe Template

Keywords

Keywords are a collection of predefined phrases that you can use to identify and categorize various items within AVEVA Recipe Management. You can also use keywords to filter the saved entities.

In Keywords, you can have

• any combination of letters, numbers, and special characters except comma (,).

• maximum length of 31 characters, and are case insensitive.

If you have the permission, you can assign Keywords for an individual entity or to multiple entities ("Bulk") using the Multi Select function. For more information see Multi Select Feature.

Versioning

Capabilities, Equipment, Formula Templates, Recipe Templates, Formulas, and Recipes are versioned entities. The version number of an entity is incremented by one only after a checked-out entity was changed and checked-in again. An entity that was checked-in with no changes to the checked-out version will keep its version number and state the same as if you had clicked Undo Check Out. For example, if you have an existing piece of Equipment that has a version number of 2. You check it out, make changes to it, and then check it back in; the Equipment will show a version number of 3.

Every version is stored in the system. That way you can have a current version used in production while you work on the new draft version without impacting production.

Upgrading

An upgrade notification appears for an item if a change is made to an item on which it depends. For example, if you make changes to a capability, related items such as Equipment, Recipe Templates, and Recipes that are using the Capability need to be updated.

Upgrades can be done by individual item or in "bulk" (selecting multiple items) using the Multi Select function. For more information see Multi Select Feature. When you use Multi Select for upgrading, the items are automatically checked out to you, and then upgraded.

Upgrades are solely dependent on the discretion of users, and you can control the upgrades depending on your requirements. Upgrades do not impact production because the production version is the current version, and the new upgrade version is a draft. You can also continue to make changes to the old item and not upgrade to the new version immediately.

Version Difference Report

You can view the version differences report by clicking the Version Differences button. The Version Difference Report allows you to differentiate two versions of an entity. The Version Difference Report is an HTML report that describes the differences between the two versions of an entity where the current version is considered the new version and the original version is the previous version. After the report has been saved, you can open it from the supported browsers.

The report is initially generated with all of the details collapsed. Only the entity and version numbers of the two entities are shown. You can expand all the sections or only the ones you want to see. To expand or collapse all sections use the down (expand) and up (collapse) arrows at the top of the screen.

To expand a certain section, click the down arrow beside the name of the section. After you expand the section, an up arrow is shown beside the section name.

The report is divided into three columns: Element (lists the headers, the element names and the keys of the objects which have been modified), Original Value, and New Value.

Upgrade Difference Report

You can view the upgrade differences report by clicking the Upgrade Differences button. The Upgrade Difference Report allows you to view the difference report for all the parent entities that are causing these entities to be flagged as upgradeable. The Upgrade Difference Report is an HTML report and allows you to save it. You can open a saved report from the supported browsers.

NOTE: There is no Upgrade Difference Report for Capability.

Audit Trail Report

You can view Audit Trail of,

• all actions performed on an individual entity by selecting the Audit Trail tab on the details page of the entity.

• all actions taken on different entities by clicking Reports from the Main menu, and then clicking Audit Trail.

  NOTE: The most recent actions are listed at the top and only 200 actions can be viewed in the Audit Trail Reports page.

States

There are three possible states for an item:

• Draft - state of an item before it is ready to be used in Execution mode, or any time the item is checked out. You must approve a checked-in item in the Draft mode before it can be used in the Execution mode.

• Current/Approved- state of an item that is ready for use in the Execution mode.

  NOTE: In the case of Equipment, Recipe, and Formula, the state of checked-in assigned items that are available for execution is called Approved. For Capability, Formula Templates, and Recipe Templates, the checked-in items are in Current state and are available for execution.

• Obsolete - assigned state of items that are not available for execution and by default are hidden in the editors.

You can only change the state of an item that is checked in. After you change the state of an item to Current/Approved or Obsolete, you cannot change it back to Draft; you can only change the state from Current/Approved to Obsolete or vice versa. However, if you check out an item with a state of Current/Approved or Obsolete, the new version is set to Draft. The older current version still exists when you check in a newer draft version. However, the older current version is not available when you approve a newer version.

NOTE: AVEVA Recipe Management updates the LastSetStateTime value in UTC date time format for that item when you update the state of an entity.

The following table summarizes the state relationships:

Setting the state can be done by individual item or in "bulk" (selecting multiple items) using the Multi Select function.

You cannot delete an item because items are versioned within the system. However, you can change the item's state to obsolete if it is no longer used.