Xi3 Wdeploy Boe Webapps en

Deploying BusinessObjects
Enterprise Web Applications Using

wdeploy
BusinessObjects Enterprise XI 3.0
Unix / Windows
Copyright © 2008 Business Objects. All rights reserved. Business Objects owns the following
U.S. patents, which may cover products that are offered and licensed by Business
Objects: 5,555,403; 5,857,205; 6,289,352; 6,247,008; 6,490,593; 6,578,027;
6,831,668; 6,768,986; 6,772,409; 6,882,998; 7,139,766; 7,299,419; 7,194,465;
7,222,130; 7,181,440 and 7,181,435. Business Objects and the Business Objects
logo, BusinessObjects, Business Objects Crystal Vision, Business Process On
Demand, BusinessQuery, Crystal Analysis, Crystal Applications, Crystal Decisions,
Crystal Enterprise, Crystal Insider, Crystal Reports, Desktop Intelligence, Inxight,
the Inxight Logo, LinguistX, Star Tree, Table Lens, ThingFinder, Timewall, Let
there be light, Metify, NSite, Rapid Marts, RapidMarts, the Spectrum Design, Web
Intelligence, Workmail and Xcelsius are trademarks or registered trademarks in
the United States and/or other countries of Business Objects and/or affiliated
companies. All other names mentioned herein may be trademarks of their respective
owners.
Third-party Business Objects products in this release may contain redistributions of software
Contributors licensed from third-party contributors. Some of these individual components may
also be available under alternative licenses. A partial listing of third-party
contributors that have requested or permitted acknowledgments, as well as required
notices, can be found at: http://www.businessobjects.com/thirdparty
2008-04-03
Contents
Chapter 1 Overview of wdeploy 7
Standalone web application server support.................................................8
Distributed web server/web application server support...............................9
Chapter 2 Configuration Information 11

Deployment information for applications (application.properties file)........12
Web and web application server configuration options (config.* file)........16
Chapter 3 Deployment Modes 17

Standalone mode.......................................................................................18
To deploy in standalone mode .............................................................18
Distributed mode........................................................................................19
To deploy in distributed mode when web and web application servers are
on same machine ................................................................................20
To deploy in distributed mode when web and web application servers are
on distinct machines ............................................................................20
Chapter 4 Before running wdeploy 21

Set Windows 8dot3 filename option..........................................................22
Set the JAVA_HOME.................................................................................22
Chapter 5 Running wdeploy 23

The wdeploy command line.......................................................................24
Modifying the config.* file and running wdeploy........................................27
To run wdeploy using the command line only............................................27
Deploying BusinessObjects Enterprise Web Applications Using wdeploy 3

Contents
Chapter 6 After running wdeploy 29
Chapter 7 Web/Web Application Server parameters reference 31
Chapter 8 Properties reference 33

Properties you must set ............................................................................34
Properties .................................................................................................35
APP......................................................................................................35
as_admin_is_secure............................................................................36
as_admin_password............................................................................36
as_admin_port......................................................................................37
as_admin_username............................................................................38
as_appserver_name.............................................................................38
as_dir....................................................................................................39
as_group_id..........................................................................................39
as_instance..........................................................................................40
as_mode...............................................................................................40
as_service_key.....................................................................................41
as_service_key_value..........................................................................41
as_service_name.................................................................................41
as_sid...................................................................................................42
as_virtual_host.....................................................................................42
classloader_package_filtering..............................................................43
connector_host.....................................................................................43
connector_name...................................................................................44
connector_port.....................................................................................44
connector_type.....................................................................................45
deploy_as_a_filetree............................................................................45
deployment_dir.....................................................................................46
4 Deploying BusinessObjects Enterprise Web Applications Using wdeploy

Contents
enforce_file_limit..................................................................................46
work_dir................................................................................................47
ws_dir...................................................................................................47
ws_instance..........................................................................................48
ws_type................................................................................................48
Chapter 9 Actions reference 49

deploy........................................................................................................51
deployall.....................................................................................................52
deployonly..................................................................................................52
deployonlyall..............................................................................................52
listapps.......................................................................................................53
listdeployedapps........................................................................................53
predeploy...................................................................................................54
predeployall...............................................................................................54
undeploy....................................................................................................55
undeployall.................................................................................................55
validateconfig.............................................................................................56
Chapter 10 What deploy changes in your environment 57

Changes in Apache web server.................................................................58
Changes in Tomcat web application server...............................................58
Changes in JBoss web application server.................................................58
Changes in NetWeaver web application server.........................................59
Changes in Oracle web application server................................................59
Changes in Sun Java Web Server.............................................................59
Changes in WebLogic web application server...........................................59
Changes in WebSphere web application server........................................60

Contents
Chapter 11 Troubleshooting 61
WASX7017E: Exception deploying in WebSphere ...................................62
Instance configuration was modified in Sun Java Web Server..................62
Sun Java System Web Server connector information for Tomcat.............63
Sun Java System Web Server connector information for WebLogic.........63
Sun Java System Web Server connector information for WebSphere......63
Apache or Sun Java System Web server/Oracle 10G R3 application server
distributed deployment ..............................................................................64
Appendix A Get More Help 65
Index 69

Overview of wdeploy
1
1 Overview of wdeploy
Standalone web application server support
wdeploy is a command-line tool for JSP environments that you can use to
deploy BusinessObjects web applications. There are two versions available
a [.sh] file for Unix, a [.bat] file for Windows.
wdeploy is ANT-based with some Javascript helpers. It runs on Java 1.4 or

