Configuration Files
cistab - Global Configuration Files
The cistab file is a key configuration file for both the web application server and the database application server. It is built during the installation process and is used by Oracle Utilities Smart Grid Gateway administration utilities to ensure that any output or log files generated by the product are stored in the correct location. It holds the mount points (for example, directories) used during the installation of the product to hold the product and its log files.
Location of cistab file:
/etc/cistab
A sample cistab file is outlined below:
DEV::/spl/DEV:/spl/sploutput/DEV::N
DEMO::/spl/DEMO:/spl/sploutput/DEMO::N
TEST::/spl/TEST:/spl/sploutput/TEST::N
TEST2::d:\spl\TEST2:e:\sploutput\TEST2::N
The format of the file is described below:
Position
Usage
1
Environment Name – specified at installation time. It is in UPPER case.
2
Reserved for future use.
3
Directory for the product software and configuration files (the SPLEBASE environment variable definition).
4
Directory for the product output files (the SPLOUTPUT environment variable definition).
5
Reserved for future use.
6
This flag may be used in custom start up scripts to indicate whether to start the environment at system boot time. Valid values are Y or N. This is the only setting that should be altered after installation.
Warning: Do not alter the cistab file unless instructed to do so by Oracle support personnel unless otherwise directed.
coherence-cache-config.xml - Oracle Coherence Configuration (BATCH)
The coherence-cache.config.xml configuration file is used by the CLUSTERED mode of execution to manage the Oracle Coherence based cache across the batch cluster. This file is generally not altered at the implementation level as it is preconfigured to execute the batch component of Oracle Utilities Smart Grid Gateway.
For details of the contents of this file refer to the Oracle Coherence Integration Guide.
e0Batch.properties - General Batch Properties
Note: This configuration file is generated and should not be altered unless instructed by Oracle Support.
This configuration file is used by the batch component to set the location of the installation and the location for any log files generated by the batch component.
This configuration file has two settings that are generated from the e0Batch.properties.template file located in templates directory:
Configuration Settings
Contents
standalone.dir
Location of batch installation
SPLOUTPUT
Location of output files
ejb-jar.xml - Enterprise Java Server Beans Configuration
The Business Application Server and MDB functionalities use Enterprise Java Server beans to implement service calls. By default, the behavior of these components is defined and controlled with the ejb-jar.xml configuration file.
This configuration file is generated by initialSetup using the templates/ejb-jar.xml.template file.
Note: This configuration file is typically NOT altered unless custom JMS or MDB resources are to be included in the servers within Oracle Utilities Smart Grid Gateway. Typically JMS resources are not included in the server Refer to Oracle WebLogic JMS Integration (Doc Id:1308181.1) for details of JMS or MDB advanced configuration.
ENVIRON.INI - Environment Configuration File
The ENVIRON.INI file is used by both the web application server and the business application server to define the environment and provide the basis for starting and stopping the environment. The file is created during the installation process and is used to generate other files. This file is maintained using the configureEnv utility provided in the installation. See configureEnv – Set up Environment Settings.
Warning: Do not alter the ENVIRON.INI manually. Always use configureEnv utility (see configureEnv – Set up Environment Settings) because additional configuration files depend on the settings in this file. If the configurations mismatch, improper operation of the product may occur.
Location of ENVIRON.INI file:
$SPLEBASE/etc/ENVIRON.INI
The file contents are in text format and are of the form:
<parameter>=<value>
Where:
<parameter>
Name of the configuration parameter.
<value>
Value of the configuration parameter.
For example:
…
appViewer=appViewer
DBCONNECTION=jdbc:oracle:thin:@myserver:1521:train
DBDRIVER=oracle.jdbc.driver.OracleDriver
…
The settings contained in the ENVIRON.INI file are outlined in ENVIRON.INI.
Extracting Information from ENVIRON.INI for Scripts
It is possible to write your own calls to the ENVIRON.INI using the same utilities used by Oracle Utilities Smart Grid Gateway to get values of configuration parameters for your own utilities. Do not hardcode values that can be obtained from ENVIRON.INI.
To obtain values of parameters use the command line:
perl $SPLEBASE/bin/getconfvalue.plx –k <parameter>
Where:
<parameter>
Name of configuration parameter from ENVIRON.INI you desire to get the value of.
For example:
ENVIRON.INI content:
…
DBNAME=TRAIN
…
Example call:
$ export DB=`perl $SPLEBASE/bin/getconfvalue.plx –k DBNAME`
$ echo $DB
TRAIN
Note: If the value is NOT set or the key is invalid the value of the call is null or blank.
hibernate.properties - Database Connectivity Settings
Opening a connection to a database is generally much less expensive than executing an SQL statement. A connection pool is used to minimize the number of connections opened between application and database. It serves as a librarian, checking out connections to application code as needed. Much like a library, your application code needs to be strict about returning connections to the pool when complete, for if it does not do so, your application will run out of available connections. Hence, the need for having a connection pooling mechanism such as Hibernate using Oracle Universal Connection Pool (UCP) connection pooling or JNDI based connection pooling.
The online and Web Service components of Oracle Utilities Smart Grid Gateway use JNDI based connection pools and the batch component uses UCP based connection pools.
Hibernate is a powerful Object Relational Mapping (ORM) technology that makes it easy to work with relational databases. Hibernate makes it seem as if the database contains plain Java objects, without having to worry about how to get them out of (or back into) database tables. Coupled with the UCP or JNDI connection pooler, it provides a comprehensive connectivity tool for the java to operate effectively against the database.
Oracle Utilities Smart Grid Gateway uses the Hibernate and either JNDI or UCP libraries to create a connection pool and connect the java objects to the database to store, update, delete and retrieve data. It is used for all the database access for online as well as batch.
Refer to http://www.hibernate.org and http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/htdocs/ucp.html for more information on the technology aspects of Hibernate and UCP.
Oracle Utilities Smart Grid Gateway has a configuration file for the database connectivity and pooling called the hibernate.properties configuration file. This file contains the configuration settings for the database connections and the connection pool to be used by any of the SQL statements accessing the database.
The configuration settings contained in the hibernate.properties file are summarized in the hibernate.properties section.
For a more indepth description of these parameters and others not included with the product see http://www.hibernate.org and http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/htdocs/ucp.html.
log4j2.properties – Product Logging Configuration
Note: This log file should not be altered unless specified. The generated configuration file has all the recommended settings for all sites.
Oracle Utilities Smart Grid Gateway uses the log4j2 Java classes to centralize all log formats into a standard format. The details of the configuration settings and log4j2 itself are available at https://logging.apache.org/log4j/2.x/.
Server Jar File (ouaf_jar_versions.txt)
Note: This configuration file is used for internal purposes and should not be altered unless instructed to do so by Oracle Support.
Note: Additional external jar files used for customizations do not need to be added to this file. This is used for base product verification only.
The java component of Oracle Utilities Smart Grid Gateway uses several industry standard jar files that are provided or used by the product. The etc/ouaf_jar_versions.txt lists the jar file that is used, and the required version used by the version of the product installed. This file is used at installation and runtime for integrity checks. If you wish to determine what version of an external jar is used then refer to this information file.
spl.properties – Product Behaviour Settings
Oracle Utilities Smart Grid Gateway web application has a specific number of settings outside of the JEE specification to control the internals of the product. This file exists as similar files exist for all modes of operation of the product (for example, Batch can be run outside the JEE web application server). Because of this a common configuration standard was adopted:
For a description of all settings in the spl.properties file refer to the spl.properties parameter descriptions.
submitbatch.properties - Submitter Configuration (BATCH)
Note: This is the default configuration file. Refer to the Configuring Batch Using Bedit section for a discussion of the role of this configuration and its variations
Each background process requires a configuration file to control its behavior. There are two levels of files that control the individual batch job executions:
• submitbatch.properties - This file sets the global settings for all batch jobs that are submitted. This file is in $SPLEBASE/splapp/standalone/config directory.
• <batchcode>.properties - This file is the same format as submitbatch.properties but contains any job specific settings and/or overrides to settings in the submitbatch.properties.
Note: Any command line options can override settings in any configuration file.
This file is generated using the bedit facility. See Configuring Batch Using Bedit.
tangosol-coherence-override.xml - Coherence Overrides (BATCH)
The tangosol-coherence-override.xml configuration file is used by the CLUSTERED mode of execution to override the settings for the Oracle Coherence based cache across the batch cluster. This file is generally not altered at the implementation level as it is preconfigured to execute the batch component of Oracle Utilities Smart Grid Gateway.
This file is generated using the bedit utility. See Configuring Batch Using Bedit.
For details of the contents of this file refer to the Oracle Coherence Integration Guide.
threadpoolworker.properties - Threadpool Configuration (BATCH)
Note: This is the default configuration file. Refer to the Configuring Batch Using Bedit section for a discussion of the role of this configuration and its variations
Each threadpoolworker requires a configuration file to control its behavior. This file is generated using the bedit facility for each type of threadpoolworker. See Configuring Batch Using Bedit.
Note: Any command line options on the threadpoolworker.sh utility can override settings in any configuration file. See threadpoolworker.sh - Manage Threadpools for details.
This file is generated using the bedit facility. See Configuring Batch Using Bedit for details.
web.xml – JEE Deployment Descriptor
Note: For Inbound Web Services, a resource version of this file is generated.
The web deployment descriptor editor lets you specify deployment information for modules created in the web development environment. The information appears in the web.xml file. The web.xml file for a web project provides information necessary for deploying a web application module. It is used in building a WAR/EAR file from a project.
The web application is controlled by a configuration file that holds behavioral information for the applications. Refer to http://jcp.org/en/jsr/detail?id=109 for more details of the format. For example:
…
<env-entry>
<description>Value of HTTP 1.1 max-age header parameter for JSPs</description>
<env-entry-name>maxAge</env-entry-name>
<env-entry-value>28800</env-entry-value>
<env-entry-type>java.lang.Integer</env-entry-type>
</env-entry>
<env-entry>
<description>How long to cache drop down values in seconds</description>
<env-entry-name>fieldValuesAge</env-entry-name>
<env-entry-value>3600</env-entry-value>
<env-entry-type>java.lang.Integer</env-entry-type>
</env-entry>
<env-entry>
<description>Is this a development environment</description>
<env-entry-name>isDevelopment</env-entry-name>
<env-entry-value>false</env-entry-value>
<env-entry-type>java.lang.Boolean</env-entry-type>
</env-entry>
<env-entry>
<description>Preload ALL Pages</description>
<env-entry-name>preloadAllPages</env-entry-name>
<env-entry-value>false</env-entry-value>
<env-entry-type>java.lang.Boolean</env-entry-type>
</env-entry>
<env-entry>
<description>Disable preloading of Pages</description>
<env-entry-name>disablePreload</env-entry-name>
<env-entry-value>false</env-entry-value>
<env-entry-type>java.lang.Boolean</env-entry-type>
</env-entry>
…
For application specific entries refer to the Web.xml parameter description on the Parameters appendix.
Note: It is highly recommended that you do not change this configuration file by extracting the configuration file from the WAR/EAR file using Java utilities, making the change manually and rebuilding the WAR/EAR file. Use initialSetup – Maintain Configuration Settings to build the WAR/EAR file as documented in the Web Application Server Configuration Process.
weblogic.xml – Oracle WebLogic Extensions
Note: For Inbound Web Services, a resource version of this file is generated.
For backward compatibility with Oracle WebLogic environments, an additional Oracle WebLogic configuration file weblogic.xml is generated and used to influence the Oracle WebLogic Server to exhibit additional behavior.
Parameter
Context
Source
context-root
The context-root element defines the context root of this stand-alone web application. If the Web application is part of an EAR, not stand-alone, specify the context root in the EAR's web.xml file. A context-root setting in web.xml takes precedence over context-root setting in weblogic.xml.
Defaults from template
java-charset-name
Specifies the Java character set to use.
Defaults from template (UTF-8)
page-check-seconds
Determines the interval at which a server checks to see if JSP files in a web application have changed and need recompiling. Used for development
Derived from WEB_WLPAGECHECKSECONDS parameter from ENVIRON.INI.
prefer-web-inf-classes
Loading of web classes from the WEB-INF are loaded in preference to system or Oracle WebLogic classes. Defaulted to false.
Defaults from template
resource-path
A path which, if included in the URL of a request, signals Oracle WebLogic Server to use the Java character set specified by java-charset-name.
Defaults from template
servlet-reload-check-secs
Defines whether an Oracle WebLogic Server will check to see if a servlet has been modified, and if it has been modified, reloads it. The -1 value tells the server never to check the servlets, 0 tells the server to always check the servlets, and the default is to check each 1 second.
A value specified in the console will always take precedence over a manually specified value.
Defaults from template
url-rewriting-enabled
Provides methods for configuring a JEE web application that is deployed on an Oracle WebLogic Server instance. Oracle WebLogic Server instantiates this interface only when you deploy a web application.
This interface can configure web applications that are deployed as a WAR file or an exploded directory.
Defaults from template (false)
Note: This configuration file is not usually altered by an implementation as it applies to development (SDK) platforms only. It is documented for completeness here.
Example:
<weblogic-web-app xmlns="http://www.bea.com/ns/weblogic/90">
<session-descriptor>
<url-rewriting-enabled>false</url-rewriting-enabled>
</session-descriptor>
<jsp-descriptor>
<page-check-seconds>43200</page-check-seconds>
</jsp-descriptor>
<container-descriptor>
<servlet-reload-check-secs>-1</servlet-reload-check-secs>
<prefer-web-inf-classes>true</prefer-web-inf-classes>
</container-descriptor>
<charset-params>
<input-charset>
<resource-path>/*</resource-path>
<java-charset-name>UTF-8</java-charset-name>
</input-charset>
</charset-params>
<context-root>/</context-root>
</weblogic-web-app>
weblogic-ejb-jar.xml - WebLogic Extensions for Enterprise Java Server Beans
WebLogic Server-specific EJB deployment descriptor that contains elements related to WebLogic Server features such as clustering, caching, and transactions. This file is required if your beans take advantage of WebLogic Server-specific features.
This file is coupled with the ejb-jar.xml configuration file using the standard weblogic-ejb-jar.xml schema. This configuration file is generated by the initialSetup – Maintain Configuration Settings using the templates/weblogic-ejb-jar.xml.template file.
Note: This configuration file is typically NOT altered unless custom JMS or MDB resources are to be included in the servers within Oracle Utilities Smart Grid Gateway. Typically JMS resources are not included in the server. See the Oracle WebLogic JMS Integration (Doc Id: 1308181.1) reference paper for details of JMS or MDB advanced configuration.
webservices.xml.resource - Web Services Configuration
Note: This file is automatically generated and should not be altered manually unless instructed by Oracle Support.
When using Inbound Web Services, a web services deployment descriptor, webservices.xml, must be generated to inform the JEE web application server of the web services.
This file is automatically generated from the template file webservices.xml.resource.iws.template located in the templates directory.