Installation and Configuration Worksheets
Refer to the Server Administration Guide for additional details (default, valid values, usage, etc.), as applicable.
Menu Block 1: Environment ID, Roles, Third Party Software Configuration
The Environment ID, Roles, Third Party Software Configuration options include:
Menu Option
Name Used in Documentation
Customer Install Value
Environment ID
ENVIRONMENT_ID
 
Server Roles
SERVER_ROLES
 
Oracle Client Home Directory
ORACLE_CLIENT_HOME
 
Web Java Home Directory
JAVA_HOME
 
**ONS JAR Directory
ONS_JAR_DIR
 
Web Application Server Home Directory
WEB_SERVER_HOME
 
***Additional JAR Directory
WLTHINT3CLIENT_JAR_DIR
 
* ADF Home Directory
ADF_HOME
 
OIM OAM Enabled Environment
OPEN_SPML_ENABLED_ENV
 
* Denotes optional menu items that may be required for the product installation and variables.
** To activate the RAC FCF, the application needs the external ons.jar file, from the ORACLE_HOME path:
$ORACLE_HOME/opmn/lib/ons.jar
 
During the installation the relevant option should be populated with the folder location of the ons.jar.
Menu Block 2: Keystore Options
The keystore is a set of files used for encryption, decryption and hash generation. The files reside in the following location:
• <SPLEBASE>/ks/.ouaf_keystore
• <SPLEBASE>/ks/.ouaf_storepass
To run the application correctly, data encryption, decryption and hash generation of data in the database and on the application server must be performed using the same keystore; otherwise, the application will fail.
Starting Oracle Utilities Application Framework v4.4.0.0.0 the keystore and truststore options have been removed from the Menu and defaulted into the following template user exit that is loaded by all the properties files:
templates/FW_spl.properties.keystore.truststore.include
The user can still customize those options using the “Centralized Properties Customization”.
Upgrades from Oracle Utilities Application Framework versions below 4.4.0.0.0 will still use the keystore and truststore options recorded in the existing etc/ENVIRON.INI file (Menu options file).
Note: Populate the “Import Keystore Directory” option to import an existing keystore.
Keystore options include:
Menu Option
Name Used in Documentation
Customer
Install
Value
Import Keystore Directory
KS_IMPORT_KEYSTORE_FOLDER
 
Menu Block 50: Environment Installation Options
Environment installation options include:
Menu Option
Name Used in Documentation
Customer
Install
Value
Environment Mount Point
SPLDIR
 
Log File Mount Point
SPLDIROUT
 
Environment Name
SPLENVIRON
 
Install Application Javadocs
WEB_ISJAVADOCS
 
Install Sample CM Source Code
CM_INSTALL_SAMPLE
 
Menu Block 1: Environment Description
The environment description menu option includes:
Menu Option
Name Used in Documentation
Customer Install Value
Environment Description
DESC
 
Menu Block 2: [WebLogic] Business Application Server Configuration
WebLogic Business Application Server configuration options include:
Menu Option
Name Used in Documentation
Customer Install Value
Business Server Host
BSN_WLHOST
 
Business Server Application Name
BSN_APP
 
Menu Block 3: [WebLogic] Web Application Server Configuration
Refer to Server Administration Guide for additional details (default, valid values, usage, etc.)
WebLogic Web Application Server configuration options include:
Menu Option
Name Used in Documentation
Customer Install Value
Web Server Host
WEB_WLHOST
 
Weblogic SSL Port Number
WEB_WLSSLPORT
 
Weblogic Console Port Number
WLS_ADMIN_PORT
 
Web Context Root
WEB_CONTEXT_ROOT
 
WebLogic JNDI User ID
WEB_WLSYSUSER
 
WebLogic JNDI Password
WEB_WLSYSPASS
 
WebLogic Server Name
WEB_WLS_SVRNAME
 
Web Server Application Name
WEB_APP
 
This Is A Production Env. And The Client Is Live
WEB_ISLIVEPRODUCTION
 
Deploy Javadocs Module
WEB_DEPLOY_JAVADOCS
 
Enable The Unsecured Health Check Service
WEB_ENABLE_HEALTHCHECK
 
MDB RunAs User ID
WEB_IWS_MDB_RUNAS_USER
 
