Plug-in Documentation

Oracle WebLogic WLDeploy

Overview

The Oracle WLDeploy plug-in automates managing and deploying applications to one or more WebLogic servers. You can complete the following tasks with the plug-in:

  • Start and stop a WebLogic server
  • Check the status of an application
  • Determine the available applications on a WebLogic server
  • Deploy an application to a WebLogic server

The plug-in includes the following steps:

Compatibility

This plug-in requires IBM UrbanCode Deploy version 6.0.1 or later.

This plug-in supports Oracle WebLogic server version 10.3 and later.

This plug-in runs on all operating systems that UrbanCode Deploy supports.

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode products.

History

Version 24.971637

  • Fixed APAR PI93543 List Applications on Target step resulting in JSONException.
  • Removed all unnecessary stream handling of input properties files.

Version 23.971404

  • Updated auto-discovery to search the MW_HOME environment variable for a weblogic installation.
  • Changed the wldeploy.path and wldeploy.mwHome Auto Discovery fields to derive from agent properties.

Version 22.947258

  • Fixed APAR PI90465 UCD encrypted output properties require decryption key.

Version 21.909738

  • Removed unused URLs from steps.
  • Fixed NullPointer issue on auto discovery.
  • Stop Target step now fails when given invalid target name.
  • Run WLDeploy step will not throw error when given unexpected parameters.
  • List Applications step now returns correct applications.
  • Wait For Application step now avoids infinite loop.

Version 19.897205

Version 19.897205 includes the following features and fixes:

  • Added timeout property to Stop Targets step.
  • Fixed Run WLDeploy step so System Properties can be passed in.

Version 18.891315

Version 18.891315 includes the following features and fixes:

  • Fixed bug in start/stop steps involving starting and stopping clusters that are already in desired state.

Version 17.885521

Version 17.885521 includes the following features and fixes:

  • Fixed infinite loop errors in starting/stopping clusters.

Version 16.868519

Version 16.868519 includes the following features and fixes:

  • Added support for property file encryption.
  • Added support for different inputs of JMX URL.

Version 15.844984

Version 15.844984 includes the following features and fixes:

  • Fixed problem involving mismatched Groovy versions causing java errors.

Version 14.830557

Version 14.830557 includes the following features and fixes:

  • Added auto-discovery of a WebLogic installation and auto-configuration of all domains, servers, and clusters managed by the administration server.

Version 13.799123 of the plug-in was released on June 21, 2016

Version 13.712081

Version 13.712081 includes the following features and fixes:

  • Added ability to fail or warn when Start Targets step fails to start one or more targets.
  • Fixed defect in Stop Target step. The step no longer fails when a target is already in SHUTDOWN state.

Version 12.699360

Version 12.699360 includes the following features and fixes:

  • Fixes APAR PI48310. Added a property on Start Targets step to set timeout length for starting targets.
  • A new output property is set for each target in the step and contains the value of the state of the target.
  • Added a property to the Run WLDeploy step that contains the path to the configuration file where the encrypted user name and password are stored.
  • Added ability to set JAVA_HOME system environment variable.

Steps

Process steps in the Oracle WebLogic WLDeploy plug-in

Check Application on Targets

Check the status of an application on target servers and clusters

