Information on this page is based on install.properties
Link migrated to SVN and provided for historical purposes; current link to be provided http://gforge.nci.nih.gov/svnroot/ncia/tags/NCIA-MASTER-4_2_1-20090616-1/build/install.properties
Application Settings
Property Name | Description | example |
---|---|---|
application.base.path.linux | Location where user is installing software on Linux | ${user.home}/apps/nbia |
application.base.path.window | Location where user is installing software on Window | c:/apps/nbia |
authentication.type | CSM authentication type, the value should be "db" or "ldap" | db |
Database Settings
Property Name | Description | example |
---|---|---|
database.type | This value specifies whether a MySQL or an Oracle database is being used. | oracle, mysql |
database.server | This value must correspond to the domain name of machine that hosts the Oracle/MySQL database server. | remotehost.org |
database.port | This value must correspond to the port for the database.server. | 3306 |
database.name | Choose a name for the NCIA MySQL database. This must be different than the UPT database name | nciadb |
database.user | Give the username to access database.name. | nciaop |
database.password | Use a password to access database.name for the username identified in database.user | S0meth!ngSecurE |
database.system.user | The username for an administrator of this database. | root |
database.system.password | The password for an administrator of this database that correlates with the value in database.system.user. | S0meth!ngSecurE |
database.re-create | One of these properties must be set to true. | true or false |
Web Application JBoss container Properties
Property Name | Description | example |
---|---|---|
jboss.web.password | Set to a secure password to be used to secure the NBIA JBoss server’s administrative functions | S0meth!ngSecurE |
LDAP Settings
Property Name | Description | Example |
---|---|---|
ldap.url | URL for LDAP server | |
ldap.basedn |
| u=nci,o=nih |
NCIA-CORE-Grid Server/Container Settings - Grid Service registration URL
Property | Description | Example |
---|---|---|
grid.index.url | This is the URL to the index service that the NBIA grid service will register itself with. | http://cagrid-index.nci.nih.gov:8080/wsrf/services/DefaultIndexService |
grid.target | The target grid for the grid service. This will affect which servers SyncGTS will run against. | nci_stage-1.3 or nci_prod-1.3 |
ncia-core-grid.jboss.* | All of these properties mirror jboss.* except that they apply to a different JBoss container. | server.edu |
ncia-core-grid.tempZipLocation | This should be a directory with enough disk space such that the grid service can write sizeable zip files temporarily. | c:/temp |
ncia-core-grid.jboss.external.http.host | If installing the grid service in a proxy configuration, then this is the hostname of the proxy. | imaging.nci.nih.gov |
ncia-core-grid.jboss.external.http.port | If installing the grid service in a proxy configuration, then this is the port that the connection goes through on the proxy. | 80 |
ncia-core-grid.jboss.thumbnailUrl | This is the URL to the servlet whereby the thumbnails for images available through remote search can be obtained. | |
ncia-core-grid.jboss.http-connector.remove | Whether or not to remove the HTTP connector in the server.xml for JBoss/Tomcat. | true/false |
ncia-core-grid.jboss.grid.secure.port | The actual port the secure HTTPS connector will run on for the grid service. | 21443 |
ncia-core-grid.jboss.grid.secure.cert.location | The absolute path to the host public certifcate. | ~username/.cagrid/certificates/HOSTNAME-cert.pem |
ncia-core-grid.jboss.grid.secure.enable | Whether or not to secure the grid container. | true/false |
ncia-core-grid.jboss.grid.secure.key.location | The absolute path to the host private key. | ~username/.cagrid/certificates/HOSTNAME-key.pem |
ncia-core-grid.anonymous.permitted | Whether or not to allow anonymous access to secure methods of the service. | true/false |
ncia-core-grid.jboss.external.grid.secure.host | In a proxy situation, this allows setting the external host name for the service. | imaging.nci.nih.gov |
ncia-core-grid.jboss.external.grid.secure.port | In a proxy situation, this allows setting the external portf or the service. | 443 |
CTP Settings
Property Name | Description | Example |
---|---|---|
ctp.server.port | The port that the CTP administration console will run on. | 23080 |
ctp.server.http_import_service.port | The port that CTP will accept submissions on. This port should be configured as the port to export to in the CTP client configuration. | 23104 |
ctp.server.storage_service.port | The port that CTP storage service administration console will run on. | 23204 |
ctp.server.admin.password | The password for the CTP server administrator. | S0meth!ngSecurE |
ctp.server.king.password | The password for the CTP server super administrator who has privilege to shutdown the server | S0meth!ngSecurE |
ctp.server.storage_service.root | The directory where the CTP will store submitted files. | storage/root |
ctp.server.storage_service.index | The directory where the CTP will store the index for submitted files. This directory must be the direct parent of ctp.storage_service.root. | storage |
ctp.server.require_authentication | Whether or not the authentication is required for data submission (HttpImportService) | yes |
ctp.client.port | The port that the CTP administration console will run on (for the client). | password |
ctp.client.http_import_service.port | The port that CTP will accept submissions on. This port should be configured as the port to send to in the FileSender. | 24104 |
ctp.client.dicom_import_service.port | The port that CTP will accept submissions on. This port should be configured as the port to send to in the FileSender. | 24304 |
ctp.client.export_service.port | The port that CTP will export submissions to (to the server). This should match up with the import service port on the server side. | 23080 |
ctp.client.admin.password | The password for the CTP client administrator. | S0meth!ngSecurE |
ctp.server.admin.password | The password for the CTP client super administrator who has privilege to shutdown the server | S0meth!ngSecurE |
ctp.server.verifier.port | The port that CTP will listen for verification requests on. |
|
ctp.client.exportService.username | Specifies the user name at the submitting site to ensure that all transmitted data made it into the NBIA database | S0meth!ngSecurE |
ctp.client.exportService.password | Specifies the password at the submitting site to ensure that all transmitted data made it into the NBIA database | S0meth!ngSecurE |
NBIA Application Properties
Property Name | Description | Example |
---|---|---|
gov.nih.nci.ncia.imaging.server.url | Publicly visible URL for the JBoss container hosting NBIA. | |
gov.nih.nci.ncia.zip.location | Location to place zipped files created by the NBIA web application for download. | /data/ncia_data/ncia_ftp |
gov.nih.nci.ncia.ftp.location | Location to place files for download through an external FTP server. | /data/ncia_data/ncia_ftp |
gov.nih.nci.ncia.grid.local.node.name | If remote search is enabled, this is the name that will be used in the search form to search THIS node. | NCI-1 |
gov.nih.nci.ncia.ui.uid.display.length | Determines the max character length of data representation in the UI tier | 100 |
gov.nih.nci.ncia.ftp.url | FTP server URL used for informing users about where to download the larger size files | localhost |
gov.nih.nci.ncia.jboss.mq.url | The value of this property should ALWAYS be “localhost:<port>” where <port> have the exact same value as ${jboss.server.jndi.port}. | localhost:45200 (port is the JBoss JNDI port) |
gov.nih.nci.ncia.installationSite | This property determines whether the installation is at ncicb or somewhere else (other). | ncicb, other |
gov.nih.nci.ncia.admin.email | The email address of the user administrator | admin@university.edu |
enabled_guest_account | Whether or not public search will be enabled for this instance. | yes or no |
guest_username | If enabled_guest_account=yes then this is the name of the CSM user that will blessed as the user for all public searches. | nbia_guest |
gov.nih.nci.ncia.download.server.url | This is the URL that the Download Manager will use to retrieve DICOM images from. | [http://localhost:45210/nbia-download/servlet/DownloadServlet |
enable_classic_download | If this is set to no, then only the WebStart based Download Manager will be available to all userse. | yes or no |
local.grid.uri | For a given installation, this is the URL to the grid service FOR THAT INSTALLATION itself. | http://imaging.company.com:45210/wsrf/services/cagrid/NBIAService |
show.collection.search.criteria | If set to false, the collection criteria selection control will not appear in the classic search UI. | true or false |
discover.remote.nodes | If set to false, the NBIA web application will not attempt to discover other instances of NBIA to search | true or false |
gov.nih.nci.ncia.download.no.retry | Maximum Number of retry to download images for Download Manager | 4 |
Global Settings
Property Name | Description | Example |
---|---|---|
mail.smtp.server | Location of mail server to send emails for application to forward emails to users, notify users of the location of the download files | mail.university.edu |
Grid Service Contact Information
Property Name | Description | Example |
---|---|---|
grid.poc.tech.researchCenter.displayname | Name of the Research Center | Cancer Research Center |
grid.poc.tech.researchCenter.shortname | Shortened Name of Research center | CRC |
grid.poc.tech.addr.street1 | Street Address | 1234 Main Street |
grid.poc.tech.addr.street2 | Additional Street Address Information | Suite 2000 |
grid.poc.tech.addr.locality | TBD | Fairfax |
grid.poc.tech.addr.stateProvince | State or Province | VA |
grid.poc.tech.addr.postalCode | Zip/Postal Code | 22033 |
grid.poc.tech.addr.country | Country where Research Center is located | USA |
grid.poc.tech.affiliation | TBD | Mr. |
grid.poc.tech.name.last | Last Name of Technical POC | Henry |
grid.poc.tech.name.first | First Name of Technical POC | Patrick |
grid.poc.tech.phone | Phone Number of Technical POC | 703-555-1212 |
grid.poc.tech.email | Email for Technical POC | user@email.com |
grid.poc.tech.role | Role of Technical POC | Network Administrator |
grid.poc.science.affiliation | TBD | Mr. |
grid.poc.science.name.last | Last Name of Science POC | Jefferson |
grid.poc.science.name.first | First Name of Science POC | Thomas |
grid.poc.science.phone | Phone Number of Science POC | 703-555-1212 |
grid.poc.science.email | Email for Science POC | user@email.com |
grid.poc.science.role | Role of Science POC | Biologist |
Branding Settings
Note: for an explanation on constructing the XHTML that is referenced by these properties, see NBIA Branding Guide
Property Name | Description | Example |
---|---|---|
cancer.center.logo | The file path and name for branding logo. (Suggest logo size: 300x20) | c:/temp/logo.jpg |
cancer.center.background | The file path and name for branding logo background. | c:/temp/logo_background.jpg |
branding.welcome.title.path | The file path and name for XHTML file to use for welcome title in center | c:/temp/welcome_title.xhtml |
branding.welcome.text.path | The file path and name for XHTML file to use for welcome text in centerof welcome page. | c:/temp/welcome_text.xhtml |
branding.welcome.image.path | The file path and name for an image file to be used as the banner image | c:/temp/some_image.png |
branding.left.submenu.quicklinks.path | The file path and name for XHTML file to use for Quick Links in the left | c:/temp/quick_links.xhtml |
branding.applogo.visible | This controls whether the an application logo will be displayed on every page under | yes or no |
branding.applogo.path | If branding.applogo.visible=yes, this property becomes relevant. | c:/temp/some_image.png |
branding.footer.path | The file path and name for XHTML file to use for the footer on every page. | c:/temp/footer.xhtml |
Download Manager Digital Signature Settings
Property Name | Description | Example |
---|---|---|
jar-signing.keystore.location | The location of the keystore to find a key to sign the download manager jars with. | c:/keystores/nbia_keystore |
jar-signing.keystore.password | The password for the keystore pointed to by keystore.location. | something_secure |
jar-signing.keystore.alias | The alias for the key to use when signing the download manager jars. | alias1 |
jar-signing.execution.time | Whether to sign the jars at build time or install time. If not at NCICB, this value should always be install. | build or install |
jar-signing.generate-selfsigned | If set to true, the install process will generate a self-signed certificate to sign the jars with. | true or false |
Cedara Settings
Property Name | Description | Example |
---|---|---|
gov.nih.nci.ncia.jboss.public.url | The URL for the NBIA web application. | |
gov.nih.nci.ncia.mapped.image.path.head | Mapped image file path in IGS machine. (Only relevant to Cedara). | \\\\fs592 |
gov.nih.nci.ncia.image.path.pattern | Pattern of the image file path. (Only relevant to Cedara). | NCICBIMAGE/documents/ |
gov.nih.nci.ncia.frontier.http.address | Cedara ISG server address (Only relevant to Cedara) | localhost |