G Oracle Analytics Desktop SDK Reference
This topic describes the software development kit (SDK) that you can use to develop and deploy visualization plug-ins to your Oracle Analytics Desktop installation.
Topics:
Oracle Analytics Desktop SDK
The SDK provides a development environment where you can create and develop custom visualization plug-ins and deploy them to your Oracle Analytics Desktop installation.
Topics:
Scripts
Your installation includes the scripts that you use to create a development environment and create skeleton visualization plug-ins.
The scripts are located in this directory: <your_installation_directory>\Oracle Analytics Desktop\tools\bin
.
C:\Program Files\Oracle Analytics Desktop\tools\bin
Note the following script names and descriptions:
-
bicreateenv - Run this script to create the development environment where you develop your plug-ins.
-
bicreateplugin - Run this script to create a skeleton visualization to quickly get started on developing your custom plug-in.
-
bideleteplugin - Run this script to delete a plug-in from your development environment.
-
bivalidate - Run this script with the
gradlew validate
command to call the bivalidate script. The bivalidate script validates whether the JSON configuration files are properly formatted and contain appropriate visualization configuration.
Other Resources
You can use resources other than scripts to develop your custom visualization plug-ins.
Note the following available resources:
-
circlePack sample - The circlePack sample is included in your development environment. You can deploy and use this sample immediately. However, the sample is designed for you to use with the provided tutorial to learn how to develop a visualization plug-in. You can also copy the sample and use it as a template for the visualization plug-ins that you want to create.
The circlePack sample is located in
<your_development_directory>\src\sampleviz\sample-circlepack
For example,
C:\OracleDVDev\src\sampleviz\sample-circlepack
-
Other visualization plug-in samples - You can download plug-in examples from the Oracle Analytics Library.
-
JS API documentation - This documentation contains JavaScript reference information that you need to develop a visualization plug-in. See Oracle Analytics Desktop SDK JavaScript Reference.
Create the Visualization Plug-in Development Environment
You need to set the PATH environment variable and create the development environment before you can create visualization plug-ins.
Create a Skeleton Visualization Plug-in
After you create a skeleton visualization plug-in in your development environment, you then develop it into a robust visualization plug-in and deploy it to your Oracle Analytics Desktop environment.
bicreateplugin -viz
command for the first time, the system creates the customviz directory in the following location. <your_development_environment>\src\customviz
All custom visualization development directories that you create are added to this directory.
For example, C:\OracleDVDev\src\customviz\com-company-basicviz
Create a Skeleton Skin or Unclassified Plug-in
The bicreateplugin -unclassified
command creates an empty plug-in with plugin.xml, localization bundles. The bicreateplugin -skin
command creates a skeleton skin plug-in.
Develop a Visualization Plug-in
After you create the skeleton visualization plug-in, you can use resources provided by Oracle to help you develop your plug-in.
The directories for dataviz and embeddableDataviz types include the datamodelhandler.js file, which contains the physical-to-logical data mapping format. This file also determines how Oracle Analytics Desktop renders and passes user interactions to the server.
Use the .JS API documentation to learn how to add dependencies. See Oracle Analytics Desktop SDK JavaScript Reference.
Run in SDK Mode and Test the Plug-in
You can run Oracle Analytics Desktop in SDK mode from your browser when you’re developing your visualization plug-in or when you want to test your visualization plug-in.
Validate the Visualization Plug-in
After you’ve tested your visualization plug-in and before you can package and deploy it, you must validate it.
Build, Package, and Deploy the Visualization Plug-in
After you validate the visualization plug-in, you've to build and package it, and then copy the resulting distributions into your installation directory.
Delete Plug-ins from the Development Environment
You can use the bideleteplugin
script to delete the unneeded plug-ins from your development environment.