1 Introduction

This document provides information about templates, Java Archive (JAR) files that contain the files and scripts required to create or extend a domain.

This document contains the following topics:

Types of Templates

The types of template include:

  • Domain template—defines the full set of resources within a domain, including infrastructure components, applications, services, security options, and general environment and operating system options.

    The product installation includes a predefined Basic WebLogic Server Domain template. This template defines the core set of resources within a domain, including an Administration Server and basic configuration information. For more information on Basic WebLogic Server Domain template, see Basic WebLogic Server Domain Template.

    You can also create a custom domain template from an existing domain by using the Domain Template Builder or the pack command. By using the Domain Template Builder, you can also create a custom domain template from an existing template.

  • Extension template—defines the applications and services that you can add to an existing domain, including product component functionality and resources such as JDBC or JMS.

    The product installation includes several predefined extension templates. For a summary of extension templates, see Template Summary.

    You can also create a custom extension template from an existing domain or template using the Domain Template Builder.

  • Managed Server template – defines the subset of resources within a domain that are required to create a Managed Server domain directory on a remote machine.

    You can create a custom Managed Server template by using the pack command. For more information, see Oracle Fusion Middleware Creating Templates and Domains Using the Pack and Unpack Commands.

Location of Installed Templates

The following table identifies the location of the predefined templates provided with your product installation, where WL_HOME represents the product installation directory.

Table 1-1 Location of Templates

Type of Template Directory Location

Domain

WL_HOME\common\templates\domains

Extension

WL_HOME\common\templates\applications

Template Tools

The following table identifies the tools with which you can create templates and the tools with which you can use templates to create or extend a domain.

Table 1-2 Template Tools

To Use this tool

Create a domain

  • Configuration Wizard

  • WLST Offline

  • unpack command

Extend an existing domain

  • Configuration Wizard

  • WLST Offline

Create a managed server domain on a remote machine

unpack command

Create a domain template

  • Domain Template Builder

  • pack command

  • WLST Offline

Create an extension template

Domain Template Builder

Create a Managed Server template

pack command


Note:

All the tools used to create or extend a domain leverage a common underlying infrastructure, referred to as the Configuration Wizard framework.

Template Summary

The following tables summarizes the predefined templates that may be provided in your product installation.

Table 1-3 Summary of Oracle WebLogic Server and Workshop for WebLogic Templates

Template File name Description

Basic WebLogic Server Domain Template (Domain Template)

wls.jar

Creates a base WebLogic Server domain.

WebLogic Server Starter Domain Template (Domain Template)

wls_starter.jar

Creates a WebLogic Server starter domain.

WebLogic Advanced Web Services Extension Template

wls_webservice.jar

Extends an existing WebLogic Server domain to add functionality required for advanced Web Services, including WSRM, Buffering, and JMS Transport.

Avitek Medical Records Sample Domain Template

medrec.jar

Extends the Basic WebLogic Server domain to create the Avitek Medical Records sample domain. This domain is a WebLogic Server sample application suite that demonstrates all aspects of the J2EE platform.

Avitek Medical Records Sample Domain Template (Spring Version)

medrec-spring.jar

Extends the Basic WebLogic Server domain to create the Avitek Medical Records sample domain for Spring. This domain is a WebLogic Server sample application suite that demonstrates all aspects of the J2EE platform.

Oracle Workshop for WebLogic Extension Template

workshop_wl.jar

Extends the Basic WebLogic Server domain to create Oracle Workshop for WebLogic domain.

WebLogic Server Default Domain Extension Template

wls_default.jar

Extends the Basic WebLogic Server domain with a web application designed to guide new users through an introduction to WebLogic Server. When running the web application, users can review informative content on various topics, including highlights of WebLogic Server functionality. From the web application, users can also run several preconfigured, precompiled examples. Resources from this extension template are required for a WebLogic Server Examples domain.

WebLogic Server Examples Extension Template

wls_examples.jar

Extends the WebLogic Server domain containing resources from the base WebLogic Server domain template and the WebLogic Server Default Domain extension template to create a complete WebLogic Server Examples domain. The WebLogic Server Examples domain contains a collection of examples that illustrate best practices for coding individual J2EE and WebLogic Server APIs.

WebLogic Personalization Extension

p13n.jar

Extends an existing WebLogic Server domain to add Weblogic Personalization functionality.

WebLogic Content Extension

content.jar

Extends an existing WebLogic Server domain to add WebLogic Content Management functionality.


Relationships Between Templates

This section discusses the following topics:

WebLogic Server Resources as a Prerequisite

