...
As shown in the structure of the toolbox, the stream definitions should be placed under streamDefn folder. The stream definitions are the definitions of your data stream which is published to BAM. You can have any number of stream definitions within one toolbox, but each of those are needed to defined under they should be defined in different files.
For example, if you are publishing your data is published with the stream definition shown below stream definition,
{...
, it should be copied to a file and placed under the streamDefn folder. (The file name is not important but the content of the files is).
| Code Block |
|---|
{ 'name':'org.wso2.bam.mystream', |
...
'version':'1.0.0', |
...
'nickName': 'My_Stream', |
...
'description': 'This is the stream definition which I'm using to send data to bam', |
...
'metaData':[ |
...
{'name':'clientType','type':'STRING'} |
...
],...
], 'payloadData':[ |
...
{'name':'my_field_1','type':'STRING'}, |
...
{'name':'my_field_2','type':'INT'}, |
...
{'name':'my_field_3','type':'INT'}, |
...
{'name':'my_field_4','type':'STRING'} |
...
]
}
Then, this stream definition needed to be copied into a file, and placed under the streamDefn folder. (Here the file name is not important, it'll be ignored, only the content of the files are important).
]
} |
Dashboard Artifacts
As shown in the toolbox structure, the dashboard artfacts should be placed under the dashboard directory. Dashboard artifcats can be for Gadget Dashboard Dashboard or Jasper Dashboard or both artifacts. You need to have the respective artifacts for the dashboard in which you are going to visualise your data is visualized. The below following section will describe describes how to include the those artifctas in the toolbox.
...
Gadget Dashboard related artifacts are given below.
As shown in above the , all gadget xmls which you are going to include to be included in the dashboard should be placed under the 'gadgets' folder. And also the if you have any css and js files, that also need to placed under the gadget directory.
If you are using any jaggery files in your gaget xmls, then you have to place the jasggery files in the jaggery folder within dashboard folder. All these jaggery files will be deployed in the WSO2 BAM server.
Finally the dashboard tabs, , including any .css/.js files, if any. If jaggery files are used in the gadget xmls, they should be placed in the 'jaggery' folder in the 'dashboard' folder. Finally, the dashboard tabs and gadgets for the tabs should be mentioned in the 'dashboard.properties' file. Accroding According to what you have is mentioned in the dashboard.propertied file, the gadgets and tabs will be organised organized in the gadget dashboard.
Assume For example, assume you have a gadget xmls as My_Gadget_1.xml, My_Gadget_2.xml, My_Gadget_3.xml, My_Gadget_4.xml under the gadgets folder. And you You are want to add My_Gadget_1.xml, My_Gadget_2.xml in to the first tab, and My_Gadget_3.xml, My_Gadget_4.xml to the second tab. Then the dashboard.properties should be as follows.
| Code Block |
|---|
dashboard.tabs=tab1, tab2 |
...
dashboard.tabs.tab1.name=Tab-1 Title |
...
dashboard.tabs.tab1.gadgets=My_Gadget_1.xml, My_Gadget_2.xml |
...
dashboard.tabs.tab2.name=Tab-2 Title |
...
dashboard.tabs.tab2.gadgets=My_Gadget_3.xml, My_Gadget_4.xml |
Here similar Similar to anayzers.properties file the , tab1, tab2 are reference in the properties. And 'dashboard.tabs.tab1.name' denotes the title of the tab denoted by the reference tab1. And tab1, will have the gadgets My_Gadget_1.xml, My_Gadget_2.xml in the indicated that order. Similarly. for the tab2, the title is 'Tab-2 Title' and the gadgets will be My_Gadget_3.xml, My_Gadget_4.xml in the mentioned that order.
Jasper Dashboard Artifacts
Jasper Dashboard related artifacts are given below.
As shown above, all the jrxml files that you would like to include to be included in the jasper dashboard should be placed under the 'jasper' directory. , and you have to link the jrxml file should be linked to the toolbox via the jasper.properties file. And also if you want to access Also, if the database needs to be accessed via the jrxml file then , you have to provide the datasuorce configuration xml file, which also should be placed under the 'dashboard' directory and included in the jasper.properties file.
...