 |
Page History
...
To use your own images simply replace the image while keeping the same name as the original one in your new folder, and 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.
| Name | Purpose |
|---|---|
| appFooter.xhtml | The footer of the application |
| appHeader.xhtml | The header of the application |
| branding.properties | Contains the application name property |
| ccHeader.xhtml | Legacy file for cancer center logos, to be removed |
| footer.xhtml | Legacy file for footers, to me removed |
| legalRules.xhtml | Legal rules when signing up |
| mainLayout.xhtml | Layout with session timer |
| mainLayoutTemplate.xhtml | Overall layout of the application |
| mainLayoutWithoutSessionTimeout.xhtml | Layout without session timer |
| mainMenu.xhtml | Top menu bar |
| ncia_messages.properties | Various messages used in the application |
| nciHeader.xhtml | Application header |
| quickLinks.xhtml | External links |
| sessionExpired.jsp | Page shown when session expires |
| siteMap.xhtml | Site map at bottom of page |
| slideshow.css | CSS for the slideshow page |
| styleSheet.css | Main CSS for the application |
| subMenu.xhtml | Sub menus in the menu bar |
| welcome.xhtml | Main login page |
| welcomeText.xhtml | Legacy 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 ncia_messages.properties contains much of the applications textual information and branding.properties contains the application names. Once you have edited the files the edit install.properties and the defaultAHP3.properties in the /software/build directory. Specifically the branding properties need to be specified, here is an example for naming an application NCIA.
| Code Block |
|---|
############################################## |
...
### New Branding Properties ### |
...
############################################## |
...
branding.appname=NCIA |
...
branding.folder=ncia |
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.
...
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.
Branding consists of You can brand the following files.
| Name | Purpose |
|---|---|
| logo.png |
...
| A logo (41 pixels high) | |
| footer.html |
...
| A snippet of HTML that is at the bottom. If included, %VERSION% will be replaced with the client version number (see #6). | |
| newAccountUrl.txt |
...
| URL for "New account" button on login screen |
...
| accountHelpUrl.txt |
...
| URL for "Account help" button on login screen |
...
| downloaderUrl.txt |
...
| URL for "Get Data Retriever" button in Download popup |
...
| versionSuffix.txt |
...
| An optional string that will be appended to the version number, if the version number is included in the footer |
...
| customMenu.json |
...
| This is the top horizontal menu. Look at the default (nbia) for an example. |
It is a JSON array, each top level object represents one top-level menu item:
...
