Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The above feature is bundled by default in WSO2 BAM. You can remove it using the instructions in  Feature Management.  

...

Installing

...

a default or a custom toolbox

WSO2 BAM comes with a set of default toolboxes. In addition, you can also create your own toolboxes with specific requirements and install them through the management console. For information on creating your own custom toolbox, see Creating a Custom Toolbox.

Follow the steps below to install.

Info

Note: The Following steps below show how to install /uninstall a toolbox using the management console. Alternatively, you can copy the .tbox file to <BAM_HOME>/repository/deployment/server/bam-toolbox folder to install it via BAM hot deployment. Create the bam-toolbox directory if it doesn't exist by default.

Similarly, deleting the .tbox file uninstalls the toolbox.

Installing a Toolbox

...

by

...

default

...

.

...

In addition to the basic toolboxes that come with BAM by default, you can install your custom toolboxesby providing the system file path or URL as described below. For information on creating your own custom toolbox, see Creating a Custom Toolbox.

  1. Log on to BAM management console and select BAM ToolBox -> Add in the Main menu.
  2. Select a toolbox To install one of the default toolboxes, select from the Basic Toolbox list and Install. E.g., Phone Retail Store Toolbox.
  3. Toolbox installs and the Available BAM Tool Boxes page opens. If the toolbox status is still Installing, wait a few seconds and refresh the page to see the status changed to Installed.

...

  1. Log on to the product's management console and select BAM ToolBox -> Add as in the previous section.To install a custom toolbox, you can do either of the following:

    Select the option Toolbox From File System if the toolbox is in your system. For example,
    OR, select the ToolBox From URL if the toolbox is hosted in a location separate from your system, like an SVN. For example,
  2. Click Install. Toolbox installs and the Available BAM Tool Boxes page opens. If the toolbox status is still Installing, wait a few seconds approximately a minute and refresh the page to see the toolbox status changed to Installed.

Uninstalling a

...

toolbox
Anchor
Uninstalling a toolbox
Uninstalling a toolbox

Uninstalling a toolbox removes deployed artifacts associated with it from the system. For example, if you have installed some analytic hive script via toolbox, it will be removed when unistalling the toolbox.

Info

Note: The steps below show how to uninstall a toolbox using the management console. Alternatively, you can delete the relevant .tbox file from <BAM_HOME>/repository/deployment/server/bam-toolbox folder.

  1. Log on to BAM management console and select BAM ToolBox -> List in the Main menu.
  2. Select the toolbox and click Uninstall. Wait about a minute and refresh the page to see the toolbox(s) removed.