A toolbox in BAM is an installable archive, with a .tbox extension. It contains all or some of the following artifacts that model a complete usecase. When you install a toolbox, all artifacts inside it get deployed.
For example, sample stream definitions, analyzers and dashboard components required to monitor the service statistics of service-hosting WSO2 products are available in the
Service Stats toolbox. Therefore, installing the
Service Stats toolbox simply installs all artifacts to the necessary locations in the server. When data from a service stats data agent reaches BAM, you will see the Service Stats dashboard populated with statistics. For more information on setting up service statistics to BAM from other service-hosting products, see Data Agents.
The WSO2 BAM Toolbox functionality is provided by the following feature in the WSO2 feature repository:
Name : WSO2 Carbon - BAM Tool Box Deployer
Identifier : org.wso2.carbon.bam.toolbox.deployer.feature.group
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.
Following steps show how to install a toolbox using the management console. Alternatively, in order to remotely deploy a BAM toolbox, you can use the following alternative methods:
- Copy (
<BAM_HOME>/repository/deployment/server/bam-toolbox/ directory, to install it via BAM hot deployment.
- Create the
bam-toolboxdirectory if it doesn't exist by default.
- Use the
Currently, it is not possible to deploy a BAM toolbox using a CAR file, and this feature would be released in a future BAM version.
- Log in to BAM management console and select BAM ToolBox -> Add in the Main menu.
- To install one of the default toolboxes, select from the Basic Toolbox list and Install. E.g., Phone Retail Store Toolbox.
- 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,
- Click Install. Toolbox installs and the Available BAM Tool Boxes page opens. If the toolbox status is still
Installing, wait approximately a minute and refresh the page to see the status changed to
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.
Note: The steps below show how to uninstall a toolbox using the management console. Alternatively, you can delete the relevant .tbox file from
- Log on to BAM management console and select BAM ToolBox -> List in the Main menu.
- Select the toolbox and click Uninstall. Wait about a minute and refresh the page to see the toolbox(s) removed.