NBIA 6.0 Properties

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 Window

c:/apps/nbia

authentication.type

CSM authentication type, the value should be "db" or "ldap"

db

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. 

If drop-schema is true, then all the schema and data will be wiped out but the database itself will not be removed.

The username for an administrator of this database. 


This value should correspond to a MySQL username that has full system privileges.

This must correspond to the administrator account defined when MySQL was configured.
For Oracle, this value will be ignored, but the value must be different than the value of database.user.

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.

database.server

This value must correspond to the domain name of machine that hosts the Oracle/MySQL database server.

Talk to your database administrator to learn the server name and port.

remotehost.org

database.port

This value must correspond to the port for the database.server.

3306 is the default port, but check with your database administrator to be certain.

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

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}

Url for connection to a database. This is the standard implementation style.

This if fixed. No Change Required

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.)

S0meth!ngSecurE

jboss.server.jndi.port

jboss.pooledha.port

jboss.cobraorb.port

jboss.jmx-rmi.port

jboss.snmp-trapd.port

JBoss port for that receives and logs SNMP TRAP and INFORM messages.

jboss.snmp.port

jboss.remoting.port

jboss.messaging.port

jboss.unifiedinvoker.port

jboss.hajndi.auto.port

jboss.ssl.port

jboss.jms2.netty.port

jboss.jms2.netty-ssl.port

jboss.transaction.recovery.port

jboss.transaction.status.port

jboss.transaction.processid.port

jboss.java.opts

jboss.ssl.enable

jboss.ssl.keystore.location

jboss.ssl.keystore.pass

jboss.ssl.keystore.alias

jboss.ssl.fullyqualified.hostname

jboss.external.http.host

jboss.external.http.port

jboss.external.ssl.host

jboss.external.ssl.port

ldap.url

Universal Resource Locator address for LightWeight Directory Access Protocol server.

ldaps://university.edu:636

ldap.basedn

LDAP server holding referrals to other server holding a given distinguished name (DN).

u=nci,o=nih

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

If installing the grid service in a proxy configuration, then this is the port that the connection goes through on the proxy. 

For example, if Apache is acting as a proxy, then a typical proxy port would be 80.  

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

This is the URL to the servlet whereby the thumbnails for images available through remote search can be obtained.

The host and port of this URL must match the JBoss public URL for the web application (gov.nih.nci.ncia.jboss.public.url)

The context and servlet name should likely stay as ncia/publicThumbnails unless the deployment has been customized.

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. 

Verification requests are queries to the (NBIA) database adapter to confirm that a given image was submitted successfully.

 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

gov.nih.nci.ncia.imaging.server.url

Publicly visible URL for the JBoss container hosting NBIA.

This URL should contain the proxy name instead of the host name if there is a proxy.

If this property is not configured properly, then thumbnails images may not appear in the web application search results.

http://locahost:45210

\\\\\\\\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

If remote search is enabled, this is the name that will be used in the search form to search THIS node.

There is a separate property that governs the name of this node but as  viewed from other instances of NBIA. 

It is likely that these two properties should agree, but it isn't mandatory.

See: grid.poc.tech.researchCenter.displayname

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

This property determines whether the installation is at ncicb or somewhere else (other). 

This governs certain aspects of the UI such as where the link to reset a password will point to.

ncicb, other

gov.nih.nci.ncia.admin.email

The email address of the user administrator

ncicbmb@mail.nih.gov

This is the URL that the Download Manager will use to retrieve DICOM images from. 

This should typically be the same host and port of the JBoss server. 

The webapp context and file path should always be the same unless deployment has been customized.

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. 

This user should likely only be provisioned to be associated with PUBLIC protection elements.

nbia_guest

enable_classic_download

If this is set to no, then only the WebStart based Download Manager will be available to all userse. 

If this is set to yes, then the "classic" download feature will still be available that allows downloading zip
 files of DICOM images through HTTP and/or HTTP

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

For a given installation, this is the URL to the grid service FOR THAT INSTALLATION itself.
 
If this is not set properly, and remote search is enabled, then the local node will appear twice in the
 list of searchable nodes. 

Once for the "local" search, and additionally for its grid interface (if it is registered with the index service).

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. 

This should only be set to false if a given instance of NBIA has, and only will ever have, 
only one collection/project to search through.

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
 through the caGrid Index Service.

In other words, no remote nodes will appear at the top of the classic search page if this is set to false.

true or false

This is the URL to the index service that the NBIA grid service will register itself with.

Additionally, the remote search feature will look for other instances of NBIA at this index service.

