Follow the instructions below to add/edit an analytic script in WSO2 BAM:
Adding an analytic script
- Log on to the BAM Management Console and select Analytics-> Add menu from the Main menu. That will open the Script Editor window.
Provide a script name and add the required HiveQL script in the editor pane as shown below:
For information on writing HiveQL scripts, refer to https://cwiki.apache.org/confluence/display/Hive/LanguageManual.
- You can click Run to execute the script and view results. The results appear in the panel below the script editor as shown in the screenshot below.
- Click Save to save the script. Click No in the pop up dialog box if it is not required to schedule the script immediately. Else click Yes to schedule the script before saving. For more information on scheduling, refer to section Scheduling an Analytic Script.
- The script will be redirected to Available Scripts page where saved script are listed.
Editing an analytic script
There are two ways to edit an analytic script. If you want to edit a script that came with a BAM toolbox,
- Go to
<BAM_HOME>/repository/deployment/server/bam-toolbox
folder and select the .tbox file you want to edit. - Open the .tbox file using any file archiving utility (e.g., 7z).
- Edit the script file in the toolbox according to your requirements. Scripts are saved inside Analytics folder in the .tbox file.
- Once the edits are done, archive the main folder again and simply change its extension to tbox.
- Save the edited .tbox file in the same
bam-toolbox
folder mentioned above and restart the server.
If you have already installed BAM, you can also change analytics scripts using the management console.
- Log in to the BAM management console and select List under Analytics menu in the Main menu.
- Select the script you want to edit and click Copy as a New Script link associated with it.
Note that you cannot use the management console to edit a script after it is deployed. The only want to do this through the UI is by duplicating the old script and renaming it. - Do your modifications to the existing script and save it in a new name.