Creating extensions to the Spotfire platform

Use the following procedure to extend Spotfire with custom capabilities. This procedure is an overview of all of the tasks required to create, build, debug, and deploy a Spotfire extension.

Before you begin

You must have a supported version of Visual Studio installed and configured for a Spotfire client.
You must have access to Spotfire Package Builder. See Spotfire Package Builder console for more information.
To debug and test the extension locally, you must have the Spotfire Windows application installed on your computer.
To deploy and test the extension in the web client, you must have administration access to Spotfire Server.

Extending the Spotfire platform is a straightforward procedure based on the extension mechanism:

Break down the problem and determine the appropriate extension points to use.
Register an extension for each point.
Implement the base classes tied to the respective extension points.

About this task

See Creating a Spotfire extension in Visual Studio for detailed instructions of the recommended way to develop extensions.

When the package is built, add the package file to a suitable deployment area from Deployments & Packages in the Spotfire Server web administration pages.

Procedure

In Visual Studio, open an existing extension or create a new extension, and build it.
If you are creating a new extension, use the Spotfire extension template.
Create or modify the .pkdesc file to include all necessary metadata and content for the extension.
In Visual Studio, develop and debug the extension.
Use the Package Builder console to build a Spotfire Package file containing the extension.

Results

After deployment on the server, users will be prompted to download updates when they start their clients and access the server. If the end user accepts the prompt, the extension is downloaded to the client computer, the client is restarted and the extension is loaded into the running Spotfire instance.