Super User Ids
WEB_IWS_SUPER_USERS
 
Menu Block 4 - Database Configuration
The parameters below and in the worksheet are for the database configuration. Note that if changes are made to any of the database menu option items below, thus potentially connecting to a different schema, a warning will be displayed in the screen next to the actual option that has been changed.
Menu Option
Name Used in Documentation
Customer
Install
Value
Application Server Database User ID
DBUSER
 
Application Server Database Password
DBPASS
 
Batch Database User ID
BATCH_DBUSER
 
Batch Database Password
BATCH_DBPASS
 
Web JDBC DataSource Name
JDBC_NAME
 
Database Name
DBNAME
 
Database Server
DBSERVER
 
Database Port
DBPORT
 
ONS Server Configuration
ONSCONFIG
 
Database Override Connection String
DB_OVERRIDE_CONNECTION
 
Character Based Database
CHAR_BASED_DB
 
Oracle Client Character Set NLS_LANG
NLS_LANG
 
Menu Block 5 - General Configuration Options
The general configuration options include:
Menu Option
Name Used in Documentation
Customer
Install
Value
Batch RMI Port
BATCH_RMI_PORT
 
RMI Port number for JMX Business
BSN_JMX_RMI_PORT_PERFORMANCE
 
RMI Port number for JMX Web
WEB_JMX_RMI_PORT_PERFORMANCE
 
JMX Enablement System User ID
BSN_JMX_SYSUSER
 
JMX Enablement System Password
BSN_JMX_SYSPASS
 
Coherence Cluster Name
COHERENCE_CLUSTER_NAME
 
Coherence Cluster Address
COHERENCE_CLUSTER_ADDRESS
 
Coherence Cluster Port
COHERENCE_CLUSTER_PORT
 
Coherence Cluster Mode
COHERENCE_CLUSTER_MODE
 
Menu Block 6 - OUAF TrustStore Options
Refer to the Oracle Utilities Application Framework Server Administration Guide for additional details on this configuration.
Starting Oracle Utilities Application Framework V4.4.0.0.0, the keystore and truststore options have been removed from the Menu and defaulted into the following template user exit that is loaded by all the properties files:
templates/FW_spl.properties.keystore.truststore.include
You can still customize those options using the “Centralized Properties Customization” option. Upgrades from Oracle Utilities Application Framework versions below 4.4.0.0.0 will still use the keystore and truststore options recorded in the existing etc/ENVIRON.INI file (Menu options file).
The OUAF truststore configuration is required for IWS.
Menu Option
Name Used in Documentation
Customer
Install Value
Import TrustStore Directory
TS_IMPORT_KEYSTORE_FOLDER
 
Advanced Menu Options
The advanced menu options are not available during installation. These options can be accessed after installation using the following commands:
Linux:
$SPLEBASE/bin/configureEnv.sh -a
 
Windows:
%SPLEBASE%\bin\configureEnv.cmd -a
Menu Block 50 - Advanced Environment Miscellaneous Configuration
The advanced environment miscellaneous configurations include:
Menu Option
Name Used in Documentation
Customer Value Install
OUAF DBMS Scheduler User
OUAF_DBMS_SCHEDULER_USER
 
WebLogic ThreadPoolWorker Enabled
WLS_THEADPOOLWORKERENABLED
 
Online JVM Batch Server Enabled
BATCHENABLED
 
Online JVM Batch Number of Threads
BATCHTHREADS
 
Online JVM Batch Scheduler Daemon Enabled
BATCHDAEMON
 
Enable Batch Edit Functionality
BATCHEDIT_ENABLED
 
Batch Online Log Directory
BATCH_ONLINE_LOG_DIR
 
JDBC Read Timeout
JDBC_TIMEOUT
 
Enable JMS Global Flush for Batch
ENABLE_JMS_GLOBAL_FLUSH
 
Add UsernameToken.xml
ADD_USERNAMETOKEN_XML
 
IWS deployment target
WLS_CLUSTER_NAME
 
Web Admin Server Host
WEB_ADMIN_SERVER
 
Split File Size in MB
TEMPSTORAGE_SPLITFILESIZE
 
GIS Service Running on the same Web Server
GIS
 
