Comparison Report Content
- Last UpdatedOct 29, 2024
- 2 minute read
The comparison report includes changes for the following recipe components:
-
Recipe Headers
-
Version History
-
Equipment Requirements
-
Formula
-
Inputs
-
Outputs
-
Process Variables
-
-
Procedures
-
Phases
-
Transitions
-
Under each section, the components’ related elements will be described if they have been added, modified, or deleted. These sections and their related elements correspond to the similar objects in the Recipe Editor. Each component is described below.
Recipe Header
Changes to the recipe header are described in this section. This section corresponds to the Recipe Header in the Recipe Editor.
Version History
Changes for version history are described in this section. This section corresponds to the Save Dialog in the Recipe Editor. One of the elements is the Date/Time modified. Its actual value is set in the AVEVA Batch Management Server’s time zone. Its formatted value in the HTML report uses the regional settings of the machine generating the report.
Equipment Requirements
The Equipment Requirements section contains changes to Process Classes, Process Instances, Transfer Class, and Transfer Instances. This section corresponds to the Equipment Requirements menu of the Recipe Editor. Information will be grouped by Addition, Modification, and Deletion. For example:
-
ProcessClasses Added
-
ProcessClass/ProcessInstance Added
-
TransferClass Added
-
TransferClass/TransferInstance Added
where ProcessClasses, ProcessClass/ProcessInstance, TransferClass and TransferClass/TransferInstance are the key combinations to identify the Process Class, Process Instance, Transfer Class and Transfer Instance objects. For example, under ProcessClass/ProcessInstance Added, Mixer/Mixer2 indicates that Process Instance Mixer2 of Process Class Mixer is added.
For every process instance, it could contain a list of attributes. The report section for the process instance includes the changes for the attributes.
Formula
Formula is divided into three sections: Inputs, Outputs, and Process Variables. These sections correspond to the Formula Inputs, Formula Outputs, and Process Variables menu of the Recipe Editor. For each section, the changes are grouped by Addition, Modification, and Deletion. For example:
-
Inputs Added
-
Inputs Modified
-
Inputs Deleted
For Inputs and Outputs, the key is Material ID, while the key combination for Process Variables is UnitProcedure/Operation/ProcessClass/Phase/Parameter/Label.
Procedures
Procedures is divided into two sections: Phases and Transitions. These sections correspond to the Phase and Transition objects of the Recipe Editor. For each section, the changes are grouped by Addition, Modification, and Deletion.
Note: The comparison report does not describe the changes to the structure of the recipe such as changes to Unit Procedures, Operations, Branches, and Loops.
For Phases, the key combination is UnitProcedure/Operation/ProcessClass/Phase/Label. For every phase, it could contain a list of parameters. The report section for the phase includes the changes for the parameters.
For Transition, different key combinations are used based on the parent of the transitions in the Recipe Editor:
-
For those transitions inside the UnitProcedure pane, the key combination is <blank>/<blank>/ Label (e.g. //5)
-
For those transitions inside the Operation pane, the key combination is UnitProcedure/<blank>/Label
-
For those transitions inside the Phase pane, the key combination is UnitProcedure/Operation/Label