WebLogic Server resources must be set up in your domain before you can add resources from an extension template. When you select an extension template, the Configuration Wizard framework checks to make sure the required resources are available for you.

Relationships Between Templates

You can create a base WebLogic domain by using the predefined Basic WebLogic Server domain template, or you can create a Basic WebLogic domain and extend it incrementally using the extension templates. The following table shows the relationships between the templates and the domains created.

Table 1-4 Relationships Between Templates

This type of domain Requires resources from these templates

Avitek Medical Records Sample

Basic WebLogic Server Domain template, wls.jar

+ Avitek Medical Records Sample Domain extension template, medrec.jar

WebLogic Server (base)

Basic WebLogic Server Domain template, wls.jar

WebLogic Server (starter)

WebLogic Server Starter Domain template, wls_starter.jar

WebLogic Server Default

Basic WebLogic Server Domain template, wls.jar

+ WebLogic Server Default Domain extension template, wls_default.jar

WebLogic Server Examples

Basic WebLogic Server Domain template, wls.jar

+ WebLogic Server Default Domain extension template, wls_default.jar

+ WebLogic Server Examples extension template, wls_examples.jar

WebLogic Advanced Web Services Extension

Basic WebLogic Server Domain, wls.jar

+ WebLogic Advanced Web Services Extension, wls_webservice.jar

Oracle Workshop for WebLogic

Basic WebLogic Server Domain, wls.jar

+ Advanced Web Services Extension, wls_webservice.jar

+ Oracle Workshop for WebLogic Extension, workshop_wl.jar


Files Typically Included in a Template

The basic files included in any template are config.xml and template-info.xml. There are additional files in the predefined templates, and a domain is created or extended based on these files. The following table describes the files typically included in a domain or extension template.

Table 1-5 Files Included in a Template

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

Sets up or extends a domain with JDBC system resources required by a product component. In a template, the *-jdbc.xml files must be located in the config\jdbc directory.

*-jms.xml

Sets up or extends a domain with JMS system resources required by a product component. In a template, the *-jms.xml files must be located in the config\jms directory.

clusters.script

Used to modify the Configuration Wizard framework's default auto-configuration of a cluster. By default, resources are targeted to the cluster. You can unassign a resource from the cluster and then assign it to another component. To specify a target, you can use the following replacement variables:

  • %AManagedServer% — Any Managed Server

  • %AllManagedServers% — Comma-separated list of all Managed Servers

  • %AdminServer% — Administration Server name

  • %Cluster% — Cluster name

  • %ProxyServer% — Proxy server name

  • %HTTPProxyApp% — http proxy application definition

Note the following additional considerations:

  • You must use the name attribute of an object that is to be replaced.

  • You can use an asterisk (*) as a wildcard for "All."

In a template, the clusters.script file must be located in the script directory.

config.xml

Sets up or extends the domain configuration. In a template, the config.xml file must be located in the config directory.

jdbc.index

Identifies the locations of SQL scripts used to set up a database. The file lists the scripts in the order in which they must be run. If the scripts are not contained in the template, but are located in the product installation directory, that directory can be represented by a tilde ( ~ ) in the pathname for the scripts, as shown in the following example:

~/integration/common/dbscripts/oracle/reporting_runtime.sql

Specifically, the tilde represents the directory path identified by the $USER_INSTALL_DIR$ variable in the stringsubs.xml file.

In a template, a jdbc.index file must be located in the _jdbc_\dbtype\dbversion directory, where dbtype is the type of database, such as Oracle, and dbversion is the database version, such as 9i.

In addition to listing the SQL files related to a data source, the jdbc.index file contains information about the categories associated with the data source. The default dbCategories that are available are:

  • 'Drop/Create P13N Database Objects' category associated with the p13nDataSource data source, which is a part of the p13n.jar domain template

  • 'Drop/Create Portal Database Objects' category associated with the "p13nDataSource" data source, which is a part of the wlp.jar domain template

  • 'Drop/Create GroupSpace Database Objects' category associated with the appsGroupSpaceDataSource data source, which is a part of the wlp_groupspacedb.jar domain template

All these template jar files are located in the MW_HOME\wlserver_<version>\common\templates\applications directory.

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 in a domain template. However, you can create user groups and roles through the security.xml included in either a domain or an extension template.

startmenu.xml

Used to create Windows start menu entries.

startscript.xml

Used to create the *.cmd and *.sh files that are placed into a domain's root and bin directories.

stringsubs.xml

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 product installation directory.

template-info.xml

Provides template identification information, such as the template name, software version, type of template (domain or application), author, description, and so on.