You can install an enterprise application file on an application server or cluster by dragging or copying an enterprise archive (EAR), web application
archive (WAR), Java™ archive (JAR), or Session Initiation
Protocol (SIP) archive (SAR) to a monitored directory. An enterprise application file must conform
to the Java Platform, Enterprise Edition (Java EE) specification.
Before you begin
Develop and assemble the EAR, JAR, WAR, or SAR file. You can use a supported assembly tool such
as an IBM®
Rational® Application Developer for WebSphere® Software product to specify bindings and assemble the file.
Installing an EAR, JAR, WAR, or SAR file by adding it to a monitored directory does not change
existing Java Naming and Directory (JNDI) and other
application bindings. If you must set binding values during deployment, install the file using the
administrative console application installation wizard, a wsadmin script, or a properties file that
sets bindings. See Installing enterprise
application files by adding properties files to a monitored directory.
By default, monitored directory deployment is not enabled. Before you can use monitored directory
deployment, you must enable it. See Setting monitored
directory deployment values.
Restriction:
- Installing an EAR, JAR, WAR, or SAR file by adding it to a monitored directory is available only
on distributed and z/OS® operating systems. It is not
supported on IBM i operating systems.
- Because you can use only one server directory, drag and drop to map applications
to combinations of servers is limited. Scenarios requiring use of more than one server, such as
mapping to an application server and a web server, are not supported by direct drag and drop of an
application file.
Avoid trouble: Do not use monitored directory deployment in a
production environment where the application must remain continuously available. Instead, in
production environments, use an automated process that staggers application updates to each
application server by first draining requests from each server, updating the application, and then
restarting the server. For information about this automated process, see IBM
WebSphere Developer Technical Journal: Maintain
continuous availability while updating WebSphere
Application Server enterprise applications.
About this task
You can deploy an EAR, JAR, WAR, or SAR file to an application server or
cluster by dragging or copying the file to a monitored directory.
For base (stand-alone) application servers, the monitored directory is the
monitoredDeployableApps/servers/server_name directory of the
application server profile.
For deployment managers, the monitored directories are the
monitoredDeployableApps/servers/server_name,
monitoredDeployableApps/nodes/node_name/servers/server_name,
and monitoredDeployableApps/clusters/cluster_name
directories of the deployment manager profile.
The product scans a monitored directory for new applications no more frequently than every five
seconds, by default. After finding a new EAR, JAR, WAR, or SAR file in a monitored directory, the
product installs the file on the application server or cluster and starts
the application or module.
After you add an EAR file to a monitored directory, the product creates a temporary copy of the
EAR file in another directory and installs the file on the server. After you add a JAR, WAR, or SAR
file to a monitored directory, the product creates a temporary copy of the archive in another
directory, wraps the archive in an EAR file named
archive_extension.ear, and installs the new EAR file. For
example, simpleApp.war is installed as simpleApp_war.ear.
The original archive that you added to the monitored directory is not changed.
You can update application files the same way. If you later add an updated EAR, JAR, WAR, or SAR
file to the same monitored directory, the product stops the previously deployed application,
installs the updated file on the application server or cluster, and starts
the updated application or module. For example, suppose you previously deployed
my_app.ear by dragging it to a monitored directory. If you later drag a file
named my_app.ear to the monitored directory, the product replaces the
previously deployed EAR file with the updated EAR file that has the same name. The server or cluster must be running for the product to notice changes to files in its
monitored directory.
You can use a graphical file browser to drag or copy the EAR, JAR, WAR, or SAR file.
Alternatively, you can use operating system commands to copy a file into a monitored
monitoredDeployableApps subdirectory.
Procedure
- Ensure that the application server or cluster member on which
you want to install the enterprise application file is running.
- Ensure that monitored directory deployment is enabled.
See Setting monitored directory deployment values.
- Browse the file structure of the computer and find or create the
monitored directory.
For base (stand-alone) application servers, the monitored directory is under the application
server profile. The directory path is:
- app_server_root/profiles/application_server_profile_name/monitoredDeployableApps/servers/server_name
- app_server_root/AppServer/profiles/default/monitoredDeployableApps/servers/server_name
For stand-alone servers, the product creates a monitored
server_name
directory automatically.
For application servers on a managed (federated) node of a deployment manager,
create a monitored directory under the deployment manager profile. The directory path is:
- app_server_root/profiles/deployment_manager_profile_name/monitoredDeployableApps/servers/server_name
- app_server_root/AppServer/profiles/default/monitoredDeployableApps/servers/server_name
For application servers on a federated node, you must create the monitored
server_name directory. The directory name must match the name of an existing
server.
If multiple servers of the same name are on different federated nodes and you
want only one of the servers to be a monitored directory, you can specify the node and server for
the monitored directory. Create the
/nodes/node_name/servers/server_name
directories under the deployment manager profile. The directory path is:
- app_server_root/profiles/deployment_manager_profile_name/monitoredDeployableApps/nodes/node_name/servers/server_name
- app_server_root/DeploymentManager/profiles/default/monitoredDeployableApps/nodes/node_name/servers/server_name
You must create directories for the node and the server. The
node_name
directory name must match the name of an existing node. The
server_name directory
name must match the name of an existing server on the node.
For clusters, create a monitored directory under the deployment manager profile.
The directory path is:
- app_server_root/profiles/deployment_manager_profile_name/monitoredDeployableApps/clusters/cluster_name
- app_server_root/DeploymentManager/profiles/default/monitoredDeployableApps/clusters/cluster_name
You must create the monitored
cluster_name directory. The directory name
must match the name of an existing cluster.
- Copy the EAR, JAR, WAR, or SAR file that you want to deploy to the monitored
directory.
Choose a file that is not already deployed to the target monitored directory, unless you want to
update a currently deployed file.
If a file is already deployed to a monitored directory of a deployment manager
and you want to deploy the file to a different monitored directory of the deployment manager, remove
the file from the current target monitored directory before you add the file to the new target
monitored directory. For this release, an application file must exist in only one monitored
directory of a deployment manager.
Results
The product adds a directory having the same name as the file to the
installedApps/cell_name directory of the profile.
Also, the product writes messages about the application deployment to the
SystemOut.log file in the
app_server_root/logs/server_name
directory. The messages start with the CWLDD
message key.
The messages indicate that the product deployed the application file and that the application is
running.
Note: This topic references one or more of the application server log files. As a
recommended alternative, you can configure the server to use the High Performance Extensible Logging
(HPEL) log and trace infrastructure instead of using
SystemOut.log ,
SystemErr.log,
trace.log, and
activity.log files on distributed and IBM
i systems. You can also use HPEL in conjunction with your native z/OS logging facilities. If you are using HPEL, you can access all of your log and trace
information using the LogViewer command-line tool from your server profile bin directory. See the
information about using HPEL to troubleshoot applications for more
information on using HPEL.
For installations on a deployment manager monitored directory, the product does
not start an application or module automatically if the node agent or server is not running. If a
node agent is stopped, the product installs the application or module at the deployment manager
level, but does not synchronize the changes with the node and does not start the application or
module. The changes will occur at the node the next time the agent is running and a node
synchronization occurs. If the server is stopped but the node agent is running, the product installs
the application or module and synchronizes the changes with the node, but does not start the
server.
Example
Suppose you want to install the sample DynaCacheEsi.ear file by copying the
EAR file to a monitored directory. You can find the sample EAR file in the
app_server_root/installableApps directory.
Deploying an EAR file on a stand-alone application server
- Ensure that the application server on which you want to install the
DynaCacheEsi.ear file is running.
To see if the server is running, you can
use the serverStatus -all
command. To start the server, you can use the
startServer server_name
command.
For
example, suppose the stand-alone application server has a profile name of AppSrv02. Run the
serverStatus
command from a command prompt at the
app_server_root/profiles/AppSrv02/bin
directory:
serverStatus -all
If the server is not running,
start the server.
For example, to start an application server named server1 on
AppSrv02, run the
startServer
command from a command prompt at the
app_server_root/profiles/AppSrv02/bin
directory:
startServer server1
The
Server server1 open for
e-business message indicates that the server is running.
- Locate the monitored directory.
For the stand-alone AppSrv02 profile, the
monitored directory is
app_server_root/profiles/AppSrv02/monitoredDeployableApps/servers/server1.
- Copy the DynaCacheEsi.ear file in the
app_server_root/installableApps directory to the monitored
directory.
- Verify that the directory for installed applications exists.
- app_server_root/profiles/AppSrv02/installedApps/cell_name/DynaCacheEsi.ear
- app_server_root/profiles/default/installedApps/cell_name/DynaCacheEsi.ear
- Verify that DynaCacheEsi.ear is in the list of installed enterprise
applications and is running.
Deploying an EAR file on a federated node of a deployment manager
- Ensure that the application server of the federated node on which you want to install the
DynaCacheEsi.ear file is running.
To see if the server is running, you can
use the serverStatus -all
command. To start the server, you can use the
startServer server_name
command.
For
example, suppose the server1 application server is on a node that has a profile name of AppSrv01.
Run the
serverStatus
command from a command prompt at the
app_server_root/profiles/AppSrv01/bin
directory:
serverStatus -all
If the server is not running,
start the server.
For example, run the
startServer
command
from a command prompt at the
app_server_root/profiles/AppSrv01/bin
directory:
startServer server1
- Ensure that the DynaCacheEsi.ear file does not exist in a monitored
directory of the deployment manager.
Add an application file to only one monitored directory of a
deployment manager. If an application file already exists in a deployment manager monitored
directory and you add an application file that has the same file name to a different deployment
manager monitored directory, the product uninstalls the application file from the previous target
and installs it to the new target. However, the new target is not synchronized with the deployment
because the file still exists in the previous target monitored directory. To prevent problems with
synchronization, you must remove DynaCacheEsi.ear from all monitored
directories before you add DynaCacheEsi.ear to the new target
directory.
- Create the monitored directory.
For federated nodes, you must create a monitored directory
under the deployment manager profile, unless the directory for the target server already exists.
For example, suppose the deployment manager profile is Dmgr01 and the
application server is server1.
- Go to the /monitoredDeployableApps/servers directory:
- app_server_root/profiles/Dmgr01/monitoredDeployableApps/servers
- app_server_root/AppServer/profiles/default/monitoredDeployableApps/servers
- If a directory named
server1
exists in the servers
directory, then go the next step.If the server1 directory does not exist,
create a directory named server1
in the
/monitoredDeployableApps/servers directory.
The monitored directory is:
- app_server_root/profiles/Dmgr01/monitoredDeployableApps/servers/server1
- app_server_root/AppServer/profiles/default/monitoredDeployableApps/servers/server1
- Copy the DynaCacheEsi.ear file in the
app_server_root/installableApps directory to the
server1 monitored directory
- Verify that the directory for installed applications exists.
- app_server_root/profiles/AppSrv01/installedApps/cell_name/DynaCacheEsi.ear
- app_server_root/AppServer/profiles/default/installedApps/cell_name/DynaCacheEsi.ear
- Verify that DynaCacheEsi.ear is in the list of enterprise applications
installed on the server and is running.
Tip: If multiple servers of the same name are on different federated nodes and you
want only one of the servers to be a monitored directory, you can specify the node and server for
the monitored directory. Create the
/nodes/node_name/servers/server_name
directories under the deployment manager profile. For example, if you want the monitored directory
to be the server1 application server on the myNode01 node, the directory path is:
- app_server_root/profiles/Dmgr01/monitoredDeployableApps/nodes/myNode01/servers/server1
- app_server_root/DeploymentManager/profiles/default/monitoredDeployableApps/nodes/myNode01/servers/server1
Only specify the node for a monitored directory if more than one server has the same
name.
Deploying an EAR file on a cluster of a deployment manager
- Ensure that the cluster members of the cluster on which you want to install the
DynaCacheEsi.ear file are running. For this example, cluster myCluster01 has
one member, myClusterMember01.
- To see if the cluster is running, you can use the
serverStatus -all
command. To
start the cluster member, you can use the startServer myClusterMember01
command.For example, suppose myClusterMember01 is in the AppSrv01 profile. Run the
serverStatus
command from a command prompt at the
app_server_root/profiles/AppSrv01/bin
directory:
serverStatus -all
If the cluster member is not running,
run the
startServer
command from a command prompt at the
app_server_root/profiles/AppSrv01/bin
directory:
startServer myClusterMember01
- Ensure that the DynaCacheEsi.ear file does not exist in a monitored
directory of the deployment manager.
- Create the monitored directory.
For clusters, you must create a monitored directory under the
deployment manager profile, unless the directory for the target cluster member already exists.
For example, suppose the deployment manager profile is Dmgr01:
- Go to
app_server_root/profiles/Dmgr01/monitoredDeployableApps/clusters.
- If a directory named
myCluster01
exists in the /clusters
directory, then go to the next step.If the myCluster01 directory does not
exist, create a directory named myCluster01
in the /clusters
directory.
The monitored directory is:
- app_server_root/profiles/Dmgr01/monitoredDeployableApps/clusters/myCluster01
- app_server_root/DeploymentManager/profiles/default/monitoredDeployableApps/clusters/myCluster01
- Copy the DynaCacheEsi.ear file in the
app_server_root/installableApps directory to the
myCluster01 monitored directory.
- Verify that the directory for installed applications exists.
- app_server_root/profiles/AppSrv01/installedApps/cell_name/DynaCacheEsi.ear
- app_server_root/AppServer/profiles/default/installedApps/cell_name/DynaCacheEsi.ear
- Verify that DynaCacheEsi.ear is in the list of enterprise applications
installed on the cluster member and is running.
What to do next
Test the deployed application or module. For example, point a web browser at the URL for a
deployed application and examine the performance of the application.
If the deployment is not successful, read messages in the SystemOut.log
file, fix the error condition, and add the application or module to the monitored directory
again.