Package Builder enables the validation, saving, local testing, and deployment of packages to a Spotfire Server.
Overview
After creating, developing and debugging an extension, your Package Builder configuration will be ready for the last steps: validation and saving, optional running of the configuration on the local development machine, and deployment to a Spotfire Server.
Validating and Saving the Extension
The warning icon indicates that the configuration has not been saved.
You may validate it by clicking Validate and Save. Validation will include all checked packages, as well as checked base Spotfire distributions.
Package Builder validation verifies some key configuration characteristics before it creates a deployment package:
- That there are no missing assembly references in any of the components
- That there are no duplicate resource names in any of the components
- That all files defined in the
module.xml file exist
- That all the information in the
module.xml file is correct
The icon and information in the validation pane provide validation status:
| Validation in progress: |  |
| Successful validation: |  |
| Error message: |  |
Running Locally
Clicking the Run Configuration button will validate and save the configuration before running it. Spotfire will be executed on your computer with your extension included. This is a good way to test the extension in your configuration.
Packaging an Extension
When the extension is ready it must be packaged in order to distribute it. Select your extension in Package Builder and choose File > Build Package File. This will produce an SPK file that can be distributed and deployed to a Spotfire Server.
Deploying a Package
There are two ways to deploy a Spotfire package, the standard administrator way and the developer debug procedure. To be able to deploy a package you need to be logged in as a member of the Administrator or the Deployment Administrator group.
Administrator Deployment Procedure
From 3.1, use the Deployment tab in the TIBCO Spotfire Server Administration Console. Refer to the TIBCO Spotfire – Deployment and Administration Manual for details.
Before 3.1, use the Deployment tab in the TIBCO Spotfire Professional Administration Manager. Refer to the Deployment Tab section of the TIBCO Spotfire – Deployment and Administration Manual of the version you are using.
Deploying from Package Builder
Package Builder supports deploying an extension to the Spotfire Server for debugging purposes. This feature is provided as a convenience since extensions with custom licenses need to be deployed to the server in order to be debugged.
In Package Builder, select the check boxes to the left of each package you want to deploy. Only packages will be deployed, never base Spotfire distributions. When you click the Deploy to Server, you will be prompted to add the required details about your server, a description of your package and a version for your package:
The package or packages will be uploaded to the selected server and you will be notified if the deployment procedure is successful:
After a successful deployment, users will receive notice upon login that there are updates to download and install. When they click OK, the deployed extensions will be automatically installed on their computers.