Deployment Installation Configuration Windows

Installation and Configuration Guide for Windows

BusinessObjects 6.5

Windows

ewiac65.book Page 1 Monday, August 9, 2004 10:10 AM

2 Installation and Configuration Guide for Windows

Copyright Copyright © 2004 Business Objects. All rights reserved.If you find any problems with this documentation, please report them to Business Objects in writing at [email protected].

Trademarks Business Objects, the Business Objects logo, Crystal Reports, and Crystal Enterprise are trademarks or registered trademarks of Business Objects SA or its affiliated companies in the United States and other countries. All other names mentioned herein may be trademarks of their respective owners.Contains ICU libraries (c) 1995-2003 International Business Machines Corporation and others. All rights reserved.

Use restrictions This software and documentation is commercial computer software under Federal Acquisition regulations, and is provided only under the Restricted Rights of the Federal Acquisition Regulations applicable to commercial computer software provided at private expense. The use, duplication, or disclosure by the U.S. Government is subject to restrictions set forth in subdivision (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at 252.227-7013.

Patents Business Objects owns the following U.S. patents, which may cover products that are offered and sold by Business Objects: 5,555,403, 6,247,008 B1, 6,578,027 B2, 6,490,593 and 6,289,352.

Part Number 313-10-650-01


Installation and Configuration Guide for Windows 3

Contents

ContentsPreface Maximizing Your Information Resources 7

Information resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Useful addresses at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12About this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Part I Preparing for Installation

Chapter 1 Planning for Installation 17Planning your deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Installation and Configuration Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Upgrading from previous versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Part II Installation

Chapter 2 Installing BusinessObjects 6.5 41Pre-install procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Installation tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Business Objects products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Types of installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Running the installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Chapter 3 Administrative and Command Line Installations 69Administrative installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Command-line installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73



Contents

Chapter 4 Modifying and Removing Installations 83Adding a product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Removing products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Repairing an installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Removing BusinessObjects 6.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Applying a hotfix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Part III Configuration

Chapter 5 Configuration Overview and Scenarios 93Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Tools and methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Deploying web applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Configuration scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Scenario 1 -- Apache/Tomcat or IIS on a single machine . . . . . . . . . . . . . 102Scenario 2 -- Two machines/web and application servers together . . . . . 104Scenario 3 -- Two machines/E6 and application server together . . . . . . . 106Scenario 4 -- Three machines/web and application server separate . . . . 109

Chapter 6 Configuring the ORB 113Starting the Configuration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Configuring the ORB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Setting cluster storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Changing cluster settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Removing a node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Chapter 7 Typical Configuration 127Starting the Typical wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130ASP technology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132JSP technology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

Chapter 8 Configuration Tool in Command Line Mode 141Configuration Tool in command-line mode . . . . . . . . . . . . . . . . . . . . . . . . 143



Contents

Chapter 9 Deploying Web Applications Using Configuration Tool 155Deploying the web applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158Customized web applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Removing a web application instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177Modifying or removing an application server . . . . . . . . . . . . . . . . . . . . . . . 178Modifying or removing a web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Chapter 10 Deploying Web Applications Using wdeploy 181What is wdeploy? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184Wdeploy deployment modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186How do you use wdeploy? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Using wdeploy on application server machines . . . . . . . . . . . . . . . . . . . . . 192Using wdeploy on web server machines . . . . . . . . . . . . . . . . . . . . . . . . . . 196Properties reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198Targets reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202Deploying a customized application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210Using unsupported web or application servers . . . . . . . . . . . . . . . . . . . . . 212Issues requiring additional procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . 215Making sure your web applications work . . . . . . . . . . . . . . . . . . . . . . . . . . 217Where to go now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

Part IV Before You Start the System

Chapter 11 Getting the System Ready 221Before starting the system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223Before you set authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228



Contents

Chapter 12 Setting Authentication and Authorization 231Authentication and authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233Authentication mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234Authentication source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235Using LDAP with Business Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239Netegrity SiteMinder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244Using the Security Configuration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246Setting the authentication mode and source . . . . . . . . . . . . . . . . . . . . . . . 248If you chose Basic authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252Configuring LDAP connection parameters . . . . . . . . . . . . . . . . . . . . . . . . 255

Part V Finalizing Your Configuration

Chapter 13 Getting Up and Running 265Starting the system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267After starting the system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268Configuring the Demo kit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272Where to go now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

Part VI Appendices

Appendix A Business Objects Products and Feature Codes 277

Appendix B Language Codes 283


preface

Maximizing Your Information Resources




OverviewInformation, services, and solutions

The Business Objects solution is supported by thousands of pages of documentation, available from the products, on the Internet, on CD, and by extensive online help systems and multimedia. Packed with in-depth technical information, business examples, and advice on troubleshooting and best practices, this comprehensive documentation set provides concrete solutions to your business problems. Business Objects also offers a complete range of support and services to help maximize the return on your business intelligence investment. See in the following sections how Business Objects can help you plan for and successfully meet your specific technical support, education, and consulting requirements.



Information resources

Information resourcesWhatever your Business Objects profile, we can help you quickly access the documentation and other information you need.

Where do I start? Below are a few suggested starting points; there is a summary of useful web addresses on page 12.

Documentation RoadmapThe Documentation Roadmap references all Business Objects guides and multimedia, and lets you see at a glance what information is available, from where, and in what format. View or download the Business Objects Documentation Roadmap at www.businessobjects.com/services/documentation.htm

Documentation from the productsYou can access electronic documentation at any time from the product you are using. Online help, multimedia, and guides in Adobe PDF format are available from the product Help menus.

Documentation on the webThe full electronic documentation set is available to customers with a valid maintenance agreement on the Online Customer Support (OCS) website at www.businessobjects.com/services/support.htm

Buy printed documentationYou can order printed documentation through your local sales office, or from the online Business Objects Documentation Supply Store at www.businessobjects.com/services/documentation.htm

Search the Documentation CDSearch across the entire documentation set on the Business Objects Documentation CD shipped with our products. This CD brings together the full set of documentation, plus tips, tricks, multimedia tutorials, and demo materials.Order the Documentation CD online, from the Business Objects Documentation Supply Store, or from your local sales office.


http://www.businessobjects.com/services/support.htm

http://www.businessobjects.com/services/documentation



http://www.businessobjects.com/services/documentation.htm




MultimediaAre you new to Business Objects? Are you upgrading from a previous release or expanding, for example, from our desktop to our web solution? Would you like to see a demonstration that shows how to use some of our more complicated or advanced features? Access our multimedia Quick Tours or Getting Started tutorials from the product, the Online Customer Support (OCS) website, or the Documentation CD.

How can I get the most recent documentation?You can get our most up-to-date documentation via the web. Regularly check the sites listed below for the latest documentation, samples, and tips.

Tips & TricksOpen to everyone, this is a regularly updated source of creative solutions to any number of business questions. You can even contribute by sending us your own tips.www.businessobjects.com/forms/tipsandtricks_login.asp

Product documentationWe regularly update and expand our documentation and multimedia offerings. With a valid maintenance agreement, you can get the latest documentation – in seven languages – on the Online Customer Support (OCS) website.

Developer Suite OnlineDeveloper Suite Online provides documentation, samples, and tips to those customers with a valid maintenance agreement and a Developer Suite license via the Online Customer Support (OCS) website.

Send us your feedbackDo 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: [email protected]

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: www.businessobjects.com/services/support.htm


http://www.businessobjects.com

http://www.businessobjects.com/forms/tipsandtricks_login.asp

mailto:[email protected]



Services

ServicesA global network of Business Objects technology experts provides customer support, education, and consulting to ensure maximum benefit to your business.

How we can support you?Business Objects offers customer support plans to best suit the size and requirements of your deployment. We operate three global customer support centers:• Americas: San Jose, California and Atlanta, Georgia• Europe: Maidenhead, United Kingdom• Asia: Tokyo, Japan and Sydney, Australia

Online Customer SupportOur Customer Support website is open to all direct customers with a current maintenance agreement, and provides the most up-to-date Business Objects product and technical information. You can log, update, and track cases from this site using the Business Objects Knowledge Base.

Having an issue with the product?Have you exhausted the troubleshooting resources at your disposal and still not found a solution to a specific issue? For support in deploying Business Objects products, contact Worldwide Customer Support at: www.businessobjects.com/services/support.htm

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: www.businessobjects.com/services/consulting.htm

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 website: www.businessobjects.com/services/education.htm


http://www.businessobjects.com/services/education.htm


http://www.businessobjects.com/services/consulting.htm



Useful addresses at a glance

Address ContentBusiness Objects Documentation

www.businessobjects.com/services/documentation.htm

Overview of Business Objects documentation. Links to Online Customer Support, Documentation Supply Store, Documentation Roadmap, Tips & Tricks, Documentation mailbox.

Business Objects Documentation mailbox

[email protected]

Feedback or questions about documentation.

Product documentation

www.businessobjects.com/services/support.htm

The latest Business Objects product documentation, to download or view online.

Business Objects product information

www.businessobjects.com

Information about the full range of Business Objects products.

Developer Suite Online

www.techsupport.businessobjects.com

Available to customers with a valid maintenance agreement and a Developer Suite license via the Online Customer Support (OCS) website. Provides all the documentation, latest samples, kits and tips.

Knowledge Base (KB)


Technical articles, documents, case resolutions.Also, use the Knowledge Exchange to learn what challenges other users – both customers and employees – face and what strategies they find to address complex issues. From the Knowledge Base, click the Knowledge Exchange link.

Tips & Tricks

www.businessobjects.com/forms/tipsandtricks_login.asp

Practical business-focused examples.



mailto:[email protected]


http://www.businessobjects.com

http://www.techsupport.businessobjects.com/


http://www.businessobjects.com/forms/tipsandtricks_login.asp


Useful addresses at a glance

Online Customer Support


www.businessobjects.com/services

Starting point for answering questions, resolving issues.

Information about registering with Worldwide Customer Support.

Business Objects Education Services

www.businessobjects.com/services/education.htm

The range of Business Objects training options and modules.

Business Objects Consulting Services

www.businessobjects.com/services/consulting.htm

Information on how Business Objects can help maximize your business intelligence investment.

Address Content



http://www.businessobjects.com/services/

http://www.businessobjects.com/services/education.htm

http://www.businessobjects.com/services/consulting.htm



About this guideThis guide describes how to install and configure the BusinessObjects6.5 suite on a Microsoft Windows® operating system.

AudienceThis guide is intended for administrators and others responsible for installation and configuration.This guide assumes that you are familiar with the following:• the BusinessObjects 6.5 suite of products• Windows system administration• command-line tools

Conventions used in this guideThe conventions used in this guide are described in the table below.

Convention Indicates

This font Code, SQL syntax, computer programs. For example: @Select(Country\Country Id). This font is also used for all paths, directories, scripts, commands and files for UNIX.

Some code more code

Placed at the end of a line of code, the symbol ( ) indicates that the next line should be entered continuously with no carriage return.

$DIRECTORYPATHNAME The path to a directory in the Business Objects installation/configuration directory structure. For example:• $INSTALLDIR refers to the Business Objects

installation directory.• $LOCDATADIR refers to a subdirectory of the

BusinessObjects installation directory called locData.


part

Preparing for Installation



chapter

Planning for Installation




OverviewThis chapter includes:• a review of the stages involved in installation and configuration• a comprehensive checklist of all the steps required• a discussion of deployment issues• what to do if you are upgrading from a previous versionThroughout this guide, you will see the following table at the start of each major section. It is designed to help you keep track of where you are in the installation and configuration process. The current stage is indicated by a checkmark.

Where you are now

Stage in the process Starts on...

1. Plan your deployment. page 19

2. Complete pre-installation procedures. page 44

3. Install the required Business Objects products. page 59

4. Define the cluster and its ORB using the Configuration Tool.

page 113

5. Deploy the required Business Objects web applications using one of the following tools:

- the Configuration Tool page 155

- wdeploy page 181

6. Get the Business Objects system ready. page 221

7. Set user authentication. page 231

8. Start the system and complete the final steps required to get your BusinessObjects solution up and running.

page 265



Planning your deployment

Planning your deploymentCarefully planning your deployment is crucial for a successful implementation of BusinessObjects 6.5. Business Objects recommends that you read Deploying the Business Objects System before starting server product installations.If you have a previous major version of Business Objects, read Migrating from a Previous Version and plan accordingly.

What is a cluster?Clusters are the basic unit in a 3-tier Business Objects solution. A cluster is the node or set of nodes that collectively provide the functional operation of a given portal. Clusters can contain the following elements:• The primary node serves as the central coordinator between all the nodes in

the cluster. There is one and only one primary node in a cluster; if the cluster contains only one node, it is a primary node.

• Optional secondary nodes run the ORB components required to communicate with the primary node and start Business Objects processes on the secondary node, as well as optional services.

Both primary and secondary nodes are considered cluster nodes.Under Windows, only one node can be configured per server machine. Under UNIX, multiple nodes can be hosted on a single machine, as long as each of them belongs to a different cluster.




Because the application server uses CORBA to communicate with the cluster’s API and interface components, the application server is also considered to be part of the cluster.

What is the primary node’s role?The primary node performs the following services:• It tracks and manages processes throughout the system.• It records various system and user activities.

The primary node occupies a critical position in the Business Objects system. If it fails, the entire system needs to be stopped and restarted.

What is the secondary node’s role?Secondary nodes rely on the primary node to provide the infrastructure required to allow multiple servers to work together. You can configure a secondary node to run only a subset of the full complement of Business Objects modules using the Administration Console. The Console allows you to tailor the structure of your system and more efficiently serve the needs of your users. For example, if you find that the load on a particular type of server process within the system is high, you can dedicate a machine to just that process.

Why use distributed configurations?The distributed object technology underlying the Business Objects system provides scalability and flexibility because components of the Business Objects middle tier can either run on a single machine or be distributed across multiple machines in the cluster.

Business Objectsprimary nodeUsers on

clientapplications

Application serverWeb server

Network

Secondary node




The system’s distributed component architecture provides three major benefits: • Failover

A distributed system can also provide failure recovery: When system components are installed on more than one server, if a server stops working, the system can continue to use the same required components on other servers.

• ScalabilityUser populations using this type of Internet technology can be significantly larger than usual. As the document processing needs and the user population in your organization grow, you can manage the extra workload simply by adding servers to the system.

• Load balancingWhen you enable multiple instances of certain key Business Objects modules over several nodes, the distributed system automatically performs load balancing across component servers. You can also weight the transaction loads to optimize the use of more or less powerful processors, thus optimizing the use of server resources, reducing the workload on the web server, and improving performance.

All of these advantages are made possible by the use of CORBA and the Business Objects Application Server Framework, or ASF.

Application servers and web serversYour application server and web server must have web applications (such as InfoView) deployed on them so they can act as entry points for users of the cluster.BusinessObjects 6.5 includes four web applications:• InfoView

Any cluster used for sharing and processing documents must have a deployment of the InfoView application to allow InfoView users to access the Business Objects server.

• Administration ConsoleProvides administrators with access to the Administration Console.

• Supervisor over the WebNeeded if you want your supervisors to manage users and user groups from a web browser.

• Auditor The Auditor application provides access to BusinessObjects Auditor.




Depending on your deployment, you can have more than one web server and application server per cluster. You can install your web server and application server on any type of node, depending on your deployment plan.In some deployments, your web servers may be completely isolated from the cluster, notably in DMZ configurations. You must still, however, install the Configuration Tool on both the application and web servers to define them as entry points.

What you install on which machinesWhere you install Business Objects products depends on the actual products your users require—and therefore the type of deployment you are implementing.

Installing a 2-tier environmentA strictly 2-tier environment includes desktop products only. In this scenario, you must install at least the main desktop products BusinessObjects, Supervisor, and Designer on the machine of every user who will be using those products. Typically, you install many more instances of the end-user product BusinessObjects than the other two, which are required administration products.

Installing a 3-tier environmentA 3-tier deployment relies on the Business Objects server products, as well as on the web and application servers through which the processing components in the Business Objects cluster communicate with the system’s clients.




In a 3-tier configuration, therefore, the following must be installed:

NOTE

You can install your web server and application server on any type of node, depending on your deployment plan.There are some deployments, however, in which you do not want your web servers to be part of the cluster, most commonly where you have implemented a DMZ. You must still, however, install the Configuration Tool on both application and web servers to configure them as client nodes and to define them as entry points.

Configuration scenariosThere are four typical configuration scenarios, summarized below. You can use these as a general guide to configuration. Their use is optional. (For a more detailed explanation of each one, see Configuration scenarios on page 101.)

System component What must be installedCluster nodes • Business Objects server components

• Administration Console (on primary node)• Configuration Tool

Web server • Web server pages (option under InfoView in the Installer)• A third-party application server connector if the application

server is on a separate machine than the web server• Configuration Tool (to configure the web server)

Application server • Application server pages (option under InfoView in the Installer)

• Configuration Tool (to configure the application server and the ORB so that it can communicate with the cluster machines)

Client machines Any or all of the following:• Desktop products (installed on the machines of their users)• Administration products• Demonstrations




Scenario 1 -- Apache/Tomcat or IIS on a single machineHere’s what Scenario 1 looks like:

With this scenario, you perform a largely-automated configuration process. This makes use of the Typical wizard within the Configuration Tool.

Machine 1--Business Objects server

(primary node)Users

Intranet

--Configuration Tool

--Application server--Web server




Scenario 2 -- Two machines/web and application servers togetherHere’s what Scenario 2 looks like:

To use Scenario 2, you must have:• a machine hosting the Business Objects server and the Configuration Tool

This is the primary node.• a second machine with the web server, application server, and the

Configuration ToolThis is the client node.

Machine 1

Machine 2

--Business Objects server

--Web and application servers

(primary node)

Users

(client node)

Intranet






Scenario 3 -- Two machines/BO6.5 and application server togetherHere’s what Scenario 3 looks like:

To use Scenario 3, you must have:• a machine with the Business Objects server, the Configuration Tool, and the

application serverThis is the primary node.

• a second machine with the web server

Machine 1

Machine 2


--Web server

(primary node)

Users

Intranet

--Application server






Scenario 4 -- Three machines/web and application server togetherHere’s what Scenario 4 looks like:

To use Scenario 4, you must have:• a machine with the Business Objects server and the Configuration Tool

This is the primary node.• a second machine with the application server and the Configuration Tool

This is the client node.• a third machine with the web server

Machine 1

Machine 3

Machine 2

- Business Objects server

Web server


Users

Intranet

(primary node)- Configuration Tool

--Configuration Tool(client node)

Configuration Tool




Installation and Configuration ChecklistUse this checklist to guide you through the installation and configuration process. Business Objects recommends that you print the checklist so that you can mark your progress from one stage to the next.If you are upgrading from a previous version, see Upgrading from previous versions on page 32.

Plan your deployment❏ See page 19 for an overview and Deploying the Business Objects System for

a detailed discussion of deployment considerations.❏ Check that your operating system, database, middleware, application and

web servers are supported by Business Objects. To do so, check the Product Availability Report (PAR) for the list of currently supported platform configurations:- Go to www.techsupport.businessobjects.com- Log in to the site.- Choose Enterprise 6 > PAR > BI Platform 6

The Recommended Settings Guide for Business Objects Deployments presents recommendations on BusinessObjects 6.5 and the underlying environment. You can access the guide at: www.techsupport.businessobjects.com

Complete pre-installation procedures❏ Make sure you have a valid license key file for the products you have

purchased and copy license files to each machine in the system. See page 44.

❏ Make sure the web and application servers you are using have been correctly installed and configured. Make sure they can communicate with each other through a connector provided by either the web or application server manufacturer. You must install and configure this connector according to the instructions packaged with it.If you are using Apache/Tomcat, you can use the installer delivered on the Business Objects installation CD to install and configure the JDK, Apache, and Tomcat, and configure the connector. Make sure you use version 6.5 of the installer. See page 47.

❏ Verify the IP address of all servers on which you intend to install Business Objects server products.



http://www.techsupport.businessobjects.com





Installation and Configuration Checklist

Install Business Objects server products❏ Install Business Objects server products on all primary and secondary nodes.❏ Install the desktop products (Supervisor and Designer) needed for getting the

system up and running.

Configure the Business Objects server system❏ Review the configuration scenarios starting on page 101.❏ Log on to Windows as an Administrator or the equivalent. The user account

used to launch the Configuration Tool and to start the Windows service must also have the following rights:- Act as part of the operating system- Log on as a service

IIS or Apache/TomcatIf you want to deploy only InfoView, Supervisor over the Web, and Administration Console on a single machine that also houses the application and web servers:❏ Run the Typical wizard as described on page 127.

For other deployment scenarios:❏ Use the Configuration Tool to define the cluster and configure ORB settings

as described on page 113.❏ Deploy Business Objects web applications using the Configuration Tool. See

page 155.

All other application and web servers❏ Use the Configuration Tool to define the cluster and configure ORB settings

as described on page 113.❏ Deploy Business Objects web applications using the wdeploy tool as

described on page 181.

Install Business Objects products on client machines❏ Follow the instructions on page 59 to install BusinessObjects desktop and

administration products on client machines:- BusinessObjects- BusinessQuery for Excel- Supervisor- Designer




Get the Business Objects system ready

Create the repository and copy the bomain.key file❏ Make sure the connectivities to all the databases used in the system, for both

the repository and corporate data, are installed and working correctly. See the Data Access Guide.

❏ Identify the database account and password of the Business Objects repository to which Business Objects server products connect. Write them down.

❏ Using Supervisor, create the repository that will be used by the cluster. This also creates the repository’s .key file. Only one .key file must be present in this folder and must be named bomain.key. You can also create the bomain.key using the wmainkey utitlity. See the Supervisor’s Guide for instructions.

❏ If you are using WebIntelligence OLAP with Essbase, configure connectivity as described on page 225.

Set up the Business Objects reporting environment❏ Use Supervisor to create or import the system’s users and/or user groups,

then assign them access rights. See Supervisor’s Guide.❏ Using Designer, create at least one universe, configured with a valid, secure

connection to the corporate database. Export the universes to the repository. See the Designer’s Guide.

Set user authentication and authorizationBy default, authentication is managed through the Business Objects repository. You can also use an external user management system, such as LDAP or Single Sign-On (SSO).❏ Set user authentication and authorization. See page 231.

Get your BusinessObjects solution up and running

Start the BusinessObjects cluster❏ Follow the instructions on page 265.

Log in to InfoView❏ Make sure you can log in to InfoView. See page 268.



Installation and Configuration Checklist

Tune and test your system❏ Set Business Objects processes and pool size for WIQT at least. See

page 269 and the System Administrator’s Guide for Windows.❏ Make sure users can successfully log on to the system.❏ Make sure you can correctly download BusinessObjects from InfoView and

that BusinessObjects in 3-tier mode functions properly.

Set up Broadcast Agent❏ Define at least one Broadcast Agent. See the Broadcast Agent

Administrator’s Guide.❏ Check that you can correctly schedule documents from InfoView or

BusinessObjects.

Set up the demo kits❏ Configure the demo kits so your users can use the WebIntelligence and

BusinessObjects Getting Started tutorials. See page 272.




Upgrading from previous versionsThe information in this section is divided into:• upgrading from version 2.x/5.x to 6.x• upgrading from 6.1.x to 6.5

Upgrading from 2.x/5.x to 6.xThe Installation wizard can upgrade Business Objects 5.x desktop products, but not earlier ones. You can replace the 5.x desktop products with BusinessObjects 6.5, or install 6.5 alongside the previous version.For complete information on upgrading from 2.x/5.x, see the Migrating from a Previous Version guide.

5.x desktop productsThe Installation wizard detects the 5.x desktop products, and then asks you to select the option you want:

Because Business Objects 5.x desktop products must be uninstalled, the Installation wizard looks for the 5.x setup.exe file. If the file is not found, the wizard informs you that you must copy it to your hard disk.Have the version 5.x installation CDs ready in case the 5.x setup.exe file is not currently on your hard disk.

WebIntelligence 2.xAlthough the Installation wizard detects WebIntelligence 2.x products, it does not uninstall them.If you want to upgrade, you must uninstall previous versions using the installation program on the original CD. Your configuration settings are not kept.



Upgrading from previous versions

BusinessObjects 4.x and earlierThe Installation wizard does not detect Business Objects 4.x or earlier. If you want to upgrade from Business Objects 4.x or earlier, you must first upgrade to version 5.x in order to preserve all corporate and user documents. You must uninstall the earlier versions using the original installation program.

Upgrading from 6.1.x to 6.5Use the checklist and procedures below to guide you through the upgrade process.

Upgrade checklistEach step in the checklist below is described in the sections that follow.❏ Stop the Business Objects cluster. Stop the secondary nodes first and then

the primary node.❏ Stop all WebIntelligence services.❏ Stop the web and application servers used by the cluster.❏ Make a manual backup of all current configuration settings and personal

storage on all nodes in the cluster.❏ Make a manual backup of any WebIntelligence and InfoView files that you

have manually customized to change font, colors, messages, and other formatting.

❏ If you originally used the Configuration Tool to deploy web applications on a web server or application server other than Apache, Tomcat, or IIS, run the Configuration Tool and undeploy these web applications.

❏ If you originally used the wdeploy tool to deploy any web applications on a web server or application server, run wdeploy and undeploy these web applications.

❏ If you installed Apache and Tomcat using the Apache/Tomcat installer delivered with Business Objects 6.1.x, undeploy your web applications, uninstall Apache and Tomcat using the 6.1.x Apache/Tomcat installer, and then reinstall Apache/Tomcat using the 6.5 Apache/Tomcat installer.

❏ Run the BusinessObjects 6.5 installer on all nodes on the cluster. You must install BusinessObjects 6.5 using the same installation path you used for your BusinessObjects 6.1.x installation.

❏ For all application and web servers other than Apache, Tomcat, or IIS, redeploy Business Objects web applications using the wdeploy tool.

❏ Check that the new installation is functioning correctly.




Stop the Business Objects clusterStop the secondary nodes first, and then the primary node.1. From the Windows Start menu, point to Programs > Business Objects > Stop

Server.Wait for the Business Objects server to shut down completely. This takes a few moments.

2. Right-click the WINotify icon and select Exit from the menu.The WINotify icon is in the status bar of your Windows desktop.

Stop all WebIntelligence servicesMake sure you stop all WebIntelligence services.1. From the Windows Start menu, point to Programs > Administrative Tools >

Services.2. In the Services window, right-click WebIntelligence Cluster Service and

select Stop from the menu.3. Right-click WebIntelligence DTS Manager and select Stop from the menu.4. Right-click Olap Cache Manager and select Stop from the menu.5. Right-click IIS Admin Service and select Stop from the menu.

Stop all web and application serversStop all web and application servers used by the Business Objects cluster. The upgrade process can be corrupted if you have web and application servers running.

NOTE

On IIS, make sure that you stop all services: WWW Publisher and IIS Admin.

Make a backup of all current configuration settings and personal storageManually backup all files containing configuration settings and personal documents, for all nodes on the cluster. This is not mandatory but enables you to make a safe recovery if anything goes wrong during the automatic upgrade.1. Make sure the cluster has been stopped.2. Go to the Business Objects installation nodes folder

$INSTALLDIR\nodes\<hostname>\<clustername>




3. Make copies of the following folders and all subfolders. You can use Winzip or an equivalent tool.$INSTALLDIR\nodes\<hostname>\<clustername>\config$INSTALLDIR\nodes\<hostname>\<clustername>\documents$INSTALLDIR\nodes\<hostname>\<clustername>\locdata$INSTALLDIR\nodes\<hostname>\<clustername>\logs$INSTALLDIR\nodes\<hostname>\<clustername>\shData$INSTALLDIR\nodes\<hostname>\<clustername>\storage$INSTALLDIR\nodes\<hostname>\<clustername>\universes$INSTALLDIR\nodes\<hostname>\<clustername>\userBQY$INSTALLDIR\nodes\<hostname>\<clustername>\webi.bat

These folders and files contain all configuration settings made through the Administration Console, user settings, and all personal documents.

Back up WebIntelligence and InfoView files you customized manuallyYou need to manually back up and then restore any files that you customized manually.

InfoView .war fileIf you have modified any of the files in the infoview.war file (*.jar,* .jsp,* .asp, *.html, *.xsl,* .xslt, servlets), you need to make a manual backup of any changes before upgrading, and then restore your customized files afterwards, manually. The infoview.war is replaced during the upgrade process.

Undeploy Business Objects web applications

wdeployIf you originally used the wdeploy tool to deploy any web applications on a web server or application server, run wdeploy and undeploy these web applications.

Configuration Tool (web/application server other than Apache, Tomcat, or IIS)If you originally used the Configuration Tool to deploy web applications on a web server or application server other than Apache, Tomcat, or IIS, run the Configuration Tool and undeploy the Business Objects web applications InfoView, Administration Console, Auditor, and any custom applications you have deployed on the web and application servers.




To undeploy:1. Launch the Configuration Tool from Start > Programs > Business Objects >

Configuration Tool.2. Click Next twice.3. On the Configuration Options page, select Custom, and then click Next.4. On the Cluster Management page, fully expand the web application branch,

for example InfoView.5. Highlight the application server.6. In the drop-down list, select Delete this web application, and then click

Next.7. If you are using a separate application server and web server, highlight the

web server.8. In the drop-down list, select Delete this virtual directory.9. Complete steps 4-8 for all web applications you have deployed.10.When you have completed all steps for all web applications, click Finish.

Apache/Tomcat from Business Objects 6.1.xIf you installed Apache and Tomcat using the Apache/Tomcat installer delivered with Business Objects 6.1.x, you must:1. Undeploy your web applications, using the procedure described above.2. Uninstall Apache and Tomcat using the 6.1.x Apache/Tomcat installer.3. Reinstall Apache/Tomcat using the 6.5 Apache/Tomcat installer.If the Apache and Tomcat you used in your version 6.1.x deployment are still supported in BusinessObjects 6.5, then the 6.5 Setup will automatically undeploy the Business Objects 6.1.x web applications that are deployed on them. If, however, your previous Apache and Tomcat are not supported in 6.5, then you must undeploy the 6.1.x web applications using the 6.1.x Configuration Tool, as explained above.

Install BusinessObjects 6.5Upgrading an existing installation takes longer than installing BusinessObjects 6.5 from scratch—a typical upgrade can take 40 minutes compared to 10 minutes for an installation from scratch. The upgrade is particularly long if you have activated antivirus software on the node where you are installing BusinessObjects 6.5.




The 6.5 Setup program will automatically uninstall your previous version. If, however, you choose to manually uninstall, make sure you first run the Configuration Tool to delete the node. (If you manually uninstall and then reinstall in the same directory without first deleting the node, delete the contents of $INSTALLDIR/nodes before creating a new node.)To install:1. Run the BusinessObjects 6.5 Setup.2. Select the products to be installed.Important: You must install BusinessObjects 6.5 using the same installation path you used for your BusinessObjects 6.1.x installation. The Business Objects installer proposes the default installation folder C:\Program Files. Make sure that you do not accept this default if your current BusinessObjects 6.x installation is installed elsewhere. If you do not install BusinessObjects 6.5 using the same installation path, the configuration settings that have been saved from BusinessObjects 6.1.x will not be valid for BusinessObjects 6.5.3. Start the installation process.

The installer detects that a previous version of BusinessObjects 6.x is already installed and switches to upgrade mode. The installer then:- runs the Configuration Tool currently installed to backup the existing configuration (ORB, services, web applications, personal settings and storage). The Configuration Tool runs in batch mode which opens a DOS window. Do not close this window; it will close automatically.- uninstalls the current BusinessObjects 6 installation.- installs BusinessObjects 6.5.- runs the new BusinessObjects 6.5 Configuration Tool, which restores the configuration. The Configuration Tool runs in batch mode which opens a DOS window. Do not close this window; it will close automatically.

4. When the Installation Wizard Complete screen appears, make sure the Configure server products checkbox is not checked, and then click Finish.You do not need to run the Configuration Tool to redeploy web applications on Apache/Tomcat or IIS; the upgrade procedure redeploys all web applications on Apache/Tomcat or IIS and restores all configuration settings. For all other web and application servers, see the next section.

Deploy Business Objects web applicationsFor all web and application servers other than Apache/Tomcat and IIS, deploy Business Objects web applications using the wdeploy tool.




Check that the upgrade has been successfully completedStart the Business Objects system in the following order:1. Start the Business Objects server on the primary node. On the Windows Start

menu, point to Programs > Business Objects > Start Server.2. Start the Business Objects server on the secondary nodes. On the Windows

Start menu, point to Programs > Business Objects > Start Server.3. Start the application server.4. Start the web server (if you are using a separate application and web server).5. Check that your BusinessObjects 6.5 deployment is functioning correctly.

TroubleshootingIf you experience problems after the upgrade, check the following:❏ Launch the Configuration Tool and check that the node has been correctly

recreated.If not, run the Configuration Tool to recreate the node and reconfigure the ORB.

❏ Check that web applications have been correctly redeployed.If not, run the Configuration Tool to redeploy the web applications on Apache/Tomcat and IIS. Use wdeploy to redeploy web applications on all other application and web servers.

❏ Check that the service parameters have been correctly reset.If not, reset them in the Configuration Tool.

❏ Check that all folders and files containing custom configuration settings made through the Administration Console, all user settings, and all personal documents have been restored.If not, restore the files and directories using the manual backup files you made. See page 34 for the list of directories.


part

Installation



chapter

Installing BusinessObjects 6.5




OverviewThis chapter explains how to install Business Objects products for the first time. Before you begin, read the preliminary information in the previous chapter.This chapter describes:• pre-installation procedures• the different types of installation and their associated products• installation of BusinessObjects 6.5 using the Installation wizard

Checking the PARBefore you begin any procedures, make sure your operating system, database, middleware, application servers, and web servers are supported by Business Objects. To do this, check the PAR (Product Availability Report) for the list of currently supported platforms:1. Go to www.techsupport.businessobjects.com2. Log in to the site.3. Select Enterprise 6 > PAR > BI Platform 6

Recommended Settings guideThe Recommended Settings Guide for Business Objects Deployments presents recommendations on BusinessObjects 6.5 and the underlying environment. It covers all supported hardware and software stacks, including settings for web and application servers as well as for Business Objects applications. This guide also covers the minimum supported O/S versions and patch levels, web browser versions, and web and application server versions and patch levels.This guide provides a starting point for setting parameters in a production environment. You may need to adjust parameters up or down depending upon the exact nature of the deployment (number of users and user profiles, number of documents, projected workflows, and so on). This guide is not a substitute for ensuring that the product is properly installed or for having a good working understanding of the product.You can access the Recommended Settings Guide for Business Objects Deployments at www.techsupport.businessobjects.com





A note about Terminal ServicesYou can install via Terminal Services, but with the following restrictions:• When you configure the ORB, you must set the cluster to use the

WebIntelligence Service• If you are using Windows 2000, you cannot use a mapped drive to access the

CDs on a remote machine




Pre-install proceduresFor command-line and administrative installations, complete the pre-installation procedures, and then go to Administrative and Command Line Installations on page 69.The following table is designed to help you keep track of where you are in the installation and configuration process. The current stage is indicated by a checkmark.

This section explains the steps you must complete before you start any installation.

LicensesYou must purchase and install licenses for all the products you want to install. In the Installation wizard, you will see only the products for which you have a license.

Where you are now






page 113



- wdeploy page 181




page 265



Pre-install procedures

License filesWhen you purchase a Business Objects product, you receive the corresponding license file from your Business Objects representative.The license file is a readable signed XML file. It contains:• a list of licensed products• the expiry date for trial products• the number of licenses purchased for each productYou can use a text editor to see what licenses you have. Do not delete or modify the license file, otherwise you cannot install or use any of the products it covers.

License file directoryIf you are installing different components of BusinessObjects 6.5 on different nodes within a cluster, make sure the license files are available in a network location to which all nodes have access.Copy your license files before starting the Installation wizard. During installation, you specify where the files are located.Copy any subsequent licenses to the same directory, otherwise you may not be able to use a product you have already installed.

License files for clientsLicense files must be accessible to all client users.You can either:• install the license files on each client machine

Although this is the simplest option, it is harder to manage if you purchase new license files, because you have to deploy them on all the client machines.

• install the license files in a shared network directoryAll machines must have access to the directory, otherwise they cannot use the Business Object products to which the license file refers, even if the product is installed at the client.The advantage is that you can track license files easily, and control which machines have access simply by adding or restricting network access rights.This is the preferred solution for larger Business Objects implementations.

Installing Java SDKTomcat requires the Java 2 SDK (JDK). This is delivered as a separate item on the Business Objects installation CD. You can also download it from the www.sun.com website. Make sure you download the SDK and not the JRE.


http://www.sun.com/



For the current required version, see the PAR.

NOTE

If you use the Apache/Tomcat Installer provided on the Business Objects installation CD, the JDK is also installed. You do not need to perform the procedure below; go to page 47.

To find out if a JDK is installed on the application server machine:• at the DOS prompt type: java -version

If a JDK is installed, the version number is returned. If no version number is returned, no JDK is installed.

To install the JDK:1. Do either of the following:

- Copy the JDK from the Business Objects installation CD.- Download Java 2 SDK Standard Edition (J2SE) from www.sun.com. Make sure you download the SDK and not the JRE.

2. Install the JDK according to the manufacturer’s instructions.Use a short pathname for the JDK installation folder, for example, c:\jdk_1.3.1

3. On the Windows Start menu, point to Settings > Control Panel > System.The System Properties dialog box appears.

4. On the Advanced tab, select Environment Variables.5. Under System Variables, check whether the JAVA_HOME variable is

present:

NOTE

If a CLASSPATH environment variable has been set, check that there are no spaces in its path and that there are no double quotes. On Windows 2000, if you use double quotes in the classpath, Tomcat cannot locate the JAR files.

6. Restart the machine.

...if JAVA_HOME is not present: ...if JAVA_HOME is present:

• Click New.• Enter the variable name.• Enter the JDK installation folder in

the value box.

Check that the JDK installation folder is correct. If not, click Edit and point to the JDK installation folder.


www.sun.com


Pre-install procedures

Installing the web and application serversMake sure the web and application servers you are using have been correctly installed and configured. Make sure they can communicate with each other through a connector provided by either the web or application server manufacturer. You must install and configure this connector according to the instructions packaged with it.

Installing Apache and TomcatIf you are installing Apache and Tomcat on a single machine, you can use the Apache/Tomcat Installer. It is located on the Business Objects installation CD.

NOTE

You must use version 6.5 of the Apache/Tomcat Installer with the BusinessObjects 6.5 suite. If you have an older version, follow the procedure below to update to version 6.5.

The Apache/Tomcat Installer:• installs the JDK• installs Apache• installs Tomcat• installs and configures the mod_jk connector that links Apache and TomcatBefore you begin, make sure that:• you have administrator rights• Apache and Tomcat are not installed on the machine• Ports 8009 and 8085 are availableTo install and configure Apache/Tomcat using the Installer:1. From the Business Objects Installation CD 0 (folder:

SetupApache2.0.46Tomcat4.1.27Jdk1.4.2_03), double click the setup.exe file.The Welcome page appears.

2. Click Next.The License Agreement page appears.

3. Read the agreement. If you accept it, select I accept the terms in the license agreement, and then click Next.




The Custom Setup page appears.

4. If you want to modify the installation directory, click Change.The default directory is C:\Program Files\Business Objects\ThirdParties\

5. Click Next.The Ready to Install the Program page appears.

6. Click Install.The tool copies the files into the installation directory and configures the connector.The Installation Wizard Completed page appears.

7. If you want to test the installation and the link between Apache and Tomcat, use the URL that appears on this page.

8. Click Finish.

Stopping Apache and TomcatApache and Tomcat must not be running while you configure Business Objects server products. To stop Apache and Tomcat:1. In the Windows Start menu, point to Settings > Control Panel > Administrative

Tools > Services.2. Right-click Apache and select Stop from the menu.3. Right-click Apache Tomcat 4.1 and select Stop from the menu.



Installation tools

Installation toolsThis section reviews the tools used during installation.

Installation wizard You use the Business Objects Installation wizard for all types of installations, including Business Objects server products and desktop products. It allows you full control over the entire installation process, and has the look and feel of industry-standard Windows installations.Both desktop and server products use the Microsoft InstallShield. This has several benefits, including:• built-in command-line mode• reliable installation and uninstallation• automatic repair of corrupted installationsThe wizard provides detailed information on all the installation options available. The actual steps you see when running the wizard vary depending upon whether you are:• installing the product for the first time• modifying an existing installation• removing all or part of an installation• updating to a new release• performing an administrative installation• repairing an installation

Command-line installationYou can use command-line installations to install entire product families or individual products. For example, you can install only BusinessObjects in 3-tier mode. Command-line mode is an important feature for deployment and integration in other products. With it, you can:• remotely install products using scripts or management systems• embed the installation of BusinessObjects within your own installation scriptCommand-line installations are explained in Administrative and Command Line Installations on page 69.




Business Objects productsThere are five categories of Business Objects products:• Server products

Server products are installable on Windows Server and UNIX platforms. server products include the server components of 3-tier Business Objects solution.

• Desktop productsDesktop products run on Windows-only client machines.

• Administration productsYou can install these either on client machines or on servers.

• Access packsThese allow Business Objects products to access your database.

• Demo kitsThese include demonstration databases to allow you to understand all the features of your Business Objects installation.

The lists of server products and desktop products are given in the tables below. You use the same Installation Wizard to install both server products and desktop products.

NOTE

The products you see in the Installation wizard depend upon your license.

Server productsServer products are network server applications. Because they must be deployed on network servers, their hardware and software requirements are not the same as those of the other product families. Because server products use CORBA for distributed processing they must be installed on each node of a cluster, and on web and application servers. See What is a cluster? on page 19 for more information.

NOTE

To enable your Business Objects server to connect to a data source, appropriate Database Access Packs and OLAP Access Packs must be installed on the Business Objects server as well.



Business Objects products

To know which platforms you can install server products on, refer to the PAR (Product Availability Report) on http://www.techsupport.businessobjects.com. The installer checks to see which platform you have installed, and installation stops if you are trying to install on a different platform or one earlier than those listed.If you do not have a supported operating system, you do not see the option to install server products.Following is a list of server products.

Server product DescriptionBusiness Objects server Required for any Business Objects server solution.

It is the engine behind all the other Business Objects server components, such as InfoView and WebIntelligence.

InfoView The gateway to your enterprise documents. InfoView contains:• web server pages, to be installed on the machine

hosting your web server.• front-end components, to be installed on the machine

housing your application server.

WebIntelligence Allows users to access, analyze, and share corporate data over intranets and extranets, for both relational databases (RDBMS) and OLAP servers. It includes:• REPORTER: to query the database and build reports• EXPLORER: to drill down to finer levels of analysis in

reports

BusinessObjects Web Installer

Enables users to install BusinessObjects in 3-tier mode from InfoView.

Broadcast Agent Broadcast Agent is the integrated enterprise report and broadcast server that allows users to publish, push, and broadcast predesigned or ad hoc reports in batch mode, via the Internet, InfoView, and a wide range of output devices.Its single component, which can be installed separately for distributed use over a network, is Scheduler, which monitors task scheduling and launches tasks.

Connection Server (CORBA-based version)

A server component that can be used to access databases.






Desktop productsYou can install desktop products only on Windows.Following is a list of desktop products.

Administration productsAdministrative products enable you to control user access and other security issues, configure and monitor server products and Broadcast Agent, design universes.

Desktop product DescriptionBusinessObjects BusinessObjects is the integrated query, reporting, and

analysis solution that enables you to access the data in your corporate databases directly from your desktop and present and analyze this information in a BusinessObjects (.rep) document. There are two modules:• REPORTER: to query the database and build reports• EXPLORER: to drill down to finer levels of analysis

3-tier BusinessObjects A subset of BusinessObjects to enable users in 3-tier mode to edit reports created with BusinessObjects.

BusinessQuery for Excel An add-on tool that provides Microsoft Excel® with fully functional database access. With BusinessQuery, you can access your corporate databases from Excel using familiar business terms.




Following is a list of administration products.

Product DescriptionDesigner The tool administrators use to create, manage, and

distribute universes for BusinessObjects and WebIntelligence users. A universe is a file that contains connection parameters for database middleware, and SQL structures called objects that map business terms to SQL structures in the database such as columns, tables, and database functions.

Supervisor The control center for the administration and security of your entire Business Objects deployment. It allows you to set up and maintain a secure environment for the overall Business Objects system with control of access to resources. This information is centralized through relational data accounts called repositories.

Supervisor over the Web Allows your supervisors to manage users and user groups from a web browser

Auditor A web-based product that allows you to monitor and analyze user and system activity for BusinessObjects in 3-tier mode, Broadcast Agent, and WebIntelligence, and display the results on a user-friendly web interface. This information provides valuable insight into your Business Objects deployment, enabling you to optimize your BI solution.

Configuration Tool Allows you to configure your Business Objects server, including:• web servers• application servers• the ORB

Administration Console Available as either a Java applet or an executable application, it enables you to administer and tune the overall Business Objects system.

Broadcast Agent Console Used by the administrator to monitor the status of processed and pending tasks and to execute actions such as running a task immediately or deleting it.Broadcast Agent Console can be deployed either on a server or a client machine. You must install and run Configuration Tool on any machine where you install Broadcast Agent Console.




Access packsYou must install an access pack so that your Business Objects server can connect to your database. The access pack must be on the same machine as a Business Objects server, so the same operating system restrictions apply.Consult the readme file on the product CD for instructions on obtaining currently supported database platforms, or consult the Product Availability Report (PAR) on the Business Objects Online Customer Support website at www.techsupport.businessobjects.comLike other Business Objects products, you need a license to install an access pack.





Demo kitsThe demo kit is a collection of Business Objects demonstration materials. The demo kit contains the following files:

Type of material

Files Description

Universes beach.unvefashion.unv

beach.unv is the universe used in most examples in the Designer’s Guide.efashion.unv is the universe used in other Business Objects guides.

Databases club.mdbefashion.mdb

The sample databases Club and efashion. These are used by the sample universes so that BusinessObjects and WebIntelligence users can follow the Getting Started guides.

Documents EFASHION.BMPEFASHION.REPEFASHION.XLSREVENUE.REPTUTORIAL.REPlesson1.pdflesson1.widlesson2.pdflesson2.widlesson2.xlslesson3.widlesson4.widlesson5.wid

Sample reports and lessons used by the BusinessObjects Getting Started Guide and the WebIntelligence Getting Started Guide.

Templates Various template files

Templates used to create BusinessObjects and WebIntelligence reports.




Types of installationThis section describes the three types of installation and their associated products.The three types of installation are:• Desktop• Server• CustomYou use the same Installation wizard to install all products. The Desktop and Server installation options install a preselected package of products. If you want to select individual products to install, use Custom installation.You cannot change the default installation directory if you use a Desktop or Server installation.When upgrading from a previous 6.x version, Desktop and Server installations are not available. You must use Custom.

Installing server products and other products separatelyBusiness Objects server products must be installed on a dedicated server. Their installation on a server housing any products other than the operating system itself, appropriate middleware, and a web server, is not supported.This means that Business Objects desktop products should not be installed on the same machine as server products. This can cause unreliable operation of the Business Objects system.

Desktop installationDesktop products run on Windows-only client machines.The Desktop installation installs all the products you need in a desktop environment. This includes the following desktop components:• BusinessObjects

- Reporter- Explorer- 3-tier BusinessObjects (desktop component)- Online help- Online guides

• BusinessQuery for Excel



Types of installation

And the following administration products:• Supervisor• Designer

Server installationIf you do not have a supported operating system, you do not see the option to install server products.The Server installation installs all the products you need for network servers. This includes the following server components:• Business Objects server• InfoView• WebIntelligence• Business Objects Web Installer

Enables users to download 3-tier BusinessObjects from InfoView.• Broadcast Agent Scheduler• Connection Server (CORBA-based version)And the following administration and related products:• Access packs• Supervisor• Supervisor over the Web• Auditor• Configuration Tool• Administration Console• Broadcast Agent Console• Demo kit

Custom installationIn a Custom installation, you can install all or part of any product family.You must use Custom installation if you:• do not want to install the preselected Desktop or Server packages• install only the 3-tier BusinessObjects component on a desktop machine• install Business Objects Web Installer• install Business Objects server and web applications on a client node• want to change the default installation directory




• install Broadcast Agent Scheduler or Broadcast Agent Console on a desktop machineBecause Broadcast Agent Console acts as part of the cluster, you must also configure the machine to be a node within the cluster. Therefore, if you install Broadcast Agent Console on a client machine, you must also install Configuration Tool in order to be able to configure it.

Connection ServerThe CORBA-based version of Connection Server is installed automatically whenever you install Business Objects server components. However, you also have the option of setting up a dedicated connectivity node in the cluster. (For detailed information, see the Deploying the Business Objects System guide.)To do this, you need to select only Connection Server in the tree list, along with the appropriate data access pack. Later, you configure a secondary node as the connectivity node. All RDBMS requests are then routed through this dedicated node.

Active XActive X appears in the tree list only on an administrator’s machine. For other machines, you must use a command-line installation (see Administrative and Command Line Installations on page 69). Active X is called using:ADDLOCAL=bo.activex INSTALLACTIVEX=1 DEFAULT_LANGUAGE=<language code>



Running the installation

Running the installationThe following table is designed to help you keep track of where you are in the installation and configuration process. The current stage is indicated by a checkmark.

This chapter covers installation using the Installation wizard. Command-line installations are explained in Administrative and Command Line Installations on page 69.The Installation wizard starts automatically (after the Welcome screen) when you insert your Business Objects CD into the CD drive. If the installation does not start automatically, use the Windows Explorer to browse to your CD drive, and then double-click setup.exe.If your Business Objects CD includes more than one language, you must select the language in which the Installation wizard runs.

Where you are now






page 113



- wdeploy page 181




page 265




NOTE

If you are updating from a previous release, have the original installation CDs available.

Instructions below for running the installation are divided into:• Desktop installation• Server installation• Custom installation

Desktop installationTo run a Desktop installation:1. Insert Business Objects installation CD1 into the disk drive.

The Choose Setup Language dialog box appears.2. Click OK, and then on the Welcome page, click Next.

The License Agreement appears.3. Read the agreement carefully.

- If you do not accept it, select I do not accept the terms in the license agreement, and then click Cancel. The Installation wizard closes. - If you accept it, select I accept the terms of this license agreement, and then click Next.

The Installation Notes page appears.Late-breaking information about installing and configuring Business Objects appears on this page. Read these notes carefully.

4. Click Next.The wizard checks whether a previous version of Business Objects products has been installed.- If a previous version is detected, go to Previous version detected on page 67.- If no previous version is detected, the License Files Folder page appears.




5. If you want to change the location of the license file, click Change, and then browse to find the directory.To see a list of the licenses you have, click Check License.

6. Click Next.The User Information page appears.The Installation wizard suggests the user and company names found in the license files or the default system values.If you want to limit access to the user currently logged in, select Only for me.

7. Click Next.The Languages to Install page appears.

8. Select the languages you want, and then click Next.If you selected more than one language, you are prompted to select a default language.The Installation Type page appears.

If your operating system does not support server products, you see only the Desktop and Custom installation options.

9. Select Desktop installation.For an explanation, see Types of installation on page 56.

10.Click Next.The Ready to Install the Program page appears.

11.Click Install.The installation begins.

When the Desktop installation is finished, you are ready to use Business Objects. Restart the machine before opening any products.




Server installationTo run a Server installation:1. Insert Business Objects installation CD1 into the disk drive.







6. Click Next.The User Information page appears.The Installation wizard suggests the user and company names found in the license files or the default system values.Do not select Only for me.


8. Select the languages you want, and then click Next.If you selected more than one language, you are prompted to select a default language.




The Installation Type page appears.


9. Select Server installation.For an explanation, see Types of installation on page 56.

10.Click Next.The Ready to Install the Program page appears.

11.Click Install.The installation begins.

When the installation is completed, the Installation Wizard Completed page appears.In order to complete your installation, you need to perform configuration. Do either of the following:• If you want to begin configuration now, select the Configure Server Products

box, and then click Finish. Go to Configuration Overview and Scenarios on page 93.

• If you want to begin configuration later, clear the Configure Server Products box, and then click Finish. When you are ready to begin, Go to Configuration Overview and Scenarios on page 93.




Custom installationTo run a Custom installation:1. Insert Business Objects installation CD1 into the disk drive.







6. Click Next.The User Information page appears.The Installation wizard suggests the user and company names found in the license files or the default system values.If you want to limit access to the user currently logged in, select Only for me. Do not select it if you are installing server products.


8. Select the languages you want, and then click Next.If you selected more than one language, you are prompted to select a default language.




The Installation Type page appears.


9. Select Custom installation.For an explanation, see Types of installation on page 56.

10.Click Next.

Setting custom installation optionsYou now select the individual components you want to install. The components are organized by product “families.”A “+” next to the product name indicates that it contains other components.

If the icon is grey, then some components under that product are not selected. If the icon is white, all options are selected. If the icon has a red X, the option cannot be installed.




To select and install products:1. Click the server icon next to a family, product, or component, and you see the

feature options:

2. Select the option you want.Selecting a product automatically selects all products beneath it.

3. To modify the installation directory, click Change. You can set the root installation directory only; the subdirectories remain the same.Click Disk Space to make sure you have enough disk space to install the products.

4. Click Next.The Configure Folders page appears.

5. Modify the locations of the local and shared .key files if you want, and then click Next..key files contain the address of the repository security domains. The .key file must be located on 2-tier users’ machines, as well as on all Business Objects server machines.The Ready to Install the Program page appears.

6. Click Install.The Installation wizard installs the products and components you selected.- If you performed a Custom installation without server products: When the Installation Wizard Completed page appears, you can begin using Business Objects. Restart the machine before opening any products.- If you performed a Custom installation that includes server products: The Installation Wizard Completed page contains an option to configure server products.




7. Do either of the following:- If you want to begin configuration now, select the Configure Server Products box, and then click Finish. Go to Configuration Overview and Scenarios on page 93.- If you want to begin configuration later, clear the Configure Server Products box, and then click Finish. When you are ready to begin, go to Configuration Overview and Scenarios on page 93.

Previous version detectedIf server products from a previous version are detected when you run the Installation wizard, a notice appears. Quit the wizard, uninstall the server products, and restart the installation.If version 5.x desktop products are detected, the following message appears.

• If you upgrade from the previous version, when the installation begins, the Installation wizard starts the Business Objects 5.x setup program to uninstall version 5.x.

• If you keep the existing release, the wizard installs BusinessObjects 6.5 in a separate directory and does not perform an upgrade. The previous version remains as it was.

If the Installation wizard cannot find the Business Objects 5.x setup program, you must re-install the setup program from the original Business Objects 5.x CD:1. Quit the Installation wizard by clicking Cancel.2. Run the installer from your original Business Objects 5.x CD.3. On the first page, select desktop products.4. From Choose the Products and Modules, open the Utilities group, select

Setup, and then click Install.5. When the installation has finished, quit and re-start the 6.5 Installation wizard.





chapter

Administrative and Command Line Installations




OverviewThe following table is designed to help you keep track of where you are in the installation and configuration process. The current stage is indicated by a checkmark.

This chapter explains how to perform administrative and command-line installations of BusinessObjects 6.5. To perform an installation using the Installation wizard, see Installing BusinessObjects 6.5 on page 41.An administrative installation allows users to run products from a central network location. It replaces the Master/Shared installation of earlier versions of Business Objects.

Where you are now






page 113



- wdeploy page 181




page 265



Command-line mode is an important feature for deployment and integration in other products. With it, you can:• remotely install products using scripts or management systems• embed the installation of BusinessObjects within your own installation scriptYou can also launch the Configuration Tool in non-interactive (command line) mode. See Configuration Tool in Command Line Mode on page 141.




Administrative installationsAn administrative installation has two stages:1. From the CD, you run an Administrative installation to a shared network

location.This makes a copy of the CD on the network.

2. Clients run the Installation wizard from the shared network location, installing the components on their local machine.

Installing to a shared network locationFor administrative installations, you cannot run the Installation wizard from the CD. You must run it from the Windows Start menu or from the command prompt.To install to a shared network location:1. Do either of the following:

- From the Windows Start menu, point to Run. Type setup /a and then click OK. Go to Step 4.- Open the Windows command prompt.

2. At the command prompt, enter the following commands:<drive letter>

cd <setup directory>

where <drive letter> is the drive containing the Business Objects CD and <setup directory> is the directory containing setup.exe.

3. Run setup.exe with the /A property (type setup /A).The Installation wizard starts in administrative mode.

4. Continue through the wizard until you see the Network Location page.5. Specify the shared network location of your administrative installation, and

then click OK.If you want to change the destination folder, click Change.

6. Click Install.If you cancel the installation, the wizard rolls back the installation completely. The installation may take several minutes.

7. Click Finish.

Installing on the client machineAfter you finish your Administrative installation, clients can connect to it and install components of BusinessObjects 6.5 locally. The procedure is the same as in Running the installation on page 59.



Command-line installations

Command-line installationsTo perform a command-line installation, you run setup.exe from the command prompt, specifying certain parameters. If you run setup.exe without specifying any parameters, it runs in normal interactive mode.You can use command-line installations to install entire product families or individual products. For example, you can install only BusinessObjects in 3-tier mode. The installation has three components:• BusinessObjects 6.5 Installation wizard• InstallShield• Windows InstallerCommand-line installations can include parameters for each of these components.

SyntaxThe general syntax for command-line installations is:setup.exe /<parameter 1> /<parameter 2> /<parameter 3> ........

Parameters for the BusinessObjects 6.5 Installation wizard and the Windows Installer must be preceded by /v:setup.exe /v<parameter>=<value>

The /v specifies that the parameters that follow are passed directly to the Windows Installer and are not used by InstallShield.Parameters must be enclosed by quotation marks if there are spaces in the string.For examples of commands, see Command-line installation: examples on page 79.

Path namesPath names must contain a final backslash. If the parameter string has one or more spaces, and if the backslash is the final character in the string, insert a space between the backslash and the quotation mark. Otherwise \” will be read as a special character and cause unintended results.For example:setup.exe /s /v”/qn LICENSEDIR=\bo\licenses\ ”

The LICENSEDIR, LOCALKEYDIR, and SHAREDKEYDIR parameters require values that are paths.




InstallShieldInstallShield parameters must be preceded by a forward slash (/). Some parameters, such as language codes, require values immediately afterward. These take the form:setup.exe /<parameter>[value]

Installation wizard parametersThe following table shows the Installation wizard parameters.

Parameter Values DescriptionMIGRATION 0 for Keep

1 for Upgrade

Default: 1

Desktop products only.If Business Objects 5.x desktop products are detected, it defines what occurs:0 keeps the existing installation and installs BusinessObjects 6.5 in a different directory.1 uninstalls the older product, performs the upgrade, and migrates settings.

MIGRATIONPROMPT 1 or 0

Default: 1

Interactive installation only.When set to 1, it prompts the user to choose whether to upgrade or keep an existing Business Objects 5.x installation.When set to 0, the user does not see the prompt, and upgrade occurs or does not occur according to the value of MIGRATION.

LICENSEDIR License directory Mandatory for all command-line installations except an administrative or 3-tier BusinessObjects install. Defines the path to the directory containing the license files.Copy your license files to a directory on a client or server machine before running a command-line installation.




INSTALL_LANG ISO language code in lower case

Indicates the list of languages to be installed. If this property is not specified, the products are installed in the default language shown in interactive mode. This is English in most distributions.You can install more than one language by listing the ISO codes in lower case, separated by a comma.See Language Codes on page 283.

DEFAULTLANG ISO language code Use only if you install more than one language.

LOCALKEYDIR Default is either an existing previous release directory or the default Business Objects directory

For desktop products only.Defines where a product looks for .key files and user .dll files.Has no impact on where the Business Objects products themselves are installed.Must end with a backslash (\).

Parameter Values Description




SHAREDKEYDIR As above For desktop products only.Defines where a product looks for shared .key files.Has no impact on where the Business Objects products themselves are installed.Must end with a backslash (\).

THREETIERBUSOBJ 1 or 0Default: 0

When set to 1, indicates that BusinessObjects is installed for use in 3-tier mode. Some files are then installed locally to reduce the download time when a user selects the option from InfoView. Note: Sets download to 1 in InfoView. If you want to customize the InfoView page to allow other downloads, reset this to 0.

WEB 1 or 0Default: 0

Set this to 1 if installation is being run from a script or batch file on a Business Objects server.Otherwise, do not specify this parameter.





Windows Installer parametersThe following table shows the Windows Installer parameters.

Parameter Values DescriptionCOMPANYNAME Company name

Default: system value.

USERNAME Any user nameDefault: system value.

ALLUSERS NULL, 1, or 2 Determines where the configuration information of the installed application is stored.NULL: Per-user installation using folders in user's personal profile.1: Per-machine installation using folders in the “All Users” profile. Checks for administrative access privileges and returns an error message if they are not sufficient. 2: Per-machine installation using folders in the “All Users” profile.

INSTALLDIR Root installation directory Must end with a backslash (\).

ADDLOCAL Products to be installed Installs products on local machine. Multiple product names can be listed, separated by a comma.You must specify the code for each component of the product, not just the generic product name. At a minimum, this usually includes the application code, the online help code, and the documentation code.For product codes, see Business Objects Products and Feature Codes on page 277.

INSTALLVBA 1: install0: do not installDefault: 1




INSTALLTYPE NULL if ADDLOCAL is defined1 if desktop installation 2 if server installationDefault is 1

Allows you to install either desktop or server products.Only products for which you have a license are installed.

ADDSOURCE Packages to be installed. Installs products to run from the network. Multiple product names can be listed, separated by a comma.Note that you must specify the code for each component of the product, not just the generic product name. Normally this would include the application code, the online help code and the documentation code as a minimum.Codes for the products are listed in Appendix B.

REMOVE Products to be removed Removes products from local machine. Multiple product names can be listed, separated by a comma.You must specify the code for each component of the product, not just the generic product name. At a minimum, this usually includes the application code, the online help code, and the documentation code.For product codes, see Business Objects Products and Feature Codes on page 277.

/qn None Instructs Windows Installer component to run in silent mode. Always preceded by the Install Shield parameter /s and, because it is a Windows Installer parameter, immediately preceded by the Install Shield parameter /v. The syntax is:setup /s /v /qn...





InstallShield parametersThe following table shows the InstallShield parameters.

The only parameters usually used alone are /a and /x. For example, to remove the entire BusinessObjects 6.5 installation:setup /x

Command-line installation: examplesBelow are some examples of a command-line installation. These include: • removing an entire installation• removing individual products• installing a product locally• installing all desktop products• installing several languages and products• performing a silent installation• performing a silent installation of several languages and packages

Removing an entire installationTo remove an entire installation (as opposed to a single product):setup /x

Parameter Name What it does/a Administrative installation Copies the Business Objects CDs to a

shared network location.

/x Uninstallation Uninstalls the entire product.

/v Pass to Windows Installer Passes parameters and associated values to the Windows Installer service.

/s Silent mode Suppresses the InstallShield initial Preparation and Language choice windows. Used with the Windows Installer option /qn.

/L Installation language Must be followed by the ISO language code. See Language Codes on page 283 for a list.

/w Wait Forces setup.exe to wait until installation is complete before exiting.




Removing individual products To remove individual products: setup /v”REMOVE=<Product1>,<Product2> ......”

Include the names of all components that need to be removed. For example, to remove Supervisor, you would specify the Supervisor application, the online help, and the documentation:/v”REMOVE=bo.SupervisorApp,bo.SupervisorHelp,bo.SupervisorDoc”

See Business Objects Products and Feature Codes on page 277 for a list of features and codes.

Installing a product locally Include the names of all components that need to be installed.For example, to install Designer locally:setup /v”LICENSEDIR=c:\bolicense ADDLOCAL=bo.DesignerApp,bo.DesignerDoc, bo.DesignerHelp”

Installing all desktop productsThis installs all desktop products for which you have a license.setup /v”LICENSEDIR=c:\bolicense INSTALLTYPE=1”

Installing several languages and productsWhen you install more than one language, you must specify the default. The example shows the command line for installing English, French, and German with French as the default, plus adding Designer to run locally:setup /v”LICENSEDIR=c:\bolicense INSTALL_LANG=en,fr,ge DEFAULTLANG=en ADDLOCAL=bo.DesignerApp,bo.DesignerDoc,bo.DesignerHelp”

Performing a silent installationPerforming a silent installation combines the /s parameter from InstallShield with the /qn parameter from the Windows Installer. You must include both for the installation to be totally silent:setup /s /v “/qn LICENSEDIR=D:\bolicense\ “

After ADDLOCAL, make sure you use the predefined.setup.invisible option. This sets the PATH environment variable. Otherwise, the user will not be able to log in to WebIntelligence. For example:ADDLOCAL=bo.WebIntelligence,bo.WebIntelligenceReporter, bo.WebIntelligenceExplorer,......predefined.setup.invisible




Performing a silent install of several languages and packagesThis combines the different parameter types:setup /s /v“/qn LICENSEDIR=c:\bolicense\ INSTALL_LANG=en,fr,ge DEFAULTLANG=en ADDLOCAL=bo.DesignerApp,bo.DesignerDoc,bo.DesignerHelp”





chapter

Modifying and Removing Installations




OverviewThis chapter explains how to modify or remove an existing BusinessObjects 6.5 installation. This includes:• adding a product• removing a product• repairing an installation• removing the installation entirelyYou can only add products for which you have a license. You must copy the license file to your license directory before you run the installer.You must log on as administrator in order to perform the procedures in this chapter.



Adding a product

Adding a productWhen you purchase an additional Business Objects product, add the license file to the same directory where your other licenses are stored.If you are installing components of BusinessObjects 6.5 on different nodes within a cluster, make sure the license files are available in a network location to which all nodes have access.You add products using the BusinessObjects 6.5 Installation Wizard.

NOTE

You can add and remove products at the same time in the Installation Wizard. The instructions are divided into adding and removing for the sake of clarity.

To add a product:1. Run the BusinessObjects 6.5 Installation Wizard from either:

- the Business Objects installation CD- Add/Remove Programs in the Windows Control PanelThe Welcome page appears.

2. Click Next.The Program Maintenance page appears.

3. Selecte Modify, and then click Next.The Custom Setup page appears.

4. Select the products you want. See Running the installation on page 59 for instructions.A cross next to a product name means that it is not installed.You can select any combination for which you have a license. You cannot select server products if your platform does not support them.




5. When you finish your selections, click OK to return to the Custom Setup page.6. Click Next.

The Ready to Modify the Program page appears.7. Click Install.

The installation begins.If you cancel, the Installation wizard rolls back the installation by:- removing any files copied- removing any registry keys that have been setThe Installation Wizard Completed page appears.

8. Click Finish.Depending on the version of your operating system and the products you added, you may need to restart the machine.



Removing products

Removing productsWhen you remove products, do not delete or modify the license file.To remove products:1. Run the BusinessObjects 6.5 Installation wizard from either:

- the installation CD- Add/Remove Programs in the Windows Control PanelThe Welcome page appears.

2. Click Next to continue.The Program Maintenance page appears.

3. Select Modify, and then click Next.The Custom Setup page appears.Only licensed products currently on your hard disk are displayed.

4. To select a product to remove, expand the tree by double-clicking on the product family name.Click the product, and then select This feature will be removed from your local hard drive from the menu that appears.A red “X” next to the product shows that it will be removed.

5. Finish making your selections, and then click Next.The Ready to Modify the Programs page appears.

6. Click Install.The product is removed.




Repairing an installationSometimes a BusinessObjects 6.5 installation becomes disrupted and is no longer operational. This may be caused, for example, by an interrupted installation or the unintended deletion of a file. The Installation wizard usually enables you to repair the installation.The repair mechanism cannot retrieve corrupted user data, license files, or customized files. Your backup strategy is the only way to recover these files.To repair an installation:1. Run the BusinessObjects 6.5 Installation wizard from either:



3. Select Repair, and then click Next.The Ready to Repair the Program page appears.

4. Click Install.Installation wizard now checks your installation and installs any files necessary for the repair. This may take several minutes.



Removing BusinessObjects 6.5

Removing BusinessObjects 6.5You can use the Installation wizard to remove an entire BusinessObjects 6.5 installation from a server or client machine. The following files must be deleted manually:• License files• Documents and reportsIf you want to remove Business Objects server products, you must first run the Configuration Tool to remove the node (see Modifying storage and other directories on page 123).To remove an entire installation:1. Run the Installation wizard from either:



3. Select Remove, and then click Next.The Remove the Program page appears.

4. Click Remove.The Installation wizard uninstalls program files, profile items, and registry keys.The installer does not remove the original installation directory or user files and settings. If you want to remove them, you must do so manually.

TIPRestart your computer before manually deleting files. This way, all changes made to the registry are loaded, and you can remove the Business Objects directory without any error messages appearing.




Applying a hotfixHotfixes resolve bugs that cannot wait for the next minor release or service pack. Hotfixes are available either by download from the Business Objects website or by email on request. New releases incorporate hotfixes issued since the previous minor release or service pack.Because hotfixes replace individual program or library files, there is no need to uninstall your Business Objects installation. Also, your configuration files are not affected.Always check the readme that comes with the hotfix to make sure that you can apply it to your system, and to see whether there are any special instructions.Apply the hotfix by copying the patch_<hotfix number>.exe file to a directory on your hard disk, then running it.


part

Configuration



chapter

Configuration Overview and Scenarios





This chapter describes the different configuration tools and methods you can use to configure Business Objects server products. Your choice of tool and method depends on:• the application and web servers you are using• how you have organized your deployment

Where you are now






page 113



- wdeploy page 181




page 265



Tools and methods

Tools and methodsThis section reviews the tools and methods used during configuration.Tools and methods include:• Configuration Tool• wdeploy tool• Manual configuration

What’s New in 6.5There is an important change in BusinessObjects 6.5 that impacts all customers who are using application and web servers other than Apache/Tomcat and IIS.If you are using WebSphere or WebLogic, you now use the Configuration Tool only to define the cluster and configure the ORB. To deploy Business Objects web applications (InfoView, Administration Console, Auditor, Supervisor over the Web, and custom applications) you use a second tool, the new wdeploy tool.

Configuration ToolThe Configuration Tool allows you to configure the ORB, and to deploy Business Objects web applications on the web server and application server.If you are using IIS or Apache/Tomcat, you can use the Configuration Tool for this entire process. In this case, you need to install the tool on the Business Objects server, web, and application server machines.If you are using other web and application servers, you must:• use the Configuration Tool to configure the ORB• use the wdeploy tool to deploy and configure the web applicationsYou can run the Configuration Tool immediately after installing BusinessObjects 6.5, or any time afterward.

Application server To define the cluster and configure the ORB, use

To deploy web applications, use

IIS Configuration Tool Configuration Tool

Apache/Tomcat Configuration Tool Configuration Tool

WebLogic Configuration Tool wdeploy tool

WebSphere Configuration Tool wdeploy tool

Others Configuration Tool wdeploy tool




Even if your web server is not within the cluster, you must still install and run the Configuration Tool so that the web server can communicate with the cluster and vice versa.

Who can use the Configuration ToolAlthough any user can start the Configuration Tool, some specific permissions are required. Log on as an administrator or the equivalent.The account must have the following rights:• Act as part of the operating system• Log on as a serviceUse Windows User Manager to assign these rights before you run the Configuration Tool. You must restart the Business Objects system for these rights to take effect.

IIS Administration serviceDuring the deployment of IIS as web server and application server (using the Configuration Tool), the IIS Administration service is automatically stopped. Therefore, IIS is not available during this part of the configuration process.

Make sure Apache and Tomcat are stoppedApache and Tomcat must not be running while you configure Business Objects server products. To stop Apache and Tomcat:1. In the Windows Start menu, point to Settings > Control Panel > Administrative

Tools > Services.2. Right-click Apache and select Stop from the menu.3. Right-click Apache Tomcat 4.1, and select Stop from the menu.

TCP portsThe server uses a number of TCP ports for inter-machine process communication. One port is allocated for each Business Objects process that is running; for example, WIAdminServer or WIQT. These ports must be free; otherwise, the system cannot function correctly. Normally, with default settings, between 20 and 30 ports are needed.The first port to be used is the one you set in the Configuration Tool. (See Configuring the ORB on page 113.) If you do not have a sufficient number of ports available, you can change the number of the first port.



Tools and methods

After you complete configuration and start the Business Objects system, in the Administration Console you can start or stop processes and modify the number of instances for pools of processes. Keep in mind that this changes the number of TCP ports that are required.

Using a firewallYou can set up a firewall between the Business Objects server and the application server (for details, see the Deploying the Business Objects System guide).If you use this kind of firewall, you need to make sure that certain ports are open. These ports are displayed in the Administration Console, when the server is selected (Exposed Ports area).If your cluster contains primary and secondary nodes, you need to open ports for the primary and all secondary nodes.

Command-line modeThe Configuration Tool can also run from the command line, and you can supply it with parameters from a text file. See Configuration Tool in Command Line Mode on page 141.

wdeploy toolwdeploy is a command-line tool that can deploy Business Objects web applications on any web server and application server for JSP deployments.If you are not using IIS or Apache/Tomcat, you must use the wdeploy tool to deploy and configure your web applications.The wdeploy tool offers great flexibility in the deployment of web applications. It enables you to:• create .war files for Business Objects web applications• include in the .war file elements that are specific to a cluster, an ORB, or an

application server• add static resources to the .war file, so that you can deploy your application

server in standalone mode• deploy and remove a web applicationEven if you use wdeploy, you still need to install the Configuration Tool to configure the ORB.




Manual configurationMost of the configuration procedures can be done manually, without using the Configuration Tool or wdeploy. This may be appropriate for highly-skilled administrators with special configuration requirements.Even if you perform manual configuration, you still must use the Configuration Tool to configure the ORB.For full details on manual configuration, see the Manual Web and Application Server Configuration guide.



Deploying web applications

Deploying web applicationsBusinessObjects 6.5 includes four web applications:• InfoView

Any cluster used for sharing and processing documents must have a deployment of the InfoView application to allow InfoView users to access the Business Objects server.

• Admin (the Administration Console) Deployment of the Admin application provides administrators with access to the Administration Console.


• Auditor The Auditor application provides access to BusinessObjects Auditor.

You deploy these web applications on your web and application servers. You can deploy the web applications in any order.Deployment is almost the same for the various applications, except that Business Objects recommends you deploy Auditor on a separate cluster and repository.Make sure you allot enough space for the deployment of your web applications:• You will need a temporary directory in which the prepackaged WAR file for

each web application is decompressed on the application server machine. Make sure at least 1.5 GB are vailable for this directory.

• Make sure you have enough disk space on the application server machine for the deployment of the web applications’ resources.

For more detailed information, see the application server documentation.




What goes on the application server, and what on the web server?Business Objects web applications are made of dynamic and static resources.• Dynamic resources are contained in a .war (Web Archive) file, which must be

deployed on the cluster’s application server.• Static resources such as HTML and GIF files are contained in a .zip file, which

must be unzipped on the cluster’s web server.

These .war and .zip files are automatically installed on the Business Objects server machine by the standard setup process.

Making sure you deploy all the web applications you needBecause you probably need to deploy more than one Business Objects web application, the procedures described in this guide are often repetitive. To help keep track of what you have already deployed, you will see a standardized checklist containing the names of the web applications:

Business Objectscluster on intranet

Business Objects serverInfoViewSupervisorAdministration Console

Application serverWeb applications’dynamic resources(.war file)

Web serverWeb applications’

static resources(.zip file)

Users

Web applications to deploy

❏ InfoView

❏ Admininistration Console

❏ Supervisor over the Web

❏ Auditor



Configuration scenarios

Configuration scenariosThe sections below explain four configuration scenarios that are based on four common deployments. You can use a scenario as a guide for your own configuration.If you do not want to follow a scenario, go to Configuring the ORB on page 113.Each scenario includes the procedures you follow for configuring the ORB, service parameters, and web applications using a scenario.There are four scenarios:• Scenario 1 -- Apache/Tomcat or IIS on a single machine• Scenario 2 -- Two machines/web and application servers together• Scenario 3 -- Two machines/E6 and application server together• Scenario 4 -- Three machines/web and application server separate




Scenario 1 -- Apache/Tomcat or IIS on a single machine

Here’s what Scenario 1 looks like:

With this scenario, you perform a a largely-automated configuration process. This makes use of the Typical wizard within the Configuration Tool.Within the context of this guide, a standalone deployment is one in which all the web applications’ resources are located on the application server.To use Scenario 1, you must have:• Business Objects server products, the web server, and the application server

on a single machine• IIS or Apache/Tomcat• one IP address• one cluster with one primary node• no external authentication; authentication and authorization performed only

on the repositoryFor single-machine deployments that do not meet all of these conditions, follow the configuration procedures that begin with Configuring the ORB on page 113.You must finish installation of BusinessObjects 6.5 before beginning the procedures.

Machine 1--Business Objects server

(primary node)Users

Intranet


--Application server--Web server



Scenario 1 -- Apache/Tomcat or IIS on a single machine

In this scenario, you can configure and deploy InfoView, Supervisor over the Web, and the Administration Console. You cannot deploy Auditor or customized applications.The web applications are configured using the default web application names: wijsp or wiasp for InfoView, wiadmin for Admin and wsupervisor for Supervisor over the Web. These cannot be changed.

Running the Typical wizardTo begin the procedures for Scenario 1, you need to run the Typical wizard, using it to configure the ORB and deploy the web applications. For instructions, go to Typical Configuration on page 127.

Where to go nowWhen you finish your configuration using the Typical wizard, go to Getting the System Ready on page 221.




Scenario 2 -- Two machines/web and application servers together


To use Scenario 2, you must have:• a machine hosting the Business Objects server and the Configuration Tool

This is the primary node.• a second machine with the web server, application server, and the

Configuration ToolThis is the client node.

Machine What is installed on itMachine 1 • Business Objects server

• Configuration Tool (to configure the ORB)

Machine 2 • Application server• Configuration Tool (to configure the ORB)• Web server

Machine 1

Machine 2


--Web and application servers

(primary node)

Users

(client node)

Intranet





Scenario 2 -- Two machines/web and application servers together

For two-machine deployments that do not meet these conditions, either:• follow the configuration procedures that begin with Starting the Configuration

Tool on page 116.• follow Scenario 3 on page 106 if it fits your deploymentYou must finish installation of BusinessObjects 6.5 before beginning the procedures.

Configuring machine 1On Machine 1, you configure the ORB for a primary node. Follow the instructions in Starting the Configuration Tool on page 116.

Configuring machine 2Machine 2 contains the application server and web server. You must perform the following two procedures:• Using the Configuration Tool, configure the ORB for a client node• Deploy the web applications.

This can be done with the Configuration Tool or with the wdeploy tool.

Configuring the ORB for a client nodeThe procedure for configuring client nodes is very similar to that of the primary node. The main differences are:• On the Node page, you select Client from the Node Type drop-down list.• You do not have to set service parameters for client nodes.Follow the procedure in Secondary or client node on page 120.

Deploying the web applicationsYou can deploy your web applications on the application server and web server by using the the Configuration Tool (IIS or Apache/Tomcat only) or the wdeploy tool.If you want to use the Configuration Tool, see Deploying Web Applications Using Configuration Tool on page 155.If you want to use the wdeploy tool, see Deploying Web Applications Using wdeploy on page 181.If you want to deploy and configure the web server and application server manually, see the Manual Web and Application Server Configuration guide.




Scenario 3 -- Two machines/E6 and application server together


To use Scenario 3, you must have:• a machine with the Business Objects server, the Configuration Tool, and the

application serverThis is the primary node.

• a second machine with the web serverFor two-machine deployments that do not meet these conditions, either:• follow the configuration procedures that begin with Configuring the ORB on

page 113.• follow Scenario 2 on page 104 if it fits your deployment


• Application server• Configuration Tool (to configure the ORB)

Machine 2 • Configuration Tool• Web server

Machine 1

Machine 2


--Web server

(primary node)

Users

Intranet






Scenario 3 -- Two machines/E6 and application server together

You must finish installation of BusinessObjects 6.5 before beginning the procedures.

Configuring machine 1Machine 1 contains the Business Objects server, the application server, and the Configuration Tool.You must perform the following two procedures:• Using the Configuration Tool, configure the ORB for a primary node• Deploy and configure the web applications on the application server. This can

be done with the Configuration Tool or with the wdeploy tool.

Configuring the ORB for a primary nodeOn Machine 1, you configure the ORB for a primary node. Follow the instructions in Configuring the ORB on page 113.

Configuring the application serverYou can deploy and configure your web applications on the application server by using the the Configuration Tool (Apache/Tomcat) or the wdeploy tool.If you want to use the Configuration Tool, go to Apache/Tomcat on page 164 and follow the instructions for application server only.If you want to use the wdeploy tool, see Deploying Web Applications Using wdeploy on page 181.If you want to configure the web applications manually, see the Manual Web and Application Server Configuration guide.

Configuring machine 2Machine 2 contains the web server. You need to deploy the static resources for each web application on the web server, and then add the virtual directories and redirections.You can do this by using the the Configuration Tool (Apache/Tomcat) or the wdeploy tool.If you want to use the Configuration Tool, go to Apache/Tomcat on page 164.If you want to use the wdeploy tool, see Deploying Web Applications Using wdeploy on page 181.If you want to configure manually, see the Manual Web and Application Server Configuration guide.




Where to go nowIf you want to deploy customized web applications on the web server, see Customized web applications on page 168.If you have no other products to configure on this machine, click Finish to quit the Configuration Tool.You must now perform a number of procedures to finalize your installation and configuration of BusinessObjects 6.5. Go to Getting the System Ready on page 221.



Scenario 4 -- Three machines/web and application server separate



To use Scenario 4, you must have:• a machine with the Business Objects server and the Configuration Tool

This is the primary node.• a second machine with the application server and the Configuration Tool

This is the client node.• a third machine with the web serverFor three-machine deployments that do not meet these conditions, follow the configuration procedures that begin with Configuring the ORB on page 113.


• Configuration Tool (to configure the ORB)

Machine 2 • Application server• Configuration Tool (to configure the ORB)

Machine 3 • Web server• Configuration Tool

Machine 1

Machine 3

Machine 2

- Business Objects server

Web server


Users

Intranet

(primary node)- Configuration Tool

--Configuration Tool(client node)

Configuration Tool




You must finish installation of BusinessObjects 6.5 before beginning the procedures.

Configuring machine 1On Machine 1, you configure the ORB for a primary node. Follow the instructions in Configuring the ORB on page 113.

Configuring machine 2Machine 2 contains the application server and the Configuration Tool. You must perform the following two procedures:• Using the Configuration Tool, configure the ORB for a client node• Deploy the web applications on the application server

This can be done with the Configuration Tool (Apache/Tomcat) or with the wdeploy tool.

Configuring the ORB for a client nodeThe procedure for configuring client nodes is very similar to that of the primary node. The main differences are:• On the Node page, you select Client from the Node Type drop-down list.• You do not have to set service parameters for client nodes.Follow the procedure in Secondary or client node on page 120.

Deploying the web applicationsYou can deploy and configure your web applications on the application server by using the the Configuration Tool (Apache/Tomcat) or the wdeploy tool.If you want to use the Configuration Tool, go to Apache/Tomcat on page 164 and follow the instructions for application server only.If you want to use the wdeploy tool, see Deploying Web Applications Using wdeploy on page 181.If you want to configure the web applications manually, see the Manual Web and Application Server Configuration guide.

Configuring machine 3Machine 3 contains the web server. You need to deploy the static resources for each web application on the web server, and then add the virtual directories and redirections.You can do this by using the the Configuration Tool (Apache/Tomcat) or the wdeploy tool.




If you want to use the Configuration Tool, go to Web server on page 166.If you want to use the wdeploy tool, see Deploying Web Applications Using wdeploy on page 181.If you want to configure manually, see the Manual Web and Application Server Configuration guide.

Where to go nowIf you want to deploy customized applications on the web server, see Customized web applications on page 168.If you have no other web applications to configure on this machine, click Finish to quit the Configuration Tool.You must now perform a number of procedures before you start the Business Objects system. Go to Getting the System Ready on page 221.





chapter

Configuring the ORB



Configuring the ORB


For a general overview of configuration, see Configuration Overview and Scenarios on page 93.

Order of configurationYou must configure the ORB on each node in the cluster. If you installed everything on one server, you must configure it as the primary node.

Where you are now






page 113



- wdeploy page 181




page 265



You configure the parts of your deployment in the following order:1. Primary node.

You must always configure the primary node first, as other nodes need to use its configuration information.

2. Secondary nodes.3. Client nodes, if required.

Client nodes are machines that host web or application servers that are used by the cluster, but do not actively participate in it.

Configuring the ORB with manual configurationEven if you perform manual configuration, you still need to use the Configuration Tool to configure the ORB, as explained in this chapter.For information on manual server configuration, see the Manual Web and Application Server Configuration Guide.

Typical configurationTypical configuration is a largely-automated configuration process that makes use of the Typical wizard within the Configuration Tool. The Typical wizard configures the ORB and deploys the web applications. For instructions, see Typical Configuration on page 127.To use Typical configuration, you must have:• Business Objects server products, the web server, and the application server

on a single machine• IIS or Apache/Tomcat• one IP address• one cluster with one primary node• no external authentication; authentication and authorization performed only

on the repositoryFor single-machine deployments that do not meet all of these conditions, start the ORB configuration procedures that begin in the next section.



Configuring the ORB

Starting the Configuration Tool

REMINDERYou must have certain rights to start the Configuration Tool. See Who can use the Configuration Tool on page 96.

To start the Configuration Tool:1. Do either of the following:

- Select it on the last page of the Installation wizard.The Tool runs in the language you chose for all products during installation. The first page to appear is Configuration Options (go to Step 4).

- Run it from the Windows Start menu or from the command prompt. The Configuration Tool is located in $INSTALLDIR\bin\scripts.

The Language Selection page appears.2. Select the language you want, and then click Next.

You can choose any language installed on your system. This applies to the current session. It has no impact on the language used for your Business Objects products.The Welcome page appears.

3. Click Next.The Configuration Options page appears.



Starting the Configuration Tool

4. Select a type of configuration:- You can choose Typical only if you have a standalone server on a single node. Go to Typical Configuration on page 127.- Otherwise, select Custom, and then click Next.The Cluster Preferences page appears.

5. Accept the default cluster name or enter a new one, and then click Next.You can use only the following characters:- letters: “A-Z” and “a-z”- numbers: “0-9”- dash: “-”- underscore: “_”

The Cluster Management page appears.

On this page, you configure all the nodes in your cluster. You must define the ORB for every node that is part of the cluster or is accessed by it.



Configuring the ORB

Configuring the ORBYou begin ORB configuration with the primary node.

Primary nodeTo configure the primary node:1. On the Cluster Management page, select ORB, select Define ORB from the

drop-down list, and then click Next.The Node page appears.

Because the primary node is central to the operation of your cluster, you must always configure it first. If you have already configured a primary node and want to create either of the other types, go to Secondary or client node on page 120.

2. Make sure the node type is set to Primary.3. Change the IP address or hostname, and first TCP port, if you want. (See

TCP ports on page 96.)- If you are using DHCP, you must enter a hostname.- If you want to check whether a certain number of ports are available, set the Last port for test, and then click Test ports. The “last port” setting is for testing purposes only.

4. Click Next. The Configuration Tool saves the ORB and primary node configuration and displays a confirmation message.



Configuring the ORB

5. Click OK.The Service page appears.

6. Select the services you want, and whether you want them to start automatically when the server is started:- WebIntelligence Service

This defines the Business Objects server as a service.- Universal Drill Through Service (UDS)

This enables WebIntelligence users to drill through between different data sources. The port must be unique and between 12000 and 65000.

- WebIntelligence OLAP Cache ServiceThis optional service improves the response time of OLAP databases having a large number of members on a dimension/level. The port must be unique and between 12000 and 65000.

7. At the bottom of the page, define the account used to start any of these services.The account must have the following rights:- act as part of the operating system- log on as a service



Configuring the ORB

NOTE

When you specify a domain user, be aware that if you change the domain password, you must use the Configuration Tool to change the password on each individual cluster node.

8. Click Next.Configuration Tool configures the services.The Cluster Management page re-appears.

If you want to configure a secondary or client node, continue to the next section.Otherwise, you are now ready to deploy and configure your web applications on the application server. To do this, go to either:• Deploying Web Applications Using Configuration Tool on page 155• Deploying Web Applications Using wdeploy on page 181.To configure cluster storage (highly recommended), go to Setting cluster storage on page 122.If you want to change cluster preferences, go to Changing cluster settings on page 123.

Secondary or client nodeThe primary node must be configured and running when you configure a secondary or client node.The procedure for configuring secondary and client nodes is very similar to that of the primary node. The main differences are:• On the Node page, you select Secondary or Client from the Node Type drop-

down list.• You do not have to set service parameters for client nodes.



Configuring the ORB

To configure a secondary or client node:1. Access the Node page of the Configuration Tool.2. In the Node Type drop-down list, select Secondary or Client.

3. On the Local Node tab, set the IP address or hostname of the local node (the one you are configuring), and the first TCP port that will be used by the local node. (See TCP ports on page 96.)- If you are using DHCP, you must enter a hostname.- If you want to check whether a certain number of ports are available, set the Last port for test, and then click Test ports.

4. On the Primary Node tab, set the IP address or hostname of the primary node of your cluster, as well as the first TCP port used by this primary node.- The IP address or hostname must be the same as the one you used when configuring your primary node. If you are using DHCP, it must be a hostname.- The primary node must be running. Use “Test connection to primary node” to check whether the connection with the primary node is working correctly.

5. Click Next.The ORB and node configuration is saved. If you have configured a secondary node, the Configuration Tool prompts you to set cluster storage.Cluster storage is highly recommended (see next section).

6. Repeat the above process for any other secondary or client nodes you want to configure.



Configuring the ORB

Setting cluster storageWhen you install Business Objects server products, you can choose the server or servers on which you want to store the system’s cached, temporary, and personal documents and files. For performance reasons, it is often a good idea to put application files, temporary files, and personal documents on separate disks or machines. This way, you control where the heavier transaction loads are likely to occur, and avoid bottlenecks before they happen.To set cluster storage:1. At the end of configuring a secondary node, accept the prompt for setting

cluster storage.If you have already configured the nodes, go to Modifying storage and other directories on page 123.

2. In the Storage Directory field, enter or browse for the path to the folder you want to use for cluster storage.You must use a mapped network drive that is shared by the cluster. You cannot use a regular path on a local machine.Business Objects recommends that you use a dedicated machine.

3. Click Finish.The Cluster Management page re-appears.

Where to go nowTo deploy and configure your web applications on the application server and web server, go to either:• Deploying Web Applications Using Configuration Tool on page 155• Deploying Web Applications Using wdeploy on page 181.



Changing cluster settings

Changing cluster settingsAfter you configure the nodes, you can:• modify storage and other directories• modify service parameters• reconfigure the ORB

Modifying storage and other directoriesYou can change the directories that Business Objects uses for storage of certain files or as temporary directories.For the Storage directory, you can:• change the Storage directory that is shared by all nodes in the cluster

You must use a mapped network drive that is shared by the cluster. You cannot use a regular path on a local machine. Business Objects recommends that you use a dedicated machine.

• set a Storage directory that is shared by two primary nodesIn this case, Business Objects recommends that you locate the directory on a third machine and point the two primary nodes to that directory.

To modify directories:1. Open the Cluster Management page of the Configuration Tool.2. Select Cluster Preferences, select Update Cluster Preferences from the

drop-down list, and then click OK.



Configuring the ORB

The Cluster Preferences page appears.

3. Make the changes you want.- Scroll down to see additional directories.- The directory you select must already exist. You cannot create new ones.

4. Click Finish.The Cluster Management page re-appears.



Removing a node

Removing a nodeWhen you remove a node, all configuration and deployment information is deleted.You must remove the node before uninstalling BusinessObjects 6.5. If you are using IIS, stop the IIS Services before removing the node.Removing the node deletes all files located in $INSTALLDIR/nodes/<hostname>/<clustername>/. This includes storage, Administration Console settings, and bomain.key. If you want to keep these settings, back them up before beginning the procedure below.To remove a node:1. Open the Cluster Management page of the Configuration Tool.

2. Highlight the cluster, and then select Delete this cluster from the drop-down list.

3. Click Next, and then click Finish.



Configuring the ORB


chapter

Typical Configuration





This chapter describes configuration using the Typical wizard of the Configuration Tool.For a general overview of configuration, see Configuration Overview and Scenarios on page 93.

What is Typical configuration?Typical configuration is a largely-automated configuration process that makes use of the Typical wizard within the Configuration Tool. It can be used to configure a server as a primary node. It configures the ORB and deploys the web applications on the web server and application server.

Where you are now






page 113



- wdeploy page 181




page 265



To use Typical configuration, you must have:• Business Objects server products, the web server, and the application server

on a single machine• IIS or Apache/Tomcat as application server and web server• no external authentication; authentication and authorization performed only

on the repositoryFor single-machine deployments that do not meet all of these conditions, follow the configuration procedures in Configuring the ORB on page 113.




Starting the Typical wizard

REMINDERYou must have certain rights to start the Configuration Tool. See Who can use the Configuration Tool on page 96.

To start the Typical wizard:1. Start the Configuration Tool by either:

- selecting it on the last page of the Installation wizard.The Tool runs in the language you chose for all products during installation. The first page to appear is Configuration Options (go to Step 4).

- running it from the Windows Start menu or from the command prompt. The Configuration Tool is located in $INSTALLDIR\bin\scripts.The Language Selection page appears.You can select any language installed on your system. This only applies to the current session. It has no impact on the language used for your Business Objects products.

2. Select the language you want, and then click Next.The Welcome page appears.

3. Click Next.The Configuration Options page appears.

4. Select Typical, select Using Active Server Pages or Using Java Server Pages, and then click Next.The Cluster Management page appears.



Starting the Typical wizard

The remainder of the instructions are divided according to the technology you selected:• for ASP technology, go to ASP technology on page 132• for JSP technology, go to JSP technology on page 136When you select ASP, your application server can be deployed in standalone mode only.




ASP technologyNow you configure the ORB and web applications on IIS.1. On the Cluster Preferences page, type a name for the cluster, and then click

Next.The Node page appears.

2. Change the IP address and first TCP port if you want. (See TCP ports on page 96.)If you want to check whether a certain number of ports are available, set the Last port for test, and then click Test ports. The “last port” setting is for testing purposes only.

3. Click Next.The Configuration Tool saves the ORB and primary node configuration and displays a confirmation message.



ASP technology

4. Click OK.The Cluster Management page appears.

The Configuration Tool automatically detects IIS as application server.5. Make sure IIS is selected, and then click Next.

The Configuration Tool configures IIS and displays a confirmation message.6. Click OK.

The Service page appears.




Service parameters allow you to set the Business Objects server to run automatically and as a Windows service.

7. Select the services you want, and whether you want them to start automatically when the server is started:- WebIntelligence Service- Universal Drill Through Service (UDS)

This enables WebIntelligence users to drill through between different data sources. Set the port.

- WebIntelligence OLAP Cache ServiceThis allows users to use the search function within WebIntelligence for OLAP. Set the port.

8. At the bottom of the page, define the account used to start any of these services.The account must have the following rights:- act as part of the operating system- log on as a serviceIf you have not assigned these rights, click Cancel to quit the Configuration Tool, and then use Windows User Manager to assign the rights. You must restart the system for the rights to take effect.

NOTE




ASP technology

9. Click Next.The Configuration Tool completes the configuration, confirms that the service parameters have been set, and displays the Cluster Management page with your current configuration. InfoView, Supervisor over the Web, and the Administration Console (Admin) have been deployed on IIS.

10.Click Finish.You must now perform a number of procedures before you start the Business Objects system. Go to Getting the System Ready on page 221.




JSP technologyNow, you configure the ORB and deploy the web applications on the application server (Tomcat) and web server (Apache).1. On the Cluster Preferences page, type a name for the cluster, and then click

Next.The Node page appears.

2. Change the IP address and first TCP port if you want. (See TCP ports on page 96.)If you want to check whether a certain number of ports are available, set the Last port for test, and then click Test ports. The “last port” setting is for testing purposes only.



JSP technology

3. Click Next. The Configuration Tool saves the ORB and primary node configuration and displays a confirmation message.The Cluster Management page appears.

If the Configuration Tool does not detect Tomcat, select Manual application server detection, and then browse or enter the location of the Tomcat installation folder.Modify the location of the server.xml file, if necessary.




4. Click Next.The Configuration Tool completes the configuration and displays the Cluster Management page with your current configuration.

The Typical wizard automatically detects Apache.5. Modify the following if necessary:

- Location of the configuration files (httpd.conf)- Web site or virtual host



JSP technology

6. Click Next.The Services page appears.

Service parameters allow you to set the Business Objects server to run automatically and as a Windows service.

7. Select the services you want (and whether you want them to start automatically when the server is started):- WebIntelligence Service- Universal Drill Through Service (UDS)

This enables WebIntelligence users to drill through between different data sources. Set the port.

- WebIntelligence OLAP Cache ServiceThis allows users to use the search function within WebIntelligence for OLAP. Set the port.

8. At the bottom of the page, define the account used to start any of these services.The account must have the following rights:- act as part of the operating system- log on as a serviceIf you have not assigned these rights, click Cancel to quit the Configuration Tool, and then use Windows User Manager to assign the rights. You must restart the system for the rights to take effect.




NOTE


9. Click Next.The Configuration Tool completes the configuration, confirms that the service parameters have been set, and displays the Cluster Management page with your current configuration. InfoView, Supervisor over the Web, and the Administration Console (Admin) have been deployed on Apache/Tomcat.

10.Click Finish.You must now perform a number of procedures before you start the Business Objects system. Go to Getting the System Ready on page 221.


chapter

Configuration Tool in Command Line Mode





This chapter describes how to use the Configuration Tool in command-line mode. For Configuration Tool in interactive mode, see Configuring the ORB on page 113.For a general overview of configuration, see Configuration Overview and Scenarios on page 93.

Where you are now






page 113



- wdeploy page 181




page 265



Configuration Tool in command-line mode

Configuration Tool in command-line modeMany companies need to deploy Business Objects products automatically on servers located across their corporate structure. Deployment takes place from a centralized corporate IT service. To facilitate such deployments, the Configuration Tool can be used in command-line (non-interactive) mode.In the current version, only IIS and Apache/Tomcat are supported. For other web and application servers, use the wdeploy tool (see Deploying Web Applications Using wdeploy on page 181).The parameters you can set from the command line allow you to:• display the help• launch the Configuration Tool in command-line mode• specify a parameters file• specify a language• suppress the splash screenIf you use a parameters file, you can specify all the actions available when running the Configuration Tool in interactive mode. The parameters file is a simple text file.To use the Configuration Tool from the command line, open the command prompt and change to the directory where the Configuration Tool executable, configtool.bat, is installed. By default, it is located in $INSTALLDIR\bin\scripts\.In command-line mode, the Configuration Tool uses this syntax: configtool -cmdline <parameter> [value]

Note that [value] is optional and depends on the parameter that precedes it.




ParametersThe following table shows the parameters used from the command line.

Using a parameters text fileA parameters text file gives you the same flexibility as Configuration Tool in interactive mode. You can:• create nodes• modify nodes• add web and application server instances• add and modify ORB parameters• modify cluster preferencesMost of the parameters must be followed by a value, such as a cluster name or IP address. Use uppercase for all parameters. The values they take can be upper or lower case, depending on the parameter.You specify the parameters file from the command line using -cmdfile:configtool -cmdline -cmdfile <filename>

File formatThe parameters file must have the following format:[Section header]

<parameter1>=<value1>

<parameter 2>=<value2> ......

Parameter What it does-cmdline Starts Configuration Tool in command-line mode.

-help Displays the help for the parameters you can use.

-cmdfile <filename> Specifies the name of the text file containing node parameters.

-language <language code>

Specifies the language in which Configuration Tool runs. Use standard ISO format: en, fr, nl, and so on. See Language Codes on page 283.For example, to run Configuration Tool in French:configtool -cmdline -language fr

-nosplash Suppresses the splash screen.

-delete Deletes the current node. You must first stop the cluster.




For example, the following code fragment shows part of the creation of a primary node:[CREATE ORB]

NODE_TYPE=PRIMARY

LOCAL_IPADDR=10.6.128.192

LOCALPORTMIN=1000

Each parameter must be on a line by itself. Blank lines are ignored.

Text file parametersIn the following tables, the parameters are classified by section header.

Section header: [CREATE CLUSTER]

Section header: [UPDATE CLUSTER]

Parameter Value DescriptionCLUSTER_NAME <cluster name> The name of the cluster.





Section header: [CREATE ORB] and [UPDATE ORB]

Section header: [UPDATE SERVICE]

Parameter Value DescriptionNODE_TYPE PRIMARY

SECONDARYCLIENT

Type of node.

LOCAL_IPADDR <IP address> IP address or hostname of the server you want to configure.

LOCAL_PORTMIN <port range start> The start number of the TCP port range to use on the local node.

PRIMARY_IPADDR <IP address> IP address of the primary node if you are configuring a secondary or client node.

PRIMARY_PORTMIN <port range start> The start number of the TCP port range of the primary node if you are configuring a secondary or client node.

Parameter Value DescriptionNODE_SERVICE 0

1Enter a value of 1 to define the WebIntelligence Service in Windows Services.

NODE_AUTOSTART 01

Enter a value of 1 to start the WebIntelligence service automatically when the node is started.

UDS_SERVICE 01

Enter a value of 1 to start the WebIntelligence Universal Drill-Through Service automatically when the node is started.

UDS_SERVICE_AUTOSTART 01

Enter a value of 1 to start the WebIntelligence Universal Drill-Through Service automatically when the node is started.




UDS_SERVICE_PORT <integer between 12000 and 65000>

Port used by the WebIntelligence Universal Drill-Through Service.

OLAP_CACHE_SERVICE 01

Enter a value of 1 to define the WebIntelligence OLAP Cache Service.

OLAP_CACHE_SERVICE_AUTOSTART

01

Enter a value of 1 to start the WebIntelligence OLAP Cache Service automatically when the node is started.

OLAP_CACHE_SERVICE_PORT

<integer between 12000 and 65000>

Port used by the WebIntelligence OLAP Cache Service.

DOMAIN <service domain> Windows domain name. If the node is defined as a service, domain used to authenticate the account that starts the service.

USERNAME <user account> Name of the user account. If the node is defined as a service, account used to start the service.

PASSWORD <password> Password for the user account used to start the service.




Section header: [ADD APPLICATION] and [DELETE APPLICATION]

Section header: [ADD WEB SERVER] and [DELETE WEB SERVER]

Parameter Value DescriptionAPP_TYPE INFOVIEW

ADMINAUDITORSUPERVISORCustomized Applications

Type of application to delete.

APP_NAME <application name> Name of the application you want to delete.



Type of application to deploy on the web server.

APP_NAME <application name> Name of the application you want to add.

WSTYPE APACHE Type of web server.

ASP 01

• 0 to use JSP• 1 to use ASP

WSINSTANCENAME <web server instance> Name of the web server instance.

WSDIRNAME <virtual directory> Name of the virtual directory.

WSINSTALLDIR <directory name> Path to the directory where the web server is installed.




Section header: [ADD APP SERVER] and [DELETE APP SERVER]

CFGFILE_LOC_0 <directory> Directory where the configuration files for the web server are installed. For Apache only.

CFGFILE_NAME_0 <filename> Name of the web server configuration file. For Apache only.

RESFILENAME <filename> Mandatory if APP_TYPE=Customized Applications. Sets the name of the resources file, if applicable.



Type of application to deploy.

APP_NAME <application name> Name of the application to deploy.

ASTYPE TOMCATIIS

Type of application server.

ASINSTANCENAME <application server instance>

Name of the application server instance. For Apache/Tomcat, this is mandatory only if ASSTANDALONE=1.

ASWEBAPPNAME <web application> Web application to deploy.

ASINSTALLDIR <directory name> Path to the directory where the application server is installed.Leave blank if ASTPE = IIS.

CFGFILE_LOC_0 <directory> Directory where the configuration files for the application server are installed. Set only if this is not the default directory.

CFGFILE_NAME_0 <filename> Name of the application server configuration file. Set only if this is not the default.

Parameter Value Description




Section header: [DELETE CLUSTER]

Section header: [UPDATE PREFERENCES]

CFGFILE_LOC_1 <directory> Tomcat only. Directory where the XML files for Tomcat are installed. Set only if this is not the default directory.

CFGFILE_NAME_1 <filename> Tomcat only. Name of the Tomcat XML configuration file. Set only if this is not the default name.

ASSTANDALONE 01

Enter:• 0 if your application server is not

standalone• 1 if your application server is

standalone and also serves as a web server

ASP 01

Applies only if ASTYPE = IIS. Enter:• 0 to use JSP• 1 to use ASP

WARFILENAME <filename> Mandatory if APP_TYPE=Customized Applications. Enter the name of the WAR file to deploy.


Parameter Value DescriptionLOCDATA_DIR <directory> locdata directory

UNIVERSES_DIR <directory> Universe directory

DOCUMENTS_DIR <directory> Document directory

LIBS_DIR <directory> libs directory

USERBQY_DIR <directory> userBQY directory

SHDATA_DIR <directory> shData directory

LOGS_DIR <directory> Logs directory





Examples of parameters filesFollowing are several examples of parameter files.

Creating a new cluster and configuring the ORB

[CREATE CLUSTER]

CLUSTER_NAME=myCluster

[CREATE ORB]

NODE_TYPE= PRIMARY

LOCAL_IPADDR=127.0.0.1

LOCAL_PORTMIN=1100

Add application to cluster and configure application server

[UPDATE CLUSTER]


[ADD APPLICATION]

APP_TYPE=INFOVIEW

APP_NAME=myInfoview

[ADD APP SERVER]

APP_TYPE=INFOVIEW

APP_NAME=myInfoview

ASTYPE=TOMCAT

ASINSTANCENAME= Tomcat-Standalone

ASWEBAPPNAME=wijsp

ASINSTALLDIR=e:\tomcat4.0

CFGFILE_NAME_0=setclasspath.bat (for tomcat if setclasspath elsewhere than its original location)

CFGFILE_LOC_0=<path_to_ CFGFILE_NAME_0>

CFGFILE_NAME_1=config.xml (for Tomcat if config.xml is moved from its original location)

CFGFILE_LOC_1=<path_to_ CFGFILE_NAME_1>

TEMP_DIR <directory> Temporary directory

TEMPLATES_DIR <directory> Templates directory

SCRIPTS_DIR <directory> Scripts directory

STORAGE_DIR <directory> Storage directory. It must be shared by the cluster.

IMAGE_DIR <directory> Image directory





ASSTANDALONE=1

Adding a web server configuration to an existing application

[UPDATE CLUSTER]


[ADD WEB SERVER]

APP_TYPE=INFOVIEW

APP_NAME=myInfoview

WSTYPE=IIS

ASP=0

WSINSTANCENAME=Default Web Site

WSDIRNAME=wijsp

WSINSTALLDIR=

Adding a customized application with an application server configuration

[UPDATE CLUSTER]


[ADD APPLICATION]

APP_TYPE=Customized Applications

APP_NAME=myOther

[ADD APP SERVER]

APP_TYPE=Customized Applications

APP_NAME=myOther

ASTYPE=TOMCAT

ASINSTANCENAME= Tomcat-Standalone

ASWEBAPPNAME=Customized Applications

WARFILENAME=%BOINSTALLDIR%\archives\admin.war

ASINSTALLDIR=e:\tomcat4.0

ASSTANDALONE=1

Deleting an existing application

[UPDATE CLUSTER]


[DELETE APPLICATION]

APP_TYPE=INFOVIEW

APP_NAME=myInfoview




Deleting a web server configuration

[UPDATE CLUSTER]


[DELETE WEB SERVER]

APP_TYPE=INFOVIEW

APP_NAME=myInfoview

WSTYPE=IIS

WSINSTANCENAME=Default Web Site

WSDIRNAME=wijsp

Deleting an application server configuration

[UPDATE CLUSTER]


[DELETE APP SERVER]

APP_TYPE=INFOVIEW

APP_NAME=myInfoview

ASTYPE=TOMCAT

ASINSTANCENAME=Tomcat-Standalone

ASWEBAPPNAME=wijsp

Updating cluster preferences

[UPDATE PREFERENCES]


LOCDATA_DIR=<locdata directory>

UNIVERSES_DIR=<universes directory>

DOCUMENTS_DIR=<documents directory>

LIBS_DIR=<libs directory>

USERBQY_DIR=<userBQY directory>

SHDATA_DIR=<shData directory>

LOGS_DIR=<logs directory>

TEMP_DIR=<temp directory>

TEMPLATES_DIR=<templates directory>

SCRIPTS_DIR=<scripts directory>

STORAGE_DIR=<storage directory>

IMAGE_DIR=<image directory>





chapter

Deploying Web Applications Using Configuration Tool





Now that you’ve defined your cluster and configured its ORB, the next step is deploying the Business Objects web applications on the cluster’s web and application servers, then configuring those servers to work with the applications.This chapter explains how to do this using the Configuration Tool. To use the wdeploy tool, see Deploying Web Applications Using wdeploy on page 181.

NOTE

If you are not using IIS or Apache/Tomcat, you must use wdeploy.

Where you are now






page 113



- wdeploy page 181




page 265



If you want to deploy and configure the web server and application server manually, see the Manual Web and Application Server Configuration guide. You can deploy and configure the following web applications:• InfoView

Allows users to access WebIntelligence and WebIntelligence for OLAP. Every cluster must have this.

• AdminAllows administrators to access the Administration Console. Every cluster must have this.


• BusinessObjects Auditor• Customized applications

Web applications to deploy

❏ InfoView

❏ Administration Console

❏ Supervisor over the Web

❏ Auditor




Deploying the web applicationsHere are the basic steps you need to follow to deploy web applications:1. Go to the Cluster Management page of the Configuration Tool.2. Under the web application, create an instance.

This creates two new branches on the tree: Web Server and Application Server.

3. Deploy and configure the web applications on the application server and web server.

These steps are explained below. The InfoView application is used as an example, but the other web applications are deployed in the same way. The steps below must be repeated for each web application you want to deploy. Only customized applications are different (see Customized web applications on page 168).To deploy and configure a web application on the web server and application server:1. In the Configuration Tool, open the Cluster Management page.

2. Highlight the web application (in this case InfoView), select Create an instance from the drop-down list, and then click Next.The Instance Name page appears.



Deploying the web applications

3. Give the instance a name, and then click Next.The instance and new branches for web server and application server appear on the Cluster Management page.

The instructions are now divided into IIS standalone (continue below), IIS/Tomcat (page 161), and Apache/Tomcat (page 164).

IIS standaloneYou now define the application server to be used with the web applications.1. Under the new instance, highlight Application server, select Add a web

application from the drop-down list, and then click Next.The Configuration Tool automatically detects the application servers. If there is more than one, it displays a list of those available for configuration.




2. In the Automatic Application drop-down list, select IIS, and then click Next.You cannot use manual server detection for IIS.The Configuration Tool detects and displays the available instances.

The default names are:- wijsp for InfoView JSP- wiadmin for Administration Console- wsupervisor for Supervisor over the Web- wiauditor for Auditor

3. Select the server instance you want, and select This application server is standalone.This must be selected because IIS acts both as application and web server.

4. Click Next.Configuration Tool configures the application server and displays the result under the instance.

5. Repeat the above procedure for any other web applications that you want to deploy and configure on the application server.

If you want to deploy and configure customized web applications on an application server, see Customized web applications on page 168.




If you have no other web applications to configure on this machine and have configured all the other nodes:• Click Finish to quit the Configuration Tool.• Go to Getting the System Ready on page 221.

IIS/TomcatFor IIS/Tomcat, you must define both the application server and web server.

Application server1. Under the new instance, highlight Application server, select Add a web


If the Configuration Tool does not detect Tomcat, select Manual application server detection, and then browse or enter the location of the Tomcat installation folder.

2. In the Choose JSP or ASP drop-down list, select JSP.3. In the Automatic Application drop-down list, select Tomcat, and then click

Next.The Location of Configuration Files page appears.

4. Change the directories if you want, and then click Next.The Configuration Tool detects and displays the available instances.




5. Select the server instance and web application you want.The web application is the virtual directory name that is used for the application files, and appears as part of the URL on the client browser. The default names are:- wijsp for InfoView JSP- wiadmin for Administration Console- wsupervisor for Supervisor over the Web- wiauditor for AuditorThe web application name you enter here must be the same as the virtual directory name you enter when deploying and configuring the web server.Do not select Standalone, which is only for IIS in standalone mode.

6. Click Next.The Configuration Tool configures the application server and displays the result under the instance.

7. Repeat the above procedure for any other web applications you want to deploy.




Web serverTo deploy and configure the web server:1. On the Cluster Management page, under the instance, highlight Web server.

2. Select Add virtual directory from the drop-down list, and then click Next.The Configuration Tool automatically detects the web servers. If there is more than one, it displays a list of those available for configuration.If the Configuration Tool does not detect the web servers, select Manual web server detection, and then browse or enter the location of the IIS installation folder.

3. In the Choose JSP or ASP drop-down list, select JSP.4. Select Automatic web server detection, select IIS, and then click Next.

The Location of Configuration Files page appears.5. Make sure the path is correct, and then click Next.

The Configuration Tool detects and displays the available instances.6. Select the website you want and confirm the virtual directory.

- The website you select depends on which port you configured the IIS web server.- The name of the virtual directory you enter here must be the same as the name you entered when configuring Tomcat.

7. Click Next.The Configuration Tool displays your current configuration.


If you want to deploy and configure customized web applications on a web server, see Customized web applications on page 168.




If you have no other products to configure on this machine and have configured all the other nodes:• Click Finish to quit the Configuration Tool.• Go to Getting the System Ready on page 221.

Apache/TomcatFor Apache/Tomcat, you must define both the application server and web server.

Application server1. Under the new instance, highlight Application server, select Add a web



2. In the Choose JSP or ASP drop-down list, select JSP.3. In the Automatic Application drop-down list, select Tomcat, and then click

Next.The Location of Configuration Files page appears.

4. Change the directories if you want, and then click Next.The Application Server Instance page appears.




5. Change the name of the web application, if you want.The web application is the virtual directory name that is used for the application files, and appears as part of the URL on the client browser. The default names are:- wijsp for InfoView JSP- wiadmin for Administration Console- wsupervisor for Supervisor over the Web- wiauditor for AuditorThe web application name you enter here must be the same as the virtual directory name you enter when deploying and configuring the web server.Do not select Standalone, which is only for IIS.






Web serverTo deploy and configure the web server:1. On the Cluster Management page, under the instance, highlight Web server.

2. Select Add virtual directory from the drop-down list, and then click Next.The Configuration Tool automatically detects the web servers. If there is more than one, it displays a list of those available for configuration.If the Configuration Tool does not detect the web servers, select Manual web server detection, and then browse or enter the location of the Apache installation folder.

3. In the Choose JSP or ASP drop-down list, select JSP.4. Select Automatic web server detection, select Apache for Tomcat, and

then click Next.The Location of Configuration Files page appears.

5. Make sure the path is correct, and then click Next.The Configuration Tool detects and displays the available instances.




6. Select the website you want and confirm the virtual directory.- The website you select depends on which port you configured the Apache web server.- The name of the virtual directory you enter here must be the same as the name you entered when configuring Tomcat.

7. Click Next.The Configuration Tool displays your current configuration.


If you want to deploy and configure customized web applications on a web server, see Customized web applications on page 168.If you have no other products to configure on this machine and have configured all the other nodes:• Click Finish to quit the Configuration Tool.• Go to Getting the System Ready on page 221.




Customized web applicationsDeploying and configuring customized web applications on the application server and web server is very similar to the above procedures for InfoView.Instructions are divided into IIS (continue below) and Apache/Tomcat (go to Apache/Tomcat on page 172).

IISTo deploy and configure customized applications with IIS:1. In the Configuration Tool, open the Cluster Management page.

2. Highlight Custom Applications, select Create an instance from the drop-down list, and then click Next.



Customized web applications

3. Give the instance a name, and then click Next.The instance and new branches for application server and web server appear on the Cluster Management page.

You now define IIS as the application server. (You do not have to define it as a web server.)

4. Under the new instance, highlight Application server, select Add a web application from the drop-down list, and then click Next.




The Configuration Tool automatically detects the application servers. If there is more than one, it displays a list of those available for configuration.

5. Select Automatic application server detection, and then click Next.You cannot use manual server detection for IIS.The Configuration Tool detects and displays the available instances.




6. Select the instance, and then provide the following information:- Web application: Type the name of the application.- Standalone: Select this box.- War file: Type or browse for the location of the ASP file you want to distribute.- Resources files: Optional. Type or browse for the location of the resources file.

Resource files contain static mapping and other information needed by the application server’s web server component.


8. Repeat the above procedure for any other customized web applications which you want to deploy and configure on the application server.

9. If you have no other web applications to configure on this machine and have configured all the other nodes:- Click Finish to quit Configuration Tool.- Go to Getting the System Ready on page 221.




Apache/Tomcat

Application server (Tomcat)To deploy and configure customized web applications on the application server:1. In the Configuration Tool, open the Cluster Management page.

2. Highlight Custom Applications, select Create an instance from the drop-down list, and then click Next.




3. Give the instance a name, and then click Next.The instance and new branches for application server and web server appear on the Cluster Management page.

You now define Tomcat as the application server.4. Under the new instance, highlight Application server, select Add a web






5. In the Choose JSP or ASP drop-down list, select JSP.6. In the Automatic Application server detection drop-down list, select Tomcat,

and then click Next.The Location of Configuration Files page appears.


8. Select the instance, and then provide the following information:- Web application: Type the name of the web application.

It must be the same as the virtual directory you entered when configuring your web server.

- Standalone: Do not select this. It is used only with IIS.- War file: Type or browse for the location of the WAR file you want to deploy.

9. Click Next.Configuration Tool configures the application server and displays the result under the instance.

10.Repeat the above procedure for any other customized web applications that you want to deploy and configure on the application server.

Web server (Apache)To deploy and configure customized web applications on the web server:1. In the Configuration Tool, go to the Cluster Management page.

2. Under Custom Applications, highlight Web server, select Add virtual directory from the drop-down list, and then click Next.




The Configuration Tool automatically detects the web servers. If there is more than one, it displays a list of those available for configuration.

If the Configuration Tool does not detect the web servers, select Manual web server detection, and then browse or enter the location of the Apache installation folder.

3. In the Choose JSP or ASP drop-down list, select JSP.4. Select Automatic web server detection, select Apache for Tomcat, and

then click Next.The Location of Configuration Files page appears.


6. Select the instance, and then provide the following information:- Virtual directory: Type the name of the application.

It must be the same as the virtual directory you entered when configuring your web server.

- Resources file: Type or browse for the path to the ZIP file for your customized application.




7. Click Next.The Configuration Tool configures the web server and displays the result under the instance.

8. Repeat the above procedure for any other customized web applications that you want to deploy and configure on a web server.

9. If you have no other products to configure on this machine and have configured all the other nodes:- Click Finish to quit the Configuration Tool.- Go to Getting the System Ready on page 221.



Removing a web application instance

Removing a web application instanceTo remove an instance:1. In the Configuration Tool, open the Cluster Management page.

2. Highlight the instance you want to remove.3. In the drop-down list, select Delete this instance, and then click Next.

The instance and its associated files are removed from both the web and application servers where they were deployed.

4. Click Finish.




Modifying or removing an application serverTo modify or remove a web application from an application server, or to change the application server on which it’s deployed:1. In the Configuration Tool, open the Cluster Management page.

2. Highlight the application server you want to remove or modify.3. In the drop-down list, select one of the following:

- Delete this web applicationAll information, web pages, and files will be removed from the application server.

- Update this web applicationYou will follow the same procedure as in Application server (Tomcat) on page 172. Each page, however, shows current configuration information.

4. Click Next, and then Finish.



Modifying or removing a web server

Modifying or removing a web serverTo modify or remove a web application from an web server, or to change the web server on which it’s deployed:1. In the Configuration Tool, open the Cluster Management page.

2. Highlight the web server you want to modify or remove.3. In the drop-down list, select one of the following:

- Delete this virtual directoryAll information, web pages, and files will be removed from the web server.

- Update this virtual directoryYou will follow the same procedure as in Web server (Apache) on page 174. Each page, however, shows current configuration information.

4. Click Next, and then Finish.





chapter

Deploying Web Applications Using wdeploy





If you’re using IIS or Apache/Tomcat, you can deploy the web applications automatically with the Configuration Tool (see Deploying Web Applications Using Configuration Tool on page 155). If you’re using any other application and/or web servers, however, you must either use wdeploy, or deploy the applications’ resource files manually.This chapter explains how to deploy and configure Business Objects web applications on the application server and web server using the wdeploy tool.

Where you are now






page 113



- wdeployAfterward, complete any additional manual steps described in the Manual Web and Application Server Configuration for Windows guide.

page 181




page 265



This chapter includes:• What is wdeploy?• Wdeploy deployment modes• How do you use wdeploy?• Using wdeploy on application server machines• Using wdeploy on web server machines• Properties reference• Targets reference• Deploying a customized application• Using unsupported web or application servers• Issues requiring additional procedures• Making sure your web applications workBusiness Objects also recommends you look at The wdeploy readme.doc file on page 191.

NOTE

Depending on the type of application server you’re using, you may need to perform additional steps manually after using wdeploy. These steps are displayed on screen when wdeploy completes the deployment; full instructions are available in the Manual Web and Application Server Configuration for Windows guide.




What is wdeploy?wdeploy is a command-line tool that you can use to deploy and/or undeploy Business Objects web applications on web and application servers in JSP environments. wdeploy is installed automatically in the $INSTALLDIR\deployment directory whenever you install the Configuration Tool on a server machine. wdeploy was developed with ANT technology. ANT is a Java- and XML-based build tool from Apache that uses XML as its scripting language. Because ANT is Java based, its scripts are cross-platform.You can find more information about ANT at:

http://ant.apache.org/index.html

The wdeploy command lineThe wdeploy command line contains three types of parameters:

wdeploy <web/application server type> <properties> <target>

All these parameters are described in more detail later on in this chapter.

Parameter Description

<web/application server type>

• If you’re running wdeploy on an application server, this must be a type of application server.

• If you’re running wdeploy on a web server, this must be a type of web server.

<properties> A specific property you set for a specific action

<target> The specific action you want wdeploy to take


http://ant.apache.org/index.html


What is wdeploy?

Specifically, what can wdeploy do?wdeploy does exactly what the Configuration Tool does for Apache/Tomcat configurations. It can do any or all of the following:• regenerate the pre-packaged WAR files for Business Objects web

applications to include elements that are specific to a cluster and/or an application serverIf you want, you can then deploy the WAR file manually on the application server.

• add static resources to the WAR file, so that you can deploy your application server in standalone mode

• deploy one or all web applications on the web and/or application servers• remove one or all web applications from an application or web server

Conditions of useTo use wdeploy to deploy Business Objects web applications on certain types of application servers, an administration instance of the application server must be started. For information, see the documentation for your application server.




Wdeploy deployment modesYou use wdeploy to deploy web applications in either standalone or distributed mode.

Standalone modeYou can configure some application servers to function as both an application server and a web server. The deployment contains no web server. This is known as standalone mode:

Figure 10-1 Standalone web deployment, with no separate web server

When web applications are deployed using wdeploy, both their static and dynamic resources are bundled in the applications’ WAR files and deployed on the application server.This makes deployment simpler, but performance may suffer, as every type of transaction, even those requiring static content only, must pass through the application server.

How to deploy in standalone modeTo deploy a web application in standalone mode on the application server, simply run wdeploy on the application server machine. For instructions, see page 192.

Distributed modeThe application server can also run in conjunction with a separate web server, in distributed mode. The web and application servers can be hosted either on the same server, or on separate ones:


Business ObjectsApplication server

Web application’sdynamic and

Users

serverin standalone mode

static resources



Wdeploy deployment modes

Figure 10-2 Distributed web deployment with web and application server on same machine

Figure 10-3 Distributed web deployment with web and application servers on different machines

In distributed deployments, web applications’ dynamic resources are deployed on the application server, and their static resources are deployed on the web server.This may enhance performance because the web server can serve up static pages without having to communicate with the application server.


Business Objects

application serverUsers

server

in distributed mode

Web server +

Web application’sdynamic resources onapplication server,static resources onweb server


Business ObjectsApplication server

Web application’sdynamic resources

Users

serverin distributed modeWeb server

Web application’sstatic resources




How to deploy in distributed modeRegardless of where your web and application servers are located, to deploy a web application in distributed mode:1. Run wdeploy on the application server machine (see page 192). You must

make sure that the as.mode property is set to “distributed”, either in the command line, or in the config.properties file.

2. Run wdeploy on the web server machine (see page 196).



How do you use wdeploy?

How do you use wdeploy?You can use wdeploy in either of two ways:• Using the command line only• By manually modifying config.properties, the configuration file in which

wdeploy settings are savedWhen wdeploy is run, it interrogates the config.properties file settings, then changes the values in the config.properties file with any property values included in the command line.

Using the command line onlyYou can define all the settings and actions for the deployment of your web applications, then execute those actions using the wdeploy command line only. wdeploy automatically provides you with the parameters you need to set.1. Open a DOS window by clicking Start > Programs > Accessories >

Command Prompt.2. Navigate to the wdeploy folder by typing:

cd $INSTALLDIR\deployment

3. Type the most basic wdeploy command line, containing the type of application or web server and target only. Here’s an example to deploy a web application on a WebLogic 7 application server:

wdeploy weblogic 7 deploy

4. Wait a few seconds.wdeploy displays the complete command line with all the properties required for that application server and target.

5. 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.

6. When you’re done, press OK.




Modifying the config.properties fileWhen the Configuration Tool is installed on a machine, this file is installed in the $INSTALLDIR\deployment folder. It contains all the properties you can set using wdeploy, and lists the required properties for each type of application and web server in separate sections:

This simplifies the use of the command line by eliminating the need to include multiple lines of property settings, and reduces the risk of error.1. Open the $INSTALLDIR\deployment\config.properties file in a standard text

editor.2. At the top of the file, in the sections containing generic parameters which do

not pertain to specific web or application servers, type in valid values for each required setting following the commented instructions. These lines do not begin with a double pound sign (##).



How do you use wdeploy?

The bo.domain and webapp.lang parameters have default values. You can change them if you want.Make sure there are no extra spaces before or after the property value. For example, if you define the as.mode parameter as standalone, leaving a space at the end, the system will not interpret the value correctly.

3. In the section pertaining to the specific web or application server you’re using, delete the double pound signs from the beginning of each parameter line, then type in valid values.

4. When you’re done, save your changes then close the file.5. Now open a DOS window by clicking Start > Programs > Accessories >

Command Prompt.6. Navigate to the wdeploy folder by typing:


7. Type the most basic wdeploy command line, containing the type of application or web server and target only. Here’s an example to deploy a web application on a WebLogic 7 application server:

wdeploy weblogic 7 deploy

8. Press OK.

NOTE

You can override the properties in the config.properties file by using the -Dproperties.file property to define another configuration file.

The wdeploy readme.doc fileThe wdeploy tool comes with an invaluable readme file designed to help you use wdeploy. Located in the $INSTALLDIR\deployment folder, wdeploy readme.doc contains:• an overview of the tool• a description of each target• the required properties for specific web and application servers• a host of sample command linesBusiness Objects recommends you have this file on hand when you are using wdeploy.




Using wdeploy on application server machinesBefore you run wdeploy on the application server machine, make sure you have enough disk space for the deployment of the web applications. The application requiring the most space is InfoView (wijsp):• In a standalone application server deployment, the WAR file containing its

compressed dynamic and static resources takes up 1.4 GB; uncompressed in the temporary directory on the application server, it takes approximatively 4 GB.

• In a distributed application server deployment, the wijsp.war file containing the application’s dynamic resources takes up 23 MB, and the temporary directory requires 78 MB.

Running wdeployTo run wdeploy, type the following at the command prompt:cd $INSTALLDIR\deployment

wdeploy <application server type> [<-Dproperty>=<value>]* <target>

in which the * represents potential additional property definitions.For example:cd $INSTALLDIR\deployment

wdeploy tomcat406 -DAPP=infoview -Das.dir=d:\Tomcat4.0.6 -Das.instance=Tomcat-BO -Das.port=8009 -Djsp.app.name=wijsp -Dwork.dir=d:\tmp\wdeploy -Das.mode=distributed -Dws.type=apache "-Dws.dir=d:\Apache2\Apache2" deploy

NOTE

See the wdeploy readme.doc file for more example command lines.



Using wdeploy on application server machines

In this command line:

Parameter Short name Description<application server type>

Application Server The type of application server you’re using. See the following section.

-D<property>=<value>

Property Various properties specific to your deployment. For complete information, see page 198.

<target> Target Action to be taken. Possible targets are:• buildwar• buildwars• clean• deploy• deployall• help• undeploy• undeployallFor complete information, see page 202.




The Application Server parameterYou can specify any of three types of application server:

Possible values DescriptionGeneric You can use generic with the buildwar and buildwars

targets only. If you use generic, wdeploy creates a generic WAR file that is not designed for a specific application server. You use this value only if you want to use an unsupported application server that you haven’t yet added to your deployment (see page 212).Depending on the type of application server you’re using, additional manual procedures may be required before actually deploying the WAR. See Issues requiring additional procedures on page 215.

<supported application server>

You can indicate a specific application server, such as websphere5, that is currently supported by Business Objects.When wdeploy is installed in the $INSTALLDIR\deployment folder, it comes with a separate XML file for each application server officially supported with this release. The value you enter for the Application Server parameter must exactly match the name of the XML file corresponding to your application server. If it is not an exact match, wdeploy will not be able to find the XML file.Business Objects suggests you browse the $INSTALLDIR\deployment folder for the precise name of the file used for your application server.For a full list of currently supported application servers, see the PAR (Product Availability Report):1. Go to www.techsupport.businessobjects.com2. Log into the site.3. Click Enterprise 6 > PAR > BI Platform 6.Note regarding WebSphere:If you’re using a WebSphere 5.0.2 application server, you cannot run wdeploy if WebSphere security is enabled.

<new application server>

You can also add new application servers that are not supported by Business Objects.To do this, you will need to add a new XML file corresponding to the type and version of the new application server before deploying any web applications. For instructions, see page 212.



Using wdeploy on application server machines

Properties you must setIf your application server is running in distributed mode, you must specify this by setting the as.mode property to “distributed”.If the web server is on the same machine as the 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. (If the web server is on a different machine than the application server, you needn’t define these properties.)

Additional required propertiesYou may also be required to set other properties pertaining to either the target or the type of application server you’re using:• Each property is described in detail starting on page 198.• The properties required with each target are described in Targets reference

on page 202.• The properties required for specific application servers are described in the

following files, all located in the $INSTALLDIR\deployment directory:- the config.properties file - the XML files for each application server- the wdeploy readme.doc file

After running wdeployAfter deploying your web applications on the application server using wdeploy, you must restart the application server to take the modifications into account.Depending on the type and version of the application server you’re using, you may also have to complete some manual procedures to complete configuration. For instructions, see the section on your application server in the Manual Web and Application Server Configuration for Windows guide.If you are using a WebLogic 7 application server, you will also need to carry out an additional step. See page 216.




Using wdeploy on web server machinesWhen you run wdeploy on a machine hosting a web server, you use the following syntax:


wdeploy webservers\<web server type> [-D<property>=<value>]* <target>

in which the * represents potential additional property definitions.For example:cd $INSTALLDIR\deployment

wdeploy webservers\apache -Dbo.domain=mars -Djsp.stat.file=ivres.zip -Djsp.app.name=wijsp -Dws.dir=\tmp\webserver -Das.type=tomcat406 deploy

NOTE

See the wdeploy readme.doc file for more example command lines.

In this command line:

Parameter Short name Description<web server type> Web Server The type of web server you’re using. See

the following section.

-D<property>=<value> Property Various properties specific to your deployment. For complete information, see page 198.

<target> Target Action to be taken. Possible targets are:• deploy• undeployFor complete information, see page 202.



Using wdeploy on web server machines

The Web Server parameterWhen wdeploy is installed in the $INSTALLDIR\deployment folder, it also installs a separate XML file for each supported web server in a subfolder called webservers. The value you enter for the Web Server parameter must exactly match the name of the XML file corresponding to your web server.BusinessObjects suggests you browse through the available XML files in the webservers folder before defining this parameter.

NOTE

IHS web servers use the same XML file as Apache, and are configured in exactly the same way.

Using unsupported web serversIf you’re using an unsupported web server with your deployment, you’ll need to add a new XML file to the $INSTALLDIR\deployment\webservers folder corresponding to the new web server before deploying your web applications. For instructions, see page 212.

Required propertiesYou may also be required to set other properties pertaining to either the target or the type of web server you’re using:• Each property is described in detail starting on page 198.• The properties required with each target are described in Targets reference

on page 202.• The properties required for specific web servers are described in the following

files:- the config.properties file ($INSTALLDIR\deployment)- the XML files for each web server ($INSTALLDIR\deployment\webservers)- the wdeploy readme.doc file ($INSTALLDIR\deployment)

After running wdeployAfter deploying your web applications on the web server using wdeploy, you must restart the web server to take the modifications into account.




Properties referenceThis parameter defines properties that are specific to your deployment. You prefix each property with -D. For example:

-DAPP=infoview

The Properties parameter modifies and adds values to the default config.properties file, which contains the specific configuration information pertaining to a cluster’s web applications, web server and application server. The following table lists the available properties for wdeploy. To define any of these properties, you must type, without spaces:-D<value from Property column>=<value from Values column>

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.

Property Values DescriptionAPP • infoview

• admin• auditor• <custom_app>

Type of web application, taken from the name of the <APP>.properties file located in the application server machine’s $INSTALLDIR\deployment\apps folder.For information on deploying customized web applications, see page 210.

archive.dir $INSTALLDIR\archives

The directory in which the prepackaged WAR files are located.

as.admin.password

<password> Password for administration of the application server. Only needed for certain application servers.

as.admin.port <port number> The port for administration of the application server. Only needed for certain application servers.

as.admin.username

<user name> User name for administration of the application server. Only needed for certain application servers.

as.dir <directory> Installation directory of the application server.



Properties reference

as.host <host_name> Host name for the application server. For any application server but WebSphere 4, enter the long name, such as myserver.product.businessobjects.com. For WebSphere 4, use the short name, such as myserver.

as.instance <instance name> The name of the application server instance on which you’re deploying the web application(s).

as.mode • standalone• distributed

Type of application server deployment. If you enter “distributed” you must also enter information concerning the web server. In this case, you must at least specify the type of web server, using the ws.type property. More information about the web server may be required depending on the type of server being used.Mandatory on the application server.

as.port <port_number> Port number used by the application server. Only needed for certain application servers.

as.trace • <any value>• <no value>

If any value is entered, sets up a trace on application server activity. If no value is entered, the trace is not activated.

as.type N/A Type of application server. This value can match that used for the Application Server parameter.Mandatory for configurations with Apache web servers.

bo.domain <cluster_name> Name of the cluster. The bo.domain cluster must be configured on the node from which you run wdeploy. You do this either by configuring the ORB using Configuration Tool, or by making sure that a <bo.domain>.cfg file is present on the node.Mandatory when using the buildwar, buildwars, deploy or deployall target.If you don’t enter a value: “mycluster” is used. This is the default used by the Configuration Tool when you create a cluster.

Property Values Description




jsp.app.name <web application name>

Name of the web application you’re deploying, as it will appear in the URL used to access it.If you don’t enter a value: wdeploy uses:• wijsp for InfoView• wiadmin for the Administration Console• wsupervisor for Supervisor over the Web• auditor for Auditor

prop <name of property> Overrides a particular value in the default config.properties file.

properties.file <file_name> Overrides the default config.properties file entirely by using a different properties file. Use this when you want to use a file with many different values than those set in the config.properties file.

webapp.lang <language_code> Default language of the web application. Chinese uses five characters; for example, zh_CN.If you don’t enter a value: “en” (English) is used.

work.dir <directory> Directory into which the created WAR files are placed.

ws.dir <directory> Installation directory of the web server.

ws.host <host_name> Host name for the web server. Enter the long name, such as myserver.product.businessobjects.com.Mandatory for deploying the Administration Console with the deploy target.




Properties reference

ws.instance <instance name> The name of the web server instance on which you’re deploying the web application(s).

ws.port <port_number> Port number used by the web server. This information is saved in the clustermanager.cfg file, which contains the URL for the Administration Console servlet. Mandatory for deploying the Administration Console with the deploy target.

ws.type N/A Type of web server. Use this property to deploy the web application(s) on both the web and application servers (distributed mode). In this case, the static pages will be on the web server, and dynamic resources on the application server.





Targets referenceThe Target parameter defines wdeploy’s action, which is a sequence of actions described in an XML file. Here’s a summary of these actions, each one of which is covered in more detail below:

Certain targets must be accompanied by specific properties. When this is the case, it is mentioned in the sections below.

buildwar and buildwarsbuildwar creates a WAR file for a specific web application. buildwars creates WAR files for all the installed web applications. Generated WAR files are stored in the directory designated by the work.dir property.

When should you use buildwar and buildwars?Use buildwar or buildwars when you want to actually deploy your web applications manually on the application and/or web servers. This allows you to keep tighter control over all changes on the servers.

Target Actiondeploy Deploy a specific web application on the application and/or web servers.

deployall Deploy all available web applications on the application and/or web servers.

buildwar Create a WAR file for a specific web application, so that you can then deploy it on the application server manually.

buildwars Create WAR files for all available web applications (InfoView, Admin, Supervisor over the Web, and Auditor), so that you can then deploy them on the application server manually.

undeploy Remove the deployment of a specific web application on a given application or web server.

undeployall Remove the deployment of all deployed applications on a given application or web server.

clean Delete the contents of the default directory where the new WAR files are stored once they are no longer needed.

help Provide a list of supported application servers and available web applications. It also explains their use.



Targets reference

Keep in mind that you must deploy Auditor in a different cluster than the other web applications. For this reason, you may not want to use buildwars, which will automatically build a WAR file for Auditor, InfoView, Supervisor over the Web, the Administration Console and any other available applications, all adapted to the same application server and the same cluster.Depending on the application server you’re using, you may need to perform some manual procedures before actually deploying the WAR file(s) on the application server. See Issues requiring additional procedures on page 215.

Parameters to use with buildwar and buildwars

Application Server

Brief description Required?

Application Server parameter

Type of application server. Yes: you can use either “generic” or the specific type of application server.

Properties Brief description Required?APP Name of the web application. Yes, for buildwar.

archive.dir Directory in which the prepackaged WAR files are located, if the directory is not the default $INSTALLDIR\archives.

No.

as.host Name of application server host. No.

as.mode Application server deployment mode: standalone or distributed.

Yes.

as.port Port number used by application server.

No.

bo.domain Name of the cluster. Yes.

jsp.app.name Name of the web application. No.

properties.file Customized properties file to override properties.config file.

No.

webapp.lang Default language of the web application.

If the web application’s language is not English.

work.dir Directory where the generated WAR files are stored.

Yes.




ws.dir Web server installation directory. Yes, if you’re using wdeploy on an application server machine and as.mode is distributed.

ws.host Name of the machine on which the web server is running.

Yes, if you’re deploying the Administration Console.

ws.port Number of the port used by the web server.

Yes, if you’re deploying the Administration Console.

ws.type Type of web server. Yes, if you’re using wdeploy on an application server machine and as.mode is distributed.

Properties Brief description Required?



Targets reference

cleanThe clean property deletes the generated WAR files from the folder on the application server where they are stored (by default, this folder is defined by the work.dir property).

When should you use clean?Use clean once you’ve successfully deployed your web applications, and are therefore sure you have no more need of the generated WAR files stored in this directory. By cleaning out this folder you are freeing space for other uses.

Parameters to use with cleanWith this target, you must set the work.dir property, which defines the directory containing the generated WAR files to be deployed.

deploy and deployallIf you run wdeploy on an application server machine, it creates the WAR file for a specified web application, then deploys it on the application server. To allow for a subsequent undeployment, the deployment parameters are saved in $INSTALLDIR\nodes\<machine name>\<cluster name>\config\servers\<name of application server>\<name of application server instance>.If you run deploy on the web server machine, it deploys the static resources for a specified web application on the web server, then configures the required virtual directories and redirections to allow the web server to work with those resources.deployall does this for all available web applications.

When should you use deploy and deployall?Use deploy when you want wdeploy to take care of the whole deployment process for a specific web application, from generating its WAR file, to deploying its resources on the application and web servers. • If you’re running in standalone mode, or the web server is running on the

application server machine, running wdeploy on the application server will also deploy the application’s static resources and perform the configuration required for the servers to work correctly with the web application.

• If your web server is running on a separate machine, however, you will need to run wdeploy with the deploy target on the web server as well.




deployall is a good solution when you want to get your system up and running quickly for testing or demo purposes.As deployall deploys all installed web applications, however, Business Objects recommends that you not install Auditor on the same cluster nodes as InfoView. Auditor should be installed and deployed in a separate cluster, with its own repository.



Targets reference

Parameters to use with deploy and deployall

Brief description Required?Application Server parameter or Web Server parameter

Type of application or web server. The specific type of web or application server is required; you cannot use “generic”.

Properties Brief description Required?APP Name of web application to be

deployed.Yes, with the deploy target.

archive.dir Directory in which the prepackaged WAR files are located, if the directory is not the default $INSTALLDIR\archives.

No.

as.dir Application server installation directory.

Yes.

as.host Name of application server host. No.

as.mode Application server deployment mode: standalone or distributed.

Yes.

as.port Port number used by application server.

No.

bo.domain The name of the cluster. Yes.

jsp.app.name The name of the web application. No.

properties.file Customized properties file to override properties.config file.

No.

webapp.lang Default language of the web application.

If the web application’s language is not English.

work.dir Target directory where WAR files to be deployed are stored.

Yes.

ws.dir Web server installation directory. If you’re using wdeploy on an application server machine which also hosts the web server, and as.mode is distributed.




undeploy and undeployallThe undeploy target removes the deployment of a web application from the machine on which you’re running wdeploy. On the web server machine, it also reverses the configuration modifications in the web server’s configuration file (for example, httpd.conf on Apache).The undeployall target removes all the web applications from the machine on which you’re running it.

When should you use undeploy and undeployall?Use undeploy when you want to remove a specific web application but not necessarily others.For example, if you used deployall to get all the web applications up and running quickly, you may want to use undeploy to remove Auditor from your deployment, then deploy it according to Business Objects recommendations, in a separate cluster/repository.You may also want, for example, to remove a customized application in order to replace it afterward with an updated version.Use undeployall when you want to remove all your deployed web applications from your BusinessObjects 6.5 deployment. This may be the case, for example, if you change the application and/or web server you use with your deployment.

Parameters to use with undeploy and undeployall

ws.host Name of the web server’s host machine.

If you’re deploying the Administration Console.

ws.port Port number used by the web server. If you’re deploying the Administration Console.

ws.type Type of web server. If you’re using wdeploy on an application server machine and as.mode is distributed.

Properties Brief description Required?

Server Brief description Required?Application Server parameter or Web Server parameter

Specific type of application or web server. Yes.



Targets reference

helpThe help target provides a list of supported application servers and available web applications, and explains wdeploy parameters.To launch help, type:cd $INSTALLDIR\deployment

wdeploy help

Properties Brief description Required?as.instance The name of the application server

instance on which the web application(s) is/are deployed.

Yes, on an application server machine.

bo.domain Name of the Business Objects cluster. Yes.

jsp.app.name Name of the web application you deployed, as it appears in the URL used to access it.

Yes, for undeploy.




Deploying a customized applicationTo make a customized application available for deployment using wdeploy, you must create for it:• a PROPERTIES file• a “pre-packaged” WAR file (that will be used to generate the final WAR file

that will be deployed on the application server)• a ZIP file containing the application’s static pages, if it requires them• an XML file if the application requires specific processing at deployment timeIt doesn’t matter what you name these files, as long as they are correctly referenced using wdeploy properties. Business Objects recommends, however, that for simplicity’s sake you use the same, meaningful root name for all of these files.

Creating the PROPERTIES fileThe simplest way to create a PROPERTIES file for your new web application is to copy and rename the infoview.properties file:1. Copy the infoview.properties file located in $INSTALLDIR\deployments\apps.

Keep the copied file in the same folder.2. Rename the file.

Use the type of the new web application.3. Open the new properties file in a text editor.4. Make the following changes in the new file:

- Change the name of the WAR file, by default infoview.war, to the name you want for the customized application:jsp.dyna.file=<name of WAR file>.war

- Change the name of the ZIP file, by default ivres.zip, to the name you want for your customized application:jsp.stat.file=<name of ZIP file>.zip

- Change the name of the web application when it is deployed to the name you want for your application. By default it is “wijsp”:jsp.app.name=<name of web application when deployed>

- Change the name of the build file (used by ANT) to the name you want for the new application. The default is infoview.xml:buildfile=<name of new web application>.xml

5. Save and close the file.



Deploying a customized application

Creating the initial WAR fileIn order to build a deployable WAR file, wdeploy requires an initial WAR file containing the application’s dynamic resources.You must create then assemble the application’s components in the development environment, then generate the application’s initial WAR file using either an ANT script or the JAR utility included in Java 2 SDK.Once you have the file, copy it to the $INSTALLDIR\archives directory on the application server machine.For complete instructions, see the information concerning JSP applications in Deploying Web Applications, available from the Developer Suite documentation site:1. Go to www.techsupport.businessobjects.com.2. Log into the site.3. Click Enterprise 6 > Developer suite.

Creating the ZIP fileIf your application uses static pages, you must compress them in a ZIP file, then copy the file to the folder containing the resource files for the standard BusinessObjects web applications. By default, it is the $INSTALLDIR\archives folder.

Creating the XML fileIf your customized application requires specific processing at deployment time, you must additionally create an XML file containing the actions required to perform this processing.When you’re done, save the file in the $INSTALLDIR\deployment\apps directory on the application server machine.




Using unsupported web or application serversYou can add an application and/or web server to your deployment which is not formally supported by Business Objects for this release. Understand, however, that unsupported web and application servers have not been tested by Business Objects, and therefore, the company cannot be held responsible for any resulting problems you may encounter.For a full list of currently supported application servers, see the PAR (Product Availability Report):1. Go to www.techsupport.businessobjects.com.2. Log into the site.3. Click Enterprise 6 > PAR > BI Platform 6.

Adding an unsupported application serverFor each application server used in a Business Objects deployment, a specific, customized XML file must exist in the $INSTALLDIR\deployment folder on the server. The simplest way to create this for the new application server is to copy and rename the existing generic.xml file:1. Copy the generic.xml file in the $INSTALLDIR\deployment folder.

Keep the copied file in the same folder.2. Rename the file to reflect the name and version of the new application server.3. Open the new XML file in an XML editor (recommended) or a text editor.4. Add the following target parameters (see below for syntax):

- help- buildwar- deployapp- undeployapp

5. Make any other changes that are required by your new application server.6. Save and close the file.



Using unsupported web or application servers

Syntax for target parametersFollowing is the syntax to use for adding the target parameters, where “newappserver” is the name of the new application server you are adding:

help<target name=“help” >

<echo>Create war files for newappserver</echo>

</target>

buildwar<target name=“buildwar”

description=“Create distribution for newappserver”>

deployapp<target name=“deployapp”

description=“Deploy application in newappserver”>

undeployapp<target name=“undeployapp”

description=“Undeploy application from newappserver”>




Adding an unsupported web serverFor each web server used in a Business Objects deployment, a specific, customized XML file must exist in the $INSTALLDIR\deployment\webservers folder on the server.The simplest way to create this for the new application server is to copy and rename an existing web server XML file:1. Copy an existing XML file for a supported web server in the

$INSTALLDIR\deployment\webservers folder.Keep the copied file in the same folder.

2. Rename the file, using the name of the new web server.3. Open the new XML file in an XML editor (recommended) or a text editor.4. Add the following target parameters (see below for syntax):

- help- deployapp- undeployapp

5. Make any other changes required by the new web server.6. Save and close the file.

Syntax for target parametersFollowing is the syntax to use for adding the target parameters, where “newwebserver” is the name of the new web server you’re adding:

help<target name=“help” >

<echo>Deploy app on newwebserver</echo>

</target>

deployapp<target name=“deployapp”

description=“Deploy application on newwebserver”>

undeployapp<target name=“undeployapp”

description=“Undeploy application from newwebserver”>



Issues requiring additional procedures

Issues requiring additional proceduresWhen deploying web applications using wdeploy, depending on the application server you’re using, you may encounter certain problems requiring additional manual “tweaks”. For more detailed instructions, see Manual Web and Application Server Configuration for Windows.

ORB incompatibilityThe ORB provided by Business Objects (Orbix from Iona) may not be compatible with the ORB provided by the application server. Should you encounter this type of conflict, you must overload the ORB used by the application server to make it use the ORB Business Objects uses.

Security problemsThe BusinessObjects 6.5 Java code that runs within the application server communicates through CORBA with processes outside the application server. The same code also accesses the disk to store temporary information and read information from property files.BusinessObjects 6.5 may not function if the application server security settings are too high. In this case try to lower the security level of the application server. The exact procedures depend on the application server you are using, so refer to your application server documentation for more information.




Incompatibility of XML processing classesThe version of the XML parser delivered with Business Objects may differ from the one delivered with the JDK used by the application server.To resolve this, override the JDK’s XML processing classes and replace them with those that Business Objects uses, by doing the following:1. Copy the following files in the $INSTALLDIR\classes folder:

- xalan.jar- xercesImpl.jar- xml-apis.jar

2. Paste them in the <APP_SERVER_JDK_HOME>\lib\endorsed folder.3. Create the following new folder:

<APP_SERVER_JDK_HOME>\jre\lib\endorsed4. Copy the contents of <APP_SERVER_JDK_HOME>\lib\endorsed to

<APP_SERVER_JDK_HOME>\jre\lib\endorsed.

If you’re using a WebLogic 7 application serverOnce you have deployed your web applications:1. Make sure the WebLogic server is stopped.2. Create an environment variable called PRE_CLASSPATH, with the same

value as the work.dir property:- Click Start > Settings > Control Panel > System.- In the Advanced tab, click Environment Variables. The Environment Variables dialog box opens.- Under System variables, click the New button.The New System Variable dialog box opens.- For Variable Name, type PRE_CLASSPATH; for Variable Value, type the name of the directory designated by the work.dir property.- Click OK.

3. Add this variable to the CLASSPATH environment variable.4. Start WebLogic in this environment.

If you’ve deployed an application on WebSphere 4 After deploying a web application on WebSphere 4 application server, you must to perform a manual step to regenerate the config-cf.xml file that goes with WebSphere.To do so, open the WebSphere Administration Console, select the WebSphere node in the lefthand panel, then click Regen Websphere Plugin.



Making sure your web applications work

Making sure your web applications workThe simplest way to verify whether you have deployed your web application correctly

is to:

1. Open an Internet browser.2. Type in the URL for the application, replacing the properties in brackets with

the application’s property values:http://<ws.host>:<ws.port>/<jsp.app.name>

3. Hit Return.If your application opens in the browser, you have succeeded.

NOTE

Make sure you have restarted your application and/or web servers beforehand, in order to take all wdeploy modifications into account.




Where to go nowWhen you finish your configuration using wdeploy, go to Getting the System Ready on page 221.


part

Before You Start the System



chapter

Getting the System Ready





This chapter describes what you need to do to get the Business Objects system ready, before you set user authentication and authorization.

Where you are now






page 113



- wdeploy page 181




page 265



Before starting the system

Before starting the systemThis section explains the steps you perform before you start the Business Objects system.

Data accessMake sure the connectivities to all the databases used in the system, for both the repository and corporate data, are installed and have been checked. Connectivity environment variables must be correctly set.See the Data Access Guide for more information.

Repositories and usersUsing Supervisor, create the repositories that will be used by the clusters. This also creates the repository’s .key file.Make sure the .key file corresponding to the repository you’re using is created on every node. The same key file must be available to all the clients using the cluster, either installed on the client machine or available in a shared directory. See the Supervisor’s Guide for details.Make sure the bomain.key file of the repository you are using has been copied to $INSTALLDIR\nodes\<hostname>\<clustername>\locdata\. Only one .key file must be present in this folder and must be named bomain.key.Use Supervisor to create or import the system’s users and user groups, then assign them access rights. Define at least one Broadcast Agent for one or more user groups.

wmainkey utilityYou can also create the bomain.key using wmainkey, a command-line utility.You need to know the type and location of the repository database and have the appropriate middleware installed. You find full details for using your connectivities in the Data Access Guide.Launch wmainkey from the command line. It is located in the following directory:$INSTALLDIR/bin/This launches wmainkey without any options. You are prompted to specify the repository database type depending on your platform.A series of prompts appear, depending on the database you selected. These include the network layer, the user name and password of the repository’s database account, and so on.




You are then given the option to test your connection:Do you want to test the connection ? (default=y) :

You have the option to save the bomain.key file in the default directory, $INSTALLDIR\nodes\<hostname>\<clustername>\locdata, or enter a path to a directory of your choosing.

UniversesUsing Designer, create at least one functioning universe, configured with a valid, secure connection to the corporate database. Export the universe to the repository.See the Designer’s Guide for information on how to create universes and the Supervisor’s Guide for information on how to export universes.

FontsVerify that the fonts you need to display documents in the languages used in your deployment are installed on the Business Objects servers. For information about font management, see Deploying the Business Objects System.

Time zoneWhen you set the cluster’s locale in the Administration Console or at setup, it must be identical to the OS locale on the cluster’s servers.For information about setting locales, see Deploying the Business Objects System.

Verifying web and application serversMake sure that the web and application servers are functioning properly.Make sure the web and application servers can communicate with each other through a connector provided by either the web or application server manufacturer. You must install and configure this connector according to the instructions packaged with it.You can test this by trying to access a page provided by the application server from a web browser. For example, if you made available some example JSP pages on a Tomcat application server at http://<HostName>:<port>/examples/jsp, you could then try accessing them from a web browser. If you can access the pages, the web and application servers are communicating properly.If you’re using an application server in standalone mode, then you don’t need a web server.




If you have installed your separate or combined web and application servers on primary or secondary nodes, you have ensured that the cluster can communicate.

Essbase with WebIntelligence OLAPIf you are using Essbase with WebIntelligence OLAP, you must configure Essbase connectivity before you can run your Business Objects system.You do this with a special utility that Business Objects provides called EssConfig.exe.To run the EssConfig.exe utility:1. Double-click the EssConfig.exe file, located in $INSTALLDIR\bin\.2. Enter the Essbase server name, user name, and password.3. Click Update.

The system builds the connection to the Essbase server and creates the Essbase.id file.

4. Click Cancel to quit the utility.

Security settings for Windows 2003 ServerIf you are running BusinessObjects 6.5 with Windows 2003 Server, and you are using IIS version 6, you must:• add a snap-in for IIS• enable the parent path • set certain system environmental variables Otherwise, you will not be able to open InfoView. This change is due to improved security in IIS version 6.

Adding a snap-inTo add a snap-in for IIS on Windows 2003 Server:1. Open a DOS command prompt.2. Type mmc, and then press Return.

The Console window appears.3. From the Console menu, select Add/Remove Snap-in.

The Add/Remove Snap-in dialog box appears.




4. Click Add.The Add Standalone Snap-in dialog box appears.

5. Highlight Internet Information Service, and then click Add.Internet Information Service appears in the list in the Add/Remove Snap-in dialog box.

6. Click OK.7. On the left panel of the Console window, highlight Web Service Extensions.

If you do not see it, open the various levels of the tree.8. On the right panel, switch Active Server Pages to Allowed. 9. Close the Console window.

Enabling the parent pathTo enable the parent path:1. Open the IIS Console.2. In the left panel, under the default website: Point to wiasp, right-click, and

select Properties.The wiasp Properties dialog box appears.

3. On the Virtual Directory tab, click Configuration. (If the button is disabled,




click Create, and then click Configuration.)The Application Configuration dialog box appears.

4. Click the App Options tab.5. Select the Enable Parent Paths check box.6. Click OK twice, and then close the IIS Console.

Setting system environmental variablesSet the following system environmental variables:• Point BO_TRACE_CONFIGFILE to the file BO_trace.ini• Point BO_TRACE_LOGDIR to the folder that contains BO_trace.iniBy default, BO_trace.ini is located in $INSTALLDIR\bin\scripts\preconf\

Restarting the serverWhen you have finished the above steps, restart the Windows 2003 Server.




Before you set authenticationBefore configuring your system to authenticate and authorize (see Setting Authentication and Authorization on page 231), you must:• set up the web agent on the web server• configure SSO, if you use this service

- Set up the SiteMinder application server and the Business Objects rights calculations.- Define the Business Objects agent on the policy server.For more information on configuring SiteMinder to work with Business Objects, see Using Netegrity SiteMinder with Business Objects, which is available on the Business Objects Customer Support website.

Supported user management systemsMake sure the version of LDAP and SiteMinder you are using is supported. You can find an up-to-date list of the versions of LDAP and Siteminder supported by Business Objects in the PAR:1. Go to www.techsupport.businessobjects.com2. Log in to the site.3. Select Enterprise 6 > PAR > BI Platform 6

Basic authentication with Apache and TomcatIf you configure the Business Objects server with Basic authentication, and you are using Apache v. 2 and Tomcat v. 4.1 or later, you must modify the server.xml file. Otherwise, your Business Objects server may not function. This is due to a limitation of Tomcat. The server.xml file is located in <Tomcat installation directory>\conf\To modify the server.xml file:1. Open the file in a text or XML editor.2. Comment the Coyote connector and uncomment the ajp13 connector.3. Add tomcatAuthentication="false" at the end of the ajp13 section.




Before you set authentication

In the following example, the text in bold has been added:





<Connector className="org.apache.ajp.tomcat4. Ajp13Connector"

port="8009" minProcessors="5" maxProcessors="75"

acceptCount="10" debug="0" tomcatAuthentication="false"/>

-->





chapter

Setting Authentication and Authorization





After you install the Business Objects products and deploy the web applications, you set the system’s authentication and authorization modes and sources.With this release, you do this using the Security Configuration Tool. The system uses the options you choose for both 2- and 3-tier Business Objects applications.This chapter describes authentication and authorization and how they work, the types of systems you can use to manage users and their security profiles, and how to set authentication and authorization for your cluster.

Where you are now






page 113



- wdeploy page 181




page 265



Authentication and authorization

Authentication and authorizationAuthentication and authorization are two distinct but related processes:• Authentication examines the user name and password a user enters at login

to verify that the user really is the person he or she claims to be.• Authorization is the subsequent calculation of a user’s access rights, in order

to provide the correct access to applications and resources. Before logging into your system, you must choose the cluster’s authentication mode, which determines the method by which users are authenticated: Business Objects, Windows, Single Sign-On, or Basic.You must also choose an authentication source; that is, where and how you are going to store user authentication and authorization information. In the past, the Business Objects suite relied entirely upon the repository for this. Now, in the current release, you can also use an external system such as LDAP or Netegrity Siteminder to manage users’ security information.




Authentication modeWhen you first launch the Security Configuration Tool, you are asked to choose an authentication mode. Your choice determines the mechanism by which users are authenticated for both 2- and 3-tier Business Objects applications.The following authentication modes are available:

Authentication mode In a 2-tier system In a 3-tier systemBusiness Objects The Business Objects system performs the entire

authentication process. The 2 and 3-tier modes use the same user name and password. Authorization can be carried out by:• Business Objects, based on the repository• LDAP• SiteMinder

Windows The user is authenticated on the Windows workstation and on the repository.

The user is authenticated by an IIS web server.

Single Sign-On (SSO) The workstation asks the SSO server to authenticate the user. The SSO system then returns the authentication ticket to the workstation.

The user is authenticated by the SSO server. After authentication, the server sends an authorization ticket to the web server, and the authentication ticket is checked again by Business Objects.

Basic authentication The Business Objects user name and password is required.

User authentication is delegated to the web server. The web server is trusted without being checked.Business Objects verifies the user name, but not the password, in the repository.



Authentication source

Authentication sourceTo authenticate a user, the system checks the username and password the user enters at login against pre-registered authentication information required for access to the system.You decide where BusinessObjects 6.5 finds this information. This is called the authentication source.As a Business Objects administrator, you can manage this type of user information by creating accounts for users in the repository, in an external application and/or directory such as Netegrity SiteMinder,® an LDAP (Lightweight Directory Access Protocol) directory, or a combination of these options.

Types of authentication sourceIf you select SSO as authentication mode, then the source is always the SSO server.If you select one of the other modes (Business Objects, Windows, or Basic), you then have a choice of three authentication sources:• Repository• External then repository• ExternalYou select the source in the Security Configuration Tool.Whether you store user authentication information in the repository or in an external system, the system relies upon the access rights stored in the Business Objects repository, as you defined them using Supervisor.The following table describes the different authentication sources.




For more detailed information on the mapping between externalized users and the security profiles in the repository, see Using LDAP with Business Objects on page 239.


Description

Repository The traditional Business Objects approach, in which each user’s authentication information and security profile is entered using Supervisor and stored in the repository’s security domain. Users are both authenticated and authorized through the repository, using Business Objects security mechanisms.

External then repository

Each user is declared in an external corporate directory (this makes them external users) and is mapped directly to a user that has been declared by name in the repository using Supervisor. The user must be declared by the same name in both the external directory and the repository. The external user is granted all the rights of the repository user.

External Each external user is mapped to one or more repository groups declared using Supervisor, thereby acquiring the cumulative access rights accorded the groups. The user is declared in the LDAP directory but is not actually named in the repository.In this case the relationship between the external user and the security profiles in the repository is defined in the external directory itself. Authorization is calculated by combining the authorizations of the mapped user groups and their parent groups in the repository.




The following diagram summarizes the authentication and authorization process.

External user management systemsManaging Business Objects user identities in an external user management system like an LDAP directory allows you to store user information for all your enterprise applications—including the Business Objects suite—in a single corporate directory.

Start authentication

Check source in repository

Is this userin the external

system?

Repository userAuthenticate and authorize

user via the repository

Authenticate user via external

system

Is the user declared in the

repository?

External-only userRead security profiles in

external authorization based on mapping

between external user profiles and repository

External and repository user

Authorization based on repository access

rights

RepositoryExternal External then repository

Yes No

Yes No




This improves scalability and ease of administration of the BusinessObjects 6.5 suite, and it allows you to lighten the amount of information stored in the repository by storing it elsewhere.Using SiteMinder with the Business Objects system lets you enable SSO for Business Objects users, which means they authenticate only once for subsequent access to multiple applications. Depending on how you configure SiteMinder, this can be when users enter the operating system, an enterprise portal, or elsewhere.SiteMinder is often deployed using an LDAP directory to store its authentication information.Users no longer managed in the repository are referred to as externalized users.

Supported external user management systemsYou can find an up-to-date list of the versions of external user management systems supported by Business Objects in the PAR:1. Go to www.techsupport.businessobjects.com.2. Log into the site.3. Select Enterprise 6 > PAR > BI Platform 6.




Using LDAP with Business Objects

Using LDAP with Business ObjectsAs discussed in the previous section, in configurations using an LDAP directory for storing user authentication, you can declare users in either of two ways:• in both the repository and in a corporate LDAP directory, where the LDAP

users are mapped directly to repository users. In this case, the same name is used to declare the user in both the external LDAP directory and in the repository.

• in the corporate LDAP directory alone, where the LDAP users are mapped to repository groupsIn this scenario, the relationship between the LDAP user and the repository group can be defined by mapping:- the user directly to the repository groups- the user to the repository groups as defined by a specific LDAP user attribute referencing these groups by name- the groups to which a user belongs to a specific group or groups in the repository. In this case, the names of the LDAP groups and the repository groups are identical.

The following diagrams show the relationships involved in these mapping scenarios.

NOTE

When mapping your external users to repository groups, you must use only static, enumerated groups. Business Objects does not support dynamic groups or LDAP references.




Mapping an LDAP user directly to a user in the repositoryHere’s an example of straight one-to-one mapping:

The LDAP user is mapped to the user instances in the repository, in this case to Instance 1 and 2 of John Smith.In this case, more than one LDAP user can be mapped to a single repository user.

Mapping an LDAP user to a group in the repositoryHere are two examples of mapping between LDAP users and repository groups.

Mapping an LDAP user directly to user groups in the repository

The LDAP user is mapped to Groups 1 and 22 in the repository.

Business Objects repositoryLDAP users

North America

South America

Ontario

cn = ‘John Smith’

Instance 1

Instance 2of John Smith

of John Smith


North America

South America

Ontariocn = ‘John Smith’

Roles = Group 1Group 22




Mapping an LDAP user to repository groups based on an external attribute

The LDAP server maps the external user attribute chosen during configuration to groups in the repository, in this case to Group 1 and Group 22. In this example, the attribute, NSROLE, includes 'Group 1' and 'Group 22' for user ‘John Smith’. Therefore, when John logs in, he will inherit the access rights defined for groups 1 and 22 in the repository.

Mapping LDAP groups to repository groups

The LDAP user groups are mapped to groups in the repository, in this case to Group 11 and Group 2. The LDAP user group Group 2 has the members John Smith and Steve Adams, who inherit the Business Objects group rights of Group 2. Therefore, the user John Smith also inherits group rights of ‘Group 11’.


North America

South America

Ontario

cn = ‘John Smith’NSROLE=Group 1, Group 22


North America

South America

Ontario

cn = ‘John Smith’

Group = ‘Group 11’Members = ‘John Smith’

‘Mary Jones’

Group = ‘Group 2’Members = ‘John Smith’

‘Steve Adams’




Synchronizing logins and externalizing repository usersBusiness Objects assumes that the administrator in charge of externalizing Business Objects users to an LDAP has thorough knowledge of LDAP and how it works.To externalize a user, you must create the user in LDAP with a name that corresponds to the repository user. If you delete a user from the repository and then re-create the user in LDAP, the user’s ID will change at the next login.Information attached to the previous user ID (personal options, personal documents, Inbox, Broadcast Agent tasks) will not be available through the new user ID. You externalize the repository user by creating the link between it and LDAP. The coherence between LDAP and repository mapping is maintained at the level of group names. If a supervisor deletes a group called Sales and another supervisor then creates a group called Sales, mapping between that group name and LDAP will be altered, most likely without the supervisor’s knowledge.

LDAP restrictions for specific Business Objects applicationsSome restrictions apply when you use LDAP with the following Business Objects applications:• Supervisor• InfoView• Broadcast Agent

SupervisorUsers stored externally are not visible in Supervisor.The supervisor and the designer users cannot be externalized. They can be authenticated externally but must still be administered in the repository.

InfoViewTo limit the scope of LDAP searches in the Send To workflow, not all LDAP users can be displayed in the drop-down list at the same time. To find an LDAP user, type the first letters of the user’s name.

Broadcast Agent

Send To workflowTo limit the scope of LDAP searches in the Send To workflow, not all LDAP users can be displayed in the drop-down list at the same time. To find an LDAP user, type the first letters of the user’s name.




Broadcast Agent requires a Broadcast Agent user to execute tasks. This user must still be declared and authenticated through the repository; you can't externalize Broadcast Agent users through LDAP.Business Objects cannot migrate Broadcast Agent tasks.

Broadcast Agent accountFor batch scheduling purposes, Broadcast Agent requires the Broadcast Agent user to be in the repository. Therefore, if an externalized user has the same name as a Broadcast Agent user, they both must have the same password. Otherwise, Broadcast Agent cannot authenticate the user and scheduled tasks will not be executed.To avoid this problem, the Broadcast Agent user must either:• be declared in the repository only and have a Broadcast Agent-specific name,

such as “bca123”• hold the same name and password as the corresponding LDAP user

Refreshing a Broadcast Agent documentWhen logged into Business Objects in Business Objects authentication mode, a user has BOUSER and BOPASS variable values, specifically the name and password entered for external authentication. This user can use any connection to build or refresh documents and use Broadcast Agent as long as the document is refreshed in the user’s name, whether relying on a BOUSER/BOPASS dynamic connection or a “fixed credential” static connection.When the user wants to schedule a document to be refreshed in the name of other users, however, the static connection works, but dynamic connections do not.When logged in to Business Objects with an external authentication source, users have a BOUSER variable value, but no BOPASS value. As a result, they cannot use dynamic connections.A solution to this issue is the option available in the Configuration Tool to store, in the repository, the passwords of externalized users. This permits dynamic connections and scheduling in the name of specifc users. Be aware, however, that this may render the password non-secure.For more information about the BOUSER and BOPASS variables, see the Designer’s Guide.




Netegrity SiteMinderSiteMinder provides SSO, which allows users to authenticate once and then access other protected resources without re-authenticating.Using SiteMinder with the Business Objects system lets you enable SSO for Business Objects users, which means they authenticate only once for subsequent access to multiple applications. Depending on how you configure SiteMinder, this can be when users enter the operating system, an enterprise portal, or elsewhere.The following diagram illustrates how SSO works:

You can use two different authentication modes with SiteMinder:• Basic authentication• SSO authenticationThe procedures are explained in the sections below.

Client

Security Server

Web serverSSO Agent

2The SSO Agent queries the Security server to authenticate the user. If the user is authenticated, the security server instructs the Agent on the policy to follow for the user.

3The SSO Agent redirects the user’s calls to the web server according to the Security Server policy, and adds the appropriate ticket to the HTTP headers. This is the ticket used to identify the session.

1The user logs into InfoView.The call is redirected by the SSO Agent for credential checks.



Netegrity SiteMinder

NOTE

For general information on configuring SiteMinder to work with Business Objects, see Using Netegrity SiteMinder with Business Objects, available on the Business Objects Customer Support website.

Using SiteMinder with Basic authenticationTo use SiteMinder with Basic authentication:1. In the Security Configuration Tool, set the authentication mode to Basic.

This is explained in Setting the authentication mode on page 248.2. In SiteMinder, create a Web Agent for the web server.

This is explained in Using Netegrity SiteMinder with Business Objects. (See the section “Configuring SiteMinder to Work with Business Objects.”)

Using SiteMinder with SSO authenticationTo use SiteMinder with SSO authentication:1. In SiteMinder, create a Web Agent for the web server.

This is explained in Using Netegrity SiteMinder with Business Objects. (See the section “Configuring SiteMinder to Work with Business Objects.”)

2. In SiteMinder, create a Business Objects Agent.This is explained in Using Netegrity SiteMinder with Business Objects. (See the section “Creating a BO Agent”)

3. In the Security Configuration Tool:- Set the authentication mode to Single Sign-on (see Setting the authentication mode on page 248).- Enter the BO Agent information in the Authentication and Authorization Source page of the Security Configuration Tool (see Setting the authentication source for SSO mode on page 250).




Using the Security Configuration ToolYou use the Security Configuration Tool to configure authorization and authentication in your Business Objects system.You configure the following parameters:• Authentication mode• Authentication and authorization source• Server connection for an external user management system• Mapping between groups in the external user management system and

Business Objects groups• User attributes used in a ‘Send To’ search (external user management

system)The Security Configuration Tool can be used from any node which has a valid repository key file. Although you can modify your configuration at any time, the changes will not take effect until the cluster is restarted from the Administration Console.

Who can use the Security Configuration ToolTo have access to the Security Configuration Tool, you must have a general supervisor profile that is authenticated and authorized in the repository.All other general supervisors can be authenticated in an external user management system but must also be declared in the repository.

Making sure the Security Configuration Tool is installedThe Security Configuration Tool is automatically installed during a standard BusinessObjects 6.5 Desktop or Server installation, provided the license key is available. You do not need to install any special software.If you select Custom Installation, however, you must select and install the LDAP Security Connector. It is located in the product tree under Administration Products.

Where are Security Configuration Tool choices stored?The choices you make when you use the Security Configuration Tool are stored in an XML file that is exported to the repository. This XML file has the same root name as the cluster’s .key file. For example, if the cluster’s .key file is called BOMainProduction.key, the XML file will be called BOMainProduction.XML.



Using the Security Configuration Tool

Launching the Security Configuration ToolTo launch the Security Configuration Tool:1. Do one of the following:

- From the DOS prompt, type:cd $INSTALLDIR\bin\scripts\

configtool.bat -security

- Click Start > Programs > Business Objects > Security Configuration Tool 6.5.The Login dialog box appears.

2. Enter your general supervisor user name and password.3. Select or browse for the repository KEY file, and then click Next.

The Authentication Mode page appears.




Setting the authentication mode and sourceThis section explains how to set the authentication mode for your cluster,and then how to configure the authentication and authorization source.

Setting the authentication modeYou set the authentication mode on the Security Configuration Tool’s Authentication Mode page.

For an explanation of these modes, see Authentication mode on page 234.Select the authentication mode you want, and then click Next.The Authentication and Authorization Source page appears. The procedures you now follow depend on the authentication mode you selected:• If you selected Business Objects, Windows, or Basic authentication, go to

Selecting the authentication source for standard modes on page 249.• If you selected Single Sign-on, go to Setting the authentication source for

SSO mode on page 250.



Setting the authentication mode and source

NOTE

If you choose Basic authentication for your cluster, after you select and configure the cluster’s authentication/authorization source, you must configure the web server to use Basic authentication as well. This procedure is not necessary if you are using SiteMinder. For instructions, see If you chose Basic authentication on page 252.

Selecting the authentication source for standard modesIf you selected the Business Objects, Windows, or Basic authentication mode, the Authentication and Authorization Source page looks like this.

To set the authentication source:1. Select an authentication source:

- Repository- External then repository- ExternalFor a full description of the sources, see Types of authentication source on page 235.




2. Do either of the following:- If you selected Repository, there is no further configuration required; click Next and then Finish. Go to Confirming your configuration on page 262.- If you selected External then Repository or External, you must configure the LDAP server connection by following the steps below.

3. Select a source from the External source drop-down list.If you have chosen the Windows authentication mode, you must select MS Active directory.

4. In the Host name box, type the name or the IP address of the server hosting the external user management system.

5. In the Port box, type the port number through which the LDAP server is accessed.

6. Click Connect.7. If the connection is successful, click OK, and then click Next.

The Choose LDAP Connection page appears. Go to Configuring LDAP connection parameters on page 255.

Setting the authentication source for SSO modeIf you selected Single Sign-on as your authentication mode, you must provide SSO server information on the Authentication and Authorization Source page.



Setting the authentication mode and source

To do so:1. In the Policy server host box, type the name or the IP address of the

SiteMinder server.2. In the Accounting port box, type the port number through which the

SiteMinder server is accessed.3. Type the authentication and authorization port numbers.4. In the Business Objects agent name box, type the name of the Business

Objects Agent that you created in SiteMinder.See Using SiteMinder with SSO authentication on page 245.

5. In the Shared secret box, type the password.6. Click Connect.

If the SSO server responds, a confirmation message appears.7. Click OK, and then Next.

The SSO Administrator page appears.8. Enter the account name and password of the administrator, and then click

Next.The Final Confirmation page appears.

9. Click Finish.




If you chose Basic authenticationIf you selected Basic authentication mode, you must configure your web server to use Basic authentication as well. This procedure is not necessary if you are using SiteMinder.

If you’re using Apache1. Navigate to <Web Server Install Dir>\bin, then type the following at the DOS

prompt:htpasswd -c <Web Server Install Dir>\conf\users GS

2. To add users, type the following:htpasswd <Web Server Install Dir>\conf\users auto

Make sure that the users created with htpasswd are already declared in the repository.

3. Using a standard text editor, open the httpd.conf file located in <Web Server Install Dir>\conf, then add the following to the end of it:<Location />

AuthName "BA Authentication"

AuthType Basic

AuthUserFile "<Web Server Install Dir>\conf\users"

require valid-user

</Location>

Save your changes and close the editor.4. Do either of the following:

- If you’re using an Apache web server with a Tomcat application server, follow the instructions in the next section.- If you’re using any other web/application server combination, start the Business Objects server, the application server, and the web server.

If you’re using Apache/Tomcat1. Open the server.xml file in an XML editor. You can find this file in the <Tomcat

Install Dir>.2. Comment the Coyote connector by doing the following:



If you chose Basic authentication

- Insert the following line:

just below the line: Name="org.apache.jk.server.JkCoyoteHandler"/>

3. Uncomment and adapt the ajp13 connector by doing the following:- Remove the  in the next line.This part of the server.xml file should now look like this:



<Connector className="org.apache.ajp.tomcat4.Ajp13Connector"port="8009" minProcessors="5" maxProcessors="75"acceptCount="10" debug="0" tomcatAuthentication="false"/>

5. Save your changes and close the editor.6. In a standard text editor, open the httpd.conf file, located in <Apache Install

Dir>\conf.




7. Add the two lines in bold to the following section, in order to permit the downloading and installation of BusinessObjects in 3-tier mode (the path used in the Alias line is an example):Alias /wijsp/distribution "C:/Program Files/ Business Objects/BusinessObjects Enterprise 6/ distribution"

<Directory "C:/Program Files/Business Objects/ BusinessObjects Enterprise 6/distribution">

Options FollowSymLinks

Allow from All

Satisfy Any

</Directory>

8. Save your changes and close the editor.9. Start the Business Objects server, the application server, and the web server.

If you’re using IISAfter choosing Basic authentication in the Securuity Configuration Tool, do the following:1. Click Start > Programs > Administrative Tools > Internet Service Manager.2. Click the Directory Security tab.3. Uncheck Anonymous access.4. Check Basic Authentication (Password sent in clear Text), then click OK.

The Inheritance Overrides dialog box appears.5. Select the scripts, viewers, bin and classes child nodes, then click OK.



Configuring LDAP connection parameters

Configuring LDAP connection parametersAfter you finish setting the authorization source for a standard (non-SSO) connection, the LDAP Configuration page appears.

To configure the LDAP connection parameters:1. In the Root DN drop-down list, select or type the naming attribute.2. If you want to display a name attribute, select Display name attribute, then

type the attribute name in the text box.3. In the LDAP Connection section, select whether to bind anonymously or with

an Administrator account.This option is available only if you selected External then Repository or External as the authentication source for Business Objects or Basic modes.

4. If you selected Bind with the following account, enter the account name and bind password of your LDAP account in the Account DN and Bind Password boxes. Read access is sufficient.




The Bind user name and password are for the LDAP account used to log into LDAP and query for user attributes and groups. Business Objects does not make modifications in the LDAP directory.

5. Click Next.The Mapping page appears.

Mapping to a group or userThe mapping parameter defines the query used to determine the list of repository groups associated with an LDAP user (for authentication purposes). The query also displays the list of Business Objects users in the Send To functionality in InfoView.These repository profiles represent either a repository user or a list of repository groups.

If you have... You can use...Sun ONE one of the following:

• the Directory Manager name and password, found in the Configuration tab, Manager sub-tab in the server group for your server.

• the user DN and password for any LDAP account that allows you to read the LDAP directory.

Active Directory the user name and password to a domain.




To map to a group or user:1. On the Mapping page, select the type of mapping you want.

- If you select LDAP user to Business Objects group, you have two options:• LDAP group membership• LDAP attribute

If you select LDAP attribute, type the attribute name in the Attribute box.- If you select LDAP user to Business Objects user, security is inherited from the repository user.

2. If you want to set LDAP attributes and filter queries, click Advanced, and go to Customizing the LDAP query parameters on page 257.If you use a standard LDAP schema (users identified by ID or user to repository profile mapping based on group or LDAP attributes) then you do not need to set the Advanced Security Configuration.

3. Click Next.The Final Confirmation page appears. Go to Confirming your configuration on page 262.

Customizing the LDAP query parametersThe Advanced LDAP Configuration page enables you to:• adapt to non-standard LDAP schemas by defining new queries to be used by

the LDAP connector• define the attributes you use in Business Objects applications




When you click Advanced on the Mapping page, the Advanced LDAP Configuration page appears.




Adding an attributeTo add a new attribute:1. Under the Attribute Returned area, click New.

The LDAP Attribute Configuration dialog box appears.

2. Type the name of the new attribute.3. If you select the Extract Only check box, type the value you want extracted.4. Select the Group Attribute check box if the attribute value corresponds to a

group.5. From the Use drop-down list, select an attribute type:

- User Unique Identifier- User Display Name- Business Objects Group- Business Objects User- Business Objects Variable

6. If you selected Business Objects Variable, the BO Variable Name text box becomes active. Type the BO Variable name.

7. Click OK.The Advanced LDAP Configuration page re-appears.

Customizing parameters for LDAP queriesTo customize parameters for LDAP queries:1. Enter the LDAP attributes that are to be read by the system (filter formula).2. Enter the base (root) at which the query begins.3. Select the Business Objects variable name that corresponds to the LDAP

attribute.




4. Click Edit.The LDAP Attribute Configuration dialog box appears.

5. If you want to change the name of the attribute, type a new name in the Attribute box.

6. If you select the Extract Only check box, type the value you want extracted.7. Select the Group Attribute check box if the attribute value corresponds to a

group.8. From the Use drop-down list, select an attribute type:

- User Unique Identifier- User Display Name- Business Objects Group- Business Objects User- Business Objects Variable

9. If you selected Business Objects Variable, the BO Variable Name text box becomes active. Type the BO Variable name.

10.Click OK.The Advanced LDAP Configuration page re-appears.

Defining the Send To searchTo specify the filter formula used for the search mechanism in the Send To feature: 1. In the Filter formula text box, enter the filter formula you want.2. In the Base box, set the Base (root) at which the query is to begin its search.3. In the Scope drop-down list, select the scope of the query.4. In the Attribute requested box, type the attribute the query is to return.

If you click the Extract only check box, enter the value you want to extract.5. Enter the maximum number of users queried.6. Click OK, or continue to Specifying group membership query on page 261.




Specifying group membership queryTo specify the filter formula used to query groups for the Broadcast Agent Send To feature:1. In the Filter formula box, enter the filter formula you want.2. In the Base box, set the Base (root) at which the query is to begin its search.

Select the corresponding value in the Scope drop-down list.3. In the Attribute returned box, enter the attribute the query is to return.

If you check the Extract only option, enter the value you want to extract.4. Enter the maximum number of users queried.5. Click OK.

The LDAP Mapping page appears.6. Click Next.

The Final Confirmation page appears. Continue to the next section.

Store Password for Broadcast AgentYou can store an external user’s password for use with Broadcast Agent. To store the password, select the Store Passwords in Repository check box.




Confirming your configurationBefore you can close the Security Configuration Tool, you must confirm your configuration. The Final Confirmation page lists the configuration choices you made.

If the parameters are correct, click Finish.


part

Finalizing Your Configuration



chapter

Getting Up and Running





This chapter explains the final steps that you must follow in order to complete the installation and configuration of BusinessObjects 6.5.Getting up and running includes:• starting the Business Objects system• testing and tuning the system• configuring the Demo kit

Where you are now






page 113



- wdeploy page 181




page 265



Starting the system

Starting the systemTo start the Business Objects system:1. Start the Business Objects server on the primary node.

From the Windows Start menu, point to Programs > Business Objects > Start Server.The Business Objects server starts the required processes. This may take a few moments.

2. Start the Business Objects server on the secondary nodes.3. Start the application servers.4. Start the web servers.




After starting the systemThis section explains the final steps you perform after starting the Business Objects system.

Verifying InfoViewMake sure that you can start InfoView:• Open a web browser and type in the following URL:

http://<server name>:<port number>/<wijsp or wiasp>

where <server name> is the name of the server on which you installed Business Objects server products, and <port name> is the port on which you configured the web server.The InfoView Login page appears.



After starting the system

TroubleshootingIf you cannot log into InfoView, check that all of the Business Objects server processes have been correctly started:1. Press Ctrl + ALT + Delete, and then select Task Manager.

The Windows Task Manager dialog box appears.2. Click the Processes tab.3. Click Image Name to display the list of processes in alphabetical order.4. Check that the following processes are in the list:

- one BOMgr process- two busobj processesThese are the last processes to start. If they are running, all required processes have been started.

5. If these processes have not started after some time, restart your machine and then restart the Business Objects server, the application server, and the web server.

Tuning the systemOpen the Administration Console and tune the system. For details, see the System Administrator’s Guide.To tune the system:• Set the required and strategic enablement of Business Objects processes on

each node, as well as the ratio of system processing that each node will handle (node weight).Make sure you enable the session stack on each node you want to use for document processing.

• Set the pool size (for WIQT at least), making sure the total number for the cluster is equal to your deployment’s maximum number of concurrent users. If you are using Connection Server as a server component, set the number of its instances with care.

• Configure at least one Scheduler for the Broadcast Agent you created in Supervisor.

• Make sure you have enough TCP ports (see TCP ports on page 96).• If you are using Auditor, make sure system Audit information is stored in a

database.




Recommended Settings guideThe Recommended Settings Guide for Business Objects Deployments presents recommendations on BusinessObjects 6.5 and the underlying environment. It covers all supported hardware and software stacks, including settings for web and application servers as well as for Business Objects applications. This guide also covers the minimum supported O/S versions and patch levels, web browser versions, and web and application server versions and patch levels.This guide provides a starting point for setting parameters in a production environment. You may need to adjust parameters depending upon the exact nature of the deployment (number of users and user profiles, number of documents, projected workflows, and so on). This guide is not a substitute for ensuring that the product is properly installed or for having a good working understanding of the product.You can access the Recommended Settings Guide for Business Objects Deployments at www.techsupport.businessobjects.com

Testing the systemTest the cluster’s connection with the client by having several users log into InfoView from different machines.Have users requiring 3-tier deployments of BusinessObjects download the product through InfoView. After the download, they select BusinessObjects as their default report editor and/or viewer in the InfoView Options pages.Create documents using BusinessObjects and WebIntelligence.Test the system’s processing capabilities by publishing these reports to the repository to share them with other users, sending them directly to other users and saving them for personal use. If users are using third-party files in InfoView, make sure the third-party applications are installed on the client machines. Upload any desired third-party files for sharing through the repository.Test Broadcast Agent by scheduling a set of documents for automatic refresh and distribution from InfoView.

Scheduling documents with non-universe data sourcesWhen you create a BusinessObjects document and specify a data source other than a BusinessObjects universe, the system creates an sdac.lsi file to store the data connection. Due to Microsoft requirements, the file is located in:C:\Documents and Settings\<user name>\Application Data\Business Objects\Business Objects 6.0\lsi\




After starting the system

and not in the Business Objects installation directory.This means that if you want to refresh the document with Broadcast Agent, the connection to the data source will fail, and the document cannot be refreshed.To solve this issue, you must manually copy the sdac.lsi file to all nodes in the cluster. Copy the file into:$INSTALLDIR\nodes\<machine name>\<cluster name>\locdata\After the file is copied, all Schedulers on the cluster will be able to refresh the document.

Testing the system with wpingIf you are experiencing delays in system reaction, it may be useful to test general system functioning. wping is a command-line tool that connects to the Business Objects server and carries out simple tasks to test whether they function properly. wping can log in, retrieve a document from corporate or personal document storage, and refresh the document. The return value of the command indicates whether the operation succeeded, and if not, what are the possible causes.To find out how to use wping, see the Diagnostic Tools Guide.




Configuring the Demo kitThe Demo kit is a group of demonstration files shipped with Business Objects products. These files include universes, generic SQL scripts to create the databases used by the universes, and sample reports and templates.The Demo kit is used with the following products:• BusinessObjects• WebIntelligence• Designer• SupervisorThis chapter describes how you configure the demonstration universes beach.unv and efashion.unv to connect to the databases that are shipped with Business Objects products.You must connect to these universes in order to use the BusinessObjects and WebIntelligence Getting Started guides. The beach.unv is also the main source for most of the examples in the Designer’s Guide.Business Objects Customer Support often uses the files in the demo kit to demonstrate solutions to user reporting and universe design issues.The Demo kit is available as a separate product in the regular installation of BusinessObjects 6.5. The files are installed by default into $INSTALLDIR\demo\.Microsoft Access 2000 database versions of the demonstration databases are shipped with Business Objects products. If you want to use the Club and Efashion databases in another RDBMS environment, then you can create the databases using the provided SQL scripts. This is described below.Configuring the Demo kit includes the following steps:1. Create the efashion and club databases using the SQL scripts.2. Create connections to point the universes to the databases.3. Export the universes to your Business Objects repository.

Creating the databasesYou create the databases using the SQL scripts. These scripts are contained in two zip files:• efashion

Contains SQL scripts to create and populate the efashion database.• club

Contains SQL scripts to create and populate the club database.



Configuring the Demo kit

Both zip files contain a Readme that describes the SQL scripts, DAT files, and any RDBMS-specific issues you need to be aware of when running the scripts. Business Objects recommends checking the Readme before you generate either database.

Creating the connectionsAfter you create the efashion and club databases, you must create a connection for the beach.unv and efashion.unv universes. You do this by opening each universe in Designer and then saving the connection in the universe parameters.When BusinessObjects and WebIntelligence users refresh the sample reports in the demo kit, they run queries against the universe using objects that infer SQL statements. The universe maps the objects in the query to actual SQL statements, and runs these statements against the database middleware.See the Data Access Guide for information on creating and managing a connection for a universe. See the Designer’s Guide for more information on using universes and optimizing connections from Designer.

Exporting the universesYou must export the beach.unv and efashion.unv universes to the Business Objects repository. For more information, see the Designer’s Guide.




Where to go nowYour BusinessObjects 6.5 suite should now be fully operational.If you want to modify or remove an installation or product, go to Modifying and Removing Installations on page 83.


part

Appendices



appendix

Business Objects Products and Feature Codes




OverviewThis appendix lists the Business Objects products and components, along with their feature codes. These codes are used when running the installer from the command line or in a batch file.

Feature code Product or component Descriptionbo BusinessObjects 6.5 The BusinessObjects suite of products.

bo.3TierBusinessObjects 3-tier BusinessObjects BusinessObjects, for use in 3-tier mode.

bo.AccessPacks Access Packs Data access packs

bo.AdminConsole Administration Console The Administration Console enables you to configure and monitor your cluster.

bo.AdminProducts Administration products Products intended for administrators and IT experts.

bo.Auditor Auditor Auditor monitors user and sytem activity

bo.AuditorDocComponents Document components Components to manage Auditor documents

bo.AuditorDocExporter Document Exporter Exports Auditor documents to repository.

bo.AuditorDocs Documents Auditor documents

bo.AuditorUniverseComponents

Universe components Components to manage Auditor universes.

bo.AuditorUniverseExporter Universe Exporter Exports Auditor universes to repository.

bo.AuditorUniverses Universes Auditor universes

bo.AuditorWebPages Web Pages Auditor portal

bo.BCAConsole Broadcast Agent Console Monitors Broadcast Agent activity

bo.BCAScheduler Scheduler The core of Broadcast Agent

bo.BroadcastAgent Broadcast Agent Broadcast Agent processes and distributes documents automatically and securely at scheduled dates and times.

bo.BusinessObjects BusinessObjects The integrated query, reporting, and analysis solution for your desktop.

bo.BusinessObjectsDoc Online Guides BusinessObjects documentation



bo.BusinessObjectsExplorer Explorer BusinessObjects module to carry out multidimentional analysis in drill mode.

bo.BusinessObjectsHelp Online Help BusinessObjects online help

bo.BusinessObjectsReporter Reporter BusinessObjects module for report creation and consultation.

bo.BusinessQuery BusinessQuery for Excel Add-in to Microsoft Excel to query relational databases and produce reports.

bo.BusinessQueryApp BusinessQuery for Excel BusinessQuery add-in

bo.BusinessQueryDoc Online Guides BusinessQuery documentation

bo.BusinessQueryHelp Online Help BusinessQuery help

bo.ConfigTool Configuration Tool The Configuration Tool enables you to configure your Business Objects server products.

bo.DemoKit Demo Kit Demo kit, including sample databases and universes.

bo.Demos Demonstrations Demonstrations and Quick Tours

bo.Designer Designer Designer enables you to create universes.

bo.DesignerApp Designer Designer application

bo.DesignerDoc Online Guides Designer documentation

bo.DesignerHelp Online Help Designer help

bo.DesktopProducts desktop products End-user products for desktop machines.

bo.Distribution BusinessObjects Web Installer

Enables users to download 3-tier BusinessObjects from InfoView. (This installs the entire package.)

bo.InfoView InfoView The InfoView portal.

bo.InfoViewASPages Application Server pages Application server pages and front-end components, installed on the machine that hosts the application server.

bo.InfoViewWSPages Web Server pages HTML pages and images, installed on the machine that hosts your web server.

bo.olap OLAP Access Packs Access packs for OLAP data sources

Feature code Product or component Description




bo.olap.BWConnect BW Connect SAP Business Warehouse Access Pack and documentation

bo.olap.BWConnectDoc Online Guides SAP Business Warehouse Access Pack documentation

bo.olap.BWConnectDriver BW Connect SAP Business Warehouse Access Pack

bo.olap.Essbase Essbase Hyperion Essbase Access Pack and documentation

bo.olap.EssbaseDoc Online Guides Hyperion Essbase Access Pack documentation

bo.olap.EssbaseDriver Essbase Hyperion Essbase Access Pack

bo.olap.Express Express Oracle Express Access Pack and documentation

bo.olap.ExpressDoc Online Guides Oracle Express Access Pack documentation

bo.olap.ExpressDriver Express Oracle Express Access Pack

bo.olap.IBMDB2 DB2 OLAP Server IBM DB2 OLAP Server Access Pack and documentation

bo.olap.IBMDB2Doc Online Guides IBM DB2 OLAP Server Access Pack documentation

bo.olap.IBMDB2Driver DB2 OLAP Server IBM DB2 OLAP Server Access Pack

bo.olap.MDXConnect MDX Connect Microsoft Analysis Services Access Pack and documentation

bo.olap.MDXConnectDoc Online Guides Microsoft Analysis Services Access Pack documentation

bo.olap.MDXConnectDriver MDX Connect Microsoft Analysis Services Access Pack

bo.QuickTour Quick Tour Multimedia Quick Tour of Business Objects products

bo.rdbms RDBMS Access Packs Access packs for relational databases

bo.rdbms.IBMDB2 IBM DB2 IBM DB2 Access Pack

bo.rdbms.IBMDB2Client DB2 Client Enables you to access an IBM DB2 database server

bo.rdbms.Microsoft Microsoft Microsoft Access Pack




bo.rdbms.MSAccessODBC Microsoft Access ODBC Driver

Enables you to access a Microsoft Access database

bo.rdbms.MSSQLServerODBC

Microsoft SQL Server ODBC Driver

Enables you to access Microsoft SQL Server

bo.rdbms.ODBC Generic ODBC ODBC Access Pack

bo.rdbms.ODBC2 Generic ODBC 2 Driver Enables you to access various databases through ODBC level 2 driver.

bo.rdbms.ODBC3 Generic ODBC 3 Driver Enables you to access various databases through ODBC level 3 driver.

bo.rdbms.Oracle Oracle Oracle Access Pack

bo.rdbms.OracleClient Oracle Client Enables you to access an Oracle database server.

bo.ServerBackEnd Business Objects server Server components, to be installed on a secured machine.

bo.ServerProducts server products Products running on server machines.

bo.Supervisor Supervisor Supervisor defines and administers users, user groups, and profiles.

bo.SupervisorApp Supervisor Supervisor application

bo.SupervisorDoc Online Guides Supervisor documentation

bo.SupervisorHelp Online Help Supervisor help

bo.WebIntelligence WebIntelligence WebIntelligence engine, for query, analysis, and reporting from the web.

bo.WebIntelligenceExplorer Explorer WebIntelligence module for report analysis (drill)

bo.WebIntelligenceReporter Reporter WebIntelligence module for report creation and consultation






appendix

Language Codes



Language Codes

OverviewISO 639 defines standard language codes that can be used as values within HTML and other documents requiring language properties. Business Objects uses these codes for command-line and Configuration Tool properties.

ISO language codesThe table below shows all ISO language codes. Check with your Business Objects consultant to see which languages are currently supported.

Code Languageab Abkhazian

af Afrikaans

am Amharic

ar Arabic

as Assamese

ay Aymara

az Azerbaijani

ba Bashkir

be Byelorussian

bg Bulgarian

bh Bihari

bi Bislama

bn Bengali; Bangla

bo Tibetan

br Breton

ca Catalan

co Corsican

cs Czech

cy Welsh

da Danish

de German



dz Bhutani

el Greek

en English

eo Esperanto

es Spanish

et Estonian

eu Basque

fa Persian

fi Finnish

fj Fiji

fo Faeroese

fr French

fy Frisian

ga Irish

gd Scots, Gaelic

gl Galician

gn Guarani

gu Gujarati

he Hebrew

ha Hausa

hi Hindi

hr Croatian

hu Hungarian

hy Armenian

ia Interlingua

id Indonesian

ie Interlingue

ik Inupiak

in Indonesian

Code Language



Language Codes

is Icelandic

it Italian

iu Inuktitut

iw Hebrew (obsolete; see “he”)

ja Japanese

ji Yiddish (obsolete; see “y”)

jw Javanese

ka Georgian

kk Kazakh

kl Greenlandic

km Cambodian

kn Kannada

ko Korean

ks Kashmiri

ku Kurdish

ky Kirghiz

la Latin

ln Lingala

lo Laothian

lt Lithuanian

lv Latvian, Lettish

mg Malagasy

mi Maori

mk Macedonian

ml Malayalam

mn Mongolian

mo Moldavian

mr Marathi

Code Language



ms Malay

mt Maltese

my Burmese

na Nauru

ne Nepali

nl Dutch

no Norwegian

oc Occitan

om (Afan), Oromo

or Oriya

pa Punjabi

pl Polish

ps Pashto, Pushto

pt Portuguese

qu Quechua

rm Rhaeto-Romance

rn Kirundi

ro Romanian

ru Russian

rw Kinyarwanda

sa Sanskrit

sd Sindhi

sg Sangro

sh Serbo-Croatian

si Singhalese

sk Slovak

sl Slovenian

sm Samoan

sn Shona

Code Language



Language Codes

so Somali

sq Albanian

sr Serbian

ss Siswati

st Sesotho

su Sundanese

sv Swedish

sw Swahili

ta Tamil

te Tegulu

tg Tajik

th Thai

ti Tigrinya

tk Turkmen

tl Tagalog

tn Setswana

to Tonga

tr Turkish

ts Tsonga

tt Tatar

tw Twi

ug Uigur

uk Ukrainian

ur Urdu

uz Uzbek

vi Vietnamese

vo Volapuk

wo Wolof

xh Xhosa

Code Language



y Yiddish

yo Yoruba

za Zuang

zh Chinese

zu Zulu

Code Language



Language Codes



Index

Index$INSTALLDIR 116, 130, 143, 212, 223.key file 223/a parameter 79/L parameter 79/s parameter 79/v parameter 79/w parameter 79/x parameter 79

Symbols2-tier architecture

see also 2-tier deployments2-tier deployments

what to install where 223-tier architecture

see also 3-tier deployments3-tier deployments

clusters 19what to install where 22

AAccess Packs 42, 54, 228, 238Access packs 50adding a product 85ADDLOCAL parameter 77ADDSOURCE

Windows Installer parameter 78Administration Console 53, 57Administration Products 52Administration products 50, 52advanced LDAP configuration

specifying LDAP authentication query 259ALLUSERS parameter 77Apache 138, 164Apache/Tomcat Installer 47APP_NAME 148, 149APP_TYPE 148, 149, 150

application serveradding a web application 159, 161, 164, 169,

173configuring 107, 110, 158modifying or removing 178

application server connector 23application servers

what you install on 23ASINSTALLDIR 149ASINSTANCENAME 149ASP 148, 150ASSTANDALONE 150ASTYPE 149ASWEBAPPNAME 149audit information 269Auditor 53, 269Authentication

before you configure the system 228authentication 250

defined 233authentication modes

delegated to the web server 234SSO authentication 234Windows 234

authentication source 250selecting standard 249

authentication vs. authorization 232authorization

defined 233

BBasic authentication 234bomain.key 223Broadcast Agent 57, 270

Console component 53description 51Scheduler component 51

Broadcast Agent Console 53, 57



Index

buildwar target 202buildwars target 202Business Objects

consulting services 11, 13documentation 10Documentation Supply Store 9support services 11training services 11, 13

Business Objects processes 269Business Objects products 278

what you install where 22Business Objects server products 60, 62, 64Business Objects system

clusters 19Business Objects Web Installer 57BusinessObjects 56

description 52description 52Explorer module 52Reporter module 52

BusinessObjects 4.x and earlierupgrading 33

BusinessObjects 5.xupgrading 32

BusinessObjects in 3-tier mode 51, 56BusinessObjects Web Installer 51BusinessQuery

description 52BusinessQuery for Excel 29, 56

CCFGFILE_LOC_0 149CFGFILE_LOC_1 150CFGFILE_NAME_0 149CFGFILE_NAME_1 150classpath

JDK 46clean target 202client machines

what you install on 23client node 120

configuration 120Cluster Management page 123, 130, 137, 158, 168cluster node

removing 125

cluster nodesdefined 19what you install on 23

cluster preferences 123Cluster Preferences page 117, 136CLUSTER_NAME 145, 150clusters

defined 19clusters and nodes 21-cmdfile 144-cmdline 144command-line installations 70, 73

examples 79path names 73syntax 73

command-line modeparameters 144syntax 143

COMPANYNAME parameter 77Configuration Options page 116, 130Configuration Tool 53, 57, 95

command-line mode 143command-line parameters 144parameters text file 144permissions 96starting 116text file parameters 145

configuring authenticationbefore you start 228Security Configuration Tool 246

configuring LDAPconfirmation 262connection parameters 255

configuring the application server 107, 110, 158configuring the ORB 118, 130, 132, 136configuring the web applications 105, 182configuring the web server 158confirming your LDAP configuration 262connectivities 223Console (Broadcast Agent)

description 53consultants

Business Objects 11creating universes 224custom configuration 117



Index

custom installation 57, 65Custom Setup page 85, 87customer support 11customized web applications 168customizing the LDAP query parameters 257

Ddata access 223data sources

OLAP 51RDBMS 51

default language 61, 63, 65DEFAULTLANG parameter 75delegated to the web server mode 234-delete 144demo

materials 9demo kit 57Demonstrations 50

filenames 55deploy target 202deployall target 202deploying an application 158Deploying static resources 216deployment

application servers and web servers 21Designer 29, 57, 224Designer (description) 53Desktop installation 56, 61, 63, 65Desktop products 52Developer Suite 10, 12distributed configurations

advantages 20documentation

CD 9feedback on 10on the web 9printed, ordering 9roadmap 9search 9

Documentation Supply Store 9DOCUMENTS_DIR 150domain user 120, 134, 140

Eeducation see trainingEssbase 225EssConfig.exe 225Explorer 56

module of BusinessObjects 52module of WebIntelligence 51

external userBusiness Objects authentication 234

external user management systemmapping to groups based on external attributes

241mapping to groups based on external user

groups 241supported directories 228, 238

external user management system restrictionsBroadcast Agent 242InfoView 242Supervisor 242

externalized users 235, 238

Ffeature codes 278feedback

on documentation 10final backslash 73final steps 266

Ggeneral system availability 271generic WAR file 194generic.xml file 212

H-help 144help target 202hotfix

applying 90httpd.conf file 138

IIIS 105, 115, 129, 133, 159, 168IIS Administration service 96



Index

IIS Services 125IMAGE_DIR 151InfoView 51, 57, 270

Login page 268troubleshooting 269verifying 268

Infoviewcore functionality of WebIntelligence 51

INSTALL_LANG parameter 75installation

custom 65which products on what machines 22

Installation Type page 61, 63, 65installation types 56Installation wizard 49

parameters 74Installation Wizard Completed page 86INSTALLDIR parameter 77installing JDK 45installing the software 42installing to the client 72Installing to the network 72InstallShield 73, 74

parameters 74, 79INSTALLTYPE parameter 78INSTALLVBA parameter 77instance

removing 177IP address 115, 118, 132, 136ISO 639 284ISO language codes 284

JJava 53JDK 45

classpath 46

KKnowledge Base 12

L-language 144language codes 284Language Selection page 116, 130

LDAPdefining mapping parameters 256Security Configuration Tool 246

LDAP authentication queryspecifying 259

LDAP connection parametersconfiguring 255

LDAP mappingspecifying LDAP authentication query 259

LDAP query parameterscustomizing 257

license agreement 60, 62, 64license files 45

installing in a shared network directory 45installing on each machine 45

LICENSEDIR parameter 74licenses 44LOCAL_IPADDR 146LOCAL_PORTMIN 146LOCALKEYDIR parameter 75LOCDATA_DIR 150LOGS_DIR 150

Mmanual application server detection 137, 161, 164manual configuration 98, 115Microsoft Excel® 52MIGRATION parameter 74MIGRATIONPROMPT parameter 74multidimensional data providers

using WebIntelligence 51multimedia

quick tours 10

Nnetwork location 72Node page 118, 121NODE_AUTOSTART 146NODE_SERVICE 146NODE_TYPE 146nodes and clusters 21-nosplash 144



Index

Oobjects

using Designer 53OLAP 225

using WebIntelligence 51OLAP Cache Service 119, 134, 139Online Customer Support 11ORB 118, 130, 132, 136

order of configuration 114

PPAR 42parameter components 73parameters file 144path names 73Possible issues

Deploying static resources 216pre-install procedures 44primary node

configuration 117defined 19what it does 20

PRIMARY_IPADDR 146PRIMARY_PORTMIN 146Product Availability Report 42Program Maintenance page 85, 87, 88, 89Properties parameter 198

Qqn parameter 78

RReady to Modify the Program page 86Ready to Repair the Program page 88relational databases

using WebIntelligence 51REMOVE parameter 78Remove the Program page 89removing a node 125removing a product 87removing an installation 89removing an instance 177removing individual products 87

repairing an installation 88Reporter 56

module of BusinessObjects 52module of WebIntelligence 51

repositories 223repository 53RESFILENAME 149review of tools 49, 95rights 96

SScheduler (Broadcast Agent) 51SCRIPTS_DIR 151search

documentation 9secondary node 120

configuration 121secondary nodes

defined 19what they do 20

Security Configuration Toolinstallation 246logging in 247who can use it 246

selecting SSO 250selecting standard authentication source 249server installation 57Server products 50Service parameters 119, 134, 139setup.exe 59SHAREDKEYDIR parameter 76SHDATA_DIR 150silent install 80specifying

LDAP authentication query 259SQL 53SQL structures 53SSO

configuring server connection 251SSO authentication mode 234SSO server connection 251SSO source

selecting 250starting the system 267Supervisor 29, 57, 269



Index

Supervisor (description) 53support

customer 11

Ttargets 202TCP ports 118, 132, 136TEMPLATES_DIR 151testing the system 270THREETIERBUSOJ parameter 76Tips & Tricks 10Tomcat 161, 164tools 49, 95training

on Business Objects products 11tuning the system 269types of configuration

custom 117types of installation 56Typical configuration 117Typical wizard 115, 128, 138

UUDS 119, 134, 139undeploy target 202undeployall target 202Universal Drill Through Service 119, 134, 139universes

creating 224UNIVERSES_DIR 150UNIX

multiple nodes on single servers 19upgrading 32, 67

WebIntelligence 32USERNAME parameter 77

WWARFILENAME 150wdeploy

deployment considerations 186

wdeploy tool 97adding an application server 212deploying a customized application 210generic WAR file 194Properties parameter 198targets 202

webcustomer support 11getting documentation via 9useful addresses 12

web applicationdeploying static resources 107, 110

web applicationsconfiguring 105, 182customized 168

WEB parameter 76web server

configuring 158web servers

what you install on 23WebIntelligence 51

description 51Explorer module 51InfoView 51OLAP Cache Service 119, 134, 139Reporter module 51

WebIntelligence 2.x 32WebIntelligence OLAP 225Welcome page 85, 89, 116, 130Windows authentication mode 234Windows Explorer 59Windows Installer 73

parameters 77Windows Start menu 130Windows User Manager 96, 134, 139WIQT 269wmainkey utility 223wping 271WSDIRNAME 148WSINSTALLDIR 148WSINSTANCENAME 148WSTYPE 148



Index

ZZero Admin BusinessObjects

definition 52



Index