Input properties for the Check Application on Targets step
Name Type Description Required
Additional System Properties String A new-line separated list of Java system properties to be added on the command line.
Specify each property in this format: property=value. The property is added to the
command line as follows: -Dprop=value.
No
Administration URL String The administration URL of the WebLogic server. Yes
Application Name String The name of the application. Yes
Expected Status String The status string to check against. Yes
JAVA_HOME String The fully qualified path to the Java installation. Provide a value to overwrite the
JAVA_HOME environment variable. If this property is not specified, the default value
is the system environment variable.
No
JMX Administration URL String The jmx administration URL of the WebLogic server. This is used when starting, stopping,
and checking status of targets.
No
Password Password The password to use to connect to the WebLogic server. If the user name and password
are encrypted, leave this property blank and specify the User Configuration File and
User Key File properties.
No
Targets String A comma-separated list of target servers to deploy to. For example: target1,target2. Yes
User Config File String The path to the configuration file where the encrypted user name and password are
stored.
No
User Key File String The path to the key file where the decryption key for the user name and password are
stored.
No
User Name String The user name to use to connect to the WebLogic server. If the user name and password
are encrypted, leave this property blank and specify the User Configuration File and
User Key File properties.
No
WLDeploy Ant Task JAR String The fully-qualified path to the WebLogic WLDeploy Ant Task JAR file or full client
JAR file. This property is required when you start, stop, and check the status of
targets.
Yes

Check Targets

Examine target servers for the RUNNING status. This step will only succeed if all specified servers are RUNNING.

Input properties for the Check Targets step
Name Type Description Required
Additional System Properties String A new-line separated list of Java system properties to be added on the command line.
Specify each property in this format: property=value. The property is added to the
command line as follows: -Dprop=value.
No
Administration URL String The administration URL of the WebLogic server. Yes
JAVA_HOME String The fully qualified path to the Java installation. Provide a value to overwrite the
JAVA_HOME environment variable. If this property is not specified, the default value
is the system environment variable.
No
JMX Administration URL String The JMX administration URL of the WebLogic server. This URL is used when you start,
stop, and check the status of targets.
No
Password Password The password to use to connect to the WebLogic server. If the user name and password
are encrypted, leave this property blank and specify the User Configuration File and
User Key File properties.
No
Targets String Specify a comma-separated list of servers to check for a RUNNING status. For example: target1,target2. Yes
User Configuration File String The path to the configuration file where the encrypted user name and password are
stored.
No
User Key File String The path to the key file where the decryption key for the user name and password are
stored.
No
User Name String The user name to use to connect to the WebLogic server. If the user name and password
are encrypted, leave this property blank and specify the User Configuration File and
User Key File properties.
No
WLDeploy Ant Task JAR String The fully-qualified path to the WebLogic WLDeploy Ant Task JAR file or full client
JAR file. This property is required when you start, stop, and check the status of
targets.
Yes

List Applications on Targets

List all AppDeployments for each target and set as output properties.

Input properties for the List Applications on Targets step
Name Type Description Required
Additional System Properties String A new-line separated list of Java system properties to be added on the command line.
Specify each property in this format: property=value. The property is added to the
command line as follows: -Dprop=value.
No
Administration URL String The administration URL of the WebLogic server. Yes
JAVA_HOME String The fully qualified path to the Java installation. Provide a value to overwrite the
JAVA_HOME environment variable. If this property is not specified, the default value
is the system environment variable.
No
JMX Administration URL String The JMX administration URL of the WebLogic server. This URL is used when you start,
stop, and check the status of targets.
No
Password Password The password to use to connect to the WebLogic server. If the user name and password
are encrypted, leave this property blank and specify the User Configuration File and
User Key File properties.
No
Targets String A comma-separated list of target servers to deploy to. For example: target1,target2. Yes
User Configuration File String The path to the configuration file where the encrypted user name and password are
stored.
No
User Key File String The path to the key file where the decryption key for the user name and password are
stored.
No
User Name String The user name to use to connect to the WebLogic server. If the user name and password
are encrypted, leave this property blank and specify the User Configuration File and
User Key File properties.
No
WLDeploy Ant Task JAR String The fully-qualified path to the WebLogic WLDeploy Ant Task JAR file or full client
JAR file. This property is required when you start, stop, and check the status of
targets.
Yes

Run WLDeploy

Run a WLDeploy Ant task.

