Page History
Information on this page is based on the install.properties
file. All releases are on the Installation and Downloads page.
Table of Contents |
---|
Application Settings
Property Name | Description | exampleExample |
---|---|---|
application.base.path.linux | Location where user is installing software on Linux | ${user.home}/apps/nbia |
application.base.path.windows | Location where user is installing software on WindowWindows | c:/apps/nbia |
authentication.type | CSM authentication type, ; the value should be "db", "ldap" or "ldap-auth"db | ldap |
Database Settings
Property Name | Description | exampleExample |
---|---|---|
database.type | This value specifies whether a MySQL or an Oracle database is being used. Currently on MySQL is supported. | oracle, mysql |
database.re-create database.drop-schema | One of these properties must be set to true. If re-create is true then the install:database target will wipe out the database instance completely and start from scratch. | true or false |
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. For Oracle, this value will be ignored. Depending on how the install is done, or the value of database.re-create this may not be necessary. If re-create=true, then this is necessary, otherwise it isn't. | Someth!ngSecure |
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 | Someth!ngSecure |
database.url | Url for connection to a database. This is the standard implementation style. This if fixed. No Change Required | jdbc:mysql://${database.server}:${database.port}/${database.name} |
database.system.url | Url for connection to a database. This is the standard implementation style. This if fixed. No Change Required | jdbc:mysql://${database.server}:${database.port}/ |
database.schema | Database Schema for Oracle | nciadev |
TCIA LDAP Settings
These can be ignored for the community version.
LDAP Settings
Property Name | Description | Example |
---|---|---|
ldap.url | Universal Resource Locator address for LightWeight Directory Access Protocol server. | |
ldap.basedn | LDAP server holding referrals to other server holding a given distinguished name (DN). | u=nci,o=nih |
ldap.user | Used only under ldap-auth, otherwise comment out | cn=NCILDAP,ou=nci,o=nih |
ldap.pass | Password for the authenticated user under ldap-auth, otherwise comment out | somepass |
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.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.server.verifier.port | The port that CTP will listen for verification requests on. | 23304 |
ctp.client.port | The port that the CTP administration console will run on (for the client). | 24080 |
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. | 24204 |
ctp.client.admin.password | The password for the CTP client administrator. | S0meth!ngSecurE |
ctp.client.king.password | The password for the CTP client super administrator who has privilege to shutdown the server | S0meth!ngSecurE |
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 Tomcat container hosting NBIA. | |
gov.nih.nci.ncia.mapped.image.path.head | \\\\\\\\cbiofs502.nci.nih.gov\\\\nciaimages\\\\,\\\\\\\\cbiofs502.nci.nih.gov\\\\nciaproddataset\\\\dataset_p01\\\\,\\\\\\\\nfs-ncia-d.nci.nih.gov\\\\nciadevdataset\\\\dataset_d01\\\\ | |
gov.nih.nci.ncia.image.path.pattern | NCICBIMAGE/documents/,data/dataset_p01/,data/dataset_d01/ | |
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.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 | |
gov.nih.nci.ncia.jboss.public.url | NBIA's URL for the portal | http://localhost:45210/ncia/ |
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 |
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 |
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 |
registration.email.subject | Subject for the Email sent to CBIIT | User registration to LDAP to access the National Biomedical Imaging Archive (NBIA) |
show.collection.search.criteria | If User wants to see Collections such as MR, CT, US etc in the Simple Search Page. By default it's set to false. | true or false |
discover.remote.nodes | What remote nodes the user want to see i.e Dev, Stage, Prod etc. Deprecated after NBIA 5.2 Version. | true or false |
show.anatomical.search.criteria | Various body parts the User wants to Search for such as Abdomen, Brain, Chest etc. | true or false |
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 |
Log4J Settings
Property Name | Description | Example |
---|---|---|
log4j.maxFileSize | 100MB | |
log4j.maxDays | 7 | |
log4j.level | WARN |
Mail 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 |
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 |
gov.nih.nci.ncia.encrypt.key | Alphanumeric key for password encryption | ABCD12346598AYE2 |
Exclusions
Property Name | Description | Example |
---|---|---|
exclude.start.servers | If you want to exclude starting server after the completion of installation. Default is false. | true or false |
exclude.ctp | If you want to exclude CTP. Default is set to false. | true or false |
exclude.ctp-client | If ctp-client should be excluded or not. Default is set to false. | true or false |
exclude.database | If you want to exclude database or not. Default is set to false. For the first time installation, please leave this property commented out so that database schema can be created. | true or false |
exclude.ctp.client.backup | If CTP Client backup is excluded. Default is set to false. | true or false |
exclude.ctp.server.backup | If CTP server backup should be excluded. Default is set to false. | true or false |
exclude.nbia-api | Exclude NBIA API or not. Default is false. | true or false |
UserGuide Settings
Property Name | Description | Example |
---|---|---|
gov.nih.nci.ncia.wiki.context.sensitive.help.url | wiki tiny URL for context sensitive help | https://wiki.nci.nih.gov/display/NBIA/NBIA+Help+Topics#NBIAHelpTopics |
SOLR Settings
Property Name | Description | Example |
---|---|---|
gov.nih.nci.ncia.solr.home | Location to keep solr indexes | c:/apps/nbia/solr-home/ |
gov.nih.nci.ncia.solr.updateinterval | This will defines how often in minutes Solr will update indexes | 60 |
Workflow Settings
Property Name | Description | Example |
---|---|---|
gov.nih.nci.ncia.workflow.updateinterval | This will defines how often in minutes Workflow will be updated | 60 |
REST API Settings
Property Name | Description | Example |
---|---|---|
nbia.api.oauth2.client.id | Unique ID given by authorization server during registration to the client application | nbiaRestAPIClient |
nbia.api.oauth2.client.secret | The password supplied to identify the client. | ItsBetweenUAndMe |
nbia.api.oauth2.token.validity.in.seconds | The expiration time in seconds before which the transaction has to be performed. | 7200 |
Tomcat Configuration Properties
Property Name | Description | example |
---|---|---|
gov.nih.nci.ncia.tomcat.home | Where tomcat is installed | /local/content/apache-tomcat-7.0.68 |
database.driver | The database driver. Please do not change the value of the property. If the database used is MySQL, just comment out the same property for Oracle and un-comment out the property for MySQL. Vise versa for Oracle database. | For MySQL database: com.mysql.jdbc.Driver For Oracle database: oracle.jdbc.driver.OracleDriver |
database.driver.jar | The jar name of database driver. Please do not change the value of the property. If the database used is MySQL, just comment out the same property for Oracle and un-comment out the property for MySQL. Vise versa for Oracle database. | For MySQL database: ${mysql.driver.jar} For Oracle database: ${oracle.driver.jar} |
database.driver.jar.src.url | The url for downloading database driver library. Please do not change the value of the property. If the database used is MySQL, just comment out the same property for Oracle and un-comment out the property for MySQL. Vise versa for Oracle database. | For MySQL database: ${mysql.driver.jar.src.url} For Oracle database: ${oracle.driver.jar.src.url}
|
csm.api.jar | The name of CSM API jar. Do not change the value of the property. | csmapi-5.2.jar |
csm.api.jar.src.url | The source url for CSM API jar. Do not change the value of the property. | https://ncimvn.nci.nih.gov/nexus/service/local/repositories/thirdparty/content/gov/nih/nci/csm/csmapi/5.2/${csm.api.jar} |
bouncy.castle.jar | The name of bouncy castle jar. Do not change the value of the property. | bcprov-jdk15on-1.51.jar |
bouncy.castle.jar.src.url | The source url for bouncy.castle.jar. Do not change the value of the property. | https://ncimvn.nci.nih.gov/nexus/service/local/repositories/central/content/org/bouncycastle/bcprov-jdk15on/1.51/${bouncy.castle.jar} |
mysql.driver.jar | The jar name of MySQL Driver. Do not change the value of the property. | mysql-connector-java-5.1.34.jar |
mysql.driver.jar.src.url | The source url for MySQL driver. Do not change the value of the property. | https://ncimvn.nci.nih.gov/nexus/service/local/repositories/central/content/mysql/mysql-connector-java/5.1.34/${mysql.driver.jar} |
oracle.driver.jar | The jar name of Orcle driver. Do not change the value of the property. | ojdbc14-10.2.0.3.0.jar |
oracle.driver.jar.src.url | The source url for Oracle driver. Do not change the value of the property. | https://ncimvn.nci.nih.gov/nexus/service/local/repositories/thirdparty/content/oracle/ojdbc14/10.2.0.3.0/${oracle.driver.jar} |
GUI Link Properties
Property Name | Description | Example |
---|---|---|
gui.text | Text for button linking out to beta search application | Leave blank in community version |
gui.link | URL for beta application, ignored in community version | gui.link=http//google.com |