Create a Skeleton Extension on Windows

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

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

For information about the extensions you can create when you run the bicreateplugin script, see Types of Oracle Analytics Extensions. The examples used in this topic show you how to create the dataviz and workbook skeleton 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.
  1. In Command Prompt, run the bicreateplugin script in your development directory.
    cd $PLUGIN_DEV_DIR
    bicreateplugin viz -subType <subtypename> -id <com.company.yourVizName>
    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 File Explorer, navigate to your development environment and extension directory, for example C:\PLUGIN_DEV_DIR\src\customviz, and confirm that a new folder was created and that its name matches the extension name you specified.
    This example shows a dataviz extension's directory:

    This example shows a workbook extension's directory: