Event Type Properties
- Last UpdatedJan 11, 2019
- 4 minute read
The following event types are exposed by the AVEVA Recipe Management Server. For each event type, specific properties are available in addition to the Event system properties. These properties must be accessed using the GetProperty() method on the client-side Event object.
Configuration Event Types
-
Equipment.SetState
-
Formula.SetState
-
Recipe.SetState
"Equipment.SetState" Event Type Properties
This event is triggered when Equipment state changes during the configuration.
|
Name |
Data Type |
Description |
|---|---|---|
|
EquipmentName |
String |
Equipment name for the event |
|
EquipmentVersion |
Integer |
Equipment version for the event |
|
State |
String |
State (Draft, Approved, Obsolete) of the event. |
"Formula.SetState" Event Type Properties
This event is triggered when a Formula state changes during the configuration.
|
Name |
Data Type |
Description |
|---|---|---|
|
FormulaName |
String |
Formula name for the event |
|
FormulaVersion |
Integer |
Formula version for the event |
|
State |
String |
State (Draft, Approved, Obsolete) of the event. |
"Recipe.SetState" Event Type Properties
This event is triggered when a Recipe state changes during the configuration.
|
Name |
Data Type |
Description |
|---|---|---|
|
RecipeName |
String |
Recipe name for the event |
|
RecipeVersion |
Integer |
Recipe version for the event |
|
State |
String |
State (Draft, Approved, Obsolete) of the event. |
Runtime Events
The following Runtime Events can be sent from the AVEVA Recipe Management Server which in turn are triggered when an event state changes.
-
Equipment.AssignFormula
-
Equipment.AssignRecipe
-
Equipment.DownloadFormula
-
Equipment.StatusChange
-
Capability.StatusChange
-
Transition.StatusChange
-
Equipment (.RecipeStart, .RecipeHold, .RecipeRestart, .RecipePause, .RecipeResume, .RecipeStop, .RecipeAbort
-
Capability (.Start, .Hold, .Restart, .Pause, .Resume, .Stop, .Abort)
-
Transition.Force
-
"OperatorAction (.New, .Completed)"
-
Material
"Equipment.AssignFormula" Event Type Properties
This event is triggered when Equipment is assigned a formula at runtime.
|
Name |
Data Type |
Description |
|---|---|---|
|
EquipmentName |
String |
Equipment name for the event |
|
EquipmentVersion |
Integer |
Equipment version for the event |
|
FormulaName |
String |
Formula name for the event |
|
FormulaVersion |
Integer |
Formula version for the event |
|
BatchSize |
String |
Batch size for the event |
|
UnitOfMeasureName |
String |
Unit of measure for the event |
|
<ExtName> |
String |
Parameter extension name for the event. |
"Equipment.AssignRecipe" Event Type Properties
This event is triggered when Equipment is assigned a recipe at runtime.
|
Name |
Data Type |
Description |
|---|---|---|
|
EquipmentName |
String |
Equipment name for the event |
|
EquipmentVersion |
Integer |
Equipment version for the event |
|
RecipeName |
String |
Recipe name for the event |
|
RecipeVersion |
Integer |
Recipe version for the event |
|
BatchSize |
String |
Batch size for the event |
|
UnitOfMeasureName |
String |
Unit of measure for the event |
|
<ExtName> |
String |
Parameter extension name for the event. |
"Equipment.DownloadFormula" Event Type Properties
This event is triggered when Equipment downloads a formula at runtime.
|
Name |
Data Type |
Description |
|---|---|---|
|
EquipmentName |
String |
Equipment name for the event |
|
FormulaName |
String |
Formula name for the event |
"Equipment.StatusChange" Event Type Properties
This event is triggered when Equipment status changes at runtime.
|
Name |
Data Type |
Description |
|---|---|---|
|
EquipmentName |
String |
Equipment name for the event |
|
RecipeName |
String |
Recipe name for the event |
|
FormulaName |
String |
Formula name for the event |
|
Status |
String |
Status of the event. For more information, refer to the Event Property Value Lookup topic. |
"Capability.StatusChange" Event Type Properties
This event is triggered when a Capability status changes at runtime.
|
Name |
Data Type |
Description |
|---|---|---|
|
EquipmentName |
String |
Equipment name for the event |
|
CapabilityName |
String |
Capability name for the event |
|
CapabilityAlias |
String |
Capability label for the event. |
|
ExecutionInstance |
String |
Execution instance of an event. The nth time a Capability is executing in a loop (transition). The count starts with zero (0). |
|
Status |
String |
Status of the event. For more information, refer to the Event Property Value Lookup topic. |
"Transition.StatusChange" Event Type Properties
This event is triggered when a Transition status changes at runtime.
|
Name |
Data Type |
Description |
|---|---|---|
|
EquipmentName |
String |
Equipment name for the event |
|
TransitionName |
String |
Transition name for the event |
|
TransitionExpression |
String |
Transition expression for the event. |
|
Status |
String |
Status of the event. For more information, refer to the Event Property Value Lookup topic. |
|
ExecutionInstance |
String |
Execution instance of an event. The nth time a Capability is executing in a loop (transition). The count starts with zero (0). |
"Equipment Recipe Requests Event Type Properties
This event is triggered anytime a script/user commands a Recipe to (Start, Hold, Restart, Pause, Resume, Stop, Abort).
|
Name |
Data Type |
Description |
|---|---|---|
|
EquipmentName |
String |
Equipment name for the event |
|
RecipeName |
String |
Recipe name for the event |
"Capability Requests Event Type Properties
This event is triggered anytime a script/user commands a Capability to (Start, Hold, Restart, Pause, Resume, Stop, Abort).
|
Name |
Data Type |
Description |
|---|---|---|
|
EquipmentName |
String |
Equipment name for the event |
|
CapabilityName |
String |
Capability name for the event |
|
CapabilityAlias |
String |
Capability label for the event. |
|
ExecutionInstance |
String |
Execution instance of an event. The nth time a Capability is executing in a loop (transition). The count starts with zero (0). |
"Transition.Force" Event Type Properties
This event is triggered when a Transition is forced to changes.
|
Name |
Data Type |
Description |
|---|---|---|
|
EquipmentName |
String |
Equipment name for the event |
|
TransitionName |
String |
Transition name for the event |
|
TransitionExpression |
String |
Transition expression for the event. |
|
ExecutionInstance |
String |
Execution instance of an event. The nth time a Capability is executing in a loop (transition). Count starts with zero (0). |
"OperatorAction (.New, .Completed)" Event Type Properties
This event is triggered when an operation state changes.
|
Name |
Data Type |
Description |
|---|---|---|
|
EquipmentID |
String |
Equipment ID for the event |
|
EquipmentName |
String |
Equipment name for the event |
|
RecipeName |
String |
Recipe name for the event |
|
ProcedureTokenId |
String |
ProcedureTokenId for the event. |
|
CapabilityAlias |
String |
Capability label for the event |
|
OperatorActionType |
String |
Operator Action type for the event. For example, AckOnExit or EditRequired. |
"Material" Event Type Properties
This event is triggered at the end of a phase for every Material Input/Output parameter.
|
Name |
Data Type |
Description |
|---|---|---|
|
EquipmentName |
String |
Equipment name for the event |
|
CapabilityName |
String |
Capability name for the event |
|
CapabilityAlias |
String |
Capability label for the event. |
|
MaterialType |
String |
Material type (Input or Output) for the event. |
|
GroupName |
String |
Group name for the event. |
|
EquipmentParameter Name |
String |
Equipment Parameter Name for the event. |
|
FormulaParameterName |
String |
Formula Parameter Name for the event. |
|
TargetValue |
String |
Target value for the event. |
|
ActualValue |
String |
Actual value for the event. |
|
<RecipeDetails> |
String |
Addition Recipe details for the event. |
|
<ExtName> |
String |
Parameter extension name for the event. |