Adding a Custom Header to Spotfire Server and Spotfire Web Player

You can add a custom header to Spotfire Web Player and the administration UI in Spotfire Server.

Steps 1-5 describe how to add a custom header to the cobranding package. Follow these steps, and deploy the cobranding package to enable the custom header in Spotfire Server. Steps 6-11 describe how to also enable the custom header in Spotfire Web Player.
Note: If adding a custom header to Spotfire Web Player is the only cobranding you want to do, this can be done without a cobranding package. For more information, see the topics "Manually configuring a Spotfire Web Player service" and "Spotfire.Dxp.Worker.Web.config" in the Spotfire Server help.

Prerequisites

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

Procedure

  1. Create a custom header to add to the Spotfire environment. You can copy and edit the WebHeader template file.
    Note: The logo image should be named CompanyLogoWide.png and placed in a subfolder to the path containing all the other cobranding files. The subfolder should be named "Images".
  2. Add the custom header HTM file to the local folder where the cobranding.config file is located.
  3. Open the cobranding.config file in an XML editor or text editor.
  4. Locate the section <web> ... <header>WebHeader.htm</header> ... </web>.
  5. Make sure that the name in the <header> section matches the name of the HTM file that you want to use as a header.
  6. On the Spotfire Server command line, export the service configuration. Specify the Web Player capability and the deployment area:
    config export-service-config --capability=WEB_PLAYER --deployment-area=Production
  7. Open the Spotfire.Dxp.Worker.Web.config file in a text editor or XML editor. After export, this file is located in the <server install dir>\tomcat\bin\config\root directory.
  8. Locate the <userInterface> section and set <customHeader enabled="false"> to true.
  9. On the command line, import the configuration file back into the Spotfire Server and name the configuration:
    config import-service-config --config-name=WebPlayerConfiguration
  10. On the command line, assign the created Spotfire Web Player configuration to the Web Player service:
    config set-service-config --service-id=value --config-name=WebPlayerConfiguration
  11. After you deploy the cobranding package in Spotfire Server, you must update the Web Player service on each node of your Spotfire implementation. For instructions, see "Updating services" in the Spotfire Server help.