If NBIA being setup for experimental purpose, it is more appropriate to register with the
staging index service (cagrind-index-stage).

grid.poc.tech.researchCenter.displayname

Name of the Research Center

This name is used by remote search. 

This name will be show in the list of searchable NBIA nodes on the search form.

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

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

jar-signing.keystore.location

The location of the keystore to find a key to sign the download manager jars with. 

If (file://\\If) generate-selfsigned is set to true, then this location will be where the installation process CREATES the keystore. 

Otherwise (file://\\Otherwise), the keystore should already exist at this location.

c:/keystores/nbia_keystore

jar-signing.keystore.password

The password for the keystore pointed to by keystore.location.

If (file://\\If) generate-selfsigned is set to true, then this password will be set when the installation process CREATES the keystore.  \ (file://\\Otherwise)

Otherwise, the password should apply to the existing keystore.

something_secure

jar-signing.keystore.alias

The alias for the key to use when signing the download manager jars.

If (file://\\If) generate-selfsigned is set to true, then this alias will be set when the installation process CREATES the key and keystore. 

Otherwise (file://\\Otherwise), the alias should exist in the existing keystore.

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. 

If (file://\\If) false, there must be an existing certificate to use when signing.

true or false

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

Whether or not to allow anonymous access to secure methods of the service.  

This will allow the public data filter to still be used.

true/false

gov.nih.nci.ncia.jboss.public.url

The URL for the NBIA web application.
This URL should contain the proxy name instead of the host name if there is a proxy. (Only relevant to Cedara). \\\\Note: this must end in a forward slash.

http://localhost:45210/ncia/

gov.nih.nci.ncia.mapped.image.path.head

Mapped image file path in IGS machine. (Only relevant to Cedara).

\\\\fs592
nciaimages

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

nbia-grid.jboss.server.name

nbia-grid.jboss.web.user

nbia-grid.jboss.web.password

nbia-grid.jboss.server.jndi.port

nbia-grid.jboss.server.port

nbia-grid.jboss.ncicb-standard.port-config

nbia-grid.jboss.server.ports.name

nbia-grid.jboss.java.opts

nbia-grid.jboss.ssl.enable

nbia-grid.jboss.ssl.keystore.location

nbia-grid.jboss.ssl.keystore.pass

nbia-grid.jboss.ssl.keystore.alias

nbia-grid.jboss.ssl.fullyqualified.hostname

nbia-grid.jboss.external.http.host

nbia-grid.jboss.external.http.port

nbia-grid.jboss.external.ssl.host

nbia-grid.jboss.external.ssl.port

branding.left.submenu.quicklinks.path

The file path and name for XHTML file to use for Quick Links in the left 
submenu. 

If not set or if the value is blank, the default Quick Links will be used.

c:/temp/quick_links.xhtml

branding.welcome.image.path

The file path and name for an image file to be used as the banner image
on the welcome page.  This image can be a JPG, GIF or PNG and
should be roughly 600x140.

If not set or if the value is blank, the default welcome banner will be used.

c:/temp/some_image.png

branding.welcome.text.path

The file path and name for XHTML file to use for welcome text in centerof welcome page.

If not set or if the value is blank, the default welcome text will be used.

c:/temp/welcome_text.xhtml

branding.welcome.title.path

The file path and name for XHTML file to use for welcome title in center
of welcome and home pages.

If not set or if the value is blank, the default welcome title will be used.

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

This controls whether the an application logo will be displayed on every page under
institution logo.

If not set, the default NBIA app logo will be used.

yes or no

branding.applogo.path

If branding.applogo.visible=yes, this property becomes relevant.

This is the file path and name for an image file to be used as the application logo image at the top of all pages.

This image can be a JPG, GIF or PNG and should be roughly 500x20.

If not set or if the value is blank, the default NBIA app logo will be used.

c:/temp/some_image.png

branding.footer.path

The file path and name for XHTML file to use for the footer on every page. 

If not set or if the value is blank, the default footer will be used.

c:/temp/footer.xhtml

exclude.nbia-grid

exclude.ncia-core-grid-unsecured

exclude.start.servers

exclude.ncia-core-grid

exclude.ctp

exclude.ctp-client

exclude.database

exclude.jboss.backup

exclude.ncia-core-grid.jboss.backup

exclude.ncia-core-grid-unsecured.jboss.backup

exclude.ctp.client.backup

exclude.ctp.server.backup

exclude.jboss-bindings

exclude.ncia-core-grid.backup

exclude.nbia-api

https://wiki.link.edu#NBIA60HelpTopics