Spotfire Developer Documentation

Adding Spotfire extensions to Spotfire Package Builder configurations

Spotfire Package Builder guides you through the process of creating a package to contain an extension.

About this task

Perform this task in the Spotfire Package Builder.

Before you begin

Procedure

  1. In Spotfire Package Builder, from the drop-down list, select the configuration for the extension, and then select the distribution.
  2. Click Add.
    The Add Project dialog is displayed.
  3. In the Add Project dialog, click From folder, and then click Browse to find the folder for the project.
    OptionDescription
    From folder Specifies that the project files are in a folder. Requires the source files and a built DLL. Use the Browse button to browse and select the folder containing the project files.
    • If you select Source code folder, browse to the location of the source code for the project and add that folder. Spotfire Package Builder files are placed in the project root directory with the source files.
    • If you clear Source code folder, browse to the folder containing the project DLLs. This is the folder specified in the Output path Build property of the Visual Studio project. For example, C:\Spotfire Dev\SDK\Examples\Extensions\SpotfireDeveloper.CustomVisualsExample\bin\AnyCPU\Debug. The project files and the module.xml are written to the selected folder.
    Note: If you are working from a source folder, the Build folder defaults to bin\Debug. This folder is where the Spotfire Package Builder expects to find the DLLs. Otherwise, the Build folder text box is left blank, and the folder you selected is used.
    Using project file It is not recommended to use this option at this time.
  4. Specify which module.xml to use.
    The file module.xml is included in all extensions provided by Spotfire Developer. If you do not want to use the existing module.xml file, you can create a new one. If there is no module.xml, you must create one. Spotfire Package Builder can create a module.xml based upon the functions it finds in the extension, but you must provide the actual name and version number manually.
  5. Optional: Specify the files from the build folder to include.
    The default selection is read from the module.xml. If this file does not exist, no files are selected and you must select them manually. The Spotfire extension or Dependent Assembly option controls whether to include the DLL in the module.xml file.
  6. Optional: Specify a Public resource name for the selected resource files, and then select a Culture.
    You can add a Public resource name for each DLL to include in your extension. If you selected the option to create a new module.xml file, select Spotfire Extension or Dependent Assembly for the DLL to be included in the module.xml file.
    By specifying a public resource and selecting a culture, any loaded module can locate the file at runtime by using the Spotfire.Dxp.Framework.ApplicationModel.ModulesService class, which is part of the Spotfire API.
    Note: A .NET Framework desktop application typically embeds in its main executable the neutral culture (the culture whose resources are used if no localized resources are available).
  7. Name the project, apply an appropriate version number, and select the intended client.
  8. Click Finish to create the extension and add it to your configuration.
    Click the extension in the Package Builder dialog to see further details listed under Information.
  9. Continue with one of the following options.
    OptionDescription
    Deploy to Server Adds the configured package to the server. This option should be selected only after fully developing, testing, and preparing the extension for distribution. Optionally, you can deploy the configured package to the Spotfire Server from its web interface. See Deploying a package from Spotfire Server for more information.
    Run Configuration Starts an instance of the specified Spotfire installation with the configuration. This option is useful for testing the extension in the Spotfire installation.
    Validate and Save Checks that the configuration is valid and saves the configuration without opening the Spotfire installation and running the configuration. This option is useful for learning to use the Spotfire Package Builder, but before you are ready to test an extension in Spotfire.