Using Configuration Files Outside the WAR/EAR File
Typically, the configuration files specified Web Application Server Configuration Process and Business Application Server Configuration Process are embedded into the WAR/EAR files, in accordance with the JEE specification, ready for deployment for use at runtime. While this is generally acceptable for most sites, it also means that any configuration change requires rebuilding of the WAR/EAR files and redeployment to fully implement the configuration changes. This may add outage time to implement configuration changes.
It is possible to allow your application to use versions of the certain configuration files outside the WAR/EAR files to minimize outage time to implement changes. In most cases, a restart of the product components is necessary to implement the configuration change.
The table below outlines the configuration files that can be externalized from the WAR/EAR file by product component.
Component
Configuration Files
Externalized
Web Application Server (root and Webservices)
web.xml – JEE Deployment Descriptor
No
Web Application Server (root and Webservices)
spl.properties – Product Behaviour Settings
Yes
Web Application Server (root and Webservices)
weblogic.xml – Oracle WebLogic Extensions
No
Web Application Server (root and Webservices)
log4j2.properties – Product Logging Configuration
Yes
Business Application Server
web.xml – JEE Deployment Descriptor
No
Business Application Server
spl.properties – Product Behaviour Settings
Yes
Business Application Server
hibernate.properties - Database Connectivity Settings
Yes
Business Application Server
log4j2.properties – Product Logging Configuration
Yes
By default, the externalization works on the following principles:
The SPLEBASE environment variable must be set to the home location of the software prior to execution of the web application server or the business application server. This must match the value configured for the environment in the cistab configuration file on the machine. See cistab - Global Configuration Files for details.
The external versions of the configuration files should be in their default locations (as supplied) in the $SPLEBASE/etc/conf subdirectories.
Your application uses the external configuration file versions instead of the versions embedded in the WAR/EAR files. If you wish to revert to the embedded versions, then the site can either rename the conf subdirectories to prevent the external configuration files being detected or ensuring the SPLEBASE environment is not set.
Warning: If the conf subdirectories are renamed they should be reverted to their original names before ANY single fix, service pack or upgrade is performed to prevent configuration reset to base templates or installation failure.
This facility is useful for several situations:
If any passwords are changed that are used by the product on a regular basis, reflecting changes in the configuration files directly or using templates is easier using externalized configuration files. The WAR/EAR files do not need to be rebuilt and redeployed and this can save time.
During the initial phases of production or when traffic volumes fluctuate, it may be necessary to tune specific settings. This allows experimentation of the changes before committing to specific values. It allows greater level of flexibility in configuration change.
Note: It is recommended to ensure that in the long term that both the external versions and embedded versions are kept in sync on a regular basis to prevent configuration issues. This can be done using standard maintenance windows as necessary.