1.5.
wdeploy can do any or all of the following:

• list all the available, installed applications listed in your BusinessObjects
Enterprise $INSTALLDIR\deployment\apps directory
• deploy all the available BusinessObjects web applications that you have
installed and BusinessObjects customized web applications developed
with Developer Suite.
• create the resources and configuration files required for a specified
application and then deploy the application
• deploy an application whose resources and configuration files have been
prepared for deployment
• list all the applications that have been previously deployed in an application
server
• undeploy applications that have been previously deployed in an application
server or in an web application server and web server.
• validate the wdeploy configuration for the supported web application
servers to ensure that the deployment can be successful.
Note: In line with BusinessObjects Enterprise version XI Release 2
terminology, this documentation uses the term web application server instead
of the term application server used through version 6.x.
See the README file for specific information or known issues.
Standalone web application server

support
wdeploy supports the following web application servers:
• Tomcat 5.5
• WebLogic 9.2 or 10
• WebSphere 6.1
• JBoss 4.04

Overview of wdeploy
Distributed web server/web application server support 1
• SAP Application Server 7.0 (Netweaver 2004)
• Oracle Application Server 10 G R3
Distributed web server/web application

server support
In distributed deployments, wdeploy supports the following web/web
application server configurations:
• Apache 2/Tomcat 5.5, or WebLogic 9.2 or 10 or WebSphere 6.1 , JBoss
4.04, Oracle Application Server 10 G R3
• IHS/WebSphere 6.1
• Sun Java System Web Server 6/ Tomcat 5.5, or WebLogic 9.2 or 10 or
WebSphere 6.1 , JBoss 4.04, Oracle Application Server 10 G R3
Note: In the following, Apache and IHS web servers are both specified as
"apache".

1 Overview of wdeploy
Distributed web server/web application server support

Configuration Information
2
2 Configuration Information
Deployment information for applications (application.properties file)
Configuration information used in BusinessObjects Enterprise deployment

is stored in two different files.
Configuration information for specific applications is stored in the <applica

tion>.properties files, and configuration information for web and web
application servers is stored in the config.<web/web application server>
files.
Their parameters can be modified.
Deployment information for applications

(application.properties file)
The deployment information for specific applications is stored in the $IN
STALLDIR\deployment\apps\<application>.properties files.
The <application>.properties files contain the following parameters:
Parameter Status Description
appvdir Mandatory. Context root of the application.
addtoclasspath Optional. Line to add to the classpath of

the web application server.
addtolibpath Optional. Line to add to the libpath of

buildfile Optional. Name of an .XML file containing

additional configuration informa-
tion, such as the example in the
$INSTALLDIR\deployment\sam
ples directory.

Deployment information for applications (application.properties file) 2
warfile Mandatory. Mandatory if app_source_dir

or win_app_source_dir is not
defined. Name of the applica-
tion .WAR file present in war_dir
or win_war_dir.
app_source_dir Optional On Unix and Windows, directory

that contains the application file
tree.
win_app_source_dir Optional See win_war_dir and

app_source_dir.
app_as_a_filetree Optional Boolean. False by default, or true.

The application is deployed as a
file tree.
zipfile Optional. Name of the static resource file

for the application present in
war_dir.
dont_split_content Optional. Boolean. False by default, or

true. Indicates that the applica-
tion does not support static and
dynamic content separation.
When "true" in distributed
mode, static content is distribut-
ed in the web server and static
plus dynamic content are dis-
tributed in the web application
server. On WebSphere 6.1 web
application server, [FileServ
ingServlet] is enabled.

Deployment information for applications (application.properties file)
file_limit_reached For WebSphere Boolean. False by default, or

6.1. true. Indicates that the content
to deploy on the application
server contains more than
65535 files.
war_dir Optional. On Unix and Windows: Name

of the directory that contains the
.war file. By default the war file
is stored at :$INSTALLDIR\en
terprise120\java\applica
tions on Unix ; $IN-
STALLDIR\BusinessObjects
Enterprise 12.0\java\appli-
cations on Windows.
Mandatory when wdeploy is

launched from another directory
than the default one.
win_war_dir Optional. On Windows: Name of the direc-

tory that contains the .war file.
win_war_dir has priority over
win_war directory. By default,
the .war file is stored at: $IN-
STALLDIR\BusinessObjects
Enterprise 12.0\java\appli-
cations
wdeploy.prop.count Optional. Number of properties to set in

the target application server.
The default value is 0.

Deployment information for applications (application.properties file) 2
wdeploy.prop#.name Optional. Name of the property to set in

"#" corresponds to the wde
ploy.prop.count value. See
[infoview.properties].
wdeploy.prop#.value Optional. Value of the property to set in

"#" corresponds to the wde
ploy.prop.count value.
See [infoview.properties].
wdeploy.prop#.ap Optional. A list of supported platforms

plies_to that supports the prop# proper-
ty. "#" corresponds to the wde
ploy.prop.count value.
Supported platforms are: so-

laris_sparc, aix_rs6000,
hpux_pa-risc, linux_x86 and
win32_x86. The list is separat-
ed by spaces. By default the list
is empty that corresponds to all
the platforms. When the plat-
form that holds the application
server is not in the list, the
property is not set in the applica-
tion server's configuration. See
[styles.properties] file.