GIS Service URL
GIS_URL
 
GIS WebLogic System User ID
GIS_WLSYSUSER
 
GIS WebLogic System Password
GIS_WLSYSPASS
 
Online Display Software Home
ONLINE_DISPLAY_HOME
 
Max Queries To Hold In Cache Across All Threads
XQUERIES_TO_CACHE
 
Seconds Timeout Flush Cache Completely
XQUERY_CACHE_FLUSH_TIMEOUT
 
Malware Scan Host
MALWARE_SCAN_HOST
 
Malware Scan Port
MALWARE_SCAN_PORT
 
Malware Scan Timeout (Seconds)
MALWARE_SCAN_TIMEOUT
 
Menu Block 51 - Advanced Environment Memory Configuration
The advanced environment memory configurations include:
Menu Option
Name Used in Documentation
Customer Install Value
Global JVM Arguments
GLOBAL_JVMARGS
 
Ant Min Heap Size
ANT_OPT_MIN
 
Ant Max Heap Size
ANT_OPT_MAX
 
Ant Additional Options
ANT_ADDITIONAL_OPT
 
Thread Pool Worker Java Min Heap Size
BATCH_MEMORY_OPT_MIN
 
Thread Pool Worker Java Max Heap Size
BATCH_MEMORY_OPT_MAX
 
Thread Pool Worker Additional Options
BATCH_MEMORY_
ADDITIONAL_OPT
 
Menu Block 52 - Advanced Web Application Configuration
Advanced web application configurations include:
Menu Option
Name Used in Documentation
Customer Install Value
HTTP Allowed Methods
HTTP_ALLOWED_METHODS
 
Web Application Cache Settings
WEB_L2_CACHE_MODE
 
Web Server Port Number
WEB_WLPORT
 
CSRF Protection For REST Services
CSRF_PROTECTION
 
OWSM Protection For REST Services
OWSM_PROTECTION_FOR_REST_SERVICES
 
Domain Home Location
WLS_DOMAIN_HOME
 
Batch Cluster URL
WEB_BATCH_CLUSTER_URL
 
Strip HTML Comments
STRIP_HTML_COMMENTS
 
Authentication Login Page Type
WEB_WLAUTHMETHOD
 
Web Form Login Page
WEB_FORM_LOGIN_PAGE
 
Web Form Login Error Page
WEB_FORM_LOGIN_ERROR_
PAGE
 
Javadocs Login Page
WEB_JAVADOCS_FORM_LOGIN_PAGE
 
Javadocs Form Login Error Page
WEB_JAVADOCS_FORM_LOGIN_ERROR_PAGE
 
Web Security Role
WEB_ROLE_NAME
 
Web Principal Name
WEB_PRINCIPAL_NAME
 
Javadocs Security Role
WEB_JAVADOCS_ROLE_NAME
 
Javadocs Principal Name
WEB_JAVADOCS_PRINCIPAL_NAME
 
Use development Configuration
WEB_ISDEVELOPMENT
 
Preload All Pages on Startup
WEB_PRELOADALL
 
Maximum Age of a Cache Entry for Text
WEB_MAXAGE
 
Maximum Age of a Cache Entry for Images
WEB_MAXAGEI
 
JSP Recompile Interval (s)
WEB_
WLPAGECHECKSECONDS
 
Enable Strict Transport Security
 
 
Strict Transport Security Max Age
HSTS_MAX_AGE
 
Strict Transport Security Include Subdomains
HSTS_SUBDOMAINS
 
Strict Transport Security Preload
HSTS_PRELOAD
 
Oracle Guided Learning Id
ORACLE_GUIDED_LEARNING_ID
 
Menu Block 54 - WebLogic Diagnostics
WebLogic diagnostic options include:
Menu Option
Name Used in Documentation
Customer Install Value
Diagnostic Context Enabled
WLS_DIAGNOSTIC_CONTEXT_ENABLED
 
Menu Block 55 - URI, File and URL Related Options
URI, File and URL Related Options include:
Menu Option
Name Used in Documentation
Customer
Install
Value
Enable CORS For Embedded UI
ENABLE_CORS
 
Allowed Frame Ancestors Max Number
CORS_ALLOWED_FRAME_ANCESTORS_MAX_NUMBER
 
