Você está na página 1de 260

System Administrators Guide for Windows

BusinessObjects Enterprise 6 Business Intelligence Windows

System Administrators Guide for Windows

Copyright

No part of the computer software or this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, or by any information storage and retrieval system, without permission in writing from Business Objects S.A. The information in this document is subject to change without notice. If you find any problems with this documentation, please report them to Business Objects in writing at documentation@businessobjects.com. Business Objects does not warrant that this document is error free. Copyright 2003 Business Objects S.A. All rights reserved. Portions Copyright 1996, Microsoft Corporation. All rights reserved. Portions copyright 1994, 1995, 1996, 1997, 1998, 1999, 2000 by Cold Spring Harbor Laboratory. Funded under Grant P41-RR02188 by the National Institutes of Health. Portions copyright 1996, 1997, 1998, 1999, 2000 by Boutell.Com, Inc. Portions relating to GD2 format copyright 1999, 2000 Philip Warner. Portions relating to PNG copyright 1999, 2000 Greg Roelofs. Portions relating to libttf copyright 1999, 2000 John Ellson (ellson@lucent.com). Portions relating to JPEG copyright 2000, Doug Becker and copyright (C) 1994-1998, Thomas G. Lane. This software is based in part on the work of the Independent JPEG Group. Portions relating to WBMP copyright 2000 Maurice Szmurlo and Johan Van den Brande. Printed in France.

Trademarks

The Business Objects logo, WebIntelligence, BusinessQuery, the Business Objects tagline, BusinessObjects, BusinessObjects Broadcast Agent, Rapid Mart, Set Analyzer, Personal Trainer, and Rapid Deployment Template are trademarks or registered trademarks of Business Objects S.A. in the United States and/or other countries. Contains IBM Runtime Environment for AIX(R), Java(TM) 2 Technology Edition Runtime Modules (c) Copyright IBM Corporation 1999, 2000. All Rights Reserved. This product includes code licensed from RSA Security, Inc. Some portions licensed from IBM are available at http://oss.software.ibm.com/icu4j. All other product and company names mentioned herein are the trademarks of their respective owners.

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.2277013. U.S. Patent Numbers 5,555,403, 6,247,008 and 6,578,027. 301-10-610-01

Patents Part Number

System Administrators Guide for Windows

Contents
Preface Maximizing Your Information Resources 7 Information resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Useful addresses at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 About this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Chapter 1 Introduction to the Business Objects System 15

What is the Business Objects System? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Overview of the Business Objects System . . . . . . . . . . . . . . . . . . . . . . . . . 18 Advantages of Using a 3-tier System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Communication of System Components . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Enhanced Audit Facilities and Auditor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Administrating the System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 The Systems Administrative Layer Components . . . . . . . . . . . . . . . . . . . . 31 What Has Changed Since The Last Release . . . . . . . . . . . . . . . . . . . . . . . . 34

Contents

System Administrators Guide for Windows

Chapter 2

Administrating without the Console

41

The Business Objects System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Starting the System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Managing User Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Managing Default Options for New InfoView Users . . . . . . . . . . . . . . . . . . 52 Modifying Administration Console Access . . . . . . . . . . . . . . . . . . . . . . . . . 56 Allowing the Installation of BusinessObjects from InfoView . . . . . . . . . . . . 58 Stopping the Business Objects System . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 OLAP Administration Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Configuring OLAP Folder Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Security and Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Creating and Viewing Charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Setting the Connections to OLAP Data Sources . . . . . . . . . . . . . . . . . . . . . 71 Using the Essbase Configuration utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 The WebIntelligence Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Chapter 3 Administrating with the Console 79

Installing and Configuring the Administration Console . . . . . . . . . . . . . . . . 81 Starting the Administration Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 Security Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 The Administration Console Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Viewing Site Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Displaying the Global Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Refreshing Administration Console Display . . . . . . . . . . . . . . . . . . . . . . . . 99 Viewing Logged-in Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Authentication Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Specifying Authentication Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Contents

System Administrators Guide for Windows

Chapter 4

Managing Servers and Modules with the Administration Console

113

Enabling and Disabling Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 The session stack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 Enabling and Disabling Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 What Module Parameters Can You Set? . . . . . . . . . . . . . . . . . . . . . . . . . . 127 To Modify the Settings of the Session Stack . . . . . . . . . . . . . . . . . . . . . . . 128 To Modify the Settings of Any Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 WIDispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 WISessionManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 WIStorageManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 WIADEServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 WIAPIBroker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 BOManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Broadcast Agent Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 WIReportServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 Administration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 WILoginServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 WIQT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 Chapter 5 Tracing System Activity 181

What Types of Tracing Methods are Available? . . . . . . . . . . . . . . . . . . . . 183 The Audit Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 Activating the Audit Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 Storing Audit Information in File Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 Storing Audit Information in Database Mode . . . . . . . . . . . . . . . . . . . . . . . 201 Monitored Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 The Business Objects Trace Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243 Index 251

Contents

System Administrators Guide for Windows

Contents

Maximizing Your Information Resources

preface

System Administrators Guide for Windows

Overview
Information, services, and solutions
The Business Objects business intelligence 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.

Maximizing Your Information Resources

System Administrators Guide for Windows

Information resources
Whatever 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 Roadmap The 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 products You 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 web The 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 documentation You 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 CD Search 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.

Information resources

10

System Administrators Guide for Windows

Multimedia Are you new to Business Objects? Are you upgrading from a previous release or expanding, for example, from our desktop to our web solution? Try one of our multimedia quick tours or Getting Started tutorials. All are available via the Online Customer Support (OCS) website or on 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 & Tricks Open 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 documentation We 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 Online Developer 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 feedback


Do you have a suggestion on how we can improve our documentation? Is there something you particularly like or have found useful? Drop us a line, and we will do our best to ensure that your suggestion is included in the next release of our documentation: documentation@businessobjects.com
NOTE

If your issue concerns a Business Objects product and not the documentation, please contact our Customer Support experts. For information about Customer Support visit: www.businessobjects.com/services/support.htm

Maximizing Your Information Resources

System Administrators Guide for Windows

11

Services
A global network of Business Objects technology experts provides customer support, education, and consulting to ensure maximum business intelligence 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 Support Our 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 web site: www.businessobjects.com/services/education.htm

Services

12

System Administrators Guide for Windows

Useful addresses at a glance


Address
Business Objects Documentation www.businessobjects.com/services/ documentation.htm

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

Business Objects Documentation mailbox documentation@businessobjects.com Product documentation www.businessobjects.com/services/ support.htm

Feedback or questions about documentation.

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

Business Objects product information Information about the full range of Business Objects products. www.businessobjects.com Developer Suite Online www.techsupport.businessobjects.com Knowledge Base (KB) 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. 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. Practical business-focused examples.

Tips & Tricks www.businessobjects.com/forms/ tipsandtricks_login.asp

Maximizing Your Information Resources

System Administrators Guide for Windows

13

Address Online Customer Support www.techsupport.businessobjects.com

Content

Starting point for answering questions, resolving issues. Information about registering with Worldwide Customer Support. The range of Business Objects training options and modules.

www.businessobjects.com/services Business Objects Education Services www.businessobjects.com/services/ education.htm

Business Objects Consulting Services Information on how Business Objects can help maximize your business intelligence investment. www.businessobjects.com/services/ consulting.htm

Useful addresses at a glance

14

System Administrators Guide for Windows

About this guide


The System Administrator's Guide for Windows to administrators how to run and administrate the Business Objects system in a Windows environment.

Audience
This guide is intended for systems administrators who already have a working knowledge of the operating system(s) on which the system is running (Microsoft Windows or UNIX).

Conventions used in this guide


The conventions used in this guide are described in the table below.

Convention This font

Indicates 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. Placed at the end of a line of code, the arrow symbol indicates that the next line should be entered continuously with no carriage return.

Some code

more code

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

Maximizing Your Information Resources

Introduction to the Business Objects System

chapter

16

System Administrators Guide for Windows

Overview
This manual introduces the Business Objects system and the administration concepts it entails. The main focus is on the Administration Console from which you carry out most of your administration tasks; it also covers more detailed administration issues so that you can improve your system and ensure its optimal performance. This section describes the Business Objects system architecture and introduces its primary components.

Introduction to the Business Objects System

System Administrators Guide for Windows

17

What is the Business Objects System?


The Business Objects system relies on a distributed solution that gives business users the ability to access, analyze, and share information in intranet, extranet, and e-business environments. From an administration standpoint, it provides IT departments with the tools they need to effectively control and manage enterprise-wide and inter-enterprise user access. At its core are the Business Objects analytical reporting tools, such as the fullclient version of BusinessObjects and WebIntelligence, the industry's leading thin-client tool for query, reporting, and analysis. These also include: InfoView, the portal interface with which users can browse document lists and view documents stored in the repository and on the Business Objects server Broadcast Agent with which users can schedule documents for automatic refresh and distribution 3-tier BusinessObjects which brings end users all the power of the full-client version The Business Objects system has a distributed component architecture and light query applets available in either Java or dHTML, eliminating the need for clientside installation and maintenance of application software and database middleware. It leverages Internet technology to operate on an intranet perfect for service staff in the office and sales people in the field or over an extranet, becoming a critical business channel for partners, suppliers and customers. It is a lowmaintenance, cost-effective way to deploy wide sophisticated business intelligence capabilities across geographically dispersed environments. For more information about these products, see the Deployment Guide.

What is the Business Objects System?

18

System Administrators Guide for Windows

Overview of the Business Objects System


The Business Objects system architecture is based on a distributed solution and can be divided into three specific areas: The client The web browser, which provides the gateway to the Business Objects system. The middle tier includes - The presentation layer - The Business Objects processing layer (functional servers) Database components The database components comprise the repository and corporate database. This is where much of the data is stored, and where system security is controlled.

Introduction to the Business Objects System

System Administrators Guide for Windows

19

The client
Users access the Business Objects system through the InfoView portal which provides them with personalized access to their organizations information. This portal consists of a set of HTML pages generated by the application server and displayed through a client Web browser equipped with ActiveX capability and a Java Applet component. Users can view, refresh and distribute all the documents to which they have access rights. They can also access WebIntelligence and 3-tier BusinessObjects.There is no client-side administration of the Business Objects system neither application software nor database middleware is required on the client desktop.

The middle tier


The middle tier includes both the web layer and the business layer. Together they communicate with the other tiers to handle security and connectivity information and handle all the processing of requests coming from the client. This tier also provides programming access to the systems server components for developers who want to customize the solution.

Overview of the Business Objects System

20

System Administrators Guide for Windows

The presentation layer The presentation layer contains the web and application servers in short, all the presentation layers used to generate the HTML and DHTML used in InfoView and WebIntelligence. It also contains all the communication and data translation layers that enable lightweight components to communicate with the system using the standard web HTTP protocol. The web server stores static web pages like document lists, and bitmaps used in InfoView. The application server processes dynamic pages and hosts active components. It: Processes dynamic server pages (ASP/JSP pages), generating InfoView and WebIntelligence HTML and DHTML pages with dynamic content, viewed through the web browser on the client. Hosts API components (WICOM/RECOM/Wibean/Rebean) which act as proxies enabling dynamic server pages to call the functions in the Business Objects processing layer through the CORBA protocol. In this case, proxies are intermediary entities that accept requests from clients then route them elsewhere for processing. Hosts web applications such as the new WebIntelligence servlet, and the HSAL and exterior ISAPI used by lightweight client components such as the WebIntelligence applet, the InfoView ActiveX viewer and 3-tier BusinessObjects to communicate with the cluster using the web protocol. These components also act as proxies, sending incoming requests from the client on to the Business Objects processing layer. - The HSAL is a component which receives HTTP user requests for Business Objects services and sends them to the WIDispatcher using CORBA. For detailed background information on the role of the application and web servers in the Business Objects system, refer to the Deployment Guide. The Business Objects processing layer The Processing layer consists of the HTTP server and Business Objects system components, linked together by CORBA calls in an Application Server Framework (ASF) environment. The Business Objects processing components are the functional backbone of the Business Objects server products. Often called modules, these processes handle: user login and authentication, by default checking with the Business Objects central repository for valid authentication information

Introduction to the Business Objects System

System Administrators Guide for Windows

21

the creation and cessation of all Business Objects user sessions, and tracking of all user activity from the time they log in until they log out the generation of document lists the creation, processing, distribution, storage and caching of BusinessObjects, WebIntelligence and third-party documents

The client applications access these processing components through APIs (WIReportServer, WIAPIBroker) and interface components (WIDispatcher) hosted within the cluster. API and interface components are usually hosted by the primary node but can in some cases be replicated on secondary nodes for failover. To find detailed information about all these components, as well as how to administrate them in the Administration Console refer to What Module Parameters Can You Set? on page 127.

Database components
The data server tier contains repositories and corporate databases: A Business Objects repository contains security data, documents and universe definitions. A universe is the business-intelligent semantic layer that maps to data in the database, in everyday terms that describe your business situation. Users create BusinessObjects and WebIntelligence documents using a universes objects and classes which map to the required data in the corporate database. A corporate database is a source of the actual data used in BusinessObjects and WebIntelligence documents.

What Products use the Business Objects System?


Every enterprise server product in the Business Objects product line uses the Business Objects system. They are: WebIntelligence InfoView Broadcast Agent 3-tier BusinessObjects WebIntelligence SDK For more detailed information on the different products, refer to the Deployment Guide.

Overview of the Business Objects System

22

System Administrators Guide for Windows

Advantages of Using a 3-tier System


In a 3-tier architecture, server products share common server resources. These products can be installed on a single server or distributed over several servers. The latter type of installation is often referred to a distributed deployment. In this case, Business Objects modules, or processes, can run on different machines, which the system automatically recognizes as well as the distributed services at runtime. This solution enables you to scale up the Business Objects system as demand grows by adding more servers to the system to share the transaction load and provide failover capabilities. This way, if one server fails, the system automatically redirects requests to another functioning server. Whether the 3-tier solution is deployed over a single machine or over several, the set of server nodes hosting Business Objects components is called a cluster. For more information, see Cluster overview on page 23. The Business Objects system relies on the Application Server Framework (ASF) for communication between components, which are also distributed across the system. The Business Objects system thus provides customers with three major benefits: Failover A 3-tier system provides failure recovery. When components are installed on more than one node in the cluster, the system can continue to use the same required components on other nodes, if one node stops working. Nevertheless, the primary node is a single point of failure: if it goes down, all secondary nodes go down with it. For more information on where and when to enable Business Objects modules, see Enablement Rules on page 123. Scalability User populations on the Internet can be substantial. 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 balancing Optimal response times are ensured because the 3-tier system automatically performs load balancing across component servers. Distributing components over several servers also allows you to decide which components are activated where, thus optimizing the use of server resources, reducing the workload on the web server, and increasing performance.

Introduction to the Business Objects System

System Administrators Guide for Windows

23

A key part of the Business Objects 3-tier, distributed system is implemented via the Application Server Framework (ASF) based on a CORBA-compliant object request broker (ORB) licensed from Iona Orbix 2000 Software. For more information on 3-tier architecture, see the Deployment Guide.

Cluster overview
A cluster is the basic unit in a 3-tier Business Objects solution. A cluster is made up of one or several nodes that collectively provide the functional operation of a given portal. Clusters can contain two elements: One node is called the primary node and serves as the central coordinator between all the nodes in the cluster. There must be one and only one primary node in a cluster; if the cluster contains only one node, it is a primary node. Secondary nodes, each of which runs the ORB components required to communicate with the primary node and start Business Objects processes on the node, as well as optional services.

Secondary node 1

Secondary node 2 Web Server Primary node

Secondary node 3

In another deployment possibility, you can install the ASF and the application server on a separate machine situated between the web server and the primary node, which can be protected on both sides by a firewall. In this deployment, the machine housing the ASF is called the client node.

Advantages of Using a 3-tier System

24

System Administrators Guide for Windows

Firewall

Firewall

Secondary node 1

Secondary node 2 Web Server ASF and application server = Client node Primary node

Secondary node 3

NOTE

Only one node can be configured per server machine. Primary node The primary node performs the following services: It tracks and manages processes throughout the system using WIProcessManager. It also runs the WIStorageManager that handles the systems storage. It records various system and user activities. It may run a session stack, a group of modules required to process any one user session. The primary node occupies a critical position in the Business Objects system. If it or one of its solution-wide processes (such as WIProcessManager) fails, the entire system needs to be stopped and restarted.

Introduction to the Business Objects System

System Administrators Guide for Windows

25

Secondary node Secondary nodes rely on the primary node which provides the infrastructure that enables multiple servers to work together. Each secondary node, as well as the primary node, runs a session stack, a group of modules required to process any one user session. One of these modules is WISessionManager, which maintains the behavior of each session. You can configure a secondary node to run only a subset of the full set 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. The next chapters will give you detailed information on how to administrate the primary node and secondary nodes.

Cluster servers and time zones


All the servers of the same cluster must be in the same time zone. In addition, the server running WIStorageManager module must be set to at least the same time as the other servers in the cluster. If this server is set to a later time than the other servers, the servers cache mechanisms may not work correctly. For Windows servers, you can do this by setting the Time Zone (in Control Panel, Regional Settings) to the same value for all servers.

Advantages of Using a 3-tier System

26

System Administrators Guide for Windows

Communication of System Components


Both CORBA and ASF are the backbone of the Business Objects system. They make it possible for the different system components to communicate with each other. Indeed this communication is essential in order for each component to carry out its functional task.

The Application Server Framework


The ASF simplifies and standardizes the behavior of CORBA servers, and provides additional benefits such as improved load balancing and failover. This light application server: Encapsulates all calls to the ORB in a single abstraction layer Manages the object life cycle, handling creation, activation, registration, deactivation and so forth Manages the distribution of objects between the nodes in a cluster Improves load balancing and failover Provides an interface for administering secondary nodes and their components The ASF is started and stopped when the node on which it resides is started and stopped. For more information on the ASF and on how it is different from the CORBA layer, refer to the Deployment Guide.

How do CORBA clients and servers communicate?


Clients and servers use a common interface called an IDL (Interface Definition Language) to communicate. This interface describes methods implemented by the server objects, as well as the arguments passed to those methods. Within a CORBA context, the Business Objects systems specific modules or processes are designed as CORBA server objects. On the CORBA node, a Portable Object Adapter (POA) manages the entire object life cycle the creation and activation of objects as well as their deactivation and removal. The CORBA architecture allows applications to communicate with one another no matter where they are in a network, or who developed them. CORBA communication is provided through vendor-dependent middleware called the Object Request Broker, or ORB. The ORB establishes the client-server relationships between objects (services or processes) by routing requests from clients to objects, then responses from objects back to their client.

Introduction to the Business Objects System

System Administrators Guide for Windows

27

Using an ORB, a client can transparently invoke a method on a server object, which can be on the same machine, or across a network. The ORB intercepts the call and finds an object that can implement the request, pass it the parameters, invoke its method, and return the results. For more detailed information on CORBA and the ASF, refer to the Deployment Guide.

Communication of System Components

28

System Administrators Guide for Windows

Security
The Business Objects system provides the tight security required to protect data in todays networked world. By leveraging the existing Business Objects security infrastructure and authentication methods, the system provides access to corporate data only to users with the appropriate authorization.

Authentication methods
The system provides the following authentication methods for identifying users and controlling the resources that they can access: Business Objects standard Basic authentication Windows authentication No authentication For more detailed security information, see Authentication Methods on page 102.

Web security standards


The Business Objects system is designed to work with web security standards such as the Secure Socket Layer (SSL), which protects data transferred over the network from unauthorized access through the use of advanced encryption algorithms. Communication between the Web server and the client can be secured using SSL, however communication between the web server and the Business Objects system cannot be secured using SSL. This isnt necessary as the system sits behind a firewall. For more information on SSL, see the Deployment Guide, as well as your HTTP server documentation.

Introduction to the Business Objects System

System Administrators Guide for Windows

29

Enhanced Audit Facilities and Auditor


The Administration Console provides you with a powerful Audit facility that lets you monitor the requests and processes passing through the system. This information is critical for system troubleshooting, but can also be used to invoice customers for their use of the system. You can store all this information in a log file, directly in a database, or both. You can gather even more precise information for individual modules using log files, which trace all the activity for a specific Business Objects system module on a specific server machine. For more information about the Business Objects systems Audit facility, see Tracing System Activity on page 181. You can also monitor and analyze the information you obtain with the Audit facility using BusinessObjects Auditor. Auditor is a web-based product that provides you with valuable information on your Business Objects deployment, enabling you to optimize your Business Intelligence solution. For more information on Auditor, refer to the BusinessObjects Auditor Users Guide.

Enhanced Audit Facilities and Auditor

30

System Administrators Guide for Windows

Administrating the System


All Business Objects enterprise server products come with the Java-based Administration Console, which you use to administrate the Business Objects system:

The Administration Console lets you administrate and tune the overall system. For example, it lets you enable and disable servers on a cluster, enable and disable modules on servers, and trace system and user activity. It also lets you set parameters which determine how and when particular processes are launched, the type of processing activity allowed on a particular server, process timeouts, and so on. Although some administrative tasks are required before you can use the system, you are free to repeat them as you use the system to discern user habits and avoid performance bottlenecks. In this way, you can use the Console to tune your system to perform at its best under every type of circumstance For detailed information about the Administration Console, see Administrating with the Console on page 79 and Managing Servers and Modules with the Administration Console on page 113.

Introduction to the Business Objects System

System Administrators Guide for Windows

31

The Systems Administrative Layer Components


The 3-tier systems administrative layer is implemented as a set of server components communicating together via the CORBA layer. For a complete explanation of how these modules interact, see the Deployment Guide. This layer enables the system to respond to client requests from InfoView, WebIntelligence, 3-tier BusinessObjects and Broadcast Agent. It also makes it possible to troubleshoot any issues that may arise through use of the system. On each machine, the installer sets a central component to start these modules and provide administration features. The administrative layer is primarily serverside, except for the Administration Console client component, in which some of these server components are displayed and can be set. Although some components are platform-specific, the administration layer is designed as a cross-platform framework. Heres a quick reference to all the executables in the administrative layer:

The Systems Administrative Layer Components

32

System Administrators Guide for Windows

Executable WIProcessManager

Description WIProcessManager is the ASF daemon which actually manages the Business Objects systems process life cycle. WIProcessManager: manages cluster activity (active/inactive nodes, previously handled by WIClusterNode/WIClusterManager) starts and stops Business objects processes and monitors their activity by restarting them if they fail handles load balancing (previously handled by WIGenerator and restricted to WIQT, now extended to all processes through their Node Weight parameter) manages all Administration Console workflows (previously routed through WIClusterNode/WIClusterManager) creates and manages theWIQT process pool. This pool contains a set of preregistered WIQT processes, which are allocated to a unique WIQTsession. Each WIQT manages one session. When this session is created, a WIQTprocess is reserved in the pool and declared in the ORB. When theWIQT process terminates, the session context is released, put back into the pool, and reallocated to another process. It is started by the WIProcessManager on the primary node machine. It provides the MachineManager and Broadcast Agent Manager with objects on the machine. It also exposes the SiteManager object, which provides central information like language and product version. The WIClusterManager also exposes the list of .key files for key file synchronization.

WIClusterManager

WIClusterNode

It is started by the WIProcessManager on each secondary node machine. It uses the SiteManager exposed by the Primary node to synchronize the cluster with the .key file.

WIAdminBOTools

This process is used as an external tool by the site manager to get the list of Broadcast Agents from the repository when needed. It provides all Business Objects security-compliant features.

Introduction to the Business Objects System

System Administrators Guide for Windows

33

Executable WISiteLog

Description This process provides a server object for auditing features, registered with the ORB. It runs on the primary node machine. The audit object lets you log events in text files or in a database through a Business Objects security-compliant connection.

WINotify

A Windows graphical tool hosted by the task bar, providing: The immediate status of the node Product start / stop on the machine A link to administration help A link to the Administration Console Product version information Iona Orbix 2000 processes.

itconfig_rep itnaming itnode_daemon itlocator

The Systems Administrative Layer Components

34

System Administrators Guide for Windows

What Has Changed Since The Last Release


Certain changes have been made to the Business Objects system and to the Administration Console, which are documented in more detail in this manual. For an overview of what has changed since version 5, see the table below. For those who are new to Business Objects products, just skip this section.

Introduction to the Business Objects System

System Administrators Guide for Windows

35

What has changed Business Objects architecture and terminology

What is was Communication between all Business Objects server components was provided by a CORBA (Common Object Request Broker Architecture)compliant object request broker called Visibroker.

What it is now Communication between all Business Objects server components is provided by: The new CORBA-compliant object request broker Orbix 2000 The ASF (Application Server Framework) that encapsulates Orbix 2000 and provides the communication framework for Business Objects modules. The name has been changed to primary node and secondary node to adapt to ASF terminology. The functions are still primarily the same.

The main node in a cluster was called cluster manager and the other nodes were called cluster nodes.

Cluster activity (active/inactive Cluster activity is now managed by nodes) was managed by the the administrative layer executable administrative layer executables WIProcessManager. WIClusterManager and WIClusterNode. New instances of multi-instance Pools of multi-instance modules are modules were registered and created at system startup, ready to started as requests for them be used as requests come in. were received. Visibroker configuration required In Orbix 2000, this parameter no a server parameter called the longer exists. It has been replaced OSAgent Port. by a set of ports and a cluster name that are required to configure Orbix 2000. Visibroker relied on two processes: oad and osagent. These processes no longer exist. They have been replaced by the Orbix 2000 processes: itconfig_rep, itnaming, itnode_daemon, and itlocator.

