Implementing Custom Templates
As described in the Web Application Server Deployment Process and Business Application Server Deployment Process sections, the configuration files used in your application are built from templates. These templates are typically located in the $SPLEBASE/templates subdirectory of each environment.
Note:
The fileFW_template_structure.xml in the structures subdirectory lists all the templates and their destination paths. This file should not be altered unless instructed by Oracle Support.
By default, the product uses the base produce provided templates to build the configuration files. These configuration files are usually adequate for most needs in non-production but usually require some customization for production or site specific standards not covered by the base templates. In the past the site had two options:
- Make custom changes to the configuration file directly – This can be performed against the $SPLEBASE/etc/conf copies of the configuration files. The issue here is that if the configuration files are reset back to the templates intentionally or unintentionally, using the
initialSetuputility, custom manual changes may be lost if not reapplied manually. See initialSetup – Maintain Configuration Settings for details. - Make custom changes to base configuration templates – In extreme conditions it was possible to make manual changes to the base product templates to reflect your site standards and customizations. The issue is that new releases of the templates for new features would overwrite any customizations if not reapplied manually.
To address this, it is now possible to override base product templates with a copy of the template (a custom template). This can be achieved by copying the desired base template in the templates directory to the same name prefixed with "cm.". The initialSetup utility will use the custom template instead of the base template.
The process to implement this is as follows:
- Identify the template in the that is used by the desired configuration file. Use the information in the Web Application Server Deployment Process and Business Application Server Deployment Process sections of this document to help identify the templates used for each configuration file.
- Copy the desired template in the
$SPLEBASE/templatessubdirectory to the same name but prefixed with a"cm.". This will be the override custom template. To disable the custom template at any time either rename the template to another name or remove it from the subdirectory. - Make the necessary adjustments to the custom template in accordance with your site standards. Please follow any conventions used in the template including use of Environment Variables or configuration settings from the ENVIRON.INI file.
- Use
initialSetupin accordance with the Web Application Server Deployment Process and Business Application Server Deployment Process sections of this document to use the template to generate the new configuration files and incorporate the changes in the product.
Note:
If custom templates are implemented, it is the sites responsibility to maintain the custom templates to reflect any changes in the base templates for new, changed or removed functionality.Additional Templates
The templates mentioned in previously in this document are the main configuration file based templates. There are additional configuration files that are built and used for various purposes. Most of these configuration files are used internally for management of the infrastructure and generation of utilities.
Note:
The fileFW_template_structure.xml in the structures subdirectory lists all the templates and their destination paths. This file should not be altered unless instructed by Oracle Support.
There are several areas the templates cover:
- Configuration Files for Oracle WebLogic – Oracle WebLogic has specific requirements for configuration settings and files. Refer to Oracle WebLogic Configuration Support for more specific details.
- Configuration Files for other software – Third party software has specific requirements for configuration files.
- Utilities for deployment – Additional configuration files are built to use in the deployment process to define applications to the relevant runtime software.
- Internal ANT build configuration files – Configuration and build files are built to support the configuration build process.
Note:
The latter two categories of templates and configurations (utilities and ANT build files) should not be altered unless instructed by Oracle Support.The table below lists the templates in the template directory not covered by other sections of this document applicable to the online, service and IWS components:
| Templates | Configuration Files | Usage |
|---|---|---|
| application.xml.template | applicaton_web.xml | JEE global application configuration file, which contains common settings for the web application server. |
| application_service.xml.template | application_service.xml | JEE global application configuration file, which contains common settings for the business application server. |
| billdirfile.ini.template | billdirfile.ini | Bill Print extract configuration file. |
| boot.properties.template | boot.properties | Oracle WebLogic boot credentials file used for starting server. |
| coherence-cache-config.xml.template | coherence-cache-config.xml | Batch Coherence cache settings. |
| doc1dirfile.ini.template | doc1dirfile.ini | Bill Print extract configuration file. |
| e0Batch.properties.template | e0Batch.properties | Global batch properties. |
| earServiceBuild.xml.template | earServiceBuild.xml | ANT Build file for EAR file for the business application server. |
| earWebBuild.xml.template | earWebBuild.xml | ANT Build file for EAR file for the web application server. |
| ejb-jar.xml.template | ejb-jar.xml | Generic business application server descriptor for EJB's. |
| Fault.xsd.iws.template | Fault.xsd | Web Services Fault Schema. |
| iws-build-common.xml.iws.template | iws-build.xml | Common settings for IWS Build. |
| iws-build-WLS.xml.iws.template | iws-build.xml | IWS build Settings for Oracle WebLogic. |
| iwsdeploy-log4j2.properties.iws.template | log4j2.properties | Log properties for IWS build process. |
| jarservice.xml.template | jarservice.xml | ANT Build file for jar files. |
| java.login.config.template | java.login.config | JAAS Login file. |
| log4j2.properties.iws.template | log4j2.properties | Log configuration for IWS. |
| log4j2.properties.service.template | log4j2.properties | Log configuration for BAS. |
| log4j2.properties.standalone.template | log4j2.properties | Log configuration for batch. |
| log4j2.properties.template | log4j2.properties | Log configuration for online. |
| ouaf.jmx.access.file.template | ouaf.jmx.access.file | Default access file for JMX Security. |
| ouaf.jmx.password.file.template | ouaf.jmx.password.file | Default security file for JMX Security. |
| OUAF-Target.xml.template | OUAF-Target.xml | Oracle Identity Manager interface configuration File. Refer to KB231541 on My Oracle Support for details of this integration. |
| tangasol-coherence-override.xml.template | tangasol-coherence-override.xml | Batch Coherence overrides. |
| warbuild.xml.template | warbuild.xml | ANT WAR Build file. |
| warupdate.xml.template | warupdate.xml | ANT WAR file for updates. |
| weblogic-ejb-jar.xml.template | weblogic-ejb-jar.xml | Deployment descriptor for Business Application Server for Oracle WebLogic Configuration Support. |
Note:
Templates that exist in thetemplates directory but are not mentioned in this document are included in one or more templates above depending on the configuration requirements.