Input properties for the Run WLDeploy step
Name Type Description Required
Additional Properties String A new-line separated list of additional properties to be used as part of the wldeploy
Ant task. Use this format: property_name=value\nname=value\n.
No
Additional System Properties String A new-line separated list of Java system properties to be added on the command line.
Specify each property in this format: property_name=value. The property is added to
the command line as follows: -Dproperty_name=value.
No
Administration URL String The administration URL of the WebLogic server. Yes
Alternate Application Descriptor String The alternate application descriptor file name. No
Alternate WLS Application Descriptor String The alternate WebLogic server application descriptor file name. No
Application Name String The name of the application. Yes
Application Version String The version of the application that is specified in the Alternate WLS Application
Description property.
No
Deployment Plan String The name of the deployment plan. No
Deployment Plan Version String The version of the deployment plan that is specified in the Deployment Plan property. No
JAVA_HOME String The fully qualified path to the Java installation. Provide a value to overwrite the
JAVA_HOME environment variable. If this property is not specified, the default value
is the system environment variable.
No
JMX Administration URL String The JMX administration URL of the WebLogic server. This URL is used when you start,
stop, and check the status of targets.
No
Operation Enumeration:

  • deploy
  • undeploy
  • distribute
  • redeploy
  • start
  • stop
The wldeploy Ant task action to perform. Yes
Password Password The password to use to connect to the WebLogic server. If the user name and password
are encrypted, leave this property blank and specify the User Configuration File and
User Key File properties.
No
Remote Boolean Enable this property if you are deploying to a remote computer that is not the same
computer that this agent runs on.
No
Retire Timeout String The timeout value that specifies when to retire the currently running version. Specify
this property if the wldeploy task is start, redeploy, or deploy.
No
Source to deploy String The fully qualified path of the source to deploy. No
Targets String A comma-separated list of the names of target servers to deploy to. For example: target1,target2. Yes
Task ID String The id for looking up the task. No
User Config File String The path to the configuration file where the encrypted user name and password are
stored.
No
User Key File String The path to the key file where the decryption key for the user name and password are
stored.
No
User Name String The user name to use to connect to the WebLogic server. If the user name and password
are encrypted, leave this property blank and specify the User Configuration File and
User Key File properties.
No
WLDeploy Ant Task JAR String The fully-qualified path to the WebLogic WLDeploy Ant Task JAR file or full client
JAR file. This property is required when you start and stop the WebLogic server.
Yes

Start Targets

Start the target server and clusters

Input properties for the Start Targets step
Name Type Description Required
Additional System Properties String A new-line separated list of Java system properties to be added on the command line.
Specify each property in this format: property=value. The property is added to the
command line as follows: -Dprop=value.
No
Administration URL String The administration URL of the WebLogic server. Yes
JAVA_HOME String The fully qualified path to the Java installation. Provide a value to overwrite the
JAVA_HOME environment variable. If this property is not specified, the default value
is the system environment variable.
No
JMX Administration URL String The JMX administration URL of the WebLogic server. This URL is used when you start,
stop, and check the status of targets.
No
On Failure Enumeration:

  • fail
  • warn
Choice of action when any of the targets fail to start. (Fail:
Step will attempt to start all targets, and will fail at the end if any of the targets
failed to start. Warn: Step will continue on if an override failure
occurs, and print a warning declaring the target that failed to start.)
Yes
Password Password The password to use to connect to the WebLogic server. If the user name and password
are encrypted, leave this property blank and specify the User Configuration File and
User Key File properties.
No
Targets String A comma-separated list of the names of the target servers to deploy to. For example:
target1,target2.
Yes
Timeout String The time after which the attempt to start the targets times out. Specify the value
in seconds. The default value is 2 minutes.
Yes
User Configuration File String The path to the configuration file where the encrypted user name and password are
stored.
No
User Key File String The path to the key file where the decryption key for the user name and password are
stored.
No
User Name String The user name to use to connect to the WebLogic server. If the user name and password
are encrypted, leave this property blank and specify the User Configuration File and
User Key File properties.
No
WLDeploy Ant Task JAR String The fully-qualified path to the WebLogic WLDeploy Ant Task JAR file or full client
JAR file. This property is required when you start, stop, and check the status of
targets.
Yes

