Spotfire® Cobranding

The cobranding.config template

You can copy and edit this cobranding.config template to create an XML file for your cobranded version of Spotfire.

<?xml version="1.0" encoding="utf-8"?>
<cobranding>
  <!--
    When specifying a URL, the following characters must be escaped:
    
        Character     Escape code
        _________________________
        SPACE 	     	%20
        < 	          %3C
        > 	          %3E
        # 	          %23
        % 	          %25
        { 	          %7B
        } 	          %7D
        | 	          %7C
        \ 	          %5C
        ^ 	          %5E
        ~ 	          %7E
        [ 	          %5B
        ] 	          %5D
        ` 	          %60
        ; 	          %3B
        / 	          %2F
        ? 	          %3F
        : 	          %3A
        @ 	          %40
        = 	          %3D
        & 	          %26
        $ 	          %24
        	
    The only valid schemes to use in the URL are HTTP and HTTPS. If a scheme
    is not provided, the scheme is assumed to be HTTP.
    
    
    To assign an access key to a menu item, the letter intended 
    to be used as access key must be prefixed with an ampersand (&). This 
    character also must be XML encoded to &amp;. To display an actual
    ampersand in these items, two escaped ampersand characters must be 
    placed next to each other (&amp;&amp;).
    
    
    All images used in the cobranding package must be in the PNG format. If
    the images are in a different format, the cobranding package uses the
    default images in Spotfire.
  -->
  
  
  <!-- 
    Replaces product name in window title and login dialog of Spotfire Analyst. 
    If the product name exceeds the available space in the login dialog, the 
    product name is trimmed.
  -->
  <productName>Sample Product Name</productName>


  <!-- 
    Replaces product name in window title, login dialog, and About page for the 
    Web Player. If the product name exceeds the available space in the login
    dialog, the product name is trimmed.
  -->
  <productNameWeb>Sample Product Name</productNameWeb>


  <!-- 
    The banner is used in splash screens and the About dialog of Spotfire Analyst. 
    The banner should be 700 pixels x 57 pixels, and able to be safely cropped to 
    400 pixels x 57 pixels. The cropping is done on the right side of the image. 
    Vital image information should be placed on the left side of the image to
    ensure that it will not disappear when cropped.
  -->
  <logoBanner>banner.png</logoBanner>


  <!--
    Replaces the "Spotfire Support" text on the Help menu and the support 
    link. If the support URL exceeds the available space in the About dialog,
    the link is trimmed and the full URL is displayed in a tooltip.
  -->
  <support>
    <text>Sample &amp;Support Link</text>
    <url>www.example.com/support</url>
  </support>

  <!--
    Replaces the "Spotfire community" text on the Help menu, and the link to the 
    Spotfire community.
  -->
  <community>
    <text>Spotfire Community</text>
    <url>https://spotfi.re/community/</url>	
  </community>
  
  <!--
    Replaces the "About Spotfire" text on the Help menu. 
  -->
  <about>Sample &amp;About Box</about>		


  <!-- 
    Link in the bottom left of the About dialog. 
  -->
  <companyUrl>www.example.com</companyUrl>

  
  <web>
  <!--
    The WebHeader.htm file is used to add a custom header to the server UI
    and Web Player.
  -->
	 <header>WebHeader.htm</header>
			
  <!-- 
    The logo shown in the navigation header on the library page. If the 
    image exceeds the dimensions 190x33 pixels, the image will be cropped.
  --> 
   <navigationLogo>libraryNavigationLogo.png</navigationLogo>
   </web>

  <!--
    To override the Spotfire default toolbar configuration without changing
    the group preference, supply a json-file that contains a json object with
    the name "ToolbarShortcuts" and the value is an array of toolbar identifiers.
  -->
  <defaultPreferences>defaultPreferences.json</defaultPreferences>

  <!--
    The landing page shown when you open Spotfire, after you have logged in. 
    Supply a .html file with the content and styling that you 
    want to use as the landing page.
  -->
  <landingPage>LandingPageTemplate.html</landingPage>
	
  <!--    
    The image shown on the right side of the Spotfire Analyst login dialog.
    The image dimensions should be 336 x 432 pixels. If the image dimensions 
    are above or below 336 x 432 pixels, the image is resized.
  --> 
  <loginPageSideImage>loginSideImage.png</loginPageSideImage>
   </cobranding>