NIH | National Cancer Institute | NCI Wiki  

Contents of this page

Branding NBIA Classic

The NBIA Classic application is currently in production, primarily to provide administrative tools. The NBIA Client is the new search interface for NBIA and is also in production.

To brand the NBIA Classic application, the developer will need to download the code from GitHub and build the application using the ant target build:all.  You will need to have the following required software:

Required Software Name and Version


Java SE Development Kit 8 Exit Disclaimer logo
Be sure to download the correct Java SDK for your operating environment. For example, for Linux AMD 64, you would download jdk-8u101-linux-x64.tar.gz and for Windows, jdk-8u101-windows-x64.exe. You must also factor in if the system is 32 or 64-bit. A 32-bit system cannot install 64-bit software. It is recommended that you install 32-bit Java SDK in a Windows environment even if your system is 64-bit because generating CTP thumbnail image only works properly with the 32-bit JDK in Windows.   

The J2SE Development Kit (JDK) supports creating J2SE applications.

Apache Ant is a Java-based build tool.

Branding in NBIA is accomplished by editing and or replacing the objects in the branding folders found in /software/common/resources/branding. The nbia folder contained within is the default branding for NBIA. The subfolder called images contains the customizable images for the application; they include:

FNLfCR-LOGO.png 200 x 39
footer_usagov.gif127 x 31
Logo-NCIA.jpg500 x  53
nci-header.png300 x 38
nci-link.png300 x 38
NCI-logo-white.png54 x 32
NCICBLOGO.gif126 x 43
white-ncilogo.gif263 x 39
white-nciurl.gif99 x 39
white-nihtext.gif208 x 39

To use your own images, simply replace the image while keeping the same name as the original one in your new folder; the build will update it accordingly. At the base level of the folder are the XHTML/properties files that allow customization. Those files are listed in the following table.

appFooter.xhtmlThe footer of the application
appHeader.xhtmlThe header of the application
branding.propertiesContains the application name property
ccHeader.xhtmlLegacy file for cancer center logos, to be removed
footer.xhtmlLegacy file for footers, to me removed
legalRules.xhtmlLegal rules when signing up
mainLayout.xhtmlLayout with session timer
mainLayoutTemplate.xhtmlOverall layout of the application
mainLayoutWithoutSessionTimeout.xhtmlLayout without session timer
mainMenu.xhtmlTop menu bar
ncia_messages.propertiesVarious messages used in the application
nciHeader.xhtmlApplication header
quickLinks.xhtmlExternal links
sessionExpired.jspPage shown when session expires
siteMap.xhtmlSite map at bottom of page
slideshow.cssCSS for the slideshow page
styleSheet.cssMain CSS for the application
subMenu.xhtmlSub menus in the menu bar
welcome.xhtmlMain login page
welcomeText.xhtmlLegacy welcome page, to be removed

Building a Branded Version

To create and build a branded version copy the example nbia folder to a new folder. As an example, assume the copied folder is "ncia" and you plan to make a version named "NCIA". Copy and name the folder and edit accordingly. Note the contains much of the applications textual information and contains the application names. Once you have edited the files, edit the and the files in the /software/build directory. Specify the branding properties. An example for naming an application "NCIA" follows.

### New Branding Properties ###

Once that is complete, execute the build:all ant target and the new war files in the directory (nbia-source-directory)/software/target/dist/exploded/nbia-wars/ will be properly branded. Replace the war files in tomcat\webapps with the branded ones, delete the nbia-api, ncia, and nbia-download and restart tomcat.

For the JNLP Download Manager to work correctly, a Java signing certificate must be used to sign the jar files used by Download Manager. If you do not have a signing certificate you can pull the following jar files from the NBIA install files ncia.war: ncia.war\NBIADownloadManager.jar and the folder ncia.war\download-mgr-dependencies and replace the files in your generated ncia.war.

XHTML/Facelets Basics

For all of the XHTML files that can be specified through the branding process, they MUST start with:

<ui:composition xmlns:ui="">

and they MUST finish up with:


Within the composition, almost any XHTML can be specified. 


The one exception to watch out for are entities such as non-breaking spaces. Including these directly will cause the rendering of the page to fail, and users will see a big mess in their browser. In other words &nbsp; will break rendering. Instead, the entity must be enclosed in a "verbatim" tag. Please note that another namespace is defined in the composition tag (in red below).

<ui:composition xmlns:ui=""

Quick Links XHTML

The Quick Links XHTML is imported into the scope of an XHTML table. Any XHTML specified here should be wrapped in a <tr> and at least one <td> element.
For an example see:


There are no restrictions on XHTML for the welcome title/text or the footer.

Branding the NBIA Client

The NBIA Client is the new search interface for NBIA. Both the NBIA Client and the NBIA Classic interfaces are currently in production.

Branding files for the NBIA Client are in directories within the assets/brand directory. Each subdirectory represents one brand. Which brand directory to be used is determined by the content of the text file assets/brand/currentBrand, it should contain the name of a directory within assets/brand.

If there is no assets/brand/currentBrand file, or its contents don't point to a valid directory, the default brand "nbia" will be used.

If there are any files missing from the brand directory named in assets/brand/currentBrand, the file from the default directory will be used.

If you only want to change one aspect of a brand, only include that file. The default directory versions will be used for the others.

You can brand the following files.

logo.pngA logo (41 pixels high)
footer.htmlA snippet of HTML that is at the bottom. If included, %VERSION% will be replaced with the client version number (versionSuffix.txt, below), and %HOST_NAME% will be replaced with the server name.
newAccountUrl.txtURL for "New account" button on the login screen
accountHelpUrl.txtURL for "Account help" button on the login screen
downloaderUrl.txtURL for "Get Data Retriever" button in the Download popup
versionSuffix.txtAn optional string that will be appended to the version number, if the version number is included in the footer.
customMenu.jsonThis is the top horizontal menu. Look at the default (nbia) for an example.

The customMenu.json is an array, with each top-level object representing one top-level menu item, as follows.

"entryTitle"The text of the top level menu item
"menuData""target" within "menuData" is the URL of the top-level menu item if you don't use a dropdown menu for this top-level item


  • "menuText"
  • "target"

an array of dropdown menu items:

  • the text for the dropdown menu item
  • the URL for the dropdown menu item

Example of Branded Properties

        "entryTitle": "Home",
        "menuData": {
            "target": ""
        "entryTitle": "News",
        "menuData": {
            "target": ""
        "entryTitle": "About Us",
        "menuDataDropdown": [
                "menuText": "About The Cancer Imaging Archive (TCIA)",
                "target": ""
                "menuText": "About the Cancer Imaging Program (CIP)",
                "target": ""
                "menuText": "About the University of Arkansas for Medical Sciences (UAMS)",
                "target": ""
  • No labels