Page History
...
Property Name | Description | example | |||
---|---|---|---|---|---|
database.type | This value specifies whether a MySQL or an Oracle database is being used. | 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.resource.file.ds-xml | Data Base Resource File. | ncia-ds.xml | database.schema | Database Schema for Oracle | nciadev |
Web Application JBoss container Properties
Properties that are below double horizontal line needs not to be set.
LDAP Settings
Property Name | Description | exampleExample |
---|---|---|
jboss.web.password | Set to a secure password to be used to secure the NBIA JBoss server’s administrative functions | S0meth!ngSecurE |
jboss.server.hostname | Name of the host. localhost if locally installed | localhost |
jboss.server.name | Name of JBoss Server | default |
jboss.web.user | UserName for JBoss Server | admin |
jboss.server.ports.name | Ports Name of JBoss | nbia-ports |
jboss.ejbinvoker.port | JBoss Port Number for EJB Invoking | 45150 |
jboss.hajndi.port | High Availability JNDI port number in JBoss that allows Java software clients to discover and look up data and objects via a name. | 45160 |
jboss.jms.port | Port Number for messaging standard that allows application components based on the Java Enterprise Edition (Java EE) to create, send, receive, and read messages. | 45170 |
jboss.server.bind.port | 45190 | |
jboss.server.jndi.port | JNDI port number in JBoss that allows Java software clients to discover and look up data and objects via a name. | 45200 |
jboss.server.port | JBoss Application Server instance listens in this port. | 45210 |
jboss.server.redirect.port | Non-SSL requests will be redirected to this port when a request for content secured under a transport confidentiality or integrity constraint is received | 45220 |
jboss.server.rmi.port | RMI (Remote Method Invocation) is a way that a programmer, using the Java programming language and development environment, can write object-oriented programming in which objects on different computers can interact in a distributed network | 45230 |
jboss.service.rmiobject.port | Remote Method Invocation port number so that Objects can interact in a distributed network | 45240 |
jboss.web.service.port | WebService Port Number for JBoss | 45250 |
jboss.hajrmi.port | High Availability Remote Method Invocation port number in JBoss. | 45260 |
jboss.pooledha.port | High Availability Pooled Port in JBoss | 45270 |
jboss.cobraorb.port | Cobra port for JBoss | 45280 |
jboss.jmx-rmi.port | Java Management Extensions, Remote Method Invocation Port in JBoss | 45290 |
jboss.snmp-trapd.port | JBoss port for that receives and logs SNMP TRAP and INFORM messages. | 45300 |
jboss.snmp.port | JBoss port for Simple Network Management Protocol which is a standard TCP/IP protocol for network management | 45310 |
jboss.remoting.port | JBoss Port for most network based invocations and related service that uses pluggable transports and data marshallers. | 45320 |
jboss.messaging.port | Messaging Port for JBoss to interact with orther applications. | 45330 |
For JBOSS 5.1.0.GA | ||
jboss.unifiedinvoker.port | Instead of having a different implementation for each transport, there is one Unified Invoker in JBoss. | 49360 |
jboss.hajndi.auto.port | Automatic Port for High Availability for Java Naming and Directory Invocation. | 49370 |
jboss.ssl.port | Port for Secured Socket Layer which is a technology which allows web browsers and web servers to communicate over a secured connection | 49380 |
jboss.jms2.netty.port | Port for simple unencrypted TCP sockets based transport. | 49390 |
jboss.jms2.netty-ssl.port | Similar to Netty TCP transport but it provides additional security by encrypting TCP connections using the Secure Sockets Layer | 49400 |
jboss.transaction.recovery.port | Transaction Management Recovery Port for JBoss | 49410 |
jboss.transaction.status.port | Status of the transaction port in JBoss | 49420 |
jboss.transaction.processid.port | JBoss's Transaction Process ID port number. | 49430 |
jboss.java.opts
| Settings for the minimum and maximum heap memory required. | -server -Xms256m -Xmx1024m -XX:ThreadStackSize=128 -XX:SurvivorRatio=10 -XX:PermSize=128m -XX:MaxPermSize=512m -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000 -Djava.awt.headless=true |
jboss.ssl.enable | Whether to enable Secure Sockets Layer or not. | true or false |
jboss.ssl.keystore.location | The pathname of the keystore file where you have stored the SSL server certificate to be loaded. | ${security.dist.relative.dir}/ncicb-test-ssl.keystore |
jboss.ssl.keystore.pass | The password used to access the server certificate from the specified keystore file. | ncicb1! |
jboss.ssl.keystore.alias | The other name of SSL keystore. | ncicb-test-ssl-key |
jboss.ssl.fullyqualified.hostname | Full hostname where SSL will be hosted. | localhost.nci.nih.gov |
jboss.external.http.host | If installing the JBoss in a proxy configuration, then this is the hostname of the proxy. | |
jboss.external.http.port | If installing the JBoss in a proxy configuration, then this is the port that the connection goes through on the proxy. | |
jboss.external.ssl.host | Portname for External SSL. Currently leave it blank. | |
jboss.external.ssl.port | Port Number for external SSL. Currently leave it blank. |
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 |
NCIA-CORE-Grid Server/Container Settings - Grid Service registration URL
...
Property
...
Description
...
Example
...
ncia-core-grid.jboss.web.user
...
ncia-core-grid.jboss.web.password
...
ncia-core-grid.jboss.server.ports.name
...
ncia-core-grid.jboss.ejbinvoker.port
...
ncia-core-grid.jboss.hajndi.port
...
ncia-core-grid.jboss.jms.port
...
ncia-core-grid.jboss.server.bind.port
...
ncia-core-grid.jboss.server.jndi.port
...
ncia-core-grid.jboss.server.port
...
ncia-core-grid.jboss.server.redirect.port
...
ncia-core-grid.jboss.server.rmi.port
...
ncia-core-grid.jboss.service.rmiobject.port
...
ncia-core-grid.jboss.web.service.port
...
ncia-core-grid.jboss.hajrmi.port
...
ncia-core-grid.jboss.pooledha.port
...
ncia-core-grid.jboss.cobraorb.port
...
ncia-core-grid.jboss.jmx-rmi.port
...
ncia-core-grid.jboss.snmp-trapd.port
...
JBoss port for that receives and logs SNMP TRAP and INFORM messages.
...
ncia-core-grid.jboss.snmp.port
...
ncia-core-grid.jboss.remoting.port
...
ncia-core-grid.jboss.messaging.port
...
ncia-core-grid.jboss.java.opts
...
ncia-core-grid.jboss.ssl.enable
...
ncia-core-grid.jboss.ssl.keystore.location
...
ncia-core-grid.jboss.ssl.keystore.pass
...
ncia-core-grid.jboss.ssl.keystore.alias
...
ncia-core-grid.jboss.ssl.fullyqualified.hostname
...
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
...
80
...
ncia-core-grid.jboss.external.ssl.host
...
ncia-core-grid.jboss.external.ssl.port
...
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
...
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
...
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.admin.password
...
The password for the CTP client super administrator who has privilege to shutdown the server
...
S0meth!ngSecurE
...
NBIA Application Properties
...
Property Name
...
Description
...
Example
...
gov.nih.nci.ncia.imaging.server.url
...
...
\\\\\\\\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.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
...
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}.
If this is not configured properly the zipping of DICOM image files for download will not work properly.
...
localhost:45200 (port is the JBoss JNDI port)
...
gov.nih.nci.ncia.installationSite
...
ncicb, other
...
gov.nih.nci.ncia.admin.email
...
The email address of the user administrator
...
...
enabled_guest_account
...
Whether or not public search will be enabled for this instance.
...
yes or no
...
guest_username
...
nbia_guest
...
enable_classic_download
...
yes or no
...
If User wants to see Collections such as MR, CT, US etc in the Simple Search Page. By default it's set to false.
...
local.grid.uri
...
http://imaging.company.com:45210/wsrf/services/cagrid/NBIAService
...
show.collection.search.criteria
...
true or false
...
discover.remote.nodes
...
true or false
...
Grid Service Contact Information
...
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 |
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 JBoss 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.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 | |
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.jboss.backup | If JBoss Backup should be excluded. Default is set to false. | 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.jboss.config | Configure the JBoss for running NBIA should be excluded or not. Default is set to false. For the initial installation of NBIA, configure JBoss is necessary. So just leave this property to be commented out. | 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 |
JBoss EAP 6.2 Configuration Properties
Property Name | Description | example |
---|---|---|
jboss.modules.lib | The directory keeping the libraries which will be used to added to JBoss container as modules. This properties is specifically used by AHP3 build. Ignore this properties if the command line installer is used to install the NBIA 6.2. | /local/content/jboss/deployTemp |
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}
|
JBOSS_HOME | The JBoss home directory. If it is also set as a system environment variable, make sure it has same value here as the value defined for system environment variable. | C:\\apps\\nbia_eap6\\jboss-eap-6.2 |
JBOSS_BASE_DIR | The base directory of JBoss. It is needed because of the concept of JBoss profile, in which the standalone directory is not always under JBOSS_HOME. | C:\\apps\\nbia_eap6\\jboss-eap-6.2\\standalone |
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} |
jbossall.client.jar | The name of jbossall client jar. Do not change the value of the property. | jbossall-client-5.1.0.GAnci.jar |
jbossall.client.jar.src.url | The source url for jbossall client jar. Do not change the value of the property. | https://ncimvn.nci.nih.gov/nexus/service/local/repositories/thirdparty/content/org/jboss/client/jbossall-client/5.1.0.GAnci/${jbossall.client.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} |
...
grid.poc.tech.researchCenter.displayname
...
Cancer Research Center
...
grid.poc.tech.researchCenter.shortname
...
Shortened Name of Research center
...
CRC
...
grid.poc.tech.addr.country
...
Country where Research Center is located
...
USA
...
grid.poc.tech.addr.locality
...
TBD
...
Fairfax
...
grid.poc.tech.addr.postalCode
...
Zip/Postal Code
...
22033
...
grid.poc.tech.addr.stateProvince
...
State or Province
...
VA
...
grid.poc.tech.addr.street1
...
Street Address
...
1234 Main Street
...
grid.poc.tech.addr.street2
...
Additional Street Address Information
...
Suite 2000
...
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
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
...
c:/keystores/nbia_keystore
...
jar-signing.keystore.password
...
something_secure
...
jar-signing.keystore.alias
...
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
...
true or false
...
Grid Security
...
Property Name
...
Description
...
Example
...
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.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.enable
...
Whether or not to secure the grid container.
...
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.key.location
...
The absolute path to the host private key.
...
~username/.cagrid/certificates/HOSTNAME-key.pem
...
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
...
ncia-core-grid.anonymous.permitted
...
true/false
CQL2 GRID SERVICE JBOSS
Property Name | Description | Example |
---|---|---|
nbia-grid.jboss.server.hostname | Name of the host. localhost if locally installed | localhost |
nbia-grid.jboss.server.name | Name of JBoss Server | default |
nbia-grid.jboss.web.user | UserName for JBoss Server | admin |
nbia-grid.jboss.web.password | Set to a secure password to be used to secure the NBIA JBoss server’s administrative functions (e.g, admin console, JMX console, command-line shutdown of JBoss server, etc.) | nbia1234! |
nbia-grid.jboss.server.jndi.port | High Availability JNDI port number in JBoss that allows Java software clients to discover and look up data and objects via a name. | 31399 |
nbia-grid.jboss.server.port | JBoss Application Server instance listens in this port. | 39380 |
nbia-grid.jboss.ncicb-standard.port-config | true or false | |
nbia-grid.jboss.server.ports.name | Ports Name of JBoss | config39380 |
nbia-grid.jboss.java.opts | Settings for the minimum and maximum heap memory required. | -server -Xms256m -Xmx1024m -XX:ThreadStackSize=128 -XX:SurvivorRatio=10 -XX:PermSize=128m -XX:MaxPermSize=128m -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000 -Djava.awt.headless=true |
nbia-grid.jboss.ssl.enable | Whether to enable Secure Sockets Layer or not. | true or false |
nbia-grid.jboss.ssl.keystore.location | The pathname of the keystore file where you have stored the SSL server certificate to be loaded. | ${security.dist.relative.dir}/ncicb-test-ssl.keystore |
nbia-grid.jboss.ssl.keystore.pass | The password used to access the server certificate from the specified keystore file. | ncicb1! |
nbia-grid.jboss.ssl.keystore.alias | The other name of SSL keystore. | ncicb-test-ssl-key |
nbia-grid.jboss.ssl.fullyqualified.hostname | Full hostname where SSL will be hosted. | localhost |
nbia-grid.jboss.external.http.host | External hostname for NBIA grid JBoss | |
nbia-grid.jboss.external.http.port | External port number for NBIA grid JBoss | |
nbia-grid.jboss.external.ssl.host | External SSL hostname for NBIA grid JBoss | |
nbia-grid.jboss.external.ssl.port | External port number for NBIA grid JBoss |
Branding Settings
Note: for an explanation on constructing the XHTML that is referenced by these properties, see NBIA Branding
...
Property Name
...
Description
...
Example
...
branding.left.submenu.quicklinks.path
...
c:/temp/quick_links.xhtml
...
branding.welcome.image.path
...
c:/temp/some_image.png
...
branding.welcome.text.path
...
c:/temp/welcome_text.xhtml
...
branding.welcome.title.path
...
c:/temp/welcome_title.xhtml
...
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.applogo.visible
...
yes or no
...
branding.applogo.path
...
c:/temp/some_image.png
...
branding.footer.path
...
c:/temp/footer.xhtml
Exclusions
Property Name | Description | Example |
---|---|---|
exclude.nbia-grid | If User want to exclude nbia-grid or not. Default is set to true. | true or false |
exclude.ncia-core-grid-unsecured | If User wants to exclude ncia-core-grid-unsecured. Default is set to true. | true or false |
exclude.start.servers | If you want to exclude starting server after the completion of installation. Default is false. | true or false |
exclude.ncia-core-grid | If you want to exclude ncia-core-grid after the completion of installation. Default is true. Code for Grid Support has been removed from NBIA. Setting to False will give compiling issue. The Grid properties will be deleted from build script on later releases. | true |
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. | true or false |
exclude.jboss.backup | If JBoss Backup should be excluded. Default is set to false. | true or false |
exclude.ncia-core-grid.jboss.backup | Exclude NCIA core grid JBoss backup. Default value is false. | true or false |
exclude.ncia-core-grid-unsecured.jboss.backup | Exclude NCIA core grid unsecured JBoss backup or not. Default is false. | true or false |
exclude.ctp.client.backup | If CTP Client backup is excluded. Default is false. | true or false |
exclude.ctp.server.backup | If CTP server backup should be excluded. Set to False | true or false |
exclude.jboss-bindings | JBoss-bindings should be excluded or not. Default is not. | true or false |
exclude.ncia-core-grid.backup | If NCIA core grid 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 |
---|---|---|
nbia.wiki.user.guide.url | wiki tiny URL for user guide | https://wiki.nci.nih.gov/x/LYEADQ |
nbia.wiki.context.sensitive.help.url | wiki tiny URL for context sensitive help |
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 |