NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Old Version 2

changes.mady.by.user Pan, Qinyan (NIH/NCI) [C]

Saved on

compared with

New Version 3

changes.mady.by.user Pan, Qinyan (NIH/NCI) [C]

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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. 

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

...

 

Property Name

Description

Example

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

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.

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.frontier.http.address

 

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

gov.nih.nci.ncia.jboss.public.urlNBIA's URL for the portalhttp://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. 

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.

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. 

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

registration.email.subjectSubject for the Email sent to CBIITUser 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.nodesWhat 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.criteriaVarious 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.
 
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

gov.nih.nci.ncia.download.no.retryMaximum Number of retry to download images for Download Manager
4

...

Log4J Settings

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

Property Name

Description

Example

grid.index.urlhttp://cagrid-index-stage.nci.nih.gov:8080/wsrf/services/DefaultIndexService

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

...

log4j.maxFileSize 100MB
log4j.maxDays 7
log4j.level WARN

Mail Settings

...

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.hostnameName of the host. localhost if locally installedlocalhost

nbia-grid.jboss.server.name

Name of JBoss Serverdefault

nbia-grid.jboss.web.user

UserName for JBoss Serveradmin

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 JBossconfig39380

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

...

brandingleft.submenu.quicklinks.pathThe 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.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.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.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.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.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.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.

Property Name

Description

Example

mail.

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

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. 

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

gov.nih.nci.ncia.encrypt.keyAlphanumeric key for password encryption ABCD12346598AYE2

Exclusions

true or false

Property Name

Description

Example

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.

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.

after the completion of installation. Default is false.true or falsetrue

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 want to exclude database or not. Default is set to false.true or false

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

Exclude NCIA core grid unsecured JBoss backup or notIf 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 false.true or false

exclude.ctp.server.backup

If CTP server backup should be excluded. Set to Falsetrue or false

exclude.jboss-bindings

JBoss-bindings should be excluded or not. Default is not.true or false

exclude.ncia-core-grid.backup

.jboss.config

Configure the JBoss for running NBIA should be excluded or not. Default is notIf 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

...

Property Name

Description

Example

nbia.wiki.user.guide.urlwiki tiny URL for user guidehttps://wiki.nci.nih.gov/x/LYEADQ
nbia.gov.nih.nci.ncia.wiki.context.sensitive.help.urlwiki tiny URL for context sensitive help

 https://wiki.nci.nih.gov/display/x/KoEADQ#NBIA61HelpTopicsNBIA/NBIA+Help+Topics#NBIAHelpTopics

SOLR Settings

Property Name

Description

Example

gov.nih.nci.ncia.solr.home
Location to keep solr indexesc:/apps/nbia/solr-home/
gov.nih.nci.ncia.solr.updateintervalThis will defines how often in minutes Solr will update indexes60

...