What Has Changed Since The Last Release

36

System Administrators Guide for Windows

What has changed Administrative Layer components

What is was Requested shutdowns were managed by the WIAdmToolStop process. WIKill was used to destroy server processes when ORB components crashed and registered servers had to be killed.

What it is now WIAdmToolStop no longer exists. Its functions are handled by the WIProcessManager. WIKill no longer exists. Its functions are handled by the WIProcessManager.

WIOrbwas used to start/stop the WIOrb is no longer used, unless you CORBA layer and the start the noce as a service. WebIntelligence processes.

Introduction to the Business Objects System

System Administrators Guide for Windows

37

What has changed Administration Console

What is was All modules on a node could be started and stopped independently.

What it is now To improve performance, seven modules, all of which are required in the processing of any one user session, now form the session stack. When the session stack is started or stopped, all modules in the session stack start or stop. They cannot be started or stopped independently of one another. The modules in the session stack are: WIAPIBroker WISessionManager WIQT (pool) WIReportServer (pool) WIDispatcher WIADEServer BOManager (and its pool of bolight processes) To process user sessions, each node must have a session stack. All processing for any given user session is done by the session stack on one node. The session stack modules communicate with one another via intramachine calls rather than CORBA inter-machine calls.

WISessionManager was run on the primary node (formerly cluster manager) only.

WISessionManager is part of the session stack on each node.

InfoView users could not choose If the cluster locale language is a their interface language. supported Western European language, InfoView users will not be able to choose Japanese. If the cluster locale language is Japanese, InfoView users will not be able to choose any Western European language.

What Has Changed Since The Last Release

38

System Administrators Guide for Windows

What has changed Administration Console (continued)

What is was Authentication mode was a parameter of WISessionManager. You had to run a web server to access the Administration Console through the web. Administrators logged into the Administration Console using a Windows system administrator's login and password.

What it is now Authentication mode is a parameter of WILoginServer. The Administration Console is deployed on an application server. Administrators log into the Administration Console through the new WILoginServer. User access is defined in the repository. Only users allowed to connect to Supervisor can connect to the Console. Users specific rights are defined using security command sets in Supervisor.

Once connected, the administrator may perform all operations in the Administration Console. The location of the Administration Consoles executable

$INSTALLDIR\server\system2.5 $INSTALLDIR\bin\administrator.exe \bin\administrator.exe

Introduction to the Business Objects System

System Administrators Guide for Windows

39

What has changed Administration Console User Interface

What is was

What it is now

The tool was called the Business The tool is now called the Objects Services Administrator. Administration Console. The Administration Console contained: Information Action bar View pages No Logout and About box features were provided. The Monitor one more Broadcast Agent and Stop Monitoring a Broadcast Agent buttons were used to create and delete a Broadcast Agent Scheduler. You could enable or disable the Broadcast Agent Manager module. They have been renamed to: Top bar Module pages A Logout and an About box button have been added to the top bar. These buttons no longer exist. They have been replaced by the buttons: Add Remove The Enable/Disable button no longer exists. It has been replaced by the buttons: Start all Stop all