Web and web application server configuration options (config.* file)
Web and web application server

configuration options (config.* file)
Configuration information for the web and web application servers used in
your BusinessObjects Enterprise deployment is stored in the con
fig.<web/web application server> files in the $INSTALLDIR\deployment
directory.
The following sample configuration files, which you must modify manually
to match your configuration, are located in the $INSTALLDIR\deployment
directory:
• config.weblogic9
• config.weblogic10
• config.websphere6
• config.apache
• config.tomcat55
• config.iplanet
• config.jboss404
• config.nw2004
• config.oas1013

Deployment Modes
3
3 Deployment Modes
Standalone mode
wdeploy allows you to deploy all BusinessObjects Enterprise web application

resources in a centralized WAR file on the web application server, or to extract
the static resources and deploy them instead on the web server.
Two deployment modes are available:
• Standalone
• Distributed.
In the standalone and distributed examples, static and dynamic resources

are deployed on a machine other than the machine where BusinessObjects
server stack is installed. This configuration results from a custom installation
that uses Web Component Installation. For more information, see the
Installation Guide.
Standalone mode
Deploying web applications' static and dynamic resources bundled in their
.WAR file on the web application server is known as standalone mode.
Figure 3-1: Standalone web deployment, with no separate web server
This makes deployment simpler, but performance may suffer, as every type
of transaction, even those requiring static content only, is handled through
To deploy in standalone mode

• To deploy a web application in standalone mode on the web application
server, simply run wdeploy on the web application server machine.

Deployment Modes
Distributed mode 3
Distributed mode
In distributed deployments, web applications' dynamic resources are deployed
on the web application server, and their static resources are deployed on
the web server.
In distributed mode, web and web application servers can be on a same

machine or on distincts machines. See the diagrams below.
Detailed information is also provided in the BusinessObjects Enterprise XI

3.0 Installation and Configuration Guide available on BusinessObjects Support
Site.
Figure 3-2: Distributed web deployment with web and web application servers on same
machine
Figure 3-3: Distributed web deployment with web and web application servers on different
machines

3 Deployment Modes
Distributed mode
Related Topics
• http://support.businessobjects.com
To deploy in distributed mode when web and web

application servers are on same machine
1. Run wdeploy on the web application server to extract dynamic resources.
Make sure that the as_mode property is set to "distributed" mode, either
in the wdeploy command line, or in the web application server's config.*
file.
2. Run wdeploy to extract static resources for the web server.
3. Generate .ZIP file and unzip it.
These instructions can be launched in one or two command line (s).
To deploy in distributed mode when web and web

application servers are on distinct machines
1. Run wdeploy on the web application server machine. Make sure that the
as_mode property is set to "distributed", either in the wdeploy command
line, or in the web application server's config.* file.
2. Run wdeploy to extract static resources for the web server (located on
another machine) and generate .ZIP file.
3. Copy .ZIP file on the web server machine and unzip it .

Before running wdeploy
4
4 Before running wdeploy
Set Windows 8dot3 filename option
Make sure you have enough disk space

To be safe, you should have 1.2 GB available in your working directory.
Describe your web and/or web application server

You must describe your web or web application server installation in a con
fig. <web_application_server_type> or config.<web_server_type>
file.
Sample configuration files, which you must modify manually to match your
configuration, are located in the $INSTALLDIR\deployment directory.
Set Windows 8dot3 filename option

On Windows enable 8-dot-3 filename option on the server.
Run regedit, and change the double word value NtfsDisable8dot3Name

Creation of the key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Con
trol\FileSystem to 0.
Reboot the machine.
Set the JAVA_HOME

Wdeploy is an ant-based tool, that runs on Java 1.4 or 1.5.
If JAVA_HOME is not set in the environment when launching wdeploy, or if

the JAVA_HOME points to a JVM that wdeploy cannot use (no java and java
executables in the /bin subdirectory), wdeploy tries to use the JVM installed
with the product, or the JVM packaged in the installation media.
If none suitable JVM is found, wdeploy exits.

Running wdeploy
5
5 Running wdeploy
The wdeploy command line
You run wdeploy from the command line. You run it for your web server or
web application server. In distributed mode, you run it for both.
You can enter all required information from the command line, or modify the
config.* file of your web/web application server first to enter properties. It's
easier to modify the configuration file first.

The wdeploy command line can contain three types of parameters:
• a web or web application server type
• one or more properties (optional depending on your deployment and how
you use wdeploy)
• an action (corresponding to an ANT target)
It looks like this (all in a single line):

wdeploy[.sh|.bat] <web or web application server type> [-
D<property>]* <action>
For example:
cd $INSTALLDIR\deployment
wdeploy[.sh|.bat] tomcat55 -Das_mode=distributed -
Das_dir=/opt/tomcat -Das_instance=localhost -Dws_type=apache

Running wdeploy
The wdeploy command line 5
-Dws_dir=/opt/apache -Dwork_dir=/tmp/wdeploy -DAPP=InfoViewApp
deploy
Parameter Short name Description
<web or web application Web/Web applica- The type of web or web

