A toolbox in BAM is an installable archive, with a .tbox extension. It contains necessary artifacts that models a complete usecase. The artifacts are as follows:
- Stream definitions
- Analytics
- Dashboard components
These artifacts are optional and only the ones available in the toolbox will be deployed. The artifacts are as follows:
- Stream definitions
- Analytics
- Dashboard components
Stream definitions are descriptions of streams of data to be sent to WSO2 BAM in order to perform analytics. You can place any number of stream definitions under one toolbox and all of them will be deployed. But, each stream definition needs to be in a separate file. For more details on how to create the stream definition artifacts, refer to section, Creating a Custom Toolbox Stream Definition Artifacts described when creating a custom toolbox.
Analytics include the hive scripts to be deployed in WSO2 BAM. Similar to the 'stream definitions' artifact, any number of analytic scripts can be deployed under one toolbox. You can provide the cron expression to schedule the analytic script for each script in a separate properties file. Find more information on how to create the analytic scripts and cron expressions, refer to section, Creating a Custom Toolbox Analytics Artifacts described when creating a custom toolbox.
Dashboard components contain 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 according to which the dashboard will be organized. Find more information on how to create the dashboard components in section, Creating a Custom Toolbox Dashboard Components described when creating a custom toolbox.
For example, to monitor the service statistics of service-hosting WSO2 products, the required stream definitions, analyzers and dashboard components are available in the "Service Stats" toolbox. Therefore, by installing the "Service Stats" toolbox, all artifacts can be deployed to the necessary locations in the server. Afterwords, when data from a "Service Stats Data Agent" reaches BAM, you will see the Service Stats dashboard populated with service statistics. For more information on setting up service statistics to BAM from other service-hosting products, refer to section Data Agents.
...