The Audit facility parameters The Audit facility parameters are set were set on two different pages. on a single page. In the Audit facilitys database mode, there was a parameter called Empty cache to database every (number of seconds. The Empty cache to database every (number of seconds) parameter in database mode no longer exists. Automatic emptying of the cache is triggred by maximum log file size or the refresh period.

What Has Changed Since The Last Release

40

System Administrators Guide for Windows

What has changed Administration Tasks

What is was

What it is now

The cluster's language could be You can change the cluster's country changed. and charset. The country determines the language Events from only one cluster at a Multi-cluster auditing is possible. time could be saved in a database for auditing purposes. You could activate an internal trace for the modules: WIGenerator WIDispatcher WISessionManager The same audit database could not be used for more than one cluster manager. The internal tracing facility no longer exists. It has been replaced by an external tracing method.

The Business Objects system supports multi cluster auditing. This component no longer exists. Its functions are now handled by the application server.

Administrated Modules

The system contained the WIHSALManager module. The system contained the WIGenerator module.

WIGenerator no longer exists. A new WIQT module manages the Max. This module managed the WIQT active time and Max. inactive time parameters. processes and its parameters Max. WIQT active time Max. WIQT inactive time Node Load Factor was a WIGenerator parameter. N/A It has been replaced by Node weight, a host parameter. New modules have been added: WILoginServer Administration Server WIReportServer

Introduction to the Business Objects System

Administrating without the Console

chapter

42

System Administrators Guide for Windows

Overview
In this chapter you will find details on: Basic administration concepts from starting and stopping the Business Objects system Managing user access and installing 3-tier BusinessObjects through a web browser OLAP administration issues. These administrative steps do not require the use of the Administration Console.

The installation and node directory


In all nodes of the cluster, primary or secondary, all files installed for the Business Objects system are located in the root directory called $INSTALLDIR. Its default value is: C:\Program Files\Business Objects\BusinessObjects Enterprise 6 More specifically, important cluster-related files are located in: $INSTALLDIR\nodes\<hostname>\<clustername>. Configuration Tool creates this directory, its subdirectories and their content when the node is configured. It contains information that is important for the functioning of the cluster. It stores: configuration files user documents cluster log files key files (one bomain.key per cluster) session information templates universes For more information on how to install Business Objects products and configure the node, refer to the Installation and Configuration Guide for Windows.

Administrating without the Console

System Administrators Guide for Windows

43

The Business Objects System


To use the Business Objects system, you need to access Business Objects resources such as user access rights, the universes which represent the semantic layer to the corporate database structure, as well as existing documents meant to be shared throughout the company. In the Business Objects solution, company information is centralized through a relational data account called a repository. A repository contains three parts: Universe domains are meta-models of the database containing a description of the data to be accessed. Document domains contain the structures for storing shared documents and for executing tasks according to a timestamped definition. The security domain is the most important domain and contains the characteristics of the other domains as well as user definitions and access rights. Before any user request can be processed, it must first pass through this domain so that the user can be identified and the database query checked against the users access rights. Business Objects users machines must recognize the address of the security domain, as it is through the security domain that they can communicate with the other domains of the repository in a transparent manner. The address of the security domain is located in a critical .key file called the bomain.key. This file can be generated on a Windows machine where Business Objects Supervisor has been installed. By default, the supervisor saves this file in the $INSTALLDIR\locData folder. Refer to the Supervisors Guide for more information. If you are working with a Business Objects server installation you will need to copy the bomain.key file into the following directory on the machine: $INSTALLDIR\nodes\<hostname>\<clustername>\locdata You can also generate the bomain.key file with the wmainkey.exe command located in: $INSTALLDIR\bin For more information, refer to the Installation and Configuration Guide for Windows. A cluster of Business Objects machines supports only one security domain at a time. There must be only one .key file in this locdata directory, called bomain.key.

The Business Objects System

44

System Administrators Guide for Windows

To install Business Objects resources, you must use the Desktop Products option of the installer program. For more information on this topic, see the Installation and Configuration Guide for Windows.

Administrating without the Console

System Administrators Guide for Windows

45

Starting the System


To start your system properly you have to start all nodes in your cluster. The primary node must be started first for your cluster to function properly and for users to be able to log in InfoView. On each machine on your cluster, you may start the node in any of the three following ways: Using the Start menu Using WINotify Using the Services Control Panel (automatic startup)

Starting the system using the Start menu


You can start the Business Objects system on any machine using the Start menu: 1. Click the Start button. 2. Point to Programs then Business Objects. 3. In the Business Objects submenu, click start server (6.1).

Starting the system using WINotify


WINotify is a utility that you can use to start and stop the Business Objects system, check its status, as well as access and define settings for the Administration Console. It also allows you to verify your WebIntelligence version number and licensing information. WINotify appears in the system tray. Checking system status To check whether the Business Objects system has been started, place your cursor on the WINotify icon until a popup help tip appears. This help tip tells you whether the system is running. You can also assess system status simply by looking at the icon: When the Business Objects system is running, the icon is colored. When the system is stopped, the icon is gray. When the system is starting or stopping, the icon flashes.

Starting the System

46

System Administrators Guide for Windows

Starting the system You can start and stop the Business Objects system using WINotify: 1. If the Business Objects system is stopped, right-click the WINotify icon. A shortcut menu appears:

2. Select the Start WebIntelligence command.

Starting the system using the Services Control Panel


You can also start the Business Objects system on a particular server using the Services Control Panel. Its easier to start the system using the WINotify icon or the Start menu, but the Services Control Panel also lets you configure each machine to start its Business Objects processes automatically at machine startup. See Configuring an automatic start of the system on page 47. This is also a way to start the system in the event of a problem such as the inadvertent deletion of the WINotify icon or WebIntelligence commands from the Start menu.
NOTE

If you plan to start up all the servers in a workgroup configuration, you must start the primary node first!

Administrating without the Console

System Administrators Guide for Windows

47

To start the Business Objects system using the Services Control Panel: 1. Open the Services Control Panel from Administrative Tools in the Control Panel by double-clicking the Services icon:

2. Find the WebIntelligence entry in the Service list: The WebIntelligence Cluster service launches the WIProcessManager which in turn starts and controls all of the processes that run on the server. 3. Select WebIntelligence Cluster service and click the Start button. 4. If you have multiple machines in your cluster that havent been started, repeat this process to start each of them.

Configuring an automatic start of the system


You can also configure WebIntelligence Cluster service to start automatically on a machine whenever you reboot the machine through the Services Control Panel: 1. Open the Services Control Panel from Administrative Tools in the Control Panel by double-clicking the Services icon. 2. Select the WebIntelligence Cluster service entry in the Service list and double-click it. The WebIntelligence Cluster properties dialog box opens:

Starting the System

48

System Administrators Guide for Windows

3. Select the Automatic option in the dropdown menu next to Startup Type. 4. Click OK. The Business Objects system is now configured to start automatically whenever the server restarts.

How webi.bat starts the node


Whatever methods you have chosen to start the node, they all run the webi.bat command. This command is located in the following directory: $INSTALLDIR\<hostname>\<clustername> You can also start the node manually by running the webi.bat start command. When invoked with the startup mechanism the webi.bat command: sets the environment for the ASF creates a backup directory in $INSTALLDIR\nodes\<hostname>\<clustername>\config\servers and saves important configuration files (localnode.xml, module parameter files) in this folder.

Administrating without the Console

System Administrators Guide for Windows

49

launches the web server, if the start sequence of the web server is manually uncommented in the webi.bat command launches the application server, if the start sequence of the application server is manually uncommented in the webi.bat command starts the ASF layer then WIProcessManager

Once the WIProcessManager is launched it starts the processes defined in the localnode.xml file (located in $INSTALLDIR\nodes\<hostname>\<clustername>\config). The localnode.xml file describes the processes to be started on a given node. You can modify the settings in this file using the Administration Console.

What processes start when the Business Objects system starts?


The following processes run on the primary node and secondary nodes once you start the Business Objects system:

Business Objects Processes WIProcessManager WIClusterManager WIClusterNode WILoginServer WISiteLog WISessionManager WIStorageManager WIDispatcher BOManager WIApiBroker WIAde WIAdminServer BcaScdul

Primary Node Yes Yes No Yes, unless disabled Yes Yes, unless disabled Yes, unless disabled Yes, unless disabled Yes, unless disabled Yes, unless disabled Yes, unless disabled Yes, unless disabled One process per Scheduler created and started

Secondary Nodes Yes No Yes No No Yes, unless disabled No Yes, unless disabled Yes, unless disabled Yes, unless disabled Yes, unless disabled No One process per Scheduler created and started

Starting the System

50

System Administrators Guide for Windows

Business Objects Processes WIReportServer BusObj

Primary Node Yes, unless disabled

Secondary Nodes Yes, unless disabled

Yes, unless disabled Yes, unless disabled As many as specified in the BOManager modules Min. number of loaded processes parameter Yes, unless disabled Yes, unless disabled

WIQT

Orbix Processes itconfig_rep itnode_daemon itnaming itlocator .

Primary Node Yes Yes Yes Yes

Secondary Nodes No Yes No No

Administrating without the Console

System Administrators Guide for Windows

51

Managing User Access


You add and delete users, change their passwords and permission levels using Supervisor. The users you create will also need to have access to Business Objects resources such as universes and existing corporate documents. These resources are referenced in the repository. The bomain.key file points to the repository which contains information about both BusinessObjects and WebIntelligence users. The security domain is the most important domain in the repository. It contains the characteristics of the other repository domains as well as user definitions. Before any user request can be processed, it must first pass through this domain so that the user can be identified and the database query checked against the users access rights. If the user has the appropriate access rights, the request can go through. To manage users with Supervisor, see the Supervisors Guide.

Managing User Access

52

System Administrators Guide for Windows

Managing Default Options for New InfoView Users


End users can customize the look, feel and functionality of InfoView by setting options in the InfoView Options page. They can, for example, define the page that opens when they launch InfoView, and what that page looks like, the type of Web Panel they use for creating and modifying WebIntelligence documents, and the type of viewer they use to view BusinessObjects documents. As a Business Objects system administrator, you must have a Business Objects supervisor profile. This lets you define not just the default Personal Options settings, but also use Supervisor to prevent unauthorized users from changing them.

Administrating without the Console

System Administrators Guide for Windows

53

Defining default Options page settings


To define new users default Options page settings: 1. Log into InfoView using your general supervisor user name and password. 2. Click the Options link in the top bar on the top right hand corner. The Options page opens. 3. Select the options you wish to apply under the Display, List, View, and Create tabs. 4. Click the About tab. The About page opens:

5. Under Default Settings click the OK button next to Set my options as Server Defaults. 6. Click Apply. It will apply all the options you have just selected. 7. Any new users you create in Supervisor will have these default settings when they first log into InfoView. For a description of the user options, refer to the InfoView Users Guide.

Managing Default Options for New InfoView Users

54

System Administrators Guide for Windows

To cancel existing InfoView Options page defaults, delete each individual user profile in the Business Objects Storage folder: $INSTALLDIR\nodes\<hostname>\<clustername>\Storage\user\<username> A master profile is stored in the master.txt file in: $INSTALLDIR\bin\Config

Preventing users from modifying default settings in Options Page


You can prevent users from updating their default Options page settings. There are different sections of the options page that you can make unavailable to users by modifying certain security commands in Supervisor. For example, to prevent users from customizing the interface, you must do the following: 1. In Supervisor, click the user or group in the tree list on the left, then doubleclick the WebIntelligence icon in the Configuration pane on the right. 2. In the Command Restrictions dialog box, select the Customize the Interface security command in the InfoView security command family of WebIntelligence:

Administrating without the Console

System Administrators Guide for Windows

55

3. Select Disabled from the Status list, then click OK. Users will no longer see the Display tab in InfoView. If you do not want to hide the Display tab, but just want to prevent users from changing their skins: 1. In the Command Restrictions dialog box, select the Change skins security command in the InfoView security command family of WebIntelligence. 2. Select Disabled from the Status list, then click OK. Users will still see the Display tab in InfoView, but will no longer see the options for skins.
NOTE

There are many more restrictions you can set in Supervisor for the Options page. For detailed on all of the security commands you can set for InfoView, refer to the Supervisors Guide.

Modifying the Default Formats for WebIntelligence Documents


You can customize the default fonts and table formats used in the WebIntelligence Java Report Panel by modifying the defaultConfig.xml file. For IIS ASP the file is under the following directory: $INSTALLDIR\nodes\<hostname>\<clustername>\IIS\1\wiasp\AppletConfig\ For Apache JSP, the file is located at: $INSTALLDIR\nodes\<hostname>\<clustername>\APACHE\MasterWebSer ver-<portnumber>\wijsp\scripts\AppletConfig\ You can customize the default fonts and table formats used in the WebIntelligence HTML Report Panel by modifying the config.js file. For Tomcat JSP, the file is located at: $INSTALLDIR\nodes\<hostname>\<clustername>\TOMCAT\\webapps\wijsp \querywizard\config\config.js

Managing Default Options for New InfoView Users

56

System Administrators Guide for Windows

Modifying Administration Console Access


You can change the URL you use to access the Administration Console under Windows by modifying Administration Console properties. Together, these properties constitute the beginning of a URL that will be used to access the Administration Console. These properties consist of: The HTTP protocol used by the Administration Console server. You can choose from two protocols: http or https. The first indicates that the server will conduct standard data transmissions with clients; the second indicates that the HTTP server has been configured to encrypt those transmissions using Secure Socket Layers (SSL). For more information on SSL, refer to the Deployment Guide, as well as your HTTP server documentation. The name of the machine on which the Administration Console is installed The value for the TCP/IP port of the web server you want to access As you modify each property, the corresponding part of the URL in the Resulting URL area of the screen dynamically changes. To modify Administration Console server properties: 1. Position your cursor on the WINotify icon in the status area of the Windows task bar.

2. Right-click the WINotify icon. 3. Select Administrator Properties from the shortcut menu. The Administration Console Properties dialog box appears.

Administrating without the Console

System Administrators Guide for Windows

57

4. Select the HTTP protocol you want to use from the list. Remember, https means the server has been configured to use SSL. 5. Select the name of the machine with the copy of the Administration Console installed on it that you want to use. The Host name drop-down list contains the names of all the secondary nodes and the primary node in the system for which an HTTP server or CGI protocol was included in the Business Objects installation. If the desired host name isnt in the list, you can type it in. 6. If you need to, modify the value for the TCP/IP port. 7. Now check the URL in the Resulting URL area of the screen. If its correct, do one of the following: Click OK to save the settings and close the screen. Click the Launch Administration Console button if you want to immediately launch the Administration Console using the new URL.

Modifying Administration Console Access

58

System Administrators Guide for Windows

Allowing the Installation of BusinessObjects from InfoView


If you want the systems users to be able to install BusinessObjects 6.1 through InfoView and use it properly: The Business Objects supervisor must grant those users: The right to use the BusinessObjects product (in the Configuration tab of the Resource pane in Supervisor) If the user is to be able to run the macros and add-ins that can be included in BusinessObjects documents, the supervisor must also grant the right to download Visual Basic for Applications from the Business Objects system (right-click on BusinessObjects, choose Properties, click on the Programmability tab, select the Download VBA from WebIntelligence server option) The right to access the WebIntelligence document lists (enable the Read Corporate Documents and Read Inbox Documents command sets) By default, this right is enabled. The right to create documents (enable the Create Documents command in the BusinessObjects Documents command set family) By default, this right is enabled. A user name and password For more information, see the Supervisors Guide. Universes must be made available to the users: These users can use universes stored locally on the client, as well as universes exported to the repository. They cannot, however, use universes stored on the Business Objects cluster. The supervisor must grant these users the right to access universes, and the proper database connections must be set, using Supervisor. For more information, see the Supervisors Guide. The Business Objects systems WIADEServer module is used to install 3-tier deployments of BusinessObjects 6.1 from the server to clients. This module must be enabled on the server on which the server product 3-tier BusinessObjects is installed.

Administrating without the Console

System Administrators Guide for Windows

59

Users must make sure that: They are using a Windows machine. The BusinessObjects option is selected as the type of document they want to create in the Personal Options page of their InfoView. The machine theyre using permits the installation and use of ActiveX controls. The browser security settings required to download signed ActiveX controls and plug-ins are enabled.

How users install BusinessObjects from InfoView


As an end user, you must do the following to install and use BusinessObjects 6.1 from a web browser: 1. Log into InfoView. 2. Click Options in the top bar to go to the Personal Options page. 3. In the Create/Edit section of that page, select the BusinessObjects option, then click the Apply All Changes button.

4. To begin installation, click the Download and Install BusinessObjects next to the BusinessObjects option. The BusinessObjects 6.1 Installation Wizard appears.

Allowing the Installation of BusinessObjects from InfoView

60

System Administrators Guide for Windows

5. Click the link to begin setup. 6. Follow the wizard instructions to download the installation package, then install the required software components onto the client machine. On-line help is downloaded as well. When installation is complete, the BusinessObjects Query Panel opens in a separate window.

Administrating without the Console

System Administrators Guide for Windows

61

7. To create a BusinessObjects document, proceed exactly as you would using the full-client version of the product. From now on, you can use BusinessObjects to create documents either through the Create Documents link in InfoView, or using the Start menu command created on your PC by the installer. For more information on this type of installation, see the InfoView Users Guide. See the BusinessObjects Users Guide for information on building queries and creating BusinessObjects documents. Can you track who has installed BusinessObjects in this manner? Because you as administrator are not notified when a user installs BusinessObjects from an InfoView session, you can trace when BusinessObjects is launched and by whom using the Audit facility. For more information, see Events Recorded in the Audit Database on page 201.

Working in offline mode


Depending on the type of deployment and the rights users have been granted, BusinessObjects users can choose to work in offline mode, that is without a connection to the WebIntelligence server. In this case, users indicate they are going to work in offline mode when they log into the product. To authenticate the user, BusinessObjects re-uses the information cached in the local .lsi (Local Security Information) file. This file contains the users security information, profile, command restrictions and authorized documents and universes. Once theyre logged in, users can work on documents stored locally, reviewing and analyzing their data. If users create a new document or refresh an existing one, however, BusinessObjects must be able to connect to the database. It therefore opens a new online session on the WebIntelligence server, using the ID and password with which the user originally logged in. Being able to work offline saves system resources for only the most essential processing.

Allowing the Installation of BusinessObjects from InfoView

62

System Administrators Guide for Windows

Stopping the Business Objects System


When stopping a cluster configuration, you must shut down the secondary nodes first and then the primary node. First be sure that all users are logged out. You can prevent new logins by setting the Prevent logins parameter to off in the WISessionManager. For information on WISessionManager parameters, see WISessionManager parameters on page 132. You can stop the system in several ways: Using the Start menu: - Click Start | Programs | Business Objects. - In the submenu click stop server (6.1). Using WINotify: - Right-click the WINotify icon in the status bar. - Select Stop WebIntelligence from the shortcut menu Using the Windows Control Panel, stop the WebIntelligence Cluster service in the Services Control Panel.

How webi.bat stops the node


All of these methods call the webi.bat command located in the following directory: $INSTALLDIR/nodes/<hostname>/<clustername> When invoked with the stop argument the webi.bat command stops all modules with the WIProcessManager, then stops the ASF layer. The shutdown mechanism stops the components in the reverse order of startup. It: 1. stops the application server and all dependent web applications 2. stops the web server 3. stops the ASF communication layer

Administrating without the Console

System Administrators Guide for Windows

63

OLAP Administration Concepts


This chapter gives you an overview of OLAP administration issues. It gives information on: Configuring OLAP Folder Security Security and Authentication Creating and Viewing Charts Setting the Connections to OLAP Data Sources The WebIntelligence Interface This guide deals with OLAP administration only; it does not cover the differences between OLAP servers, Essbase/DB2OLAP servers, or SAP - Business Warehouse connectivity. For further details on this subject, refer to the WebIntelligence for OLAP Users Guide. For information on OLAP installation refer to the Installation and Configuration Guide for Windows.

OLAP Administration Concepts

64

System Administrators Guide for Windows

Configuring OLAP Folder Security


When installing WebIntelligence OLAP on Windows 2000, you should configure the OLAP folder according to the table below:
$INSTALLDIR\nodes\<hostname>\<clustername>\IIS\1\wiasp\viewers\owr\OLAP

Security Setting Domain name, user name and password Rights

Value Must be valid. Should ideally be the same as the user name and password specified during the Business Objects installation. Local administrator rights

Administrating without the Console

System Administrators Guide for Windows

65

Security and Authentication


An authentication method is a means of identifying users and controlling the resources they can access. Nevertheless, setting up authentication may affect users access rights to the OLAP cube and whether they may view and create charts. Therefore, you must set up security on the \wiasp\olap virtual directory so that users can access Microsoft cubes. This virtual directory is mapped to:
$INSTALLDIR\nodes\<hostname>\<clustername>\IIS\1\wiasp\viewers\owr\OLAP

Security can be set up in three different ways: Anonymous Access Basic Authentication Windows authentication

Anonymous access
Anonymous access requires the least administration and provides the lowest level of security. Every user can log on anonymously and is not prompted for a user name or password. Every user can access every cube. You need to create only one role in OLAP services for the anonymous user. Anonymous access works with Microsoft Internet Explorer. The Business Objects server and the OLAP server can be installed on different machines. For information on how to configure anonymous access, see Specifying IIS Authentication on Windows 2000 Server on page 67. When to use anonymous access If you are using Microsoft SQL Server Analysis Services: You can use anonymous access if you want to grant all users access to all OLAP cubes. You will also need to enable anonymous users the rights to create and view charts. For information on how to give users rights to create and view charts, see Creating and Viewing Charts on page 68.

Security and Authentication

66

System Administrators Guide for Windows

If you are using Essbase or SAP Business Warehouse: Business Objects recommends you use anonymous access on the IIS server because Microsoft security doesnt affect cube access for Essbase. Essbase has its own security, so therefore you wont need to give specific access rights to cubes from IIS. You will nonetheless need to grant users the ability to create and view charts. For information on how to do this, see Creating and Viewing Charts on page 68.

Basic authentication
Basic authentication requires more administration and provides more security than anonymous access. Every user is prompted for an NT user name and password when they access the OLAP server. The user name and password are sent as encrypted text. Each user can be granted access to only certain cubes. You need to create a role for every user in OLAP services. Basic authentication works with Internet Explorer only. The Business Objects server and the OLAP server can be installed on different machines. When to use basic authentication You can use basic authentication if you want to restrict each users access to different cubes and if you require more security on the cube itself. You must also give users the rights to create and view charts. A simple way of doing this for all users is by adding the role "authenticated users" and granting them the appropriate privileges. For information on how to enable users to create and view charts, see When using Windows authentication or basic authentication on page 69. You can create a shared NT user name and password for multiple users, so that users log in using a different NT user name than the one they use to log into the network. This reduces the number of roles that you must create in OLAP services. For more information, see When using Windows authentication or basic authentication on page 69.

Windows authentication
Windows authentication passes each users NT user name to the OLAP server. You need to set up a role for every user in Microsoft Analysis Services. Windows authentication works with Internet Explorer only.

Administrating without the Console

System Administrators Guide for Windows

67

Furthermore, Windows authentication may not work correctly if the Business Objects server and OLAP server are installed on different machines. In this case, authentication sometimes fails because the web server does not send the user name to the OLAP server. Further information about the benefits and pitfalls of setting up Windows authentication across your network can be found on the Microsoft web site (www.microsoft.com) and in Microsoft documentation. When to use Windows authentication You should use basic authentication if you require high security and also want to restrict each users access to different cubes. You must also give users the rights to create and view charts. To see how to set this option for NT Challenge/Response, see When using Windows authentication or basic authentication on page 69.

Specifying IIS Authentication on Windows 2000 Server


To specify authentication for the OLAP folder in IIS version 5.0: 1. Start the Internet Services Manager from Administrative Tools in the Control Panel. 2. Right-click the olap folder (beneath the Default Web Site and wiasp folders) and select Properties from the shortcut menu. 3. Select the Directory Security tab. 4. Click the Edit button beside Anonymous access and authentication tool. The Authentication Method dialog box opens. 5. Select the desired option: Anonymous access, Basic authentication, or Integrated Windows authentication. 6. Click OK to apply the options. 7. Click Exit from the Internet Information Services menu to exit the Internet Services Manager.
NOTE

Make sure the account you select has administrative rights on the server and is a member of the domain with access rights in MSOLAP server databases. This account is usually the Business Objects administrator account.

Security and Authentication

68

System Administrators Guide for Windows

Creating and Viewing Charts


To enable users to generate and read charts using OLAP, you first need to give them access to the following directory: $INSTALLDIR\nodes\<hostname>\<clustername>\temp To set these privileges: 1. Right click on the above directory and select Properties. 2. Select the Security tab. The following dialog box appears:

3. Select the anonymous user under Name and check the Read & Execute, List Folder Contents, Read and Write check boxes under Permissions. The charts will not be displayed if these privileges arent applied.

Administrating without the Console

System Administrators Guide for Windows

69

When using Windows authentication or basic authentication


If you are using Windows authentication or Basic Authentication for the IIS application server and you want users to be able to generate and read charts, you have two options: 1. Right click on the Temp directory and select Properties. 2. Select the Security tab. 3. Under Name, either - Select the users and enable the Read/Write privileges under Permissions for every user. - Or add Authenticated Users and apply the Read/Write privilege. This saves you having to add and manage each WebIntelligence OLAP user individually.

Tracking chart access


To track which user is being used to access a chart: 1. Right click on the Temp directory and select Properties. 2. In the Properties dialog box, click the Security tab. 3. Click the Advanced button under Permissions. 4. Select the Audit tab and add the users you want to audit. Click OK. Close the Properties dialog box. 5. Open the Administrative Tools dialog box in the Control Panel and click on Local Security Policy. The Local Security Settings dialog box opens.

Creating and Viewing Charts

70

System Administrators Guide for Windows

6. Expand the Local Policies folder and open the Audit Policy folder. 7. Select Audit object access and enable the auditing facility. The event log file enables you to track exactly which user is being used to access a chart.

Administrating without the Console

System Administrators Guide for Windows

71

Setting the Connections to OLAP Data Sources


To create a new connection to an OLAP data source and to edit or delete an existing connection you must use the OLAP data source buttons. You can only add or edit an OLAP data source if you are a general supervisor for the repository.

Creating a connection
To create a connection to an OLAP data source: 1. In the InfoView Home page click OLAP under New Document.

2. The WebIntelligence OLAP Report Panel page opens. Click New to display the Create OLAP Data Source page.

3. In the OLAP Data Source Name field, enter a name for the connection. This name will appear in the list of connections as shown below. 4. Select the provider from the OLAP Server listbox. The table below shows how this provider is displayed in the list of connections.

Setting the Connections to OLAP Data Sources

72

System Administrators Guide for Windows

5. In the Server Name field, enter the name of the server to which you want to connect. This name will appear in the list of connections as shown below. 6. Enter a description for the connection. This is optional.

Name of provider shown in the Create OLAP Data Source screen (SQL 7.0 or later) SAP Business Information Warehouse Essbase DB2 OLAP

Name of provider
shown in INFOVIEW

Name used in this guide

Microsoft OLAP Services MSOLAP MDRMSAP Essbase Essbase

Microsoft SAP BW Essbase DB2 OLAP Essbase DB2 OLAP

Administrating without the Console

System Administrators Guide for Windows

73

7. Click Save to create the connection. An OLAP administrator must also grant access to web users to the databases and cubes on the server. The new connection is displayed in the WebIntelligence OLAP Report Panel page.

Editing a connection
To edit a connection to an OLAP data source: 1. In the InfoView Home page click OLAP under New Document.

2. Check the check box next to the connection that you want to edit.

Setting the Connections to OLAP Data Sources

74

System Administrators Guide for Windows

3. Click Edit. The following page opens:

4. Change the server name or description. 5. Click Save.

Administrating without the Console

System Administrators Guide for Windows

75

Deleting a connection
To delete a connection to an OLAP data source: 1. Click Create Documents in the InfoView navigation bar on the left side of the screen. 2. Click OLAP Data Sources to display a list of the current connections.

3. Select the connection that you want to delete. You can delete more than one connection at a time.

4. Click Delete. 5. A dialogue box is displayed. Click OK to confirm that you want to delete the connection.

Setting the Connections to OLAP Data Sources

76

System Administrators Guide for Windows

Using the Essbase Configuration utility


The Essbase Configuration utility allows WebiOLAP to connect to either Hyperion Essbase or IBM DB2OLAP data sources. The utility causes the Essbase/DB2OLAP middleware to create a file, Essbase.ID, in the C:\WINNT directory. The middleware needs this file in order to connect to the server. The following conditions are necessary to use the utility: The utility should be run on the machine with the WebiOLAP installation. The logged-on user must be an administrator of the machine in order for the file to be created in the C:\WINNT directory. The Essbase/DB2OLAP middleware must already be installed on the machine. To run the utility: 1. Allow the utility to run from the Configuration Tool, or else use the Windows Explorer to navigate to the utilitys executable, EssConfig.exe, located in $INSTALLDIR\bin, and double-click. The Essbase System Login dialog box appears. 2. Click Cancel to exit the dialog box. No login is required in this box for the utility to work. The Essbase.ID file is created in the C:\WINNT directory.

Administrating without the Console

System Administrators Guide for Windows

77

The WebIntelligence Interface


This section contains details of issues relating to the WebIntelligence interface.

Interface restrictions
The restrictions of the WebIntelligence user interface are listed in the following sections: Changing the password on first login There is no interface to support the scenario in which users need to change their password when first logging into an OLAP server. Users must change their password prior to connecting to the OLAP server via InfoView. Drilling on dimensions with a large number of children Dimensions with thousands of children may cause an error in displaying values when drilled down. You may move the dimension and then filter the dimension in the member selection dialog. Report limits The maximum number of columns allowed is 256; the maximum number of rows is 1000.

Changing the interface look and feel


The entire look and feel of WebIntelligence is controlled by a cascading style sheet. The name of the file for this cascading style sheet is oawStyle_IE.css. It is located in the directory:
$INSTALLDIR\nodes\<hostname>\<clustername>\IIS\1\wiasp\viewers\owr\OLAP

This is a standard HTML cascading style sheet. It can be edited using any text editor. It is highly recommended that you do a backup of this file prior to making any modifications.
NOTE

Use a simple text editor such as Notepad to edit oawStyle_IE.css. Do not use a proprietary HTML editor, because this kind of editor often modifies the HTML code in unexpected ways.

The WebIntelligence Interface

78

System Administrators Guide for Windows

Any of the existing attributes can be modified. New styles can also be created using any of the existing attributes. Using any other attributes can cause unexpected results. Using spaces in the name of a style can also cause unexpected results. After modifying the oawExceptions.css file, users of WebIntelligence OLAP must relaunch their browsers before the changes will take effect. Further documentation about cascading style sheets is available from the World Wide Web Consortium (W3C): http://www.w3.org.

Administrating without the Console

Administrating with the Console

chapter

80

System Administrators Guide for Windows

Overview
The Administration Console is a Java applet that acts as a control panel for overseeing a Business Objects cluster. It is run through a browser or as an application on Windows. The Administration Console lets you monitor and control all the nodes and modules in your system: It gives you an overview of the current status of each server machine and module in your system. It allows you to enable and disable individual modules and grouped modules called session stacks throughout your system. This allows you to start and stop a 3-tier distributed system from one place. It lets you set module parameters. You can use it to end user sessions. You can also use it to trace various types of activity in the system. The Administration Console lets you perform all these tasks from a single machine, regardless of how many servers are part of your 3-tier configuration. Although many of these tasks are required before you can use the system, you may have to repeat them as you use the system. You will discern user habits and performance bottlenecks and use the Console to tune your system to perform at its best under every type of circumstance.

Administrating with the Console

System Administrators Guide for Windows

81

Installing and Configuring the Administration Console


When you install Business Objects products on a Windows machine you are given the choice of installing the Administration Console: As a Java applet accessed through a browser. One machine in the cluster must be configured with an application server that hosts the Administration Console. The application server sends Administration Console requests to the administration layer on the server side. As an application (administrator.exe) available as a standard Desktop Product on Windows. This program makes a direct call to a Java Virtual Machine (Java 2) to make it run the Administration Console. Administration Console requests are directly sent to administration layer. This may be useful when the cluster is used exclusively to deploy Broadcast Agent and an HTTP server is therefore unavailable. For more information, see the Broadcast Agent Administrator's Guide. To use the Administration Console you have to: Install the Administration Console (executable and/or applet) as well as the the Business Objects server and the Configuration Tool. Run the Configuration Tool to configure the ORB. If you want to access the Administration Console through a browser you must configure it to run as a web application using the Configuration Tool. For more information, refer to the Installation and Configuration Guide for Windows.

Installing and Configuring the Administration Console

82

System Administrators Guide for Windows

Starting the Administration Console


To use the Administration Console you must first start the cluster. You can start the Administration Console: As a web application from a web browser if you have deployed the Administration Console in a web server. As a Windows application from any machine on which your Business Objects system is installed.

Starting the Administration Console as a web application


To access the Administration Console from any supported web browser, open your browser and type the following URL: http://<host>:<port>/<directory> where: "<host>" and "<port>" are the hostname and the port value of the web server on which you have deployed the Administration Console. "<directory>" is the name of the directory specified in the Configuration Tool when deploying the Administration Console. By default, this directory is wiadmin. For more information on how to configure and deploy the Administration Console, refer to the Installation and Configuration Guide for Windows.
REMINDER

If you're using a secure HTTP server, replace "http" with "https". For information on setting the HTTP protocol, see Modifying Administration Console Access on page 56.

Administrating with the Console

System Administrators Guide for Windows

83

On the machine where the server is installed and running, you can also use the WINotify icon to open the Administration Console in a browser. Ensure your system is started and do one of the following: Double-click the WINotify icon is located in system tray.

Or right-click the WINotify icon, then point to Administration Console.

A new browser is started and the login screen opens. You may modify the URL you use to access the Administration Console in Administration Console Properties from the WINotify menu. For more information see Modifying Administration Console Access on page 56.

Starting the Administration Console as a Windows application


To start the Administration Console from any Windows machine first ensure that the Business Objects system is running and then do one of the following: Run the administrator.exe command located in the $INSTALLDIR\bin directory. Click Start | Programs | Business Objects and select Administration Console 6.1 in the submenu. Right-click the WINotify icon, then point to Administration Console (.exe). The Administration Console executable is then started and the login screen opens. Running the administrator.exe command There are three ways to run administrator.exe: Navigate in the Windows Explorer to the adminstrator.exe file located in the

Starting the Administration Console

84

System Administrators Guide for Windows

$INSTALLDIR\bin directory and double-click. Choose the Run command from the Windows start bar, enter the path and filename, and click OK. Run it from the command line.

Starting the Administration Console from the command line To run the Administration Console from the command line, open the command prompt and set it to the $INSTALLDIR\bin directory, then run this command:
administrator.exe -user <username> -pass <password>

where <username> and <password> are the user name and password of a Business Objects user with a supervisor or general supervisor profile.

Administrating with the Console

System Administrators Guide for Windows

85

Logging into the Administration Console


The Administration Console no longer requires a system administrator login and password. To log in you use the same login that you use to access Supervisor. You must therefore have the right to connect to Supervisor and the correct security commands must be enabled. For information on the supervisor profiles needed to access the Console, see Security Commands on page 107.To log into the Administration Console do the following:

1. Type in your login name and password in the entry boxes. 2. Click the Login button, or press Enter before leaving the Password entry box. The login procedure begins.
NOTE

The login to the Administration Console is checked in the repository through the WILoginServer using Business Objects standard authentication. If the bomain.key doesnt exist, all logins are refused. Login information is always checked in the repository whatever the Authentication method used. For more information on authentication refer to Authentication Methods on page 97.

Starting the Administration Console

86

System Administrators Guide for Windows

Security Commands
With version 6.1 of the Business Objects system, administrators use a Business Objects user name and password as defined in the repository. To have access to the Administration Console, you must have one of the following profiles: general supervisor supervisor supervisor-designer versatile user (with supervisor rights) The actions these different profiles can carry out within the Administration Console can be restricted by applying specific security commands. With a general supervisor profile, you can restrict a supervisors, supervisordesigners and versatile users authorization by applying security commands in Supervisor. By default, supervisor, supervisor-designer and versatile user profiles do not have access to the Administration Console. As a general supervisor you must specifically give them permission to access the Administration Console by applying the different security commands. You can also restrict a supervisors, supervisor-designers and versatile users authorization by applying security commands in Supervisor.
NOTE

Security commands applied to users are only be taken into account once WILoginServer refreshes its cache, which by default is set to occur every 10 minutes. If you want to apply these changes immediately, you can refresh WILoginServer manually. See WILoginServer parameters on page 171.

Administrating with the Console

System Administrators Guide for Windows

87

The different security commands that may be applied for the Administration Console are shown below:

Commands which can be enabled/disabled Log into Administration Console Administrate clusters, modules and audit

Actions affected when the command is set to disabled The user cannot log into the Administration Console The user cannot: Stop or start clusters and modules Change cluster language Change log file names Change module parameters Change module instance number Stop or start audit facilities Change audit file names and parameters Initialize database arrays The user will not be able to stop user sessions The user will not be able to: Create or remove BCA Schedulers Stop/start Schedulers Change Scheduler parameters

Administrate user sessions Administrate Broadcast Agents

For more information on how to set these security commands in Supervisor, refer to the Supervisors Guide.

Predefined Settings in Supervisor


As a general supervisor, you can perform all operations in the Administration Console, as security commands do not apply to the general supervisor profile. As a supervisor, supervisor-designer or versatile user your authority may vary from being able to perform all operations to being permitted to carry out only a restricted amount of actions. This may depend on the security commands that have been enabled or disabled on your profile. In Supervisor you can apply predefined settings, which define a set number of security commands in one operation. The table below shows how the relevant security commands are set according to the predefined settings:

Security Commands

88

System Administrators Guide for Windows

Predefined Settings

Log into Administrate Administrate Administrate Administration clusters, user sessions BCAs Console modules and audit Inherit Disabled Inherit Inherit Enabled Inherit Disabled Disabled Disabled Enabled Inherit Disabled Disabled inherit Enabled Inherit Disabled Disabled Inherit Enabled

Default All revoked Novice Standard Expert


NOTE

These security commands dont apply to designers and end users, since they do not have access rights to Supervisor. For more detailed explanation of predefined settings and how to apply them, please refer to the Supervisors Guide.

Administrating with the Console

System Administrators Guide for Windows

89

The Administration Console Interface


The Administration Console gives you an overview of an entire Business Objects cluster; you can see at a glance which modules are running on each machine in the cluster, the language the cluster is using, and more. The Console also allows you to enable and disable modules on the various nodes in the cluster, as well as determine the node weight of every machine. When you start the Administration Console the following screen opens:

It displays the machines and modules installed in your system grouped by host to the left, and properties concerning the entire system to the right. The Administration Console interface is divided into four main sections: The Module pages at the left of the Administration Console allow you to choose how you want the host machines and modules in your Business Objects system displayed. You can organize this information either by host machine, by module, or you can display it in an easy-to-read tabular format. See Using the Module pages on page 86. The top bar at the top allows you to choose or update the information you need. This information can include site properties, audit information, access to online help, and about information on the product. There is also a logout button.

The Administration Console Interface

90

System Administrators Guide for Windows

The properties area beneath the top bar on the right displays the properties of the host machine or module selected in one of the Module pages, or as in the previous image, overall site properties. The status bar provides you with constantly updated system information, and displays error messages if you run into any problems. See Using the status bar on page 89.

Using the Module pages


There are three pages in the Administration Console, each of which displays the names of the machines and modules currently installed in your system in a different way. They are the Host, Module, and Report pages. When you click on the name of a machine or module in any of these pages, that elements properties are displayed in the properties area to the right. You can also use these pages to enable and disable your systems host machines and modules. The Host page The Host page looks like this:

Administrating with the Console

System Administrators Guide for Windows

91

This page lists all the machines in the current configuration. Beneath each machine name is a list of the modules that are installed on that machine. All the modules required for processing any one user session are grouped together and displayed as the session stack. These modules are always turned on and off together. Next to each machine, session stack, and module name is a checkmark or an X. If the machine, session stack, or module is enabled and functioning, a checkmark is displayed. If disabled, a red X is displayed. To collapse the display of a hosts modules, just double-click the hosts name. To expand display, double-click it again. The Module page The Module page looks like this:

This page lists all the modules in the system, grouped by module type. For each module type, there is a list of the various machines on which that module is installed. Session stack modules have a distinctive icon to distinguish them from the other modules. As with the Host page, enabled and functioning modules are indicated by a green checkmark, disabled modules by a red X.

The Administration Console Interface

92

System Administrators Guide for Windows

The Report page The Report page looks like this:

It lists in tabular form each module in the current configuration, the machine on which that module is installed, and a green checkmark or red X indicating whether the module is enabled or disabled.

Using the top bar


The Administration Console contains a six-button top bar which allows you to choose the type of information you want to display or to refresh the Administration Consoles information display:

Administrating with the Console

System Administrators Guide for Windows

93

These buttons are:

Name Logout Site Properties

Description Lets you log out of the Administration Console. Displays properties such as the enabled and disabled modules throughout the Business Objects system in the Administration Consoles properties area (see Viewing Site Properties on page 91). Refreshes Administration Consoles display (see Refreshing Administration Console Display on page 94). Displays information relating to the Audit facility. Opens the Administration Consoles online help. To view the online help, you need to enable your browser settings for Java and ActiveX. See below for more information. Displays information on copyright, product version number, etc.

Refresh Audit Help

About

Configuring your browser settings If you encounter problems viewing the contents of this online help, you need to change your browser security settings to run Java scripts and download ActiveX controls and plug ins. To configure your browser settings: 1. Open your Internet browser. 2. Click the Tools button on the browser toolbar, then click Internet Options. 3. Click the Security tab. 4. Select Local Intranet then click the Custom Level button. Your browser security settings appear. 5. In the ActiveX controls and plug-ins section, enable all the options. 6. In the Scripting section, enable all the options. 7. Click OK twice to apply the new settings.

The Administration Console Interface

94

System Administrators Guide for Windows

Using the status bar


The status bar is located at the bottom of the Administration Consoles screen:

It provides you with the most important system information, refreshed every 30 seconds. It contains five parts, from left to right: The first section displays the Administration Consoles status, such as Ready if your system is running fine. When you encounter errors, this section displays an appropriate error message. The second section is a progress indicator for Administration Console processes. While a process is in progress, this section fills and empties. When its clear again, the process has been completed. The third section tells you how many users are currently logged into the Business Objects system. The fourth section displays the number of server machines (host machines) in the Business Objects system. The fifth section indicates the number of enabled modules in the system.

Administrating with the Console

System Administrators Guide for Windows

95

Viewing Site Properties


You can view properties concerning the overall Business Objects system by clicking the Site Properties tab in the top bar:

This information includes: The number of host machines included in the Business Objects system The number of modules in the entire system The locale setting of the cluster, including language and country. Only one locale can be used for all the machines of the cluster The character set of the cluster Synchronization of key files The list of logged in users The global report

Viewing Site Properties

96

System Administrators Guide for Windows

Changing the locale and character set of your Business Objects server
The Locale dropdown list on the Site Properties tab includes all the installed languages and countries. To change the locale of your server, you must: 1. Select the new language and country from the Locale dropdown list InfoView users can choose the interface language they wish to use from among those installed for Business Objects products. If you select a Western European language for the cluster, InfoView users will not be able to select Japanese as their language. If you select Japanese, they will not be able to select a Western European language. 2. Select the new character set from the Character Set dropdown list. If no character set is supported for the language and country you selected from the Language and Country dropdown list, the selected value in the character set dropdown list is the first one in the list. 3. Click Apply.
NOTE

Additionally, you need to make sure the system locale in each machine of the cluster is the same, and change it if necessary. Then reboot each machine before restarting the Business Objects servers. For more information on changing the system locale, refer to the Installation and Configuration Guide for Windows. Th e role of WISessionManager Internally, it is WISessionManager that handles the locale and character set feature of the Administration Console. WISessionManager is a session stack module. If no session stack is available in the cluster, the locale and character set will not be available in the Site Properties page.

Administrating with the Console

System Administrators Guide for Windows

97

Synchronizing key files


The .key files that point the cluster nodes to the security domain of the repository with which they work are automatically synchronized when the system starts up. This means that the primary node copies the bomain.key file in its $INSTALLDIR\nodes\<hostname>\<clustername>\locdata folder to the same folder in the secondary nodes. This ensures that all nodes in the cluster are pointing to the same repository. The Site Properties tab contains a button that allows you to synchronize the bomain.key file in the cluster after the system has started. The .key file synchronization button is automatically enabled in the Site Properties page if there are more than two servers in a cluster. You should use this feature if you want to change the bomain.key file for the cluster, after changing it first on the primary node. You can also use this feature when Broadcast Agents have been assigned to the various nodes, or if a new secondary node is added to the cluster. To synchronize the bomain.key files: 1. Click Site Properties on the primary node. 2. Click .key file synchronization. The Administration Console automatically synchronizes the bomain.key files on all secondary nodes.
NOTE

Synchronization makes sure the secondary nodes use the same .key file as the primary node. This means that if there is no bomain.key file in the locdata directory on the primary node, any bomain.key files in the locdata folder on the secondary nodes will be deleted. You are prompted to confirm or cancel the operation if this is the case.

Viewing Site Properties

98

System Administrators Guide for Windows

Displaying the Global Report


The Global Report is an HTML page which gives you a comprehensive overview of the Business Objects system: the current enabled/disabled status for each module in the system where each module is located in the system (host machine and subnet) the parameters of each module on each node Note that this report includes no information about user activity in your system. If you want this type of information, see Viewing User Activity on page 185. To view a global report on your system and the machines in it, just click the Global Report button on the Site Properties page. The report opens beneath the Administration Console. If you are working with the desktop version of the Administration Console the overall report opens in a new window. To close the window simply click the Close button. .

Administrating with the Console

System Administrators Guide for Windows

99

Refreshing Administration Console Display


You can refresh the Administration Consoles display whenever you need to by clicking the Refresh button in the top bar at the top of the Console. When refreshed, the Administration Console displays any changes that may have occurred since it was launched or last refreshed. These can include recently added servers or modules, and the enabled/disabled status of these elements.

Refreshing Administration Console Display

100

System Administrators Guide for Windows

Viewing Logged-in Users


The status bar displays the number of users logged into the system. You can obtain a complete list of the users names by clicking the Logged-in users button in the Site Properties area. A new window opens that shows the user's name, inactivity period, and IP address of each user's machine or proxy server, depending on deployment. Users are displayed in order of connection.

You can use the Refresh button to refresh the data.


NOTE

Because the Administration Server does not rely on WISessionManager to manage its client sessions, you cannot view any of the Administration Server's users from the Administration Console.

Administrating with the Console

System Administrators Guide for Windows

101

Ending User Sessions


To end a user session, click the user name in the list and click the End selected sessions button. You can select multiple user sessions by clicking each user name while holding down the Ctrl and Shift keys. To close the window, click the Close button.

Viewing Logged-in Users

102

System Administrators Guide for Windows

Authentication Methods
An authentication method is a means of identifying users based on a user name and password. This includes determining the rights as they are set in Supervisor. Administrators determine the authentication method in the Administration Console. With version 6.1 of the Business Objects system the request for authentication goes through WILoginServer. The authentication method is a parameter of WILoginServer. For information on WILoginServer, see WILoginServer on page 173. The Administration Console offers several authentication methods for the Business Objects system as described below: Business Objects standard User name and password are checked in the repository. Windows authentication Windows authentication method in which the user name is checked against the Business Objects repository. The Business Objects system assumes that authentication has been made and grants access according to the rights associated with the user name. Basic authentication A widely used, industry standard method for identifying users. The Business Objects system assumes that authentication has been made and grants access according to the rights associated with the user name. No authentication This method does not involve connecting to the repository. All users are granted the same right to use reports and universes stored in their own file system or on a shared file system. There is no Inbox or Corporate Documents folder but only a Personal Documents folder.
NOTE

The Authentication methods that you select in the Administration Console only apply to InfoView and not to the Administration Console itself. The Authentication method for the Administration Console is Business Objects standard and cannot be modified. The main characteristics of these methods are summarized in the table below:

Administrating with the Console

System Administrators Guide for Windows

103

Method Windows authentication Basic authentication

Security High Medium/ High

Browser

Prompt

Internet Explorer (IE) None IE Authentication system user name and password Business Objects user name and password None

Business Objects Medium standard No authentication None

IE

IE

Each authentication method is explained in more detail in the following sections.

Windows authentication
Windows authentication is the Windows authentication method where the user name is not sent across the network. During this authentication process, the web server engages in a cryptographic exchange of information with the users Microsoft Internet Explorer browser, involving hashing. Windows authentication can use either the Kerberos v5 authentication protocol and its own NT Challenge/Response authentication protocol, for example. Once enabled, the primary node of your Business Objects system can use this authentication method under the following conditions: Anonymous access is disabled. Anonymous access is denied because Windows 2000 permission has been set up requiring users to provide a Windows 2000 user name and password before establishing a connection. When this authentication method is set, the user is not prompted for a user name and password when logging into InfoView. For more detailed information on the security issues relating to this method, see the Microsoft Windows documentation. When not to use Windows authentication This type of authentication should not be used in the following situations: When the Use BusinessObjects user name and password option is checked in the connectivity dialog box in Designer. Authentication will not work because the password is not transmitted by the web server to the Business

Authentication Methods

104

System Administrators Guide for Windows

Objects system.

Basic authentication
Basic authentication is a widely used industry standard method for identifying users. The primary node of your system can use basic authentication under either of the following conditions: Anonymous access is disabled. Anonymous access is denied because the web server has been set up to require users to provide a web server user name and password, before establishing a connection. When this authentication method is set, the web browser prompts users to enter their user name and password. When to use basic authentication You may use Windows authentication or basic authentication with Microsoft Internet Explorer. However, when you need to set up authentication for users using a browser other than Microsoft Internet Explorer, you should use basic authentication. For example, Netscape browsers understand basic authentication only. When not to use basic authentication This type of authentication should not be used in the following situations: When the Use BusinessObjects user name and password option is checked in the connectivity dialog box in Designer. Authentication will not work because the password is not transmitted by the web server.

Business Objects standard


When this authentication method is set, the Business Objects system prompts users to enter their user name and password. For more information on Business Objects security, see the Supervisors Guide.

No authentication
The Business Objects system provides a No authentication option, which may be appropriate for sites in which security or the sharing of documents is not an issue. With this option, users are able to log into the Business Objects system without entering a user name or password.

Administrating with the Console

System Administrators Guide for Windows

105

NOTE

In order for this option to work, you must remove the .key file that permits access to the repository (bomain.key). However, be careful not to remove the objects.lsi file.

Restrictions when using certain authentication methods


If you want to use the Use BusinessObjects user name and password option for the user or user group in Supervisor or for the Universe in Designer, do not select Basic authentication or Windows authentication, as this will not function in a 3tier distributed architecture. .

In this case, the authentication password is not transmitted by the web server.

Authentication Methods

106

System Administrators Guide for Windows

Specifying Authentication Methods


To configure the Business Objects system to use an authentication method, you must do the following: Specify the authentication method on the Web server. Select the authentication method in the Administration Console. Set up the account information for each InfoView user in Supervisor. If you are using any authentication method other than Business Objects standard, activate the correct authentication driver in the Business Objects client installation on every machine in the cluster. Be sure that the authentication method you set in the Administration Console is adapted to the one you chose for your web server as shown below:

Business Objects authentication Business Objects standard Windows authentication Basic authentication No authentication

Web server authentication Anonymous authentication Windows authentication Basic authentication Anonymous authentication

The steps for each task are described in the next sections of this chapter. Both the server and Business Objects administrators must perform each task on the primary node of the system.

Specifying the authentication method on the Web server


This section explains how to specify the authentication method for your systems Web server from: An IIS server An Apache server Completing authentication activation involves: Enabling the authentication method in the Administration Console Setting up account information for Business Objects users Activating the correct authentication driver (for client installations)

Administrating with the Console

System Administrators Guide for Windows

107

Specifying the authentication method for an IIS server To select the authentication method from the Microsoft Internet Information Service (IIS) Manager version 5.0: 1. Start the Internet Services Manager from Administrative Tools in the Control Panel. The Internet Information Services console appears.

2. Right-click the <WIDIR> folder where <WIDIR> is the name of the InfoView instance you selected in the Configuration Tool, by default wiasp (located within the Internet Information Service folder) and click Properties. The wiasp Properties dialog box appears.

Specifying Authentication Methods

108

System Administrators Guide for Windows

3. Click the Directory Security tab. 4. Click the Edit button. The Authentication Methods dialog box appears:

5. Click the desired option. 6. Click OK to apply the options.

Administrating with the Console

System Administrators Guide for Windows

109

7. Click Exit from the Internet Information Services menu to exit the Internet Services Manager.
NOTE

Business Objects recommends you restart the World Wide Web Publishing Service in the Services Control Panel if you have selected Windows authentication mode. Specifying the authentication method for an Apache server You can select the authentication method by editing the httpd.conf file. To do so you have to create a login and password using the htpasswd -c command. For more detailed information on how to set authentication for Apache, refer to the Apache documentation at www.apache.org.

Selecting the authentication method in the Administration Console


To enable the authentication method for system users: 1. In the Administration Console, click the WILoginServer module. 2. Click the desired authentication method in the Properties page. 3. Click the Apply button. For the authentication method to be taken into consideration you need to stop and restart the Business Objects server.

Specifying Authentication Methods

110

System Administrators Guide for Windows

Setting up account information for Business Objects users


The Business Objects supervisor sets up the account information for the Business Objects users in Supervisor. 1. Create a new user for each Business Objects user in Supervisor. 2. Keep, delete, or assign passwords as necessary. 3. Double-click the user to access the User Properties dialog box. 4. Make sure that Identification Strategy is set to Full Checking. 5. Click OK, then exit Supervisor. For more information on setting up accounts in Supervisor, see the Supervisors Guide.

Specifying the authentication method for client installations


On BusinessObjects client installations, you must configure the correct authentication driver if you do not want to use the Business Objects standard authentication method. Activating the correct authentication driver Three drivers are installed with the BusinessObjects client installation in $INSTALLDIR\bin: Driver KGLUIDRV.DLL Description Driver loaded by the Business Objects application. This driver must be a copy of KBOUIDRV.DLL or KNTUIDRV.DLL. By default, it is a copy of KBOUIDRV.DLL. Driver used for Business Objects standard authentication mode. Driver used for Windows NT authentication.

KBOUIDRV.DLL KNTUIDRV.DLL

By default, the KGLUIDRV.DLL driver is a copy of KBOUIDRV.DLL so the default authentication method used by the Business Objects application is Business Objects standard authentication mode. To change from one authentication mode to another you have to manually change the KGLUIDRV.DLL driver.

Administrating with the Console

System Administrators Guide for Windows

111

To activate the Windows NT authentication driver To change from Business Objects standard authentication to Windows NT authentication method do the following: In the $INSTALLDIR\bin directory: 1. Rename the KGLUIDRV.DLL file to KGLUIDRV.BAK for example. 2. Make a copy of the KNTUIDRV.DLL file and rename the copy to KGLUIDRV.DLL. To revert back to Business Objects authentication driver To change back from Windows NT authentication to Business Objects standard authentication do the following: In the $INSTALLDIR\bin directory: 1. Rename the KGLUIDRV.DLL file to KGLUIDRV.BAK for example. 2. Make a copy of the KBOUIDRV.DLL file and rename the copy to KGLUIDRV.DLL.

Specifying Authentication Methods

112

System Administrators Guide for Windows

Administrating with the Console

Managing Servers and Modules with the Administration Console

chapter

114

System Administrators Guide for Windows

Overview
You can use the Administration Console to set the parameters for all of the Business Objects system modules. This chapter explains the modules and their parameters and gives detailed information on how to administrate these within the Administration Console.

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

115

Enabling and Disabling Servers


To enable and disable a Business Objects server (also called a host), do the following: 1. In the Host or Module page, click the name of the machine you want to enable or disable. 2. In the Properties page a Start or Stop button is displayed depending on whether the machine is currently disabled or enabled.

3. Click the button for the desired effect. If you stop a server, all modules running on this server are also disabled. If you start a server, all modules that were running before the stop are restarted. If you stop a secondary node, only the modules on that node are affected, the cluster continues to be up and running. However, if you stop the primary node the entire cluster goes down.

Enabling and Disabling Servers

116

System Administrators Guide for Windows

When a server is disabled the following administrative layer processes continue to run: Orbix 2000 processes: - itconfig_rep - itnaming - itnode_daemon - itlocator Business Objects processes: - WIProcessManager - WIClusterManager (or WIClusterNode on a secondary node) - WISiteLog As long as the administrative layer is still running, the node is registered in the cluster and can be enabled again in the Administration Console.
NOTE

You can also enable and disable a server using the Services Control Panel. If you do so, however, you can no longer administrate the server and its modules using the Administration Console. For more detailed information, see Starting the system using the Services Control Panel on page 46.

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

117

Server Parameters
Clicking the host machine in the Module pages gives you the status on that machine displayed in the properties area. The primary node and the secondary nodes are set during configuration. They cannot be modified in the Administration Console. The properties page displays the information concerning the host machine you have selected in the Module page. The top part of the properties page indicates whether the host machine is a primary or a secondary node.

The start/stop button enables you to start or stop the host machine. For more information on how to start or stop servers, see Enabling and Disabling Servers on page 115.

Enabling and Disabling Servers

118

System Administrators Guide for Windows

Information/ Parameter Modules Network Info Node weight

Description Gives information on the number of modules enabled and disabled on the host machine. Displays the host machines IP address.

Default

The weight of the clusters global transaction 1 load that you want this machine to handle. By default this value is 1, but in fact the value is relative. What counts is the sum of the Node Weight for the entire cluster, and the proportion of that value represented by the Node Weight on each cluster machine. For example, if a particular secondary node machine is much more powerful than other nodes in the cluster, you can make sure it receives more of the transaction load by giving it a higher node weight than the other machines. Likewise, if one machine is particularly restricted, by giving it a low node weight, you can make sure it doesnt penalize the entire system. For more information see, Node Weight on page 119.

IIS auto-restart

Sets the IIS auto-restart parameter.

Off

The IIS auto-restart parameter The IIS auto-restart parameter is displayed in the host properties area only when a Microsoft Internet Information Server (IIS) is installed on the selected machine and is configured to be used with the Business Objects system. By default, whenever the system is running, the MachineManager monitors the IIS service every 15 seconds to make sure its running as well. If it isnt, the MachineManager automatically restarts it. This means that if the IIS auto-restart parameter is set to On, you cannot stop the IIS service as long as the system is running.

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

119

Load Balancing the System


The Administration Console lets you administrate a number of components in the Business Objects system. The main purpose is to ensure that these components are balanced out within the cluster for optimal capacity and performance. The following section gives you some information on the components and how they should be set in order to balance out the load and avoid single point of failure within the cluster. Distributing Transaction Loads Across the System The Business Objects system comes with a series of mechanisms which permit the system to provide optimal performance. A 3-tier deployment can scale to a greater number of users by automatically redirecting requests to the machines that are less loaded in the system. This capacity is called load balancing. To scale up, simply add machines. Multiple machines allow overloaded components to redirect request to less-used ones. You can use the same type of strategy with Business Objects system components, or modules. By having more than one of them activated in the cluster, you can enable them to share the transactions loads between them. You can make sure heavier transaction loads are automatically directed to the more powerful servers in the cluster for certain types of processing. You can also adjust how many process instances are launched on a server, in order to obtain the type of performance your users expect. Furthermore, you can dedicate certain nodes to certain types of processing and leave the others free for administration tasks for example. Node Weight Each machine on the cluster has a separate Node Weight that you can adjust in the Administration Console. There are potentially two different ways documents can be processed by the system: thin-client and full-client. There are two different kinds of processes for thin-client documents: WebIntelligence 2.6/2.7 documents, as well as third-party files, are processed using WIQT processes, managed by WIAPIBroker. WebIntelligence 6.x documents are processed by WIReportServer, which interacts with WIQT.

Enabling and Disabling Servers

120

System Administrators Guide for Windows

For information about how you can balance the load for these processes, see Thin-client process load balancing. Full-client, or BusinessObjects, documents are processed by BusinessObjects processes, managed by BOManager. For information about balancing the load for these processes, see Full-client process load balancing. Thin-client process load balancing The Business Objects system includes an improved means of distributing Business Objects processes in a cluster. The server module has a parameter called Node Weight which weighs the transaction load for that specific server. For example, if a particular secondary node machine is much more powerful than other nodes in the cluster, you can make sure it receives more of the transaction load by giving it a higher node weight than the other machines. Likewise, if one machine is particularly restricted, by giving it a low node weight, you can make sure it doesnt penalize the entire system. Now, when a new user session starts, instead of automatically sending the new transaction to the node running the fewest transactions, the WISessionManager sends it to the machine whose current session count/Node Weight ratio is the smallest. This is called the load ratio.
NOTE

Take for example a small cluster with two machines: Machine 1 is currently handling 30 user sessions, and has a Node Weight of 1000. Its load ratio is therefore 30/1000 (or 3/100). Machine 2 is currently handling 40 user sessions, and has a Node Weight of 2000. Its load ratio is therefore 40/2000 (or 2/100). Even though Machine 2 currently has a greater transaction load, its load ratio is smaller. The WISessionManager therefore sends the new session to it for processing.Server Parameters on page 117 For information about setting a servers Node Weight, see Server Parameters on page 117.

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

121

Full-client process load balancing Full client documents are processed using BusinessObjects processes governed by the BOManagers in the cluster. Each BOManager may be assigned parameters of minimum and maximum number of processes. When Broadcast Agent or an end user tries to view or refresh a full-client document, WIAPIBroker assigns a process to the first available BOManager. For information on how to set BOManager parameters, see BOManager parameters on page 147.

Enabling and Disabling Servers

122

System Administrators Guide for Windows

The session stack


Each node in a cluster has a group of seven modules which is called the session stack. At least one session stack must be enabled in the cluster. The modules in the session stack are those required to process any one user session. The session stack modules are: WIReportServer BOManager WIADEServer WIAPIBroker WIQT WIDispatcher WISessionManager All modules in the session stack are turned on and off together. The session stack is used to ensure that each user session is processed on a single node. The modules communicate using intramachine calls rather than inter-machine CORBA calls. This results in faster communication and higher performance. The WIReportServer and WIQT modules are implemented as a pool of instances. The maximum number of instances for each is set in the Administration Console and can be seen as a module parameter. The following modules are not part of the session stack and can be started and stopped individually: Administration Server WIStorageManager Broadcast Agent Manager WILoginServer

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

123

Enabling and Disabling Modules


You can enable or disable a session stack and its modules or individual nonsession-stack modules on any machine in the Business Objects configuration using the Administration Consoles Module pages: 1. In the Host or Report page, click the name of the session stack or nonsession-stack module you want to enable or disable. 2. In the Properties page an Enable or Disable button is displayed, depending on whether the module is currently enabled or disabled.

3. Click the button for the desired effect.

Enablement Rules
Only one WIStorageManager, one WILoginServer, and one Administration Server can run in a cluster. In addition, they must run on the primary node. This is why the Business Objects system automatically deactivates these modules on the secondary nodes by default after installation. It leaves all other modules enabled. By strategically coordinating where each process functions, you can optimize performance on the Business Objects system.

Enabling and Disabling Modules

124

System Administrators Guide for Windows

The following table indicates where and how Business Objects modules must be, should be, or can be enabled: This module can be ...on the primary ...on secondary enabled... node nodes WIDispatcher (session stack) At least one session stack must be enabled in the cluster. ...on multiple ...more than machines once on a single machine Yes Yes No Yes No No No No, but a single BOManager manages a pool of Business Objects processes. No, but a single Broadcast Agent Manager manages a pool of Schedulers No No No Yes, in a pool of processes No Yes, in a pool of processes

WISessionManager At least one session stack must be (session stack) enabled in the cluster. WIStorageManager Required BOManager (session stack) No At least one session stack must be enabled in the cluster.

Broadcast Agent Manager

Optional

Optional

Yes

WIADEServer (session stack) WIAPIBroker (session stack) WILoginServer WIReportServer (session stack) Administration Server WIQT (session stack)

At least one session stack must be enabled in the cluster. At least one session stack must be enabled in the cluster. Required No At least one session stack must be enabled in the cluster. Recommended No

Yes Yes No Yes No Yes

At least one session stack must be enabled in the cluster.

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

125

Example of a cluster configuration


The figure below shows the recommended configuration of modules on a cluster. What is important to keep in mind are the modules that must be activated on the primary node. For more detailed information on additional module configuration advice, see Additional deployment advice on page 126.
Bold text = Required on node Black text= Recommended on node Grey text = Optional on node Primary Node Session stack modules WIStorageManager WILoginServer Administration Server BCA Manager

Secondary Node Session stack modules BCA Manager

Secondary Node

Session stack modules BCA Manager

Enabling and Disabling Modules

126

System Administrators Guide for Windows

Additional deployment advice


The following table contains additional enablement advice to help you optimize your Business Objects system:

Modules WIStorageManager

Enablement Notes There can only be one WIStorageManager in a cluster, and it must be enabled on the primary node. When you start the Business Objects system, the primary node is the first machine thats started; the modules enabled on it are therefore the first processes to be launched. WIStorageManager must be among those processes for the system to function properly. There can be only one WILoginServer in a cluster and it must be on the primary node. BOManager is a session stack module that manages a pool of Business Objects processes. How many processes should you allow per BOManager? As a general rule of thumb, allow one BusinessObjects process for each user using full-client documents. You can set the maximum and minimum number of these processes you want to run on any session-stack-enabled node. For faster full-client document display, install a printer driver on any Windows node on which this module is enabled.

WILoginServer BOManager

Broadcast Agent Manager

Business Objects recommends that you enable Broadcast Agent Manager on at least two nodes per cluster, preferably on secondary nodes. This way, if one machine crashes, the system can still use the other Broadcast Agent Managers Scheduler for the automatic refresh and distribution of documents. We suggest you choose a machine with a low Node Weight. For more information, see Thin-client process load balancing on page 120.

Administration Server

You can enable the Administration Server only on the primary node.

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

127

What Module Parameters Can You Set?


The Administration Console lets you set parameters for the following modules: Session stack modules: - WIReportServer - BOManager - WIADEServer - WIAPIBroker - WIQT - WIDispatcher - WISessionManager WIStorageManager Broadcast Agent Manager Administration Server WILoginServer Each module has a specific function and a different set of parameters you can modify. The following sections give you a more detailed description of each module plus a list of the parameters that can be set for that particular module.

What Module Parameters Can You Set?

128

System Administrators Guide for Windows

To Modify the Settings of the Session Stack


The session stack includes all the modules required for handling a given user session on a given node. Each session-stack module has parameters of its own that can be set individually, as described in the section To Modify the Settings of Any Module on page 130. Two parameters are set for the session stack as a whole. Proceed as follows to modify the settings of the session stack of a server: 1. Select the session stack of a server. The two session-stack parameters appear on the right: Enable interactive processing and Enable batch processing.

2. Modify the parameter as desired. 3. Click Apply.

Session stack parameters


The session stack parameters are described below:

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

129

Parameter Enable interactive processing

Description When On, the session stack is used to process InfoView requests for viewing and refreshing BusinessObjects documents. When Off, this session stack cannot be used for processing such tasks. If the system cannot find another cluster server for which this setting is On, an error is displayed in InfoView. Notes: When you turn this setting from On to Off, BusinessObjects processes which are running finish processing the current task before they are stopped. This setting must be activated on both Windows servers and UNIX servers. If you havent installed WebIntelligence 6.x or if you do not have a WebIntelligence 6.x license, this parameter will be set to Off by default. It will not be possible to change it.

Default On

Enable batch processing

When On, Broadcast Agent uses this session stack to process scheduled BusinessObjects documents for Broadcast Agent. When Off, Broadcast Agent does not use this session stack to process scheduled BusinessObjects documents and will try to find another node for which this setting is On. Note: When you turn this setting from On to Off, BusObj processes which are running finish processing the current task before they are stopped.

On

To Modify the Settings of the Session Stack

130

System Administrators Guide for Windows

To Modify the Settings of Any Module


Proceed as follows to modify the settings of the individual modules of a server: 1. Select the module for one server in one of the Module pages. The Administration Console displays the modules parameters on the right hand side of its window. These parameters are described in the remainder of the chapter. 2. Modify the parameters as desired. 3. Click the Apply button. The new values for each parameter are sent to the module on the node.
NOTE

This applies to all modules except for Broadcast Agent. For information on how to set Broadcast Agent Manager parameters, see Broadcast Agent Manager parameters on page 160.

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

131

WIDispatcher
WIDispatcher is the router of the Business Objects system. It dispatches requests coming from the HSAL to the required processes. Whenever WIDispatcher receives a translated request from the HSAL/jHSAL, it first calls the session stacks WISessionManager to verify that the user is authenticated and the session is valid. It then decides which process the requests should be sent to, then converts the textual URLs into CORBA requests that can start the required Business Objects process. WIDispatcher calls WISessionManager, WIQT, and WIADEServer. WIDispatcher is part of the session stack.

WIDispatcher parameters
The WIDispatcher parameter is described below:

Parameter User activity log

Description See The Audit Facility on page 184.

Default Off

WIDispatcher

132

System Administrators Guide for Windows

WISessionManager
WISessionManager creates and manages sessions by associating a WIQT process with a Web cookie. It implements session behavior and tracks all activity from the time users log in until they log out. WISessionManager is part of the sessions stack.

WISessionManager parameters
The WISessionManager parameters are described below:

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

133

Parameter Session timeout

Description

Default

The maximum number of seconds a user 5400 s can be inactive before the session is stopped. Modifications to this parameter only affect new users who log in after this parameter has been changed. Users who are already connected are not affected.

Maximum users

The maximum number of users who can log into the Business Objects system. If the number of users already connected is higher than this limit, their sessions are not stopped.

10000

Prevent logins

If turned on, this parameter prevents any Off new user of the Business Objects system from logging in. Sessions of users already connected are not stopped. You can use this parameter to prevent new users from logging in before you stop the system. Once all other users have logged out, you can stop the system.

WISessionManager

134

System Administrators Guide for Windows

WIStorageManager
WIStorageManager manages the Business Objects systems cache and personal document storage areas (both for Personal Documents and Inbox Documents). It works using a storage area whose path is set during configuration. A Business Objects cluster must have only one WIStorageManager, installed on the primary node. WIStorageManager accelerates access to documents in the repository by storing a cache of reports and other files, such as document lists and category lists. WIStorageManager is one of the key modules in the system: WIAPIBroker, the BusinessObjects and WIQT processes talk to WIStorageManager. The BusinessObjects and WIQT processes do so when they want to store a document in the storage area; WIAPIBroker does so to get the list of documents in the storage area. WIStorageManager has two primary functions: It manages a cache for repository-related information, such as corporate and inbox document lists, and lists of available universes. The first time users log into InfoView, WILoginServer generates the .lsi file which contains the personal document lists; they are then saved to the repository cache. Whenever users need these lists, the system obtains them from the cache instead of having to connect to the repository again. It permanently stores the documents users have saved as personal documents in the systems storage.

Storage directory
By default, the storage directory is: $INSTALLDIR/nodes/<hostname>/<clustername>/storage This directory may be changed during the node's configuration. It includes four subdirectories: list mail user docs

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

135

The list directory The list directory contains the list of documents and universes users can access. It contains one subdirectory per user and each user directory stores four files: category.txt lists all the corporate categories for InfoView. corp.txt lists all the corporate documents a user is permitted to access. mail.txt lists all of the unread mail in a user's inbox. unv.txt lists all the universes a user can use. These lists are used to limit the number of connections to the repository. The mail directory The mail directory stores all of the documents in the inbox that have been read by users. It contains one subdirectory per user. When a document is sent to a user, it is stored in the repository and remains there until the recipient reads it. Once the user reads the document it is copied into that users mail subdirectory. Each user directory contains one text file and all the read documents: read.txt lists all of the documents in the user's inbox that have been read. read documents the documents are stored in this directory with all the of the document properties in the document name. The read documents are stored in this directory with all the properties in the document name. The user directory The user directory contains one subdirectory per user. This subdirectory stores two text files, the category files, and all of the users personal documents: profile.txt contains all the user settings. This file is created only when users change their settings in the InfoView Options page. attribut.txt contains a list of a users personal documents and related information. personal categories a .ctg file lists the personal categories. Each category file contains the list of documents that it contains. personal documents contains the documents that users have saved as personal documents.

WIStorageManager

136

System Administrators Guide for Windows

The docs directory The docs directory caches corporate documents and contains one subdirectory per document domain. Each document domain folder contains: cached corporate documents All corporate documents that have been opened/read are stored here so that they accessible to everyone without having to send a request to the repository. one subdirectory per BusinessObjects document contains the HTML version of the BusinessObjects documents opened using the HTML viewer. Deleting users When users are deleted in Supervisor their subdirectories are not removed from the Storage folder. For security reasons, Business Objects recommends that you manually delete a users subdirectories in the list, mail, and user directories. For information on how to delete users, refer to the Supervisors Guide. When users are deleted using the Administration Server, their directories are automatically deleted. For more information on the Administration Server, refer to the Customizing Administration Guide.

WIStorageManager parameters
The WIStorageManager parameters are described below:

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

137

Parameter User activity log Duration

Description See The Audit Facility on page 184. The maximum amount of time that documents remain in the repository cache before being flushed. Note: If this parameter is set to 0, the corporate document cache is disabled and corporate documents are directly retrieved from the repository. Before the cache is disabled, all corporate documents that were copied in the cache are deleted.

Default Off 72 hours

Storage maximum size

The maximum amount of space allocated for storage on this server If the storage size is bigger than the allocated storage size, the system will delete the documents with the oldest last accessed time.

100 MB

WIStorageManager

138

System Administrators Guide for Windows

Parameter Storage lower limit

Description The percentage of the storage maximum size that the system maintains when the WIStorageManager purges its oldest files. For example, if Storage maximum size is set to 100 MB and Storage lower limit is set to 70%, the WIStorageManager will remove old files until storage size reaches 70 MB.

Default 70%

Scan frequency

Defines how often storage is checked to be purged. According to this value, the system deletes those documents for which the last access date is older than the Duration" time. If the storage size is still bigger than Storage maximum size, the system deletes all documents with the oldest access date until the Storage lower limit * Storage maximum size is reached.

120 min

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

139

Parameter Enable shared storage

Description

Default

If On, this setting allows the storage Off area defined at installation to be shared by other Storage Managers. You can change this setting while the system is running. When you change from Enable to Disable mode, the lock mechanism ends for the current session; when you change from Disable to Enable mode, the lock mechanism appears for the next session. Business Objects recommends, however, that you apply these changes during off peak time (ideally without any active users). For more information on this option, see WIADEServer on page 140. Warning: Enabling shared storage may hinder optimal performance.

WIStorageManager

140

System Administrators Guide for Windows

WIADEServer
WIADEServer (ADE stands for Application Development Environment) provides the server interface for calls from the client ActiveX Viewer and 3-tier BusinessObjects. Calls are received directly from the client via WIDispatcher, and are passed directly to the appropriate Business Objects components for processing. Calls are passed to BOManager to process full client documents for ActiveX Viewer and to WIQT to process document exchange and SQL commands. The WIADEServer module is used to: Handle the requests sent by an ActiveX viewer running on a client machine Handle requests sent by 3-tier BusinessObjects Provide access to the Report Catalog API Install 3-tier BusinessObjects and permit it to communicate with the Business Objects server WIADEServer interacts with WISessionManager for user settings and session data, with WIQT and BOManager for document processing, and with WIStorageManager for cache data. WIADEServer is part of the session stack.

WIADEServer parameters
This module has one parameter:

Parameter User activity log

Description

Default

See The Audit Facility on page 184. Off

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

141

ActiveX viewer This viewer is an ActiveX component that uses a proprietary system, based on HTTP, to transfer the display of data to a client machine. The ActiveX viewer can run only from within Internet Explorer 5.5 under Windows 2000. This viewer lets InfoView users view BusinessObjects documents in enhanced document format, exactly as they appear in the BusinessObjects product. For example, you can navigate through the document by sections and zoom into it by section. Unlike the standard HTML view, Active X offers WYSIWYG (What You See Is What You Get) printing. Users can specify ActiveX viewing by choosing Enhanced Document Format viewing in the Options page. WebIntelligence automatically installs it on their machine the first time they use it. However, they can use the ActiveX Viewer to display BusinessObjects documents only. They can view WebIntelligence documents only in HTML. Report Catalog API The Report Catalog API, in the form of an ActiveX automation object model, gives developers access to the document catalog. This API enables them to build customized document catalogs in their applications. This component does not require other WebIntelligence or BusinessObjects software to be installed because it makes use of the existing server components.

WIADEServer

142

System Administrators Guide for Windows

WIAPIBroker
WIAPIBroker is the interface between the client and the business processing (middle tier) layer. WIAPIBroker interacts with: WISessionManager for session creation WIQT for document and list processing WIStorageManager for cache data WIAPIBroker is part of the session stack. WIAPIBroker handles requests sent by the WICom ActiveX server component wicom250.dll, which is used to write Active Server Pages (ASP), and by the WIBean server component, which is used to write Java Server Pages (JSP). For more information on ASP and JSP, refer to the Introduction to Developer Suite Guide. This module is part of the session stack. At least one session stack must be enabled in the cluster to provide users access to InfoView or any customized application that relies on WICom or WIBean. .WIAPIBroker parameters The WIAPIBroker parameters are described below:

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

143

Parameter User activity log Cleanup period

Description See The Audit Facility on page 184.

Default Off

Sets the period at which WIAPIBroker 60 s removes any sessions left hanging after session timeout. The value you enter is a trade off between CPU consumption and WIAPIBroker memory usage, i.e.: if you enter too low a value the system will consume a lot of CPU power to run the cleanup task if you enter too high a value memory isn't freed often, resulting in a WIAPIBroker memory heap that will grow instead of being freed for other processes to use. If you set this parameter to 0 no memory is freed, you should therefore only use this value for troubleshooting purposes. In fact, Business Objects recommends that you do not set this value any lower than 30 s. Any change to this parameter is dynamically taken into account once cleanup period ends.

WIAPIBroker

144

System Administrators Guide for Windows

BOManager
This module launches and manages a pool of BusinessObjects processes called BusObj via Microsofts COM (Component Object Model) . BusinessObjects processes (BusObj) are the components used to run and process BusinessObjects documents. One session is launched per job, thus enabling multiple requests to be handled at server level for full-client documents. This differs from accessing or refreshing WebIntelligence 2.6/2.7 documents, where one session is launched per user. BOManager is a scalable, server-based form of the BusinessObjects product that allows users to view and refresh BusinessObjects documents using the Business Objects system. BOManager interacts with WIQT for document processing and caching. BOManager is part of the session stack. When running on a Windows machine, it can handle all types of documents, regardless of the types of data providers or the reporting functionality used to create the documents. If you are using a heterogeneous cluster including both Windows and UNIX servers, you can choose to process your systems full-client documents on either platform. For more information, see the Deployment Guide.

What BOManager does


BOManager manages a pool of BusinessObjects processes, based on the parameters set in the Administration Console. It also deals with CORBA calls to all Business Objects system objects. For each open BusinessObjects document, BOManager creates and maintains a document context object; this makes it possible for it to manage a document throughout its life in BOManager. A document context object resides in the memory of the BOManager machine where it takes up approximately 400 bytes. It is created by the BOManager when an InfoView user or a BCA makes an initial request for a BusinessObjects document.

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

145

A document context object consists of the following elements: Session ID User name Password Root directory for the session Path name of the document (the name of the local temporary document file) Name of the document in the repository Last action carried out on the document (open, refresh, etc.) Last time an action was carried out on a document (used for time-out calculations)

BusinessObjects processes
BOManager handles multiple BusObj processes such as editing and refreshing full-client documents though InfoView as well as refreshing full-client documents via Broadcast Agent. Each process is a full BusinessObjects client (BusObj). You can set the number of BusObj processes through parameters in the BOManager module of the Administration Console. For more information on these parameters, see BOManager parameters on page 147. In Windows environments, BOManager and the BusObj processes communicate locally via COM.

Caching Broadcast Agent login information


Each time a Broadcast Agent task starts, a new BOManager session is started. Each task needs to log in against the repository. This is inefficient if several tasks are processed using the same user identity. Unfortunately, this is often the case, especially in larger organizations which rely upon the regular processing of their documents. Furthermore, Broadcast Agent doesnt rely on WILoginServer for its login and authentication. BOManager caches the login information for each new task, storing the relevant key file, .lsi file, user name and password in a temporary folder on the server. The next time a task starts, if all the login information matches the information in the cache, the session context for the task is restored directly from the cache, instead of having to check the repository for the required security information. This both improves performance on heavily loaded servers and lightens the load on the repository.

BOManager

146

System Administrators Guide for Windows

Cache essentials There is one cache for each BOManager machine. The cache is maintained on the local hard disk of the BOManager machine. The life span of cache entries is set by the BOManager parameter, Scheduler login cache duration. You set this parameter using the Administration Console. This cache mechanism is enabled only for Broadcast Agent tasks.

How BOManager caches BusinessObjects documents


When BusinessObjects users schedule a corporate document with Broadcast Agents, they improve server performance by having BOManager automatically cache the documents presentation either in metafile (.rep) or standard HTML format. These formats correspond to the two possible options for viewing BusinessObjects documents within InfoView. The first time an InfoView user asks to view the document, BOManager receives the request, then forwards it to the BusinessObjects process. As a result, when the documents recipients access the document in InfoView, instead of having to recontact BOManager and regenerate the file in the requested format, they access a pre-generated file. This means that: After the initial InfoView request for the BusinessObjects document, subsequent requests for the same document in the same format dont require logging into BOManager. There are fewer demands on available BusinessObjects processes in your cluster. The document doesnt have to be loaded into the BusinessObjects process. The documents presentation doesnt have to be generated the document is displayed faster, and having used fewer system resources. The response time remains constant and doesnt depend on the documents size or complexity. CPU power and BusinessObjects processes are therefore made available for refreshing documents (ad-hoc queries).

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

147

BOManager parameters
BOManager parameters relate to the sessions, processes and documents present on the machine on which BOManager is installed:

BOManager

148

System Administrators Guide for Windows

Parameter User activity log Kill BusObj processes on startup Max. number of busy processes

Description See The Audit Facility on page 184. Kills all BusinessObjects processes (including those which may be running interactively) whenever the Broadcast Agent or WebIntelligence is started.

Default Off On

The maximum number of busy BusinessObjects 4 processes allowed to run on the BOManager machine. A busy process is one that takes up CPU time because of tasks such as refresh, save, or computing data. The machines CPU should determine this setting. In our bench labs, we have set this parameter to 32 on a 4-CPU server with 4 gigabytes of RAM. Note: The value you enter must be greater than the value set for Min. number of loaded processes and less than the value set for Max. number of loaded processes.

Max. number of loaded processes

The maximum number of BusinessObjects processes that are allowed to run on the BOManager machine. This is the value most affected by the machines memory capacity as each process is a full BusinessObjects client. In our bench labs, we have set this parameter to 34 on a 4-CPU server with 4 gigabytes of RAM. Note: The value you enter must always be greater than the one set for Min. number of loaded processes.

10

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

149

Parameter Min. number of loaded processes

Description The minimum number of BusinessObjects processes that are allowed to run on the machine when BOManager is started. BOManager automatically starts new BusinessObjects processes until the minimum number is running. The value you enter must always be less than that of Max. number of busy processes. This parameter improves performance by making a number of BusinessObjects processes available for execution rather than running new processes. Note: When BOManager times out the minimum number of BusinessObjects processes is not retained and will be set to 0 until BOManager is restarted and starts the minimum number of loaded processes.

Default 2

Idle loop interval

The interval that elapses between two iterations 20 s of BOManagers background thread. Each time the background thread runs, BOManager checks the values specified in the following parameters: Delete inactive process after Scheduler login cache duration Auto-shutdown BOManager after If any of the values has expired, the background thread performs the related clean-up task.

BOManager

150

System Administrators Guide for Windows

Parameter Keep exclusive process

Description The minimum interval during which a BusObj process is dedicated exclusively to one user. If another user wants to open a session before this interval has expired, BOManager starts a new BusObj process for this user. If, however, this interval has expired, BOManager assigns the same BusObj process to another user. The parameter provides a benefit that is a tradeoff between the response times of the current user and that of any other users. When the value is high, the process is dedicated to the current user and results in improved response times for each action carried out by this user throughout this interval. However, during this interval, BOManager has to start new BusObj processes for subsequent users, which results in more time-consuming operations. When the value is low, the process is not dedicated to the current user; consequently, BOManager has to restart another BusObj process for every action other users perform after this interval has expired. (This requires more time than for a simple action.) However, all other users are able to reuse this process once the interval has expired; this leads to improved response times.

Default 60 s

Delete inactive process after

Specifies how long a BusObj process can remain open after it has finished processing a document. If during this period, there is no activity in the BusObj process, BOManager closes the process if there are more loaded processes than the value set for Min. number of loaded processes.

5 min

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

151

Parameter Recycle process (actions)

Description

Default

Specifies the number of transaction-intensive 40 actions such as opening, refreshing, saving, publishing, or sending documents that can occur before the active memory on the server machine is cleaned up. Once this number has been reached, BOManager closes the BusObj process and reopens it once the next document is opened or the next user is logged in.

Auto-shutdown BO Specifies the amount of time BOManager can Manager after remain inactive before it is shut down. Shutting down BOManager cleans up the active memory on the server machine. It is recommended that you set this parameter to a value greater than the one set for the parameter Timeout for interactive and batch actions; otherwise any batch actions requiring more than this value could be killed. Scheduler login cache duration An interval during which the login cache functions. Once this interval has expired, the next login does not make use of the cache; instead it logs into the repository. Note that this login cache is used only for Broadcast Agent tasks (scheduled documents). The value of this parameter provides a trade-off between improved performance and up-to-date real-time information. To deactivate the login cache, you must set it to 0. For more information on the login cache, see Cache essentials on page 146.

60 min

360 min

BOManager

152

System Administrators Guide for Windows

Parameter Timeout for interactive actions

Description The interval during which a BusObj process running interactively (within WebIntelligence) can be busy without interruption for any single action. Once this interval expires, the BusObj process is recycled (killed) to stop the current action. This value must be less than the time allowed for the WIQTs Max. active time parameter.

Default 10 min

Timeout for batch actions

The interval during which a BusObj process running in batch mode (through Broadcast Agent) can be busy without interruption for any single action. Once this interval expires, the BusObj process is recycled (killed) to stop the current action.

60 min

Enable macros for interactive users

Determines if any VBA macros embedded in BusinessObjects documents will be run on the server when this document is viewed from InfoView. Note: This doesnt affect add-ins, which must be physically installed on the server machine. This setting does not affect Broadcast Agent.

On

Cache read max. chunk size

The chunk size (in KB) of the cached document 64 KB that the WIStorageManager reads from the file system and sends to the requesting BOManager. BOManager requests cached document content from the WIStorageManager in chunks. Therefore, if documents stored in the cache are generally very large, Business Objects recommends you increase the chunk size in order to minimize CORBA calls between the BOManager and the WIStorageManager.

HSAL write max. chunk size

The chunk size (in KB) of the output buffers written to the HSAL.

64 KB

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

153

Choosing the server for interactive refresh


BOManager runs on either Windows or UNIX machines, so if you are using a heterogeneous cluster, you can choose what type of server you want to process interactive BusinessObjects document refreshes.
NOTE

The term "interactive refresh" refers to the specific request for the refresh of a BusinessObjects document from an InfoView user. Each operating system has its advantages and disadvantages. When choosing which server you want to process full-client document requests, keep in mind the following: On a Windows machine, BOManager can handle all types of full-client documents, regardless of the types of their data providers or the reporting functionality used to create the documents. On a UNIX machine, BOManager cannot process the following types of documents: - Those whose data comes from OLAP sources - Those with Visual Basic for Applications data providers - Those whose data comes from personal data files - Those containing stored procedures - Those containing free-hand SQL - Those containing custom macros for Broadcast Agent processing - Those published to channels UNIX servers also support a more restricted list of RDBMSs and middleware than Windows servers. For a full list, see the ReadMe file for this release.

BOManager

154

System Administrators Guide for Windows

Broadcast Agent Manager


Broadcast Agent Manager lets you monitor all the Broadcast Agents set up for your system. With this module, you can also assign and modify the Scheduler assigned to any Broadcast Agent in order to improve system performance. To use Broadcast Agent Manager, you need to understand how BusinessObjects, WebIntelligence, Broadcast Agent and Schedulers interact. This topic includes: Broadcast Agents and Schedulers Monitoring Broadcast Agents and assigning Schedulers Assigning parameters to the Scheduler of a Broadcast Agent

Broadcast Agents and Schedulers


For each Broadcast Agent there must be at least one Scheduler in the WebIntelligence backbone. It is also possible to have several Schedulers for one Broadcast Agent. The Scheduler polls the repository to monitor documents scheduled for processing in assigned Broadcast Agents. When the Scheduler detects a document that needs to be refreshed, it requests either WIQT or BOManager to perform the task. Each exists as a separate process (BcaScdul.exe) on a machine.

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

155

Monitoring Broadcast Agents and assigning Schedulers


From Broadcast Agent Manager, you can monitor the Broadcast Agents assigned to the different nodes of the system. If a Broadcast Agent has more than one Scheduler, the Broadcast Agents name is repeated in a list in the Administration Console. By clicking the Parameters button beside the name of the Broadcast Agent, you can view the parameters of its Scheduler.

To monitor a Broadcast Agent from the Administration Console: 1. Click the Add button. The following dialog box appears:

Broadcast Agent Manager

156

System Administrators Guide for Windows

2. Select the key file from the list box. The key file is a file that points to the repository from which the Broadcast Agent was defined. 3. Click the Refresh BCA list button. The following login box appears:

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

157

4. Enter your general supervisor or supervisor user name and password, then click OK. The list of available Broadcast Agents opens.

The dialog box above shows two Broadcast Agents named Scheduler 1 and Scheduler 2. Only Scheduler 1 is being monitored from the machine oberstenfeld; the other is not being monitored.

Broadcast Agent Manager

158

System Administrators Guide for Windows

NOTE

You must have a general supervisor profile to obtain a list of all of the Broadcast Agents available on the repository. If you log in with a supervisor profile, you can view only those BCAs assigned to your group; if you want to see those outside your group, log out then log in again with the user name and password of another supervisor or as the general supervisor. 5. From the list, click the Broadcast Agent you want to monitor then click OK. A login box prompts you to enter a password for the Broadcast Agent. 6. Enter the password. You can now monitor the Broadcast Agent from the Administration Console. At this point, you can assign parameters to its Scheduler.

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

159

Assigning parameters to the Scheduler of a Broadcast Agent


If a Broadcast Agent has more than one Scheduler, the Broadcast Agents name is repeated in a list in the Administration Console.

To assign parameters to the Scheduler of a Broadcast Agent: 1. Click the Parameters button beside the Broadcast Agent with the Scheduler that you want to configure. The following dialog box appears.

Broadcast Agent Manager

160

System Administrators Guide for Windows

Note that the first three parameters pertain to the Broadcast Agent itself, and the rest pertain to the Scheduler. 2. Change the values of the parameters as necessary. 3. When you have finished specifying the values, click the Apply button. The parameters are listed and defined below.

Broadcast Agent Manager parameters


The BCAManager manages BCA Schedulers. The parameters are listed and defined below:

Parameter Password

Description

Default

The password assigned by the supervisor to the Broadcast Agent.

Domain name (key The name of the .key file for the security file) domain. This name is essential in configurations where multiple repositories (each with one security domain, hence one .key file) have been set up. The key file must be present on the machine where the Scheduler is running. When the Scheduler instructs BOManager to process a document, it also passes the .key file information to BOManager. Scanning repository delay

Determines how frequently the Scheduler 600 s scans the security domain for pending tasks. If the parameter has a low value, Broadcast Agent Manager checks the repository frequently to determine whether changes occurred on the pending tasks or if new tasks have arrived. If this parameter has a high value, the Broadcast Agent Manager is not updated frequently.

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

161

Parameter Update repository delay

Description

Default

When a process is complete, Broadcast 300 s Agent sends updated information to the repository to flag the process as Successful, Failed etc. This parameter determines the delay between the end of the process and the transaction which updates the repository. For example, if you set it to 10 minutes, the Scheduler updates the repository every 10 minutes with information on every process that has ended during that time. Without this parameter, Broadcast Agent would send information to the repository as soon as a process is complete. Thus, if 10 processes ended simultaneously, 10 individual connections to the repository would be made at the same time. This type of situation would result in a bottleneck of repository connections.

BusinessObjects documents WebIntelligence documents Max. duration

Specifies whether Broadcast Agent can process BusinessObjects documents. Specifies whether Broadcast Agent can process WebIntelligence documents. Specifies how long a task can run. This parameter prevents runaway queries from holding a connection and blocking the server for long periods.

On On 36000 s

Delay between retry

Broadcast Agent reloads failed tasks at the frequency that you set with this parameter. When a task fails, Broadcast Agent tries to run it again once this delay has expired.

600 s

Broadcast Agent Manager

162

System Administrators Guide for Windows

Parameter Nb. max. running Business Objects jobs

Description The number of BusinessObjects documents that Broadcast Agent can process simultaneously. The value you assign to this parameter depends on: The memory of the server machine The size of your documents The time it takes to connect to the corporate database The number of connections required by each document. The number of BOManagers on the cluster node. This parameter is highly dependent on the value set for the BOManager parameter Max. number of busy processes. If this value is higher than the sum of the values set for the parameter Max. number of busy processes in all the BOManagers on your cluster nodes, the following occurs: when the maximum number of jobs is reached, some will fail as no BOManager will be available to process them; this is because all the BOManagers are busy. It is recommended that you set this parameter to a value lower than the sum of the values for all BOManagers parameter Max. number of busy processes on the cluster nodes.

Default 10

Nb. max. running WebIntelligence 2.x jobs Nb. max. running WebIntelligence 6.x jobs

The number of WebIntelligence 2.x 10 documents that Broadcast Agent can process simultaneously. The number of WebIntelligence 6.x 10 documents that Broadcast Agent can process simultaneously. 5

Nb. max. retry jobs The maximum number of times Broadcast Agent attempts to process failed jobs.

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

163

Parameter Purge jobs

Description

Default

Specifies whether Broadcast Agent purges all Off processed documents, successful or otherwise, from the repositorys document domain. See also Purge only successful jobs. Purging the queue deletes all processed 100 days documents from the repositorys document domain. This parameter lets you specify how often you want to purge the document domain, and whether to purge both failed and successful tasks. Note that you can also control queue purging by using the Purge the Queue command from the Broadcast Agent Console.

Period for purge

Purge only successful jobs Delay for auto shutdown

Purges only the documents that Broadcast Off Agent has successfully processed. Thus, you can view and manage only failed tasks. Specifies how often the Scheduler is shut down then restarted. Shutting down the Scheduler cleans up the active memory on the server machine. The Scheduler cannot shut down while a task is running. It waits until the end of a process, then applies the interval that you specified. 120 min

Broadcast Agent Manager

164

System Administrators Guide for Windows

Parameter Log file name

Description Specifies the log file in which information on the activities of Broadcast Agent is stored. Even if the value of this parameter is blank, a log file is still created. The default log file is BcaScdul_BCA_ID.log where ID represents the ID of your Scheduler (the same as BcaScdul_BCA_ID.ini in which the values of the Schedulers parameters are stored).

Default

Number of BOMgr to try

Specifies the number of BOManagers in your 5 cluster node to which the Scheduler tries to connect when a BOManager has reached its Max. number of busy processes. The optimal value is the number of BOManagers you have enabled on all your cluster nodes.

Waiting time before This parameter is used to prevent tasks that 30 s bind need to run concurrently so that they start at different times. For example, if two tasks start at the same time, two intervals are randomly generated (for example, three and five seconds). Once these intervals have expired, the tasks start after three and five seconds, respectively. For more information, see the Broadcast Agent Administrators Guide.

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

165

WIReportServer
WIReportServer is a report engine used to create, edit, view, and analyze WebIntelligence 6.1 documents. Note that any 2.6/2.7 documents edited with WebIntelligence 6.x are upgraded to 6.x documents. The Servlet/ISAPI extension receives HTTP calls from the WebIntelligence Java Report Panel applet and translates these into CORBA/IIOP calls that the WIReportServer can understand. WIReportServer is a pure report engine used by WebIntelligence 6.x documents. WIReportServer interacts with WIQT, which acts as a middleman between WIReportServer and WIStorageManager to retrieve, open, and save documents. WIReportServer uses the InfoView session created when a user logs into InfoView. ReBean/ReCom gets the session reference for an InfoView Session Cookie and passes it on to WIReportServer. Thus a WIReportServer session uses the services offered by an InfoView session via proxies.

WIReportServer parameters
The parameters for the WIReportServer module are displayed below:

WIReportServer

166

System Administrators Guide for Windows

Parameter User activity log

Description See The Audit Facility on page 184.

Default Off 1200 s

Max. inactive time The maximum number of seconds WIReportServer can be inactive before its executable is stopped. The maximum inactive time should be less than the maximum active time. If the value is set to 0 the executable is never stopped. Max. active time The maximum number of seconds WIReportServer can be active before its executable is stopped. There are a few things you need to take into consideration: Once the Max. active time is reached the Shutdown timeout starts its countdown. It is only after the Shutdown timeout period has elapsed that WIReportServer's executable is stopped. Max. active time should be higher than Max. inactive time. In fact, the Max. active time should rarely be attained as it is recalculated after the Max. inactive time has been reached. WIReportServer module's executable is stopped and then restarted. Therefore, it is important not to enter too large a value for the Max. inactive time. The value for the Max. active time should truly reflect the point at which you want to stop all actions on a WIReportServer. If the value is set to 0 the executable is never stopped.

604800 s

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

167

Parameter Max. number of documents per instance

Description

Default

The maximum number of WebIntelligence 100 sessions allowed per WIReportServer process. The load balancing mechanism takes this value and uses it to find the "least-loaded" process and routes requests to the least-loaded process in order to maximize performance and scalability. For more information on the load balancing mechanism see Node Weight on page 119.

Session reactivation period

Specifies the interval for reactivating a user's InfoView session so that it will not time out. This parameter is important because the InfoView session is based on an active WIQT. If a user is performing actions that do not require the WIQT, the InfoView session may terminate. This will create problems for the user while using the applet. Session reactivation period must be less than the value set for WISessionManager's Session timeout parameter.

600 s

Session validation Sets how frequently WIReportServer checks frequency for a valid InfoView session. List of values caching

120 s

Enables or disables caching per user session On of lists of values in WIReportServer's memory.

WIReportServer

168

System Administrators Guide for Windows

Parameter List of values batch size

Description The maximum number of values that can be returned per list of values batch. The minimum value that you can enter is 10 and although there is no limit on the maximum value, Business Objects recommends that you limit it to 30000. If you set this parameter to 0 there is no limit on the number of values returned per batch. Note: If you develop a custom application with the SDK, the value you set for the list of values batch size via the SDK will override any defaults set in the Administration Console.

Default 1000

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

169

Parameter

Description

Default 60 s

Shutdown timeout Determines the delay between the request to shut down WIReportServer module and the actual shutdown of the module. There are a few things you need to take into consideration: A shutdown can happen before the value for Shutdown timeout is reached if all the requests naturally end before this time. Once the Max. active time is reached the Shutdown timeout starts its countdown. It is only after the Shutdown timeout period has elapsed that WIReportServer's executable is stopped. The value for Shutdown timeout should be equal to or slightly greater than the average duration of actions, such as refresh. You can determine the duration of actions by activating the Trace method. New actions originating from existing sessions received during Shutdown timeout must wait for the Shutdown timeout to end before they will start to be executed. These actions are placed in a queue to await processing, as they cannot be rerouted to other modules. Therefore, the Shutdown timeout value should not be too high, as users launching new actions from existing sessions may have to wait a while before their request is carried out. New actions originating from new sessions will be rerouted to other modules by the load balancing mechanism. If the value is set to 0 the module will immediately shut down and all processes terminated at once.

WIReportServer

170

System Administrators Guide for Windows

Parameter Number of instances

Description The number of WIReportServer instances permitted to run on the machine. WIReportServer is a multithread process that can handle multiple requests. This parameter can't be null.

Default 2

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

171

Administration Server
Administration Server is used to administrate users with JSP technology. It is the server component of the Java Administration SDK. Administration Server provides a subset of the functionalities available in Supervisor. It lets the administrator manage users and groups, as well as user properties, such as changing passwords and enabling password modification rather than having to log into Supervisor. Only a user with a general supervisor or supervisor profile can administrate users via Administration Server. A session is started when a com.bo.adminbean.Server object is instantiated in JSP script and once the administrator has been successfully identified and authenticated. Several administrators can work on Administration Server concurrently and all of their input is centralized in the security domain of the Business Objects repository. For more information on Administration Server, see the Customizing Administration Guide. Administration Server user sessions cannot be viewed in the Administration Console, as the Administration does not use WISessionManager to manage its user sessions. For information on WebIntelligence SDK, refer to Customizing WebIntelligence.
NOTE

Only one Administration Server can be installed on the cluster, ideally on the primary node.

Administration Server

172

System Administrators Guide for Windows

Administration Server parameters


The parameters for the Administration Server module are detailed below:

Parameter User activity log Client session timeout Cleanup period

Description See The Audit Facility on page 184.

Default Off

Determines the period of time a session stay 600 s inactive before ending. Sets the period at which Administration Server removes any sessions left hanging after session timeout. Any change to this parameter is dynamically taken into account once cleanup period ends. 60 s

Inactivity timeout

Determines the period of time Administration 3600 s Server can stay inactive before shutting down.

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

173

WILoginServer
To log users in quickly and efficiently, the Business Objects system makes use of a system component called WILoginServer. WILoginServer retrieves information on user rights from the repository, precalculates this information and caches it, thereby accelerating the login process.

How WILoginServer functions


WILoginServer is in charge of authenticating the user and generating the user's .lsi file, the file that holds a users security and ID information. After initializing the session environment, WIQT calls WILoginServer, which authenticates the user against the repository and creates the .lsi file. The .lsi file, which holds security and ID information about users, is based on precalculated database tables stored in the server's cache. The .lsi file caches all security attributes related to a user, so .lsi file calculation can be long. WILoginServer's cache is used to accelerate .lsi file generation. Because the security attributes of all the groups are precalculated, login performance is greatly improved. The cache is loaded when WILoginServer is started and is refreshed regularly, so that repository changes can be accounted for. WILoginServer can handle double-caching, thereby enabling user authentication even when the server is refreshing its cache data. WILoginServer is also where you choose the systems authentication method. WILoginServer cache contents The WILoginServer cache holds precalculated data of the security model which consists of: Groups and user instances Precalculated security attributes for each group: - Timestamp - Profiles - Security commands - Authorized Documents - Authorized Universes The hierarchy of categories in which documents are classified The relationship between documents and categories

WILoginServer

174

System Administrators Guide for Windows

The security model The Business Objects security model is implemented as a set of database tables in the repository; it contains information on users and groups that reflects your company's organizational structure. Information on groups and users is made up of the following elements: Security restrictions: Timestamps that set the period within which a user can log in Functional rights: Profiles and security commands (for more information, refer to the Supervisors Guide) Object access rights: Authorized documents, authorized universes, access rights to database stored procedures and access restrictions on universe data (Universe overload) General information, such as user preferences Cache refreshing Refreshing the cache regularly is crucial because, if it is not up-to-date, any changes made to the repository are not taken into account. The WILoginServer cache can be refreshed from the Administration Console. You can either: initiate a refresh manually or automatically by setting the time between two refreshes. For information on how to refresh the WILoginServer cache, see WILoginServer parameters on page 176.
NOTE

The time set between two refreshes should be adjusted depending on how often the supervisor makes changes to the repository.

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

175

Double caching While the cache is being refreshed, WILoginServer remains available if the double cache option is enabled. During refresh users can log in using the cloned image of the cache.
NOTE

Because cloning the cache has a big impact on memory, you can enable/disable this feature using the Administration Console. For more information on how to enable the double caching option, refer to WILoginServer parameters on page 176.

WILoginServer Administration
Using the Administration Console you can: Restart the WILoginServer Select the refresh period Refresh WILoginServer cache manually Enable/disable double caching Choose the systems authentication method

Which products use the WILoginServer?


The products that use the WILoginServer are: 3-tier BusinessObjects InfoView Administration Console Products that do not use the WILoginServer are: BusinessObjects Designer Supervisor Broadcast Agent

WILoginServer

176

System Administrators Guide for Windows

WILoginServer parameters
The WILoginServer parameters are detailed below:

The Refresh button, as seen above, enables you to manually refresh WILoginServer. This is particularly useful if you have applied security commands to users and want these changes to be taken into account immediately.

Parameter Refresh period

Description

Default

This parameter sets the period of time 600 s between each refresh. This value must be higher than the last refresh duration value.

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

177

Parameter Last refresh duration

Description Indicates the amount of time it took the WILoginServer to refresh its cache at the last refresh. This value is set by the system and can change from refresh to refresh. It cannot be set by the user.

Default No default value. Refresh time displayed in seconds.

Double caching

Enables or disables the double caching On option. For more information on double caching, see Double caching on page 175. Lets you set an authentication method Business Objects for the Business Objects system. See Standard Authentication Methods on page 102.

Authentication method

WILoginServer

178

System Administrators Guide for Windows

WIQT
WIQThandles document processing. It processes requests coming from WIAPIBroker, WISessionManager, WIDispatcher, WIADEServer, BOManager, and WIReportServer, and generates the SQLBO calls. WIQT is responsible for opening, viewing, and refreshing WebIntelligence 2.6/2.7 documents and for creating BusinessObjects documents through the BOManager. It processes requests from 3-tier BusinessObjects and accesses the cache to retrieve WebIntelligence 2.6/2.7 documents. WIQT is singlethreaded and can treat only one request at a time.

WIQT parameters
The WIQT parameters are detailed below.

Managing Servers and Modules with the Administration Console

System Administrators Guide for Windows

179

Parameter Max. active time

Description The maximum number of seconds WIQT can be active before its executable is stopped. This value must be greater than the value of the BOManager parameter Timeout for interactive actions. The maximum number of seconds WIQT can be inactive before its executable is stopped. See The Audit Facility on page 184.

Default 900 s

Max. inactive time

300 s

User activity log

Off 20

Number of instances The number of WIQT instances permitted to run on the machine. Customers with multi-CPU servers may want to increase this value to match the anticipated concurrent user population on the server. We recommend setting this to at least 64 WIQT for a 4-CPU server. This parameter can't be null. You should disable the WIQT module to stop and to deregister all WIQT processes.
NOTE

The WIQT module parameters Max. active time and Max. inactive time are common to all WIQT processes. When the WIQT module parameters are modified, WIQT processes that are already running are not affected by the parameter change. Only WIQTs started after the parameter change will take the values into account. WIQT instances With CORBA, object registration and deregistration is an administrative task that can take a long time. To reduce process start and stop time, objects are registered when the node is started and deregistered when the node is stopped, and not when the process starts or stops. This means that an object is still registered even after a process has stopped.

WIQT

180

System Administrators Guide for Windows

The Number of instances parameter defines the number of WIQT objects registered at node startup, and consequently, the maximum number of WIQT executables that can be started on a machine. When the node is started, WIQT processes are started to register WIQT objects. Once these WIQT objects are registered, the WIQT processes shut down except for two (or only one if the Number of instances is set to 1), which remain active in order to wait for new users requests. When a user connects to InfoView, a WIQT is allocated and dedicated to this user during the whole session. If all WIQTs are already allocated to users, new users must wait until another WIQT is free. When a user logs out or when the WIQT timeout is reached, the WIQTs executable is stopped and is free for incoming requests: If the number of running WIQTs is lower than the Number of instances parameter, a new WIQT is started when a new request comes in. If the number of running WIQTs is equal to the Number of instances parameter, no new processes are started. If a user is inactive for more than five minutes, WIQTs executable is stopped and can be used by another user. Thus, if the number of instances is too low, the same user who wishes to work again in InfoView may no longer be able to do so, as no WIQTs are free to be allocated to this user. The number of active users that can log in to any machine is determined directly by the number of WIQT instances defined. Thus, even on a powerful machine, only a limited number of users may be able to log in unless you set the number of WIQT instances to a value sufficient to support your user population. When you increase the value of this parameter, new WIQTs are registered and can be started and allocated to users without having to restart the server. When you decrease this parameter, WIQTs are deregistered. Nevertheless, running WIQT processes are not stopped immediately, but only once users log out or after its timeout.

Managing Servers and Modules with the Administration Console

Tracing System Activity

chapter

182

System Administrators Guide for Windows

Overview
The Audit facility tracks critical information relating to user activity, as well as critical system activity. Each time any of 52 predefined events occurs, a record of the event is created and stored by the Audit facility. You can then retrieve and analyze the information on event duration. In this way, you can determine how many users were active at any given time, and thus check the number of concurrent users in the system (that is, users who are making the server work as opposed to the users who are merely logged in). Finally, auditing can also be used for billing purposes. For example, it can determine which objects or universes were used in queries for billing by objects or universes. The universe object information audited refers exclusively to result objects retrieved by the query and not to objects used to restrict query results, such as predefined conditions, and conditions or objects used in secondary queries. Auditing can also track the number of rows extracted from a database for billing by data volume. For information on the Auditor product, refer to the BusinessObjects Auditor Guide.

Tracing System Activity

System Administrators Guide for Windows

183

What Types of Tracing Methods are Available?


The Business Objects system provides you with several ways of monitoring all the requests and processes passing through the system, coming from WebIntelligence, Broadcast Agent and 3-tier BusinessObjects:

Tracing Methods Audit facility

Description Traces all types of activity related to: user actions, such as the selection of a universe, the execution of a query, or refresh of a document etc. system activity, such as the time used by the system to process a request, the universe or objects used in queries, etc. See The Audit Facility on page 184. Traces the activity of a particular module on a specific server machine. As opposed to Business Objects system Audit files, these traces are most useful in explaining abnormal module behavior, and are therefore used primarily for debugging purposes.

Trace facility

NOTE

The internal tracing method is no longer part of the Administration Console. For information on how to set the trace, see The Business Objects Trace Facility on page 243.

What Types of Tracing Methods are Available?

184

System Administrators Guide for Windows

The Audit Facility


The Audit facility traces system and user activity and logs the information to the Audit database or to log files. The Business Objects system supports the following databases for audit: Oracle v. 8 or later DB2 v. 7.1 or later SQL Server v. 7 or later You must activate the Audit database from the server that you want to monitor. Before activating the Audit facility for the first time, you must create the Audit database. You do this by: Creating a secured connection to the Audit database, using Supervisor. Activating the Audit Facility in the Administration Console.

Tracing System Activity

System Administrators Guide for Windows

185

Creating a secured connection to the Audit database


You must create a secured connection to the Audit database using Supervisor. You must define a name, a path to a RDBMS and a network layer. To create the connection: 1. Open Supervisor, using a general supervisor profile. 2. In the Tools menu, select Connections. The Connections dialog box appears.

3. Click Add.

The Audit Facility

186

System Administrators Guide for Windows

The Add a Connection dialog box appears.

4. Select the network layer used. A description of the driver appears in the Description box. 5. Click OK. The dialog box is closed, and a configuration dialog box for the driver appears. 6. Enter the necessary parameters. (For more information on this dialog box, see the Data Access Guide.) 7. Click Test to test the connection. If the connection is valid, a confirmation message appears. If an error message appears, see the Data Access Guide or your RDBMS documentation. 8. Click OK.

Tracing System Activity

System Administrators Guide for Windows

187

Activating the Audit Facility


The Audit facility has two modes for gathering and storing event records: File mode The Business Objects system stores the user or system information in flat (.log) files, which are saved to a directory of your choice. These text files can be viewed in the Administration Console or in a simple text editor, such as Notepad. Database mode The Business Objects system stores the user or system information to the Audit database. Because of its complexity, information in Database mode is normally viewed and analyzed via the use of indicators in Auditor. However, this can also be performed in SQL, if no other solution is available. The Audit facility is activated in the Administration Console. By default, the Audit facility is inactive. The Audit can be enabled on three levels: cluster level, session stack level, and module level. Enabling or disabling a cluster or session stack affects all modules it contains The Audit facility covers the activity of the following Business Objects modules: WIDispatcher For session information, such as the user who started a session, and when the session started and ended. BOManager For information about opening, saving, and refreshing full-client documents. WIAPIBroker Allows WebIntelligence SDK users to audit the LOGIN event. WIADEServer For information concerning requests from ActiveX viewers on client machines. WIReportSever For information about creating, editing and refreshing WebIntelligence 6.x documents. WIStorageManager For user activity information concerning the WIStorageManager. WIQT For information about opening, saving, editing and refreshing WebIntelligence 2.x documents and about opening and saving WebIntelligence 6.1 documents.

Activating the Audit Facility

188

System Administrators Guide for Windows

Activating the Audit facility at cluster or session stack level


You can activate the audit facility from the Audit page of the cluster or session stack. This activates audit for all modules in the cluster or session stack with the parameters you set. Audit can then be deactivated for the session stack alone or the other individual modules in the cluster. To activate the Audit facility on all modules in a cluster or session stack: 1. Open the Administration Console. 2. Select the cluster or session stack. 3. Click the Audit button in the top bar of the Administration Console. The Audit page opens.

4. Click the On button. The User activity log option lets you: - Turn auditing on or off - Specify how you want to record the information: in log files or in a database 5. Do either of the following: - If you want to activate File mode, click Off next to Log to database, and then click Apply. The default location of the log files appears in the User Log file and Manager log files boxes. If you want to change these locations, see Modifying storage

Tracing System Activity

System Administrators Guide for Windows

189

location on page 196. - If you want to activate Database mode, click On next to Log to database. The login dialog box appears. If you selected File mode (in other words, Database mode Off), the system is now fully activated. If you selected Database mode On, continue with the steps below. Setting database mode parameters The database mode parameters on the Audit page look like this:

They are described in the table below.

Parameter Audit database connection

Description The list of authorized connections to a database as defined by the Business Objects supervisor. The connection must be a secure one. The connections are created in Supervisor. For information on how to set up these databases, refer to the Supervisors Guide.

Maximum cache size (KB)

Specifies the maximum size of the primary nodes cache in kilobytes. The default is 75 KB. The minimum value you can enter is 1 KB. Data is stored temporarily in the user log file specified on this audit page. When the file reaches its maximum size, it is flushed to the database.

To set the database mode parameters, proceed as follows. 1. In the Audit Database Connection list, select the database connection you want.

Activating the Audit Facility

190

System Administrators Guide for Windows

2. Change the Maximum temporary log file size parameter if required. 3. Click Apply. The system confirms that the audit tables are present. If not, an SQL script is executed to create them. If they are present, but not migrated, an SQL script is launched to migrate a 2.6/2.7 database to a 6.x database. These procedures may take a few moments. For a description of the audit tables, see Storing Audit Information in Database Mode on page 201.
NOTE

The log files and database connection for audit is the same for all modules in the cluster. If these parameters change for the session stack or for any module, the changes apply to all modules in the cluster. Version 6.1 of the Business Objects system supports multicluster auditing. However, each cluster must have a different name in order for multicluster auditing to work. Furthermore, to ensure that Auditor can retrieve coherent information all clusters need to point to the same repository.

Tracing System Activity

System Administrators Guide for Windows

191

Activating the Audit facility per module


You can activate an audit per cluster, session stack or module. Activating audit per cluster or session stack sets the same audit parameters for all modules of the cluster or session stack. Thereafter, you are free to deactivate the facility on the session stack or individual modules of the cluster as necessary. You can also choose to activate audit for each of the non-session-stack modules individually. To enable/disable the Audit facility for individual non-session-stack modules: 1. Open the Administration Console. 2. In the Module page, select the non-session stack module you want to enable or disable. For example, in the picture below, WIStorageManager is highlighted.

3. At User Activity Log, click On. This action does not affect the status of the other modules.

Activating the Audit Facility

192

System Administrators Guide for Windows

Emptying the cache


Audit data is stored in a cache on the server. There are two ways the cache is emptied: automatically, at the frequency set in the Empty cache to database every (number of seconds) parameter on the audit page manually, by clicking Flush cache at the bottom of the Audit page How cache emptying works in File mode In File mode (Database mode set to Off), when the cache is emptied automatically at the specified frequency, the data is written at the end of the log files specified on the Audit page, filling them incrementally. You can also click Flush cache at any time to empty the cache files to the log files manually. How cache emptying works in Database mode In Database mode, when the cache is emptied automatically at the specified frequency, the data is written temporarily in the user log file specified on the Audit page. When the file reaches the maximum size specified in the Maximum cache size (KB) parameter on the Audit page, it is flushed to the database.

Tracing System Activity

System Administrators Guide for Windows

193

Setting parameters to empty the cache To set the parameters to empty the cache: 1. On the Audit page, after Empty cache to database every, enter the number of seconds after which the cache is regularly flushed.

In File mode (Database mode at Off), this writes the cache data incrementally in the log files and empties the cache. In Database mode, this flushes the cache to the user log file used as a temporary buffer.

Activating the Audit Facility

194

System Administrators Guide for Windows

2. To set the maximum size at which the user log file is automatically flushed to the database in Database mode, enter the maximum size of the file in KB after Maximum cache size (KB).

Tracing System Activity

System Administrators Guide for Windows

195

Storing Audit Information in File Mode


In File mode, the Business Objects system stores the user or system information in flat (.log) files, which are saved to a directory of your choice. The default storage location is: $INSTALLDIR/nodes/<hostname>/<clustername>/auditlog/user.log There are four types of log files: sm.log Contains items of information for system events. user.log Contains items of information for user events, such as selecting a universe, executing a query, or refreshing a document. userdet.log Contains details of user events, such as type of browser or the machines IP address.
NOTE

If you are working in file mode, Business Objects recommends that you periodically check the size of the systems log files (particularly the user.log and userdet.log files). Over time, these files can take up a large amount of disk space.

Storing Audit Information in File Mode

196

System Administrators Guide for Windows

Modifying storage location


The directory in which your systems audit files are stored is set at installation. You can then use the Administration Console to modify the location of the log files if necessary:

To modify this Do this... files location... sm.log 1. In the Administration Console, click Audit. 2. Type the path of the new location in the Site Manager Log File box, and then click Apply. 1. In the Administration Console, click Audit. 2. Type the path of the new location in the User Log File box, and then click Apply. (This file is generated in the same folder as the user.log file.)

user.log

userdet.log

Viewing Audit log files in the Log View window


You can view the two principal Audit log files in the Log View window in the Administration Console. To open the Log View window: 1. If you havent already, click Audit in the top bar of the Administration Console. 2. Click the View Log button.

Tracing System Activity

System Administrators Guide for Windows

197

The Log View window opens.

To view the system activity information in the sm.log file, click the System Activity tab. To view the user activity information in the user.log file, click the User Activity tab. To close the window, click the Close button.

For detailed information about all Audit log files, see Storing Audit Information in File Mode on page 195.

Storing Audit Information in File Mode

198

System Administrators Guide for Windows

Viewing System Activity The System Activity view includes information on the date and time a process was launched, its host and process ID, and what action was taken.

Each row corresponds to a single system event. The following information is displayed for each event, listed here in the same order as in the text editor.

Item Level

Description Level of the event. This item was introduced in earlier versions. However, because of changes in the structure of WebIntelligence modules in the current version, the information logged for this item is no longer maintained. The time (year, month, day, hour, minute, second) at which the event began. Name of the machine on which the event was generated. The name of the module that logged the event. Module process ID. An explanation of the event.

Time/Date Host Name Module PID Message

Tracing System Activity

System Administrators Guide for Windows

199

This information corresponds to the OBJ_A_SITE_LOG table in the Audit database. For more information refer to Storing Audit Information in Database Mode on page 201. Viewing User Activity The User Activity view includes information on the event ID, the type and time of event and the user name.

Each row corresponds to a single user event. The following information is displayed for each event, listed here in the same order as in the User Activity view.

Storing Audit Information in File Mode

200

System Administrators Guide for Windows

Item Event No

Description References the event sequentially in the file or in the cache in database mode. This number does not reflect the number in the database because when the cache is flushed the event number will follow on the previous rows listed in the database.

Event Type ID Start Time Duration User Session ID

A number representing the type of event.


The time (year, month, day, hour, minute, second) at which the event began.

Duration of the action in milliseconds (rounded up). If the event duration cannot be computed, the value is -1. User that caused the event to be logged. The user session ID. For InfoView and 3-tier BusinessObjects, the session ID is the cookie generated for each session. For the Broadcast Agent Manager module, the system builds a session ID using a portion of the BCA task information. The Application ID. Status of the action result (level of error). Used only by Broadcast Agent to store task execution errors.

Application ID Error ID

This information corresponds to the user.log file when working in file mode and to the OBJ_A_EVENT_LOG table in the Audit database. For more information refer to Storing Audit Information in Database Mode on page 201.

Pausing audit activity


If there is enough activity in your Business Objects system at any given point (especially if you have activated the internal trace), the Log View window may receive so much information so rapidly that legible display is impossible. In this case, simply pause the display of the windows trace activity. This gives the display a chance to re-establish itself. To temporarily pause the display of the tracing activity, just click the Pause button. To renew tracing activity, click the Pause button again.

Tracing System Activity

System Administrators Guide for Windows

201

Storing Audit Information in Database Mode


When set to Database mode, the Audit facility records user and system information in the Audit database. This is a database which Auditor can access. Note that this does not occur with File Mode.

Events Recorded in the Audit Database


The Audit database contains eight tables, split into two groups. The first group of five reference tables provides variable information that describes your particular Business Objects system: OBJ_A_EVENT_LOG Events related to user activity OBJ_A_SITE_LOG Activity of Business Objects system modules OBJ_A_EVENT_DETL Details relevant to user events OBJ_A_CLUSTER Details relevant to a cluster OBJ_A_MAGICID Used to generate unique identifiers The second group of three lookup tables provides values that are fixed by the Audit facility: OBJ_A_EVENT_NAME Event ID (types of events) OBJ_A_APPLICATION Application ID OBJ_A_OBJECT_TYPE Event Detail ID

Storing Audit Information in Database Mode

202

System Administrators Guide for Windows

Reference tables
The following section lists the reference tables stored in the Audit database. User events This information corresponds to the OBJ_A_EVENT_LOG table in the Audit database. To view the table and the information in it when working in file mode, see Viewing User Activity on page 199.

Item A_EVLOG_N_ID A_EVLOG_N_TYPEID

Description References the event in the database. A number representing the type of event. Refers to OBJ_A_EVENT_NAME table.

A_EVLOG_D_STARTIME The time (year, month, day, hour, minute, second) at which the event began. A_EVLOG_N_DURATION Duration of the action in milliseconds (rounded up). If the event duration cannot be computed, the value is -1. A_EVLOG_C_USER A_EVLOG_C_SESSION User that caused the event to be logged. The user session ID. For InfoView and 3-tier BusinessObjects, the session ID is the cookie generated for each session. For the Broadcast Agent Manager module, the system builds a session ID using a portion of the BCA task information. The Application ID. Refers to OBJ_A_APPLICATION table. A_EVLOG_N_ERRORID A_EVLOG_C_HOST A_EVLOG_N_CLSTRID Status of the action result (level of error). Used only by Broadcast Agent to store task execution errors. Name of the machine on which the event was generated. Refers to A_CLUSTER_N_ID (ID of cluster on which the user event was generated) in OBJ_A_CLUSTER table.

A_EVLOG_N_APPID

Tracing System Activity

System Administrators Guide for Windows

203

System events This information corresponds to the OBJ_A_SITE_LOG table in the Audit database. To view the table and the information in it when working in file mode, see Viewing System Activity on page 198.

Item A_STLOG_N_ID

Description System event ID.

A_STLOG_N_LOGLEVEL Level of the event. This item was introduced in earlier versions. However, because of changes in the structure of Business Objects modules in the current version, the information logged for this item is no longer maintained. A_STLOG_D_LOGTIME A_STLOG_C_LOGHOST A_STLOG_C_LOGMODL A_STLOG_N_LOGPID A_STLOG_C_LOGINFO A_STLOG_N_CLSTRID The time (year, month, day, hour, minute, second) at which the event began. Name of the machine on which the event was generated. The name of the module that logged the event. Module process ID. An explanation of the event. Refers to A_CLUSTER_N_ID (ID of cluster on which the user event was generated) in OBJ_A_CLUSTER table.

Storing Audit Information in Database Mode

204

System Administrators Guide for Windows

User event details This information corresponds to the OBJ_A_EVENT_DETL table in the Audit database.

Item A_EVENT_N_ID

Description Event ID (event index number) Identifies the event with which the detail is associated (long integer). Object ID Item logged when the detail refers to an object in the repository that has an ID, such as documents, universes, or objects in the universe. The ID refers to the following tables: OBJ_M_REPOSITORY (for repository name) OBJ_M_UNIVERSES (for universe and object name) OBJ_M_DOCUMENTS (for document name) Event detail ID A number representing the type of the event detail (long integer). The ID refers to the OBJ_A_OBJECT_TYPE table. String that contains the detail information. For example, a document name or a browser version.

A_EVDET_N_OBJECTID

A_EVDET_N_OBJTYPID

A_EVDET_C_OBJNAME

Tracing System Activity

System Administrators Guide for Windows

205

Cluster information This information corresponds to the OBJ_A_CLUSTER table in the Audit database.

Item A_CLUSTER_C_NAME A_CLUSTER_N_ID ID generation details

Description Indicates the name of the cluster (primary node) Unique cluster ID generated by the OBJ_A_MAGICID table.

This audit table is solely used to generate unique identifiers. It cannot be joined to any other table. This information corresponds to the OBJ_A_MAGICID table in the Audit database.

Item A_MAGIC_N_ID A_MAGIC_C_NAME

Description Generates next available index value. Generates index name: EVENT_INDEX index for OBJ_A_EVENT_LOG SITE_INDEX index for OBJ_A_SITE_LOG CLUSTER_INDEX index for OBJ_A_CLUSTER VERSION value is 600

Storing Audit Information in Database Mode

206

System Administrators Guide for Windows

Lookup tables
The following section lists the lookup tables stored in the Audit database. Types of events Here is a list of the events associated with their Event Type ID.This information corresponds to the OBJ_A_EVENT_NAME table of the Audit database:

Event Type ID A_EVNAM_N_ID 1 2 3

Event A_EVNAM_C_NAME Logon Failed Logon Log Off (not always generated; i.e. when the system automatically ends a user session or when a user disconnects by crashing the browser, there is no logoff event) Get a list of Inbox documents Get a list of Corporate documents Get a list of Universes Send to users Publish Save Read Inbox document Read Corporate document Read Personal document Selection of Universe (the opening of the Web or Query Panel) Generation of list of values Execution of query Refresh of query from HTML Login successful Compute result

4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

Tracing System Activity

System Administrators Guide for Windows

207

Event Type ID 19 20 21 22 23 24

Event Refresh document Compute result after drill List of values Edit document Get document generated by reporter Get a CSV document (Comma Separated Value, for downloading WebIntelligence documents into spreadsheets) Refresh document after a prompt Reserved range limit Get list of Personal documents Apply format Open report from cache Execute macro (VB) Execute script (4.1) Download agnostic document * 3-tier BusinessObjects started Delete Inbox documents Delete Corporate documents Delete Personal documents Delete Scheduled documents Upload agnostic document * Get page Generate SQL Drill out of scope Create user Create group

25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

Storing Audit Information in Database Mode

208

System Administrators Guide for Windows

Event Type ID 45 46 47 48 49 50 51 52

Event Delete user Delete group Add user Remove user Set user properties Set profile Rename user Rename group

* Although we now use the term third-party documents to describe non Business Objects documents, the term agnostic is still used for the Event name. Applications In the log files or database, the applications are referenced by their ID. This information corresponds to the user.log file or the OBJ_A_APPLICATION table of the Audit database: Application ID A_APPLI_N_ID 1 2 3 4 5 6 7 8 9 10 Data A_APPLI_C_NAME Unknown application WebIntelligence 2.5 BOManager via WebIntelligence BusinessObjects 5.0 BOManager via Broadcast Agent 3-tier BusinessObjects WebIntelligence 2.6/2.7 WIReportServer WIQT Administration Server

There can be several Application IDs for WebIntelligence 6.x documents, as WebIntelligence 6.x is composed of multiple modules.

Tracing System Activity

System Administrators Guide for Windows

209

Types of event details The following event details are associated with events. This information corresponds to the OBJ_A_OBJECT_TYPE table of the Audit database. (The A_OTYPE_N_ID entry is referenced by the A_EVDET_N_OBJTYPID entry.)

Event Details A_OTYPE_N_ID 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 * 20 21 22

Data A_OTYPE_C_NAME Repository name Universe name Objects name User name Group name Number of lines Number of elements Document name Document size Browser IP Browser OS Browser name Total size of documents in list Description Category name Keywords Refresh options Overwrite SQL value Page number Document type Report name

Storing Audit Information in Database Mode

210

System Administrators Guide for Windows

Event Details 23 24 25 26 27 28 29 30 31 32 33

Data Parent group name Profile name Password Is enabled Must change password Can change password Objects security level Password checking Password limited validity Validity is periodic Validity period (days)

* Event detail19 is not generated automatically. If you want to generate event detail 19 you must activate it by setting the LogDetailSQLValue to 1 in the wisitelog.cfg file located in the following directory: $INSTALLDIR/nodes/<hostname>/<clustername>/config/servers

Tracing System Activity

System Administrators Guide for Windows

211

Monitored Events
Below is a detailed description of the 52 events that are monitored by the Audit facility. Each event is presented in its own table, in the following format: Event #27 Get List of Personal Documents

Description Applications

User accesses the Personal Documents list. (6) 3-tier BusinessObjects The workflow is Retrieve From Personal Documents (9) WIQT (7) Number of elements Number of documents in the Personal Documents list. (13) Total size of documents in list (in bytes) None Object ID has no significance for any of the data. 1 is logged.

Event details

Anticipated next event Remarks

Numbers in parentheses are one of the following: For Applications Application ID For Event Details Detail Type ID For Anticipated Next Event Event No For example, Event #27 (shown above) lists (6) 3-tier BusinessObjects as one of the applications that can generate this event. This means that the application name is 3-tier BusinessObjects and the Application ID is 6. Event #27 also lists, as one of the event details it can generate: (13) Total size of documents in list. This means that the event detail name is Total size of documents in list and the Event Detail ID is 13. Sometimes, an anticipated piece of data is not available. For example, because of changes in the structure of Business Objects modules in the current version, the information logged for certain items is no longer relevant, and therefore is no longer maintained. Nevertheless, the event or detail is still generated. When this occurs, a value of 1 is logged. When data refers to document names, the suffixes used are: *.rep for BusinessObjects documents

Monitored Events

212

System Administrators Guide for Windows

*.wqy for WebIntelligence 2.x documents *.wid for WebIntelligence 6.x documents *.agn for third-party documents (such as *.xls, *.doc, *.pdf) *.bqy for BusinessQuery documents When data refers to a new document (such as a query that is being built), the document name is ADHOC, and its ID is 1.
NOTE

Event details are always generated, unless stated otherwise.

Full-Client Documents
Activity related to full-client BusinessObjects documents may or may not be logged by the Audit facility, depending on the type of platform: 3-tier BusinessObjects Logged. The logging of events is very similar to that of thin-client documents. WIQT Logged. Standalone BusinessObjects Not logged. This is because the activity is performed entirely at the users machine; there is no connection to the Audit database.

Tracing System Activity

System Administrators Guide for Windows

213

Event #1 Logon Description Applications Event Details A session is opened for the user (9) WIQT (10) Administration Server (10) Browser IP (11) Browser OS Windows NT, etc. (12) Browser name IE 5.5, Netscape 4, etc. Anticipated next event Remarks (17) Login Successful (2) Failed Logon This event refers to any attempt to log in. Because the user is not yet authenticated, the logged user is Unknown. The next event, Login Successful, will contain the complete user name. The events duration is 1 because it cannot be provided. (This duration is the delay between clicking the WebIntelligence Login button and the appearance of the InfoView welcome page.) Object ID has no significance for any of the event details. 1 is logged. Even if 3-tier BusinessObjects is used to connect to the system, Application ID 9 (WIQT) is used because a WIQT handles the session. The Browser Name detail is the HTTP user agent that is retrieved from the HTTP server. When the login originates in 3-tier BusinessObjects, the http user agent is formatted as in the following example: BO/5.1 (build 5.1.1.22 ; UserLCID 0409 ; Windows NT 5.0.2195)

Monitored Events

214

System Administrators Guide for Windows

Event #2 Failed Logon Description Applications Event Details Anticipated next event Remarks User authentication failed (9) WIQT (10) Administration Server None None The erroneous user name is logged because the dedicated field (User Name) was filled in. Even if 3-tier BusinessObjects is used, Application ID 9 (WIQT) is used because a WIQT handles the session.

Event #3 Log Off Description Applications Event Details Anticipated next event Remarks User logs off from InfoView (9) WIQT (10) Administration Server None None The events duration is 1 because it cannot be provided. The event's user can be "unknown" if logged off by timeout or if the user closes the browser without logging out. Even if 3-tier BusinessObjects is used, Application ID 9 (WIQT) is used because a WIQT handles the session.

Tracing System Activity

System Administrators Guide for Windows

215

Event #4 Get List of Inbox Documents Description Applications User accesses the Inbox (6) 3-tier BusinessObjects The workflow is Retrieve from Users. (9) WIQT Event Details Anticipated next event Remarks (7) Number of elements (13) Total size of documents in list (in bytes). None Also recorded when the user refreshes the Inbox. Object ID has no significance for any of the details. 1 is logged.

Event #5 Get List of Corporate Documents Description Applications User accesses the list of Corporate documents, in accordance with the access rights assigned. (6) 3-tier BusinessObjects The workflow is Retrieve from Corporate Documents. (9) WIQT Event Details (7) Number of elements The number of documents in the Corporate Documents list. (13) Total size of documents in list (in bytes) (15) Category Name Anticipated next event Remarks None Also recorded when the user refreshes the Corporate Documents list. Object ID has no significance for any of the details. 1 is logged.

Monitored Events

216

System Administrators Guide for Windows

Event #6 Get List of Universes Description Applications Event Details Anticipated next event Remarks User accesses the list of universes during a document creation workflow. (6) 3-tier BusinessObjects (9) WIQT (7) Number of elements The number of universes available to the user. None Also recorded when the user refreshes the Universe list. Object ID has no significance for the detail Number of Elements. 1 is logged.

Tracing System Activity

System Administrators Guide for Windows

217

Event #7 Send to Users Description Applications Event Details User sends a document to another user. (6) 3-tier BusinessObjects (9) WIQT (1) Repository name Name of the document domain that will host the document to be sent. (8) Document name (9) Document size (in bytes) (4) User name One occurrence of this detail per targeted user (14) Description If none is entered by the user, this detail does not appear. (15) Category Name (16) Keywords If none are entered by the user, this detail does not appear. (17) Refresh options Refresh on Open, Refresh Manually, Scheduled Refresh, or None for thirdparty documents. Anticipated next event Remarks None Object ID has no significance for the details Document Size, User Name, Description, Keywords, and Refresh Options. 1 is logged. If Application ID is (6) the details are: (1),(8),(9),(4),(15),(17) If Application ID is (9) the details are: (1),(8),(9),(4),(14),(16),(17) Detail (17) is never recorded for third-party documents.

Monitored Events

218

System Administrators Guide for Windows

Event #8 Publish Description Applications User publishes a document to Corporate documents. (5) BOManager via Broadcast Agent (9) WIQT (6) 3-tier BusinessObjects Event Details (1) Repository name Name of the document domain that will host the document to be sent. (8) Document name (9) Document size (in bytes) (5) Group name (14) Description If none is entered by the user, this detail does not appear. (16) Keywords If none are entered by the user, this detail does not appear. (17) Refresh options Refresh on Open, Refresh Manually, Scheduled Refresh, or None for thirdparty documents. (15) Category name One occurrence of this detail per category. Not generated if no category is selected. (18) Overwrite True or false. Anticipated next event Remarks None For this event, the duration is 1 because it cannot be provided. Object ID has no significance for the details Document Size, Description, Keywords, Refresh Options, and Overwrite. 1 is logged. If BOManager via Broadcast Agent logs the event, the object ID has no significance for the detail Repository name. 1 is logged. The document size of a .rep file is not the same if it is audited through InfoView/WebIntelligence SDK or 3tier BusinessObjects. Detail (17) is never recorded for third-party documents.

Tracing System Activity

System Administrators Guide for Windows

219

Event #9 Save Description Applications Event details User saves a document in the Personal documents list. (9) WIQT (8) Document name (9) Document size (in bytes) (14) Description If none is entered by the user, this detail does not appear. (16) Keywords If none are entered by the user, this detail does not appear. (17) Refresh options Refresh on Open, Refresh Manually, Scheduled Refresh, or None for thirdparty documents. (15) Category name One occurrence of this detail per category. Not generated if no category is selected. (18) Overwrite True or false. Anticipated next event Remarks None For this event, the duration is 1 because it cannot be provided.

Monitored Events

220

System Administrators Guide for Windows

Event #10 Read Inbox Document Description Applications User opens a document from the Inbox. (6) 3-tier BusinessObjects (8) WIReportServer Valid for .wid documents on InfoView/WebIntelligence SDK (3) BOManager via WebIntelligence When actions are performed on full-client documents via InfoView. (9) WIQT Event details (1) Repository name Name of the document domain where the document originates. Domain ID is also logged. (8) Document name (9) Document size (in bytes) Anticipated next event (33) Download agnostic document Only if the document that was read is third-party (agnostic) and the Application ID is 9 (WIQT). (10) Read Inbox document If the Application ID is 3, the same event may follow with an Application ID of 9, because both BOManager and WIQT are involved when non-cached Full Client documents are read through InfoView. (23) Get document generated by reporter Only if the Application ID is 9 and the document read is Full Client. Remarks If the Application ID is 9, the duration is 1 because it cannot be provided. If the Application ID is 3, it is logged with the correct value. Object ID has no significance for the Document Size detail. 1 is logged. If BOManager via WebIntelligence logs the event, the object ID has no significance for the detail Repository name. 1 is logged.

Tracing System Activity

System Administrators Guide for Windows

221

Event #11 Read Corporate Document Description Applications User opens a document from the Corporate Documents list. (6) 3-tier BusinessObjects (8) WIReportServer (3) BOManager via WebIntelligence When actions are performed on full-client documents via InfoView. (9) WIQT (5) BOManager via Broadcast Agent Event details (1) Repository name Name of the document domain where the document originates. Domain ID is also logged (not by Application ID #3). (8) Document name (9) Document size (in bytes) Anticipated next event (33) Download agnostic document Only if the document that was read is third-party (agnostic) and the Application ID is 9 (WIQT). (11) Read Corporate document If the Application ID is 3, the same event may follow with Application ID of 9, because both BOManager and WIQT are involved when non-cached Full Client documents are read through InfoView. (23) Get document generated by reporter Only if the Application ID is 9 and the document read is Full Client. Remarks If Application ID is 9, the duration is 1 because it cannot be provided. Object ID has no significance for the Document Size detail. 1 is logged. If BOManager via WebIntelligence logs the event, the object ID has no significance for the detail Repository name. 1 is logged.

Monitored Events

222

System Administrators Guide for Windows

Event #12 Read Personal Document Description Applications User opens a Personal document. (6) 3-tier BusinessObjects (8) WIReportServer (3) BOManager via WebIntelligence When actions are performed on full-client documents via InfoView. (9) WIQT Event details Anticipated next event (8) Document name (9) Document size (in bytes) (33) Download agnostic document Only if the document that was read is third-party (agnostic) and the Application ID is 9 (WIQT). (12) Read Personal document If the Application ID is 3, the same event may follow with an Application ID of 9, because both BOManager and WIQT are involved when non-cached Full Client documents are read through InfoView. (23) Get document generated by reporter Only if the Application ID is 9 and the document read is Full Client. Remarks If Application ID is 9, the duration is 1 because it cannot be provided. Object ID has no significance for the Document Size detail. 1 is logged.

Tracing System Activity

System Administrators Guide for Windows

223

Event #13 Selection of Universe Description Applications Event details Anticipated next event Remarks User selects a universe during a document creation workflow. (6) 3-tier BusinessObjects (8) WIReportServer (2) Universe name None The events duration is 1 because it cannot be provided.

Event #14 Generation of List of Values This event was replaced by event #21, List of Values. Event #15 Execution of Query This event was replaced by the following two events: #18, Compute Result #20, Compute Result After Drill Event #16 Refresh of Query From HTML This event was replaced by the following two events: #19, Refresh Document #25, Refresh Document After a Prompt

Monitored Events

224

System Administrators Guide for Windows

Event #17 Login Successful Description User authentication successful. The user name is then logged because the dedicated field has been filled in. (9) WIQT (10) Administration Server Event details Anticipated next event Remarks None None Even if 3-tier BusinessObjects is used, Application ID 9 (WIQT) is used, because a WIQT handles the session.

Applications

Tracing System Activity

System Administrators Guide for Windows

225

Event #18 Compute Result Description Generated when the user refreshes a thin-client document or clicks on the Run Query button in the Query Panel (for thin-client documents only). (6) 3-tier BusinessObjects (3) BOMananger via WebIntelligence (9) WIQT Event details (6) Number of lines - The number of lines retrieved. (1) Repository name - Name of the document domain where the document originates. Not generated by 3-tier BusinessObjects (2) Universe name - The universe on which the document is based. (8) Document name (9) Document size (in bytes) (3) Object name - One occurrence of this detail per object. (19) SQL Value detail - Logs the value of the SQL statement that is generated for a refreshed document or a new ad-hoc query. Several details may be logged according to sentence length: each detail stores a 254-character section of the SQL sentence, as a slice number allows the sentence to be rebuilt for further analysis. This value is stored in the column A_EVDET_N_OBJECTID. Anticipated next event Remarks None Using detail #19 can result in a large number of rows in the database, so its activation is optional. It can be activated manually in the wisitelog.cfg file located in the following directory: $INSTALLDIR/nodes/<hostname>/<clustername>/ config/servers by setting the LogDetailSQLValue to 1. By default the value is 0 and the detail is not logged.

Applications

Monitored Events

226

System Administrators Guide for Windows

Event #19 Refresh Document Description Applications User refreshes a document. (6) 3-tier BusinessObjects (3) BOManager via WebIntelligence When actions are performed on full-client documents via InfoView. (9) WIQT (8) WIReportServer Event details (1) Repository name Name of the document domain where the document originates. Not generated by 3-tier BusinessObjects, and not generated by WebIntelligence for *.rep documents. (2) Universe name The universe on which the document is based. (3) Object name One occurrence of this detail per object. (6) Number of lines Number of lines retrieved. (8) Document name Anticipated next event Remarks None The duration of this event for application (3) takes into account the time it takes to refresh the document but does not include the time it takes to display the report in the browser.

Tracing System Activity

System Administrators Guide for Windows

227

Event #20 Compute Result After Drill Description Applications Event details A query is performed as the result of a drill action. (9) WIQT (6) Number of lines The number of lines retrieved. (1) Repository name Name of the document domain where the document originates. (2) Universe name The universe on which the document is based. (8) Document name (3) Object name One occurrence of this detail per object. This includes all objects used to create the document and all objects involved in the drill hierarchy. Anticipated next event Remarks None None

Event #21 List of Values Description Applications A list of values is accessed or generated. (6) 3-tier BusinessObjects (8) WIReportServer (9) WIQT Event details (6) Number of lines Number of lines retrieved. (2) Universe name The universe on which the document is based. (3) Object name Name of the object for which the LoV is generated. Anticipated next event Remarks None None

Monitored Events

228

System Administrators Guide for Windows

Event #22 Edit Document Description Applications Event details Anticipated next event Remarks A user edits a WebIntelligence document (6) 3-tier BusinessObjects (8) WIReportServer (8) Document name None The events duration is 1 because it cannot be provided. A *.rep file edited on InfoView is automatically passed to 3-tier BusinessObjects.

Event #23 Get Document Generated by Reporter Description Applications Event details Anticipated next event Remarks User accesses a full-client document through InfoView. (9) WIQT (8) Document name None The events duration is 1 because it cannot be provided.

Tracing System Activity

System Administrators Guide for Windows

229

Event #24 Get a CSV Document Description Applications Event details Anticipated next event Remarks User downloads a WebIntelligence document and loads it into a spreadsheet. (9) WIQT (8) Document name None The download is performed through the generation of a CSV document (Comma Separated Value). The stream is sent via http with the mime.type text/csv. The browser then handles the result. Also generated when the user downloads a *.rep document. No event is generated when a *.rep or *.wid file is downloaded in Excel format or if a *.pdf document is downloaded. The events duration is 1 because it cannot be provided.

Monitored Events

230

System Administrators Guide for Windows

Event #25 Refresh Document After a Prompt Description Applications A document prompt is filled in, and the consecutive refresh is performed. (8) WIReportServer (3) BOManager via WebIntelligence (9) WIQT Event details (6) Number of lines Number of lines retrieved. (1) Repository name Name of the document domain where the document originates. (2) Universe name The universe on which the document is based. (8) Document name (3) Object name One occurrence of this detail per object. Anticipated next event Remarks None Not generated for 3-tier BusinessObjects

Event #26 Reserved Range Limit Description This event was created in order to resolve a maintenance issue. In prior versions, this event represented an ID range limit. None None None None

Applications Event details Anticipated next event Remarks

Tracing System Activity

System Administrators Guide for Windows

231

Event #27 Get List of Personal Documents Description Applications User accesses the Personal Documents list. (6) 3-tier BusinessObjects The workflow is Retrieve From Personal Documents (9) WIQT Event details (7) Number of elements Number of documents in the Personal Documents list. (13) Total size of documents in list (in bytes) Anticipated next event Remarks None Object ID has no significance for any of the data. 1 is logged.

Event #28 Apply Format Description Applications Event details Anticipated next event Remarks User edits a document by Apply Format from the Query panel. (8) WIReportServer (8) Document name (22) Report name None The events duration is 1 because it cannot be provided. Object ID generates one Report name detail per report contained in the document.

Monitored Events

232

System Administrators Guide for Windows

Event #29 N/A Description This event was created in order to resolve a maintenance issue. Not implemented in the current version. None None None None

Applications Event details Anticipated next event Remarks

Event #30 Open Report From Cache Description Applications Event details Anticipated next event Remarks BOManager retrieves a document from the cache during a batch workflow. (3) BOManager via WebIntelligence (8) Document name (9) Document size (in bytes) None Object ID has no significance for the details Document size and Document name. 1 is logged.

Event #31 Execute Macro (VB) Description Applications Event details Anticipated next event Remarks BOManager executes a macro stored in the document, during a batch workflow. (5) BOManager via Broadcast Agent (8) Document name (9) Document size (n bytes) None None

Tracing System Activity

System Administrators Guide for Windows

233

Event #32 Execute Script (4.1) Description Applications Event details Anticipated next event Remarks BOManager executes a script stored in a 4.1 document, during a batch workflow. None None None This event was recorded up to version 5.1 of BusinessObjects. It is no longer implemented for BusinessObjects 6.x.

Event #33 Download Agnostic Document Description Applications Event details Anticipated next event Remarks User accesses an third-party (agnostic) document Corporate, Inbox, or Personal. (9) WIQT (8) Document name (9) Document size (in bytes) None The events duration is 1 because it cannot be provided. Linking this event with the previous one allows a complete analysis of the download workflow, because the event read provides information about the document (such as its size).

Monitored Events

234

System Administrators Guide for Windows

Event #34 3-tier BusinessObjects Started Description Applications Event details Anticipated next event Remarks 3-tier BusinessObjects is launched, either from InfoView or directly from the end-user desktop. (6) 3-tier BusinessObjects None None None

Event #35 Delete Inbox Documents Description Applications Event details Anticipated next event Remarks User deletes a document from the Inbox. (6) 3-tier BusinessObjects (9) WIQT (8) Document name One occurrence of this detail for each document deleted. None The events duration is 1 because it cannot be provided.

Event #36 Delete Corporate Documents Description Applications Event details Anticipated next event Remarks User deletes a document from the Corporate list. (6) 3-tier BusinessObjects (9) WIQT (8) Document name One occurrence of this detail for each document deleted. None The events duration is 1 because it cannot be provided.

Tracing System Activity

System Administrators Guide for Windows

235

Event #37 Delete Personal Documents Description Applications Event details Anticipated next event Remarks User deletes a document from the Personal documents list. (9) WIQT (8) Document name One occurrence of this detail for each document deleted. None The events duration is 1 because it cannot be provided. Not available for 3-tier BusinessObjects.

Event #38 Delete Scheduled Documents Description Applications Event details Anticipated next event Remarks User deletes a task from the Scheduled Documents list. (6) 3-tier BusinessObjects (9) WIQT (8) Document name One occurrence of this detail for each document or task deleted. None The events duration is 1 because it cannot be provided.

Monitored Events

236

System Administrators Guide for Windows

Event #39 Upload Agnostic Document Description Applications Event details User clicks the Add a document link in the Home page. (9) WIQT (8) Document name The name of the document requested by the user. (9) Document size (in bytes) Anticipated next event Remarks None The document extension is always *.agn. For example, if the user requests a document named MyDocument.pdf, the event detail will contain the name MyDocument.pdf.agn.

Event #40 Get Page Description Applications Event details User retrieves and displays one or more pages of a WebIntelligence 6.x (.wid) document. (8) WIReportServer (8) Document name (20) Page range Pages retrieved (21) Document type Can be XLS, PDF, or XML (22) Report name Anticipated next event Remarks None None

Tracing System Activity

System Administrators Guide for Windows

237

Event #41 Generate SQL Description Applications Event details This event is generated when a WebIntelligence 6.x document is refreshed. (8) WIReportServer (1) Repository name (2) Universe name (3) Object name One occurrence per object used to build the query (6) Number of lines (8) Document name (19) SQL value Anticipated next event Remarks None Using detail #19 can result in a large number of rows in the database, so its activation is optional. It can be activated manually in the wisitelog.cfg file located in the following directory: $INSTALLDIR/nodes/<hostname>/<clustername>/ config/servers by setting the LogDetailSQLValue to 1. By default the value is 0 and the detail is not logged.

Monitored Events

238

System Administrators Guide for Windows

Event #42 Drill out of Scope Description Generated for a WebIntelligence 6.x document when the user drills through one level in the hierarchy. (8) WIReportServer (1) Repository name (2) Universe name (3) Object name One occurrence per object used to build the query (6) Number of lines (8) Document name (19) SQL value Anticipated next event Remarks None Using detail #19 can result in a large number of rows in the database, so its activation is optional. It can be activated manually in the wisitelog.cfg file located in the following directory: $INSTALLDIR/nodes/<hostname>/<clustername>/ config/servers by setting the LogDetailSQLValue to 1. By default the value is 0 and the detail is not logged.

Applications Event details

Event #43 Create User Description Applications Event details Generated when creating a user using the Administration Server. (10) Administration Server (4) User name (23) Parent group name (24) Profile name Anticipated next event Remarks None None

Tracing System Activity

System Administrators Guide for Windows

239

Event #44 Create Group Description Applications Event details Anticipated next event Remarks Generated when creating a group using the Administration Server. (10) Administration Server (5) Group (23) Parent group name None None

Event #45 Delete User Description Applications Event details Anticipated next event Remarks Generated when deleting a user using the Administration Server. (10) Administration Server (4) User name None None

Event #46 Delete Group Description Applications Event details Anticipated next event Remarks Generated when deleting a group using the Administration Server. (10) Administration Server (5) Group name None None

Monitored Events

240

System Administrators Guide for Windows

Event #47 Add User Description Applications Event details Generated when adding a user using the Administration Server. (10) Administration Server (4) User name (23) Parent Group name (24) Profile name Anticipated next event Remarks None None

Event #48 Remove User Description Applications Event details Anticipated next event Remarks Generated when removing a user using the Administration Server. (10) Administration Server (4) User name (23) Parent Group name None None

Tracing System Activity

System Administrators Guide for Windows

241

Event #49 Set User Properties Description Applications Event details Generated when setting user properties using the Administration Server. (10) Administration Server (4) User name (25) Password (26) Is enabled (27) Must change password (28) Can change password (29) Object security level (30) Password checking (31) Password limited validity (32) Validity is periodic (33) Validity period (days) Anticipated next event Remarks None Only modified properties are logged. Event details Password limited validity, Validity is periodic and Validity period (days) are logged together.

Event #50 Set Profile Description Applications Event details Generated when setting a users profile using the Administration Server. (10) Administration Server (4) User name (23) Parent Group name (24) Profile name Anticipated next event Remarks None None

Monitored Events

242

System Administrators Guide for Windows

Event #51 Rename User Description Applications Event details Anticipated next event Remarks Generated when renaming a user using the Administration Server. (10) Administration Server (4) User name None None

Event #52 Rename Group Description Applications Event details Anticipated next event Remarks Generated when renaming a group using the Administration Server. (10) Administration Server (5) Group name None None

Tracing System Activity

System Administrators Guide for Windows

243

The Business Objects Trace Facility


The trace facility is delivered with the Business Objects system 6.x to help you diagnose and analyze problems that may arise either during system setup or when the system is running. A trace is a simple message containing run time information that is written by a program into a text file. These trace messages are inserted into different parts of Business Objects code and contain information that is considered useful for your understanding of how the system functions. To avoid the impact numerous disk writes have on performance, traces can be turned on and off and set to a certain level of detail by editing a trace configuration file. Because trace is only a tool for diagnostics, trace messages are in English and are not localized.

What does the trace do?


Trace files give you information on user actions and main workflows such as: Session establishment, login and logout Browsing and refresh list workflows Create, edit, refresh, save and publish document workflows BCA workflows They can also give you detailed information on administrative workflows such as: Startup Shutdown Configuration issues Administration issues Calls between the different system modules Warning and error messages Trace messages are associated with an importance rating to give you an indication of how critical the message is. You determine the level of importance of a trace message that you want to view when you create the trace file. For more information, see Trace importance on page 248.

The Business Objects Trace Facility

244

System Administrators Guide for Windows

Before starting the Business Objects system


There are two things you must do before you can activate a trace. You must: run the Configuration Tool and configure the ORB and web server(s) create the trace configuration file (by default it is called BO_trace.ini). Setting environment variables The Configuration Tool sets the environment variables transparently to a default directory when you configure the Business Objects system. With Windows the variables are set in the script: $INSTALLDIR/nodes/<hostname>/<clustername>/webi.bat By default the script sets the BO_TRACE_CONFIGDIR directory to the following directory: $INSTALLDIR\nodes\<hostname>\<clustername>\logs By default the script sets the BO_TRACE_LOGDIR directory to the following directory: $INSTALLDIR\nodes\<hostname>\<clustername>\logs You can change the default directory by choosing cluster preferences in the Configuration Tool. For more detailed information, refer to the Installation and Configuration Guide. You can also change the default directory by setting the BO_TRACE_CONFIGDIR and BO_TRACE_LOGDIR files to a different directory in the webi.bat script.

Tracing System Activity

System Administrators Guide for Windows

245

Creating the trace configuration file You can use any text editor to create the trace configuration. In the logs folder create a new Text Document and rename the file BO_trace.ini. Open the file and enter the following syntax:
active = true; importance = '>='; size = 10000; keep = true;

NOTE

No field is mandatory. The default value is used for any fields that have not been specified. You can add comments after every row by placing a // or # before the comment.

The Business Objects Trace Facility

246

System Administrators Guide for Windows

The following table explains the parameters you can set for the trace configuration file: Parameter active importance Type Syntax true/false <<, <=, ==, >=, >> int Default Value false == Use Tells you if a trace is active or not. To activate the trace, set it to true. Importance level above which traces emitted by the system are written into the trace file. Maximum number of lines per trace file. When the maximum number of lines is reached a new trace file is generated. When set to true the old trace files are kept when the new one is created. A new trace file is generated when the trace file reaches its maximum size. By default the maximum size of a trace file is 10 000 lines. When a new trace file is generated the old trace file is removed if the parameter keep is set to false in the BO_trace.ini file.

size

10000

keep

true/false

false

Tracing System Activity

System Administrators Guide for Windows

247

Configuring a module-specific trace By default, settings in the trace configuration file are common for all modules and all processes that use the trace facility. However, you can obtain a trace for a specific module or process by adding conditions in the trace configuration file. To set parameters for a specific module, use the following condition: if ( name == "ModuleName" ) { ... }

EXAMPLE The following condition activates the trace for the WISessionManager module only:

active = false; if ( name == "WISessionManager" ) { active = true; size keep } You can also set a condition for a specific process ID. To do that you must use the following condition: if ( pid == PID ) { ... } = 100000; = false;

The Business Objects Trace Facility

248

System Administrators Guide for Windows

EXAMPLE The following condition activates the trace for the process with PID 10200 only:

active = false; if ( pid == 10200 ) { active = true; size = 100000; keep = true; } If you modify the trace configuration file during runtime, as the file is read at regular intervals, you will only have to wait 1 minute for the modification to be taken into account. You do not have to stop the Business Objects server.
NOTE

Trace log files are generated only by the following modules: BOManager, WIAPIBroker, WIReportServer, WIClusterManager, WILoginServer, WIQT, WISessionManager, WISiteLog, WIStorageManager, Administration Server, BCA Scheduler, and WIAdminBOTools. Trace importance Trace messages are classified by their importance. There are 5 different levels of importance for a trace:

XS S M L XL

lowest level, an insignificant trace low level, a trace of little importance a normal trace high level, an important trace highest level, a very important trace

There are also two more levels for errors: Warning Error recoverable error fatal error

Tracing System Activity

System Administrators Guide for Windows

249

NOTE

Warning and Error are mapped on the L and XL trace level. In most cases a severity column dedicated to warnings and errors can be found in trace output files. When you activate the trace, you can choose the level of importance youd like to view your trace files with. So, if you set the trace to level S, only trace messages of the importance level S or higher will be written to the trace file. To select or modify the level above which messages are written into the trace file you must edit the trace configuration file (BO_trace.ini) and set the importance field to one of these values: << Equals XS, the lowest level. This will write all traces. <= Equals S, indicating a trace of small importance. This will write traces emitted at and above the low level (S, M, L, XL, Warning and Errors). == Indicates a trace of normal importance. This will write traces emitted at and above the normal level (M, L, XL, Warning and Errors). >= Indicates a trace of high importance. This will write traces emitted at and above the high level (L, XL, Warning and Errors). >> Equals XL, a very important trace. This will write only the traces emitted at the highest level and errors. These symbols can be alphabetically sorted and enable filtering (using "is greater than" filter) in Excel for instance.

Viewing a trace
Traces generated by a process are contained in the files called: <process name>_<pid>_<date>.log You can view the trace log file using any text editor.
NOTE

The time given in your trace files is the GMT date/time and not the server time.

The Business Objects Trace Facility

250

System Administrators Guide for Windows

Tracing System Activity

System Administrators Guide for Windows

251

Index
A
access rights 51 activating the audit facility 187-191 Active X viewer 141 administration what module parameters you can set 127 Administration Console activating audit facility at cluster level 188 activating audit facility per module 191 activating the correct authentication driver 110 authentication methods 102-105 changing locale and charset 96 deployment information 81 displaying the global report 98 enabling and disabling modules 123 enabling and disabling servers 115 ending user sessions 101 Host page 90 interface 89 Logged-in users button 100 logging in 85 modifying access 56 Module page 91 online help settings 93 overview 30 refreshing display 99 Report page 92 security commands 86 starting 82 storing information in database mode 201 storing information in file mode 195 synchronizing key files 97 tracing system activity 183-249 using the status bar 94 using the top bar 92 viewing list of logged-in users 100 viewing site properties 95 what module parameters you can set 127 Administration Server 171 Cleanup period 172 Client session timeout 172 deployment advice 126 enablement rules 124 Inactivity timeout 172 parameters 172 administrative layers 31 itconfig_rep 33 itlocator 33 itnaming 33 itnode_daemon 33 Orbix 2000 processes 33 WIAdminBOTools 32 WIClusterManager 32 WIClusterNode 32 WIProcessManager 32 WISiteLog 33 Apache specifying authentication method 109 Application ID 208 Application Server Framework see ASF ASF 26, 35 communication 26 how CORBA clients and servers communicate 26 Audit facilities overview 29 Audit facility 184-242 .agn documents 212 .bqy documents 212 .rep documents 211 .wid documents 212 .wqy documents 212 activating at cluster level 188 activating per module 191 activating the audit facility 187-191 Audit database 184, 201

Index

252

System Administrators Guide for Windows

Audit database connection 189 creating secured connection to Audit database 185 events recorded in database 201 Maximum cache size 189 modifying storage location 196 modules logged 187 monitored events 211-242 pausing audit activity 200 setting database mode parameters 189 storing information in database mode 201 storing information in file mode 195 viewing log files 196 viewing system activity 198 viewing user activity 199 Audit log files modifying storage location 196 modules logged 187 sm.log 195 user.log 195 userdet.log 195 viewing 196 auditing Applications 208 Event details 209 Event Type ID 206 events recorded 201 Auditor overview 29 authentication methods 102-105 basic authentication 104 Business Objects standard 104 no authentication 104 restrictions 105 selecting in Administration Console 109 specifying 106-109 specifying from Apache 109 specifying from IIS 107 Windows authentication 103 automatic system startup 47

B
basic authentication 104 when not to use basic authentication 104 when to use basic authentication 104 BO_trace.ini file 244 bomain.key file 43 synchronizing 97 BOManager 144 auditing 187 BusObj processes 145 caching Broadcast Agent login information 145 caching BusinessObjects documents 146 definition 144 deployment advice 126 Enable macros for interactive users 152 enablement rules 124 interactive refresh 153 Keep exclusive process 150 Kill BusObj processes on startup 148 Max. number of busy processes 148 Max. number of loaded processes 148 Min. number of loaded processes 149 parameters 147 Timeout for batch actions 152 Timeout for interactive actions 152 what it does 144 Broadcast Agent assigning Scheduler parameters 159 cache essentials 146 caching login information 145 monitoring Broadcast Agents 155 Schedulers 154 Broadcast Agent Manager 154 Delay for auto shutdown 163 deployment advice 126 Domain name (key file) 160 enablement rules 124 enabling processing of BusinessObjects documents 161 enabling processing of WebIntelligence documents 161 Max. duration 161 Nb. max retry jobs 162 Number of BOMgr to try 164 parameters 160

Index

System Administrators Guide for Windows

253

Period for purge 163 Purge jobs 163 Purge only successful jobs 163 Scanning repository delay 160 Update repository delay 161 Business Objects consulting services 11, 13 documentation 10 Documentation Supply Store 9 support services 11 trace facility 243-249 training services 11, 13 Business Objects security 174 Business Objects standard 104 Business Objects system administrating 30 administrative layer components 31 ASF 26 Audit facility 184-242 authentication methods 102-105 client tier 19 communication of components 26 database components 21 enabling and disabling modules 123 enabling and disabling servers 115 how CORBA clients and servers communicate 26 middle tier 19 overview 17-21 presentation layer 20 processes on startup 49 processing layer 20 security overview 28 starting 45-50 stopping 62 supported databases 184 trace facility 243-249 what has changed 34 which products use the system 21 BusinessObjects allowing an installation from InfoView 58 caching documents 146 working offline 61 BusinessObjects documents enabling Broadcast Agent processing 161

BusinessObjects processes 145 killing 148 setting max. number of busy processes 148 BusObj processes killing 148

C
caches enabling double caching of WILoginServer 177 maximum size for Audit cache 189 repository cache duration 137 WILoginServer 173 WILoginServer cache refresh 174 caching Broadcast Agent login information 145 BusinessObjects documents 146 double 175 list of values for WIReportServer 167 charset changing 96 client tier 19 cluster nodes defined 23 clusters and time zones 25 full-client load balancing 121 module deployment advice 126 module enablement rules 123 overview 23 possible configuration 125 thin-client load balancing 120 Common Request Broker Architecture see CORBA consultants Business Objects 11 CORBA 31 how CORBA clients and servers communicate 26 customer support 11 customizing default formats for WebIntelligence documents 55

Index

254

System Administrators Guide for Windows

D
database components 21 database connections and auditing 201 database mode definition of audit storage 187 databases Audit database connection parameter 189 creating secured connection to Audit database 185 storing audit information in 201 supported 184 default formats for WebIntelligence documents 55 default new user profile 52 Delay for auto shutdown 163 demo materials 9 Developer Suite 10, 12 document domain defined 43 period for purge 163 purge jobs 163 purge only successful jobs 163 documentation CD 9 feedback on 10 on the web 9 printed, ordering 9 roadmap 9 search 9 Documentation Supply Store 9 Domain name (key file) parameter 160 drivers activating the correct authentication driver 110 dynamic server pages processing by web layer 20

E
education see training Enable batch processing parameter 129 Enable interactive processing parameter 129 Enable macros for interactive users parameter 152 enabling double caching 177 enabling modules 123 environment variables setting 244 Essbase configuration utility 76 Event details 209 Event Type ID 206 events monitored 211-242 recorded 201

F
failover overview 22 feedback on documentation 10 file mode definition of audit storage 187

G
generating trace BO_trace.ini file 245 global report 98

H
Help configuring browser settings 93 Host page 90

I
IIS (Microsoft Internet Information Server) auto-restart parameter 118 specifying authentication method 107 specifying authentication method for OLAP InfoView installing BusinessObjects from 58 installation directory default values 42

Index

System Administrators Guide for Windows

255

installing BusinessObjects from InfoView 58 interactive refresh 153 interface Administration Console 89 Iona Orbix 2000 processes 33 itconfig_rep Orbix 2000 process 33 itlocator Orbix 2000 process 33 itnaming Orbix 2000 process 33 itnode_daemon Orbix 2000 process 33

Login Server see WILoginServer lsi file 173 how is it generated 173

M
MachineManager 32 managing default InfoView user options 52 user access 51 Max. active time parameter (WIQT) 179 Max. active time parameter (WIReportServer) 166 Max. inactive time parameter (WIQT) 179 Max. inactive time parameter (WIReportServer) 166 Max. number of busy process parameter 148 Max. number of documents per instance parameter 167 Max. number of loaded processes parameter 148 Microsoft Internet Information Server see IIS middle tier 19 Min. number of loaded processes parameter 149 modifying Administration Console access 56 Module page 91 modules Administration Server 171 BOManager 144 Broadcast Agent Manager 154 deployment advice 126 enablement rules 123 enabling and disabling 123 modifying settings 128 WIADEServer 140 WIAPIBroker 142 WIDispatcher 131 WILoginServer 173 WIQT 178 WIReportServer 165 WISessionManager 132 WIStorageManager 134 monitored events 211-242 multimedia quick tours 10

K
Keep exclusive process parameter 150 key files .key file 43 synchronizing 97 Knowledge Base 12

L
load balancing 119-121 definition 119 full client 121 Node weight 119 overview 22 thin client 120 weighting a server 119 locale changing 96 localnode.xml file defined 49 log files modifying storage location 196 modules logged 187 sm.log 195 user.log 195 userdet.log 195 viewing 196 logging into the Administration Console 85 bomain.key file 85

Index

256

System Administrators Guide for Windows

N
no authentication 104 Node weight 119 setting 118 nodes Primary node 24 Secondary node 25 number of WIQT instances 179

O
Object Request Broker see ORB offline mode working in 61 OLAP changing interface look and feel 77 configuring OLAP folder security 64 creating a connection 71 creating and viewing charts 68 deleting a connection 75 editing a connection 73 interface restrictions 77 security and authentication 65 setting connections to OLAP data sources 71 specifying authentication method on a Windows 2000 server Online Customer Support 11 Online help configuring browser settings 93 ORB Orbix 2000 Orbix 2000 processes 33

WIReportServer 165 WISessionManager 132 WIStorageManager 136 pausing audit activity 200 Period for purge parameter 163 presentation layer defined 20 Primary node 24 defined 23 what it does 24 processes BusObj 145 Orbix 2000 processes 33 processing layer 20 Purge jobs parameter 163 Purge only successful jobs parameter 163 purging documents from document domain 163 purging documents Broadcast Agent has processed 163

R
recorded events 201 refreshing the WILoginServer 176 Report Catalog API 141 Report page 92

S
scalability overview 22 scanning repository delay 160 Scheduler assigning parameters 159 Schedulers 154 search documentation 9 Secondary node 25 defined 23 what it does 25 security OLAP security and authentication 65 overview 28 WILoginServer 174

P
parameters Administration Server 172 Audit facility 189 BOManager 147 Broadcast Agent Manager 160 server 117 WIADEServer 140 WIAPIBroker 142 WILoginServer 176 WIQT 178

Index

System Administrators Guide for Windows

257

security commands 86 which ones can be applied 87 security domain .key file 43 defined 43 servers deployment advice 126 enabling and disabling 115 IIS auto-restart parameter 118 parameters 117 weighting in cluster 119 session stack Enable batch processing 129 Enable interactive processing 129 modifying settings 130 setting session reactivation period 167 setting session validation frequency 167 setting time between WILoginServer refresh 176 setting timeout for batch actions 152 setting timeout for interactive actions 152 setting up the Audit database 184-186 shutdown 62 site properties changing locale 96 synchronizing key files 97 viewing 95 SiteManager 32 sm.log 195 changing location 196 Start menu starting the system using 45 starting the Administration Console 82 starting the system 45-50 automatically 47 using the Start menu 45 using WINotify 45 startup 45-50 processes running 49 status bar 94 stopping the Business Objects system 62 storage enabling shared storage 139

storage directory 134 deleting users 136 docs directory 136 list directory 135 mail directory 135 user directory 135 storing audit information in database mode definition 187 storing audit information in file mode definition 187 Supervisor creating secured connection to Audit database 185 predefined settings 87 setting up account information 110 supervisor security commands 86 support customer 11 system administrative layer components 31 checking status 45 starting 45-50 stopping 62 what has changed 34 system activity viewing 198 system components ASF 26 communication 26

T
tiers client tier 19 database components 21 middle tier 19 time zones and clusters 25 Timeout for batch actions parameter 152 Timeout for interactive actions parameter 152 Tips & Tricks 10 top bar 92 trace configuration file creating 245 creating module-specific 247

Index

258

System Administrators Guide for Windows

trace facility 243-249 creating module-specific trace 247 creating trace configuration file 245 requirements 244 setting environment variables 244 trace importance 248 what it does 243 trace framework viewing 249 trace importance 248 tracing methods 183-249 training on Business Objects products 11

V
viewing last refresh duration of WILoginServer 177 log files 196 system activity 198 trace 249 user activity 199

W
web customer support 11 getting documentation via 9 useful addresses 12 webi.bat 244 webi.bat script how it starts the node 48 how it stops the node 62 webi.bat stop file 62 WebIntelligence changing interface look and feel for OLAP 77 interface restrictions for OLAP 77 WIReportServer 165 WebIntelligence documents enabling Broadcast Agent processing 161 WebIntelligence SDK and the Administration Server 171 WebIntelligence sessions 167 caching list of values per user session 167 Cleanup period (Administration Server) 172 setting max. number of documents per instance 167 WIADEServer 140 auditing 187 enablement rules 124 parameters 140 WIAdminBOTools 32 WIAPIBroker 142 auditing 187 enablement rules 124 parameters 142 WIClusterManager 32 WIClusterNode 32

U
universe domain defined 43 update repository delay 161 user activity viewing 199 user sessions ending 101 user.log 195 changing location 196 userdet.log 195 changing location 196 users deleting from storage 136 list of logged-in users 100 managing access rights 51 managing default InfoView options 52 maximum number of active users 133 preventing from modifying default options 54 preventing users from logging into the system 133 profiles for Administration Console access 86 setting timeout 133 setting up account information 110 viewing user names and IP addresses 100

Index

System Administrators Guide for Windows

259

WIDispatcher 131 auditing 187 enablement rules 124 parameters 128, 131 WILoginServer 173 cache contents 173 cache refreshing 174 deployment advice 126 double caching 175 enablement rules 124 enabling double caching 177 generating the .lsi file 173 how it functions 173 Last refresh duration 177 parameters 176 Refresh period 176 security model 174 Windows authentication 103 when not to use Windows authentication 103 WINotify checking system status 45 starting the system using 45 WIProcessManager 32 session context 32 WIQT 178 auditing 187 enablement rules 124 Max. active time 179 Max. inactive time 179 Number of instances 179 parameters 178 WIReportServer 165 auditing 187 enablement rules 124 List of values batch size 168 List of values caching 167 Max. active time 166 Max. inactive time 166 Max. number of documents per instance 167 parameters 165 Session reactivation period 167 Session validation frequency 167 Shutdown timeout 169

WISessionManager 132 Authentication method 177 enablement rules 124 Maximum number of active users 133 parameters 132 Prevent logins 133 selecting authentication method 109 Session timeout 133 WISiteLog 33 WIStorageManager 134 auditing 187 deleting users from storage 136 deployment advice 126 Duration 137 Enable shared storage 139 enablement rules 124 parameters 136 Scan frequency 138 storage directory 134 Storage lower limit 138 Storage maximum size 137 wmainkey.exe command 43

Index

260

System Administrators Guide for Windows

Index