Toolbox

A toolbox is an installable archive, with a .tbox extension. A toolbox will contains necessary artifacts that models a complete use case. A toolbox can contain the below artifacts

  1. Stream definitions
  2. Analytics
  3. Dashboard components

All three artifacts are not mandated, and they are optional. You can have all of three artifacts or either of them in one toolbox. And only those artifcats will be deployed.

Stream Definitions, are the definitions of the streams of data which you are going to send to WSO2 BAM and perform the analytics.You can place any number of stream definitions under one toolbox and all of then will be deployed with that toolbox. But Each stream definitions need to be in the separate file. You can find More details on how to create the stream definition artifact on Creating a custom toolbox.

Analytics, includes the hive scripts which you are going to deploy in WSO2 BAM. Similar to the stream definitions artifact you can place any number of analytic scripts and ll of the will be deployed. You can provide the cron expression if you want to schedule the analytic script for each script in a seperate properties file. You can find More details on how to create the analytic scripts on Creating a custom toolbox.

Dashboard components, contains the gadget xmls, jaggery files, etc. You can specify the number of tabs, title of tabs, gadgets that should be shown in a tab, etc in a properties file, and the dashboard will be organised as specified. You can find More details on how to create the dashboard components on Creating a custom toolbox.

For example, to monitor service statistics of service hosting WSO2 servers the stream definitions, analyzers and dashboard components needed will be available in the "Service Stats" toolbox. So, by installing the "Service Stats" toolbox, all artifacts will be deployed to the necessary locations in the server. Then, when data from a "Service Stats Data Agent" reaches BAM, after a few minutes you will see the Service Stats dashboard populated with service statistics.

  1. Installing a Toolbox

    2. There are toolbox which are shipped by default with WSO2 BAM pack, and you can created your own toolboxes for your requirement also.

    1. Installing Default Toolbox
      1. Start WSO2 BAM server
      2. Go to management console and login
      3. Go to Main -> BAM ToolBox -> Add
      4. Select an option which are listed under 'Basic Toolbox'. Eg: Phone Retail Store Toolbox, HTTPD Logs Analysis Toolbox

      5. Click on Install Button

        6. This will redirect to 'List' page of BAM toolboxes. There you can notice that the selected toolbox will be in the status of 'installing'.



        Wait for approximately 1mintue and refresh the page, then you can notice the status of the toolbox status has changed to 'Installed' state.




    2. Installing Custom Toolbox

      3. You can install the toolboxes which is not listed in under the Basic Toolbox list by providing the system file path or URL path pointing to your toolbox

      1. Start WSO2 BAM server
      2. Go to management console and login
      3. Go to Main -> BAM ToolBox -> Add
      4. Select 'Toolbox From File System' if you have the toolbox in your system


        5. OR Select 'ToolBox From URL ' if you have the toolbox in hosted in a location.



      5. And provide the necessary toolbox file path OR URL path depending on your selection in step-4.
      6. Click on Install Button.

        7. This will redirect to 'List' page of BAM toolboxes. There you can notice that the selected toolbox will be in the status of 'installing'.


        Wait for approximately 1mintue and refresh the page, then you can notice the status of the toolbox status has changed to 'Installed' state.




  2. Uninstalling Toolbox

    3. You can uninstall the toolbox which have been installed in WSO2 BAM instance. Uninstalling toolbox involves removing your deployed artifacts from your system. Ie, If you have installed some analytic hive script via toolbox, the have script will be removed from the when unistalling the toolbox.

    1. Start WSO2 BAM server
    2. Go to management console and login
    3. Go to Main -> BAM Toolbox - > List
    4. Select the toolboxes which you are going to uninstall by selecting the relevant check boxes of toolbox
    5. Click on 'Uninstall' icon


    6. Click 'yes' on the confirmation dialog box which asks for uninstalling the toolbox

      7. There you can notice that the selected toolbox(s) will be in the status of 'uninstalling'.


      Wait for approximately 1mintue and refresh the page, then you can notice the toolbox(s) have been removed from list of toolboxes.