server type>
tion server application server you're
using:
• apache for Apache 2
web server type
• iplanet for Sun Java
System Web Server 6
web server type
• tomcat55 for Tomcat
5.5 web application
server type
• websphere6 for Web-
sphere 6 application
server type
• weblogic9 for We-
bLogic 9 application
server type
• weblogic10 for We-
bLogic 10 application
server type
• jboss404 for JBoss
4.0.4 application server
type
• oas1013 for Oracle
Application Server 10g
R3 application server
type
• nw2004 for SAP
NetWeaver 7 applica-
tion server type
<property> property

5 Running wdeploy
Parameter Short name Description
Web application deploy-

ment parameter.
You can use as many

properties as you require.
You can set properties in

your web or web applica-
tion server's config.*
file instead of in the wde-
ploy command line if you
want.
<action> action Action to be taken.
Possible actions on ma-

chines hosting web appli-
cation servers are:
• listapps
• deployall
• predeploy *
• predeployall *
• deploy *
• deployonly *
• deployonlyall *
• listdeployedapps
• undeploy *
• undeployall *
• validateconfig
* these actions can also
be run on the web server
when web and web appli-
cation servers are on the
same machine.

Running wdeploy
Modifying the config.* file and running wdeploy 5
Modifying the config.* file and running
wdeploy
Business Objects recommends that you manually modify the config.* file
for the web or web application server you are using, and then run wdeploy.
Samples of configuration files, which you must modify manually to match

your configuration, are located in the $INSTALLDIR\deployment directory:
To modify the [config.*] file

1. Go to the $INSTALLDIR\deployment directory.
2. Set the required web/web application server information required by
wdeploy, as well as all of the properties required by your deployment.
3. Run wdeploy on the machine (s) that host(s) the web/web application
server.
You need only include the web/web application server, an application name
(APP property) if required, and an action.
Example:
For example:
cd $INSTALLDIR\deployment
wdeploy [.bat|.sh] websphere6 -DAPP=InfoViewApp predeploy
Related Topics
• Properties reference on page 33
• Actions reference on page 49
To run wdeploy using the command line

only
You can define all the settings and actions for the deployment of your web
applications, then execute those actions using the wdeploy command line
only. To use the wdeploy command line:
1. In the DOS window, or at the command line, navigate to the $IN
STALLDIR\deployment directory.

5 Running wdeploy
To run wdeploy using the command line only
2. Type the wdeploy command line.

Add as many properties (property=value) as required for your deployment.
Enter valid values for each parameter, making sure that every parameter
requiring spaces or special characters (such as file locations) is wrapped in
double quotes.
Example:
For example, in standalone mode (all in one line):
wdeploy[.bat|.sh] websphere6 -Das_mode=standalone -
Das_dir=/opt/ibm/WebSphere/AppServer -Das_instance=server1 -
Das_admin_port=8880 -Dwork_dir=/tmp/wdeploy -Das_virtu
al_host=default_host -DAPP=InfoViewApp deploy
For example, in distributed mode (all in one line):
wdeploy[.bat|.sh] tomcat55 -Das_mode=distributed -
Das_dir=/opt/tomcat -Das_instance=localhost -Dws_type=apache
-Dws_dir=/opt/apache -Dwork_dir=/tmp/wdeploy -DAPP=In
foViewApp deploy
Press the Return key.
Related Topics

After running wdeploy
6
6 After running wdeploy
After deploying your web applications on the web or web application server
using wdeploy, restart the web and/or web application server to take the
modifications into account.

Web/Web Application
Server parameters
reference
7
7 Web/Web Application Server parameters reference
When wdeploy is installed in the $INSTALLDIR\deployment directory, it

comes with a separate config.* file for each supported web or web
application server.
The value you enter for this parameter must exactly match the extension of
the configuration file corresponding to your web or web application server.
If it is not an exact match, wdeploy will be unable to find the file.
Business Objects suggests you browse the $INSTALLDIR\deployment

directory for the precise name of the file used for your application server.

Properties reference
8
8 Properties reference
Properties you must set
This parameter defines properties that are specific to your deployment. These
settings are stored in the config.* files in $INSTALLDIR\deployment.
• To define property, type without spaces:
-D<value from Property column>=<value from Values column>
Properties you must set

Required Properties
If your web application server is running in distributed mode, you must specify
this by setting the as_mode property to "distributed" either in your web
application server's config.* file or in the wdeploy command line.
If the web server is on the same machine as the web application server, you
must specify the type of web server and its installation directory on the
machine, using respectively the ws_type and ws_dir properties.
You must define the connector-type property if you are running wdeploy
on a web server machine.
Additional required properties

You may also be required to set other properties pertaining to either the
action or the type of web application server you're using.
The properties required for specific web and web application servers are
described in the following files, all located in the $INSTALLDIR\deployment
directory:
• the config.* file for each web or web application server
• the wdeploy README file
Related Topics

Properties 8
Properties
You can define as many properties as you want in the command line,
separating them with a space, as long as the properties don't contradict each
other.
Properties are put in alphabetical order.
APP
Property Value Description
APP
Value depends on the applica- Specific web application,
tion installed. See the taken from the name of the
<APP>.properties file located <APP>.properties file
in the web application server located in the web applica-
machine's $INSTALLDIR\deploy tion server machine's $IN
ment\apps directory. STALLDIR\deploy
ment\apps directory.
Example: -DAPP=In
foViewApp

Properties
as_admin_is_secure
as_admin_is_se
cure
true For Oracle Application Server
instructs wdeploy to use SSL
false to do the deployment.
For WebSphere: instructs wde-

