SAP BusinessObjects Business Intelligence platform Document Version: 4.1 Support Package Web Application Deployment Guide

(1)

SAP BusinessObjects Business Intelligence platform

Document Version: 4.1 Support Package 3 - 2014-03-25

(2)

1 Document History

The following table provides an overview of the most important document changes.

Note

For an up-to-date list of web application servers supported by this release, see the Product Availability Matrix (Supported Platforms/PAR), available on the SAP BusinessObjects section of the SAP Support Portal at:

https://service.sap.com/bosap-support .

Version Date Description

SAP BusinessObjects Business Intelligence platform 4.1

May, 2013 First release of this document.

SAP BusinessObjects Business Intelligence platform 4.1 Support Package 1

August, 2013 Updated Security exception when deploying AdminTools, dswsbobje, or BusinessProcessBI to JBoss 7.1 [page 88]. Workaround may also be re quired for dswsbobje and BusinessProcessBI applications when de ploying to JBoss 7.1.

SAP Software Update Manager (SUM) is now used instead of SAP Java Support Package Manager (JSPM) to deploy web applications to SAP NetWeaver. Updated SAP NetWeaver deployment with SAP Software Up date Manager (SUM) [page 76].

SAP BusinessObjects Business Intelligence platform 4.1 Support Package 2

November,

2013 ● Weblogic 10 has been dropped from supported platforms_{● Changes to installed languages has been updated because you can} add languages by doing a modify installation rather than a full re-in stallation.

● Updated wdeploy predeploy and wdeploy predeployall sections to in clude jrockit parameter

(6)

2 Getting Started

2.1 About this document

This document tells you how to deploy BI platform web applications to a web application server using the WDeploy tool.

For information related to the installation of the BI platform, see the SAP BusinessObjects Business Intelligence

Platform Installation Guide.

For information related to the administration of an SAP BusinessObjects Business Intelligence platform server, see the SAP BusinessObjects Business Intelligence Platform Administrator Guide.

2.2 What's new in the Web Application Deployment Guide?

Web application server support

For a list of platforms, databases, web application servers, web servers, and other systems supported by this release, see the Product Availability Matrix (Supported Platforms/PAR), available on the SAP BusinessObjects section of the SAP Support Portal at: https://service.sap.com/bosap-support . The Product Availability Matrix takes precedence over any discrepancies in the Web Application Deployment Guide.

BI platform 4.x

The following features have been introduced as of BI platform 4.x:

Table 1: What's new with the WDeploy deployment tool

Feature Description

GUI interface New GUI interface for deployall and undeployall actions.

Two levels of log files One log summary to help administrators understand the deployment status; one detailed log to help developers troubleshoot deployment issues.

Easier configuration Centralized configuration file for WDeploy global parameters; access server and WDe ploy parameters from WDeploy GUI.

Localization support WDeploy GUI localization support. No intermediate WAR

files

Intermediate WAR files are no longer created as a part of the deployment process. If you need to create a WAR file that is not tailored to a specific web application server, use the wdeploy buildwarall command.

(7)

Feature Description

Simplified deploy ment

The number of WAR files used for BI platform web applications has been reduced. This helps reduce duplicate resource consumption and number of queries made from the web application server to the CMS.

Table 2: What's new in this document

Feature Description

Content reorganization Rather than list each WDeploy command for every web application server, now a WDeploy command is now shown only once, with examples for each sup ported web application server.

New features documented New WDeploy features have been documented.

BI platform product documentation is available in supported languages from the support web site, and is refreshed with up-to-date content as it becomes available between releases. For the most recent product documentation, visit http://help.sap.com.

2.3 Who should read this documentation

This documentation is intended for the system administrator or IT professional working to support an installation of the BI platform. Familiarity with your overall network environment, port usage conventions, database

environment, and web server software is essential.

2.4 Variables

The following variables are used throughout this guide.

Variable Description

<BIP_INSTALL_DIR> The directory where the BI platform is installed.

<WAS_HOSTNAME> The hostname or IP of the web application server where BI

platform web applications are deployed.

<WEB_APP> The name of a BI platform web application. For example, a

value for <WEB_APP> is BOE. This application has a configuration file called BOE.properties, and the WDeploy tool creates BOE.war during predeploy steps for certain application servers.

For a complete list of BI platform web applications, see SAP BusinessObjects Business Intelligence platform WAR and EAR files [page 11].

(8)

Variable Description

<WEB_APP_SERVER> The shorthand name of the web application server used by

the WDeploy tool. For example, the value of

<WEB_APP_SERVER> for Tomcat 7.0 is tomcat7. For a complete list of values, see Values for WEB_APP_SERVER [page 47].

2.5 Terminology

The following terms are used throughout the BI platform documentation:

Term Definition

add-on products Products that work with the BI platform but have their

own installation program, such as SAP BusinessOb jects Explorer

Auditing Data Store (ADS) The database used to store auditing data

BI platform An abbreviation for the SAP BusinessObjects Business

Intelligence platform

bundled database; bundled web application server The database or web application server shipped with the BI platform

cluster (noun) Two or more Central Management Servers (CMSs)

working together and using a single CMS database

cluster (verb) To create a cluster

For example, to create a cluster:

1. Install a CMS and CMS database on machine. 2. Install a CMS on machine B.

3. Point the CMS on machine B to the CMS database on machine A.

cluster key Used to decrypt the keys in the CMS database

You can change the cluster key in the CCM, but you cannot reset the key like a password. It contains en crypted content and is important not to lose.

CMS An abbreviation for the Central Management Server

CMS database The database used by the CMS to store information

(9)

Term Definition

deployment The BI platform software installed, configured, and run

ning on one or more machines

installation An instance of BI platform files created by the installa

tion program on a machine

machine The computer on which the BI platform software is in

stalled

major release A full release of the software, such as 4.0

migration The process of transferring BI content from a previous

major release (for example, from XI 3.1), using the up grade management tool.

This term does not apply to deployments with the same major release. See promotion.

minor release A release of some components of the software, such as

4.1

node A group of BI platform servers that run on the same

machine and are managed by the same Server Intelli gence Agent (SIA)

patch A small update for a specific Support Package version

promotion The process of transferring BI content between deploy

ments with the same major release (for example, 4.0 to 4.0), using the promotion management application

server A BI platform process. A server hosts one or more

services.

Server Intelligence Agent (SIA) A process that manages a group of servers, including

stopping, starting, and restarting servers

support package A software update for a minor or major release

web application server A server that processes dynamic content. For example,

the bundled web application server for 4.1 is Tomcat 7.

