Creating and Deploying a Cobranding Package

You must create and deploy a package containing the cobranding.config XML file, the images, and the custom header HTM file to be used in the cobranded version of Spotfire.

Prerequisites

  • You must have the following in a local folder:
    • An edited cobranding.config file.
    • All the images you plan to include.
    • If you plan to use a custom header, a custom header .htm file.
  • For cobranding to work on a Linux system, cabextract must be installed.
Note: You must use the Spotfire® Package Builder to create the cobranding package.

Procedure

  1. Download and unpack the latest version of the "TIBCO Spotfire Developer Software" from the TIBCO eDelivery site. The software is listed under "Components found" in the search results.
  2. Start Spotfire Package Builder.
  3. Click Manage, and in the Manage Configurations dialog click Add.
  4. Enter a name for the configuration, and then click OK twice.
  5. In the main Package Builder dialog, click File > Add TIBCO Spotfire Distribution, and then browse to and select the Spotfire Modules folder. By default, this folder is located here: C:\Program Files (x86)\TIBCO\Spotfire\<version number>. Click Select Folder.
  6. In the main Package Builder dialog, expand TIBCO Spotfire Distribution and select the check box of the imported client version.
  7. Click Add, leave the selected option From folder, clear the Source code folder check box, and then browse to and select the folder that contains all your cobranding project files.
  8. Click Select Folder and then click Next.
  9. On the next page, select Create a module.xml file and click Next. (If the file already exists, click Yes in the "File exists" message.)
  10. On the next page, select both the cobranding.config check box and the words "cobranding.config" and then, under Public resource name, enter the text cobranding.config.
  11. Select all the files to include in the package, including the cobranding.config file, and click Next.
  12. In the next dialog, give the project a name.
  13. Under Intended client, select one of the following and then click Finish:
    • TIBCO Spotfire Installed Client to cobrand just Spotfire Analyst.
    • TIBCO Spotfire Web Client to cobrand Spotfire Web Player.
    • TIBCO Spotfire Any Client
  14. In the main Package Builder dialog, select the new project and then click File > Build package file.
  15. In the Save Package dialog, select a location for the package file and click Save.
  16. Click Validate and Save.
  17. Deploy the cobranding package to Spotfire Server; for instructions, see "Adding software packages to a deployment area" in the Spotfire Server help.
    Important: The cobranding package must be deployed on the default deployment area.

What to do next

  • Restart the Spotfire Server service.
  • If updates are not applied automatically to the default deployment area, make sure that end users accept the update when connecting to the server.
  • If you are adding a custom header to the web client, you must update the Web Player services on each node of the collective; for instructions, see "Updating services" in the Spotfire Server help.