Page History
Background Color | ||
---|---|---|
| ||
Do NOT delete this page. This page is referred to in installation guides linked from the caIntegrator Documentation page. |
Information on this page is based on install.properties
These properties are derived from the BDA Build Template properties, more information can be found here.
Note: All properties that contain the word "grid" can be ignored, currently caIntegrator2 isn't grid enabled.
Application Settings
Property Name | GUI Installer Text | Description | Example |
application.url | N/A | URL for accessing application. This is generated by the installer. | http://${jboss.server.hostname}:${jboss.server.port}/caintegrator2 |
application.base.path | "Select installation folder" | Location where user is installing software | ${user.home}/apps/cai2 |
authentication.type | "Authentication Type" | Option to enable LDAP or Database authentication type. "db" or "ldap" | ldap |
env.name | N/A | The name of the environment for this properties file. Things can be conditionally excecuted based on this value
| external |
exclude.access-logs | N/A | Option to enable/disable tomcat access logs in jboss or tomcat | true |
struts.devMode | N/A | Option to enable/disable the struts.devMode property in struts.properties | false |
Database Settings
Property Name | GUI Installer Text | Description | Example |
database.type | N/A | The type of DB caIntegrator should use (currently only supports MySQL-type), this should not be changed by user | mysql |
database.re-create | N/A | Another flag that controls build flow, only one of these properties can be set. This one will connect as the database.system.user and drop/recreate the database.name and database.user. This is recommended for local deploys. This cannot be used on the tiers and is not recommended for external installs. | true |
database.system.user | "Database User Name with Administrative Privileges" | Database user with administrator-level privileges | root |
database.system.password | "Password for the above-named user:" | Administrator-level DB user's password | S0meth!ngSecurE |
database.system.url | N/A | The JDBC URL for administrator-level user DB connectivity (only needed at install time), should not be changed by user | jdbc:mysql://${database.server}:${database.port}/ |
database.server | "Database Host Name" | This value must correspond to the domain name of machine that hosts the MySQL server. Talk to your database administrator to learn the server name and port. | remotehost.org |
database.port | "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 | "Database Name" | Choose a name for the caIntegrator MySQL database. This must be different than the UPT database name | caIntegratordb |
database.user | "Database User Name for caIntegrator Application" | Give the username to access database.name. This must be different than the UPT database user name | caIntegratorop |
database.password | "Password for the above-named user:" | Use a password to access database.name for the username identified in database.user | S0meth!ngSecurE |
database.url | N/A | The JDBC URL for caIntegrator DB connectivity, should not be changed by user | jdbc:mysql://${database.server}:${database.port}/${database.name} |
JBoss Settings
Property Name | GUI Installer Text | Description | Example |
jboss.home | N/A | Location where caIntegrator JBoss server is being installed (auto generated) | ${application.base.path}/${jboss.relative.path} |
jboss.relative.path | N/A | Relative location of caIntegrator JBoss server (keep default value here, it can be changed from project.properties file) | ${jboss.binaries.relative.dir} |
jboss.server.hostname | "Application Host Name" | Hostname where JBoss is being installed | localhost |
jboss.server.name | "Application Server Name" | JBoss servername | default |
jboss.web.user | "Application JBoss Web User" | The username for the caIntegrator JBoss server's administrator user. | admin |
jboss.web.password | "Application JBoss Web Password" | The password for the caIntegrator JBoss server's administrator user, which is used to access the JBoss admin console, and also stop the server via shutdown script. | S0meth!ngSecurE |
jboss.ejbinvoker.port | "Application ejbinvoker Port Number" | port used by caIntegrator JBoss | 47150 |
jboss.hajndi.port | "Application hajndi Port Number" | port used by caIntegrator JBoss | 47160 |
jboss.jms.port | "Application JMS Port Number" | port used by caIntegrator JBoss | 47170 |
jboss.server.bind.port | "Application Bind Port Number" | port used by caIntegrator JBoss | 47190 |
jboss.server.jndi.port | "Application JNDI Port Number" | port used by caIntegrator JBoss | 47200 |
jboss.server.port | "Application HTTP Port Number" | port used by caIntegrator JBoss | 47210 |
jboss.server.redirect.port | N/A | port used by caIntegrator JBoss | 47220 |
jboss.server.rmi.port | "Application RMI Port Number" | port used by caIntegrator JBoss | 47230 |
jboss.service.rmiobject.port | "Application RMIObject Port Number" | port used by caIntegrator JBoss | 47240 |
jboss.web.service.port | "Application Web Service Port Number" | port used by caIntegrator JBoss | 47250 |
jboss.hajrmi.port | "Application hajrmi Port Number" | port used by caIntegrator JBoss | 47260 |
jboss.pooledha.port | "Application pooledha Port Number" | port used by caIntegrator JBoss | 47270 |
jboss.cobraorb.port | "Application corbaorb Port Number" | port used by caIntegrator JBoss | 47280 |
jboss.jmx-rmi.port | "Application JMX-RMI Port Number" | port used by caIntegrator JBoss | 47290 |
jboss.snmp-trapd.port | "Application SNMP-TRAPD Port Number" | port used by caIntegrator JBoss | 47300 |
jboss.snmp.port | "Application SNMP Port Number" | port used by caIntegrator JBoss | 47310 |
jboss.remoting.port | "Application Remoting Port Number" | port used by caIntegrator JBoss | 47320 |
jboss.messaging.port | "Application Messaging Port Number" | port used by caIntegrator JBoss | 47330 |
jboss.ssl.enable | "Enable JBoss SSL Port" | This flag tells the build process whether to configure a SSL connector. See this link for more details. | true |
jboss.ssl.keystore.location | "Keystore file location" | This is the location of keystore file that holds the certificate. | ${security.dist.relative.dir}/ncicb-test-ssl.keystore |
jboss.ssl.keystore.pass | "Keystore file password" | The password for that keystore. | ncicb1! |
jboss.ssl.keystore.alias | "Keystore alias name" | The alias of the certifiacate within the keystore. | ncicb-test-ssl-key |
jboss.ssl.fullyqualified.hostname | "Fully Qualified Host Name" | The FQHN the certificate is issued for (if it does not match the build will fail) | localhost.nci.nih.gov |
jboss.java.opts | N/A | JVM arguments which are passed when starting caIntegrator JBoss instance. | -server -Xms2048m -Xmx2048m -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 |
...
jboss.external.http.host |
...
"External |
...
Host |
...
Name |
...
for |
...
http |
...
port" |
...
The |
...
external |
...
Fully |
...
Qualified |
...
Host |
...
Name |
...
(FQHN) |
...
of |
...
the |
...
HTTP |
...
port. |
...
If |
...
this |
...
is |
...
set |
...
it |
...
will |
...
cause |
...
the |
...
proxyHost |
...
to |
...
be |
...
set |
...
in |
...
the |
...
HTTP |
...
connector. |
...
This |
...
will |
...
cause |
...
the |
...
servlet |
...
container |
...
to |
...
reply |
...
with |
...
this |
...
as |
...
it's |
...
hostname. |
...
You |
...
would |
...
use |
...
this |
...
if |
...
you |
...
were |
...
using |
...
a |
...
Proxy |
...
or |
...
NAT. |
...
| |
jboss.external.http.port |
...
"External |
...
Port |
...
for |
...
http |
...
port" |
...
The |
...
port |
...
to |
...
go |
...
along |
...
with |
...
the |
...
FQHN. |
...
It |
...
will |
...
cause |
...
proxyPort |
...
to |
...
be |
...
set |
...
in |
...
the |
...
connector. |
...
| |
jboss.external.ssl.host |
...
"External |
...
Host |
...
Name |
...
for |
...
ssl |
...
por" |
...
The |
...
external |
...
Fully |
...
Qualified |
...
Host |
...
Name |
...
(FQHN) |
...
of |
...
the |
...
SSL |
...
port. |
...
If |
...
this |
...
is |
...
set |
...
it |
...
will |
...
cause |
...
the |
...
proxyHost |
...
to |
...
be |
...
set |
...
in |
...
the |
...
SSL |
...
connector. |
...
This |
...
will |
...
cause |
...
the |
...
servlet |
...
container |
...
to |
...
reply |
...
with |
...
this |
...
as |
...
it's |
...
hostname. |
...
You |
...
would |
...
use |
...
this |
...
if |
...
you |
...
were |
...
using |
...
a |
...
Proxy |
...
or |
...
NAT. |
...
| |
jboss.external.ssl.port |
...
"External |
...
Port |
...
for |
...
ssl |
...
port" |
...
The |
...
port |
...
to |
...
go |
...
along |
...
with |
...
the |
...
FQHN. |
...
It |
...
will |
...
cause |
...
proxyPort |
...
to |
...
be |
...
set |
...
in |
...
the |
...
connector. |
|
LDAP Settings
Property Name | GUI Installer Text | Description | Example |
ldap.url | "LDAP URL" | The LDAP host used to authenticate caIntegrator users (if using LDAP) | ldap_host.mydomain.com |
...
ldap. |
...
basedn | "LDAP |
...
Search |
...
Base |
...
DN" |
...
The |
...
subdirectory |
...
in |
...
LDAP |
...
where |
...
users/roles |
...
should |
...
be |
...
searched |
...
for |
...
ou=users, |
...
o=mydomain.com |
...
Log4J Settings
Property Name | GUI Installer Text | Description | Example |
log4j.maxFileSize | N/A | The Log4J appender file size | 100MB |
log4j.maxDays | N/A | The Log4J appender number of copies | 7 |
log4j.level | N/A | The Log4J category level | WARN |
UPT Settings
Property Name | GUI Installer Text | Description | Example |
user.admin.email.address.from |
...
"UPT |
...
Admin |
...
...
Address |
...
From" |
...
...
address |
...
which |
...
registration |
...
emails |
...
come |
...
from. |
...
address@domain.com | |
user.admin.email.address.to |
...
"UPT |
...
Admin |
...
...
Address |
...
To" |
...
...
address |
...
that |
...
registration |
...
emails |
...
are |
...
sent |
...
to. |
...
address@domain.com |
...
upt.url |
...
"UPT |
...
URL" |
...
URL |
...
for |
...
the |
...
UPT |
...
server |
...
that |
...
manages |
...
this |
...
instance |
...
of |
...
CaIntegrator2 | http://\[caIntegrator2:server\]:\[caIntegrator2:port\]/upt42 |
...
Mail Settings
Property Name | GUI Installer Text | Description | Example |
mail.smtp.host |
...
...
Server |
...
Host" |
...
SMTP |
...
...
server |
...
from |
...
which |
...
software |
...
will |
...
send |
...
its |
...
emails |
...
smtp_host.mydomain.com |
...
mail.smtp.port |
...
...
Server |
...
Port |
...
Number" |
...
SMTP |
...
...
server |
...
port |
...
number | smtp_host.mydomain.com |
...
mail.smtp.auth |
...
...
Server |
...
Authentication" |
...
SMTP |
...
...
server |
...
requires |
...
authentication |
...
(true |
...
or |
...
false) |
...
false | |
mail.smtp.starttls.enable |
...
...
Server |
...
Starttls" |
...
SMTP |
...
...
server |
...
start |
...
tls |
...
(true |
...
or |
...
false) |
...
false | |
mail.user |
...
...
Server |
...
User" |
...
SMTP |
...
...
server |
...
user |
...
name | |
mail.password |
...
...
Server |
...
Password" |
...
SMTP |
...
...
server |
...
password |
...