upgrade The planning, preparation, migration, and post-proc

(10)

3 Overview of web application deployment

The BI platform installation program can deploy web applications only to the bundled Tomcat web application server. All other supported web application servers require that web applications be deployed after the installation is complete. It is recommended that you use the WDeploy web application deployment tool. For information and instructions on how to deploy using the WDeploy tool, see the “To deploy web applications with the WDeploy tool” section of this guide.

You can also deploy web applications with your application server's administrative console if you prefer. Web applications deployed with the web application server's administrative console must first be modified to be deployable WAR or EAR files. The wdeploy predeploy and wdeploy predeployall commands automate this process. After using these predeployment commands, jump to the “To deploy web applications with the

administrative console” section of the guide for instructions. However, if you have extensive knowledge of your web application server and know how to customize web applications for deployment, this process can be done by hand. The manual tailoring of web applications for deployment to a web application server is not covered in this guide.

3.1 Overview of OSGi WAR files

The OSGi framework for Java web applications simplifies the deployment of the web applications bundled with the BI platform. It allows web applications, language packs, SDKs, plugins, and other resources to exist in a single bundle that can be deployed to a web application server in one step.

Deploying a single WAR file also means fewer web sessions are needed when a user accesses multiple web applications, which reduces the memory, disk, and processing load placed on a web application server.

3.2 Fail-over and load balancing

The BI platform supports clustered web application servers with load balancing. Hardware or software load balancers can be used as the entry-point for the web application servers to ensure that the processing is evenly distributed among the web application servers.

The following hardware load balancers are currently supported: ● Cisco Application Control Engine (ACE) module.

● The F5 BIG-IP family of load balancers.

The following persistence types are currently supported: ● Source IP address persistence.

● Cookie persistence Insert mode (ArrowPoint Cookie).

Load balancing a cluster of the BI platform servers is not required, as the Central Management Server (CMS) already distributes work between cluster nodes.

(11)

Note

The Central Management Console (CMC) web application does not support session fail-over. However, BI launch pad does support session fail-over, so users will not notice if there is a problem with one of the BI platform server machines in your deployment.

3.2.1 Web application clustering support

The Central Management Console (CMC) and BI launch pad web applications can be used in environments with a variety of different clustered, load balanced, or fault tolerant configurations. The table below lists configuration support for CMC and BI launch pad web applications.

Web application Clustered web

application servers Load balancers with session affinity Load balances without session affinity

Fault tolerant

BI launch pad (stateless)

Supported Supported Unsupported Yes CMC (stateful) Supported Supported Unsupported No

Note

The WDeploy tool is not supported for deployment to a cluster or cluster software such as Websphere Application Server Network Deployment.

3.3 SAP BusinessObjects Business Intelligence platform

WAR and EAR files

The functionality that makes up the BI platform is divided between several web applications to make it easy to deploy only the components required by your organization. In the BI platform 4.2, many of the core web applications included with previous releases have been bundled into a single OSGi archive. This saves web application server memory and the reduces the number of web sessions needed for web applications that previously had multiple archives.

For example, BI platform XI 3.x included the Central Management Console (CMC) and InfoView (now BI launch pad) web applications archived as CMC.war and InfoView.war. The BI platform 4.2 has consolidated the CMC and InfoView (now BI launch pad) web applications, along with others, into a single archive named BOE.war or BOE.ear.

The WDeploy tool is used to automate the process of tailoring web applications to be deployable on a supported web application server. While it is possible for an experienced administrator to manually tailor a web application for a specific web application server, it is recommended that the WDeploy tool be used to automate the process. The following table lists the web application archives, the web applications that require them. Web applications not automatically deployed by the installation program must be deployed post-install.

(12)

Web application archive (may be WAR or EAR)

Deployed automatically? Description

BOE Yes OSGi archive of core web applications,

including:

● Analytical Reporting ● CMC

● SAP Crystal Reports

● BI launch pad (formerly InfoView) ● Eclipse IDE support

● Lifecycle Manager ● Monitoring ● OpenDocument

● BI workspace (formerly Dashboard Builder)

● Platform search ● Platform services ● Visual difference

● SAP BusinessObjects Dashboards (formerly Xcelsius)

BusinessProcessBI (deprecated) Yes This web application is deprecated. It

provides support for legacy Crystal Reports web services and SDK components, including: ● Crystal Enterprise

● Crystal Reports Report Application Server (RAS)

● SAP BusinessObjects Dashboards (formerly Xcelsius)

● SAP BusinessObjects Analysis, OLAP edition (formerly Voyager)

clientapi Yes SAP Crystal Reports JavaScript API

support.

dswsbobje Yes Web Services components, including:

● Session ● BI platform ● BI catalog

● Federation Administration tool ● Live Office

● Web service query tool (formerly Query as a Web Service) ● Publishing

● Report Engine

● SAP BusinessObjects Web Intelligence (formerly Web Intelligence)

● SAP BusinessObjects Dashboards web services (formerly Xcelsius)

(13)

Web application archive (may be WAR or EAR)

Deployed automatically? Description

jsfplatform No Java Server Faces support and

examples.

MobileOTA14 No Web application for mobile client

support.

OpenSearch No OpenSearch support.

AdminTools Yes Query Builder support.

The following table compares the WAR files shipped in previous versions, and where to find the functionality in the BI platform 4.2.

Previous web application archive (may be WAR or

EAR) New web application archive (may be WAR or EAR)

AdminTools AdminTools

AnalyticalReporting BOE

BusinessProcessBI BusinessProcessBI (deprecated)

CmcApp BOE CmcAppActions BOE CrystalReports BOE Xcelsius BOE dswsbobje dswsbobje InfoViewApp BOE InfoViewAppActions BOE LCM BOE OpenDocument BOE PerformanceManagement BOE PlatformServices BOE PMC_Help BOE VoyagerClient BOE XCTemplateUploader BOE

3.3.1 To deploy MobileOTA14.war for mobile application

support

The BI platform installation program does not deploy the MobileOTA14 web application that provides support for mobile applications.

To use mobile applications, you must deploy the MobileOTA14 archive (MobileOTA14.war or MobileOTA14.ear) manually once the installation process is complete.

(14)

Note

The WDeploy GUI tool cannot be used to deploy individual web applications. To deploy an individual web application, such as MobileOTA14, use the WDeploy command-line tool.

1. Before deploying the MobileOTA14 web application, ensure that the WDeploy configuration file

config.<WEB_APPLICATION_SERVER> has been configured appropriately for your web application server. See WDeploy configuration files [page 30].

2. Deploy the MobileOTA14 web application.