ploy that security is enabled in
WebSphere (administrator login
and password are then re-
quired).
Related Topics
• as_admin_password on page 36
• as_admin_username on page 38
as_admin_password
as_admin_pass
word
<password> Password for administration of the
application server.
Mandatory for NetWeaver, Oracle

Application Server, and WebLogic.
• For WebSphere and if as_ad
min_is_secure is false, the val-
ue does not need to be specified.

Properties 8
Related Topics
• as_admin_is_secure on page 36
• as_admin_username on page 38
as_admin_port
as_ad
min_port
<port number> Administration port of the appli-
cation server.
Mandatory for NetWeaver, Ora-

cle Application Server, and We-
bLogic.
• For WebSphere, the SOAP

port. If not set, the default
SOAP port will be used.
• For Oracle Application Serv-
er (oas1013): wdeploy ex-
pects the request port of the
<notification-server> element
in the [opmn.xml] file.

Properties
as_admin_username
as_admin_user
name
<user name> User name with administra-
tion rights on the application
server.
Mandatory for NetWeaver,

Oracle Application Server,
and WebLogic.
• For WebSphere and if
as_admin_is_secure is
false, the value does not
need to be specified.
Related Topics
• as_admin_is_secure on page 36
• as_admin_password on page 36
as_appserver_name
as_appserver_name
<web application server For Oracle Application
name> Server, the name of the
target application serv-
er.

Properties 8
as_dir
as_dir
<directory> Installation directory of the
web application server.
For WebLogic application

servers, as_dir is the do-
main root.
Example:
-Das_dir=/space3/tomcat
as_group_id
as_group_id
<group servers name> For Oracle Application
Server: the group of
servers the target appli-
cation belongs to.

Properties
as_instance
as_instance
<instance name> Mandatory for all the application
servers.
Name of the web application server

instance currently used.
Example: -Das_instance=local
host
as_mode
as_mode
standalone
Type of web application deployment.
distribut
Example: -Das_mode=distributed
ed
Related Topics
• ws_type on page 48
• Distributed mode on page 19
• Standalone mode on page 18

Properties 8
as_service_key
Proper- Value Description

ty
as_ser HKLM\SOFTWARE\Apache For Tomcat 55 only. When in-

vice_key Software Foundation\Pro stalled as a service, the Windows
crun 2.0\$as_ser registry key where the jvm's start-
vice_name\Parameters\Java up parameters are stored.
as_service_key_value
as_ser For Tomcat 55 only. When Tomcat is in-

vice_key_val stalled as a service,
ue The name of the multi-string value hold- on Windows.
ing Tomcat’s startup parameters.
as_service_name
as_service_name
<service name> For Tomcat 55 only.
The name of the Windows

service (when the application
server is installed as a Win-
dows service).

Properties
as_sid
as_sid <sap_sid>
Mandatory for NetWeaver, the
SAP system ID of the target in-
stance.
as_virtual_host
as_virtual_host
<virtual host name> For WebSphere 6.1 on-
ly.
The virtual host to which

the application must be
bound.

Properties 8
classloader_package_filtering
Proper- Value Description

ty
class Coma-separated list of pack- For WebLogic 9 and 10

load ages to filter from the class
er_pack loader. When the property is set, the
age_fil application is turned into an
tering Example:classloader_pack EAR, and a filtering Classload
age_filter er is setup with the package list.
ing=com.ctc.wstx.*,javax.xml.*,org.apache.*
connector_host

connec
tor_host
<host_name> For distributed deployment using Oracle Applica-
tion Server, the host name of the web application
server to contact.
Related Topics
• connector_port on page 44
• connector_type on page 45
• connector_name on page 44

Properties
connector_name
connector_name
<connector Required for Sun Java System
name> Web Server only.
The name of the object that de-

scribes the connector service to
the application server, in the
[obj.conf] file.
Related Topics
• connector_host on page 43
connector_port

<ajp13
connec
port>
For distributed deployment using Oracle Apllica-
tor_port tion Server, the ajp13 port of the web application
server to contact.
Related Topics

Properties 8
connector_type
Property Values Description
connector_type
<connector type> For Apache and Sun Java
System Web Server.
The type of connector to

configure in distributed
mode.
See the Readme file.
Related Topics
deploy_as_a_filetree
de true For WebLogic 9 and 10 application servers.

ploy_as_a_file
tree false Indicates whether the application must be de-
ployed as a file tree or as a packaged application
(.war or .ear file).
Default: false

Properties
deployment_dir
deployment_dir
<directory> In distributed mode, the web
server directory under which
wdeploy creates a subdirectory
matching the application name,
and in which the .ZIP files
containing the application's
static resources are unzipped.
wdeploy creates a virtual direc-

tory in the web server configura-
tion mapping the subdirectory
to a URL.
Example: -Ddeploy
ment_dir=/temp/apache
enforce_file_limit
en
true False by default except for Web-
force_file_lim
it Sphere 6.
false
Tells wdeploy whether or not the
application server has encountered
issues loading an application that
contains more than 65535 files.

Properties 8
work_dir
work_dir
<directory> Directory in which wdeploy manipu-
lates the web applications (typically
when it splits the static and dynamic
content of an application), stores the
results of the pre-deploy action, and
stores data to be able to undeploy
applications.
By default, this is $INSTALLDIR\de

ployment\workdir.
Example: -Dwork_dir=IN
STALLDIR\deployment\workdir
ws_dir
ws_dir
<directory> Use this in distributed mode only.
The Apache installation directory,

