Creating and deploying a cobranding package

To use the cobranded version of Spotfire, you must create and deploy a package containing the updated cobranding.config XML file together with any images and custom files, such as the custom header HTM file, or custom login files, that are needed.

Before you begin

You must have the following in a local folder:
- An edited cobranding.config file.
- All the images you plan to include.
- All the files you need. For example, 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 on the computers running the Spotfire Server and the node managers (if you have node managers running on Linux).
To use the cobranding package with a Web Player running on Linux as well as with Spotfire Analyst and Web Player on Windows, the package must use IntendedPlatform="UNIVERSAL" and TargetFramework="ANY". Read more about building packages for Linux in the Spotfire Developer Documentation.

Note: You must use the Spotfire Package Builder to create the cobranding package. If you intend to build packages that work with the Web Player on Linux, you must use the Package Builder console, Spotfire.Dxp.PackageBuilder-Console.exe, and not the graphical Package Builder tool.

Procedure

Download and unpack the Spotfire Developer software, which is available under Spotfire Server on TIBCO eDelivery.
For download instructions, see the Spotfire Developer documentation.
Start Spotfire Package Builder.
Click Manage, and in the Manage Configurations dialog box, click Add.
Enter a name for the configuration, and then click OK twice.
In the main Package Builder dialog, click File > Add Spotfire Distribution, to add a Spotfire executable for debugging the cobranding package. Browse to the Modules folder for your Spotfire Analyst installation. For example:
- For a shared computer setup, this folder is usually located at C:\Program Files (x86)\Spotfire\<version number>\Modules.
- For a single user setup, this folder is usually similar to C:\Users\<username>\AppData\Local\Spotfire\<version number>\Modules.
(Note that the Modules folder is a hidden folder in some Windows configurations.)
Click Select Folder.
In the main Package Builder dialog, expand Spotfire Distribution and select the check box of the imported client version.
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.
Click Select Folder and then click Next.
On the next page, select Create a module.xml file and click Next.
If the file already exists, for the File exists message, click Yes.
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.
Select all the files to include in the package, including the cobranding.config file, and then click Next.
In the next dialog, give the project a name.
Under Intended client, select one of the following and then click Finish:
- Spotfire Installed Client to cobrand just Spotfire Analyst.
- Spotfire Web Client to cobrand Spotfire Web Player.
- Spotfire Any Client
In the main Package Builder dialog, select the new project and then click File > Build package file.
In the Save Package dialog, select a location for the package file and click Save.
Click Validate and Save.
Deploy the cobranding package to Spotfire Server.
For instructions, see Adding software packages to a deployment area in the Spotfire® Server Installation and Administration guide.
Important: The cobranding package must be deployed on the default deployment area.

What to do next

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.