To deploy the MobileOTA14 web application, use the following WDeploy command: wdeploy.sh <WEB_APPLICATION_SERVER>

-Dwar_dir=<LOCATION_OF_MOBILEOTA14.WAR>

-DAPP=MobileOTA14 deploy

For example, the following command deploys MobileOTA14 to a WebSphere 7 web application server: wdeploy.sh websphere7

-Dwar_dir=/sap/sap/businessobjects_xi40/mobile_14/Client -DAPP=MobileOTA14

deploy

3. Restart the web application server.

4. Access the following URL to ensure that the MobileOTA14 web application is working: http://<HOSTNAME>:<PORT>/MobileOTA14

Substitute <HOSTNAME> for the web application server hostname, and <PORT> for the web application server port number.

For more information on mobile products, refer to the SAP BusinessObjects Mobile Installation and Deployment

Guide.

3.3.2 To deploy OpenSearch.war for OpenSearch support

The installation program does not deploy the OpenSearch web application that provides support for OpenSearch applications.

To use OpenSearch applications, you must deploy the OpenSearch.war archive manually once the installation process is complete.

Note

The WDeploy GUI tool cannot be used to deploy individual web applications. To deploy an individual web application, such as OpenSearch, use the WDeploy command-line tool.

1. Ensure that web application server's connection details have been set in the WDeploy web application server configuration file. The file is located in:

<BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy/conf/config.<WEB_APP_SERVER>

For more information on the WDeploy web application server configuration file, see “Configuration files” in the

(15)

2. Update the OpenSearch configuration in the OpenSearch web application's config.properties file. The file is located in:

<BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/warfiles/OpenSearch/WEB-INF Ensure that the following parameters are configured for your server:

○ cms: the CMS hostname and CMS port number. For example, use the format: <CMS_HOSTNAME>:<PORT>. ○ opendoc: the URL of the OpenDocument web application. For example: http://

<WAS_HOSTNAME>:<PORT>/BOE/OpenDocument/opendoc/openDocument.jsp. ○ proxy.rpurl: reverse proxy URL, if your organization uses a reverse proxy server.

○ proxy.opendoc.rpurl: the OpenDoc reverse proxy server URL, if your organization uses an OpenDoc reverse proxy server.

3. Deploy the OpenSearch web application.

To deploy the OpenSearch web application, use the following WDeploy command: wdeploy.sh <WEB_APPLICATION_SERVER>

-Dapp_source_dir=<LOCATION_OF_OPENSEARCH_WEB_APP_SOURCE_TREE> -DAPP=OpenSearch

deploy

For example, the following command deploys the OpenSearch web application to a WebSphere 7 web application server:

wdeploy.sh websphere7

-Dwar=/sap/sap_bobj/enterprise_xi40/warfiles/OpenSearch -DAPP=OpenSearch

deploy

For more information on OpenSearch related products, refer to “OpenSearch” section of the SAP

BusinessObjects Business Intelligence Platform Administrator Guide.

3.4 Default context roots

All web applications can be deployed to a custom context root on your web application server. The following table lists the context roots for each web application.

Web application Context path

Central Management Console (CMC) /BOE/CMC

BI launch pad /BOE/BI

Open Document /BOE/OpenDocument

SAP Crystal Reports JavaScript API /clientapi

Web Services provider /dswsbobje

(16)

3.5 Custom root contexts and context paths

BI platform web applications can be deployed to a custom location on a web application server. This location is reflected in the URL used to access the web application from a web browser, and is often known as the context. A root context is the top-level folder on a web application server in which web applications are located. The default root context for BI platform web applications is /BOE. For example, on a web application server named

www.mycompany.com, the URL prefix used to access web applications on the server would be http:// www.mycompany.com/BOE/.

A context path (sometimes referred to as a virtual directory) is a folder within a root context, in which a web application is located. For example, the default context path for the BI launch pad application is /BI. The URL used to access the BI launch pad web application on a web application server named www.mycompany.com would be http://www.mycompany.com/BOE/BI.

Both the root context and the context path can be changed to suit the needs of your organization. The following table lists examples of deploying a web application named MyApp to different root and web application context paths. The following topics describe how to customize root and web application context paths.

3.5.1 To change the root context

You can change the root context used by the BI platform web applications (excluding the AdminTools web application. AdminTools must use the default root context to function correctly). The default setting is to have an empty root context, so the web application context path is shown directly after the server address in a URL. For example, an empty root context results in a URL such as http://localhost:8080/BOE/CMC, where http://localhost:8080/ is the server and port number, there is no root context, and BOE/CMC is the web application context path. Setting the root context to /MY_COMPANY would change the URL example shown above to http://localhost:8080/MY_COMPANY/BOE/CMC.

When using the WDeploy tool, the root context can be set in the Options screen. When using the WDeploy command-line tools, the root context for the BI platform web applications is set in the following configuration file:

<BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy/conf/wdeploy.conf Use a text editor to update the value for root_context_path given in wdeploy.conf. For example, wdeploy.conf configuration file contains the following parameters by default:

as_lang=en work_dir= war_dir= app_source_tree= disable_CMC=false disable_InfoView=false JCoStandalone= root_context_path= recent_app_svr=<WEB_APP_SERVER>

(17)

3.5.2 To change a web application's context path

You can change the default context path (sometimes referred to as the virtual directory) of BI platform web applications.

For example, the BOE web application's default context path is BOE, which can be seen in the sample URL http://localhost:8080/BOE/CMC. In this example, http://localhost:8080/ is the server and port number, BOE is the web application, and /CMC is a component included within the BOE web application. The context path for BI platform web applications is set in the following configuration file:

<BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy/conf/apps/<WEB_APP>.properties Use a text editor to update the value of the appvdir parameter found in configuration file

WEB_APP.properties.

For example, the BOE.properties configuration file contains the following parameters by default: warfile=BOE.war

appvdir=BOE buildfile=BOE.xml osgisupported=true

(18)

4 To deploy web applications with the

WDeploy tool

4.1 Overview of WDeploy

The WDeploy tool is included with the BI platform to ease deployment of web applications to Java-based web application servers.

There are two different interfaces to WDeploy:

● A traditional, text-based interface that processes commands and parameters given on the command-line. ● A new console-based guided assistant similar to the BI platform installation program, which prompts the user

to enter deployment parameters.

While each supported web application server requires different commands and web application package updates, WDeploy provides a consistent interface for administrators, and automates the adjustments needed for

deployment to a specific web application server.

For example, to deploy a web application to an IBM WebSphere web application server, a single WDeploy command performs the following tasks:

