Oracle® Fusion Middleware: Domain Template Reference 12c Release 1 (12.1.2)
Oracle® Fusion Middleware: Domain Template Reference 12c Release 1 (12.1.2)
Oracle® Fusion Middleware: Domain Template Reference 12c Release 1 (12.1.2)
June 2013
This document provides information about WebLogic
domain and extension templates, which are Java archive
(JAR) files that contain the files and scripts required to create
or extend a WebLogic domain.
Contents
Preface ................................................................................................................................................................. v
Documentation Accessibility .....................................................................................................................
Conventions .................................................................................................................................................
v
v
1 Introduction
1.1
1.2
1.3
1.4
1.5
1.6
1.6.1
1.6.2
1.6.3
1.6.3.1
iii
2.7
2.7.1
2.7.2
2.8
2.8.1
2.8.2
2.9
2.9.1
2.9.2
2-12
2-12
2-12
2-14
2-14
2-15
2-17
2-17
2-17
iv
Preface
This preface describes the document accessibility features and conventions used in this
guide, Oracle Fusion Middleware Domain Template Reference.
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle
Accessibility Program website at
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.
Access to Oracle Support
Oracle customers have access to electronic support through My Oracle Support. For
information, visit
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are
hearing impaired.
Conventions
The following text conventions are used in this document:
Convention
Meaning
boldface
italic
monospace
vi
1
Introduction
This document provides information about Fusion Middleware domain and extension
templates, which are Java Archive (JAR) files that contain the files and scripts required
to create or extend a WebLogic domain.
This document contains the following topics:
Extension templatedefines the applications and services that you can add to an
existing domain, including product component functionality and resources such as
JDBC or JMS.
The WebLogic Server product installation includes several predefined extension
templates. The templates that are available to you in the Configuration Wizard
depend on the product you are installing. WebLogic Server installations include
the templates described in Section 2, "WebLogic Server Templates."
You can create a custom extension template from an existing domain or template
by using the Domain Template Builder.
Introduction 1-1
Location of Templates
Type of Template
Directory Location
WL_HOME\common\templates\wls
Fusion Middleware
Extension and
Reconfiguration
ORACLE_HOME\oracle _common\common\templates\wls
ORACLE_HOME\PRODUCT_HOME\common\templates\wls
Template Dependencies
Table 12
Template Tools
To
Create a domain
Configuration Wizard
WLST Offline
unpack command
Configuration Wizard
WLST Offline
unpack command
pack command
WLST Offline
pack command
Upgrade a domain
Reconfiguration Wizard
Note:
For information about using the Configuration Wizard, see Creating Domains Using
the Configuration Wizard.
For information about using the WLST Offline, see Understanding the WebLogic
Scripting Tool.
For information about using the pack/unpack commands, see Creating Templates
and Domains Using the Pack and Unpack Commands.
For information about using the Domain Template Builder, see Creating Domain
Templates Using the Domain Template Builder.
For information about using the Reconfiguration Wizard, see Upgrading Oracle
WebLogic Server.
Introduction 1-3
Filename
Description
product component
files
Various files used to complete the domain setup for a specific Oracle
product component. Such files may provide information for security
and default database settings.
*-jdbc.xml
*-jms.xml
Description
clusters.script
%Cluster%Cluster name
This file is not required. When used, it must be located in the script
directory. If it is not present, default targeting is used.
config.xml
config-groups.xml
Introduction 1-5
Description
database.xml
file-definition.xml
jdbc.index
security.xml
Used to create user groups and roles that establish identity and access
to domain resources. You can create the default Admin user only
through the security.xml file in a domain template. However, you can
create user groups and roles through the security.xml file included in
either a domain or an extension template.
startscript.xml
Used to create the *.cmd and *.sh files that are placed into a domain's
root and bin directories.
Description
startup-plan.xml
Environmental variables
WLS PRE_CLASSPATH
WLS POST_CLASSPATH
Identifies string substitution values and files that will receive string
substitutions during domain creation or extension. The files that will
receive string substitutions must already be prepared with
replacement variables. During domain creation or extension, the
Configuration Wizard framework runs macros to replace variables
with the appropriate string substitution, using information from WL_
HOME\common\lib\macrorules.xml, where WL_HOME is the
WebLogic Server installation directory.
template-info.xml
was-variable.xml
Some templates also contain a startup-plan.xml file, which defines server startup
parameters at a global (domain-wide) level or server group level.
Introduction 1-7
When you create a domain using multiple templates, the config-group.xml files from
all templates included in the domain are used to create the config-groups.xml file for
the domain.
Similarly, the startup-plan.xml files from all templates included in the domain are
merged to create the startup-plan.xml file for the domain. At domain creation, the
merged startup plan is used to generate the appropriate scripts for the domain.
The merged config-groups.xml and startup-plan.xml files are stored in the domain's
init-info directory.
Do not manually edit either the config-groups.xml or
startup-plan.xml files in the init-info directory.
Note:
The following sections describe each of these items in detail and how they work
together in a domain.
Note:
The config-groups.xml file in a Fusion Middleware product template may define the
domain profiles for the domain, in the profile attribute of the
<domain-topology> element. The domain profile can be either Compact (or
single-instance) or Expanded (clustered). If the <domain-topology> does not define
separate Custom and Expanded profiles, the configuration defined in
<domain-topology> is used for both types of domains.
The domain profile defines:
Note:
The application service groups that are targeted to each defined server group. All
servers that are assigned to a server group inherit its targets.
Whether or not a prefix is assigned to the name of any servers that are added to
the server group. For example, if a prefix of 'xyz' is defined for the server group,
and you add a server called 'server2' to the group, the server name is registered as
'xyz_server2'.
Table 14 describes the differences between Expanded and Compact domain profiles.
Table 14
Expanded Domain
Compact Domain
There are two ways to select the domain profile for a new domain:
When creating a domain using the FMW Configuration Wizard, you select the
profile to use on the Configuration Type screen. See "Configuration Type" in
Creating Domains Using the Configuration Wizard.
When creating a domain using WLST, you specify the profile to use in the
readTemplate command. See "readTemplate" in WebLogic Scripting Tool
Command Reference. The default profile type is Expanded.
1.6.2 Application Service Groups, Server Groups, and Application Service Mappings
The config-groups.xml file in Fusion Middleware templates may define application
service groups, server groups, and application service mappings. This automates the
assignment of applications and services to the appropriate servers in the domain.
Introduction 1-9
Server groups target Fusion Middleware applications and services to one or more
servers by mapping defined application service groups to each defined server group.
A given application service group may be mapped to multiple server groups if
needed. Any application services that are mapped to a given server group are
automatically targeted to all servers that are assigned to that group.
For example, suppose that the following items are defined in config-groups.xml:
Server group ADMIN-SVR (the server group for the Administration Server)
In this example, all applications and other resources that are defined in ADMIN-APPS
are targeted to the Administration Server. All applications and other resources that are
defined in MAIN-APPS are targeted to all Managed Servers. All libraries that are
defined in MAIN-LIBS are targeted to the Administration Server and all Managed
Servers.
Add a Server To or Remove a Server From a Server Group
You can use the WLST setServerGroups() command to add a server to any
user-expandable server group or any server group that you created. You can also
remove a server from any server group. The following examples demonstrate this.
a global startup definition, which defines the domain-wide startup settings for all
servers in the domain.
one or more server startup groups, which are associated with a server group. If
present, these define the startup settings for all servers assigned to the server
group. If a server startup group defines a setting that is already defined at the
global level, the server-level setting takes precedence.
Different startup settings may be defined for Expanded and Compact domain profiles.
In addition, when creating a domain, multiple templates may be applied to a domain.
Therefore, all possible startup settings and startup groups are combined into a single
startup-plan. xml file in the domain's /init-info directory. When you start a server,
this file is referenced to determine:
The startup group (if any) to which a server is assigned, based on the server group
to which the server is assigned and the startup group to which the server group is
assigned.
The startup settings to use for the server, based on the startup group to which the
server's server group is assigned.
If a server is not assigned to a server group, it is started using the global settings that
are defined in startup-plan.xml.
startup-plan.xml in Table 13 lists the startup parameters that may be configured in
this file.
Create your own startup groups to define unique startup parameters for one or
more servers in the domain.
Adjust the startup parameters for a server group.
Add a server to or remove a server from a startup group. Note that although you
can remove a server from a server group that is not user-modifiable, you can only
add a server to either a user-modifiable server group or a server group that you
have created.
The startup-plan.xml file for a domain is automatically updated with any changes you
make to the startup configuration.
Introduction 1-11
The following WLST example shows how to create a new startup group called
XYZ-MGD-SVRS based on server group JRF-MAN-SVR, add a server to the group,
and view and adjust the settings for the new group.
Example 11 Creating and Modifying a Startup Group
# Create a new startup group called XYZ-MGD-SVRS based on the startup settings
# for server group JRF-MAN-SVR
addStartupGroup('XYZ-MGD-SRVS', 'JRF-MAN-SVR')
# Set the startup group for my_server1 to XYZ-MGD-SRVS
setStartupGroup('my_server1', 'XYZ-MGD-SRVS')
# select the XYZ-MGD-SRVS startup group for modification
cd('/StartupGroupConfig/XYZ-MGD-SRVS')
# display the setting for MaxHeapSize
get('MaxHeapSize')
'1024'
# change the setting for MaxHeapSize
set('MaxHeapSize', '1536')
# get Java system properties for a startup group as a Python dictionary
dictionary = get('SystemProperties')
# set Java system properties for a startup group
dictionary['key.1'] = 'value.1'
dictionary['key.2'] = 'value.2'
set('SystemProperties',dictionary)
# get Java environment settings for a startup group as a Python dictionary
dictionary = get('EnvVars')
# set Java system properties for a startup group
dictionary['env.1'] = 'value.1'
dictionary['env.2'] = 'value.2'
set('EnvVars',dictionary)
2
WebLogic Server Templates
This chapter describes the following WebLogic domain templates that are provided
with your WebLogic Server installation. You can create or extend domains by selecting
these templates on the Select Domain Source or Select Extension Source screens of the
Oracle Fusion Middleware Configuration Wizard.
Table 21
Template
Description
WebLogic JAX-WS
SOAP/JMS Extension
Template
2-1
Table 21 (Cont.) Oracle WebLogic Server and Workshop for WebLogic Templates
Template
Description
WebLogic Server
Examples Extension
Template
Template Detail
Information
Template type
Domain
Template name
WL_HOME\common\templates\wls\wls.jar
Template
Dependencies
None
Table 23
Resource Type
Name
Notes
Administration
Server
AdminServer
SSL is disabled
myrealm
2-3
Table 24
Template Detail
Information
Template type
Domain
Template name in
Configuration Wizard
WL_HOME\common\templates\wls\wls_starter.jar
Template
Dependencies
Resource Type
Name
Notes
Administration
Server
AdminServer
SSL is disabled
myrealm
Name
Notes
Application
Deployments
wls_starter
Information
Template type
Extension
Category
Uncategorized
Template
Dependencies
WL_HOME\common\templates\wls\wls_webservice.jar
Reconfiguration
template JAR file and
location
WL_HOME\common\templates\wls\wls_webservice_reconfig_
version.jar
Domain topology
profiles
2-5
Table 27
Domain
Resource Type
Name
Extension Result
Administration
Server
AdminServer
SSL is enabled
myrealm
File Store
WseeFileStore
SAF Agent
JMS Queues
WseeMessageQueue
JMS Queues
WseeCallbackQueue
JMS Server
WseeJmsServer
Work Manager
Note:
For more information, see "Configuring Your Domain for Advanced Web Services
Features" in Developing JAX-WS Web Services for Oracle WebLogic Server.
Template Detail
Information
Template type
Extension
Category
Uncategorized
Template Dependencies
WL_HOME\common\templates\wls\wls_webservice_jaxws.jar
Reconfiguration template
JAR file and location
WL_HOME\common\templates\wls\wls_webservice_jaxws_
reconfig_version.jar
2-7
Table 29
Domain
Resource Type
Name
Extension Result
Administration
Server
AdminServer
SSL is enabled
myrealm
JMS Server
WseeJaxwsJmsServer
File Store
WseeJaxwsFileStore
JMS System
Resource
WseeJaxwsJmsModule
JMS Queues
SAF Agent
Work Manager
weblogic.wsee.jaxws.md
b.DispatchPolicy
Template Detail
Information
Template type
Extension
Category
Uncategorized
Template Dependencies
WL_HOME\common\templates\wls\wls_webservice_
soapjms.jar
Reconfiguration template
JAR file and location
WL_HOME\common\templates\wls\wls_webservice_
soapjms_reconfig_version.jar
Resource Type
Name
Extension Result
JMS server
WseeSoapjmsJmsServer
File store
WseeSoapjmsFileStore
JMS Module
WseeSoapjmsJmsModule
JMS
subdeployment
WseeSoapjmsJmsServerSub
JMS Connection
Factory
com.oracle.webservices.
jms.ConnectionFactory
JMS Queue
com.oracle.webservices.
api.jms.RequestQueue
2-9
Name
Extension Result
JMS Queue
com.oracle.webservices.
api.jms.ResponseQueue
Template Detail
Information
Template type
Extension
Template name in
Configuration Wizard
WL_HOME\common\templates\wls\medrec.jar
Template
Dependencies
Table 213
Resource
Type
Name
Administration AdminServer
Server
Extension Result
Uses the Administration Server provided in
the Base WebLogic Server domain. The
default name is AdminServer, unless
changed during domain creation. The
Administration Server is referenced in the
template as @SERVER_NAME, and appears
as AdminServer in the Administration
Console.
The default configuration for the
Administration Server is as follows:
SSL is enabled
myrealm
Application
Deployments
browser-starter
Application
Deployments
medrec
Application
Deployments
physician
Application
Deployment
SamplesSearchWebApp
JDBC Data
Sources
MedRecGlobalDataSourceXA
JMS Queues
com.oracle.medrec.jms.Record
ToCreateQueue
com.oracle.medrec.jms.Patient
NotificationQueue
weblogic.wsee.DefaultQueue
JMS Server
MedRecJMSServer
JMS System
Resources
MedRec-jms
Mail Session
mail/MedRecMailSession
Name
Extension Result
SAF Agent
WsrmAgent
Deployed
library
jsf1.2@1.2.9.0
Deployed
library
jstl1.2.@1.2.0.2
WLDF System
Resource
MedRecWLDF
Template Detail
Information
Template type
Extension
Template name
WL_HOME\common\templates\wls\medrec_spring.jar
Template
Dependencies
Table 215
Resource
Type
Name
Administration AdminServer
Server
Extension Result
Uses the Administration Server provided
in the base WebLogic Server domain. The
default name is AdminServer, unless
changed during domain creation. The
Administration Server is referenced in the
template as @SERVER_NAME, and
appears as AdminServer in the
Administration Console.
The default configuration for the
Administration Server is as follows:
SSL is enabled
myrealm
Application
Deployments
browser-starter
Application
Deployments
medrec
Application
Deployments
physician
Application
Deployment
SamplesSearchWebApp
JDBC Data
Sources
MedRecGlobalDataSourceXA
JMS Queues
JMS Servers
MedRecJMSServer
JMS System
Resources
MedRec-jms
Table 215 (Cont.) Resources Configured in an Avitek Medical Records Domain for
Resource
Type
Name
Extension Result
Mail Session
mail/MedRecMailSession
SAF Agent
WsrmAgent
Deployed
library
jsf1.2@1.2.9.0
Deployed
library
jstl1.2.@1.2.0.1
Deployed
library
WLDF System
Resource
MedRecWLDF
Note:
For more information about the samples that are supported in the WebLogic Server
Examples domain, see "Sample Application and Code Examples" in Understanding
Oracle WebLogic Server.
Template Detail
Information
Template type
Extension
Template name in
Configuration Wizard
Information
WL_HOME\common\templates\wls\wls_default.jar
Template
Dependencies
Extension Result
Administration
Server
AdminServer
SSL is disabled
myrealm
Application
Deployment
mainWebApp
Application
Deployment
examplesWebApp
Application
Deployment
entityBeanValidation
Application
Deployment
jsfBeanValidation
Application
Deployment
cdi
Application
Deployment
asyncMethodOfEJB
Application
Deployment
calendarStyledTimer
Application
Deployment
Extension Result
Application
Deployment
portableGlobalJNDIN
ame
Application
Deployment
singletonBean
Application
Deployment
jaxrs
Application
Deployment
stockAdapter
Application
Deployment
stockFrontEnd
Application
Deployment
stockBackEnd
Application
Deployment
jdbcDataSource.war
Application
Deployment
criteriaQuery
Application
Deployment
elementCollection
Application
Deployment
ajaxJSF
Application
Deployment
bookmarkingJSF
Application
Deployment
faceletsJSF
Application
Deployment
annotation
Application
Deployment
asyncServlet30
Application
Deployment
Application
Deployment
apache_xbean.jar
Application
Deployment
annotation
JDBC System
Resource
examples-demo
Initial capacity: 1
Maximum capacity: 10
Extension Result
JDBC System
Resource
examples-demoXA
JNDI Name:
examples-dataSource-demoXAPool
Global transaction protocol: Two Phase Commit
Deployed
library
apache-xbean.jar
Initial capacity: 2
Maximum capacity: 10
Template Detail
Information
Template type
Extension
Template name in
Configuration Wizard
WL_HOME\common\templates\wls\wls_examples.jar
Template
Dependencies
Table 219
Resource
Type
Name
Administration AdminServer
Server
Notes
Uses the Administration Server provided in the
Basic WebLogic Server domain. The default name
is AdminServer, unless changed during domain
creation. The Administration Server is referenced
in the template as @SERVER_NAME, and appears
as AdminServer in the Administration Console.
The default configuration for the Administration
Server is as follows:
SSL is disabled
myrealm
Application
Deployment
SamplesSearchWebApp
JMS Server
examplesJMSServer
JMS Server
WseeJMSServer
File Store
WseeFileStore
JDBC Store
exampleJDBCStore
JMS System
Resources
examples-jms
JMS
Connection
Factories
exampleTopic
exampleTrader
weblogic.examples.jms.Q
ueueConnectionFactory
weblogic.examples.ejb30.
QueueConnectionFactory
Table 219 (Cont.) Additional Resources Configured by the WebLogic Server Examples
Resource
Type
Name
Notes
JMS Queues
exampleQueue
jms/MULTIDATASOURC
E_MDB_QUEUE
weblogic.examples.ejb30.
ExampleQueue
JMS Queue
JMS Topics
exampleTopic
quotes
stockTopic
JDBC System
Resource
examples-oracleXA
JNDI name:
examples-dataSource-oracleXAPool
Global transaction protocol: Two Phase
Commit
examples-demoXA-2
SAF Agent
ReliableWseeSAFAgent
Work Manager
3
Fusion Middleware Product Templates
This chapter describes the WebLogic domain and extension templates that are used to
configure WebLogic domains for various Fusion Middleware product installations. For
most of these templates, you can create or extend domains by selecting the template on
the Templates screen of the Oracle Fusion Middleware Configuration Wizard. You can
also use the WebLogic Scripting Tool (WLST) in offline mode to create or extend
domains using these templates. See Section 1.3, "Template Tools," for more
information.
Your product installation includes only those templates that are relevant to your
product. Some templates in this chapter, such as the Oracle JRF template, apply to
domains for multiple Fusion Middleware products. Other templates apply only to
domains for a single Fusion Middleware product, and are therefore not included with
any other Fusion Middleware product installations.
This chapter contains the following sections:
When creating your product domain using the Configuration Wizard, you can
select the domain and extension templates concurrently for the products you want
to install.
Note:
Template Detail
Information
Template type
Extension
Category
Oracle
Information
ORACLE_HOME/oracle_
common/common/templates/wls/oracle.jrf_template_12.1.2.jar
Template Detail
Information
Template type
Extension
Category
Oracle
Template
Dependencies
ORACLE_HOME/oracle_
common/common/templates/wls/oracle.jrf.ws.async_template_
12.1.2.jar
Template Detail
Information
Template type
Extension
Category
Oracle
Template
Dependencies
Information
ORACLE_HOME/oracle_
common/common/templates/wls/oracle.jrf.ws.soapjms_template_
12.1.2.jar
Template Detail
Information
Template type
Extension
Template
Dependencies
ORACLE_HOME/oracle_
common/common/templates/wls/oracle.opss_template_12.1.2.jar
Template Detail
Information
Template type
Extension
Template
Dependencies
None
ORACLE_
HOME/jdeveloper/common/templates/jdeveloper/adf.fine.logging
_12.1.2.jar
Coherence Template
Note:
Template Detail
Information
Template type
Extension
Template
Dependencies
This template consists of multiple template JAR files. These JAR files
are located in the following directory after you install Oracle Fusion
Middleware:
ORACLE_HOME/em/common/templates/wls
The template consists of the following JAR files in the templates
directory:
oracle.em_wls_template_12.1.2.jar
oracle.emas_wls_template_12.1.2.jar
Template Detail
Information
Template type
Extension Template
Information
Template
Dependencies
Template JAR file and
location
WL_HOME/common/templates/applications/wls_coherence.jar
Note:
Template Detail
Information
Template type
Extension
Template
Dependencies
Template JAR file and
location
ORACLE_HOME/oracle_
common/common/templates/wls/oracle.wsmpm_template_
12.1.2.jar
You can configure the Coherence cluster with either Well Known Addresses (WKA) or
multicast communication. If you do not specify a communication type, WKA is set as
for cluster communication.
Oracle Virtual Assembly Builder Deployer uses Coherence cluster data partitioning to
distribute work. The deployerId is used as a key association, where all data specific
to a particular deployment id is guaranteed to exists on the same node. When you
initiate an asynchronous request (such as a deploy, undeploy, or scale operation), the
request is handled by the node on which the data is partitioned at that time. The same
node handles the request even if data gets repartitioned to another node.
If a node with running requests goes down or crashes, the requests are cancelled,
because none of the Deployer asynchronous operations are idempotent. That is, if a
request is initiated, it cannot be rolled back because the work is distributed amongst
multiple tiers.
You must re-initiate such requests by cleaning up the previous state. For example: if a
deploy operation gets cancelled, the corresponding deployment object is marked as
'Failed' with the reason as 'cancelled'. You must invoke an explicit cleanup operation
by the to cleanup the deployment, then create another deployment object and start the
deploy operation.
With the compact domain topology profile, this template provides for a standalone
Oracle Virtual Assembly Builder Deployer.
The following table provides key information about this template.
Table 39
Template Detail
Information
Template type
Extension
Category
Uncategorized
Template
Dependencies
OVAB_
HOME/common/templates/wls/oracle.ovab.deployer.template_
12.1.2.jar
Domain topology
profiles
Note:
Template Detail
Information
Template type
Extension
Category
Template
Dependencies
Template JAR file and
location
ORACLE_HOME/odi/common/templates/wls/odi_cam_
unmanaged_template_12.1.2.jar
Template Detail
Information
Template type
Extension
Category
Template
Dependencies
Template JAR file and
location
ORACLE_HOME/odi/common/templates/wls/odi_cam_managed_
template_12.1.2.jar
Table 312
Template Detail
Information
Template type
Extension
Category
Template
Dependencies
Template JAR file and
location
ORACLE_HOME/odi/common/templates/wls/odi_agent_
template_12.1.2.jar
Template Detail
Information
Template type
Extension
Category
Template
Dependencies
Template JAR file and
location
ORACLE_HOME/odi/common/templates/wls/odi_agent_libraries_
template_12.1.2.jar
Template Detail
Information
Template type
Extension
Category
Template
Dependencies
Template JAR file and
location
ORACLE_HOME/odi/common/templates/wls/odi_repository_
explorer_template_12.1.2.jar
Template Detail
Information
Template type
Extension
Category
Oracle
Template
Dependencies
ORACLE_HOME/em/common/templates/wls/oracle.em_odi_
template_12.1.2.jar
Template Detail
Information
Template type
Extension
Category
Uncategorized
Template Dependencies
MW_HOME/ohs/common/templates/wls/ohs_managed_
template_12.1.2.jar
Category
Undefined
Template Detail
Information
Template type
Extension
Category
Template Dependencies
None
MW_HOME/ohs/common/templates/wls/ohs_standalone_
template_12.1.2.jar
None defined.
Server groups
Undefined
3-11