or the Sun Java system web server
instance's configuration directory.
Example:
-Dws_dir=/space3/apache

Properties
ws_instance
ws_instance
<instance name> For WebSphere 6 only.
The name of the web server

where the application is in-
stalled, in distributed mode.
Example: -Dws_instance=web
server1
ws_type
ws_type
<web server type> The type of web server to deploy
to, in distributed mode.
Used when static and dynamic

resources are deployed in one
stage.
The command is:wdeploy <ap

plication server name> -
Dws_type=<web server name>.
See the README for examples

Actions reference
9
9 Actions reference
deploy
The Action parameter defines wdeploy's sequence of actions. Actions are

put in alphabetical order.

Actions reference
deploy 9
deploy
Action Description
deploy Deploys an application.
deploy = predeploy + deployonly
Example 1: wdeploy[.sh|.bat] tomcat55 -

DAPP=CmcApp deploy
Deploys the CmcApp application on Tomcat55
Example 2: wdeploy[.sh|.bat] tomcat55 -

DAPP=InfoViewApp -Das_mode=distributed -
Das_dir=/space3/tomcat -Das_instance=local
host -Dws_type=apache -Ddeploy
ment_dir=/tmp -Dws_dir=/space3/apache de
ploy
Deploys the InfoViewApp application in Tomcat 5.5,

in distributed mode:
Tomcat is installed in /space3/tomcat, Instance

is 'localhost'. Web server is Apache, installed on
/space3/apache. Resources are installed in
/tmp/infoview ($deployment_dir/$APP), and
the directory is mapped to the application context
root.
Example 3: wdeploy[.sh|.bat] apache -

DAPP=InfoViewApp -Das_mode=distributed -
Dconnector_type=weblogic9 -Ddeploy
ment_dir=/tmp/apache -Dws_dir=/space3/pc
effis/apache deploy
Deploys the static resources of the Infoview appli-

cation in Apache, configuring the connector for
WebLogic 9.

9 Actions reference
deployall
deployall
Action Description
deployall Deploys all wdeploy's supported, installed applica-

tions described in the $INSTALLDIR\deploy-
ment\apps directory.
Example: wdeploy[.sh|.bat] websphere6 de

ployall
Deploys all applications for WebSphere 6.1 (all

configuration parameters are set in the config.web
sphere6 file).
deployonly
Action Description
deployonly Deploys a predeployed application.
deployonlyall
Action Description
deployonlyall deploy all predeployed applications.

Actions reference
listapps 9
listapps
Action Description
listapps Lists all the available, installed applications de-

scribed in the $INSTALLDIR\deployment\apps di-
rectory.
Example: wdeploy[.sh|.bat] tomcat55

listapps
Lists all available applications.
listdeployedapps
Action Description
listdeployedapps Lists all the applications deployed in the selected web

application server.

9 Actions reference
predeploy
predeploy
Action Description
predeploy Creates all the resources and the configuration files

required for the specified application.
After you have invoked this action, everything is

ready for the application's deployment to take place.
Use this option if you want to review precisely what

is going to be deployed in the web application
server, or if you want to deploy manually.
predeployall
Action Description
predeployall Builds all resources WAR, ZIP files, etc., and con-
figuration files required for all specified applications.
predeployall can be followed by deployonlyall.

Actions reference
undeploy 9
undeploy
Action Description
undeploy Undeploys the selected application from the web appli-

cation server, the web server or both, depending on the
deployment mode.
Example: wdeploy[.sh|.bat] tomcat55 -DAPP=Cm

cApp undeploy
Undeploys the CmcApp application that was previously

deployed on Tomcat55
undeployall
Action Description
undeployall Undeploys all the application that have been previously

deployed.
Stops the application and removes it from the web

application server.
Example: wdeploy[.sh|.bat] tomcat55 undeploy

all
Undeploys all the applications that were previously

deployed.

9 Actions reference
validateconfig
validateconfig
Action Description
validatecon Validates the wdeploy configuration for the supported web

fig application servers to ensure that the deployment can be
successful.
Example: wdeploy [.sh|.bat] tomcat55 validateconfig
Checks the as_dir and as_instance values.

What deploy changes in
your environment
10
10 What deploy changes in your environment
Changes in Apache web server
Changes in Apache web server

For each application, ${ws_dir}/conf/bobj.${APP}.conf file is created,
containing connector configuration, directory and servlet mapping information.
File ${ws_dir}/conf/httpd.conf is modified to include that file.
Changes in Tomcat web application

server
Files added to the classpath are dropped in ${as_dir}/shared/lib
${as_dir}/bin/bobjeEnv.${APP}.[sh|bat] file is created, containing

library path modifications, and java properties modifications to add the
application's properties.
${as_dir}/bin/catalina.[sh|bat] file is modified to include this file.
On Windows, additionnal java properties are added to the tomcat service

startup parameters. Library path modifications must manually be made to
the system-wide PATH environment variable
Restart Tomcat to take changes into account.
Changes in JBoss web application server

The JSF package shipped with JBoss is deleted if it is detected (directory
${as_dir}/server/${as_instance}/deploy/jbossweb-tom
cat55.sar/jsf-libs is deleted)
Files added to the classpath are dropped in ${as_dir}/server/${as_in

stance}/lib.
File ${as_dir}/bin/bobjeEnv.${APP}.[sh|bat] is created, containing