1. Creates settings specific to IBM WebSphere in the web application's web.xml file. 2. Bundles the web application content into a web archive.

3. Creates an EAR file containing the web application.

4. Calls IBM WebSphere deployment tools to deploy the web application.

4.2 WDeploy prerequisites

This section details prerequisites for the deployment of the BI platform web applications to supported web application servers.

Note

Before deploying web applications to WebSphere, see WASX7017E: Exception deploying in WebSphere [page 92].

For more information on WDeploy GUI prerequisites, see WDeploy GUI tool prerequisites [page 69].

4.2.1 Before you deploy web applications

Your web application server must be installed and working before you install the BI platform. Consult your web application server documentation for installation instructions.

Your web application server should have at least 5 GB of free disk space, in addition to any other requirements given by other software installed on the machine.

(19)

We recommended that you change the heap size and maximum perm size settings of your JVM to Xms128m -Xmx2048m -XX:MaxPermSize=512m. If using Tomcat for example, your modified settings would look like this:

JAVA_OPTS="-Xms128m -Xmx2048m -XX:MaxPermSize=512m"

Note

For SAP NetWeaver, ensure that the maximum heap size is at least 4096 megabytes. For example: JAVA_OPTS="-Xms128m -Xmx4096m -XX:MaxPermSize=512m"

Consult your JVM documentation for information on changing your Java memory settings.

Before you begin the deployment process, ensure that the web application server is installed and verify that the application server is running correctly by launching its administrative console.

4.2.2 Hardware requirements

The deployment of web applications to a web application server with the WDeploy tool requires at least 4 GB of RAM (8 GB for SAP NetWeaver), and 15 GB of free disk space, plus a minimum 5 GB of free space on the partition that hosts the /tmp temporary folder, for the deployment of web applications. This is in addition to any other requirements of the web application server or any other servers or services installed on the host.

4.2.3 64-bit support

The BI platform is only supported on 64-bit operating systems and only supports 64-bit web application servers with a 64-bit JDK.

4.2.4 Minimum rights for deploying web applications with a

different account

Tip

It is recommended that you install the BI platform and run the WDeploy tool (wdeploy.sh) with the same user account used to install your web application server.

To deploy web applications with the WDeploy tool with a user account different from the one used to install the web application server, you must ensure that this account has appropriate permissions to certain web application server directories. Set the privileges listed in the following table before running the WDeploy tool. Alternatively, ensure this separate account is a member of the same group as the web application server account and set the privileges for the User and Group columns only.

(20)

Note

In addition to the right to execute files or folders mentioned in the tables below, the right to execute is also required on the parent directory.

Tomcat 6 and 7

Directory Recursive User Group Other Example command Tomcat user

