NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

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

...

Property NameDescriptionexample

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.

true or false
database.system.user

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.

root
database.system.passwordThe 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.

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

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-xmlData Base Resource File.ncia-ds.xmldatabase.schemaDatabase Schema for Oraclenciadev

...

Property Name

Description

example

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.hostnameName of the host. localhost if locally installedlocalhost
jboss.server.nameName of JBoss Serverdefault
jboss.web.userUserName for JBoss Serveradmin
jboss.server.ports.namePorts Name of JBossnbia-ports
jboss.ejbinvoker.portJBoss Port Number for EJB Invoking45150
jboss.hajndi.portHigh 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.portPort 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.portJBoss Application Server instance listens in this port.45210
jboss.server.redirect.portNon-SSL requests will be redirected to this port when a request for content secured under a transport confidentiality or integrity constraint is received45220
jboss.server.rmi.portRMI (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 network45230
jboss.service.rmiobject.portRemote Method Invocation port number so that Objects can interact in a distributed network45240
jboss.web.service.portWebService Port Number for JBoss45250
jboss.hajrmi.portHigh Availability Remote Method Invocation port number in JBoss.45260

jboss.pooledha.port

High Availability Pooled Port in JBoss45270

jboss.cobraorb.port

Cobra port for JBoss45280

jboss.jmx-rmi.port

Java Management Extensions, Remote Method Invocation Port in JBoss45290

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 management45310

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 connection49380

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 JBoss49410

jboss.transaction.status.port

Status of the transaction port in JBoss49420

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.

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 Server/Container Settings - Grid Service registration URL

For JBOSS EAP 6.2
  

LDAP Settings

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.  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.http://localhost:45210/ncia/publicThumbnails

Property Name

Description

Example

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

Property

Description

Example

ncia-core-grid.jboss.server.hostnameHostname for NCIA Core Gridlocalhost
ncia-core-grid.jboss.server.nameServer Name for NCIA Core Griddefault

ncia-core-grid.jboss.web.user

Username for NCIA Core Gridadmin

ncia-core-grid.jboss.web.password

Password for NCIA Core Gridncia1234!

ncia-core-grid.jboss.server.ports.name

 Ports Name of JBossnbia-ports

ncia-core-grid.jboss.ejbinvoker.port

JBoss Port Number for EJB Invoking21150

ncia-core-grid.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.21160

ncia-core-grid.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.21170

ncia-core-grid.jboss.server.bind.port

 21190

ncia-core-grid.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.21200

ncia-core-grid.jboss.server.port

JBoss Application Server instance listens in this port.21080

ncia-core-grid.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 received21220

ncia-core-grid.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 network21230

ncia-core-grid.jboss.service.rmiobject.port

Remote Method Invocation port number so that Objects can interact in a distributed network21240

ncia-core-grid.jboss.web.service.port

WebService Port Number for JBoss21250

ncia-core-grid.jboss.hajrmi.port

High Availability Remote Method Invocation port number in JBoss.21260

ncia-core-grid.jboss.pooledha.port

High Availability Pooled Port in JBoss21270

ncia-core-grid.jboss.cobraorb.port

Cobra port for JBoss21280

ncia-core-grid.jboss.jmx-rmi.port

Java Management Extensions, Remote Method Invocation Port in JBoss21290

ncia-core-grid.jboss.snmp-trapd.port

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

21300

ncia-core-grid.jboss.snmp.port

JBoss port for Simple Network Management Protocol which is a standard TCP/IP protocol for network management21310

ncia-core-grid.jboss.remoting.port

JBoss Port for most network based invocations and related service that uses pluggable transports and data marshallers.21320

ncia-core-grid.jboss.messaging.port

Messaging Port for JBoss to interact with orther applications.21330

ncia-core-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

ncia-core-grid.jboss.ssl.enable

Whether to enable Secure Sockets Layer or not.false

ncia-core-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

ncia-core-grid.jboss.ssl.keystore.pass

The password used to access the server certificate from the specified keystore file.ncicb1!

ncia-core-grid.jboss.ssl.keystore.alias

The other name of SSL keystore.ncicb-test-ssl-key

ncia-core-grid.jboss.ssl.fullyqualified.hostname

Full hostname where SSL will be hosted.localhost

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

If installing the grid service in proxy configuration, then this is the hostname of the proxy for SSL configuration. 

ncia-core-grid.jboss.external.ssl.port

Port Number for external SSL. Currently leave it blank. 

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

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. 

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

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

...