library path modifications, and java properties modifications to add the
application's properties. File ${as_dir}/bin/run.[sh|bat] is modified to
include this file.
Restart JBoss to take changes into account.

What deploy changes in your environment
Changes in NetWeaver web application server 10
Changes in NetWeaver web application
server
Files to add to the classpath are bundled in the application (added to WEB-
INF/lib). Additionnal library path and application properties modifications
are not supported yet.
Such modifications must be done manually using NetWeaver's configuration

interface.
Changes in Oracle web application server

INF/lib).
Library path and application specific properties are set into

${as_dir}/opmn/conf/opmn.xml.
Restart your application server to take changes into account.
Changes in Sun Java Web Server

For each application, ${ws_dir}/obj.conf file is modified, to add connector
configuration, directory and servlet mapping information.
NameTrans fn=pfx2dir from="${appvdir}" dir="${deploy
ment_dir}/${APP}"
Changes in WebLogic web application

server
INF/lib).
${as_dir}/bin/bobjeEnv.${APP}.[sh|cmd]file is created, containing

library path and java properties modifications.

10 What deploy changes in your environment
Changes in WebSphere web application server
${as_dir}/bin/startWebLogic.[sh|cmd] file is modified to include this

file.
Changes in WebSphere web application

server
INF/lib).
Properties are added as JVM custom properties. Library path modifications

are done modifying the environment of the JVM. Web Server plugin gets
automatically regenerated.

Troubleshooting
11
11 Troubleshooting
WASX7017E: Exception deploying in WebSphere
WASX7017E: Exception deploying in

WebSphere
If you receive the following exception:
WASX7017E: Exception "workdir/websphere/application/install.scr";

exception information:
com.ibm.websphere.management.exception.ConfigServiceException
com.ibm.websphere.management.exception.ConnectorException
org.apache.soap.SOAPException: [SOAPException: faultCode=SOAP-

ENV:Client;
msg=Read timed out; targetException=java.net.SocketTimeoutEx

ception: Read timed out]
Try raising or removing the SOAP connection timeout set by the property:
com.ibm.SOAP.requestTimeout
in:
$WASINSTALLDIR/profiles/<profile>/properties/soap.client.props
file,
and in:
$WASINSTALLDIR/profiles/<profile>/temp/soap.client.props.
Instance configuration was modified in

Sun Java Web Server
After deploying into Sun Java System Web server, if the following warning
is displayed in the Administration consoleInstance configuration was
modified, click on the warning then select "Pull and deploy configuration
from <instance name>" and click Ok.

Troubleshooting
Sun Java System Web Server connector information for Tomcat 11
Sun Java System Web Server connector
information for Tomcat
For Tomcat
Add to obj.conf
<Object name="jknsapi">
ObjectType fn=force-type type=text/plain
Service fn="jk_service" method="*" worker="worker1"
</Object>
where 'jknsapi' is the connector_name to pass to wdeploy
Related Topics
• http://tomcat.apache.org/connectors-doc/howto/nes.html

information for WebLogic
For WebLogic
Add to obj.conf
<Object name="weblo">
Service fn="wl_proxy" WebLogicHost="localhost" WebLogic
Port="7001"
</Object>
where 'weblo' is the connector name to pass to wdeploy.
Related Topics
• http://e-docs.bea.com/wls/docs81/plugins/nsapi.html

information for WebSphere
For WebSphere, see the web site referenced below.

11 Troubleshooting
Apache or Sun Java System Web server/Oracle 10G R3 application server distributed deployment
Related Topics
• http://publib.boulder.ibm.com/infocenter/wasinfo/v6r0/index.jsp?top
ic=/com.ibm.websphere.base.doc/info/aes/ae/tins_manualWebIPL.html
Apache or Sun Java System Web

server/Oracle 10G R3 application server
distributed deployment
To launch Infoview portal configure the module mod_oc4j in static mode to
perform Static Routing.
Add to mod_oc4j.conf file the following entry: Oc4jRoutingMode Static.

Get More Help
A
A Get More Help
Online documentation library

Business Objects offers a full documentation set covering all products and
their deployment. The online documentation library has the most up-to-date
version of the Business Objects product documentation. You can browse
the library contents, do full-text searches, read guides on line, and download
PDF versions. The library is updated regularly with new content as it becomes
available.
http://support.businessobjects.com/documentation/product_guides/
Additional developer resources

http://devlibrary.businessobjects.com
Online customer support

The Business Objects Customer Support web site contains information about
Customer Support programs and services. It also has links to a wide range
of technical information including knowledgebase articles, downloads, and
support forums.
http://www.businessobjects.com/support/
Looking for the best deployment solution for your company?

Business Objects consultants can accompany you from the initial analysis
stage to the delivery of your deployment project. Expertise is available in
relational and multidimensional databases, in connectivities, database design
tools, customized embedding technology, and more.
For more information, contact your local sales office, or contact us at:
http://www.businessobjects.com/services/consulting/
Looking for training options?

From traditional classroom learning to targeted e-learning seminars, we can
offer a training package to suit your learning needs and preferred learning
style. Find more information on the Business Objects Education web site:
http://www.businessobjects.com/services/training

