Event Association of Type BAM
- Last UpdatedJul 01, 2024
- 4 minute read
You can package and deploy the Event Associations of type BAM along with its associated artifacts from one environment or repository to another environment or repository using the Package feature in AVEVA Work Tasks.
To add Event Association of Type BAM to Package Template
-
Log on to the Enterprise Console.
-
On the Enterprise Console menu, click Workflows. The Workflows window appears.
-
Select a Workflow with an event association of type BAM associated to it.
-
Right-click the workflow, and then select View Association. All associations of the selected workflow appear.
-
Right-click Event Associations of type BAM that you want to package, and then click Add to Package Template.
The Add to Package Template window appears.
For more information about adding artifacts to Package Template, see Adding Artifacts to a Package Template.
In the Package Template tree view, the BAM Event Association will appear in the following format:
<Workflow Name_Associated Event Name_Associated Event Type>
Here,
-
Workflow Name: Name of the workflow to which BAM is associated
-
Associated Event Name: Name of the BAM event associated
-
Associated Event Type: Name of the BAM event type i.e. Overdue Analysis or KPI
Configuration Settings for Event Association of Type BAM
The Event Associations of type BAM has a unique set of configuration settings required to install, update, and uninstall the package.
You can view and edit the configuration settings from one of the following windows:
-
Source Environment > Package Template window
-
Target Environment > Manage Package window
You can use the Settings tab to define the configuration settings. The Associated Artifacts tab displays the associated artifacts of the Event Association of type BAM definition. The Child Artifacts tab displays child artifacts of the Event Association of type BAM definition.
The Package Template configuration window contains the following tabs:
-
Settings
-
Install
-
Update
-
Uninstall
-
-
Associated Artifacts
-
Security Artifacts
Settings Tab
The properties in this tab allow you to take appropriate actions while installing, updating, or uninstalling the Package.
Behavior of BAM Event Association while installing, updating, or uninstalling the package:
-
You cannot overwrite an already existing item.
-
You can delete or uninstall a BAM Event Association only if it was installed by the Package.
Install
The settings in this tab are referred to when installing the Package. When installing the package, if the Event BAM dates are invalid, then the package will not be installed. Edit the dates and install the package.
-
The following event association details are displayed:
-
Type: The type of event. In this scenario, type is Overdue Analysis or KPI.
-
Associated Workflow: The workflow associated to the BAM event type.
-
Workflow: The workflow associated to the event.
-
-
BAM Event Association Settings: This displays the settings of the Event Association of type BAM in the Source environment and it also allows you to specify the settings of the Event Association of type BAM in the Target environment.
-
Source
-
Effective From: Displays the date from when the Event should be triggered in the source environment.
-
Effective To: Displays the date till when the Event should be triggered in the source environment.
-
-
Target
-
Effective From: Select the date from when the Event should be triggered in the target environment.
If you are not using the date picker ensure that the date is in the MM\dd\yyyy format.
-
Effective To: Select the date till when the Event should be triggered in the target environment.
If you are not using the date picker ensure that the date is in the MM\dd\yyyy format.
Note:
Ensure that you follow the following guidelines while packaging the BAM Event Association in the target environment:
- Effective From and Effective To should be in a valid format.
- Effective From should be less than or equal to Effective To respectively.
- Effective To should be greater than or equal to current date.
- Effective From and Effective To can be 'Null'. However, you cannot have either one of them as 'Null'.
- If you want to leave the dates as blank, then you have to enter 'Null' in the Effective From and Effective To fields in the Target section.
-
-
Update
The settings in this tab are referred to when the same Package is installed for the consecutive time.
-
Delete Event Association: Select this option to delete the Event Association that is present in the target environment.
-
Yes: Select this option to remove the Event Association in the target environment.
-
No: Select this option to retain the Event Association in the target environment or install the Event Association if it is not present in the target environment. By default, No is selected.
-
Uninstall
The settings in this tab are referred to when the Package is being uninstalled in the target environment.
-
Delete Event Association: This property allows you to retain or delete the Event Association of the type BAM in the target environment even after the Package is uninstalled.
-
Yes: Select this option to delete the Event Association from the target environment when the Package is uninstalled. By default, Yes is selected.
-
No: Select this option to retain the Event Association in the target environment even after the Package is uninstalled.
-
Click Save Event Association Settings.
Note: You cannot uninstall individual versions, when uninstalling a package. All the version will be uninstalled and a message is logged for every single version that is uninstalled.
Associated Artifacts
The Associated Artifacts tab displays all the associated artifacts of the selected Event Association of type BAM definition.
BAM Event Association has the following associated artifacts:
-
Workflow
-
BAM
Child Artifacts
Event Association of type BAM does not have any child artifact.
Security Artifacts
The Security Artifacts tab displays the security artifacts of an Event Association of type BAM, if any.
You can enable the security settings of the grid view that you want to include in
the package.
For more information about including security artifacts, see Include Security Artifacts.