Adding custom headers to Spotfire UIs

You can use your own header in the Spotfire UIs. If you include the custom header in the cobranding package, and add the cobranding package to the default deployment area, the header will be displayed in the Spotfire Server UIs and the web player UIs. No restart or update is required, but you might need to refresh the web page.

About this task

The procedure below describes how to add a custom header to the cobranding package. Follow the steps, and then deploy the cobranding package to enable the custom headers.

Before you begin

You have a cobranding.config file to work with. If you need one, see Creating a cobranding.config file.

Procedure

Create a custom header to add to the Spotfire environment. You can copy and edit the WebHeader template file.
You can add a logo to the custom header, if desired. Use /[%AppPath%]/, e.g., <img src="/[%AppPath%]/customLogo.png"> and include an image in the cobranding package.

Note: If you also want to change the product logo displayed on, for example, the login page, this is controlled in the cobranding.config file. Locate the section <navigationLogo>libraryNavigationLogo.png</navigationLogo>. Make sure that the file name inside the <navigationLogo> ... </navigationLogo> tags matches the name of the image file you want to use for the logo. The image file should have the dimensions 190x33 pixels.
Add the custom header HTM file to the local folder where the cobranding.config file is located.
Open the cobranding.config file in an XML editor or text editor.
Locate the section <web> ... <header>WebHeader.htm</header> ... </web>.
Make sure that the name in the <header> section matches the name of the HTM file that you want to use as a header.

Various header display options

If you want to display the custom header only for a certain UI, or if you want different web players to use different custom headers, the attribute source in the Spotfire.Dxp.Worker.Web.config file is used. The attribute can be set to any of the values default, local, and none.

By means of the different attributes, the following display options are possible (the first option is the default display option which you get when following the steps in the section above):

The custom header is visible in the Server web administration pages as well as all web players. In this option, the value of the source attribute is default in the Spotfire.Dxp.Worker.Web.config file for each of the web players. (The default value of the source attribute is default.)
To use the custom header is only in the Server web administration pages:
1. Deploy the cobranding package containing the custom header in the default deployment area.
2. For each web player, make sure source is set to none in its Spotfire.Dxp.Worker.Web.config file.
To use the custom header only in all of the web client UIs:
1. Check that no cobranding package is deployed in the default deployment area. (If a cobranding package is deployed in the default deployment area, the header will automatically be visible in the server UI.)
2. Make sure that the cobranding package containing the custom header is deployed in a non-default deployment area.
3. For each web player, make sure source is set to local in its Spotfire.Dxp.Worker.Web.config file.
  Note: Any web player that is deployed in the default deployment area will not get a custom header.
  
  You can, if you want, make the custom header invisible in a separate web player. Then simply set source to none in its Spotfire.Dxp.Worker.Web.config file.
Note: It is possible to use different custom headers in different web players by adding cobranding packages containing different headers to different deployment areas. Then set source to local in the Spotfire.Dxp.Worker.Web.config file for each of the web players.