Package Builder guides you through the process of creating a package consisting of an extension.
Launching Package Builder
When Package Builder is launched for the first time, the following window is displayed:
Package Builder automatically locates any TIBCO Spotfire Professional client installed on your computer. You can use File > Add TIBCO Spotfire Distribution to add more clients, typically other versions of TIBCO Spotfire Professional.
If you have Spotfire Web Player installed on your computer it can also be added as a distribution. This is required to create packages intended for the Web Player.
When you add a distribution you should browse to the installation folder, that is, to the folder containing the Spotfire executable. In case of the Web Player you should browse to the web.config file.
Adding an Extension
To add an extension to the current configuration, click on the Add button to display the Add Project dialog:
| From folder: | Defines what folder to open. If the Source code folder option is selected, a source code folder is selected. Otherwise, a folder containing DLLs is expected. |
| Using project file: | Uses a project file previously created by Package Builder. |
Browse to the folder where your project is saved, click OK and then Next.
For instance, to add the custom visual extension of the SDK, browse to and select the folder C:\TIBCO Spotfire SDK\[version]\SDK\Examples\Extensions\SpotfireDeveloper.CustomVisualsExample
If you have already used Package Builder to create a project file for the extension, select the Using project file option.
The module.xml is included in all extensions provided by the TIBCO Spotfire SDK. If you for some reason do not wish to use the existing module.xml file, you may create a new one. If there is no module.xml, this is the only option. Package Builder is able to create a module.xml based upon the functions it finds in the extension, but you will have to provide the actual name and version number manually.
You may choose specifically what files to include. The default selection is read from the module.xml. If this file does not exist, no files are selected and you will have to select them manually. The Spotfire extension or Dependent Assembly option controls whether to include the DLL in the module.xml file or not.
You can add a Public resource name to a file and define its Culture by marking it and adding the information in the adjacent fields. This way any loaded module can locate the file at runtime by using the Framework.ApplicationModel.ModulesService class. Refer to the API documentation for more information on how to retrieve public resources at runtime.
If you are working on a source folder, the Build folder defaults to bin\Debug. This is where it expects to find the DLLs. Otherwise, this field is left blank, and the folder you selected is used.
If you wish to add a Public resource name for use in your development process, you may do so for each DLL that is to be included in your extension. If you selected to create a new module.xml file, select Spotfire Extension or Dependent Assembly for the DLL to be included in the module.xml file.
The last step is to name your project, apply an appropriate version number, and, from Spotfire 3.0, select the intended client:
In the Intended client drop-down list, select the target client for the extension:
- TIBCO Spotfire Any Client: Extensions without any UI logic. Typically extension providing models based on the Spotfire platform. Refer to the Runtime Structure overview.
- TIBCO Spotfire Professional/Enterprise Player: Any Windows Forms UI component.
- TIBCO Spotfire Web Player: Any Web Player UI component.
When you click Finish the extension is added to your configuration. Click on it to see further details in the Information pane:
