Versions Compared

Key

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

...

You can install the custom toolbox by following the steps in Installing custom toolbox.

Structure of Toolbox

Toolbox artifacts should be placed in the as shown in the below structure

Analytic Artifacts

As shown in the structure the analytics scripts (Eg: Hive script) should be placed under analytics folder under toolbox. All the scripts which are placed under the analytics folder will be deployed. And if you ant to schedule the script then you have to include analyzers.properties file such as following.

...

The cron property is optional, if you want to schedule the script then you should mention it in this property file. As shown in the above both scripts are scheduled with cron expression '1 * * * * ? *'. If you don't want to schedule the script to run, then simply you can avoid having the property for that particular script in the analyzers.properties file.

 

Stream Definition Artifacts

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 different files.

...

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  or Jasper Dashboard or both artifacts.

You need to have the respective artifacts for the dashboard which you are going to visualise your data. The below section will describe how to include the those artifctas in the toolbox. 

Gadget Dashboard Artifacts

Gadget Dashboard related artifacts are given below.

...

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 order. 

Jasper Dashboard Artifacts

Jasper Dashboard related artifacts are given below.

...

And also if you want to access the database via 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. 

Assume you have My_Jasper.jrxml file in the jasper folder. And you are using the My_Datasource.xml configuration file which consists of the connection parameters, etc to the datasource as given below.

...

According to the above configuration, there will be one tab and the title of that tab will be 'My Jasper Tab Title' and associated jasper file is 'My_Jasper.jrxml'. The datasource configuration is provided by 'datasource.configuration' property.

Packing Toolbox

After including all required artifacts as described above in a directory, finally you need to make it as .zip file and change the extension to .tbox.

The name of the .tbox is taken as the name of toolbox. Further more now you are ready to install your toolbox, and you can install the toolbox by following the steps in Installing custom toolbox.