Get More Help
A
Send us your feedback
Do you have a suggestion on how we can improve our documentation? Is
there something you particularly like or have found useful? Drop us a line,
and we will do our best to ensure that your suggestion is included in the next
release of our documentation:
mailto:documentation@businessobjects.com
Note: If your issue concerns a Business Objects product and not the
documentation, please contact our Customer Support experts. For information
about Customer Support visit: http://www.businessobjects.com/support/.
Business Objects product information

For information about the full range of Business Objects products, visit:
http://www.businessobjects.com.

A Get More Help

Index
-D command 34 config.* file 27, 34
.apache 16
.iplanet 16
A .jboss404 16
Action 24 .nw2004 16
addtoclasspath parameter 12 .oas1013 16
addtolibpath parameter 12 .tomcat55 16
ajp13 port 44 .weblogic10 16
app_as_a_filetree parameter 12 .weblogic9 16
app_source_dir parameter 12 .websphere6 16
application.properties files connector_name 44
addtoclasspath 12
addtolibpath 12 D
app_as_a_filetree 12
app_source_dir 12 Describe your web/web application server 22
appvdir 12 Disk space availability 22
buildfile 12 dont_split_content parameter 12
dont_split_content 12
file_limit_reached 12
war_dir 12
F
warfile 12 file_limit_reached parameter 12
wdeploy.prop.* 12
win_app_source_dir 12
win_war_dir 12 H
zipfile 12
appvdir parameter 12 httpd.conf file 58
B M
bobjeEnv.* file 58, 59 mod_oc4j.conf file 64
buildfile parameter 12
N
C NameTrans 59
catalina.* file 58

Index
O S
obj.conf 44 SAP ID 42
obj.conf file 59, 63 SOAP
Oc4jRoutingMode Static entry 64 timeout connection 62
opmn.xml file 37, 59 SOAP port 37
startWebLogic.* file 59
P
W
Port
ajp13 44 war_dir parameter 12
opmn.xml file 37 warfile parameter 12
SOAP 37 wdeploy.prop.* parameter 12
Property 24 Web or web application server's type 24
web server's type 48
win_app_source_dir parameter 12
R win_war_dir parameter 12
run.* file 58
Z
zipfile parameter 12

Xi3 Wdeploy Boe Webapps en

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Xi3 Wdeploy Boe Webapps en

Uploaded by

Copyright:

Available Formats

Deploying BusinessObjects

Enterprise Web Applications Using

BusinessObjects Enterprise XI 3.0

Chapter 2 Configuration Information 11

Chapter 3 Deployment Modes 17

Chapter 4 Before running wdeploy 21

Chapter 5 Running wdeploy 23

Deploying BusinessObjects Enterprise Web Applications Using wdeploy 3

Chapter 6 After running wdeploy 29

Chapter 7 Web/Web Application Server parameters reference 31

Chapter 8 Properties reference 33

4 Deploying BusinessObjects Enterprise Web Applications Using wdeploy

Chapter 9 Actions reference 49

Chapter 10 What deploy changes in your environment 57

Deploying BusinessObjects Enterprise Web Applications Using wdeploy 5

Appendix A Get More Help 65

6 Deploying BusinessObjects Enterprise Web Applications Using wdeploy

wdeploy is ANT-based with some Javascript helpers. It runs on Java 1.4 or

wdeploy can do any or all of the following:

Standalone web application server

8 Deploying BusinessObjects Enterprise Web Applications Using wdeploy

Distributed web server/web application

Deploying BusinessObjects Enterprise Web Applications Using wdeploy 9

10 Deploying BusinessObjects Enterprise Web Applications Using wdeploy

Configuration information used in BusinessObjects Enterprise deployment

Configuration information for specific applications is stored in the <applica

Their parameters can be modified.

Deployment information for applications

The <application>.properties files contain the following parameters:

Parameter Status Description

appvdir Mandatory. Context root of the application.

addtoclasspath Optional. Line to add to the classpath of

addtolibpath Optional. Line to add to the libpath of

buildfile Optional. Name of an .XML file containing

12 Deploying BusinessObjects Enterprise Web Applications Using wdeploy

warfile Mandatory. Mandatory if app_source_dir

app_source_dir Optional On Unix and Windows, directory

win_app_source_dir Optional See win_war_dir and

app_as_a_filetree Optional Boolean. False by default, or true.

zipfile Optional. Name of the static resource file

dont_split_content Optional. Boolean. False by default, or

Deploying BusinessObjects Enterprise Web Applications Using wdeploy 13

Parameter Status Description

file_limit_reached For WebSphere Boolean. False by default, or

war_dir Optional. On Unix and Windows: Name

Mandatory when wdeploy is

win_war_dir Optional. On Windows: Name of the direc-

wdeploy.prop.count Optional. Number of properties to set in

14 Deploying BusinessObjects Enterprise Web Applications Using wdeploy

wdeploy.prop#.name Optional. Name of the property to set in

wdeploy.prop#.value Optional. Value of the property to set in

wdeploy.prop#.ap Optional. A list of supported platforms

Supported platforms are: so-

Deploying BusinessObjects Enterprise Web Applications Using wdeploy 15

Web and web application server

16 Deploying BusinessObjects Enterprise Web Applications Using wdeploy

wdeploy allows you to deploy all BusinessObjects Enterprise web application

Two deployment modes are available:

In the standalone and distributed examples, static and dynamic resources

Figure 3-1: Standalone web deployment, with no separate web server

To deploy in standalone mode

18 Deploying BusinessObjects Enterprise Web Applications Using wdeploy