Stop Targets

Stop the target server and clusters

Input properties for the Stop Targets step
Name Type Description Required
Additional System Properties String A new-line separated list of Java system properties to be added on the command line.
Specify each property in this format: property=value. The property is added to the
command line as follows: -Dprop=value.
No
Administration URL String The administration URL of the WebLogic server. Yes
Force Boolean Use the force shutdown command instead of a simple shutdown command. Yes
JAVA_HOME String The fully qualified path to the Java installation. Provide a value to overwrite the
JAVA_HOME environment variable. If this property is not specified, the default value
is the system environment variable.
No
JMX Administration URL String The JMX administration URL of the WebLogic server. This URL is used when you start,
stop, and check the status of targets.
No
Password Password The password to use to connect to the WebLogic server. If the user name and password
are encrypted, leave this property blank and specify the User Configuration File and
User Key File properties.
No
Targets String A comma-separated list of target servers to deploy to. For example: target1,target2. Yes
User Configuration File String The path to the configuration file where the encrypted user name and password are
stored.
No
User Key File String The path to the key file where the decryption key for the user name and password are
stored.
No
User Name String The user name to use to connect to the WebLogic server. If the user name and password
are encrypted, leave this property blank and specify the User Configuration File and
User Key File properties.
No
WLDeploy Ant Task JAR String The fully-qualified path to the WebLogic WLDeploy Ant Task JAR file or full client
JAR file. This property is required when you start, stop, and check the status of
targets.
Yes

Wait for Application on Targets

Wait for the status of application on target servers and clusters to be running

Input properties for the Wait for Application on Targets step
Name Type Description Required
Additional System Properties String A new-line separated list of Java system properties to be added on the command line.
Specify each property in this format: property=value. The property is added to the
command line as follows: -Dprop=value.
No
Administration URL String The administration URL of the WebLogic server. Yes
Application Name String The name of the application. Yes
Expected Status String The status string to should check against. Yes
JAVA_HOME String The fully qualified path to the Java installation. Provide a value to overwrite the
JAVA_HOME environment variable. If this property is not specified, the default value
is the system environment variable.
No
JMX Administration URL String The JMX administration URL of the WebLogic server. This URL is used when you start,
stop, and check the status of targets.
No
Password Password The password to use to connect to the WebLogic server. If the user name and password
are encrypted, leave this property blank and specify the User Configuration File and
User Key File properties.
No
Targets String A comma-separated list of target servers to deploy to. For example: target1,target2. Yes
User Configuration File String The path to the configuration file where the encrypted user name and password are
stored.
No
User Key File String The path to the key file where the decryption key for the user name and password are
stored.
No
User Name String The user name to use to connect to the WebLogic server. If the user name and password
are encrypted, leave this property blank and specify the User Configuration File and
User Key File properties.
No
WLDeploy Ant Task JAR String The fully-qualified path to the WebLogic WLDeploy Ant Task JAR file or full client
JAR file. This property is required when you start, stop, and check the status of
targets.
Yes

Usage

Use the WLDeploy plug-in to deploy, remove, or redeploy Java applications on a WebLogic server or cluster as a step in your deployment process. You can design your process to start and stop WebLogic servers or clusters and query the server about the status of an application.

With the Run WLDeploy step, you can run the Oracle wldeploy Ant Task, and you can specify wldeploy attributes in the step. For details of the available attributes, see the wldeploy Ant Task Reference.

Before you begin

Verify that a Java SDK is installed.

Step palette

To access this plug-in in the palette, click Application Server > Java > WebLogic WLDeploy.

WebLogic Auto-Discovery

For an in-depth tutorial on using auto-discovery with WebLogic, please read the blog post:

Auto-Discovery with WebLogic