URI For Variable CSP_FRAME_ANS_HOST1
CORS_CSP_FRAME_ANS_
HOST1
 
URI For Variable CSP_FRAME_ANS_HOST2
CORS_CSP_FRAME_ANS_
HOST2
 
Custom URL For CSP img-src
CSP_URL_IMG_SRC
 
Custom URL For CSP script-src
CSP_URL_SCRIPT_SRC
 
Custom URL For CSP style-src
CSP_STYLE_SRC
 
Custom URL For CSP font-src
CSP_FONT_SRC
 
Custom URL For CSP connect-src
CSP_CONNECT_SRC
 
Custom URL For CSP frame-src
CSP_URL_FRAME_SRC
 
Custom URL For CSP form-action
CSP_FORM_ACTION_SRC
 
URI For Variable FA_DOMAIN
CORS_FA_DOMAIN
 
URI For Variable ALM_DOMAIN
CORS_ALM_DOMAIN
 
Restriction URLs Enable
CLOUD_RESTRICTION_URLS_ENABLE
 
Custom SQL Security
CUSTOM_SQL_SECURITY
 
White List Full Path
CLOUD_WHITE_LIST_PATH
 
Custom White List Full Path
CLOUD_CUSTOM_WHITE_LIST_PATH
 
Substitution Variable List File Location
CLOUD_SUBSTITUTION_VARIABLE_LIST_FILE_LOCATION
 
Directory For Variable F1_CMA_FILES
CLOUD_LOCATION_F1_MIGR_ASSISTANT_FILES
 
URI For Variable F1_OAUTH2_URI
CLOUD_LOCATION_F1_OAUTH2_URI
 
URI for Variable F1_BASE_REST_URL
CLOUD_LOCATION_F1_BASE_REST_URL
 
URI for Variable F1_OPEN_API_BASE_URL
CLOUD_LOCATION_F1_OPEN_API_BASE_URL
 
URI For Variable F1_BASE_WEB_URI
CLOUD_LOCATION_F1_BASE_WEB_URI
 
URI For Variable F1_BASE_IWS_URI
CLOUD_LOCATION_F1_BASE_IWS_URI
 
Consolidated Logfile Full Path
CONSOLIDATED_LOG_FILE_
PATH
 
Temporary File Location
TMP_FILE_LOCATION
 
Menu Block 57 - REST Settings for JMX
REST settings for JMX configurations include:
Menu Option
Name Used in Documentation
Customer Install Value
Enable/Disable REST Service For The JMX
JMX_REST_SERVICE_FLAG
 
Hostname To Run The REST Server
JMX_REST_SERVICE_HOST
 
Batch Port For REST Server
JMX_REST_PORT_BATCH
 
Web Port For REST Server
JMX_REST_PORT_WEB
 
Business Server Port For REST Server
JMX_REST_PORT_SERVICE
 
Server Context
JMX_REST_CONTEXT
 
SSL Flag
JMX_HTTPSSL_FLAG
 
Keystore File Path
JMX_HTTPSSL_KEYSTORE_
FILE
 
Keystore Type
JMX_HTTPSSL_KEYSTORE_
TYPE
 
Keystore Passphrase
JMX_HTTPSSL_KEYSTORE_
PASSPHRASE
 
Keypair Passphrase
JMX_HTTPSSL_KEYPAIR_
PASSPHRASE
 
Trust Store File Path
JMX_HTTPSSL_TRUSTSTORE_
FILE
 
Truststore Type
JMX_HTTPSSL_TRUSTSTORE_
TYPE
 
Truststore Passphrase
JMX_HTTPSSL_TRUSTSTORE_
PASSPHRASE
 
Http Server Username For Authentication
JMX_HTTP_REST_USERNAME
 
Http Server Password For Authentication
JMX_HTTP_REST_PASSWORD
 
Menu Block 58 - WebService Authentication Configuration
Web service authentication configurations include:
Menu Option
Name Used in Documentation
Customer Install Value
enable multispeak30 protocol
ENABLE_MULTISPEAK30
 
enable multispeak41 protocol
ENABLE_MULTISPEAK41
 
enable cim12 protocol
ENABLE_CIM12
 
enable cim20 protocol
ENABLE_CIM20