Work with Extensions

This topic describes some of the tasks you perform when you develop your Oracle Analytics extensions.

Build and Package an Extension

Run the gradlew clean build command to build and package an extension into a ZIP file. You upload this file to your Oracle Analytics production environment, or to your Oracle Analytics Desktop test environment.

After you run the command, Oracle Analytics Desktop adds a build directory to your development environment, for example C:/PLUGIN_DEV_DIR/build/distributions. This directory contains a ZIP file for each extension in your development directory.
  1. Navigate to your development directory and run the gradlew clean build command. For example,
    cd $PLUGIN_DEV_DIR
    ./gradlew clean build

Upload an Extension to Oracle Analytics

After you build and package your extension to a ZIP file in your Oracle Analytics Desktop development environment, you upload the ZIP file to your Oracle Analytics production environment.

After you upload a visualization extension to Oracle Analytics and create or open a workbook, the Visualization tab displays the visualization extension in the Custom Visualizations section. From there you can drag and drop the custom visualization to your workbook. The extension displays as an option for every workbook on the instance where you uploaded the extension. All visualization extension types are available for you to add to workbooks. See Types of Oracle Analytics Extensions.

After you upload a workbook extension to Oracle Analytics, and create or open a workbook, the Custom Workbook Extension icon is displayed in the workbook's toolbar. Click this icon to view a list of the uploaded workbook extensions. Click an extension from the list to invoke it. The workbook extensions display for every workbook on the instance where you uploaded the extension.

  1. Open Oracle Analytics. On the Home page click Navigator. In Navigator click Console.
  2. Under Extensions and Enrichments, click Extensions.
  3. In Extensions, click Upload Extensions, and select the ZIP file containing the extension. Then click Open.

Delete Extensions from the Oracle Analytics Development Environment

You can use the bideleteplugin script to delete any extension from your Oracle Analytics development environment.

The build and package process includes all of the visualizations contained in your development directory. To exclude any unwanted visualizations from the build, you can delete them before you perform the build and package process.

Use the information in this table to help you delete an extension:

Action Command
Delete an extension
cd $PLUGIN_DEV_DIR
bideleteplugin viz -id <id_of_extension>
Delete an unclassified extension
cd $PLUGIN_DEV_DIR
bideleteplugin unclassified -id <id_of_extension>
Delete a skin extension
cd $PLUGIN_DEV_DIR
bideleteplugin skin -id <id_of_extension>