BAM

You can package and deploy the BAM configuration associated with workflow from one environment or repository to another environment or repository. The BAM events that can be associated with the workflow are Overdue Analysis, KPI Analysis, and KPIs.

Note: You can rebuild Overdue Analysis, KPI Analysis, and KPIs associated with the workflow but cannot rebuild the Basic Configuration associated with the workflow.

To add BAM to Package Template

1. Log on to the Enterprise Console.

2. Create a workflow and configure the workflow with BAM configuration using the BAM Configuration option. For more information, see Associate workflow with Enterprise Console events and Access BAM configuration

3. Save BAM configuration associated with the workflow and publish the workflow.

4. Right-click the workflow 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.

   You can set the configuration properties of the BAM in the Add to Package Template window. The left side of the configuration window displays the package template and its configurations. You can set the configuration properties of the workflow configured with BAM on the right side of the Add to Package Template window.

5. Configure the required settings.

6. Click Save Template to save the configured settings.

Configuration Settings for BAM associated with Workflow

The BAM has an 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

The Package Template configuration window contains the following tabs:

• Settings

  • Install

  • Update

  • Uninstall

• Associated Artifacts

• Child Artifacts

Settings Tab

You can use the properties in the Settings tab to take appropriate actions to install, update, or uninstall a package.

Install

Use this tab to set the configurations for installing the package.

• BAM Exists: Select this property to take appropriate action when the BAM in the package is already present in the target environment.

  • Overwrite existing BAM: Select this option to overwrite the BAM, present in the target environment with the packaged BAM.

    During the package installation, backup will be taken before overwriting the existing artifact.

  • Use existing BAM: Select this option to use the BAM, present in the target environment.

Update

Use the settings in this tab to update an installed package.

• Delete BAM Settings: Select this property to delete or retain the BAM settings that is present in the target environment.

  • Yes: Select this option to delete the BAM, that was installed by the package.

    If BAM Settings are modified after installation: Select this option to retain, roll back the BAM settings to original state, or delete the BAM settings from the target environment even after the package is updated. This property is applicable only if Delete BAM is set to Yes and the BAM setting is modified.

    • Retain: Select this option to retain the BAM settings along with the modifications in the target environment.

    • Rollback to original state: Select this option to roll back the artifact to the backup taken. All modifications that were done to the BAM settings after it was installed in the target environment will be reverted. However, the BAM settings will remain in the target environment.

    • Delete: Select this option to delete the BAM settings from the target environment.

  • No: Select this option to retain the BAM settings in the target environment.

    BAM exists: Select this property to take appropriate action when the BAM that is being installed is present in the target environment.

    • Overwrite existing BAM: Select this option to overwrite the BAM settings present in the target environment with the packaged BAM.

    • Use existing BAM: Select this option to use the BAM settings present in the target environment.

Uninstall

Use this tab to configure the settings when the package is being uninstalled from the target environment.

• Delete BAM Settings: Select this property to retain or delete the BAM settings from the target environment even after the package is uninstalled.

  • Yes: Select this option to delete the BAM settings from the target environment when the package is uninstalled.

  • No: Select this option to retain the BAM settings in the target environment even after the package is uninstalled.

• If BAM Settings are modified after installation: Select this option to retain, roll back the BAM settings to original state, or delete the BAM settings from the target environment even after the package is uninstalled. This property is displayed only if Delete BAM Settings is set to Yes. However, if Delete BAM is set to No, this property is not displayed.

  • Retain: Select this option to retain the BAM settings along with the modifications in the target environment.

  • Rollback to original state: Select this option to roll back to the artifact to the backup taken. All modifications that were done to the BAM settings after it was installed in the target environment will be reverted. However, the BAM settings will remain in the target environment.

  • Delete: Select this option to delete the BAM settings from the target environment.

Associated Artifacts Tab

BAM can include the following associated artifacts:

• Parent Folder

• Parent Workflow

Child Artifacts for Tab

BAM can include the following child artifacts:

• Child Workflow

• Folder

Include Child Item

For more information, see Include Child Item.

Security Artifacts for BAM

You can enable the security settings of the BAM that you want to include in the package. For more information about including security artifacts, see Include Security Artifacts.