weblogic.PlanGenerator Command Line Reference

Deploying Applications to WebLogic Server

weblogic.PlanGenerator Command Line Reference

weblogic.PlanGenerator is a Java-based deployment configuration tool intended for developers who want to export portions of a WebLogic Server deployment configuration into a deployment plan.

See also WebLogic Scripting Tool for information about performing deployment configuration operations using the WebLogic Scripting Tool (WLST).
The following sections describe how to use the weblogic.PlanGenerator utility:

Overview of weblogic.PlanGenerator
Required Environment for weblogic.PlanGenerator
Syntax for Invoking weblogic.PlanGenerator
Common weblogic.PlanGenerator Tasks

Overview of weblogic.PlanGenerator

weblogic.PlanGenerator generates WebLogic Server deployment configuration files for an application or stand-alone module. weblogic.PlanGenerator provides two primary functions:

Exporting different categories of WebLogic Server deployment descriptor properties into empty (null) variables in a template deployment plan. You can optionally use an existing deployment plan as input to the configuration export session. Template plans are generally modified further before they can be used. See Exporting an Application for Deployment to New Environments.
Generating a simple initial deployment plan from a J2EE application. See Generating a Template Deployment Plan using weblogic.PlanGenerator.

By default, weblogic.PlanGenerator writes an application's deployment plan to a file named plan.xml in the application's root directory. If your application is not in an application root directory, weblogic.PlanGenerator writes plan.xml to <your_dir>/config/deployments/<user>/<application_name>/plan where:

your_dir is your TEMP directory if it is specified in the property java.io.tmpdir. If the property java.io.tmpdir is not specified, your_dir is the WebLogic Server domain directory.
user is your user name.
application is the name of the application.

Required Environment for weblogic.PlanGenerator

To set up your environment to use the weblogic.PlanGenerator utility:

Install and configure the WebLogic Server software, as described in the WebLogic Server Installation Guide.
Add the WebLogic Server classes to the CLASSPATH environment variable, and ensure that the correct JDK binaries are available in your PATH. You can use the setWLSEnv.sh or setWLSEnv.cmd script, located in the server/bin subdirectory of the WebLogic Server installation directory, to set the environment.

Syntax for Invoking weblogic.PlanGenerator
java weblogic.PlanGenerator [Options] [filespec]
The filespec can be either:

An absolute or relative path to an archive file
An absolute or relative path to an exploded archive directory

Oracle recommends:

That you store your applications in an installation root directory.
That you specify an application's installation root directory, with the -root option as described in Options when you issue a weblogic.PlanGenerator command.

In all cases, the application identified with the filespec must contain valid J2EE deployment descriptor files.
If you do not specify an application root directory with the -root option or a deployment plan path and name with the -plan option, by default, weblogic.PlanGenerator writes an application's deployment plan to a file named plan.xml in the application's root directory. If it cannot locate an application root directory, weblogic.PlanGenerator writes plan.xml to <your_dir>/config/deployments/<user>/<application_name>/plan where:

your_dir is your TEMP directory if it is specified in the property java.io.tmpdir. If the property java.io.tmpdir is not specified, your_dir is the WebLogic Server domain directory.
user is your user name.
application is the name of the application.

Options

The following table describes each weblogic.PlanGenerator option.

Table B-1 weblogic.PlanGenerator Options
Option Description
-debug Enables debug mode.
-plan plan_file Identifies the path and name of the plan file to create for the configuration session.
-useplan plan_file Existing deployment plan file to initialize from. If you use -root to specify an application root directory, weblogic.PlanGenerator uses the /plan/plan.xml file in the root directory as input, if one is available; otherwise, weblogic.PlanGenerator creates a plan in the root directory. weblogic.PlanGenerator adds additional exported properties to the input plan; any exported properties that were already in the input plan are retained.
-root root_directory Application root directory on which to perform the plan generation or export.
category where valid values for category are:

-all
-configurables
-dependencies
-declarations
-dynamics
-none
Generates null variable definitions in a template deployment plan for different categories of deployment configuration property:

all—Creates a plan that exports all editable properties.
configurables—Creates a plan that exports all editable properties except dependencies and declarations.
dependencies—Creates a plan that exports all WebLogic Server descriptor properties that resolve external resource references. This is the default value.
declarations—Creates a plan that exports all properties that declare a resource to other applications and modules.
dynamics—Creates a plan that exports all properties that can be changed on-the-fly without requiring the application to be redeployed.
none—Creates a plan that exports no properties.

-variables [global | unique] Whether variable names created in the deployment plan can be used across all modules of an application, or only within a particular module. For example, a role assignment might be applied to an entire EAR, or to only a single Web application or other module within the EAR. By default, PlanGenerator creates global variables that apply to the entire application.

Common weblogic.PlanGenerator Tasks

The following sections describe common configuration and export tasks, with examples of weblogic.PlanGenerator syntax.

Creating an Initial Deployment Plan in an Application's Root Directory

If you store your application using an installation root directory, and you specify the root directory with the -root option, generated deployment plan files are automatically stored in the root directory's plan subdirectory.
java weblogic.PlanGenerator -root /appRelease/MyApplication
In the above example, the plan.xml file is automatically stored in /appRelease/MyApplication/plan.

Creating a New Deployment Plan Based on an Existing Plan

The following command uses an existing plan as input and generates a new plan in the /plan subdirectory of the application root directory:
java weblogic.PlanGenerator -useplan /plans/MyApplication_template.xml

     -root /appRelease/MyApplication
Controlling the Components Exported to a Deployment Plan

You can use the -all, -configurables, -dependencies, -declarations, -dynamics, and -none options to specify the WebLogic Server deployment descriptor components that are exported to a template deployment plan. The following command exports all configurable properties to null variables in a template deployment plan:
java weblogic.PlanGenerator -root /appRelease/MyApplication -all 
See Exporting an Application for Deployment to New Environments for more information about exporting a deployment configuration.

Option	Description
-debug	Enables debug mode.
-plan plan_file	Identifies the path and name of the plan file to create for the configuration session.
-useplan plan_file	Existing deployment plan file to initialize from. If you use -root to specify an application root directory, weblogic.PlanGenerator uses the /plan/plan.xml file in the root directory as input, if one is available; otherwise, weblogic.PlanGenerator creates a plan in the root directory. weblogic.PlanGenerator adds additional exported properties to the input plan; any exported properties that were already in the input plan are retained.
-root root_directory	Application root directory on which to perform the plan generation or export.
category where valid values for category are: -all -configurables -dependencies -declarations -dynamics -none	Generates null variable definitions in a template deployment plan for different categories of deployment configuration property: all—Creates a plan that exports all editable properties. configurables—Creates a plan that exports all editable properties except dependencies and declarations. dependencies—Creates a plan that exports all WebLogic Server descriptor properties that resolve external resource references. This is the default value. declarations—Creates a plan that exports all properties that declare a resource to other applications and modules. dynamics—Creates a plan that exports all properties that can be changed on-the-fly without requiring the application to be redeployed. none—Creates a plan that exports no properties.
-variables [global \| unique]	Whether variable names created in the deployment plan can be used across all modules of an application, or only within a particular module. For example, a role assignment might be applied to an entire EAR, or to only a single Web application or other module within the EAR. By default, PlanGenerator creates global variables that apply to the entire application.