account home and BI platform user folder subdirectory No rwx r-x r-x chmod 755 ~<TOMCAT_US ER> Web application deployment directory ($as_dir/ webapps) No rwx rwx rwx chmod 777 <TC_HOME>/ webapps Tomcat binary directory ($as_dir/bin) No rwx rwx rwx chmod 777 <TC_HOME>/ bin Tomcat configuration directory ($as_dir/conf) Yes rwx rwx rwx chmod -R 777 <TC_HOME>/ conf Tomcat library directory ($as_dir/lib) No rwx r-x r-x chmod 755 <TC_HOME>/ lib/*

(21)

WebLogic 11gR1

Directory Recursive User Group Other Example command WebLogic user

account home and BI platform user folder subdirectory No rwx r-x r-x chmod 755 <WL_USER> Web domain binaries ($WL_HOME/ <PROJECT>/ <DOMAIN>/ <BASE>/bin) No rwx rwx rwx chmod 777 <WL_HOME>/ user_projec ts/ domains/ base_domain /bin WebLogic server libraries ($WL_HOME/ server/lib) No rwx r-x r-x chmod 755 <WL_SERVER> / user_projec ts / lib WebLogic server binaries ($WL_HOME/ server/ domains/ base_domain common/bin) No rwx rwx r-x chmod 775 <WL_SERVER> / user_projec ts /bin WebLogic server modules ($WL_HOME/ server/ domains/ base_domain modules) No rwx rwx r-x chmod 775 <WL_SERVER> / modules WebLogic Java ($WL_HOME/ jdk150_06) No rwx rwx r-x chmod 775 <WL_SERVER> / jdk150_06

(22)

WebSphere 7.0, 8.5, and 8.5.5

Directory Recursive User Group Other Example command WebSphere user

account home and BI platform user folder subdirectory No rwx r-x r-x chmod 755 ~<WEBSPHERE _USER> WebSphere profiles directory ($WEBS_HOME/ AppServer/ profiles) Yes rwx rwx rwx chmod -R 777 <WEBSPHERE_ HOME>/ AppServer/ profiles WebSphere admin script ($as_dir/bin/ wsadmin.sh) No rwx r-x r-x chmod 755 <WEBSPHERE_ HOME>/ bin/ wsadmin.sh WebSphere plugin script ($as_dir/bin/ GenPluginCfg. sh) No rwx r-x r-x chmod 755 <WEBSPHERE_ HOME>/ bin/ GenPluginCf g.sh WebSphere security ($as_dir/bin/ securityProcs .jacl) No rwx r-x r-x chmod 755 <WEBSPHERE_ HOME>/ bin/ securityPro cs.jacl WebSphere security ($as_dir/bin/ LTPA_LDAPsecu rityProcs.jac l) No rwx r-x r-x chmod 755 <WEBSPHERE_ HOME>/ bin/ LTPA_LDAPse curityProcs

(23)

Directory Recursive User Group Other Example command .jacl WebSphere plugins directory ($as_dir/ plugins) No rwx r-x r-x chmod 755 <WEBSPHERE_ HOME>/ plugins WebSphere Java directory ($as_dir/java) No rwx r-x r-x chmod 755 <WEBSPHERE_ HOME>/ java WebSphere deployment tool directory ($as_dir/ deploytool) No rwx r-x r-x chmod 755 <WEBSPHERE_ HOME>/ deploytool WebSphere properties directory ($as_dir/ properties) No rwx r-x r-x chmod 755 <WEBSPHERE_ HOME>/ properties

Note

You must accept the WebSphere web application server SSL certificate before you can use WDeploy. To accept the certificate, use wsadmin command in the format

<WEBSPHERE_HOME>/AppServer/bin/wsadmin

-conntype SOAP -port <ADMIN_PORT> -user <AS_ADMIN_USERNAME> -password <AS_ADMIN_PASSWORD>

. For example:

./wsadmin -conntype SOAP

-port 8880 -user administrator -password websphere

(24)

4.2.5 Set ulimit to unlimited

To successfully build and deploy BI platform web applications, the host operating system or user account ulimit setting must be configured as unlimited.

Set the ulimit configuration with the ulimit command, or modify the system configuration file /etc/

security/limits.conf. For more information about the ulimit setting, see the documentation included with your operating system.

4.2.7 To set up the Java environment

WDeploy requires a Java Virtual Machine to be available on the host system. Java Development Kit (JDK) 1.6 is installed automatically by the BI platform installation program, but must be set up or copied from the BI platform server when manually installed on a dedicated machine.

The JDK installed by the BI platform installation program is used by default. If you are using a dedicated web application server, you must set up the JDK by performing either a Web Tier installation, or manually installing an appropriate JDK (1.5 or 1.6, as supported by the web application server). When setting up a JDK manually, ensure that the following environment settings have been configured:

● WDeploy attempts to use the JVM installed with the BI platform first. If this JVM cannot be found, then WDeploy attempts to use the <JAVA_HOME> environment variable setting that is set to a valid Java directory. If no valid or suitable JVM is found, WDeploy exits.

● The user account PATH environment variable includes:

<JAVA_HOME>/bin

● To allow WDeploy to run from any directory, update the PATH environment variable to include:

<BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy

4.2.8 Web application server parameter configuration files

Before using the WDeploy command-line interface to deploy a web application, ensure that the correct parameters are set in the WDeploy web application deployment server parameter configuration file. Set parameters are used as default settings, and no longer need to be given on the command-line.

Note

You do not need to set parameters in these deployment configuration files if you are using the GUI interface, or if you are only predeploying using the wdeploy predeploy or wdeploy predeployall commands.

The configuration file appropriate for your web application server is located in the following folder:

<BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy/conf. For example, if you are using Tomcat 7, select /opt/sap/sap_bobj/enterprise_xi40/wdeploy/conf/config.tomcat7.

Use a text editor to update values specific to your organization's web application server. For more information on how to configure WDeploy configuration files, see WDeploy configuration files [page 30].

Parameters set in the WDeploy web application server parameter configuration file can be overridden when calling WDeploy from the command-line, using switches and parameters to change the default behavior. However, it is

(25)

highly recommended that you configure the parameters in the config.<WEB_APP_SERVER> configuration file appropriate for your deployment.

4.2.9 To install WDeploy on remote web application server

To deploy web applications to a dedicated web application server, perform a Web Tier or Custom / Expand installation with the BI platform installation program. If you prefer to copy the WDeploy tool manually, copy the following folder to the web application server:

<BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy

Note

When copying the WDeploy tool manually, ensure that the environment variable JAVA_HOME is configured appropriately on the web application server.

4.3 SAP System Landscape Directory (SLD) registration

Your organization may use the SAP System Landscape Directory (SLD) Data Supplier (DS) to maintain a central repository of information about your organization's SAP software. It provides administrators with detailed information about the system's topology and software components. For more information on setting up the BI platform for SLD, see “Registration of BI platform in the System Landscape” in the SAP BusinessObjects Business

Intelligence Platform Administrator Guide and SAP Note 1653689.

The SLD registration notifies the SLD when web applications are deployed or undeployed, keeping the SLD database current with the latest information about your organization's web application deployments. Web application components can be registered with SLD on the following web application servers: ● SAP NetWeaver

● Apache Tomcat 6.0 and 7.0 ● IBM WebSphere 7.0

4.3.1 To enable SLD registration for SAP NetWeaver

SAP System Landscape Directory Data Supplier (SLD-DS) integration is available for SAP NetWeaver. For information on SLD-DS integration and NetWeaver, see the System Landscape Directory SCN document at:

(26)

4.3.2 To enable SLD registration for Tomcat

To use SAP System Landscape Directory Data Supplier (SLD-DS) with Apache Tomcat, the SLDREG registration tool must be installed on each Apache Tomcat web application server.

Note

SLDREG is not installed as a part of the BI platform. For information on installing SLDREG, refer to SAP Note 1018839.

To configure SLDREG so that the SLD is updated whenever web applications are deployed or undeployed from an Apache Tomcat web application server, refer to SAP Note 1508421.

Note

The required sap.com~TomcatSLDDataSupplierWEB.war file attached to SAP Note 1508421 can also be found in the <BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/warfiles/webapps folder after the Java Web Applications feature is installed during a Web Tier installation.

4.3.3 To enable SLD registration for WebSphere

To use SAP System Landscape Directory Data Supplier (SLD-DS) with WebSphere, the SLDREG registration tool must be installed on each WebSphere web application server.

Note

SLDREG is not installed as a part of the BI platform. For information on installing SLDREG, refer to SAP Note 1018839.

To configure SLDREG so that the SLD is updated whenever web applications are deployed or undeployed from a WebSphere web application server, refer to SAP Note 1482727.

4.4 Deployment modes

WDeploy supports two different deployment modes: 1. Standalone mode (a web application server)

The web application server serves both static content (HTML pages, images, documents, JavaScript, Cascading Style Sheets) and dynamic content (Java Server Pages, JAR files, XML files).

2. Split web tier mode (a web application server plus a dedicated web server)

A dedicated web server receives requests from web browsers and serves all static content (HTML pages, images, documents, JavaScript, Cascading Style Sheets). Requests for dynamic content (Java Server Pages, JAR files, XML files) are forwarded to the dedicated application server and returned to the web browser when the content has been formed.

(27)

This mode is suited to larger production deployments where scalability and performance are key.

It is also possible to use WDeploy to deploy web applications to a web application server installed on the same system as the BI platform. This configuration can be used for small development or test systems, and is not recommended for production systems.

4.4.1 Standalone deployments

Standalone mode refers to a web application server serving both static and dynamic content to web clients. The web application server could run on the same machine as the BI platform, or on a separate machine connected by network.

In the following diagram, web clients connect through a firewall to a web application server [1] that serves both static and dynamic content. Processing requests from the web application server are sent to the BI platform Central Management Server (CMS) [2].

In the diagram above, the WDeploy is installed as a component of the CMS [2], and web applications are

separated out into directories for static and dynamic content. The dynamic content can now be copied to the web application server [1].

The WDeploy tool can also be installed or copied to a dedicated web application server [1], making it easy to deploy separated content received from a CMS [2].

This mode is best suited for small deployments with a limited number of users. The advantage of a standalone deployment is that it is easy to deploy and maintain, but it may not scale to a large number of users because the web application server delivers both static and dynamic content.

4.4.2 Split web tier deployments

A web tier deployment separates static and dynamic web application content so that static content is served by a web server, and dynamic content is served by a web application server. The web and web application servers could run on the same machine, or separate machines connected to a network.

Note

The following web application are not supported in split web tier mode deployments ● Web Services

● MobileOTA14 ● OpenSearch

(28)

● jsfplatform

In the following diagram, web clients connect through a firewall to a web server [1] that serves only static content (HTML pages, images, documents, JavaScript, Cascading Style Sheets). When dynamic content is required, the web server sends a request to the web application server [2]. Any requests that require further processing by the BI platform are sent to Central Management Server (CMS) for processing [3].

In the diagram above, the WDeploy is installed as a component of the CMS [3], and web applications are

separated out into directories for static and dynamic content. The dynamic content can now be copied to the web application server [2], and the static content copied to the web server [1].

The WDeploy command can also be installed on dedicated web [1] and web application [2] servers, making it easy to deploy separated content received from a CMS [3].

If an organization implements security measures that restrict access to server machines, the separated static and dynamic content can be sent separately to those with the authority to deploy content.

Split deployments are best suited to mid or large-sized deployments with a large or increasing number of users. The advantage of a split deployment is that it is scalable and provides good performance.

Note

Web, web application, and BI platform servers can be clustered to provide an even greater degree of scalability, availability, and performance.

4.4.2.1 Supported dedicated web and web application server

combinations

WDeploy supports the following web and web application server configurations for split deployments: ● Apache 2.2 web server with Tomcat 6 or 7

● Apache 2.2 web server with WebLogic 10.3.x ● IBM IHS web server 7 with WebSphere 7.0

● IBM IHS web server 8.5 with WebSphere 8.5 or 8.5.5

Note

(29)

4.4.2.2 To deploy web applications on a remote machine

Use the procedure below to deploy web applications to a remote machine. In this procedure, Box 1 refers to the machine hosting a BI platform installation, and Box 2 is the remote machine on which the web application server is installed.

1. Create on Box 2 the following directories.

○ <BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy. This folder contains the WDeploy scripts and configuration files.

○ <BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/warfiles/webapps ○ <BIP_INSTALL_DIR>/InstallData

These directories reflect the default directory structure installed on Box 1.

Tip

Although you can customize the folder structure to meet your specific requirements, it is recommended that you maintain files within the same folder structure or hierarchy in Box 2 as in Box 1.

2. Copy the following files from Box 1 to Box 2.

○ Folder <BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy.

Tip

Remove the contents under <BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy/ workdir before the file copy, if that folder is not empty.

○ Folder <BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/warfiles/webapps.

○ Folder <BIP_INSTALL_DIR>/InstallData/setup.engine. 3. Set the JAVA_HOME environment variable to the JDK 1.5 or 1.6 directory.

4. Modify the WDeploy configuration file for your web application server. Provide all the required information to enable WDeploy to deploy the web application.

For example, to modify the configuration file for WebLogic 11, you would modify the file to: as_domain_dir=C:\Oracle\Middleware\user_projects\domains\base_domain as_instance=AdminServer

as_admin_port=7001

as_admin_username=weblogic as_admin_password=weblogic

The configuration file is located in the following directory:

<BOE_INSTALL_DI>R/sap_bobj/enterprise_xi40/wdeploy/conf/config.<WEB_APP_SERVER>

5. Run the WDeploy script from its location in Box 2 by opening command line console and entering the following command:

<BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy/wdeploy.sh <WEB_APP_SERVER>

-Dapp_source_tree=“<BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/warfiles/

webapps” deployall

(30)

Note

○ You can set WDeploy parameter defaults values in the WDeploy configuration file

<BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy/conf/wdeploy.conf, instead of giving parameters on the command-line. For example, set the parameters:

○ app_source_tree or war_dir ○ work_dir

○ root_context_path

For more information, see WDeploy configuration file [page 31].

○ You pass the argument -Dwar_dir to specify the location of generic WAR files as input for deployment. For example, to deploy a generic BOE.war file:

<BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy/wdeploy.sh

<WEB_APP_SERVER>

-Dwar_dir="/myGenericWarFiles/BOE.war" -DAPP=BOE

deploy

○ To create generic WAR files for all BI platform applications, run the following command:

<BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy/wdeploy.sh buildwarall

-Dapp_source_tree=“<BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/

warfiles/webapps”

-Dwar_dir=“/myGenericWarFiles”

○ Pass the parameter -Dwar_dir=<TARGET_LOCATION_OF_GENERIC_WAR_FILE> to specify the location to output the generic WAR files to.

4.5 WDeploy configuration files

The WDeploy configuration files contain settings saved in a key-value pair text format. Read by WDeploy when it starts, the options and parameters saved in the configuration files are used as default settings and no longer need to be given on the command-line. However, all options and parameters can still be given on the command-line, which overrides the configuration file. Options and parameters given on the command-line do not change the options stored in configuration files.

Note

It is recommended that web application server administrator account passwords are not stored in the WDeploy configuration file, but rather passed to WDeploy from the commandline with the parameter

-Das_admin_password=<PASSWORD>.

There are three configuration files used by WDeploy:

● WDeploy configuration file (<BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy/conf/ wdeploy.conf): stores general WDeploy settings that apply to all web applications severs.

(31)

● Web application server configuration files (<BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/ wdeploy/conf/config.<WEB_APP_SERVER>): stores settings for a specific web application server. ● Web application configuration file (<BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy/conf/

apps/<WEB_APP>.properties): stores individual deployment settings for each web application.

4.5.1 WDeploy configuration file

The <BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy/conf/wdeploy.conf configuration file stores settings likely to be shared among any web application servers in your deployment.

Properties stored in the WDeploy configuration file can be overridden from the commandline using the -D<PROPERTY> switch parameter. However, it is highly recommended that you configure the parameters in the config.<WEB_APP_SERVER> configuration file appropriate for your deployment.

For a complete list of WDeploy properties, see WDeploy property parameters [page 38].

4.5.2 Web application server configuration files

As each web server and web application server requires different WDeploy settings, the WDeploy tool references a configuration file for each supported server. The configuration files are stored in the WDeploy conf folder as follows:

<BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy/conf/config.<WEB_APP_SERVER>

Substitute <WEB_APP_SERVER> for the name of the web application server to which the WDeploy tool deploys. The following list shows all configuration files for currently supported web application servers:

● config.jboss7 (JBoss 7.1)

● config.sapappsvr73 (SAP NetWeaver) ● config.tomcat6 (Tomcat 6.0)

● config.tomcat7 (Tomcat 7.0)

● config.weblogic11 (WebLogic 10.3.x (11gR1)) ● config.websphere7 (WebSphere 7.0)

● config.websphere8 (WebSphere 8.5 or 8.5.5)

The following sections list the configuration options available for each supported web and web application server.

4.5.2.1 JBoss 7.1 configuration file

Set default values for the following parameters in config.jboss7 (JBoss 7.1) to avoid having to give them on the command-line every time.

(32)

Table 3: Mandatory WDeploy parameters for JBoss 7.1

Parameter name Description Example

as_dir Installed location of the JBoss web

application server (<JBOSS_HOME>).

/opt/jboss-as-7.1.1.Final

as_instance Name of the JBoss application

server instance.

default

4.5.2.2 SAP NetWeaver configuration file

Note

Currently the WDeploy tool does not support deployment to SAP NetWeaver. You must use the wdeploy predeploy or wdeploy predeployall commands of the WDeploy tool to create SCA files and deploy manually using SAP Software Update Manager (SUM). You do not need to set parameters in

config.sapappsvr73 to use these predeployment commands. (Note that the configuration file

config.sapappsvr73 contains settings for all supported versions of SAP Netweaver, not just version 7.3). Set default values for the following parameters in config.sapappsvr73 to avoid having to give them on the command-line every time.

Table 4: Mandatory WDeploy parameters for SAP NetWeaver

as_dir Installed location of SAP NetWea

ver. /opt/sap

as_sid System ID of the target instance. AS1

as_instance Application server instance name. JC01

as_admin_port SAP NetWeaver administration re

quest port.

50004

as_admin_username SAP NetWeaver administrative ac

count username.

administrator

as_admin_password SAP NetWeaver administrative ac

count password.

password

clear.temp.dirs Passed to SAP NetWeaver during

deployment: toggles the automatic removal of temporary files. Should be set to "true".

true

use.deploy.controller Passed to SAP NetWeaver during

deployment: toggles use of the SAP Deploy Controller tool. Should be set to "true".

(33)

time.to.wait.factor Passed to SAP NetWeaver during

deployment: wait time in seconds for the WDeploy script to wait for the web application server to com plete deployment (for example "1600").

1600

4.5.2.3 Tomcat 6 or 7 configuration file

Set default values for the following parameters in config.tomcat6 or config.tomcat7 to avoid having to give them on the command-line every time.

When deploying to a split environment, where a Tomcat web application server is paired with a dedicated Apache web server, see To deploy to separate Apache web and Tomcat web application servers [page 59].

Table 5: Mandatory WDeploy parameters for Tomcat 6 or 7

as_instance Application server instance

name.

localhost

as_service_name Name of the Tomcat service

when the application server is installed as a Windows service (only applicable for installa tions on Microsoft Windows).

Tomcat6 or Tomcat7

as_dir Installed location of Tomcat 6

or 7. /opt/tomcat

as_service_key Registry key used by Tomcat to

give Java parameters (only ap plicable for installations on Mi crosoft Windows).

HKLM\SOFTWARE\Wow6432Node \Apache Software Foundation \Procrun 2.0\$<as_serv-ice_name>\Parameters\Java

as_service_key_value Tomcat's Java parameters: the

value of the registry key as_server_key.

Options.

4.5.2.4 WebLogic 11gR1 configuration file

Set default values for the following parameters in config.weblogic11 to avoid having to give them on the command-line every time.

(34)

Table 6: Mandatory WDeploy parameters for WebLogic 11gR1

as_admin_port WebLogic administration request

port.

7001

as_admin_username WebLogic administrative account

username.

weblogic

as_admin_password WebLogic administrative account

password.

password

as_instance Name of the WebLogic application

server instance.

AdminServer

as_domain_dir WebLogic domain directory. _{/opt/bea/weblogic/}

user_projects/domains/ base_domain

4.5.2.5 WebSphere 7, 8.5, or 8.5.5 configuration file

Set default values for the following parameters in config.websphere7 or config.websphere8 to avoid having to give them on the command-line every time.

Table 7: Mandatory WDeploy parameters for WebSphere 7 , 8.5, or 8.5.5

Parameter name Description Example value

as_soap_port Port number for SOAP application

server administration. If not set, the default SOAP port number will be used.

8880

as_instance The name of the WebSphere applica

tion server instance.

server1

as_admin_password WebSphere administrative account

password.

password

as_admin_username WebSphere administrative account

username.

administrator

as_profile_name Name of the profile created for Web

sphere Application Server. Give this parameter when a non-default profile is used for the deployment.

AppSrv01

as_virtual_host Virtual host to which the application

must be bound.

default_host

as_admin_is_secure Instructs WDeploy that WebSphere

security is enabled.

(35)

Parameter name Description Example value

Note

Values for as_admin_username and as_admin_password must be set when as_admin_is_secure is true").

as_dir Installed location of WebSphere. _/opt/IBM/

WebSphere/ AppServer

ws_instance Web server instance when deployed

to a split environment (dedicated web server).

webserver1

enforce_file_limit Indicates to WDeploy whether or not

the web application server may en counter issues loading applications that contain more than 65,535 files (false by default).

false

as_plugin_cfg_dir Location of the WebSphere

plugin-cfg.xml file. This parameter is only required for split web tier deploy ments. /opt/ AppServers/IBM/ WebSphere7/profiles/ AppSrv01/config/ cells/<cell_name>/ nodes/ <web-server_node>/serv ers/ <web-server_name>

4.5.2.6 Dedicated web servers in split deployments

When deploying web applications to a dedicated web server in split deployments, use the name of the supported web server:

● config.apache (Apache Web Server or IBM IHS)

Note

It is recommended that web application server administrator account passwords are not stored in the WDeploy configuration file, but rather passed to WDeploy from the commandline with the parameter

-Das_admin_password=<PASSWORD>.

Split deployments employ a dedicated web application server to serve dynamic content, and a dedicated web server to serve static content. The following table lists the web application servers that can be configured for a split deployment of the BI platform.

(36)

Application Server Apache web server

JBoss 7.1 No

SAP NetWeaver N/A

Tomcat 6.0 Yes

Tomcat 7.0 Yes

WebLogic 11gR1 Yes

WebSphere 7 Yes (IHS 7)

WebSphere 8.5 and 8.5.5 Yes (IHS 8.5)

4.5.2.6.1 Apache or IBM IHS (split deployment)

configuration file

Set default values for the following parameters in config.apache to avoid having to give them on the command-line every time.

Note

The same configuration file (config.apache) is used for Apache 2.2 or IBM IHS.

Table 8: Mandatory WDeploy parameters for Apache 2.2 or IBM IHS (split deployment)

connector_type The Apache connector type used to

configure split mode

tomcat6

deployment_dir Directory under which WDeploy cre

ates a subdirectory for static con tent served by the web server. WDe ploy creates a virtual directory on the web server, mapping the subdir ectory to the URL

/opt/apache2/htdocs

plugin_install_dir The root plugin installation directory

for WebSphere application servers. ${ws_dir}/Plugins

ws_dir The Apache web server installation

directory. /opt/apache2

Note

When using IBM IHS with a WebSphere 7, 8.5, or 8.5.5 web application server, ensure that as_plugin_cfg_dir is correctly configured in config.websphere7 or config.websphere8.

(37)

4.5.3 Web application configuration property file

Each web application can be deployed to a different location on the web application server, and can be configured with different packaging options.

Each deployable web application is configured in the configuration file <BIP_INSTALL_DIR>/sap_bobj/ enterprise_xi40/wdeploy/conf/app/<WEB_APP>.properties.

The following settings are available in a <WEB_APP>.properties configuration file:

Variable Description Example

warfile Name of the WAR file to create

for this web application.

dswsbobje.war

appvdir Name of the context path (also

known as a virtual directory) to which the web application is deployed.

dswsbobje

buildfile Ant build file used to build the

web application.

dswsbobje.xml

deploy_as_a_filetree Toggle to enable the deploy ment of an exploded WAR file when true.

true

classloading_mode Setting to determine the Class

loader order.

PARENT_LAST

classloader_package_ filtering

Filter for classloader. com.ctc.wstx.*,javax.xml.*,org.apache.

*

When deploying a web application to a specific location on a web application server, use the appvdir variable to set the location of the web application within the server's root context. For example, if a web application server's root context was http://www.mycompany.com/BOE, setting appvdir to mywebapp/ would result in the web application being accessible from http://www.mycompany.com/BOE/mywebapp/.

4.6 Using the WDeploy command-line tool

Before using the WDeploy command-line tool, ensure that the WDeploy configuration files have been configured appropriately for your web application server. See WDeploy configuration files [page 30].

For information on WDeploy prerequisites, see: ● WDeploy prerequisites [page 18]

● WDeploy GUI tool prerequisites [page 69]

The WDeploy command-line tool is installed as a part of the BI platform:

<BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy/wdeploy.sh There are two types of commands:

(38)

● General commands

Used to provide high-level information about the tool itself and the available web application server deployment. They are not used together with server names, properties, or actions. For example: ○ wdeploy.sh help

○ wdeploy.sh listappservers ● Deployment commands

Used to deploy specific web applications to a specific web application server. These commands always follow the format: server, properties, action. For example:

wdeploy.sh <WEB_APP_SERVER> [-D<PROPERTY>=<value>] <ACTION>

Where:

○ <WEB_APP_SERVER> is the name of the web or web application server and must match the name of the WDeploy configuration file <BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy/conf/ config.<WEB_APP_SERVER>.

For example, for SAP NetWeaver, the configuration file is named <BIP_INSTALL_DIR>/sap_bobj/ enterprise_xi40/wdeploy/conf/config.sapappsvr73, so the name given for the

<WEB_APP_SERVER> parameter is sapappsvr73.

○ -D<PROPERTY>=<value> is at least one key-value pair. Parameters given on the command-line override those in the configuration file.

For example, to deploy the BOE web application, use -DAPP=BOE. This overrides any value for -DAPP= stored in the web application server configuration file config.<WEB_APP_SERVER>.

○ <ACTION> is the name of the operation to perform.

For example, the deployall action will deploy all web applications to the web application server given as

<WEB_APP_SERVER> in the first parameter.

4.6.1 Syntax

4.6.1.1 WDeploy server names

WDeploy uses a server name on the command-line and as part of the filename for server configuration files. The server name is the first parameter given on the command-line when running the WDeploy tool:

wdeploy.sh <WEB_APP_SERVER> [-D<PROPERTY>=<value>] <ACTION>

<WEB_APP_SERVER> is the name of the web or web application server. The name given must match the name of the configuration file in <BIP_INSTALL_DIR>/sap_bobj/enterprise_xi40/wdeploy/conf.

For a complete list of valid names for <WEB_APP_SERVER>, see Values for WEB_APP_SERVER [page 47].

4.6.1.2 WDeploy property parameters

WDeploy properties can be set on the command-line with the -D<PROPERTY> switch parameter. Repeat the -D<PROPERTY> switch parameter for each property to be set.

(39)

For example, in the following command, multiple invocations of the -D<PROPERTY> switch parameter are used to set multiple properties for a Tomcat 6 web application server (as_dir, as_instance, as_service_name, and APP: wdeploy.sh Tomcat6 -Das_dir=/opt/tomcat6 -Das_instance=localhost -Das_service_name=Tomcat6 -DAPP=BOE deployonly

Properties can also be configured in the wdeploy.config configuration file. This allows properties to be set by default, and over-ridden from the command-line when required. For more information on the wdeploy.conf configuration file, see WDeploy configuration file [page 31].

The following table lists all properties for WDeploy.

Table 9: Properties for WDeploy

Property Description Example value

APP Name of the web application to deploy, as found in the

WAR or EAR file name and the web application proper ties file:

<BIP_INSTALL_DIR> /sap_bobj/enter-prise_xi40/wdeploy/conf/apps/

<WEB_APP>.properties

This property is used when working with individual web applications, as with the wdeploy predeploy, wde-ploy dewde-ploy, or wdewde-ploy dewde-ployonly commands.

BOE

app_source_dir Location of an individual web application's source files.

This property is used when working with individual web applications, as with the wdeploy predeploy, wde-ploy dewde-ploy, or wdewde-ploy dewde-ployonly commands.

<BIP_INSTALL_DIR>/ sap_bobj/enter-prise_xi40/warfiles/ webapps/<WEB_APP>

app_source_tree Location of the source files for all available web applica tions (the parent folder of app_source_dir).

This property is used when working with all available web applications simultaneously, as with the wdeploy predeployall, wdeploy deployall or wdeploy deployonlyall commands.

<BIP_INSTALL_DIR>/ sap_bobj/enter-prise_xi40/warfiles/ webapps

as_admin_is_secure _{For web application servers that use SSL encryption} during web application deployment, such as Web Sphere.

false (default) true

SAP BusinessObjects Business Intelligence platform Document Version: 4.1 Support Package Web Application Deployment Guide