Create a Skeleton Extension on Mac

Use the bicreateplugin script to create an Oracle Analytics extension skeleton.

For information about the extensions you can create when you run the bicreateplugin script, see Types of Oracle Analytics Extensions.

Running the script creates a folder in your PLUGIN_DEV_DIRECTORY environment. This folder contains the files that you use to develop the extension. The <extension_name>.js render method is the entry point where you can start writing code.

The bicreateplugin script uses the following syntax:

bicreateplugin viz -subType <subtypename> -id <com.company.yourVizName>

Where:

subType is the type of visualization extension you want to create. Valid values are basic, dataviz, and embeddableDataviz. Don't include subType when you create a workbook extension.

id is the name of the extension. The name you specify must be in this format: <com.company.yourVizName>.

1. In Terminal, navigate to your extension development directory, run the bicreateplugin script.
   This example shows how to create a dataviz skeleton extension:

   bicreateplugin viz -subType dataviz -id com.companyabc.helloviz 

   This example shows how to create a workbook skeleton extension:

   bicreateplugin workbook -id com.companyabc.helloworkbook

2. In Finder, navigate to the src/customviz folder and confirm that a new folder was created and that its name matches the extension name you specified when you ran the script.
   This example shows a dataviz extension's directory:
   

   
   Description of the illustration mac_skeleton_viz_folder_structure.png

   
   
   This example shows a workbook extension's directory:
   

   
   Description of the illustration mac_skeleton_workbook_folder_structure.png