You are on page 1of 468

Installation and Configuration

Guide

Version: 8.0.1
Document Number: 09300801
First Edition, July 2005, version 8.0.1
To ensure that you are using the documentation that corresponds to the software you are licensed to use, compare this version number
with the software version shown in About MicroStrategy... in the Help menu of your software.

Document number: 09300801

Copyright 2005 by MicroStrategy Incorporated. All rights reserved.

If you have not executed a written or electronic agreement with MicroStrategy or any authorized MicroStrategy distributor, the following
terms apply:
This software and documentation are the proprietary and confidential information of MicroStrategy Incorporated and may not be
provided to any other person. Copyright 2001-2005 by MicroStrategy Incorporated. All rights reserved.
THIS SOFTWARE AND DOCUMENTATION ARE PROVIDED AS IS AND WITHOUT EXPRESS OR LIMITED WARRANTY OF ANY
KIND BY EITHER MICROSTRATEGY INCORPORATED OR ANYONE WHO HAS BEEN INVOLVED IN THE CREATION,
PRODUCTION, OR DISTRIBUTION OF THE SOFTWARE OR DOCUMENTATION, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE AND
NONINFRINGMENT, QUALITY OR ACCURACY. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
SOFTWARE AND DOCUMENTATION IS WITH YOU. SHOULD THE SOFTWARE OR DOCUMENTATION PROVE DEFECTIVE,
YOU (AND NOT MICROSTRATEGY, INC. OR ANYONE ELSE WHO HAS BEEN INVOLVED WITH THE CREATION, PRODUCTION,
OR DISTRIBUTION OF THE SOFTWARE OR DOCUMENTATION) ASSUME THE ENTIRE COST OF ALL NECESSARY
SERVICING, REPAIR, OR CORRECTION. SOME STATES DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO THE
ABOVE EXCLUSION MAY NOT APPLY TO YOU.
In no event will MicroStrategy, Inc. or any other person involved with the creation, production, or distribution of the Software be liable
to you on account of any claim for damage, including any lost profits, lost savings, or other special, incidental, consequential, or
exemplary damages, including but not limited to any damages assessed against or paid by you to any third party, arising from the use,
inability to use, quality, or performance of such Software and Documentation, even if MicroStrategy, Inc. or any such other person or
entity has been advised of the possibility of such damages, or for the claim by any other party. In addition, MicroStrategy, Inc. or any
other person involved in the creation, production, or distribution of the Software shall not be liable for any claim by you or any other
party for damages arising from the use, inability to use, quality, or performance of such Software and Documentation, based upon
principles of contract warranty, negligence, strict liability for the negligence of indemnity or contribution, the failure of any remedy to
achieve its essential purpose, or otherwise. The entire liability of MicroStrategy, Inc. and your exclusive remedy shall not exceed, at
the option of MicroStrategy, Inc., either a full refund of the price paid, or replacement of the Software. No oral or written information
given out expands the liability of MicroStrategy, Inc. beyond that specified in the above limitation of liability. Some states do not allow
the limitation or exclusion of liability for incidental or consequential damages, so the above limitation may not apply to you.
The information contained in this manual (the Documentation) and the Software are copyrighted and all rights are reserved by
MicroStrategy, Inc. MicroStrategy, Inc. reserves the right to make periodic modifications to the Software or the Documentation without
obligation to notify any person or entity of such revision. Copying, duplicating, selling, or otherwise distributing any part of the Software
or Documentation without prior written consent of an authorized representative of MicroStrategy, Inc. are prohibited. U.S. Government
Restricted Rights. It is acknowledged that the Software and Documentation were developed at private expense, that no part is public
domain, and that the Software and Documentation are Commercial Computer Software provided with RESTRICTED RIGHTS under
Federal Acquisition Regulations and agency supplements to them. Use, duplication, or disclosure by the U.S. Government is subject
to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFAR
252.227-7013 et. seq. or subparagraphs (c)(1) and (2) of the Commercial Computer SoftwareRestricted Rights at FAR 52.227-19,
as applicable. Contractor is MicroStrategy, Inc., 1861 International Drive, McLean, Virginia 22102. Rights are reserved under copyright
laws of the United States with respect to unpublished portions of the Software.
The following are either trademarks or registered trademarks of MicroStrategy Incorporated in the United States and certain other
countries:
MicroStrategy, MicroStrategy 6, MicroStrategy 7, MicroStrategy 7i, MicroStrategy 7i Evaluation Edition, MicroStrategy 7i Olap Services,
MicroStrategy 8, MicroStrategy Evaluation Edition, MicroStrategy Administrator, MicroStrategy Agent, MicroStrategy Architect,
MicroStrategy Bi Developer Kit, MicroStrategy Broadcast Server, MicroStrategy Broadcaster, MicroStrategy Broadcaster Server,
MicroStrategy Business Intelligence Platform, MicroStrategy Consulting, MicroStrategy CRM Applications, MicroStrategy Customer
Analyzer, MicroStrategy Desktop, MicroStrategy Desktop Analyst, MicroStrategy Desktop Designer, MicroStrategy eCRM 7,
MicroStrategy Education, MicroStrategy eTrainer, MicroStrategy Executive, MicroStrategy Infocenter, MicroStrategy Intelligence
Server, MicroStrategy Intelligence Server Universal Edition, MicroStrategy MDX Adapter, MicroStrategy Narrowcast Server,
MicroStrategy Objects, MicroStrategy OLAP Provider, MicroStrategy SDK, MicroStrategy Support, MicroStrategy Telecaster,
MicroStrategy Transactor, MicroStrategy Web, MicroStrategy Web Business Analyzer, MicroStrategy World, Alarm, Alarm.com,
Alert.com, Angel, Angel.com, Application Development and Sophisticated Analysis, Best In Business Intelligence, Centralized
Application Management, Changing The Way Government Looks At Information, DSS Agent, DSS Architect, DSS Broadcaster, DSS
Broadcaster Server, DSS Office, DSS Server, DSS Subscriber, DSS Telecaster, DSS Web, eBroadcaster, eCaster, eStrategy,
eTelecaster, Information Like Water, Insight Is Everything, Intelligence Through Every Phone, Intelligence To Every Decision Maker,
Intelligent E-Business, IWAPU, Personal Intelligence Network, Personalized Intelligence Portal, Query Tone, Quickstrike, Rapid
Application Development, Strategy.com, Telepath, Telepath Intelligence, Telepath Intelligence (and Design), The E-Business
Intelligence Platform, The Foundation For Intelligent E-Business, The Integrated Business Intelligence Platform Built For The
Enterprise, The Intelligence Company, The Platform For Intelligent E-Business, The Power Of Intelligent eBusiness, The Power Of
Intelligent E-Business, and The Scalable Business Intelligence Platform Built For The Internet are all registered trademarks or
trademarks of MicroStrategy Incorporated.
All other products are trademarks of their respective holders. Specifications subject to change without notice. MicroStrategy is not
responsible for errors or omissions. MicroStrategy makes no warranties or commitments concerning the availability of future products
or versions that may be planned or under development.
This product is patented. One or more of the following patents may apply to the product sold herein: U.S. Patent Nos. 6,154,766,
6,173,310, 6,260,050, 6,263,051, 6,269,393, 6,279,033, 6,501,832, 6,567,796, 6,587,547, 6,606,596, 6,658,093, 6,658,432,
6,662,195, 6,671,715, 6,691,100, 6,694,316, 6,697,808, 6,704,723, 6,707,889, 6,741,980, 6,765,997, 6,768,788, 6,772,137,
6,788,768, 6,792,086, 6,798,867, 6,801,910, 6,820,073, 6,829,334, 6,836,537, 6,850,603, 6,859,798, 6,873,693 and 6,885,734.
Other patent applications are pending.
Various MicroStrategy products contain the copyrighted technology of third parties. This product may contain one or more of the
following copyrighted technologies:
Graph Generation Engine Copyright 1998-2004. Three D Graphics, Inc. All rights reserved.
Actuate Formula One. Copyright 1993-2004 Actuate Corporation. All rights reserved.
XML parser Copyright 2003 Microsoft Corporation. All rights reserved.
Xalan XSLT processor. Copyright 1999-2004. The Apache Software Foundation. All rights reserved.
Xerces XML parser. Copyright 1999-2004. The Apache Software Foundation. All rights reserved.
FOP XSL formatting objects. Copyright 2004. The Apache Software Foundation. All rights reserved.
Portions of Intelligence Server memory management Copyright 1991-2004 Compuware Corporation. All rights reserved.
International Components for Unicode
Copyright 1999-2004 Compaq Computer Corporation
Copyright 1999-2004 Hewlett-Packard Company
Copyright 1999-2004 IBM Corporation
Copyright 1999-2004 Hummingbird Communications Ltd.
Copyright 1999-2004 Silicon Graphics, Inc.
Copyright 1999-2004 Sun Microsystems, Inc.
Copyright 1999-2004 The Open Group
All rights reserved.
Real Player and RealJukebox are included under license from Real Networks, Inc. Copyright 1999-2004. All rights reserved.
CONTENTS

Document description.............................................................. xiii


Who should use this guide..................................................... xiv
Prerequisites .......................................................................... xiv
Objectives .............................................................................. xiv
About this book .............................................................................xv
Typographical standards ..............................................................xv
For online and printed documentation ....................................xv
For printed documentation only ............................................ xvii
Resources.................................................................................... xix
Product documentation .......................................................... xix
Online documentation ............................................................ xix
International support ................................................................... xxii
User assistance ......................................................................... xxiii
Online help........................................................................... xxiii
Technical Support ................................................................ xxiii
Feedback ................................................................................... xxix

1. Introduction to Introduction.................................................................................. 1
MicroStrategy
MicroStrategy components ............................................................ 2
Common Setups for MicroStrategy.......................................... 2
How to use this book ................................................................... 14
Installing MicroStrategy on Windows ..................................... 14
Installing MicroStrategy on UNIX and Linux .......................... 16

2005 MicroStrategy, Inc. v


Contents Installation and Configuration Guide

2. Planning Your Introduction................................................................................ 19


Installation
Upgrade considerations............................................................... 20
Installation prerequisites .............................................................. 20
Recommended installation location ....................................... 21
Hardware recommendations.................................................. 21
Software recommendations ................................................... 28
Installation considerations ........................................................... 35
System sizing guidelines........................................................ 35
MicroStrategy Web Universal and Intelligence Server
compatibility ........................................................................... 42
Certified ODBC drivers for MicroStrategy Intelligence Server
Universal Edition .................................................................... 42
Methods of installation ................................................................. 43
GUI ........................................................................................ 43
Command line........................................................................ 44
Silent installation .................................................................... 45
Licensing information................................................................... 46
Types of licenses ................................................................... 47
Next steps.................................................................................... 48

3. Installing Introduction................................................................................ 49
MicroStrategy on
Installation procedure .................................................................. 50
Windows
InstallShield Wizard ............................................................... 51
Installation verification ........................................................... 67
Next steps.............................................................................. 68

4. Installing Introduction................................................................................ 71
MicroStrategy on
Installation procedures on UNIX or Linux .................................... 72
UNIX and Linux
Different methods of installation............................................. 72
Installing MicroStrategy using InstallShield Wizard ............... 73
Verifying installation ............................................................... 82
Directory structure.................................................................. 83
Next steps.................................................................................... 85

5. Configuring Introduction................................................................................ 87
MicroStrategy
Configuration prerequisites.......................................................... 88
Intelligence Server
Using the MicroStrategy Configuration Wizard............................ 89
Overview of the MicroStrategy Configuration Wizard ............ 89
Creating a metadata repository and statistics tables ............. 95

vi 2005 MicroStrategy, Inc.


Installation and Configuration Guide Contents

Setting up the MicroStrategy Intelligence Server................. 102


Project Sources ................................................................... 108
Next steps.................................................................................. 110

6. Creating a Project Introduction.............................................................................. 111


MicroStrategy Desktop definitions ............................................. 112
MicroStrategy metadata....................................................... 112
Metadata shell ..................................................................... 112
MicroStrategy objects .......................................................... 113
Project source ...................................................................... 113
Database instance ............................................................... 114
Project.................................................................................. 114
Creating a project using Project Builder .................................... 118
Using Project Builder ........................................................... 118
Creating a project using MicroStrategy Desktop ....................... 120
Creating a new project ......................................................... 120
Adding tables using the Warehouse Catalog....................... 122
Creating facts....................................................................... 124
Creating attributes ............................................................... 126
Creating shortcut objects ..................................................... 130
MicroStrategy project schema ................................................... 132
Next steps.................................................................................. 133

7. Deploying Your Introduction.............................................................................. 135


Project with
Connecting MicroStrategy Web to the Intelligence Server ........ 136
MicroStrategy Web

8. Configuring and Introduction.............................................................................. 139


Deploying
Deploying with WebLogic and Apache ...................................... 140
MicroStrategy Web
Universal WebLogic paths and folder locations ................................... 141
Preconfiguration information ................................................ 142
Deploying MicroStrategy Web Universal ............................. 146
Re-deploy the application .................................................... 157
Performance-based setup information................................. 158
Deploying with WebSphere 5.x and IBM HTTP Server ............. 165
Preconfiguration information ................................................ 165
Deploying MicroStrategy Web Universal ............................. 167
Performance-based setup information................................. 176
Deploying with Sun ONE (iPlanet) 8.0....................................... 179

2005 MicroStrategy, Inc. vii


Contents Installation and Configuration Guide

Preconfiguration information ................................................ 180


Deploying MicroStrategy Web Universal ............................. 182
Performance-based setup information................................. 189
Deploying with Tomcat (Linux) .................................................. 191
Preconfiguration information ................................................ 191
Deploying MicroStrategy Web Universal ............................. 195
Deploying with Oracle 10g......................................................... 199
Preconfiguration information ................................................ 199
Deploying MicroStrategy Web Universal ............................. 201
Using the MicroStrategy Web Administrator Console................ 205
Intelligence Servers page .................................................... 206
Narrowcast Server Integration page .................................... 211
Diagnostics page ................................................................. 211
Security ................................................................................ 218

9. Setting up Documents Introduction.............................................................................. 221


and HTML Documents
Before you start ......................................................................... 222
Overview.................................................................................... 223
Setup for creating and executing HTML documents.................. 224
Setup for executing existing HTML documents ......................... 227
Setup for executing Report Services documents....................... 228

10. Automated Introduction.............................................................................. 229


Installation and
Methods of installation ............................................................... 231
Configuration on
Windows Response.ini file installation................................................. 231
Silent installation .................................................................. 231
Installation log file ...................................................................... 232
Installing and configuring with a response.ini file....................... 233
Configuring a response.ini file for installation ...................... 233
Configuring a response.ini file for the Configuration Wizard 257
Uninstalling using a response.ini file.......................................... 263
Example of a response.ini file .............................................. 263
Silent installation........................................................................ 265
Silent installation of a hotfix ................................................. 271

11. Automated Introduction.............................................................................. 273


Installation and
Silent installation........................................................................ 274
Configuration on UNIX

viii 2005 MicroStrategy, Inc.


Installation and Configuration Guide Contents

Creating an options file ........................................................ 274


Settings that can be changed .............................................. 275
Silent installation output ....................................................... 279
Configuring through command line mode.................................. 279
Creating a response.ini file for the Configuration Wizard..... 280
Using the response.ini file through the Configuration Wizard ....
288
Configuring MicroStrategy using the command line mode .. 289
Configuring metadata and statistics tables .......................... 291
Setting up MicroStrategy Intelligence Server....................... 298
Creating a project source..................................................... 304

12. Adding or Removing Introduction.............................................................................. 307


MicroStrategy
Adding or removing MicroStrategy components on Windows ... 308
Components
Reinstalling MicroStrategy components on Windows................ 310
Reinstalling MicroStrategy Office......................................... 311
Uninstalling MicroStrategy components on Windows................ 312
Uninstalling MicroStrategy Office......................................... 313
Uninstalling MicroStrategy components on UNIX and Linux ..... 314
Uninstalling MicroStrategy Intelligence Server on UNIX and
Linux .................................................................................... 314
Uninstalling MicroStrategy Web Universal on UNIX and Linux..
315

A. Managing Licenses Introduction.............................................................................. 317


Verifying Named user licenses .................................................. 318
Verifying CPU licenses .............................................................. 319
MicroStrategy License Manager ................................................ 321
Determining the number of licenses in use................................ 321
Upgrading a license ................................................................... 322

B. ODBC and DSNs Introduction.............................................................................. 325


Setting up ODBC ....................................................................... 326
Configuring ODBC with MicroStrategy for Windows............ 328
Configuring ODBC with MicroStrategy for UNIX.................. 328
Creating DSNs........................................................................... 330
Using the MicroStrategy Connectivity Configuration Wizard 331
Using the MicroStrategy Configuration Wizard .................... 334

2005 MicroStrategy, Inc. ix


Contents Installation and Configuration Guide

Using the Microsoft ODBC Administrator............................. 336


Creating DSNs for individual ODBC drivers......................... 338
Testing the ODBC connectivity .................................................. 357
Parameters from ODBC.ini ........................................................ 359
Oracle Wire Protocol............................................................ 361
DB2 Wire Protocol ............................................................... 362
Informix Wire Protocol.......................................................... 366
Sybase Wire Protocol .......................................................... 367
SQL Server Wire Protocol.................................................... 368
ODBC .................................................................................. 369
Red Brick 6.x ....................................................................... 369
SybaseIQ ............................................................................. 370
Teradata-Server................................................................... 370
Informix XPS ........................................................................ 372

C. Advanced Warehouse Introduction.............................................................................. 375


Catalog Usage
Warehouse Catalog usage ........................................................ 376
What should I know before I use the Warehouse Catalog?. 376
Accessing Warehouse Catalog............................................ 377
Warehouse Catalog layout .................................................. 377
Warehouse Catalog settings................................................ 381
Ignore table name space settings ........................................ 385
Troubleshooting Warehouse Catalog .................................. 386

D. Advanced Hardware Introduction.............................................................................. 389


Considerations
Small MicroStrategy production system configuration............... 389
Medium MicroStrategy production system configuration ........... 393
Large MicroStrategy production system configuration............... 396

E. Troubleshooting Introduction.............................................................................. 399


Installing MicroStrategy for UNIX............................................... 399
Mounting CD-ROMs............................................................. 400
General installation errors.................................................... 403
Server port number errors.................................................... 403
DSN connection errors......................................................... 404
Permission errors................................................................. 404
Troubleshooting LDAP authentication ....................................... 405
LDAP authentication mode problems .................................. 406
LDAP functionality problems................................................ 407

x 2005 MicroStrategy, Inc.


Installation and Configuration Guide Contents

LDAP frequently asked questions........................................ 409

F. Example of a Modified Introduction.............................................................................. 411


web.xml File
Example of modified web.xml file .............................................. 411

Glossary ................................................................................... 421

Index ......................................................................................... 427

2005 MicroStrategy, Inc. xi


Contents Installation and Configuration Guide

xii 2005 MicroStrategy, Inc.


PREFACE

Document description

The MicroStrategy Installation and Configuration Guide


provides comprehensive information on how to install and
configure MicroStrategy software, as well as basic
maintenance guidelines. This guide gets you started using the
UNIX, Linux, and Windows version of the MicroStrategy
platform.

It assumes a basic understanding of how to use UNIX either


from a UNIX server or by using a viewer on a PC. For tasks
that require advanced System Administration commands,
this document assumes you are either familiar with those
commands or can contact your System Administrator.

The appendixes contain the following additional reference


information, which you may require depending on your
specific needs:
managing MicroStrategy licenses

configuring ODBC and DSNs

warehouse catalog usage and settings

hardware related configuration information

modified web.xml file example

troubleshooting

2005 MicroStrategy, Inc. xiii


Preface Installation and Configuration Guide

Technical terms that need more clarification are defined in


the glossary section of this guide.

Who should use this guide


This document is designed for System Administrators who
install, configure, and maintain MicroStrategy software on
the UNIX, Linux, and Windows operating system.

Prerequisites
Before working with this document, you should be familiar
with

the nature and structure of the data to use for your


business intelligence application

the basics of the UNIX operating system

Objectives
After reading this manual, you will be able to
install MicroStrategy software on a UNIX, Linux, and
Windows system

configure Intelligence Server and Web Universal for use


by clients
provide maintenance support for MicroStrategy on a
UNIX, Linux, and Windows operating system

xiv Who should use this guide 2005 MicroStrategy, Inc.


Installation and Configuration Guide Preface

About this book


This book is divided into chapters and reference appendices.
The chapters provide conceptual information about

all MicroStrategy components

installation and configuration procedures

troubleshooting and maintenance guidelines

Each chapter begins with a brief overview of the content


within that chapter. The chapter is then divided into
subsections organized in the best method to promote
learning. If applicable, a series of steps may be provided to
carry out tasks and to facilitate the learning process.

The appendixes contain additional reference information,


which you may or may not require depending on your specific
needs.

When you are looking for specific information, you can use
the table of contents or index to quickly locate the
information.

Typographical standards
There are different typographical standards for the online
and printed documentation, and only for printed
documentation.

For online and printed documentation


MicroStrategy online and hard copy documentation follows
presentation conventions and cues to help you locate,
identify, and understand important concepts and procedures.
The following table lists these conventions.

2005 MicroStrategy, Inc. About this book xv


Preface Installation and Configuration Guide

Type Indicates

bold button names, check boxes, dialog boxes,


options, lists, and menus that are the focus of
actions or part of a list of such GUI elements and
their definitions
text to be entered by the user

italic new terms defined within the text and in the


glossary
names of other product manuals
when part of a command syntax, indicates
variable information to be replaced by the user

Courier calculations
font code samples
registry keys
path and file names
URLs
messages displayed in the screen

UPPERCASE keyboard command key (such as ENTER)


shortcut key (such as CTRL+V)

+ A keyboard command that calls for the use of more


than one key (for example, SHIFT+F1)

xvi Typographical standards 2005 MicroStrategy, Inc.


Installation and Configuration Guide Preface

For printed documentation only


The following are explanations of the font style changes,
icons, and different types of notes that you may see in this
user guide.

Actions

References to screen elements and keys that are the focus of


actions are in bold Arial font style. Following is an example:

1 Click Select Warehouse.

Code

References to code, formulas, or calculations within


paragraphs are formatted in regular Courier New font style.
Following is an example:

Sum(sales)/number of months

Data entry

References to literal data you must type in an exercise or


procedure are in bold Arial font style. References to data you
type in that could vary from user to user or system to system
are in bold italic Arial font style. Following is an example:
Type cmdmgr -f scriptfile.scp and press ENTER.

Type cp /path/to/file /path/to/newfile

Keyboard keys

References to a keyboard key or shortcut keys are in


uppercase letters. Following is an example:

To bold the selected text, press CTRL+B.

2005 MicroStrategy, Inc. Typographical standards xvii


Preface Installation and Configuration Guide

New terms

New terms to note are in regular italic font style. These terms
are defined when they are first encountered in the course
material. Following is an example:
The aggregation level is the level of calculation for the
metric.

Notes and warnings

 This note icon indicates helpful information.


 This warning icon calls your attention to very
important information that should be read before
continuing.

Heading icons

The following heading icons are used to indicate specific


practice and review sections:


Precedes a Case Study. Cases Studies are real-life examples
from companies that are using MicroStrategy products.


Precedes a Business Scenario. Business Scenarios are
examples from the MicroStrategy Tutorial. They explain how
to accomplish complex tasks using MicroStrategy.

xviii Typographical standards 2005 MicroStrategy, Inc.


Installation and Configuration Guide Preface

Resources

Product documentation
MicroStrategy includes a full set of product manuals,
designed to help you find the information you require to
install, configure, design, and administer your business
intelligence and narrowcast systems, as well as full SDK
documentation to help you extend and customize
MicroStrategy and integrate it with your existing
applications.

A list of documentation links is available to access all


documentation installed from your CD-ROM. Most of these
documents have been provided in Acrobat Portable
Document format (PDF).

 Adobe Acrobat Reader is required to view these


documents. If you do not have Acrobat Reader
installed on your computer, you can download it from
http://www.adobe.com.

Online documentation

To access an online manual

1 From the UNIX File Manager, navigate to the


MicroStrategy directory, then to the Documentation
directory.

2 Double-click the Product_Manuals.htm file to see the list


of available manuals in PDF format.

3 Click the link for the desired manual.

4 Some information is provided in HTML help format.


When you select one of these guides, the Download file
dialog box will open. Select the Open this file from its
current location option and click OK.

2005 MicroStrategy, Inc. Resources xix


Preface Installation and Configuration Guide

 IfAcrobat
bookmarks are not visible on the left side of an
document, select Bookmarks and Page from
the View menu, then select the topic and section you
want to see. You can also scroll from the title page of
the guide to its table of contents, and select from there
the topic you want to read.

The following documents are provided on your CD-ROM in


Acrobat Portable Document format (PDF):

MicroStrategy Overview
Introduction to MicroStrategy: Evaluation Guide

MicroStrategy Quick Start Guide

Manuals for Query, Reporting, and Analysis


Products
MicroStrategy Installation and Configuration Guide

MicroStrategy Upgrade Guide

MicroStrategy Basic Reporting Guide

MicroStrategy Advanced Reporting Guide

MicroStrategy Document Creation Guide


MicroStrategy System Administration Guide

MicroStrategy Analytical Functions Reference

MicroStrategy Web SDK

 The Web SDK is available in the MicroStrategy


Developer Library, which is sold as part of the
MicroStrategy SDK.

Manuals for Information Delivery and Alerting


Products
MicroStrategy Narrowcast Server Getting Started Guide

xx Resources 2005 MicroStrategy, Inc.


Installation and Configuration Guide Preface

MicroStrategy Narrowcast Server Installation and


Configuration Guide

MicroStrategy Narrowcast Server Application Designer


Guide

MicroStrategy Narrowcast Server System


Administrator Guide

MicroStrategy Narrowcast Server Upgrade Guide

Manuals for Analytics Modules


Business Intelligence Developer Kit (BIDK) Installation
and Porting Guide

Customer Analysis Module Reference

Sales Force Analysis Module Reference

Web Traffic Analysis Module Reference

Financial Reporting Analysis Module Reference

Sales and Distribution Analysis Module Reference

Human Resources Analysis Module Reference

Software Development Kits


MicroStrategy Developer Library
MicroStrategy Web SDK

 The Web SDK is available in the MicroStrategy


Developer Library, which is sold as part of the
MicroStrategy SDK.

Narrowcast Server SDK Guide

2005 MicroStrategy, Inc. Resources xxi


Preface Installation and Configuration Guide

International support
MicroStrategy supports several locales. Support for a locale
typically includes native database and operating system
support, support for date formats, decimal formats, currency
symbols etc. and availability of translated interfaces and
documentation. The level of support is defined in terms of the
components of a MicroStrategy Business Intelligence
environment. A MicroStrategy Business Intelligence
environment consists of the following components,
collectively known as a configuration:
warehouse, metadata, and statistics databases

MicroStrategy Intelligence Server

MicroStrategy Web Server

MicroStrategy Desktop client

Web browser

MicroStrategy is certified in homogeneous configurations


(where all the components lie in the same locale) in the
following languagesEnglish (US), French, German, Italian,
Japanese, Korean, Portuguese (Brazilian), Spanish, Chinese
(simplified) and Swedish.

 For information on the exact languages, see the


Readme file.

MicroStrategy also provides limited support for


heterogeneous configurations (where some of the
components may lie in different locales). Please contact
MicroStrategy Technical Support for more details.

A translated user interface is available in each of the above


languages. In addition, translated versions of the online help
files and product documentation are available in several of
the above languages.

xxii International support 2005 MicroStrategy, Inc.


Installation and Configuration Guide Preface

User assistance
The following paragraphs describe the types of assistance
available to answer questions you may have regarding
MicroStrategy products.

Online help
MicroStrategy provides several modes of access to online
help:

From the Help menu, by selecting Contents and Index to


see the main table of contents for the help system

By pressing F1 to see context-sensitive help addressing


the function or task you are currently performing

 Netscape
help.
browser is required for viewing the online

Technical Support
If you have questions about a specific MicroStrategy product,
you should:

1 Consult the product guides, online help, readme files, and


release notes

2 Consult the online knowledge base at


http://www.microstrategy.com/support/
k_base/index.asp

 Aprobably
technical administrator in your organization can
help you resolve some of your issues
immediately.

2005 MicroStrategy, Inc. User assistance xxiii


Preface Installation and Configuration Guide

3 If the resources listed in steps 1 and 2 do not provide you


with a solution, contact MicroStrategy Technical Support
directly. To ensure the most effective and productive
relationship with MicroStrategy Technical Support,
review the Policies and Procedures document posted at
http://www.microstrategy.com/Support/
Policies. Please refer to the terms of your purchase
agreement to determine the type of support available to
you.

The table on the following page shows where, when, and how
to contact MicroStrategy Technical Support. If you are unable
to reach MicroStrategy Technical Support by phone during
the hours of operation, you have the option to leave a
voicemail message or send electronic mail.

xxiv User assistance 2005 MicroStrategy, Inc.


Installation and Configuration Guide Preface

North E-mail: support@microstrategy.com


America Web: https://support.microstrategy.com
Fax: (703) 8488710
Phone: (703) 8488700
Message: (703) 848-8709
Hours:
9:00 A.M.7:00 P.M. Eastern Time (14000000 GMT),
MondayFriday except holidays

Europe, the E-mail: eurosupp@microstrategy.com


Middle East, Web: https://support.microstrategy.com
and Africa Fax: +44 (0) 208 396 0001
(EMEA) The European Technical Support Centre is closed on certain
public holidays. These holidays reflect the national public
holidays in each country.
Phone:
United Kingdom: +44 (0) 208 396 0085
Benelux: +31 20 346 9210
Finland: +35 8 9 6937 9620
France: +33 1 41 91 86 49
Germany: +49 69 95096206
Ireland: +35 3 1242 1522
Italy: +39 02696 33 456
Spain: +34 91 406 90 10
International distributors: +44 (0) 208 396 0080
Hours:
United Kingdom: 9:00 A.M.6:00 P.M. GMT, Monday-Friday
except holidays
Mainland Europe: 9:00 A.M.6:00 P.M. CET, Monday-Friday
except holidays

Asia Pacific E-mail: apsupport@microstrategy.com


Web: https://support.microstrategy.com
Fax: +81 3 5456 5464
Phone:
APAC (except Korea): +81 3 5456 5618
Korea: +82 2 565 2525
Hours:
9:00 A.M.6:00 P.M. JST (Tokyo), Monday-Friday except
holidays

Latin America E-mail: latamsupport@microstrategy.com


Web: https://support.microstrategy.com
Fax: +55 11 3044 4088
Phone: LATAM (except Argentina): +55 11 3054 1010
Argentina: 0 800 444 MSTR
Hours:
9:00 A.M.6:00 P.M. (San Paulo), MondayFriday except
holidays

2005 MicroStrategy, Inc. User assistance xxv


Preface Installation and Configuration Guide

Technical Support may be obtained by a Customers Support


Liaisons. A "Support Liaison" is defined as a person whom
the customer has designated as a point-of-contact with
MicroStrategys support personnel. All customer inquiries
and case communications must come through these named
individuals. The customer may designate two employees to
serve as their Support Liaisons. Customers may change their
Support Liaisons two times per year, if necessary, so long as
they provide written notice to MicroStrategy Technical
Support of such change.

During the course of troubleshooting and researching issues,


MicroStrategy Technical Support personnel may make
recommendations that require administrative privileges on
the MicroStrategy projects or that assume that the designated
liaison has a security level that permits them to fully
manipulate the MicroStrategy projects and has access to
potentially sensitive project data such as security filter
definitions. Although not a requirement, we recommend that
customers only designate Support Liaisons who have
permissions to be MicroStrategy project administrators. This
will eliminate security conflicts and improve case resolution
time.

When contacting MicroStrategy Technical Support, please


provide the following information:

name (first and last)


company
customer site (if different from company)

phone and fax numbers

e-mail address

MicroStrategy software product(s) being used, including


version nubmer(s)

error message(s)

brief description of the case

priority of the case

steps taken to troubleshoot the case thus far

xxvi User assistance 2005 MicroStrategy, Inc.


Installation and Configuration Guide Preface

If the Support Liason is unable to reach MicroStrategy


Technical Support, the Support Liason can leave a voice mail
message or contact Technical Support via e-mail. The
Support Liason should include the following information in
his/her message:

name

company

brief description of the case

preferred contact method and contact information

If this is your first call, you should also be prepared to provide


the following:

street address

phone number

fax number

e-mail address

To help your Technical Support representative work with you


to resolve the problem promptly and effectively, be prepared
to provide the following additional information:

issue numberplease keep a record of the number


assigned to each problem logged with MicroStrategy
Technical Support, and be ready to provide it when
inquiring about an existing issue
software version and product registration numbers of the
MicroStrategy software products you are using

2005 MicroStrategy, Inc. User assistance xxvii


Preface Installation and Configuration Guide

problem description:

What causes the condition to occur?

Does the condition occur sporadically or each time a


certain action is performed?

Does the condition occur on all machines or just on


one?

When did the condition first occur?

What events took place immediately prior to the first


occurrence of the condition (for example, a major
database load, a database move, a software upgrade)?
If there was an error message, what was its exact
wording?

What steps have you taken to isolate and resolve the


issue? What were the results?

system configuration (the information needed for this


purpose depends on the nature of the problem; not all
items listed may be necessary):

computer hardware specifications (processor speed,


RAM, disk space, and so on)

network protocol used

ODBC driver manufacturer and version

database gateway software version


(for MicroStrategy Web-related problems) browser
manufacturer and version
(for MicroStrategy Web-related problems) Web server
manufacturer and version

If the issue requires additional investigation or testing, you


and the MicroStrategy Technical Support representative
should agree on certain action items to be performed. You
should perform any agreed-upon actions before contacting
Technical Support again regarding the issue. If the Technical
Support representative is responsible for an action item, you
may call Technical Support at any time to inquire about the
status of the issue.

xxviii User assistance 2005 MicroStrategy, Inc.


Installation and Configuration Guide Preface

Feedback
Please send any comments or suggestions about user
documentation for MicroStrategy 7 products to:

documents@microstrategy.com

Send suggestions for product enhancements to:

support@microstrategy.com

When you provide feedback to us, please include the name


and version of the products you are currently using. Your
feedback is important to us as we prepare for future releases.

2005 MicroStrategy, Inc. Feedback xxix


Preface Installation and Configuration Guide

xxx Feedback 2005 MicroStrategy, Inc.


1
1. INTRODUCTION TO
MICROSTRATEGY

Introduction

MicroStrategy business intelligence tools help organizations


to monitor, report, and analyze all of their enterprise data. It
helps you make decisions based upon the data within your
organizations enterprise data warehouse.

This chapter provides an overview of the different


MicroStrategy components and products so you can decide
what you need to install. It also provides details on supported
functionality. It gives you a road map to using this guide for
installing MicroStrategy on Windows, UNIX, and Linux.

This chapter includes the following sections:

MicroStrategy components

How to use this book

2005 MicroStrategy, Inc. 1


1 Introduction to MicroStrategy Installation and Configuration Guide

MicroStrategy components
MicroStrategy has a range of products that you can install on
different operating systems. Depending on the type of setup
you have, you can install various combinations of
MicroStrategy components. The components described in
this section offer a complete set of tools for creating,
deploying, supporting, and maintaining the business
intelligence applications. This section briefly describes the
most common setups and the components required for each.

 Ifandyousubarecomponents,
familiar with MicroStrategy components
you can skip this section and go
to How to use this book, page 14.

Common Setups for MicroStrategy


The following are the common MicroStrategy configuration
and the components required for the setups:

Common configurations: This setup includes


MicroStrategy Desktop Products, MicroStrategy
Administrator, MicroStrategy Intelligence Server,
MicroStrategy Web Services, and MicroStrategy
Tutorial-Reporting.
MicroStrategy Web Universal configuration: In addition
to the components required for the common
configuration, you also need to install MicroStrategy Web
Universal components.
MicroStrategy NCS: In addition to the components
required for the common configuration, you also need to
install MicroStrategy Narrowcast Server components.

MicroStrategy SDK: In addition to the components


required for the common configuration, you also need to
install MicroStrategy SDK component.

2 MicroStrategy components 2005 MicroStrategy, Inc.


Installation and Configuration Guide Introduction to MicroStrategy 1

 Note the following:


Apart from the components listed above, you can also
install MicroStrategy Office and MicroStrategy
eTrainer for Web.

The details regarding each component and their sub


components is described in the sections that follow.

MicroStrategy Desktop Products

MicroStrategy Desktop provides analytical features designed


to facilitate and perform the deployment of reports. It
governs application objects such as reports, filters, and
metrics.

MicroStrategy Desktop also enables you to create application


objects. The application objects are built on the schema
objects that are created in Architect. These application
objects are used to analyze and provide insight into relevant
data. The following sections provide a brief description of the
sub-components for these products.

MicroStrategy Desktop Products sub-components

MicroStrategy Desktop Analyst is a simplified version of


MicroStrategy Desktop, providing the basic interactive
reporting functionality required by managers.

MicroStrategy Desktop Designer is a full-featured version


for power analysts and application developers. With a full
range of analytical functionality, a rich library of
functions, and intelligent workflow, Desktop Designer is
well suited for demanding users.
MicroStrategy Architect provides Project Designer
functionality such as attribute, fact, hierarchy, and project
creation and modification. Another sub-component of
Architect is MicroStrategy Project Builder, which allows
quick creation of simple projects. These projects can be
used for easy creation of prototypes for proof-of-concept
purposes.

MicroStrategy Server Administrator provides


administrative functionality such as system monitoring,
cache management, and user and group management.

2005 MicroStrategy, Inc. MicroStrategy components 3


1 Introduction to MicroStrategy Installation and Configuration Guide

For details about the specific features that the different


Desktop versions include, review the feature comparison
chart at the following website:

http://www.microstrategy.com/Software/
Products/Desktop/feature_comparison.asp

For information on various options present in MicroStrategy


Desktop to create and run reports, refer to the MicroStrategy
Basic Reporting Guide. After you are familiar with basic
Desktop concepts, refer to the MicroStrategy Advanced
Reporting Guide for information on advanced Desktop
functionality.

MicroStrategy Administrator

The sub components of MicroStrategy Administrators are as


follows:

MicroStrategy Command Manager is an application


designed to simplify and automate administration tasks,
such as add, delete, or update enterprise-level data
associated with large numbers of users and user groups.
Additionally, Command Manager allows you to manage
various configuration settings within the MicroStrategy
platform.

MicroStrategy Object Manager provides complete life


cycle management capabilities for MicroStrategy
environments.
MicroStrategy Enterprise Manager allows viewing and
analysis of MicroStrategy product usage and system
performance.

 IfWindows
you install MicroStrategy Administrator on
XP, the option to install Enterprise
Manager is not displayed.

For more information about MicroStrategy Administrator


and its components, see the MicroStrategy System
Administration Guide.

4 MicroStrategy components 2005 MicroStrategy, Inc.


Installation and Configuration Guide Introduction to MicroStrategy 1

MicroStrategy Intelligence Server

The important functions of the MicroStrategy Intelligence


Server are

sharing data

protecting the information in the metadata

sharing objects

The MicroStrategy Intelligence Server also provides a library


of over 150 different sophisticated mathematical and
statistical functions, and more can be added. See the
MicroStrategy Analytical Functions Reference for details
about these functions.

All other products in the platform work in conjunction with


the MicroStrategy Intelligence Server and benefit from its
broad functionality.

MicroStrategy has different editions of Intelligence Server,


which are
Standard edition

Enterprise edition

Universal edition

The Standard edition and Enterprise edition are Windows


versions of MicroStrategy Intelligence Server, whereas the
Universal edition is platform-independent. It can be installed
on various operating systems such as Windows, UNIX, Linux,
and so on. The Standard, Enterprise, and Universal editions
of MicroStrategy Intelligence Server share a common code
base and run reports identically. However, there are a few
functionality differences. The following table highlights the
major differences between them.

2005 MicroStrategy, Inc. MicroStrategy components 5


1 Introduction to MicroStrategy Installation and Configuration Guide

Intelligence Server
Intelligence Server
Functionality Standard and
Universal Edition
Enterprise Editions

Windows Not supported as Supported


Authentication single sign-on, but
Active Directory
Services are
supported

Custom Function Not supported Supported


Plug-in

Performance MicroStrategy Microsoft Windows


Monitoring Java-based Control MMC Performance
Center Counters

Diagnostics Debug Not supported Supported


Monitor

ETL Support Informatica MX2 not Informatica MX2


supported supported

ODBC DSN Creation MicroStrategy ODBC Microsoft Windows


Administrator ODBC Data Source
Administrator

Intelligence Server MicroStrategy SDK Supported


SDK applications can be
run against
Intelligence Server
Universal Edition, but
they need to be
executed from a
Windows machine

Microsoft Access Not supported Supported

For a detailed description of all the features of MicroStrategy


Intelligence Server, refer to the MicroStrategy System
Administration Guide.

6 MicroStrategy components 2005 MicroStrategy, Inc.


Installation and Configuration Guide Introduction to MicroStrategy 1

MicroStrategy Web and Web Universal


components

MicroStrategy Web provides users with a highly interactive


environment and a low-maintenance interface for reporting
and analysis. Using the Web interface, users can access,
analyze, and share corporate data through any Web browser
on any operating system. MicroStrategy Web provides ad hoc
querying, industry-leading analysis, quick deployment, and
rapid customizability, making it even easier for users to make
informed business decisions.

In addition to the powerful functionality that MicroStrategy


Web offers, MicroStrategy Web Universal provides the added
benefit of working with

operating systems, such as Sun Solaris and IBM AIX.

application servers, such as BEA WebLogic and IBM


WebSphere.

Web servers and Web browsers.

MicroStrategy Web and Web Universal are available in the


following versions:

The full-featured version contains all the powerful


features that let report designers create Intelligent Cubes
reports for their users. Full reporting, ad hoc reporting,
and OLAP capabilities are integrated with seamless
ROLAP analysis.
The simplified version provides ad hoc analysis from
Intelligent Cubes with interactive slice-and-dice OLAP.
The Enterprise Reporting version enables viewing of
scheduled reports and interactive slice-and-dice, with
printing and e-mail subscription to reports.

2005 MicroStrategy, Inc. MicroStrategy components 7


1 Introduction to MicroStrategy Installation and Configuration Guide

MicroStrategy Web products include Web Professional, Web


Analyst, and Web Reporter. The following table lists the
versions that the various MicroStrategy Web products
support.

Enterprise
MicroStrategy Full-featured Simplified
Reporting
Products version version
version

Web Professional or Supported Supported Supported


Web Universal
Professional

Web Analyst or Web Not Supported Supported Supported


Universal Analyst

Web Reporter or Not Supported Not Supported Supported


Web Universal
Reporter

For detailed information about using the MicroStrategy Web


reporting environment, refer to the online help provided on
the MicroStrategy Web interface.

For information about configuring and tuning MicroStrategy


Web, refer to the MicroStrategy System Administration
Guide.

MicroStrategy Web Services

MicroStrategy Web Services is a self-contained business


function that operates over the Internet. It is based on
industry standards and is designed to work together with
similar components. It provides an alternative way to access
the MicroStrategy business intelligence platform using the
latest technologies such as ASP.NET, JNI, Java and Web
protocols, such as Apache Axis. MicroStrategy Web Services
is an easy-to-deploy service that is accessible through
MicroStrategy Office. It also implements an open API that

8 MicroStrategy components 2005 MicroStrategy, Inc.


Installation and Configuration Guide Introduction to MicroStrategy 1

allows customers to quickly develop Web reporting


applications accessing MicroStrategy Intelligence Server. It is
a discrete business process that

exposes and describes itself

Other applications can understand and use this


functionality.

easily allows other services to locate it on the Web

It can be easily located through a type of yellow pages.

can be invoked

After it is located and examined, other services can invoke


it using an Internet standard protocol.

returns a response

When service is provided, the results are passed back to


the requesting application using the same Internet
standard protocol.

For more information on MicroStrategy Web Services, refer


to the MicroStrategy Web Services Administration Guide.

MicroStrategy SDK

The MicroStrategy SDK allows you to easily adapt and


integrate MicroStrategy functionality into your application or
modify the standard interface or functionality. It provides
access to the entire platform and includes the necessary
services and utilities for building a business
intelligence-enabled application.

2005 MicroStrategy, Inc. MicroStrategy components 9


1 Introduction to MicroStrategy Installation and Configuration Guide

The MicroStrategy SDK consists of the following


components:

A comprehensive set of open Application Programming


Interfaces (APIs) that include

the COM-based client-server API

the XML-based Web API with support for Java/COM

the Narrowcast Server API

the Office API

Complete SDK documentation for all the MicroStrategy


products and reference guides, such as Javadocs for the
APIs.
Development tools that contain the source code and
sample application code for typical customization tasks.
The SDK also provides development tools and
production-ready utilities that reduce code creation and
maintenance and help you build customized applications.

MicroStrategy Office

MicroStrategy Office lets every Microsoft Office user run,


edit, and format any MicroStrategy report directly from
within Microsoft applications such as Excel, PowerPoint,
and Word. MicroStrategy Office is designed using Microsoft
.NET technology and accesses the MicroStrategy business
intelligence platform using XML and Web Services.

MicroStrategy Office gives business users open and


straightforward access to the full functionality of the
MicroStrategy platform from familiar Microsoft Office
applications. MicroStrategy Office serves as a Microsoft
add-in, with MicroStrategy functionality exposed as a single
toolbar in Microsoft Office applications.

To learn how to use other Microsoft Office tools, refer to the


MicroStrategy Office online help.

10 MicroStrategy components 2005 MicroStrategy, Inc.


Installation and Configuration Guide Introduction to MicroStrategy 1

MicroStrategy Narrowcast Server

MicroStrategy Narrowcast Server proactively distributes


personalized information to employees, business partners,
and customers through a variety of devices, including mobile
phones, PDAs, e-mail, Web pages, and pagers. The
distribution of personalized messages and targeted offers is
triggered according to predefined schedules and exception
criteria, delivering information in a timely and convenient
manner. MicroStrategy Narrowcast Server also provides a
self-subscription portal, easing administrative
responsibilities and empowering information consumers to
choose the information they receive. Narrowcast Server can
draw information from relational or non-relational sources.

For information on Narrowcast Server sub-components, refer


to the MicroStrategy Narrowcast Server Installation and
Configuration Guide.

MicroStrategy eTrainer for Web

MicroStrategy eTrainer is a Web-based training module that


gives you the in-depth knowledge and hands-on experience
you require to work with MicroStrategy Web or Web
Universal.

Each lesson of the MicroStrategy eTrainer course describes a


function of MicroStrategy Web and breaks it into a
combination of informational screens and task-based tests.
Each lesson has an appropriate and graded activity. This
training gives you the option to pick and choose topics that
enhance your performance, ultimately leading to the success
of the business intelligence or e-business project. With the
included database feature, managers can control access to the
training and monitor progress and achievement of users
going through the eTrainer module to learn about
MicroStrategy Web or Web Universal.

For more information, refer to the MicroStrategy ReadMe


files.

2005 MicroStrategy, Inc. MicroStrategy components 11


1 Introduction to MicroStrategy Installation and Configuration Guide

MicroStrategy Analytics Modules

MicroStrategy Analytics Modules are a set of packaged


analytic components built using the MicroStrategy platform.
The modules can be mapped to a different warehouse or used
as starter kits to develop custom applications. Each module
consists of a MicroStrategy project in a metadata, a reference
guide, and a default data model. Examples of the Analytics
Modules are as follows:

Customer Analysis Module focuses on customer-centric


information

Sales Analysis Module focuses on information captured


during the sales process

Web Traffic Analysis Module provides in-depth analysis


of website information captured in Web logs

Financial Reporting Analysis Module provides in-depth


analysis of financial information captured by general
ledgers, forecasting systems, and data on actual amounts,
payables, and receivables

MicroStrategy Tutorial Reporting

MicroStrategy Tutorial is a sample MicroStrategy project


with a metadata and warehouse, and a set of demonstration
applications designed to illustrate the platform's rich
functionality.

The theme of the MicroStrategy Tutorial project is a retail


store for the years 2003 - 2004 that sells electronics, books,
movies, and music. The key features include:

Five hierarchies: Customer, Geography, Products,


Promotions, and Time. Each hierarchy can be viewed
graphically through MicroStrategy Desktop and Web
(through documents).

A large number of customers and items purchased.

Five reporting areas: Human Resources, Inventory,


Financial, Product Sales, and Supplier.

12 MicroStrategy components 2005 MicroStrategy, Inc.


Installation and Configuration Guide Introduction to MicroStrategy 1

Options to create reports from MicroStrategy Web or


Desktop focusing on a particular analysis area, such as
Customer, Inventory, Time, Products, Category,
Employee, or Call Center.

For more information on the MicroStrategy Tutorial, refer to


the MicroStrategy Advanced Reporting Guide.

SequeLink ODBC Socket Server

SequeLink is a complete, end-to-end solution for configuring


and managing data access across virtually any number of
data stores, operating systems, and deployment options. It
provides a universal client for ODBC and JDBC, and a
centralized console for configuring and managing data access
from a single point of control. SequeLink creates two NT
services: SLAgent 54, which is the Administrator, and
SLSocket54, which is the Server.

 SequeLink ODBC Socket Server is installed


automatically if you install MicroStrategy Narrowcast
Server. You do not need to install this if you are not
installing MicroStrategy Narrowcast Server.

2005 MicroStrategy, Inc. MicroStrategy components 13


1 Introduction to MicroStrategy Installation and Configuration Guide

How to use this book


This guide provides information on how to install and
configure MicroStrategy products on Windows UNIX, and
Linux. To help you navigate through this guide, the following
section lists down the chapters that you should refer to
depending on the platform on which you are installing the
products. It also provides a brief overview of each chapter. It
is recommended that you read this section before performing
an installation.

You must read Chapter 2, Planning Your Installation,


whether you are installing MicroStrategy on Windows or any
other operating system. It provides details on things to
consider before performing an installation, such as hardware
and software recommendations and system sizing guidelines.

Installing MicroStrategy on Windows


If you are installing MicroStrategy on Windows, you should
refer to the following chapters sequentially.
Chapter 3, Installing MicroStrategy on Windows: This
chapter describes the procedures for installing the
MicroStrategy products necessary to get your business
intelligence application running in Windows
environment.

 Asautomated
an alternative, you can perform a fully
installation and configuration. For
more information refer to Chapter 10, Automated
Installation and Configuration on Windows.
Chapter 5, Configuring MicroStrategy Intelligence Server:
After installing MicroStrategy products, you must use the
MicroStrategy Configuration Wizard to configure the
MicroStrategy metadata repository and statistics tables,
Intelligence Server, and project sources. This chapter
describes the steps used to configure an installed
MicroStrategy suite of products using the MicroStrategy
Configuration Wizard.

14 How to use this book 2005 MicroStrategy, Inc.


Installation and Configuration Guide Introduction to MicroStrategy 1

Chapter 6, Creating a Project: After installing and


configuring MicroStrategy products, you must create your
own projects to start using the product with your own
data. This chapter tells you what a project is and how you
can create a project using MicroStrategy Desktop and
Project Builder.

Chapter 7, Deploying Your Project with MicroStrategy


Web: You can deploy the project that you have created to
your user community using MicroStrategy Web. This
chapter describes the steps to connect the ASP.NET
version of MicroStrategy Web with MicroStrategy
Intelligence Server on Windows.

 You can deploy your project with either


MicroStrategy Web or Web Universal.
MicroStrategy Web Universal is platform-
independent, whereas MicroStrategy Web can be
installed only on Windows.

Chapter 8, Configuring and Deploying MicroStrategy Web


Universal: You can deploy your project to your user
community using MicroStrategy Web Universal. This
chapter provides information on how to deploy and
configure MicroStrategy Web Universal on Windows and
other operating systems with various Web and application
servers. If you are installing on Windows, refer to the
following sections:

Deploying with Tomcat (Linux)

Deploying with Oracle 10g


Using the MicroStrategy Web Administrator Console

Chapter 10, Automated Installation and Configuration on


Windows: As an alternative to the regular installation
described in Chapter 3, Installing MicroStrategy on
Windows, you can perform a fully automated and
unattended installation including customization and
configuration routines available with the product. This
chapter describes different types of unattended and
automated installations and provides steps to perform
these installations on Windows.

2005 MicroStrategy, Inc. How to use this book 15


1 Introduction to MicroStrategy Installation and Configuration Guide

Chapter 12, Adding or Removing MicroStrategy


Components: This chapter describes the steps to add and
remove MicroStrategy components on Windows, as well
as other operating systems. If you are performing an
installation on Windows, refer to the following sections:

Adding or removing MicroStrategy components on


Windows.

Reinstalling MicroStrategy components on Windows.

Uninstalling MicroStrategy components on Windows.

Installing MicroStrategy on UNIX and Linux


If you are installing MicroStrategy on UNIX or Linux
operating systems, you should refer to the following chapters
sequentially.

Chapter 4, Installing MicroStrategy on UNIX and Linux:


This chapter describes the procedures for installing the
MicroStrategy products necessary to get your business
intelligence application running on a UNIX or Linux
environment.

Chapter 5, Configuring MicroStrategy Intelligence Server:


After installing MicroStrategy products, you must use the
MicroStrategy Configuration Wizard to configure the
MicroStrategy metadata repository and statistics tables,
Intelligence Server, and project sources. This chapter
addresses the processes necessary to configure an
installed MicroStrategy suite of products using the
MicroStrategy Configuration Wizard.

Chapter 8, Configuring and Deploying MicroStrategy Web


Universal: This chapter provides information on how to
deploy and configure MicroStrategy Web Universal on the
UNIX and Linux platform with various Web and
application servers. If you are installing on UNIX or Linux
platform, refer to the following sections:
Deploying with WebLogic and Apache.

Deploying with WebSphere 5.x and IBM HTTP Server.

16 How to use this book 2005 MicroStrategy, Inc.


Installation and Configuration Guide Introduction to MicroStrategy 1

Deploying with Sun ONE (iPlanet) 8.0.

Using the MicroStrategy Web Administrator Console.

Chapter 9, Setting up Documents and HTML Documents:


This chapter explains the setup required for the
Intelligence Server to create and execute HTML
documents and documents. It also describes the steps to
create this setup.

Chapter 11, Automated Installation and Configuration on


UNIX: As an alternative to the normal installation
described in Chapter 4, Installing MicroStrategy on
UNIX and Linux on other operating systems, you can
perform a fully automated and unattended installation
without using the graphical user interface. This chapter
describes different types of unattended and automated
installations and steps to perform these installations on
UNIX.

Chapter 12, Adding or Removing MicroStrategy


Components: This chapter describes the steps to add and
remove MicroStrategy components on all supported
operating systems. For UNIX and Linux platforms, refer
to the following section:
Uninstalling MicroStrategy components on UNIX and
Linux

2005 MicroStrategy, Inc. How to use this book 17


1 Introduction to MicroStrategy Installation and Configuration Guide

18 How to use this book 2005 MicroStrategy, Inc.


2
2. PLANNING YOUR
INSTALLATION

Introduction

This chapter describes important information regarding


MicroStrategy installation that should be taken into
consideration before you start installing MicroStrategy
products.

This chapter has the following sections:

Upgrade considerations

Installation prerequisites

Installation considerations

Methods of installation

Methods of installation

Licensing information

Next steps

2005 MicroStrategy, Inc. 19


2 Planning Your Installation Installation and Configuration Guide

Upgrade considerations
If you have MicroStrategy products installed and want to
upgrade them, refer to the MicroStrategy Upgrade Guide.
The upgrade procedures on Windows and UNIX are covered
in this guide. It is recommended that you read this guide
before deciding to upgrade an existing database.

Installation prerequisites
Before you install MicroStrategy, you must have the
following:

MicroStrategy Intelligence Server installation files

You can access the installation files from the


MicroStrategy CD-ROM or you can ask your system
administrator to share the files on a network location.
For information on mounting or unmounting
CD-ROMs, see Mounting CD-ROMs, page 400, in
Appendix E, Troubleshooting.

License key from MicroStrategy

Installation location for your MicroStrategy products

Write permissions in the installation directory to


complete the installation; otherwise the installation fails

Apart from the information provided above, review the


following sections before you start the installation:

Recommended installation location

Hardware recommendations

Software recommendations

20 Upgrade considerations 2005 MicroStrategy, Inc.


Installation and Configuration Guide Planning Your Installation 2

Recommended installation location


There are hundreds of possible arrangements for all the
products available on MicroStrategy platform, and what you
decide to do depends largely on your installation
environment and requirements. In general, though, the
following recommendations are usually true for a typical
business intelligence system:

MicroStrategy Intelligence Server should be installed on


its own dedicated server machine.

MicroStrategy Web should be installed on its own


dedicated Web server machine.

The rest of the products can be installed in varying


combinations depending on who intends to use them and
on what machines.

 These are just suggestions to help you get started.


Read the rest of this chapter for more detailed
guidelines.

Hardware recommendations
MicroStrategy acknowledges that variables, such as CPU
speed, CPU type, OS version, and service upgrades, File
Space, Physical and Swap Memory, are factors that play an
important role in making your deployment of MicroStrategy
Intelligence Server Universal a successful one. This section
lists the hardware recommendations for Windows, UNIX,
and Linux platforms.

 The following information is intended to give the


reader a general guidance for hardware requirements.
For more details and exact information regarding
supported and certified versions of the OS for a
particular MicroStrategy release, see the Readme files
or contact Technical Support.

2005 MicroStrategy, Inc. Installation prerequisites 21


2 Planning Your Installation Installation and Configuration Guide

System hardware recommendations for


Windows

The following table shows the recommended and minimum


hardware requirements for MicroStrategy products. See the
products readme files for the updated requirements.

MicroStrategy
Processor Memory Storage
Product

Administrator 1 GHz or higher 1 GB (minimum 500 MB


Pentium compatible 256 MB)
(minimum 450MHz)

Desktop 1 GHz or higher 1 GB (minimum 500 MB


Products Pentium compatible 256 MB)
(minimum 450MHz)

Intelligence 1 GHz or higher 2 GB (minimum 2 GB


Server Pentium compatible 512 MB) (minimum
(minimum 600 MHz) 512 MB)

MicroStrategy 1 GHz or higher 512 MB 100 MB


Office Pentium compatible (minimum 256
(minimum 400 MHz) MB)

Narrowcast 1 GHz Pentium or 1 GB 2 GB


Server equivalent (minimum 512 (minimum 1
(minimum 600 MHz) MB) GB)

SDK no additional requirements

MicroStrategy 400 MHz or higher 512 MB 1 GB


Tutorial Pentium compatible

MicroStrategy N.A. N.A. N.A.


BI Developer Kit

MicroStrategy
Web

Web server 1 GHz or higher 1 GB (minimum 1 GB


Pentium compatible 512MB) (minimum
(minimum 450 MHz) 500 MB)

Web client 1 GHz or higher 512 MB or Additional


Pentium compatible higher space not
(minimum 450 MHz) (minimum 128 required
MB)

22 Installation prerequisites 2005 MicroStrategy, Inc.


Installation and Configuration Guide Planning Your Installation 2

MicroStrategy
Processor Memory Storage
Product

MicroStrategy
Web Universal

Web Server 1 GHz or higher 1 GB or higher 1 GB or


Web Client (minimum 450 MHz) (minimum higher
512MB) (minimum
500 MB)

1 GHz or higher 128MB or Additional


(minimum 450 MHz) higher space not
(minimum required
512MB)

In addition to the MicroStrategy products listed above, the


database server on which your MicroStrategy metadata is
hosted should run on a computer with the following
minimum configuration:

Processor: 400 MHz or higher Pentium compatible

Memory: 256 MB

Storage: 200 MB

 Note the following:


Depending on the MicroStrategy products you intend
to install, you must have at least 170 MB to 300 MB of
free space on your C: drive for a set of system files that
MicroStrategy installs. If you only install
MicroStrategy Web, you need 170 MB of free space.
However, for other products besides MicroStrategy
Web, you need 300 MB of free space. For example,
even if you perform an advanced installation and
choose to install every MicroStrategy product on your
D: drive, you still have 300 MB of system files installed
on your C: drive. This storage requirement is in
addition to the storage requirement discussed in the
above list.
Intelligence Server is licensed based on CPU number
and clock speed. Thus, Intelligence Server can only be
installed on machines with a maximum clock speed
that equals the licensed clock speed. If you try to
install the product on a machine faster than what is

2005 MicroStrategy, Inc. Installation prerequisites 23


2 Planning Your Installation Installation and Configuration Guide

licensed, installation fails. For example, if you are


licensed only for 750 MHz clock speed, you cannot
install the software on a 1 GHz machine. See the
MicroStrategy System Administration Guide for
more information about licensing.

MicroStrategy Intelligence Server hardware


recommendations on UNIX

For the exact information, such as version numbers and


space requirements, see the Readme file.

Sun Solaris

Hardware File CD-ROM


CPU Memory Swap
Configuration Space Drive

Minimum 1 x 450 MHZ 1 GB 2 GB 2 GB Yes


UltraSparc II
and III

Space requirements on Sun Solaris

Common Files referred to in this table are installed no matter


which MicroStrategy products are selected.

Common Intelligence Web


Directory SDK
Files Server Universal

Home Directory 427 KB 107 KB 0 0

Install Directory 260 MB 340 MB 0 0

Log Directory 2 KB 0 0 0
Web Universal N/A N/A 26.4 MB N/A
Deploy Directory

SDK Install N/A N/A N/A 281 MB


Directory

24 Installation prerequisites 2005 MicroStrategy, Inc.


Installation and Configuration Guide Planning Your Installation 2

In addition to the space requirements listed above, you also


need 75 MB of free space in the temporary directory. The
default location of the temporary directory is /var/tmp. If
the space in the default temporary directory is inadequate,
you can use the is:tempdir command to change the
location of the temporary directory. This directory must
already exist and it must be specified using its absolute path,
for example:

./setupsol.bin is:tempdir /home/user/tmp

IBM AIX

Hardware File CD-ROM


CPU Memory Swap
Configuration Space Drive

Minimum 1 x 450 MHZ 1 GB 2 GB 2 GB Yes


PowerPC 4
and
PowerPC 5

The AIX kernel should be running only in 64-bit mode. You


can determine the mode by logging in as the root user and
entering bootinfo -K at the command prompt. The output
displays the mode.

Space requirements on IBM AIX

Common Files referred to in this table are installed no matter


which MicroStrategy products are selected.

Common Intelligence Web


Directory SDK
Files Server Universal

Home Directory 551 KB 103 KB 0 0

Install Directory 342 MB 1009 MB 0 0


Log Directory 3 KB 0 0 0

Web Universal N/A N/A 26.4 MB N/A


Deploy Directory

SDK Install N/A N/A N/A 281 MB


Directory

2005 MicroStrategy, Inc. Installation prerequisites 25


2 Planning Your Installation Installation and Configuration Guide

In addition to the space requirements listed above, you also


need 55 MB of free space in the temporary directory. The
default location of the temporary directory is /tmp. If the
space in the default temporary directory is inadequate, you
can use the is:tempdir command to change the location of
the temporary directory. This directory must already exist
and it must be specified using its absolute path, for example:

./setupAIX.bin is:tempdir /home/user/tmp

RedHat Linux

Hardware File CD-ROM


CPU Memory Swap
Configuration Space Drive

Minimum for 1 x 1.8 GHz 1 GB 4 GB 2 GB Yes


AMD Opteron Opteron

Minimum for 1 x 2.8 GHz 1 GB 4 GB 2 GB Yes


Intel Xeon Xeon EM64T

Space requirements for RedHat Linux

Common Files referred to in this table are installed no matter


which MicroStrategy products are selected.

Common Intelligence Web


Directory SDK
Files Server Universal

Home Directory 425 KB 112 KB 1 0

Install Directory 314.8 MB 465.2 MB 0 0

Log Directory 2 KB 1 0 0

Web Universal N/A N/A 27.2 KB N/A


Deploy Directory

SDK Install N/A N/A N/A 243.9 MB


Directory

26 Installation prerequisites 2005 MicroStrategy, Inc.


Installation and Configuration Guide Planning Your Installation 2

In addition to the space requirements listed above, you also


need 60 MB of free space in the temporary directory. The
default location of the temporary directory is /tmp. If the
space in the default temporary directory is inadequate, you
can use the is:tempdir command to change the location of
the temporary directory. This directory must already exist
and it must be specified using its absolute path, for example:

./setupLinux.bin is:tempdir /home/user/tmp

MicroStrategy Web Universal hardware


recommendations on UNIX

For exact information, see the MicroStrategy Readme file.

Web server

Requirement Minimum Recommended

Processor 450 Mhz 1 Ghz or higher

RAM 512 MB 1 GB or higher

Hard disk space 500 MB 1 GB or higher

Web client

Requirement Minimum Recommended

Processor 450 Mhz 1 Ghz or higher


RAM 128 MB 512 MB or higher

2005 MicroStrategy, Inc. Installation prerequisites 27


2 Planning Your Installation Installation and Configuration Guide

MicroStrategy Web Universal hardware


recommendations on Linux

For exact information, see the MicroStrategy Readme file.

Web server

Requirement Minimum Recommended

Processor 1 GHz Opteron -OR- 1 GHz Opteron -OR-


2.8GHz Xeon 2.8GHz Xeon

RAM 512 MB 1 GB or higher

Hard disk space 500 MB 1 GB or higher

Software recommendations
This section lists the software recommendations for the
Windows and UNIX platforms.

 The following information is intended to give the


reader a general guidance for software requirements.
For more details and exact information regarding
supported versions of the operating system for a
particular MicroStrategy release, see the Readme files
or contact Technical Support.

28 Installation prerequisites 2005 MicroStrategy, Inc.


Installation and Configuration Guide Planning Your Installation 2

System software recommendations on Windows

For a successful installation of MicroStrategy products, the


following product-specific software requirements must be
satisfied.

MicroStrategy Product Software Requirements

Administrator At a minimum, you should have one of the


following for a Windows operating system:
Microsoft Windows 2000 SP1 or higher
Microsoft Windows 2003 Server
Standard Edition or Enterprise Edition
Microsoft Windows XP Professional
Edition SP1 (not valid for Enterprise
Manager)

Desktop Products Internet Explorer 4.01 or higher. Note


that to use the Document Editor with
double-byte languages you need
Internet Explorer 5.01.

Intelligence Server For Windows 2000:


Windows 2000 Server SP3 or SP4
Windows 2000 Advanced Server SP3 or
SP4
Internet Explorer 5.01 or higher
For Windows Server 2003:
Windows Server 2003 Enterprise Edition
Windows Server 2003 Standard Edition
Internet Explorer 6.01 or higher

MicroStrategy Office Microsoft Internet Information Services


5.0 or higher
Microsoft .NET Framework 1.1 build
v1.1.4322 or higher
Microsoft Excel, Microsoft
PowerPoint, or Microsoft Word, all
version 2000 or higher
MicroStrategy Web Services configured
and running

2005 MicroStrategy, Inc. Installation prerequisites 29


2 Planning Your Installation Installation and Configuration Guide

MicroStrategy Product Software Requirements

MicroStrategy Web

Web server Microsoft Internet Information Services 5.0


or higher
Web client Minimum resolution for the monitor is
800 x 600 or higher with 256 color
palette minimum, but the recommended
resolution is 1024 x 768 or higher
Any spreadsheet application that
supports the CSV file type can be used
as an export alternative to Microsoft
Excel

MicroStrategy Web
Universal

Web server Certified combination of Web server,


application server and operating system

Recommended resolution for the


Web client monitor is 800x600 or higher with 256
color palette minimum
Any spreadsheet application that
supports the CSV file type can be used
as an export alternative to Microsoft
Excel

SDK No additional requirements

MicroStrategy Tutorial See the Introduction to MicroStrategy:


Evaluation Guide for complete details

MicroStrategy BI MicroStrategy Desktop Designer or


Developer Kit MicroStrategy Architect version 7.5.0 or
higher

Narrowcast Server Microsoft Internet Information Services


4.0 or higher
Internet Explorer 5.01 Service Pack 2 or
higher
ODBC and JDBC connectivity

For more detailed information on product-specific


requirements, see the products readme files.

30 Installation prerequisites 2005 MicroStrategy, Inc.


Installation and Configuration Guide Planning Your Installation 2

MicroStrategy Intelligence Server software


recommendations on UNIX

For the exact information such as version numbers and space


requirements, see the Readme file.

Sun Solaris

Sun Solaris 8 Operating System for SPARC Platforms

Patch requirements:

Patch clusters: Sun-recommended patch clusters dated


05/31/05 or later.
Sun Solaris 9 Operating System for SPARC Platforms

Patch requirements:

111712-05 or higher

Patch clusters: Sun-recommended patch clusters dated


5/27/05 or later

 For details and installation information for each of the


patches, refer to the Patch Finder section of the Sun
Microsystems Web site, which can be found at
http://sunsolve.sun.com/pub-cgi/show.pl?
target=patches/patch-access.

Other requirements:

A Web browser (for example, Netscape 4.78 and


above) is required for viewing readme, release notes,
and online help.
Windows Services For UNIX or Samba
(http://www.samba.org)
(http://www.microsoft.com/windows/sfu/
downloads/default.asp) is required for HTML
documents support. Samba 3.0 is required for the
support of HTML documents with alphanumeric
names.

On UltraSparc II-based systems that support both 32


and 64-bit modes, the kernel must be booted in 32-bit
mode.

2005 MicroStrategy, Inc. Installation prerequisites 31


2 Planning Your Installation Installation and Configuration Guide

IBM AIX

IBM AIX 5L UNIX Operating System, version 5.2

Patch requirements:

AIX: 5.2 maintenance level 6

IBM AIX 5L UNIX Operating System, version 5.3

AIX: 5.2 maintenance level 2

Other requirements:

A X-windows-enabled environment is required for both


the GUI-based MicroStrategy Installation Wizard and
MicroStrategy Control Center.

A Web browser (for example, Netscape 4.78 and above) is


required for viewing readme files, release notes, and
online help.

Samba (http://www.samba.org) or Windows Services


For UNIX
(http://www.microsoft.com/windows/sfu/
downloads/default.asp) is required for HTML
documents support. Samba 3.0 is required for the support
of HTML documents with alphanumeric names.

RedHat Linux

RedHat Enterprise Linux AS Version 3 (64-bit) update 3

RedHat Enterprise Linux AS Version 4 (64-bit)


Other requirements:
A X-windows-enabled environment is required for both
the GUI-based MicroStrategy Installation Wizard and
MicroStrategy Control Center.

A Web browser (for example, Netscape 4.78 and above) is


required for viewing readme files, release notes, and
online help.

32 Installation prerequisites 2005 MicroStrategy, Inc.


Installation and Configuration Guide Planning Your Installation 2

Samba (http://www.samba.org) or Windows Services


For UNIX
(http://www.microsoft.com/windows/sfu/
downloads/default.asp) is required for HTML
documents support. Samba 3.0 is required for the support
of HTML documents with alphanumeric names.

MicroStrategy Web Universal software


recommendations on UNIX

For exact information, see the MicroStrategy Readme file.

Web client software

Requirement Recommended

Web browser At a minimum, you should have one of the


following for a Windows operating system:
Microsoft Internet Explorer version 6.0
SP1
Mozilla Firefox 1.0
Netscape Navigator 6.2 (HTML mode
only)
However, MicroStrategy recommends the
following browsers for a Windows operating
system:
Microsoft Internet Explorer 6.0 SP1
Mozilla Firefox 1.0
For the UNIX operating systems:
Netscape 7.0 on Solaris
Netscape 7.0 on AIX
Firefox 1.0 on Linux

Browser resolution 800 x 600 or higher with 256 color palette


minimum

Spreadsheet application Microsoft Excel or other spreadsheet


(for exporting) application that supports the CSV file type

PDF viewer (for viewing Adobe Acrobat Reader versions 5 or 6


and exporting PDF
documents)

2005 MicroStrategy, Inc. Installation prerequisites 33


2 Planning Your Installation Installation and Configuration Guide

Web server operating systems

MicroStrategy Web Universal supports these operating


systems:

Microsoft Windows 2000/2003

IBM AIX 5.2 or 5.3

Sun Solaris 8 or 9 for SPARC

RedHat Enterprise Linux AS Version 3 or 4 for


ADM64/EM64T

Application servers

MicroStrategy Web Universal supports the following


application servers:

BEA WebLogic version 7.x or 8.x

IBM WebSphere version 5.x or 6.x

Apache Tomcat versions 4.x or 5.x

Oracle 10g (also known as Oracle application server 9.x)

Sun ONE (iPlanet) Application Server version 8.x

 Throughout this guide iPlanet is referred to as Sun


ONE (iPlanet). Sun Microsystems purchased iPlanet
and renamed it Sun ONE Application Server.

Web servers

MicroStrategy Web Universal supports the following Web


servers:
Apache version 1.3 and 2.0

IBM HTTP Server version 1.3 or 2.0

Microsoft Internet Information Server version 5.0 or 6.0

Sun ONE (iPlanet) Web Server 6.x (previously known as


iPlanet Web Server, Enterprise Edition version 6.0 SP5)

 This guide uses Sun ONE (iPlanet) Web Server to


refer to what was previously known as iPlanet.

34 Installation prerequisites 2005 MicroStrategy, Inc.


Installation and Configuration Guide Planning Your Installation 2

Java development kits

MicroStrategy Web Universal supports the following Java


development kits:

IBM JDK 1.3.x, and 1.4.x

Sun JDK 1.3.x, and 1.4.x

For information on the exact version numbers, see the


Readme file.

Installation considerations
The following section contains guidelines and considerations
you must keep in mind during MicroStrategy installation.

System sizing guidelines


The following topics describe things to consider when you
initially set up your system. You should periodically
reevaluate the system and update it based on actual system
performance and use.

 This section describes only the most basic guidelines.


For detailed information refer to the MicroStrategy
System Administration Guide.

Number of users

The number of users can be measured in the following ways:

Total users: Users that are registered in the system. For


example, if a corporate website is available to be viewed
by 950 individuals, the site has 950 total users.
Active users: Users that are logged into the system. If a
site is available to be viewed by 950 total users and 30 of
them are logged in to the site, there are 30 active users.

2005 MicroStrategy, Inc. Installation considerations 35


2 Planning Your Installation Installation and Configuration Guide

Concurrent users: Users that have jobs being processed by


a server (MicroStrategy Web, Intelligence Server, and so
on) at the same time. For example, a site is available to
950 total users, and 30 people are logged in. Of 30 active
users, 10 have jobs being processed by the server
simultaneously, hence there are 10 concurrent users.

Of these measures, the number of concurrent users is


important to consider. Your system must support the
maximum number of concurrent users you expect at any
given time.

Report complexity

The more complex a report, the more Intelligence Server


resources are required. In this context, a complex report is
one that requires a lot of analytical processing. While reports
with long, complicated SQL are certainly complex in nature,
they do not necessarily require additional Intelligence Server
resources to execute. It is the analytical processing in a report
that creates additional stress on an Intelligence Server.

Since analytically complex reports create a heavier load on


the Intelligence Server than simpler reports, you should have
a general idea of what the average report complexity is for
your system. Knowing this can help you decide on a caching
strategy. For example, you may decide to pre-cache complex
reports and determine the processing power your Intelligence
Server needs.

 The database server processes the SQL that


Intelligence Server generates, so reports with
extremely complex SQL can place additional stress on
the database server. You should take this into account
when sizing your database server machine.

36 Installation considerations 2005 MicroStrategy, Inc.


Installation and Configuration Guide Planning Your Installation 2

Ad hoc reports versus caches

Report caches store the results of previously executed


reports. If a client (MicroStrategy Web, Desktop, and so on)
requests a report that is cached, Intelligence Server simply
returns the cached report results to the client. For any ad hoc
reports that are not cached, Intelligence Server must go
through the entire report execution cycle before it can return
the results. For this reason, report caching allows better
response time while minimizing the load on the Intelligence
Server.

The benefits of caching are more apparent for complex


reports than for simple reports. While caching a complex
report may significantly improve execution time, a report
cache for a simple report may not make much difference in
this regard.

Therefore, the more complex the ad hoc reporting is in your


system, the greater the overall load on the Intelligence Server.
Be sure to take this into account when sizing your Intelligence
Server machine.

 The process for element browsing is similar to ad hoc


reporting. Element browsing takes place when you
navigate through hierarchies of attribute elements, for
example, viewing the list of months in the year
attribute. By default, caching is enabled for element
browsing. In addition, you can limit the number of
elements to be retrieved at a time.

Report Services document

Report Services documents utilize MicroStrategy objects to


run complex and sophisticated reports. The datasets available
to a document determine its content. Each dataset represents
a report and its component objects, such as attributes,
metrics, custom groups, and consolidations. When a dataset
is available to a document, the entire report or any
component object from that dataset can be included in the
document output.

2005 MicroStrategy, Inc. Installation considerations 37


2 Planning Your Installation Installation and Configuration Guide

When creating a document, refer to the following guidelines


to avoid an increase in the Intelligence Server execution time
and the overall CPU usage:

The datasets should be few in number, but large in size.

The number of grids in the output document should be


less in number. Consolidate the data to fit into less grids
in the output document, where possible.
Use of complex elements, such as consolidations, custom
groups, and smart metrics can increase the Intelligence
Server usage, especially if arithmetic operators are used in
element definitions.
Use Custom formatting only when required.

OLAP Services

OLAP Services store reports as cubes in the physical memory


of the Intelligence Server. When these cubes are cached in
memory, report manipulations, such as adding derived
metrics, formatting, and drilling within the cube, take
considerably less time. This is the case because the new SQL
is not run against the database.

OLAP Services provide enhanced report manipulation


functionality at the cost of Intelligence Server resources, as
the cubes are stored in the memory of the Intelligence Server.
Consider the following factors to determine the size of the
Intelligent cubes:
Intelligence Server resources

expected response time

user concurrency

You must monitor Intelligence Server CPU utilization and


memory usage closely as OLAP Services might have an
impact on the performance of the platform, particularly the
memory and report response time.

38 Installation considerations 2005 MicroStrategy, Inc.


Installation and Configuration Guide Planning Your Installation 2

Additional considerations

Numerous factors can affect system performance, most of


them related to system specifics, which makes them difficult
to predict. Listed below are items you might want to consider
when determining the requirements for your system:

MicroStrategy Desktop versus MicroStrategy Web


usageMicroStrategy products are designed with the
assumption that the majority of users access the system
through MicroStrategy Web while a smaller percentage
use the Desktop products.

Statistics loggingStatistics logging is very useful for


analyzing and further refining the system configuration
based on actual usage. However, logging all statistics all
the time can create a noticeable increase in system
response time. For this reason, you might choose to log
only a subset of the statistics generated or only log
statistics periodically.

Backup frequencyCaches can be stored in memory and


on disk. When you enable backup, you allow the
Intelligence Server to write all cache files to disk. If the
backup frequency is set to the default of zero, backup files
are written to disk as soon as they are created. However,
writing all cache files to disk all the time can cause a
noticeable reduction in system performance.

Set the backup frequency to a value that minimizes disk


writes and optimizes memory usage for your system.
Ratio of Web servers to Intelligence ServersIn a typical
system you should have a 1:1 ratio of Intelligence Servers
to Web servers. This ensures that resources on both sides
are optimized. However, you might find it useful to add
Intelligence Servers or Web servers depending on your
particular requirements.

Report StylesMicroStrategy Web provides a set of


different XSL report styles. These styles provide an easy
way for you to customize how reports look. Due to the
varying complexity of these styles, some might require
more processing than others.

2005 MicroStrategy, Inc. Installation considerations 39


2 Planning Your Installation Installation and Configuration Guide

Common questions about sizing

Why should I increase the processor speed of


MicroStrategy Intelligence Server?

Increasing the processor speed of MicroStrategy Intelligence


Server enhances performance and reduces execution time for
all analytical tasks and for requests from the Extensible
Markup Language (XML) and Component Object Model
(COM) application programming interfaces (APIs).

Why should I add more processors to MicroStrategy


Intelligence Server?

Adding more processors to the MicroStrategy Intelligence


Server allows for a better load distribution among the
processors. This provides an overall performance gain.

Why should I increase disk speed?

Increasing disk speed allows MicroStrategy Intelligence


Server to store and retrieve caches faster, resulting in quicker
response time.

What would more network bandwidth do for me?

For very large result sets, increasing network bandwidth


reduces bottlenecks created by network congestion. The
result is larger data flow and faster query response time.

How many CPUs can a user fully utilize?

One user can fully utilize up to one CPU, regardless of the


number of CPUs available in the server. The load is split
across multiple CPUs in multi-processor servers.

What is the advantage of using hyper-threading for a


dual processor?

The advantage of using hyper-threading with a dual


processor is that it decreases the overall CPU usage. The use
of hyper-threading is recommended if you have large number
of users.

40 Installation considerations 2005 MicroStrategy, Inc.


Installation and Configuration Guide Planning Your Installation 2

What is the disadvantage of using hyper-threading for a


dual processor?

The disadvantage of using hyper-threading is that it increases


the Intelligence Server execution time slightly. Therefore, for
faster processing, the use of hyper-threading is not
recommended.

How will I determine the size of the Intelligent Cube


reports?

To determine the size of Intelligent Cube reports, view the


cache size of the Intelligent Cubes and Report Views. The
cache size reported in the Cache Monitor is generally 30-50%
smaller than the in-memory version because it is stored in a
compressed format.

What is the maximum Intelligent Cube cache size that I


can store in an Intelligence Server?

The Intelligence Server can support a single Intelligent Cube


with a cache size up to 400MB. A cache of this size would be
created with a report of approximately 40 million data cells.
However, with an Intelligent Cube of this size, the
Intelligence Servers memory resources will be limited for
other types of operations.

What is the recommended Intelligent Cube cache size?

It is recommend that an Intelligent Cube cache should not be


greater than 1MB in high concurrent environments. A cache
of this size would be created with a report of approximately
110,000 data cells.

2005 MicroStrategy, Inc. Installation considerations 41


2 Planning Your Installation Installation and Configuration Guide

MicroStrategy Web Universal and Intelligence Server


compatibility
MicroStrategy Web Universal 8.0 can only connect to
MicroStrategy Intelligence Server version 8.0. or later.

 Refer to the MicroStrategy 8 General Information


readme for the complete MicroStrategy platform
compatibility and interoperability specification. In
addition, you can contact MicroStrategy Technical
Support for the latest information and updates.

Certified ODBC drivers for MicroStrategy Intelligence Server


Universal Edition
The following table identifies the ODBC drivers that are
certified for MicroStrategy Intelligence Server on Solaris and
AIX.

RDBMS Driver

Informix MicroStrategy Informix Wire Protocol

Oracle MicroStrategy Oracle Wire Protocol

Sybase MicroStrategy Sybase Wire Protocol

DB2 MicroStrategy DB2 Wire Protocol

DB2 iSeries (formerly MicroStrategy DB2 Wire Protocol


known as AS400)

SQL Server MicroStrategy SQL Server Wire Protocol


Informix XPS MicroStrategy Informix Driver

Teradata NCR Teradata ODBC Driver

Red Brick Red Brick Driver


Sybase IQ Sybase IQ ODBC Driver

For information on the exact version numbers, see the


Readme file.

42 Installation considerations 2005 MicroStrategy, Inc.


Installation and Configuration Guide Planning Your Installation 2

MicroStrategy-branded 32-bit ODBC drivers are installed


with the MicroStrategy products.

 The MicroStrategy Connectivity Configuration Wizard


exposes only the MicroStrategy-branded ODBC
drivers. However, this guide also provides instructions
for drivers from other vendors, that you can install
separately and use with MicroStrategy. For more
information, refer to Appendix B, ODBC and DSNs.

Methods of installation
The methods of MicroStrategy installation are:

GUI (Graphical User Interface)

Command line

Silent installation

GUI
The GUI mode presents a user interface for each page in the
InstallShield Wizard. You click the mouse to place the cursor
on the desired object, then proceed as appropriate to
complete the task. The following navigational buttons are
also displayed:
Next: Click to proceed to the next page.

Back: Click to return to the previous page.

Cancel: Click to cancel the installation and close the


MicroStrategy InstallShield Wizard.
Finish (only on the MicroStrategy InstallShield Wizard
Complete page): Click to complete the setup and close the
wizard.

2005 MicroStrategy, Inc. Methods of installation 43


2 Planning Your Installation Installation and Configuration Guide

MicroStrategy provides the following types of GUI


installation:

Typical

Advanced

For information on how to perform these installations, refer


to Chapter 3, Installing MicroStrategy on Windows and
Chapter 4, Installing MicroStrategy on UNIX and Linux.

Typical installation

This installation is interactive and prompts you for a License


Key, the products to be installed, the location for the
MicroStrategy home directory, and the name of the program
folder where the application shortcuts reside.

Advanced installation

This is similar to the Typical installation, except that you have


more control over the individual directories in which each
component is installed. The Advanced installation prompts
you for the target directory for each component being
installed.

Command line
In command line mode, you type the appropriate information
at the prompt and press ENTER. Instructions are included on
each page of the InstallShield Wizard.

In some cases, you are asked to make a selection by pressing 1


or 2, and ENTER. You then press 0 and ENTER to continue.

Defaults appear next to each prompt and are enclosed in


square brackets, for example, [1]. Press ENTER to use the
default, or type a different response to the prompt to override
the default.

44 Methods of installation 2005 MicroStrategy, Inc.


Installation and Configuration Guide Planning Your Installation 2

In addition, on the command line wizard pages, the following


options are available:

Press 1 and then press ENTER to proceed to the next


page.

Press 2 and then press ENTER to return to the


previous page.

Press 3 and then press ENTER to cancel the


installation and close the MicroStrategy InstallShield
Wizard.

On the last page, which is MicroStrategy InstallShield


Wizard Complete, press 3 and then press ENTER to
complete the setup and close the wizard.

For information on command line installation, refer to


Chapter 4, Installing MicroStrategy on UNIX and Linux.

Silent installation
A silent, or unattended, installation is one that presents no
graphical user interface (GUI). Silent installations are useful
for system administrators who do not want users to run the
installation themselves. It allows you to automate the
installation, so it can be called from a script and executed
without user interaction.

For information on silent installation, refer to Silent


installation, page 265, in Chapter 10, Automated
Installation and Configuration on Windows and Silent
installation, page 274, in Chapter 11, Automated Installation
and Configuration on UNIX.

2005 MicroStrategy, Inc. Methods of installation 45


2 Planning Your Installation Installation and Configuration Guide

Licensing information
If you have installed the Evaluation version of MicroStrategy,
you cannot use its CD Key with a Generally Available (GA) CD
Key in the same environment. Hence, the Evaluation version
of MicroStrategy cannot be used for your production
environment.

For example, an organization that has MicroStrategy 7.5.0


installed does not support MicroStrategy Office as its CD Key
does not contain the license for MicroStrategy Office. If they
want to test the capabilities of MicroStrategy Office, they can
run the evaluation CD Key on their client computers, after
downloading MicroStrategy Office, to test it in their
environment. They then configure MicroStrategy Office to
connect to their Development Intelligence Server, which was
installed by the permanent GA CD key, on the MicroStrategy
Server computer. However, after attempting to run
MicroStrategy Office, the following error message appears:

The selected Login ID does not have privilege


to use MicroStrategy Office.

This message appears as the CD keys on the client machine


and on the MicroStrategy Intelligence Server are different.
Therefore, the same CD key must be used on both the
MicroStrategy Intelligence Server and on the Client machine
for the client to connect to the MicroStrategy Intelligence
Server.

 Aenvironment,
workaround for this scenario is to create a testing
built entirely on the Evaluation CD key.
This enables customers to test any products they want
to evaluate.

46 Licensing information 2005 MicroStrategy, Inc.


Installation and Configuration Guide Planning Your Installation 2

Types of licenses
The types of MicroStrategy licenses are

Named User licenses

CPU licenses

Named User licenses

When you purchase licenses in the Named User format, the


system monitors the number of users in your implementation
and compares it to the number of licenses. It can be
considered out of compliance if too many users are in the
metadata or more users are assigned higher-level privileges
than are licensed. For example, if you have licenses for 10
Web Professional users and 12 users have the privileges
associated with Web Professional, the system considers that
as noncompliance.

For more information, refer to Verifying Named user


licenses, page 318, in Appendix A, Managing Licenses.

CPU licenses

When you purchase licenses in the CPU format, the


Intelligence Server governs its processes to operate only on
the first "n" CPUs you specify during installation. The ability
to deploy MicroStrategy Intelligence Server only on a subset
of the total number of physical CPUs on a given machine is
called Processor Affinity. To learn more about Processor
Affinity, refer to MicroStrategy System Administration
Guide.

For more information on CPU licenses, refer to Verifying


CPU licenses, page 319, in Appendix A, Managing Licenses.

2005 MicroStrategy, Inc. Licensing information 47


2 Planning Your Installation Installation and Configuration Guide

Next steps
After planning your installation, you are now ready to install
the MicroStrategy components you need. The following
chapters instruct you on installing and configuring
MicroStrategy components. If you are installing
MicroStrategy on Windows, then see Chapter 3, Installing
MicroStrategy on Windows. If you are installing
MicroStrategy components on any other operating system,
then see Chapter 4, Installing MicroStrategy on UNIX and
Linux.

48 Next steps 2005 MicroStrategy, Inc.


3
3. INSTALLING MICROSTRATEGY
ON WINDOWS

Introduction

This chapter describes the procedures for installing the


MicroStrategy products that are necessary to run your
business intelligence application on a Windows environment.

 IfMicroStrategy
you have used the Evaluation Edition of the
platform, you may have installed most
of these products already. However, additional
considerations are important when you are setting up
a production business intelligence system as opposed
to running the evaluation software. You should read
this chapter carefully, even if you already have a
working system from your Evaluation Edition.

This chapter has the following sections:

Installation procedure

If you are installing MicroStrategy on UNIX or Linux, refer to


Installation procedures on UNIX or Linux, page 72 in
Chapter 4, Installing MicroStrategy on UNIX and Linux.

2005 MicroStrategy, Inc. 49


3 Installing MicroStrategy on Windows Installation and Configuration Guide

Installation procedure
The MicroStrategy InstallShield Wizard provides
step-by-step instructions to guide you through installing one
or more MicroStrategy products in a Windows environment.
The following sections can assist you in installing one or more
MicroStrategy products:

InstallShield Wizard

Installation verification

For information on installation prerequisites, see Installation


prerequisites, page 20 in Chapter 2, Planning Your
Installation.

For information about advanced installation functionality,


such as installing in an SMS environment or using
installation response files, see Chapter 10, Automated
Installation and Configuration on Windows.

For information about installing and deploying


MicroStrategy Web Universal on other operating systems or
with other Web and application servers, see Chapter 8,
Configuring and Deploying MicroStrategy Web Universal.

 Note the following:


If you have not uninstalled previous versions of
MicroStrategy products, you are prompted to
overwrite them. Click Yes to ensure that all products
are installed properly. To retain the existing Tutorial
metadata repository and warehouse, rename it or
move it to another location before you start the
installation process.
Though MicroStrategy supports Windows Terminal
Services, using Windows Terminal Services is not
recommended for installation. It can affect the
functionality of some MicroStrategy components.

50 Installation procedure 2005 MicroStrategy, Inc.


Installation and Configuration Guide Installing MicroStrategy on Windows 3

InstallShield Wizard
To install MicroStrategy products, you must log on to your
machine using a domain account with Windows
administrative privileges for the domain or target machine.
The domain must include your database servers.

To exit the installation process at any time, click Cancel.

To access the InstallShield Wizard

1 Log on to the machine where you are installing one or


more MicroStrategy products.

2 Exit all Windows applications before beginning the


installation process.

3 Insert the CD into the CD-ROM drive and wait for the
MicroStrategy Main Menu window to display
automatically.

 Iflocate
the MicroStrategy Main Menu does not display,
and run Setup.exe on the CD.

4 If this is the first time you have installed MicroStrategy,


you are prompted to choose the language for the wizard.
Select the appropriate language from the drop-down list
and click OK.

The InstallShield Wizard opens and leads you through the


rest of the installation process. The following sections
describe the actions you must take for each page in the
wizard.

If any Windows services are running for previously installed


MicroStrategy products, you are prompted to stop them.
Click Yes to proceed. If you click No, you cannot install
MicroStrategy products until you stop all MicroStrategy
services.

2005 MicroStrategy, Inc. Installation procedure 51


3 Installing MicroStrategy on Windows Installation and Configuration Guide

Welcome

Page Content Options

Welcome statement. Read the information on the


Welcome screen. Click Next to
proceed.

 IfMicrosoft
you opened the InstallShield Wizard through the
Control Panel using the Add/Remove
Programs option, the wizard opens the Welcome page
in maintenance mode. The table below describes this
window.

Page Content Options

Welcome statement. Click Modify to add new


program components or to
remove currently installed
components. The remaining
pages are the same as for a
first-time installation.
Click Repair to reinstall all
MicroStrategy components
installed by the previous setup.
You do not have to select the
MicroStrategy components
again.
Click Remove to remove all
installed MicroStrategy
components without accessing
all the InstallShield Wizard
pages.
Click Next to proceed.

 Ifyouyouneedinstall the MicroStrategy products using a CD,


your original installation CD to modify or
repair the software.

52 Installation procedure 2005 MicroStrategy, Inc.


Installation and Configuration Guide Installing MicroStrategy on Windows 3

License Agreement

Page Content Options

License-related terms and Read the license agreement,


conditions. and select to accept or decline
the agreement. If you choose to
decline, you cannot install
MicroStrategy products.
Click Next to proceed.
Click Back to return to the
previous page.

Customer Information

Page Content Options

Boxes for name, company name, Enter your name.


and product license key. Enter the name of your
company.
Enter the license key.
Click Next to proceed.
Click Back to return to the
previous page.

Setup Type

Page Content Options

Options to select the type of Select Typical to place all products


installation: Typical or in a given root directory.
advanced. Select Advanced to specify a
different directory for each
MicroStrategy product you install.
Click Next to proceed.
Click Back to return to the previous
page.

The significant differences between a Typical setup and an


Advanced setup are as follows:

With the Advanced setup option, you can select a different


location for each product selected in the Select
Components window; with the Typical option, all
products selected are placed in the same location.

2005 MicroStrategy, Inc. Installation procedure 53


3 Installing MicroStrategy on Windows Installation and Configuration Guide

With the Advanced setup option, you can select a location


for the common files; with the Typical setup option, the
system assigns the common file location (C:\Program
Files\Common Files\MicroStrategy).

Choose Destination Location

Page Content Options

Location where the MicroStrategy Click Browse to select a


products are installed. location different from the
default value; see the following
note.
Click Next to proceed.
Click Back to return to the
previous page.

 Note the following:


While this setting determines the default root
directory for the MicroStrategy products you install,
you can change the destination of a product later if you
choose an Advanced setup.

With both Typical and Advanced setup types, you can


choose the directory for a product only if that product
is not already installed on the server machine.
Otherwise, the product can only be installed in the
same directory in which it already exists. In that case
this page is not displayed.

Select Components

Page Content Options

A list of MicroStrategy products. Select or clear the appropriate


Space Required: Space check boxes.
needed for the MicroStrategy Click Next to proceed.
products selected; the count Click Back to return to the
changes dynamically as check previous page.
boxes are selected and
cleared.
Description: Details about
each MicroStrategy product.

54 Installation procedure 2005 MicroStrategy, Inc.


Installation and Configuration Guide Installing MicroStrategy on Windows 3

Click Yes if you are prompted to stop your Web server. If you
click No, you cannot continue with the installation until you
stop your Web server.

The installation screens you see from here depend on the


products you choose to install. These instructions describe all
possible screens, but to perform the functions described in
this book, you must install the following components along
with all their sub-components:

MicroStrategy Desktop Products

MicroStrategy Administrator

MicroStrategy Intelligence Server

MicroStrategy Web ASP.NET version, or Web


Universal, depending on your license key

MicroStrategy Web Services required for


MicroStrategy Office
MicroStrategy Office

MicroStrategy Narrowcast Server

MicroStrategy Tutorial - Reporting

 You do not have to install all of these products on


the same machine. In fact, this is strongly
discouraged in a production environment. For
basic guidelines about product placement, see
Installation prerequisites, page 20 in Chapter 2,
Planning Your Installation.

Many of the platform components have sub-components. If


you expand MicroStrategy Desktop Products, MicroStrategy
Administrator, MicroStrategy Web, MicroStrategy Web
Services, or MicroStrategy Narrowcast Server, you can select
or clear the appropriate check boxes to specify the
components and sub-components to install. For information
on MicroStrategy components and sub-components, see
MicroStrategy components, page 2 in Chapter 1,
Introduction to MicroStrategy.

2005 MicroStrategy, Inc. Installation procedure 55


3 Installing MicroStrategy on Windows Installation and Configuration Guide

CPU License Information

You see this page only if

you are installing MicroStrategy Intelligence Server on a


multi-processor machine

your license is based on CPU and allows for more than


one CPU

Page Content Options

Box to specify the number of Type the number of CPUs


CPUs Intelligence Server is to Intelligence Server is to use.
use on this machine. Click Next to proceed.
Information about the minimum Click Back to return to the
and maximum allowed number previous page.
of CPUs based on your license.

Select multiple target directories (Advanced


setup option only)

If you did not choose the Advanced Setup option, you skip
this page and its series of dialog boxes. If you select the
Advanced Setup option, you must specify the installation
location for each component you choose to install.

Page Content Options

This step consists of multiple Click Browse to select a target


sub-steps that open one dialog destination for each
box for each component.You can component.
select multiple target directories Click Next to proceed.
only if you choose an advanced Click Back to return to the
install. previous page.

The system validates the space available for each destination


selected. This processing is transparent. You are notified of
the status only if the space available is insufficient.

56 Installation procedure 2005 MicroStrategy, Inc.


Installation and Configuration Guide Installing MicroStrategy on Windows 3

MicroStrategy Web (ASP.NET) setting

You see this page only if you choose to install MicroStrategy


Web (ASP.NET) and only if you do not have a previous
version of MicroStrategy Web installed.

Page Content Options

Box to specify the name of the Specify the name of the IIS
Microsoft IIS virtual directory to be virtual directory to be created
created. for MicroStrategy Web.
Click Next to proceed.
Click Back to return to the
previous page.

In IIS, a virtual directory is the home location for a set of Web


pages that the Web server hosts. In this case, you must
specify the home location for the MicroStrategy Web ASP
pages. The default is MicroStrategy.

 Note the following:


If you have a previous version of MicroStrategy Web
installed on the machine, the new version you install
uses the same virtual directory the previous version is
using, and you are not prompted to specify the name
of the virtual directory.
The name provided for a virtual directory must be
unique. You cannot use the same name as the default
for other MicroStrategy products.

2005 MicroStrategy, Inc. Installation procedure 57


3 Installing MicroStrategy on Windows Installation and Configuration Guide

MicroStrategy Web (ASP.NET) CPU Affinity


setting

You see this page only if you choose to install MicroStrategy


Web (ASP.NET) and if the MicroStrategy Web installation
detects that the license key entered by the administrator
corresponds to a CPU-based license.

Page Content Options

Box to specify the number of CPUs Specify the number of CPUs


that MicroStrategy Web should use that Web should use on the
on the machine. machine.
This page is not displayed on Click Next to proceed.
single-processor machines. Click Back to return to the
previous page.

You can specify only the number of CPUs that are allowed by
the license. If MicroStrategy Web is installed on more than
one machine, the total number of CPUs should not exceed the
maximum number of CPUs specified by the license. For
machines that support hyperthreading technology, the CPU
counts correspond to physical CPUs, not logical CPUs.

 Note the following:


To allow the setting to take effect, the installation
stops Internet Information Services (IIS). After IIS has
been restarted, the MicroStrategy Web application
uses the specified number of CPUs.
If a CPU-based license key is specified for a machine
running IIS 5.0, a warning is displayed before the CPU
affinity selection dialog.

For more information on the MicroStrategy Web CPU affinity


feature, refer to the MicroStrategy System Administration
Guide.

58 Installation procedure 2005 MicroStrategy, Inc.


Installation and Configuration Guide Installing MicroStrategy on Windows 3

MicroStrategy Subscription Portal setting

You see this page only if you choose to install MicroStrategy


Subscription Portal, which is a component of Narrowcast
Server, and only if you do not have a previous version of
Subscription Portal installed.

Page Content Options

Box to specify the name of the Specify the name of the IIS
Microsoft IIS virtual directory to be virtual directory to be created
created. for MicroStrategy Subscription
Portal.
Click Next to proceed.
Click Back to return to the
previous page.

In IIS, a virtual directory is the home location for a set of Web


pages that the Web server hosts. In this case, you must
specify the home location for the Subscription Portal pages.
The default is NarrowcastServer.

 Note the following:


Subscription Portal offers you the ability to subscribe
to and view Narrowcast Server services, service
descriptions, and their most recent modification dates
on the Web. For complete information about
Subscription Portal and other components of
Narrowcast Server, refer to the MicroStrategy
Narrowcast Server documentation.
The name provided for a virtual directory must be
unique. You cannot use the same name as the default
for other MicroStrategy products.

2005 MicroStrategy, Inc. Installation procedure 59


3 Installing MicroStrategy on Windows Installation and Configuration Guide

MicroStrategy Web Services setting

You see this page only if you choose to install MicroStrategy


Web Services, which is required to run MicroStrategy Office,
and only if you do not have a previous version of Web
Services installed.

Page Content Options

Box to specify the name of the Specify the name of the IIS
Microsoft IIS virtual directory to be virtual directory to be created
created. for MicroStrategy Web
Services.
Click Next to proceed.
Click Back to return to the
previous page.

In IIS, a virtual directory is the home location for a set of Web


pages that the Web server will host. In this case, you must
specify the home location for the Web Services pages. The
default is MicroStrategyWS.

To learn more about MicroStrategy Web Services, refer to the


MicroStrategy Web Services Administration Guide.

MicroStrategy eTrainer for Web setting

You see this page only if you choose to install MicroStrategy


eTrainer for Web and if you do not have a previous version of
eTrainer installed.

Page Content Options

Box to specify the name of the Specify the name of the IIS
Microsoft IIS virtual directory to be virtual directory to be created
created. for MicroStrategy Web
Services.
Click Next to proceed.
Click Back to return to the
previous page.

60 Installation procedure 2005 MicroStrategy, Inc.


Installation and Configuration Guide Installing MicroStrategy on Windows 3

In IIS, a virtual directory is the home location for a set of Web


pages that the Web server hosts. In this case, you must
specify the home location for the eTrainer pages. The default
is eTrainer.

Select Program Folder

Page Content Options

Box to specify the name of the Perform one of the following


program folder in your Windows actions:
Start menu from which type a folder name different
MicroStrategy products will be from the default
accessed. select an existing folder
List of the existing program accept the default. It is
folders found under the recommended to accept to
Windows Start menu. default.
Click Next to proceed.
Click Back to return to the
previous page.

MicroStrategy Intelligence Server setting

You see this page if you choose to install MicroStrategy


Intelligence Server and if you do not have a previous version
of Intelligence Server installed.

Page Content Options

Check box: Option to not set Enter the necessary data and
the service account. click Next to establish the
Login: Windows login with account.
administrative privileges in the Select the check box to bypass
format Domain\User. account initiation.
Password: Valid password for
the login entered in the Login
box.
Confirmation: Retype the
password to confirm.

The MicroStrategy Intelligence Server service requires a


Windows account with administrative privileges under which
to run. If you click Cancel, the service runs under the local
system account.

2005 MicroStrategy, Inc. Installation procedure 61


3 Installing MicroStrategy on Windows Installation and Configuration Guide

 Note the following:


If you have a previous version of Intelligence Server
installed on your machine, the new version you install
uses the same account that the previous version is
using and you are not prompted for this information.

If the password you supply ever changes, you must


reconfigure the Windows service to use the new
password, otherwise Intelligence Server does not
work.

For information on installing MicroStrategy Intelligence


Server on UNIX or Linux, see Chapter 4, Installing
MicroStrategy on UNIX and Linux.

MicroStrategy Narrowcast Server Setting

You see this page if you choose to install MicroStrategy


Narrowcast Server.

Page Content Options

Check box: Option to not set Enter the necessary data and
the service account. click Next to establish the
Login: Windows login with account. It is recommended to
administrative privileges in the create the account.
format Domain\User. Select the check box to bypass
Password: Valid password for account initiation.
the login entered in the Login
box.
Confirmation: Retype the
password to confirm.

The MicroStrategy Narrowcast Server service requires a


Windows account on the machine with administrative
privileges. Enter the necessary information and click Next.

Refer to the MicroStrategy Narrowcast Server Installation


and Configuration Guide for additional details about this
setting.

62 Installation procedure 2005 MicroStrategy, Inc.


Installation and Configuration Guide Installing MicroStrategy on Windows 3

 Note the following:


If you have a previous version of Narrowcast Server
installed on the machine, the new version you install
uses the same account the previous version is using
and you are not prompted for this information.

If you change the password, you must reconfigure the


Narrowcast Server Windows services to use the new
password at any time.

MicroStrategy Web Universal Application


Deployment

This page is displayed only when the MicroStrategy Web


Universal option is selected in the Select Components page.

If you are not deploying with WebLogic Application Server,


skip this step and click Next to proceed.

Page Content Options

Information about the location By default, the Do not


where MicroStrategy Web configure Web Universal
Universal is deployed by the deployment location check
WebLogic Application Server. box is selected. If you are
deploying with WebLogic
Application Server, clear this
check box to enable the
Browse button.
Click Browse to specify the
MicroStrategy Web Universal
deployment location.
Click Next to proceed to the
next page.
Click Back to return to the
previous page.

2005 MicroStrategy, Inc. Installation procedure 63


3 Installing MicroStrategy on Windows Installation and Configuration Guide

If you are deploying with WebLogic Application Server, the


Web deployment descriptor file (web.xml) for the Web
Universal WAR file has to be modified to allow certain
configuration files used by MicroStrategy Web Universal to
be created under an absolute path. When the MicroStrategy
Web Universal application is started, several configuration
files used by the application are saved under this path. You
can specify this path under the MicroStrategy Web Universal
Deployment location.

For information on installing MicroStrategy Web Universal


on UNIX or Linux, see Chapter 4, Installing MicroStrategy
on UNIX and Linux.

MicroStrategy Office URL setting

You see this page if you choose to install MicroStrategy Office


and if you do not have a previous version of MicroStrategy
Office installed.

Page Content Options

Text box to specify the Specify the URL for


MicroStrategy Web Services URL MicroStrategy Web Services.
for MicroStrategy Office. Click Next to proceed.
Click Back to return to the
previous page.

The MicroStrategy Office client requires the Web Services


URL to access MicroStrategy projects. The URL depends on
the name of the IIS virtual directory that you specified on the
MicroStrategy Web Services Setting page. Assuming that you
kept the default value on the MicroStrategy Web Services
Setting page and you are installing on the same Web server
machine that is hosting MicroStrategy Web, you should use
the default URL provided:

http://localhost/MicroStrategyWS/MSTRWS.asmx

64 Installation procedure 2005 MicroStrategy, Inc.


Installation and Configuration Guide Installing MicroStrategy on Windows 3

MicroStrategy Office configuration

You see this page if you choose to install MicroStrategy Office


and if you do not have a previous version of MicroStrategy
Office installed.

Page Content Options

Check boxes to specify the Select the check box next to the
Microsoft Office applications to applications to be used.
integrate with MicroStrategy Office. Click Next to proceed.
Click Back to return to the
previous page.

This setting adds the MicroStrategy Office tool bar to the


Microsoft Office applications that you select. You can
configure MicroStrategy Office to integrate with Microsoft
Excel, PowerPoint, or Word. You can choose any of the
applications, but this chapter only shows you how to use
Excel.

Start Copying Files

Page content Options

Current Settings (depending Click Next to proceed.


upon the products you install): Click Back to return to the
Products that will be installed or previous page.
updated.
The target directories in which
the products are installed.
Name of the Windows Start
menu program folder.
Virtual directories for Web
(ASP.NET), Subscription
Portal, Web Services, and
eTrainer.
URL for MicroStrategy Web
Services.
Service accounts for
MicroStrategy Narrowcast
Server and Intelligence Server.
Location of the installation log
file.
License details.

2005 MicroStrategy, Inc. Installation procedure 65


3 Installing MicroStrategy on Windows Installation and Configuration Guide

Click Install to continue with the installation process, which


can take several minutes depending on your computers
hardware configuration.

Software Activation

Before the installation process ends the Software Activation


window opens.

Page Content Options

Option to automatically activate Select Yes to activate the


MicroStrategy installation via installation.
internet. Select No to activate the
installation at a later date.

This page gives you the option to activate your MicroStrategy


product installation automatically through the Internet, or
activate it at a later date by visiting the activation web site,
https://support.microstrategy.com/activation.
If you choose to activate your installation later, you have a
grace period of thirty calendar days. If you do not complete
the activation before the grace period expires, your
MicroStrategy product stops functioning until you activate it.
If you wait to activate your installation, you receive periodic
reminders.

When the activation process is finished, you are prompted to


either view the ReadMe file, or go directly to the InstallShield
Wizard Complete page. Click Yes to read the ReadMe file and
No to go to the InstallShield Wizard Complete page.

 During installation, the following folders are created


with special privileges that are required for
MicroStrategy Web users. Changes made to these
default access privileges can create problems for
MicroStrategy Web users:

Common files\MicroStrategy\Web-INF\log.
This folder stores the Web log files, including all
errors. All Web users can write to this location.

66 Installation procedure 2005 MicroStrategy, Inc.


Installation and Configuration Guide Installing MicroStrategy on Windows 3

Common files\MicroStrategy\Web-INF\xml.
This folder stores some of the configuration XML files,
such as AdminServers.xml and
AdminOptions.xml. The Web administrator can
add, remove, and modify the list of Intelligence
Servers to which the Web server is connected. The
Web administrator can also modify the Administrator
Preferences shared by all users.

InstallShield Wizard Complete

Page Content Options

Message confirming Select Yes to restart the


installation. computer. It is recommended to
Options Yes/No to restart the restart your computer.
computer if required. Select No to continue without
Check box to open the ReadMe restarting.
file, if restarting is not required. Select the check box to open
Instructions to empty drives and the ReadMe file, if restarting is
click Finish. not required.
Click Finish to complete the
setup.

 Ifensure
the option to restart your machine appears, to
that the installation process finishes correctly,
you should select Yes I want to restart my computer
now.

Installation verification
During the installation routine, the InstallShield Wizard
gathers and records information about your system and your
installation selections. Verify installation setup information
through the installation log file (install.log), located by
default in C:\Program Files\Common
Files\MicroStrategy.

The installation log file includes the following information:

Installation date

Target directories

2005 MicroStrategy, Inc. Installation procedure 67


3 Installing MicroStrategy on Windows Installation and Configuration Guide

Program folder name

Operating system identification

Hardware specifications

Selected installation options

Registry paths

List of registered files

 The installation log file can be helpful if you encounter


errors during the installation process. For example,
the log can tell you if a registry key or path was not
added or if a critical file was not registered
successfully.

Next steps
If you encounter errors while installing MicroStrategy, refer
to Appendix E, Troubleshooting.

After installation is complete, you are ready to configure the


MicroStrategy components you have installed. This ensures
the software can be used immediately. Configuration is
performed with the Configuration Wizard. To learn about the
Configuration Wizard, see Using the MicroStrategy
Configuration Wizard, page 89 in Chapter 5, Configuring
MicroStrategy Intelligence Server.

After you have installed MicroStrategy Web Universal, you


can deploy and configure it for your specific environment.
The configuration and deployment steps are provided in
Chapter 8, Configuring and Deploying MicroStrategy Web
Universal. The table below lists the steps for all
environments.

68 Installation procedure 2005 MicroStrategy, Inc.


Installation and Configuration Guide Installing MicroStrategy on Windows 3

High-Level Deployment Steps

1 Log on to the application server by using the proper user name and
password.
2 Locate the MicroStrategy.war file. It is located in the Web
Universal Deployment Directory you specified during installation.
3 To increase the performance of the application and before
proceeding with the deployment, see the Performance-based setup
information section, if available, for your environment and configure
as necessary. Also, after deploying Web Universal on your
machine, there may be a few performance-based setup steps that
you should complete.
4 Choose the desired deployment method.
5 Follow the deployment procedure.
6 Log on to the MicroStrategy Web Administrator Page.
7 Launch MicroStrategy Web.
8 Start working with the application.

For details on deploying MicroStrategy Web Universal with


different application and web servers on Windows, see the
following sections:

To deploy with Tomcat Application Server, see Deploying


with Tomcat (Linux), page 191 in Chapter 8, Configuring
and Deploying MicroStrategy Web Universal.

To deploy with Oracle Application Server, see Deploying


with Oracle 10g, page 199 in Chapter 8, Configuring and
Deploying MicroStrategy Web Universal.

The MicroStrategy platform comes with a Tutoriala sample


data warehouse and demonstration project you can use to
learn about the various features that MicroStrategy offers. It
is ready to be used and requires no additional configuration
tasks. If you have used the Evaluation Edition, you should
already be familiar with the Tutorial. To use the Tutorial,
refer to the Reporting Essentails chapter in the Basic
Reporting Guide. When you are ready to set up a new system
to be used with your own data, see Chapter 5, Configuring
MicroStrategy Intelligence Server and perform the tasks
described here.

2005 MicroStrategy, Inc. Installation procedure 69


3 Installing MicroStrategy on Windows Installation and Configuration Guide

70 Installation procedure 2005 MicroStrategy, Inc.


4
4. INSTALLING MICROSTRATEGY
ON UNIX AND LINUX

Introduction

This chapter describes the procedure for installing


MicroStrategy on UNIX or Linux platforms. MicroStrategy
products are compatible with Solaris, AIX, and RedHat. The
installation procedure described in this chapter refer to
installing MicroStrategy on Solaris, AIX, and RedHat. This
chapter covers the following section:
Installation procedures on UNIX or Linux

If you are installing MicroStrategy on Windows, refer to


Chapter 3, Installing MicroStrategy on Windows.

2005 MicroStrategy, Inc. 71


4 Installing MicroStrategy on UNIX and Linux Installation and Configuration Guide

Installation procedures on UNIX or Linux


This section describes installing MicroStrategy on UNIX or
Linux. The MicroStrategy products that you can install on
UNIX or Linux environment are:
MicroStrategy Intelligence Server

MicroStrategy Web Universal

MicroStrategy SDK

For more information about these products, see


MicroStrategy components, page 2 in Chapter 1,
Introduction to MicroStrategy.

Different methods of installation


MicroStrategy products can be installed on UNIX or Linux,
either in graphical user interface (GUI) mode or in command
line mode, using the MicroStrategy InstallShield Wizard. In
both cases, the MicroStrategy InstallShield Wizard runs,
displaying the same pages and requesting the same
information. The main differences are in how you provide the
information and navigate through the wizard.

Using GUI mode

The GUI (graphical user interface) mode presents a user


interface for each page in the InstallShield Wizard. You click
the mouse to place the cursor on the desired object, and then
proceed as appropriate to complete the task. The following
navigational buttons are also displayed:
Next proceed to the next page

Backreturn to the previous page

Cancelcancel the installation and close the


MicroStrategy InstallShield Wizard
Finishcomplete the setup and close the wizard

72 Installation procedures on UNIX or Linux 2005 MicroStrategy, Inc.


Installation and Configuration Guide Installing MicroStrategy on UNIX and Linux 4

Using command line mode

In command line mode, you type the appropriate information


at the prompt and press ENTER. Instructions are included on
each page of the InstallShield Wizard.

In some cases, you are asked to make a selection by pressing


1 or 2, and ENTER. You then press 0 and ENTER to continue.

Defaults appear next to each prompt and are enclosed in


square brackets, for example, [1]. Press ENTER to use the
default, or type a different response to the prompt to override
the default.

In addition, on the command line wizard pages, the following


options are available:

Press 1 and then press ENTER to proceed to the next


page.
Press 2 and then press ENTER to return to the
previous page.

Press 3 and then press ENTER to cancel the


installation and close the MicroStrategy InstallShield
Wizard.

On the last page, which is MicroStrategy InstallShield


Wizard Complete, press 3 and then press ENTER to
complete the setup and close the wizard.

Installing MicroStrategy using InstallShield Wizard


To install MicroStrategy products, you must log on to your
machine using a valid UNIX or Linux account. For ease of
management and maintenance, it is recommended that you
create a dedicated user account.

 You need root access permissions for installation if


you have purchased the CPU-based MicroStrategy
license.

To exit the installation process at any time, click Cancel.

2005 MicroStrategy, Inc. Installation procedures on UNIX or Linux 73


4 Installing MicroStrategy on UNIX and Linux Installation and Configuration Guide

To access the MicroStrategy InstallShield Wizard

1 Log on to the machine on which you are installing one or


more MicroStrategy products.

2 Browse to the MicroStrategyInstallation/


QueryReportingAnalysis_UNIX directory.

 You can access the installation files from a


CD-ROM or ask your system administrator to
share the files on a network location. There are
different CDs for installing MicroStrategy products
on different platforms; Windows, UNIX, and
Linux. For information on mounting or
unmounting CD-ROMs, refer to Mounting
CD-ROMs, page 400 in Appendix E,
Troubleshooting.

3 Type one of the following, depending on the installation


mode you chose and your operating system:

To run the wizard in GUI mode

for Solaris: ./setupsol.bin

for AIX: ./setupAIX.bin

For Linux: ./setupLinux.bin

To run the wizard in command line mode


for Solaris: ./setupsol.bin -console

for AIX: ./setupAIX.bin -console

For Linux: ./setupLinux.bin console

For more information on these modes of installation,


refer to Different methods of installation, page 72.

4 The MicroStrategy InstallShield Wizard opens and leads


you through the rest of the installation process. The
following sections describe the actions you need to take
for each page in the wizard.

74 Installation procedures on UNIX or Linux 2005 MicroStrategy, Inc.


Installation and Configuration Guide Installing MicroStrategy on UNIX and Linux 4

 Note the following:


To complete the installation, you must have write
permissions in the installation directory; otherwise the
installation fails.

At any time during the setup, click Cancel, or press 3


and then press ENTER, to quit the installation.

Language Setup

Page Content Options

Language selection. Enter the number associated


with the language to be used
for the installation from the
available list. If you do not
select any language, by default
English is selected.
Proceed to the next page.

Welcome

Page Content Options

Welcome statement. Proceed to the next page in the


wizard.

License Agreement

Page Content Options

License-related terms and Read the license agreement.


conditions. Select to accept or to decline
the agreement. If you choose to
decline, you cannot install
MicroStrategy products.
Click Next to proceed to the
next page.
Click Back to return to the
previous page.

2005 MicroStrategy, Inc. Installation procedures on UNIX or Linux 75


4 Installing MicroStrategy on UNIX and Linux Installation and Configuration Guide

Customer Information

Page Content Options

Prompts to specify the user name, Specify your user name,


company name, and license key. company name, and license
key.
Proceed to the next page.
Return to the previous page.

Home Directory

Page Content Options

Location where the MicroStrategy If required, specify a location


configuration files and application different from the default value.
launchers will be installed. See the following Note.
Click Next to proceed to the
next page.
Click Back to return to the
previous page.

 Note the following:


The default location is /var/opt/MicroStrategy,
or $HOME/MicroStrategy if you do not have write
access to /var/opt/MicroStrategy.

The path specified for the Home Directory is referred


to as <HOME_PATH> in this guide.
Do not change the names of folders in the product
destination, installation path, after
installing the Intelligence Server.

76 Installation procedures on UNIX or Linux 2005 MicroStrategy, Inc.


Installation and Configuration Guide Installing MicroStrategy on UNIX and Linux 4

Install Directory

Page Content Options

Location where the MicroStrategy If required, specify a location


products will be installed. different from the default value.
See the following Note.
Click Next to proceed to the
next page.
Click Back to return to the
previous page.

 Note the following:


The default location is /var/opt/MicroStrategy,
or $HOME/MicroStrategy if you do not have write
access to /var/opt/MicroStrategy.

The path specified for the Home Directory is referred


to as <HOME_PATH> in this guide.

Do not change the names of folders in the product


destination, installation path, after
installing the Intelligence Server.

Log Directory

Page Content Options

Location where the application If required, specify a location


logs will be created. different from the default value.
See the following Note.
Click Next to proceed to the
next page.
Click Back to return to the
previous page.

 Note the following:


The default location is /var/opt/MicroStrategy,
or $HOME/MicroStrategy if you do not have write
access to /var/opt/MicroStrategy.

The path specified for the Home Directory is referred


to as <HOME_PATH> in this guide.

2005 MicroStrategy, Inc. Installation procedures on UNIX or Linux 77


4 Installing MicroStrategy on UNIX and Linux Installation and Configuration Guide

Do not change the names of folders in the product


destination, installation path, after
installing the Intelligence Server.

Select Components

Page Content Options

A list of MicroStrategy products: Select the products you want to


Intelligence Server install. By default, all are
Web Universal selected.
MicroStrategy SDK Click Next to proceed to the
next page.
Click Back to return to the
previous page.

MicroStrategy Web Universal has sub components. To learn


more about them, refer to MicroStrategy Web and Web
Universal components, page 7 in Chapter 1, Introduction to
MicroStrategy.

CPU License Information

This page is displayed only if the Intelligence Server license


has a CPU number limitation.

Page Content Options

Prompt for the number of CPUs to Specify the number of CPUs to


be deployed on this computer. be deployed on this computer
or accept the default.
Click Next to proceed to the
next page.
Click Back to return to the
previous page.

78 Installation procedures on UNIX or Linux 2005 MicroStrategy, Inc.


Installation and Configuration Guide Installing MicroStrategy on UNIX and Linux 4

MicroStrategy Web Universal Install Location

This page is displayed only when the MicroStrategy Web


Universal option is selected in the Select Components page.

Page Content Options

Information about the Click Browse to change the


destination directory where the directory.
WAR file is placed. The default Click Next to proceed.
is /opt/MicroStrategy. Click Back to return to the
Browse button. previous page.

MicroStrategy Web Universal Application


Deployment

This page is displayed only when the MicroStrategy Web


Universal option is selected in the Select Components page.

If you are not deploying with WebLogic Application Server,


skip this step and click Next to proceed.

Page Content Options

Information about the location By default, the Do not


where MicroStrategy Web configure Web Universal
Universal is deployed by the deployment location check
WebLogic Application Server. box is selected. If you are
deploying with WebLogic
Application Server, clear this
check box to enable the
Browse button.
Click Browse to specify the
MicroStrategy Web Universal
deployment location.
Click Next to proceed to the
next page.
Click Back to return to the
previous page.

2005 MicroStrategy, Inc. Installation procedures on UNIX or Linux 79


4 Installing MicroStrategy on UNIX and Linux Installation and Configuration Guide

If you are deploying with WebLogic Application Server, the


Web deployment descriptor file (web.xml) for the Web
Universal WAR file has to be modified, to allow certain
configuration files used by MicroStrategy Web Universal to
be created under an absolute path. When the MicroStrategy
Web Universal application is started, several configuration
files used by the application are saved under this path. You
can specify this path under the MicroStrategy Web Universal
Deployment location.

MicroStrategy SDK Installation Location

This page is displayed only when the MicroStrategy SDK


option is selected in the Select Components page.

Page Content Options

Location of the destination Specify the path to the folder or


directory where MicroStrategy accept the default.
SDK Universal files will be Click Next to proceed to the
installed. next page.
Click Back to return to the
previous page.

Start Copying Files

Page Content Options

Current settings: Verify the information and


Products that are installed or proceed to the next page.
updated. Return to the previous page.
Directories in which the
products are installed.
Location of the installation log
file.
License details.

80 Installation procedures on UNIX or Linux 2005 MicroStrategy, Inc.


Installation and Configuration Guide Installing MicroStrategy on UNIX and Linux 4

File Transfer Complete

Page Content Options

Information about any Review the information and


problems that occurred during proceed to the next page.
installation. Return to the previous page.

Software Activation

Before the installation process ends the Software Activation


window opens.

Page Content Options

Option to automatically activate Select Yes to activate the


MicroStrategy installation via the installation.
internet. Select No to activate the
installation at a later date.

This page gives you the option to activate your MicroStrategy


product installation automatically through the Internet, or
activate it at a later date by visiting the activation web site,
https://support.microstrategy.com/activation.
If you choose to activate your installation later, you have a
grace period of thirty calendar days. If you do not complete
the activation before the grace period expires, your
MicroStrategy product stops functioning until you activate it.
If you wait to activate your installation, you receive periodic
reminders.

When the activation process is finished, you are prompted to


either view the ReadMe file, or go directly to the InstallShield
Wizard Complete page. Click Yes to read the ReadMe file and
No to go to the InstallShield Wizard Complete page.

 During installation, the following folders are created


with special privileges that are required for
MicroStrategy Web users. Changes made to these
default access privileges can create problems for
MicroStrategy Web users:

Common files\MicroStrategy\Web-INF\log.
This folder stores the Web log files, including all
errors. All Web users can write to this location.

2005 MicroStrategy, Inc. Installation procedures on UNIX or Linux 81


4 Installing MicroStrategy on UNIX and Linux Installation and Configuration Guide

Common files\MicroStrategy\Web-INF\xml.
This folder stores some of the configuration XML files,
such as AdminServers.xml and
AdminOptions.xml. The Web administrator can
add, remove, and modify the list of Intelligence
Servers to which the Web server is connected. The
Web administrator can also modify the Administrator
Preferences shared by all users.

MicroStrategy Install Wizard Complete

Page Content Options

Message confirming Select the check box to open


completion of installation. the ReadMe file in GUI mode
Check box to open the ReadMe only.
file, in GUI mode only. Select the check box to run
Check box to launch MicroStrategy Control Center in
MicroStrategy Control Center. GUI mode only.
Click Finish or press 3 to
complete the setup.

 Ifshould
the option to restart your machine appears, you
select Yes I want to restart my computer now
to restart your computer at this time to ensure that the
installation process finishes correctly.

Verifying installation
During the installation routine, the InstallShield Wizard
gathers and records information about your system and your
installation selections. You can verify the setup information
through the installation log file (install.log).

By default, the log file is located in <INSTALL_PATH> where,


<INSTALL_PATH> is the directory you specified as the install
directory in the InstallShield Wizard.

The log file includes information about the following:

Installation date

Target directory

82 Installation procedures on UNIX or Linux 2005 MicroStrategy, Inc.


Installation and Configuration Guide Installing MicroStrategy on UNIX and Linux 4

Operating system identification

Selected installation options

Selected licensing details

 This log file can be helpful if you encounter errors


during the installation process. The log file records the
reasons due to which the errors occurred.

Directory structure
The following table describes the directories in which
MicroStrategy files are installed.

PATH/Directory Contents

<HOME_PATH> Configuration files that can be modified after installation.

<HOME_PATH>/env Scripts to set up the proper environment for the


MicroStrategy applications.

<HOME_PATH>/bin Scripts to launch the MicroStrategy applications.

<INSTALL_PATH> Files that are not supposed to change after the


installation is complete.

<INSTALL_PATH>/Documentation Documentation for MicroStrategy products.

<INSTALL_PATH>/IntelligenceServer/bin Intelligence Server-specific binary files.

<INSTALL_PATH>/PDFGeneratorFiles Support files (fonts) for the PDF generation feature of


Intelligence Server.

<INSTALL_PATH>/ReleaseNotes Release notes and readme files for this release of


MicroStrategy products.

<INSTALL_PATH>/SDK Software Development Kit files. This is the default


directory for the SDK but another location can be selected
during installation.

<INSTALL_PATH>/WebUniversal Web Universal deployment path. This is the default


directory for Web Universal, but it can be changed during
installation.

<INSTALL_PATH>/_jvm The Java Runtime Environment (JRE) to be used by the


Java applications. It provides the requirements for
executing a Java application, a Java Virtual Machine,
core classes, and supporting files.

<INSTALL_PATH>/_uninst Launch files for uninstalling MicroStrategy Universal.

<INSTALL_PATH>/bin 64-bit binary files.

2005 MicroStrategy, Inc. Installation procedures on UNIX or Linux 83


4 Installing MicroStrategy on UNIX and Linux Installation and Configuration Guide

PATH/Directory Contents

<INSTALL_PATH>/bin32 32-bit binary files.

<INSTALL_PATH>/help Online help files.

<INSTALL_PATH>/jar Java libraries.


<INSTALL_PATH>/lib 64-bit binary libraries.

<INSTALL_PATH>/lib32 32-bit binary libraries.

<INSTALL_PATH>/locale ODBC support messages. The ODBC drivers are copied


to /lib32.

<LOG_PATH> MicroStrategy application log files.

<LOG_PATH>/IntelligenceServer Intelligence Server log files.

Directory structure after deploying the WAR file

The following table shows the default directory structure


after deploying the WAR file in your application server.

Directory Contents

\help Help and descriptor


files.

\images All image files.

\javascript Interface JavaScript


files.

\jsp Interface JSP code


files.

\style Interface style files.


\WEB-INF Configuration
information for
MicroStrategy Web.

\WEB-INF\classes All resource files.

\WEB-INF\lib All library files.


\WEB-INF\log All log files, except for
ncsportal.log files.
They are created in
the application server
root folder.

84 Installation procedures on UNIX or Linux 2005 MicroStrategy, Inc.


Installation and Configuration Guide Installing MicroStrategy on UNIX and Linux 4

Directory Contents

\WEB-INF\tlds All Tag Library


Descriptor files.

\WEB-INF\xml All Web xml and xsl


files.

Next steps
After the installation is complete, you are ready to configure
the MicroStrategy components you have installed. This
ensures that the software can be used immediately.

If there are no project sources defined, then MicroStrategy


Control Center opens the Configuration Wizard. To learn
about the Configuration Wizard, see Using the
MicroStrategy Configuration Wizard, page 89 in Chapter 5,
Configuring MicroStrategy Intelligence Server in this guide.

After you have installed MicroStrategy Web Universal, you


can deploy and configure it for your specific environment.
The configuration and deployment steps are provided in
Chapter 8, Configuring and Deploying MicroStrategy Web
Universal. The table below lists the steps for all
environments.

High-Level Deployment Steps

1 Log on to the application server by using the proper user name and
password.
2 Locate the MicroStrategy.war file. It is located in the Web
Universal Deployment Directory you specified during installation.
3 To increase the performance of the application and before
proceeding with the deployment, see the Performance-based setup
information section, if available, for your environment and configure
as necessary. Also, after deploying Web Universal on your
machine, there may be a few performance-based setup steps that
you should complete.
4 Choose the desired deployment method.
5 Follow the deployment procedure.
6 Log on to the MicroStrategy Web Administrator Page.
7 Launch MicroStrategy Web.
8 Start working with the application.

2005 MicroStrategy, Inc. Next steps 85


4 Installing MicroStrategy on UNIX and Linux Installation and Configuration Guide

For details on deploying MicroStartegy Web Universal with


different application and web servers on UNIX, see the
following sections:

To deploy with WebLogic and Apache, see Deploying with


WebLogic and Apache, page 140 in Chapter 8,
Configuring and Deploying MicroStrategy Web
Universal.

To deploy with WebSphere and IBM HTTP Server, see


Deploying with WebSphere 5.x and IBM HTTP Server,
page 165 in Chapter 8, Configuring and Deploying
MicroStrategy Web Universal.

To deploy with Sun ONE (iPlanet), see Deploying with


Sun ONE (iPlanet) 8.0, page 179 in Chapter 8,
Configuring and Deploying MicroStrategy Web
Universal.

86 Next steps 2005 MicroStrategy, Inc.


5
5. CONFIGURING
MICROSTRATEGY
INTELLIGENCE SERVER

Introduction

After installing MicroStrategy, you must complete a few


configuration tasks. This chapter addresses the processes
used to configure an installed MicroStrategy suite of products
using the MicroStrategy Configuration Wizard.

 The MicroStrategy platform includes a Tutorial


project, which is a sample data warehouse and a
demonstration project you can use to learn about the
various features that MicroStrategy offers. It is ready
to be used and requires no additional configuration
tasks. If you want to set up a new system using your
own data, you must read this chapter and perform the
tasks it describes.

This chapter includes the following sections:

Configuration prerequisites

Using the MicroStrategy Configuration Wizard

2005 MicroStrategy, Inc. 87


5 Configuring MicroStrategy Intelligence Server Installation and Configuration Guide

Configuration prerequisites
Before you begin using the Configuration Wizard you should
satisfy the following requirements:

Install the necessary MicroStrategy products. You should


have at least MicroStrategy Desktop and MicroStrategy
Intelligence Server installed. For information on how to
install MicroStrategy on Windows, see Chapter 3,
Installing MicroStrategy on Windows. For information
on how to install MicroStrategy on other operating
systems, see Chapter 4, Installing MicroStrategy on
UNIX and Linux.

Have access to an empty database location certified to


house the metadata. For a list of certified metadata
platforms, see the MicroStrategy platform readme file.

 MicroStrategy products must be configured on the


machine on which they are installed. You cannot
configure them remotely.

88 Configuration prerequisites 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring MicroStrategy Intelligence Server 5

Using the MicroStrategy Configuration Wizard


The MicroStrategy Configuration Wizard automates much of
the configuration process, prompting you only when critical
information is required. With this tool, you can configure
metadata repository and statistics tables, MicroStrategy
Intelligence Server, and multiple project sources.

If you are configuring using the Windows operating system,


you must have administrative privileges on the computer in
which the Intelligence Server is installed, so that you can set
the parameters necessary to start the Intelligence Server and
invoke server-definition objects.

You can set up the MicroStrategy Configuration Wizard to


work in silent or unattended mode, by clicking Advanced on
the Welcome page. This opens the Advanced Options page. It
uses a response file to run automated installations from local
or remote locations. For more information, refer to
Configuring a response.ini file for the Configuration
Wizard, page 257, in Chapter 10, Automated Installation
and Configuration on Windows, or refer to Configuring
through command line mode, page 279, in Chapter 11,
Automated Installation and Configuration on UNIX.

 After completing any of the three main configuration


tasks, Metadata Repository and Statistics Tables,
MicroStrategy Intelligence Server, and Project
Sources, a check mark appears besides the option and
the next option is selected.

Overview of the MicroStrategy Configuration Wizard


The MicroStrategy Configuration Wizard opens
automatically after you install MicroStrategy products and
restart your machine. The MicroStrategy Configuration
Wizard allows you to configure

Metadata repository and statistics tables

Intelligence Server

Project Sources

2005 MicroStrategy, Inc. Using the MicroStrategy Configuration Wizard 89


5 Configuring MicroStrategy Intelligence Server Installation and Configuration Guide

Metadata repository and statistics tables

The metadata consists of tables that contain the definitions


for nearly all MicroStrategy objects, including database
logins, server definitions, database instances and
connections, reports, metrics, facts, and so on. The metadata
repository or database contains information that facilitates
the transfer of data among MicroStrategy applications and
between MicroStrategy applications and the data warehouse.
MicroStrategy applications use the metadata database to
transform user requests into SQL queries and translate the
results of those queries back into MicroStrategy objects, such
as reports and documents. It is mandatory to have a metadata
repository to which an Intelligence Server can connect.

Statistics tables are used to record a variety of statistical


information about the usage and performance of a
MicroStrategy system. You can set which statistics are
recorded in the statistics tables and use MicroStrategy
Enterprise Manager, which is a part of the MicroStrategy
Administrator product, to analyze the data and locate
opportunities for system performance tuning. For more
information about the statistics tables and Enterprise
Manager, refer to the MicroStrategy System Administration
Guide.

MicroStrategy Intelligence Server

The MicroStrategy Intelligence Server requires a server


definition to run. A server definition is a MicroStrategy
object stored in the metadata repository. It contains
information about the configuration of Intelligence Server,
such as governing settings, which projects should be loaded,
which communication protocols should be used, and so on.

Before you can use the MicroStrategy Intelligence Server, you


must determine from the MicroStrategy Configuration
Wizard the server definition that the Intelligence Server
should use.

 Many server definitions can exist in the metadata, but


you can install only one Intelligence Server on one
server machine and MicroStrategy Intelligence Server
uses only one server definition at a time.

90 Using the MicroStrategy Configuration Wizard 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring MicroStrategy Intelligence Server 5

Project Sources

The highest level icon in the Folder List of MicroStrategy


Desktop is the project source. Project sources are the highest
level objects in the MicroStrategy environment and represent
a connection to a metadata database or a MicroStrategy
Intelligence Server. The project source stores the location of
the metadata repository or the MicroStrategy Intelligence
Server definition that is used to run the project. Through a
project source you can create, manipulate, and administer
MicroStrategy projects.

 Note the following:


For WindowsProject Source is available only if the
Desktop product is installed on the machine.

For UNIXProject Source is available only if


MicroStrategy Control Center exists. Control Center
allows you to configure project sources.

Configuring MicroStrategy software

You can configure a 3-tier or a 2-tier setup for MicroStrategy.


The following figure describes how to configure
MicroStrategy to suit a 3-tier environment. It also shows how
the various components of the MicroStrategy Configuration
Wizard, the Metadata Repository, the Intelligence Server,
and the Project Source interact with each other.

2005 MicroStrategy, Inc. Using the MicroStrategy Configuration Wizard 91


5 Configuring MicroStrategy Intelligence Server Installation and Configuration Guide

The following figure describes how to configure


MicroStrategy to suit a 2-tier environment. It also shows how
the various components of the MicroStrategy Configuration
Wizard, the Metadata Repository and the Project Source
interact with each other.

 Itproduction
is not recommended to use a 2-tier setup for the
environment.

The following are the high-level steps to configure


MicroStrategy software through the Configuration Wizard.

92 Using the MicroStrategy Configuration Wizard 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring MicroStrategy Intelligence Server 5

To configure MicroStrategy through the Configuration Wizard

1 If you are installing MicroStrategy on Windows:

On the Windows Start menu, point to Programs, then


to MicroStrategy, and then choose Configuration
Wizard. The Configuration Wizard opens with the
Welcome page displayed.

If you are installing MicroStrategy on UNIX:

In a UNIX console window, browse to <HOME_PATH>


where <HOME_PATH> is the directory you specified as
the home directory during installation. Browse to the
folder bin and type ./mstrcfgwiz, then press
ENTER. The MicroStrategy Configuration Wizard
opens with the Welcome page displayed.

2 Choose from the following configuration tasks and click


Next to begin the selected task.
Metadata Repository and Statistics Tables: runs the
SQL scripts necessary to create and initialize the
metadata and statistics tables in the database location
you select.

 When you create a metadata repository, a 3-tier


project source is automatically created.

Set up MicroStrategy Intelligence Server: allows


you to create a new server definition object in the
metadata repository you select. This setup provides
3-tier access to all projects that are stored in the
repository. This option also lets you link to or delete an
existing server definition. You must specify a port
number to be used by the Intelligence Server.

2005 MicroStrategy, Inc. Using the MicroStrategy Configuration Wizard 93


5 Configuring MicroStrategy Intelligence Server Installation and Configuration Guide

Project Sources: A project source contains the


configuration information that each client requires to
access an existing project. It stores the location of the
metadata repository and MicroStrategy Intelligence
Server that is used to run the project. Hence, a project
source determines how the Desktop product accesses
the metadata.

For WindowsProject Source is available only if the


Desktop product is installed on the machine.

For UNIXProject Source is available only if


MicroStrategy Control Center exists. Control Center
allows you to configure project sources.

 When you create a metadata repository, a 3-tier


project source is automatically created. You can
use this option, Project Sources, to create multiple
project sources for your project, or to create a 2-tier
project source.

The remainder of this chapter describes each configuration


option in detail.

After completing these steps, an empty metadata repository


is created. To learn how to add projects to your metadata
repository, refer to Creating a project using MicroStrategy
Desktop, page 120 in Chapter 6, Creating a Project.

For information about advanced configuration functionality


on Windows, such as configuring in an SMS environment or
using configuration response files, see Chapter 10,
Automated Installation and Configuration on Windows.

For information about advanced configuration functionality


on UNIX, such as using configuration response files for
automated configuration, see Configuring through
command line mode, page 279 in Chapter 11, Automated
Installation and Configuration on UNIX.

94 Using the MicroStrategy Configuration Wizard 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring MicroStrategy Intelligence Server 5

Creating a metadata repository and statistics tables


The general configuration process for creating a metadata
repository and statistics tables is as follows:

 Itrepository
is recommended that you create the metadata
and the statistics tables in different
databases to ensure enhanced performance.

To create metadata repository and statistics table

1 Select a data source name (DSN) that points to the


database in which to create the metadata repository or
statistics tables.

2 Verify that the ODBC driver used to connect to the


database is MicroStrategy certified.

 For information on ODBC, Appendix B, ODBC and


DSNs.

3 Select the SQL scripts to use for creating your metadata


repository or statistics tables.

ODBC drivers and validation

The validation process verifies the selected database driver


used by the DSN you chose in the first step.

MicroStrategy software ships with a current list of


MicroStrategy-branded ODBC drivers, that is, drivers that
are certified to work with MicroStrategy products. If the
driver you are using is found to be invalid, the system returns
a message that the driver is invalid and a comparison of the
selected driver and a certified driver is displayed.

See the MicroStrategy readme file for details about supported


and certified ODBC drivers. To access the MicroStrategy
readme files:

On Windows: Go to the Start menu, point to Programs,


then to MicroStrategy, and then choose ReadMe.

2005 MicroStrategy, Inc. Using the MicroStrategy Configuration Wizard 95


5 Configuring MicroStrategy Intelligence Server Installation and Configuration Guide

On UNIX: In the UNIX File Manager, browse to


<INSTALL_PATH>, where <INSTALL_PATH> is the
directory you specified as the install directory during
installation, and double-click the ReadMe.htm file.

 Note the following:


Although it is possible to use a non-certified driver, it
is strongly recommended that you contact your
database vendor to obtain a certified driver if the
selected driver is not certified as valid.

MicroStrategy products include certified ODBC


drivers for you to use. The MicroStrategy General
Information Readme lists these MicroStrategy ODBC
drivers and recommended database connection
settings for them. MicroStrategy ODBC drivers only
work with MicroStrategy products.

SQL scripts

MicroStrategy has database-specific SQL scripts for creating


metadata and statistics tables. The scripts for each certified
database platform are shipped with the product. The
MicroStrategy Configuration Wizard automatically selects a
default script based on your ODBC drivers database
platform.

 You must change from the default script only if a


double-byte script or a custom script is required.

By default, all the scripts reside in the directory where you


installed MicroStrategy and are identified by the .sql
extension. It is highly recommended that no edits be
performed on these scripts, except on rare occasions and only
by skilled database personnel.

96 Using the MicroStrategy Configuration Wizard 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring MicroStrategy Intelligence Server 5

Metadata repository and statistics tables

The Metadata Repository and Statistics Tables option on


the Configuration Wizard provides the following selections to
start configuring a metadata repository:
Create Metadata Tables

Create Default Configuration

Create Statistics Tables

Create Default Project Source (2 Tier with Standard


Authentication)

The following sections provide details about each of these


options.

Create metadata tables

The Create Metadata Tables option lets you create


MicroStrategy metadata tables. If you choose this option, you
can create the metadata repository in the database location of
your choice. Additionally, a default configuration is created in
the tables. This populates the tables with the basic data
required for the MicroStrategy metadata, such as the default
project folder structure and some basic connection
information.

To create metadata tables

1 Select Metadata Repository and Statistics Tables and


click Next.

2 Select the Create Metadata Tables check box and click


Next.

3 Select to configure the repository in either an ODBC


database or in a Microsoft Access database.

2005 MicroStrategy, Inc. Using the MicroStrategy Configuration Wizard 97


5 Configuring MicroStrategy Intelligence Server Installation and Configuration Guide

 Although it is possible to use the Microsoft Access


database for the metadata repository, it is not a
suitable metadata repository for a production project.
You should not use Microsoft Access for anything
other than a proof-of-concept or demonstration type
of application.

Creating repository in an ODBC database

4 Select an existing ODBC DSN from the drop-down list and


specify a user name and password. You can also click New
to create a new DSN, and MD Prefix if you want to specify
a metadata table prefix.

5 If you click New, choose the SQL script for creating the
metadata by accepting the default, or browse to select the
SQL script and click Finish. It is recommended that you
select the default SQL script.

6 Click Next, review the summary information, and click


Finish to create the metadata repository.

For more information on creating DSNs, Appendix B, ODBC


and DSNs.

Create default configuration

This option lets you create the default configuration for the
MicroStrategy metadata. It is disabled if Create Metadata
Tables is selected because the process of creating the default
configuration occurs automatically when the Create
Metadata Tables check box is selected.

The default configuration populates the metadata tables with


the basic necessities required for the MicroStrategy
metadata, such as the default project folder structure and
some basic connection information.

You must select the Create Default Configuration check box


if you have created empty metadata tables outside the
Configuration Wizard using a custom SQL script. You must
do this to initialize the metadata with a default configuration.
It is not recommended to create empty metadata tables
outside the Configuration Wizard.

98 Using the MicroStrategy Configuration Wizard 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring MicroStrategy Intelligence Server 5

To create a default configuration

1 Select Metadata Repository and Statistics Tables and


click Next.

2 Select the Create Default Configuration check box and


click Next.

 You must clear the Create Metadata Tables check


box to enable this check box.

3 Select to configure the repository in either an ODBC


database or a Microsoft Access database.

 Although it is possible to use the Microsoft Access


database for the metadata repository, it is not a
suitable metadata repository for a production project.
You should not use Microsoft Access for anything
other than a proof-of-concept or demonstration type
of application.

Creating a repository in an ODBC database

4 Choose an ODBC DSN and provide a user name and


password.
To specify a metadata table prefix, you can click New to
create a new DSN and MD prefix.

5 Click Next, review the summary information, and click


Finish to create the default configuration.

 Note the following:


If MicroStrategy metadata tables are not present in the
database location you specified, you are prompted to
create them. Click Yes to create the metadata tables,
or click No to cancel.

If a configuration is already present in the database


location you specified, you are prompted to overwrite
it. Click Yes to overwrite the existing configuration or
click No to cancel.

2005 MicroStrategy, Inc. Using the MicroStrategy Configuration Wizard 99


5 Configuring MicroStrategy Intelligence Server Installation and Configuration Guide

Create statistics tables

The Create Statistics Tables option lets you create


MicroStrategy statistics tables in the database of your choice.
These tables are used to maintain and monitor system
activity. You can run MicroStrategy Enterprise Manager
against the statistical information to analyze and interpret
the statistics.

To create statistics tables

1 Select Metadata Repository and Statistics Tables and


click Next.

2 Select the Create Statistics Tables check box, and click


Next.

3 Select to configure the repository in either an ODBC


database or in a Microsoft Access database.

 Although it is possible to use the Microsoft Access


database for the statistics tables, it is not suitable for a
production project. You should not use Microsoft
Access for anything other than a proof-of-concept or
demonstration type of application.

Creating repository in an ODBC database

4 Select an ODBC DSN from the drop-down list, and


provide a user name and password.
You can click New to create a new DSN.

5 If you click New, choose the SQL script for creating the
statistics tables by accepting the default, or browse to
select the SQL script and click Finish. It is recommended
that you select the default SQL script.

6 Click Next, review the summary information, and click


Finish to create the default configuration.

100 Using the MicroStrategy Configuration Wizard 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring MicroStrategy Intelligence Server 5

Create default project source (2-tier with


standard authentication)

When you create a metadata repository a 3-tier project source


is automatically created. To create a 2-tier project use the
option, default project source (2-tier with standard
authentication), to access your MicroStrategy metadata.
Enter the name of the project source to be created in the
Project Source Name box, or use the default name of New
Project Source.

 Note the following:


This option is intended to be used in conjunction with
one or more of the other available options. If you want
to simply create a new project source, use the Project
Sources option on the Welcome page of the
Configuration Wizard. For information on project
sources, see Project Sources, page 108.

For more information about authentication modes,


refer to the MicroStrategy System Administration
Guide.

Configuration messages

Depending on the selected ODBC database, different


messages might be displayed prompting you to complete the
configuration successfully. Two examples of messages that
require action are as follows:
An existing Metadata Repository
configuration was found at this location.
Continuing will remove all existing
metadata objects. Are you sure you want to
continue?

This message is displayed if the Configuration Wizard


detects an existing metadata repository in the database
location you specified.

 Ifmetadata
you continue, all information in the existing
repository is overwritten.

2005 MicroStrategy, Inc. Using the MicroStrategy Configuration Wizard 101


5 Configuring MicroStrategy Intelligence Server Installation and Configuration Guide

No Metadata Tables are defined, would you


like to create them?

This message is displayed if there is no existing metadata


repository and you have not chosen to create one.

The messages are displayed if there are conflicts or some


requirements are not met. These messages help you resolve
the conflicts and lead you through the configuration process.

Setting up the MicroStrategy Intelligence Server


You use the Configuration Wizard to create, link, or delete
server definitions that are stored in the metadata repository.
The following list describes these options in detail:

Create: When you create a new server definition in the


metadata repository of your choice, all its parameters are
set as default. Creating a new server definition creates an
entry in the machines configuration file that points to the
metadata. This is used by MicroStrategy Intelligence
Server at startup. You can modify a server definition using
MicroStrategy Intelligence Server Administrator. For
information on MicroStrategy Intelligence Server
Administrator, refer to the MicroStrategy System
Administration Guide.

Link: You link a server definition of your choice to


MicroStrategy Intelligence Server. When you use the
MicroStrategy Configuration Wizard to link to a server
definition different from the existing one, you are
changing the machines configuration information to
point to a different server definition, which can be in an
entirely different metadata.
Delete: When you delete a server definition, you are
deleting the server definition object from the metadata
repository, but not from the MicroStrategy Intelligence
Server software that you installed.

 You must run the Configuration Wizard locally on the


Intelligence Server machine. You cannot create, link,
or delete server definitions remotely.

102 Using the MicroStrategy Configuration Wizard 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring MicroStrategy Intelligence Server 5

If you create a new server definition or link to an existing one,


you can load the projects to use with the server definition
from within the Configuration Wizard.

If the password to the metadata has changed in the database,


use the Connect to Metadata Repository page in the
MicroStrategy Configuration Wizard to update your
password.

The MicroStrategy Configuration Wizard provides the


following pages to manage server definitions:

Connect to metadata repository


User authentication

Create, link, or delete a server definition

Specify a port number

Select projects

The following sections provide details about each of these


options.

Connect to metadata repository

On the MicroStrategy Configuration Wizard, click Setup


MicroStrategy Intelligence Server to access the Connect to
Metadata Repository page. On this page, select the ODBC
Data Source Name (DSN) to use when connecting to the
metadata repository.

Selecting the ODBC DSN Driver execution mode

1 Select MicroStrategy Intelligence Server and click Next.

2 Select an ODBC DSN from the drop-down list and specify


a user name and password.

You can click the following:

New to create a new DSN

2005 MicroStrategy, Inc. Using the MicroStrategy Configuration Wizard 103


5 Configuring MicroStrategy Intelligence Server Installation and Configuration Guide

MD Prefix if you want to specify a metadata table


prefix

Temp Table Prefix to specify a prefix for the


temporary tables used by the server definition

 Although it is possible to use the Microsoft Access


database for the metadata repository, it is not a
suitable metadata repository for a production project.
You should not use Microsoft Access for anything
other than a proof-of-concept or demonstration type
of application.

You can only configure your database instance to be in


multiprocess mode as all available ODBC drivers are 32-bit
and Intelligence Server processes are 64-bit. Multithreaded
mode is not available. The following note provides a short
explanation of multiprocess execution mode.

 Amemory
process is a running executable that resides in a
space and uses operating system resources.
An application can consist of one or several processes.
Each process owns an address space which is not
shared with other processes. If one process fails, the
others are not affected. This tends to make
multiprocess applications more robust and stable than
single process applications at the expense of overhead
in memory space and increased resources.

User authentication

After you connect to a metadata repository, click Next in the


Configuration Wizard to access the User Authentication page.
In this page you specify the username and password for the
MicroStrategy user to access the metadata to create, link, or
delete server definitions. By default, the username is
Administrator and it has no password. If you are setting up
the MicroStrategy Intelligence Server for the first time, use
the default username and password.

104 Using the MicroStrategy Configuration Wizard 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring MicroStrategy Intelligence Server 5

 For security reasons, you should change the


Administrator username and password as soon as
possible after you initially configure the system. Refer
to the MicroStrategy System Administration Guide
for details about passwords and other user
management information.

To authenticate a user

1 Accept the default user name and password, if you are


setting up MicroStrategy Intelligence Server for the first
time. For subsequent uses specify an appropriate
administrative user name and password.

2 Click Next to perform the authentication and access the


Create, Link, or Delete a Server Definition page.

Create, link, or delete a server definition

After you specify the user name and password for the user,
click Next to access Create, Link, or Delete a Server
Definition page. From this page, you can create a new server
definition, link to an existing server definition, or delete a
current server definition. The steps to create, link, or delete a
server definition are as follows.

To create a new server definition

1 Select Create New Server Definition.

2 Specify a name in the Server Definition Name text box,


which defaults to the name of the machine, and click
Next.

3 Click Yes or No to accept or reject the new server


definition as the default server definition. If you click Yes,
this server definition is used by MicroStrategy
Intelligence Server when it starts. If you click No, this
server definition is not used by MicroStrategy Intelligence
Server when it starts.

2005 MicroStrategy, Inc. Using the MicroStrategy Configuration Wizard 105


5 Configuring MicroStrategy Intelligence Server Installation and Configuration Guide

To link to an existing server definition

1 Select Use Selected Server Definition.

2 Select an appropriate server definition from the list of


existing server definitions and click Next.

To delete a server definition

1 Select Delete Selected Server Definition.

2 Select the server definition to delete from the list of


existing server definitions, and click Next.

3 Read the summary information and click Yes to confirm


the deletion.

Specify a port number

After you create or link to an existing server definition, click


Next to access the Port Number page. In this page you can
use the default port number or specify another port number.
If the port number is used by another process, for example in
a shared environment, specify a free port number. For
instructions on how to find an available port number, see
Port number is in use, page 403 in Appendix E,
Troubleshooting, Troubleshooting.

To specify a port number

1 Specify a port number if required, or use the default port


number of MicroStrategy Intelligence Server, which is
34952.

2 Click Next to continue.

106 Using the MicroStrategy Configuration Wizard 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring MicroStrategy Intelligence Server 5

Select projects

After you specify a port number, click Next to access the


Select Projects page. This page displays all the projects that
are in the metadata repository. You can select projects to use
with the server definition you have chosen. The projects you
select are loaded on the server at startup.

To select projects

1 Select or clear the check boxes for each project to use with
this server definition and click Next.

2 Read the summary information and click Finish to create


the new server definition or to assign the selected server
definition to the Intelligence Server. You are prompted to
stop the Intelligence Server service.

3 When the new server definition is created, you are


prompted to restart the Intelligence Server service.

If you create a new server definition, it is displayed in the


list of existing server definitions for that metadata.

If you assigned an existing server definition to the


Intelligence Server and the existing project source uses
this server, a related message is displayed.

Starting, stopping, and restarting the server

The primary function of the Service Manager is to provide a


way to start and stop Intelligence Server. For additional
information, refer to the MicroStrategy System
Administration Guide.

2005 MicroStrategy, Inc. Using the MicroStrategy Configuration Wizard 107


5 Configuring MicroStrategy Intelligence Server Installation and Configuration Guide

Project Sources
When you create a metadata repository, by default it creates a
3-tier project source. Hence use the option, Project Sources,
if you need to create multiple project sources or a 2-tier
project source.

The different types of project sources are:

Direct project sources that connect directly to the


metadata through ODBC.

Server project sources that connect to the metadata


through an Intelligence Server.

 Note the following:


For WindowsProject Source is available only if the
Desktop product is installed on the machine.

For UNIXProject Source is available only if


MicroStrategy Control Center exists. Control Center
allows you to configure project sources.

Direct (2-tier)

A 2-tier project source is used to connect directly to the


metadata repository using ODBC DSN.

Connecting to a Direct (2-tier) project source

1 Select Project Sources on the Configuration Wizard, and


click Next.

2 Type a Project Source Name. Select Direct (2-tier) as the


Connection Type, and click Next.

3 Choose the ODBC DSN that points to the metadata


containing the MicroStrategy projects to access. Specify a
user name and password, and click Next.

You can also click New to create a new DSN and click MD
Prefix to specify a metadata table prefix if necessary.

108 Using the MicroStrategy Configuration Wizard 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring MicroStrategy Intelligence Server 5

4 Select the authentication mode for the project source and


click Next. For more information about authentication
modes, refer to the MicroStrategy System
Administration Guide.

5 Review the summary information and click Finish to


create the project source.

MicroStrategy Intelligence Server (3-tier)

A 3-tier project source is used to connect to the metadata


using the MicroStrategy Intelligence Server.

Connecting to a MicroStrategy Intelligence Server (3-tier)


project source

1 Select Project Sources and click Next.

2 Type a Project Source Name. Choose the MicroStrategy


Intelligence Server (3-tier) option and click Next.

3 Specify the name and port number for the Intelligence


Server to which to connect the project source, and click
Next. See the following note regarding the port number.

 The port number is how the Intelligence Server


process identifies itself on the server on which it is
running. When the Intelligence Server receives a
network call from a client, that is, Desktop, Web, and
so on, it forwards those calls to the Intelligence Server
port number that is specified in the call.
The default port number for MicroStrategy
Intelligence Server is 34952. When it is set to 0, it
takes the default value of 34952. However, if you use a
non-default port number, this number must be
provided while connecting through MicroStrategy
Desktop.

4 Select the authentication mode to be used for the project


source and click Next. For more information about
authentication modes, see the MicroStrategy System
Administration Guide.

2005 MicroStrategy, Inc. Using the MicroStrategy Configuration Wizard 109


5 Configuring MicroStrategy Intelligence Server Installation and Configuration Guide

5 Review the summary information and click Finish to


create the project source.

Next steps
Now you have configured MicroStrategy and are ready to
create a project. There are various ways to create a project to
get your MicroStrategy project started. The different methods
to create a project are described in Chapter 6, Creating a
Project.

 The MicroStrategy platform provides a Tutorial


project, which is a sample data warehouse and
demonstration project you can use to learn about the
various features that MicroStrategy offers. It is ready
to be used and requires no additional configuration
tasks. To use the MicroStrategy Tutorial, refer to the
MicroStrategy Basic Reporting Guide for more
information. However, if you want to create a new
project using your own data, you must read Chapter 6,
Creating a Project in detail and perform the tasks it
describes.

110 Next steps 2005 MicroStrategy, Inc.


6
6. CREATING A PROJECT

Introduction

There are several methods for creating a project and editing a


project. This chapter introduces you to the overall process of
building a MicroStrategy project. It also provides definitions
for the MicroStrategy Desktop components that are essential
for creating a project.

 You may choose not to create your own project at this


stage but use the MicroStrategy Tutorial for learning
purposes. The Tutorial has already been created and
configured for you.

This chapter includes the following sections:

MicroStrategy Desktop definitions

Creating a project using Project Builder

Creating a project using MicroStrategy Desktop

MicroStrategy project schema

2005 MicroStrategy, Inc. 111


6 Creating a Project Installation and Configuration Guide

MicroStrategy Desktop definitions


This section defines some of the basic terminology used in
project creation in MicroStrategy Desktop.

MicroStrategy metadata
MicroStrategy metadata is stored in a relational database
with a predefined structure, which MicroStrategy has
designed. The RDBMS for the metadata and warehouse do
not need to be the same. All schema objects, application
objects, configuration objects, and project settings are stored
in the metadata.

 You can find the list of supported RDBMS platforms in


the Readme file that installs with MicroStrategy
products. By default, the Readme file can be found in
C:\Program Files\Common
Files\MicroStrategy\readme.htm.

Metadata shell
Before you can populate the metadata database with data, the
necessary tables must be present. The metadata shell refers
to the set of blank tables that are created when you initially
implement a MicroStrategy business intelligence
environment.

You create the metadata shell with the MicroStrategy


Configuration Wizard, which creates the necessary tables and
also populates some tables with basic initialization data.

112 MicroStrategy Desktop definitions 2005 MicroStrategy, Inc.


Installation and Configuration Guide Creating a Project 6

MicroStrategy objects
Project creation and navigation in MicroStrategy is generally
handled through the creation and use of various types of
objects. You can build and manipulate three fundamentally
different kinds of objects in MicroStrategy:

Configuration objectsObjects built by a project architect


or administrator. These objects are not used directly for
reporting, but rather they serve to provide important
information or governing parameters for connectivity,
user privileges, and project administration. As a general
rule, configuration objects are built and manipulated with
MicroStrategy Desktop or the managers that are
accessible from within the Administration icon in
MicroStrategy Desktop. A database instance or user are
examples of configuration objects.

Schema objectsObjects that are built in the application


to correspond to database objects, such as tables, views,
and columns. MicroStrategy Desktop is used to build and
manipulate schema objects such as facts, attributes,
hierarchies, and other objects in the Schema Objects
folder in MicroStrategy Desktops folder list.

Application objectsObjects built or manipulated using


MicroStrategy Desktop. The definition of application
objects such as reports, filters, metrics, and prompts are
derived from schema objects.

Project source
The project source configuration object is the highest-level
MicroStrategy object that exists. It appears in the folder list
and represents a connection to a metadata database. This
connection is achieved in one of two ways:

Direct or 2-tier modeConnects to the metadata by


specifying a DSN, login, and password to a metadata
database.

 Itproduction
is not recommended to use a 2-tier setup for the
environment.

2005 MicroStrategy, Inc. MicroStrategy Desktop definitions 113


6 Creating a Project Installation and Configuration Guide

Server or 3-tier mode Connects to the metadata by


pointing to an Intelligence Server definition, which in
turn governs and validates the connection to the
metadata.

After the connection to the metadata is established, every


object definition you create within this project source is
stored in this metadata. This includes application objects,
schema objects, and configuration objects from any number
of projects defined within this project source.

Database instance
The database instance is a configuration object that
represents a connection to a data warehouse. When you
define a project, you specify the data warehouse location by
selecting a database instance with the appropriate connection
parameters.

Project
A project is the intersection of a data warehouse, metadata
repository, and the user community. It is the highest-level
object in the MicroStrategy reporting environment. A project
is where you build and store all schema objects and
information you require to create an application, which
together provide for a flexible reporting environment. A
project
Determines the set of warehouse tables to be used, and
therefore the set of data available to be analyzed.

Contains all schema objects used to interpret the data in


those tables. Schema objects include facts, attributes,
hierarchies, and so on.

Contains all reporting objects used to create reports and


analyze the data. Reporting objects include metrics,
filters, reports, and so on.

114 MicroStrategy Desktop definitions 2005 MicroStrategy, Inc.


Installation and Configuration Guide Creating a Project 6

defines the security scheme for the user community that


accesses these objects to operate. Security objects include
security filters, security roles, privileges, access control,
and so on.

 Many of the schema objects and reporting objects are


discussed in the MicroStrategy Basic Reporting
Guide and in the MicroStrategy Advanced Reporting
Guide. Security and other project-level administrative
features are discussed in the MicroStrategy System
Administration Guide.

A project can contain any number of reports in addition to a


number of other objects that support simple and advanced
reporting requirements. The objects include filters, prompts,
and metrics. Conceptually, the project is simply the
environment in which all related reporting is done.

For information on database instances, see the


MicroStrategy System Administration Guide.

Some key concepts to understand before you begin creating a


project are as follows:

A project is created within a specified metadata


repository, determined by the project source through
which you create the project.

The projects warehouse location is specified by


associating it with the appropriate database instance.

For information on project sources, see Project Sources,


page 108.

 With MicroStrategy 8.0, you can create OLAP cube


reports using data from SAP BW. For detailed
information on how to set up the SAP BW project,
refer to Creating OLAP cube reports in the
MicroStrategy Advanced Reporting Guide and the
MicroStrategy online help.

For information on how to use your own customized


SQL statements to create reports, see the Creating
Freeform SQL reports chapter in the MicroStrategy
Advanced Reporting Guide.

2005 MicroStrategy, Inc. MicroStrategy Desktop definitions 115


6 Creating a Project Installation and Configuration Guide

Now that you understand the MicroStrategy metadata, the


project source, the database instance, and the project, you
can begin to build an understanding of how these various
pieces work together to provide an integrated business
intelligence environment as shown in the following diagram:

Language display of a project

Projects that use single-byte interfaces create autostyles with


fonts that are incompatible with double-byte characters.
Autostyles are predefined formatting styles that allow you to
standardize formatting among reports. For example, you
create a project in MicroStrategy Desktop using the English
interface, which is a single-byte language, and then you use a
Chinese interface that is a double-byte language, you can see
Chinese characters on the MicroStrategy Desktop. However,
if you export a report to PDF, the PDF uses autostyle fonts
that are in English and loses the Chinese characters.

For more information on autostyles refer to Report


Manipulation Essentials in the Basic Reporting Guide.

116 MicroStrategy Desktop definitions 2005 MicroStrategy, Inc.


Installation and Configuration Guide Creating a Project 6

When you create a new project or update the metadata, a


language check ensures that the language settings in the
CURRENT_USER registry key, the LOCAL_MACHINE
registry key, and the Project locale property match before an
update takes place. The system performs the following
checks:

In a 2-tier configuration, it checks that the language under


the LOCAL_MACHINE registry key matches the language
under the CURRENT_USER registry key.
In a 3-tier configuration, it checks that the language under
the CURRENT_USER registry key on the client machine
matches the language under the LOCAL_MACHINE
registry key on the server machine.

The MicroStrategy interface obtains the language


information from the CURRENT_USER registry key and the
server obtains the language information from the
LOCAL_MACHINE registry key. This can lead to
inconsistencies in the language display. The language check
prevents these inconsistencies and ensures that the language
display is consistent across the interface.

2005 MicroStrategy, Inc. MicroStrategy Desktop definitions 117


6 Creating a Project Installation and Configuration Guide

Creating a project using Project Builder


Project Builder is a wizard that allows you create simple
MicroStrategy projects quickly and efficiently. With Project
Builder, you can build project prototypes rapidly for
proof-of-concept tests with your own data. Project Builder
was created with speed in mind and hence it provides only a
subset of the features and functionality of MicroStrategy. To
create a project for your production setup, other methods can
be used to add greater functionality and complexity to your
project in the production setup. For more information on
other methods refer to Creating a project using
MicroStrategy Desktop, page 120. For more information on
Project Builder, refer to the MicroStrategy online help.

Using Project Builder


By default, Project Builder uses a Microsoft Access database
for the metadata repository. You can use the Microsoft Access
database for creating the metadata repository as the project
you are creating is only a prototype project.

 While it is possible to use an Access database for the


metadata repository, it is not a suitable metadata
repository for a production project. You should not use
Microsoft Access for anything other than a
proof-of-concept or demonstration type of application.

If you intend to create a production project, refer to Creating


a project using MicroStrategy Desktop, page 120.

The Project Builder contains the following options that assist


you in creating a prototype project:

My Database: allows you to name the project and select


the database that contains the business information you
want to analyze with the project you create.

My Business Model: allows you to identify relationships


that define the business information in your database.
Project Builder uses this structure to help you analyze the
data.

118 Creating a project using Project Builder 2005 MicroStrategy, Inc.


Installation and Configuration Guide Creating a Project 6

My Reports: allows you to use the attributes and metrics


you defined using My Business Model, to create a variety
of reports. These reports are based on pre-defined
templates. You can also preview and run the reports.

 You can learn about creating and manipulating reports


in more detail in the MicroStrategy Basic Reporting
Guide.

After you create a project using the Project Builder you can
add more tables, facts, attributes, and hierarchies to the
project. The following sections describe the MicroStrategy
tools you can use to add additional objects to your project:
Warehouse Catalog allows you to add more warehouse
tables to your project. You can add tables in bulk using the
Warehouse Catalog, unlike Project Builder that requires
you to add just a few tables at a time.

Fact Creation Wizard allows you to add more facts to


your project. You can create facts in bulk using the Fact
Creation Wizard, unlike Project Builder that requires you
to create one at a time.

Attribute Creation Wizard allows you to add more


attributes to your project. You can create attributes in
bulk using the Attribute Creation Wizard, unlike Project
Builder which requires you to create one at a time.

Hierarchy Editor allows you to add more hierarchies to


your project. The Hierarchy Editor provides an intuitive
graphical interface for creating hierarchies.

Click MicroStrategy Desktop to open MicroStrategy


Desktop, explore your project, and access the tools described
above. You can close Project Builder now. The following
section, Creating a project using MicroStrategy Desktop,
page 120 describes how to access and use these tools.

 Note the following:


When MicroStrategy Desktop opens, you might be
prompted to log in to an existing project source,
especially if you have installed MicroStrategy Tutorial.
If you are prompted, click Cancel and then choose
which project source to use.

2005 MicroStrategy, Inc. Creating a project using Project Builder 119


6 Creating a Project Installation and Configuration Guide

You can view your project even if you have installed


MicroStrategy Web or MicroStrategy Office. If you are
creating a new system, they are most likely not
properly configured yet and may not work as expected.
For information about how to configure and use these
products, see Connecting MicroStrategy Web to the
Intelligence Server, page 136 in Chapter 7, Deploying
Your Project with MicroStrategy Web.

Creating a project using MicroStrategy Desktop


This section describes how to create a project for your
production setup using MicroStrategy Desktop. It provides
advanced functionalities and greater complexity to your
project. It allows you to create a new project and add the
following objects to it or to an existing project:

tables

facts

attributes

shortcut objects

Creating a new project


Use the Project Creation Assistant wizard to create a new
project.

To create a new project

1 Log in to MicroStrategy Desktop.

2 From the Schema menu, select Create New Project. The


Project Creation Assistant opens.

3 Click Create project. The New Project page opens.

120 Creating a project using MicroStrategy Desktop 2005 MicroStrategy, Inc.


Installation and Configuration Guide Creating a Project 6

4 Specify the name, description, and default directory


location for the project.

5 Select a project source from the drop-down list, or click


New to create a new project source for your project.

 The project source should point to the metadata


repository in which to create the project.

6 Click OK. The Login dialog box opens.

 Ifdatayousource
are not authorized to create projects in the
you have selected, you cannot proceed
to the next step.

7 Specify a valid login ID and password and click OK. The


Project Creation Assistant creates an empty project in the
metadata database and redisplays the Project Creation
Assistant.

You can add the following through the Project Creation


Assistant wizard:

tables from the Warehouse Catalog

facts

attributes

Alternatively, you can use the various editors available


through the schema menu to create these schema objects at a
later stage.

For information on how to add tables using the Warehouse


Catalog, see Adding tables using the Warehouse Catalog,
page 122. For information on how to add facts, see Creating
facts, page 124. For information on how to add attributes, see
Creating attributes, page 126. You can also create shortcut
objects for your project. For more information on shortcut
objects and how to create them, see Creating shortcut
objects, page 130.

2005 MicroStrategy, Inc. Creating a project using MicroStrategy Desktop 121


6 Creating a Project Installation and Configuration Guide

Adding tables using the Warehouse Catalog


The Warehouse Catalog queries the data warehouse and lists
the tables and columns that exist in it. From this list, you can
choose the tables to add to your project. Every project can
have a unique set of warehouse tables.

 The Warehouse Catalog lists the tables present in the


database that connect to your projects database
instance. The database login you use must have read
privileges at least. Database instances and database
logins are MicroStrategy objects that determine the
warehouse to which a project connects. If you want to
learn more about these objects, refer to the
MicroStrategy System Administration Guide.

You might want more MicroStrategy objects, such as large


number of lookup tables or relate tables that can be provided
efficiently by the Warehouse Catalog.

To open the catalog

1 Log in to the project source that contains your project in


MicroStrategy Desktop, and expand your project.

 You must use a login that has Architect privileges. For


more information about privileges see Appendix B of
the MicroStrategy System Administration Guide.

2 Select the project from the folder list on MicroStrategy


Desktop.

3 From the Schema menu, choose Warehouse Catalog.


The Warehouse Catalog opens.

The left side of the Warehouse Catalog lists all available


tables and the number of rows each table contains. The list on
the right shows all tables already being used in the project.

122 Creating a project using MicroStrategy Desktop 2005 MicroStrategy, Inc.


Installation and Configuration Guide Creating a Project 6

From here you can add additional tables to the project or you
can remove tables you no longer require from the project.
Right-clicking any table provides you with additional
Warehouse Catalog functionality:

Table Structure allows you to view the columns that


make up the table and their data type.

Update Structure is similar to refreshing a display. If the


structure of the table has changed, use this option to see
the most recent version.

Show Sample Data displays the first 100 rows of data in


the table.
Table Prefix allows you to specify a table prefix to
differentiate the tables that belong to different to projects.
You can also create copies of the same table by providing a
different prefix to it.

Table Database Instance allows you to specify a


secondary database instance used to support database
gateways. For example, in your environment you might
have a gateway between two databases, perhaps an Oracle
database and a DB2 database. One of them is the primary
database and the other is the secondary database. The
primary database receives all SQL and passes it to the
correct database. From the perspective of MicroStrategy
products, you need to define two database instances, one
for the primary database and another for the secondary
database. The default database instance for the project is
set to be the primary database. In the Warehouse Catalog,
you must set the secondary database instance for any
tables that are found in the secondary database. This way,
MicroStrategy products know how to generate SQL for
each one.

Additionally, you can click Options on the Warehouse


Catalog tool bar to set advanced options. For more
information on using the Warehouse Catalog, see Appendix
C, Advanced Warehouse Catalog Usage.

2005 MicroStrategy, Inc. Creating a project using MicroStrategy Desktop 123


6 Creating a Project Installation and Configuration Guide

To add and remove tables

1 Select the tables to add or remove. You can highlight


multiple tables using the CTRL+click or SHIFT+click
standard selection method.

2 To add tables to your project, click > to add the selected


tables. Click >> to add all the listed tables.

3 To remove tables from your project, click < to move them


to the left side. Click << to remove all the selected tables.

4 Click Save and Close to save your changes.

Creating facts
Facts are MicroStrategy objects that relate numeric data
values from the data warehouse to the project
creation/reporting environment. Relate is a key term here.
The facts correspond to physical columns in the data
warehouse. When you create facts, you are essentially
mapping column names in the warehouse to facts in the
MicroStrategy environment.

Facts are used to create metrics, which perform calculations


on the actual fact data.

 For information on metrics, refer to the


MicroStrategy Basic Reporting Guide. To learn more
about facts and fact columns, refer to Data Modeling
in the MicroStrategy Basic Reporting Guide. For
more detailed discussions of both facts and metrics,
see the MicroStrategy Advanced Reporting Guide.

124 Creating a project using MicroStrategy Desktop 2005 MicroStrategy, Inc.


Installation and Configuration Guide Creating a Project 6

Project Builder guides you through the project creation


process, including the creation of facts. The Fact Creation
Wizard allows you to create multiple facts quickly and easily.
However it limits you to creating simple facts and does not
allow you to edit existing facts. Typically, you only use the
Fact Creation Wizard as part of the initial project creation, for
creating most of the facts for the project. You can use the Fact
Editor to add complexity to existing facts as your project
evolves.

 The Fact Editor and the fact definitions you can create
with it are discussed in detail in the Facts chapter of
the MicroStrategy Advanced Reporting Guide.

To create facts

1 Log in to the project source that contains your project in


MicroStrategy Desktop and expand your project.

 You must use a login that has Architect privileges. For


more information about privileges see Permissions
and Privileges of the MicroStrategy System
Administration Guide.

2 From the folder list on MicroStrategy Desktop, select the


project to add additional facts.

3 From the Schema menu, choose Fact Creation Wizard.


The Introduction page opens.

4 Review the Introduction page.

5 Click Define Rules. The Fact Creation Rules page opens,


which allows you to set basic fact creation rules. These
rules can make the process of choosing fact columns and
naming your facts considerably easier, especially if you
use consistent naming conventions and data types in your
data warehouse.

6 Select the rules for the Column data type and Fact name.

7 Click OK. The Introduction page opens.

2005 MicroStrategy, Inc. Creating a project using MicroStrategy Desktop 125


6 Creating a Project Installation and Configuration Guide

8 Click Next. The Column Selection page opens. Columns


that are not currently being used in the project are listed
as available on the left side of the Column Selection page
whereas the fact columns available in the project are
placed on the right.

9 Choose the fact columns to use for your facts and click > to
add them to your project. Click >> to add all the listed
columns.

10 To remove fact columns from your project, click < to move


them to the left side. Click << to remove all the selected
columns.

11 Click Next. The Finish page opens.

12 Review the summary information in the Finish page and


click Finish to create the facts.

Creating attributes
Attributes are additional information that provides context
for facts. For example, assume Sales is a fact. If you know that
the sales figure for your company is $25,000, this
information is meaningless unless you have the context for
the sales figure, such as:

When were the sales made? Does the total represent sales
for a day, week, or year? Which day, week, or year?
Where were the sales made? Is that a company-wide total
or is it just for a particular region or store?

What products were sold and from what departments?


Who sold them?

Attributes allow you to answer these types of questions about


a fact. They provide context, categories, and levels for
convenient summarization and qualification of data.

The Attribute Creation Wizard guides you through creating


new attributes to use in your project.

126 Creating a project using MicroStrategy Desktop 2005 MicroStrategy, Inc.


Installation and Configuration Guide Creating a Project 6

Parent and child attributes

An attribute can have two parts, a parent and child. This


helps to define the relationship that one attribute has with
another attribute. A child attribute can have only parent,
whereas a parent attribute can have multiple children. For
example, a store may split the United States into different
regions such as Northeast and Southwest. The regions are the
children of the parent attribute, which is United States. For
more information on attribute relationship, refer to the
Attributes chapter in the MicroStrategy Advanced
Reporting guide.

Compound attributes

A compound attribute is any attribute with more than one


column specified as the ID column. For example, in the
MicroStrategy Tutorial, the Distribution Center attribute is a
compound attribute. To uniquely identify a distribution
center, you have to know both the distribution center ID and
the country ID. This is because the distribution center ID can
be reused in different countries. See the note at the end of
this table.

Attribute elements are the unique values of an attribute. For


example, 2002 and 2003 might be elements of the Year
attribute. Reykjavik, Jakarta, and Brussels might be elements
of the International Capital attribute.

To create attributes using the Attribute Creation Wizard

1 In MicroStrategy Desktop, log in to the project source that


contains your project and expand your project.

 You must use a login that has Architect privileges. For


more information see Privileges of the MicroStrategy
System Administration Guide for more information
about privileges.

2 From the folder list, select the project to which to add new
attributes.

2005 MicroStrategy, Inc. Creating a project using MicroStrategy Desktop 127


6 Creating a Project Installation and Configuration Guide

3 From the Schema menu, choose Attribute Creation


Wizard. The Introduction page opens.

4 Review the Introduction page.

5 Click Define Rules to set some basic attribute creation


rules. The Attribute Creation Rules page opens. These
rules can make the process of choosing attribute columns
and naming your attributes considerably easier, especially
if you use consistent naming conventions and data types
in your data warehouse.

 Notice that some columns are already highlighted


based on the rules you defined. Only columns that are
not currently being used in the project are listed as
available on the left side of the ID Column Selection
page, whereas, the fact columns available in the
project, are placed on the right.

6 Select the check boxes as needed for Column data type


and Attribute name to define basic attribute creation
rules. Enter search criteria for the identifier column,
description column, and lookup tables in the Warehouse
search section. Click OK. The Introduction page opens.

7 Click Next. The ID Column Selection page opens.

 An ID column is a column or group of columns that


uniquely identifies each element of an attribute. When
choosing the ID column for an attribute, make sure
that all values in the column are unique and that it
does not contain NULL values. Although
MicroStrategy Desktop allows it, you should never use
a column that has NULL or repeated values as the ID
column for an attribute. Doing so results in
unexpected behavior and errors.

8 Choose the columns to use for your attribute IDs and click
> to add them to your project. Click >> to add all the
attribute IDs.

9 To remove attribute ID columns from your project, click <


to move them to the left side. Click << to remove the
entire listed columns.

128 Creating a project using MicroStrategy Desktop 2005 MicroStrategy, Inc.


Installation and Configuration Guide Creating a Project 6

10 To create a compound attribute, complete the following


steps:

Click Compound Attributes and then click Add. The


New Compound Attribute dialog box opens.

Type a name for the attribute.

Select the columns that make up the key for the


compound attribute and click OK.

11 Click Next after adding all your attribute ID columns. The


Description Column Selection page opens.

12 Choose the default description column for each attribute.


In some cases, it may make sense to use the ID column as
the description column.

13 Click Next when you are finished. The Lookup Table


Selection page opens.

14 Choose the default lookup table for each attribute and


click Next.
If you have created a compound attribute, the
Compound Attribute Definition page opens. Specify
the lookup table and description column for the
selected compound attribute and click Next. The
Relationship Definition page opens.

If you have not created a compound attribute, the


Relationship Definition page opens.

15 To define children for each attribute follow the steps


below:

Select an attribute and click Add. The Select Children


Attributes dialog box opens.
Select the child attribute from the list of available child
attributes.

16 When you have defined children for all the attributes that
need them, click OK. The Finish page opens.

17 Review the summary information in the Finish window


and click Finish to create the attributes.

2005 MicroStrategy, Inc. Creating a project using MicroStrategy Desktop 129


6 Creating a Project Installation and Configuration Guide

Creating shortcut objects


Shortcut objects are stand-alone objects in MicroStrategy
that represent links to other objects, such as reports, filters,
metrics, and so on. The shortcut objects are easy pointers for
navigation. Creating shortcuts to original objects in different
locations facilitates access to these objects without
duplicating them.

The shortcuts allow for easy maintenance by eliminating the


requirement to change numerous duplicate copies of the
original object. To change any parameters of an object, you
have to modify only the original object and these changes are
reflected in all locations where the shortcuts for this object
exist. To access the editor for the object, right-click the
original object or its shortcut, and select Edit. The original
object is displayed in the editor.

You can create shortcut objects either from the original object
or from the Shortcut Editor.

To create a shortcut object from the original object

1 Right-click the object for which to create a shortcut and


select Create Shortcut. The Browse for Folder dialog box
opens.

2 Navigate to the folder in which to save the shortcut and


click OK. The shortcut object is created in the destination
folder.

For example, you want to create a shortcut to the Units Sold


metric and save it in the Templates folder. Expand the
Metrics folder, then expand the Sales Metrics folder.
Right-click the Units Sold metric and choose Create
Shortcut. On the Browse to Folder dialog box, navigate to the
Templates folder and click OK. The Units Sold shortcut
object is created in the Templates folder.

130 Creating a project using MicroStrategy Desktop 2005 MicroStrategy, Inc.


Installation and Configuration Guide Creating a Project 6

To create a shortcut object using the Shortcut Editor

1 Open the folder in which to create a new shortcut object.

2 From the File menu, point to New, and then choose


Shortcut. The Open dialog box is displayed.

3 Navigate to the object for which to create a shortcut.


Select the object and click Open. Make sure the object
name is displayed in the Object name text field. The
shortcut object is created in the folder that you opened in
step 1.

For example, you want to create a new shortcut object to the


filter Year 2003 in the Templates folder. First, open the
Templates folder. From the File menu point to New, and then
choose Shortcut. On the Open dialog box navigate to the
filter Year 2003 and click Open. The shortcut to Year 2003 is
created in the Templates folder.

2005 MicroStrategy, Inc. Creating a project using MicroStrategy Desktop 131


6 Creating a Project Installation and Configuration Guide

MicroStrategy project schema


All of the schema objects come together to form a projects
schema.

 Though the concepts are related, this schema is not the


same as the physical warehouse schema. Rather, this
schema refers to an internal map that MicroStrategy
uses to keep track of attribute relationships, fact levels,
table sizes, and so on.

Whenever you make any changes to a schema objectfacts,


attributes, hierarchies, transformations, and so onyou must
indicate to MicroStrategy that new schema object definitions
have been included and that these definitions need to be
loaded into memory. You can do any of the following to
update a schema

Stop and restart MicroStrategy Intelligence Server, if in


three-tier mode.

Disconnect and reconnect to the project or the project


source, if in direct mode.
Manually update the schema.

Manually updating the schema is most effective.

To manually update the schema

1 In MicroStrategy Desktop, from the Schema menu, select


Update Schema.

2 In the Schema Update dialog box, select or clear the


following check boxes:

Update schema logical informationUse this option


if you added, modified, or deleted a schema object.

Recalculate table keys and fact entry levelsUse


this option if you changed the key structure of a table
or if you changed the level at which a fact is stored.

132 MicroStrategy project schema 2005 MicroStrategy, Inc.


Installation and Configuration Guide Creating a Project 6

Recalculate table logical sizesUse this option to


use MicroStrategy Desktops algorithm to recalculate
logical table sizes and override any modifications that
you have made to logical table sizes.

 Logical table sizes are significant in how the


MicroStrategy SQL Engine determines the tables to
use in a query.

Recalculate project client object cache size Use


this option to update the object cache size for the
project.

3 Click Update.

You can also update the schema with the last saved settings
by clicking the Update Schema icon in the toolbar.

Next steps
Now you have learned how to create a new project and how to
enhance it by adding additional facts and attributes to it. To
learn how you can use these objects to create metrics, filters,
reports, documents, and so on, refer to the MicroStrategy
Advanced Reporting Guide.

After creating your project, you can deploy it to your user


community using MicroStrategy Web. To learn more about
how to deploy your project using MicroStrategy Web, refer to
Chapter 7, Deploying Your Project with MicroStrategy Web.

2005 MicroStrategy, Inc. Next steps 133


6 Creating a Project Installation and Configuration Guide

134 Next steps 2005 MicroStrategy, Inc.


7
7. DEPLOYING YOUR PROJECT
WITH MICROSTRATEGY WEB

Introduction

This chapter describes the procedure to deploy a project to


your user community using MicroStrategy Web. The process
of deploying the ASP.NET version of MicroStrategy Web on
Windows with Microsoft Internet Information Services (IIS)
is explained in detail.

MicroStrategy Web simplifies the job of deploying to large


user groups because there is no need to install anything on
the end users machines. MicroStrategy Web can be accessed
from any supported browser because there is no code to
download. It provides the functionality that end users and
power users require to take full advantage of the
MicroStrategy product suite.

MicroStrategy Web Universal is platform-independent and


can be deployed using different combinations of operating
systems, Web servers, and application servers. If you are
deploying MicroStrategy Web Universal, Chapter 8,
Configuring and Deploying MicroStrategy Web Universal.

2005 MicroStrategy, Inc. 135


7 Deploying Your Project with MicroStrategy Web Installation and Configuration Guide

Connecting MicroStrategy Web to the


Intelligence Server
You must have administrative privileges to deploy
MicroStrategy Web for your project. If this is the first time
you are logging in and you have not changed the default
MicroStrategy administrative login, you can use
Administrator as the login with no password. After the first
time, the user name and password should be changed for
security purposes.

To connect MicroStrategy Web to your Intelligence Server

1 On the Windows Start menu, point to Programs, then to


MicroStrategy, then to Web, and then choose Web
Administrator. The Web Administrator page opens. This
is the page where you connect MicroStrategy Web to the
Intelligence Server.

2 Type the name of your Intelligence Server in the Add a


server manually box on the Web Administrator page.

3 Click Connect. All projects loaded on the Intelligence


Server are now available from MicroStrategy Web. Click
the Home icon to see the list of projects loaded on the
Intelligence Server you specified.

4 Send your users the URL:

http://webservername/microstrategy/asp/
where webservername is the name of the computer
hosting your Web server. For example, if the name of your
Web server machine is Web_Srv1, then the URL your
users would use to access MicroStrategy Web would be

http://Web_Srv1/microstrategy/asp

 See the MicroStrategy System Administration


Guide for more information.

You have manually connected MicroStrategy Web to the


Intelligence Server.

136 Connecting MicroStrategy Web to the Intelligence Server 2005 MicroStrategy, Inc.
Installation and Configuration Guide Deploying Your Project with MicroStrategy Web 7

You can also connect automatically whenever MicroStrategy


Web Server or Intelligence Server starts.

To make MicroStrategy Web connect to the Intelligence Server


automatically

1 On the MicroStrategy Web Administrator page, click


Modify in the Properties column of the Intelligence
Server.

2 Select the Automatically connect to Intelligence Server


when Web Server or Intelligence Server is restarted
option and click Save.

2005 MicroStrategy, Inc. Connecting MicroStrategy Web to the Intelligence Server 137
7 Deploying Your Project with MicroStrategy Web Installation and Configuration Guide

138 Connecting MicroStrategy Web to the Intelligence Server 2005 MicroStrategy, Inc.
8
8. CONFIGURING AND DEPLOYING
MICROSTRATEGY WEB
UNIVERSAL

Introduction

This chapter provides information on how to deploy and


configure MicroStrategy Web Universal in a UNIX/Linux
environment with various Web and application servers.

 Web application servers are not MicroStrategy


products, so detailed steps cannot be provided for
every combination of application server and operating
system. This chapter supplies instructions for a few of
the most common combinations. The procedures for
different operating systems are similar, but please
refer to the vendor-provided user information for
details.

This chapter has the following sections:

Deploying with WebLogic and Apache (Solaris)

Deploying with WebSphere 5.x and IBM HTTP Server


(AIX)
Deploying with Sun ONE (iPlanet) 8.0

2005 MicroStrategy, Inc. 139


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Deploying with Tomcat (Linux)

Deploying with Oracle 10g

Using the MicroStrategy Web Administrator Console

Deploying with WebLogic and Apache


This section provides information used to deploy and
configure MicroStrategy Web Universal on the Sun Solaris 8
operating system, using Apache as the Web server and
WebLogic Server as the application server. It provides
information for WebLogic 7.x and 8.x.

This section includes the following information:

WebLogic paths and folder locations: Default folder


structure for each version of WebLogic.

Preconfiguration information: Configuration that must


occur before you begin deploying MicroStrategy Web
Universal.

Deploying MicroStrategy Web Universal: Instructions for


deploying the application.

Re-deploy the application: Instructions for re-deploying


the application.
Performance-based setup information: Optional
configuration settings to increase the applications
performance.

 The additional configuration steps are not required


for MicroStrategy Web Universal to run, but these
settings can increase its performance. Review the
performance-based setup information prior to
deploying the system to see if these changes are of
interest to you.

140 Deploying with WebLogic and Apache 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

WebLogic paths and folder locations


This section presents the default folder structure for each
version of WebLogic, and provides the variable used
throughout the rest of this chapter to represent the WebLogic
mydomain folder path.

Each version of WebLogic is installed with a different default


path to the WebLogic mydomain folder. When deploying
MicroStrategy Web Universal, you must make some changes
within the WebLogic folders. Thus, it is important to
understand the WebLogic folder structure for the version of
WebLogic you are using. The following paths reflect the
default folder structure for each WebLogic version:

WebLogic 7.x:
<WEBLOGIC_HOME>/user_projects/mydomain/

WebLogic 8.x:
<WEBLOGIC_HOME>/user_projects/domains/
mydomain/

 Note the following:


<WEBLOGIC_HOME> is the WebLogic Server home
path.

The folder structures are configurable and your


organization may have changed the default names or
path.

Throughout this chapter, the WebLogic mydomain folder is


referred to as <WEBLOGIC_MYDOMAIN_FOLDER>. This
variable refers to the WebLogic mydomain folder in whatever
location it resides on your system. The location of this
variable is based on the version of WebLogic and whether
your organization has changed the versions default name or
path.

2005 MicroStrategy, Inc. Deploying with WebLogic and Apache 141


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Preconfiguration information
This section provides the preconfiguration information
necessary to deploy MicroStrategy Web Universal on your
machine. This includes the following sections:

Locating the WAR file

Configuring the web.xml file

Setting up Apache Web server to proxy requests to


WebLogic

This section uses the configuration outlined in the following


table. While your setup may vary slightly, for example, you
may have different versions of these applications, the overall
process remains the same.

Requirement Recommended

Operating system Sun Solaris 8

Web server Apache 1.3x, Apache 2.0.x

Application server WebLogic 7.x, WebLogic 8.x

JRE Sun JRE 1.3.1, Sun JRE 1.4.1

 Note the following:


WebLogic 7.x uses Sun JDK 1.3.x whereas WebLogic
8.x uses Sun JDK 1.4.x.
For information on the version numbers supported or
certified by MicroStrategy, see the MicroStrategy
Readme file.

For information on installing these products, see


http://edocs.bea.com/

Before you start the deployment process, locate the


machine name and IP address.

142 Deploying with WebLogic and Apache 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Locating the WAR file

The MicroStrategy Web Universal application is packaged


within a single file, called a WAR (Web ARchive) file,
following J2EE specifications. You must deploy the WAR file
to run the application in your application server
environment.

The WAR file is placed in the folder you specified when


installing MicroStrategy Web Universal. Copy the WAR file to
the <WEBLOGIC_MYDOMAIN_FOLDER>. See WebLogic paths
and folder locations, page 141 for information on the default
folder structure.

 Tothatdeploy the WAR file, you must follow a set of steps


are specific to the application server you are
using. For more details, see the application server
vendor documentation or follow the instructions
within this guide. You should also follow any relevant
preconfiguration instructions within this chapter.

After deploying the MicroStrategy.war file, you can view


the WEB-INF folder, which contains a sub folder named log.
The log folder retains all the log files, except for the
ncsportal.log files. They are created in the Application
server root folder. For more information on the directory
structure after deploying the WAR file, see Directory structure
after deploying the WAR file, page 84 in Chapter 8,
Configuring and Deploying MicroStrategy Web Universal.

Configuring the web.xml file

 This procedure is required if you deploy MicroStrategy


Web Universal as a duplicate WAR file on WebLogic.
It is not necessary if you deploy the application as an
exploded directory.

By default, the paths of the configuration and log files are


saved as relative paths in the web.xml file. Before deploying
MicroStrategy Web Universal, you may need to modify these
paths to absolute paths.

A sample of modified web.xml file is available for your


reference; see Appendix F, Example of modified web.xml file.

2005 MicroStrategy, Inc. Deploying with WebLogic and Apache 143


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

To configure the web.xml file

1 Open the web.xml file located in the /WEB-INF


directory.

 The web.xml file is inside the


MicroStrategy.war file so you must expand or
unzip that WAR file first. For details on expanding
or unzipping the file, see Deploying MicroStrategy
Web Universal, page 146.

2 The following table lists the parameters to be modified in


the web.xml file. For each parameter, replace the string
listed in the Old Value column with the string in the New
Value column. Change the parameter value from relative
to an absolute path pointing to a physical folder in your
machine. However, set the values for pageConfig.xml
and styleCatalog.xml parameters to be relative.

For example, if the directory where you store the


MicroStrategy Web Universal configuration files is
<WEBLOGIC_HOME>/NewFolder
where <WEBLOGIC_HOME> is the path to the WebLogic
Server, change the
serverConfigFilesDefaultLocation parameter
value to
<param-value>ABSOLUTE:<WEBLOGIC_HOME>/
NewFolder/ </param-value>

 If you are running WebLogic Server in Windows,


make sure that you specify only forward slashes in
the absolute path. For example, <par
am-value>ABSOLUTE:C:/MyFolder
</param-value> is a valid path, but
<param-value>ABSOLUTE:C:\MyFolder</pa
ram-value> is not valid.

144 Deploying with WebLogic and Apache 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Parameter Old Value New Value

styleCatalogFile styleCatalog.xml /WEB-INF/xml/styleCatalog.xml


configFile pageConfig.xml /WEB-INF/xml/pageConfig.xml

serverConfigFilesDefaul <param-value>/WEB-INF/xml/ <param-value>ABSOLUTE:<WEBLOG


tLocation </param-value> IC_HOME>/NewFolder/
</param-value>

serverLogFilesDefaultL <param-value>/WEB-INF/log/ <param-value>ABSOLUTE:<WEBLOG


ocation </param-value> IC_HOME>/NewFolder/log/
</param-value>

3 Save the web.xml file and compress the WAR file.

 Ifwasyoualready
modify the web.xml file for an application that
deployed, you must re-deploy the
application for the changes to take effect. For details,
see Re-deploy the application, page 157.

Setting up Apache Web server to proxy requests


to WebLogic

You can have the Apache Web server and WebLogic Server
running independently on the same machine, but to
configure Apache to proxy the desired requests to the
WebLogic Server, you must install a plug-in provided by
WebLogic. Complete the instructions at the following URLs
to install and configure the plug-in.

For WebLogic 7.x, the URL is

http://e-docs.bea.com/wls/docs70/plugins/
apache.html

Install the plug-in with the WebLogic installation in the


following location:
<WEBLOGIC_HOME>/Server/lib/solaris/
mod_wl_ssl.so

where <WEBLOGIC_HOME> is the path to the WebLogic


Server.

2005 MicroStrategy, Inc. Deploying with WebLogic and Apache 145


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

For WebLogic 8.x, the URL is

http://e-docs.bea.com/wls/docs81/plugins/
apache.html

Install the plug-in with the WebLogic installation in the


following location:

<WEBLOGIC_HOME>/Server/lib/solaris/
mod_wl_ssl.so

where <WEBLOGIC_HOME> is the path to the WebLogic


Server.

 Tocanincrease the performance of Web Universal, you


complete additional setup configurations before
the deployment. For more information, see
Performance-based setup information, page 158.

Deploying MicroStrategy Web Universal


When your machine has been configured with the necessary
settings, you can deploy MicroStrategy Web Universal with
Apache and WebLogic. This involves the following steps:

1 Deploying automatically (development mode).

- or -

Deploying manually (production mode).

2 Accessing the MicroStrategy Web Administrator page.

3 Launching the project.

 The Performance-based setup information section


provides information on additional settings to increase
application performance. These additional settings are
not required but can increase the performance of Web
Universal. Review this information prior to
deployment to see if these options are of interest to
you.

146 Deploying with WebLogic and Apache 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

You can deploy MicroStrategy Web Universal using one of the


following deployment methods:

The automatic deployment feature is the easiest and


fastest way. See Deploying automatically (development
mode), page 147. Choose the development mode in the
/<WEBLOGIC_MYDOMAIN_FOLDER>/
startWebLogic.sh file, within the WebLogic Server
folder structure.

The manual deployment feature can be used for


environments where the server is running in production
mode and the automatic deployment is turned OFF. For
more information, see Deploying manually (production
mode), page 150.

Deploying automatically (development mode)

When automatic deployment is set to ON, as soon as you


place a WAR file in the
/<WEBLOGIC_MYDOMAIN_FOLDER>/applications folder,
the application is automatically deployed.

With this method you can deploy from either of the following:

a duplicate WAR file

an exploded directory where all the files contained in the


WAR file were extracted

To automatically deploy MicroStrategy Web Universal from a


duplicate WAR file

1 Locate the MicroStrategy.war file in the Web


Universal Deployment Directory you specified during
installation. For more information, see Installation
procedures on UNIX or Linux, page 72 in Chapter 4,
Installing MicroStrategy on UNIX and Linux.

2 Rename the WAR file to a name you can easily identify


and remember. This name is the context_name used in
the uniform resource locator (URL) to access the file. This
step is optional.

2005 MicroStrategy, Inc. Deploying with WebLogic and Apache 147


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

 Ifremember
you do not change the name of the file,
to replace context_name with
MicroStrategy when accessing the application
from the URL.

3 Unzip the WAR file using the following command:


#jar -xvf MicroStrategy.war
4 Configure the web.xml file. For information on
configuration, see Configuring the web.xml file, page 143.

 Ifmake
you are running WebLogic Server in Windows,
sure that you specify only forward slashes in
the absolute path. For example, <par
am-value>ABSOLUTE:C:/MyFolder
</param-value> is a valid path, but
<param-value>ABSOLUTE:C:\MyFolder</pa
ram-value> is not valid.

5 Zip the WAR file with the following command:


#jar -cvf MicroStrategy.war *
6 Transfer the WAR file to the following application
directory:

/<WEBLOGIC_MYDOMAIN_FOLDER>/applications

The application is automatically deployed. To add and


connect to an Intelligence Server, see Accessing the
MicroStrategy Web Administrator page, page 174.

 ToUniversal,
increase the performance of MicroStrategy Web
you can configure additional settings after
deployment. For more information, see
Performance-based setup information, page 158.

Next, access the MicroStrategy Web Administrator page to


finish configuring Web Universal.

148 Deploying with WebLogic and Apache 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

To deploy MicroStrategy Web Universal from the exploded


directory

 The WAR file must be uncompressed by the same


Solaris user who started the application.

1 Locate the MicroStrategy.war file. It is located in the


Web Universal Deployment Directory you specified
during installation. For more information, see
Installation procedures on UNIX or Linux, page 72.

2 Create the following new folder:


/home/username/context_folder
where username is your account name used to access
the Web server machine, and context_folder is the
name of the new folder.

 You can create the new folder anywhere except in


the following location:

/<WEBLOGIC_MYDOMAIN_FOLDER>/applications

3 Copy the WAR file to the new folder.

4 To explode the WAR file inside the folder you created, run
the following command:
# jar -xvf MicroStrategy.war

5 Delete the MicroStrategy.war file by running this


command:
# rm MicroStrategy.war

6 Move the folder to the applications folder with the


following commands:

# cd..

# mv context_folder
/<WEBLOGIC_MYDOMAIN_FOLDER>/applications

The application is automatically deployed. To add and


connect to an Intelligence Server, see Accessing the
MicroStrategy Web Administrator page, page 174.

2005 MicroStrategy, Inc. Deploying with WebLogic and Apache 149


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

 ToUniversal,
increase the performance of MicroStrategy Web
you can configure additional settings after
deployment. For more information, see
Performance-based setup information, page 158.

Deploying manually (production mode)

With manual deployment you can deploy MicroStrategy Web


Universal from either of the following:

a duplicate WAR file

an exploded directory where all the files contained in the


WAR file were extracted

Perform the deployment in the


/<WEBLOGIC_MYDOMAIN_FOLDER>/applications
directory.

To manually deploy MicroStrategy Web Universal from a


duplicate WAR file

1 Locate the MicroStrategy.war file. It is located in the


Web Universal Deployment Directory you specified
during installation. For more information, see
Installation procedures on UNIX or Linux, page 72 in
Chapter 4, Installing MicroStrategy on UNIX and Linux.

2 Unzip the WAR file by running the following command:


#jar -xvf MicroStrategy.war
3 Configure the web.xml file. For more information, see
Configuring the web.xml file, page 143.

 Ifsureyouthat
are running WebLogic Server in Windows, make
you specify only forward slashes in the
absolute path. For example, <par
am-value>ABSOLUTE:C:/MyFolder
</param-value> is a valid path, but
<param-value>ABSOLUTE:C:\MyFolder</param
-value> is not valid.

150 Deploying with WebLogic and Apache 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

4 Zip the WAR file by running the following command:


#jar -cvf MicroStrategy.war *
5 Transfer the file to the
/<WEBLOGIC_MYDOMAIN_FOLDER>/applications
directory.

6 Open the WebLogic Server Administration Console (WLS


Admin Console) by typing the following address:

http://IP address:7001/console/

where IP address is the IP address of the machine.

7 Type a valid user ID and password at the prompt.

8 To complete this operation, see Configure from the WLS


Admin Console, page 152.

To manually deploy MicroStrategy Web Universal from the


exploded directory

1 Locate the MicroStrategy.war file. It is located in the


Web Universal Deployment Directory you specified
during installation. For more information, see
Installation procedures on UNIX or Linux, page 72 in
Chapter 4, Installing MicroStrategy on UNIX and Linux.

2 Create a folder in the


/<WEBLOGIC_MYDOMAIN_FOLDER>/applications
directory and transfer the WAR file to this directory.

3 Unzip the WAR file using the following command:

#jar -xvf MicroStrategy.war

4 Open the WLS Admin Console by accessing the following


address:

http://IP address:7001/console/

5 Type a valid user ID and password at the prompt. The


user ID and password are the ones you specified when
installing the WebLogic Server on your machine.

2005 MicroStrategy, Inc. Deploying with WebLogic and Apache 151


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

6 To complete this operation, see Configure from the WLS


Admin Console.

Configure from the WLS Admin Console

To configure from the WLS admin console, refer to the


appropriate procedure below depending on your version of
WebLogic:
To configure from the WLS Admin Console with
WebLogic 7.x, page 152

To configure from the WLS Admin Console with


WebLogic 8.x, page 153

To configure from the WLS Admin Console with WebLogic 7.x

1 Select mydomain, point to Deployments, and then


choose Web Applications. The Web Application table
opens.

2 Select Configure a New Web Application.

3 Locate and select the WAR file to configure and deploy. If


you are deploying from the exploded directory, select the
root of the exploded directory.

4 Select the server on which you want to deploy the


application. From the Available list of servers box, select
myserver and click the > arrow to move it to the Chosen
Servers box. Click Apply.

5 Type the name of the application you want to create. This


name is used in the URL to access the MicroStrategy Web
Administrator page.

6 Click Configure and Deploy, then wait for the


application to activate.

You have completed the steps required to deploy


MicroStrategy Web Universal.

To launch MicroStrategy Web Administrator and to configure


MicroStrategy Intelligence Server, see Accessing the
MicroStrategy Web Administrator page, page 174.

152 Deploying with WebLogic and Apache 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

 ToUniversal,
increase the performance of MicroStrategy Web
you can complete additional setup
configurations that occur after the deployment. For
more information, see Performance-based setup
information, page 158.

To configure from the WLS Admin Console with WebLogic 8.x

1 Select mydomain, point to Deployments, and then


choose Web Application Modules. The Web Application
table opens.

2 Select Deploy a New Web Application Module.

3 Locate and select the WAR file to configure and deploy. If


you are deploying from the exploded directory, select the
root of the exploded directory.

4 Click the Target Module button.

5 Select the server on which you want to deploy the


application and click Continue.

6 Select how you want the source files to be made accessible


and type the name for the new Web Application module.
This name is used in the URL to access the MicroStrategy
Web Administrator page.

7 Click Deploy, then wait for the application to activate.

You have completed the steps required to deploy


MicroStrategy Web Universal.

To launch MicroStrategy Web Administrator and to configure


MicroStrategy Intelligence Server, see Accessing the
MicroStrategy Web Administrator page, page 174.

 ToUniversal,
increase the performance of MicroStrategy Web
you can configure additional settings after
deployment. For more information, see
Performance-based setup information, page 158.

2005 MicroStrategy, Inc. Deploying with WebLogic and Apache 153


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Configuring the MicroStrategy Web


Administrator page

Before starting MicroStrategy Web Universal, you must


configure the Web Administrator page; the mstrWebAdmin
servlet.

To access the MicroStrategy Web Administrator page

1 The address to launch MicroStrategy Web is different for


each deployment method. The following table lists the
URL to access MicroStrategy Web Administrator.

 The servlet names are case-sensitive. Make sure to use


the correct case when typing the mstrWebAdmin
name. If the application server is enabled with
security, a dialog box related to the administrator
authentication opens.

Deployment Method Address

Automatic
deployment:

When deployed Access the Administrator page from a browser


from a duplicate using either of the following addresses:
WAR file. http://IPaddress:7001/context_na
me/servlet/mstrWebAdmin
http://IPaddress/context_name/se
rvlet/mstrWebAdmin
The first URL accesses the Web Administrator
through port 7001, which is the default port for
the application server. The second URL uses
the Apache Web server.
The context_name is the name you gave to
the WAR file and IPaddress is the IP address
of your machine.

154 Deploying with WebLogic and Apache 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Deployment Method Address

When deployed Access the Administrator page from a browser


from an exploded at this address:
directory. http://IPaddress:7001/context_
folder/servlet/mstrWebAdmin
where context_folder is the name of the
folder where the application was exploded and
IPaddress is the IP address of your machine.

Manual deployment Access the Administrator page from a browser


using this address:
http://IPaddress:7001/name/servlet
/mstrWebAdmin
where IPaddress is the IP address of your
machine. Replace the name variable with the
name you specified in the Name field when
configuring from WLS Admin console, for
example, MyWebApp.

2 Type the same user ID and password that was used to


start the WebLogic Server on your machine.

In WebLogic, the deployment of Web Universal


automatically associates the WebLogic administrative
user with the MicroStrategy Web Universal administrator.
The WebLogic administrative user is the user who has
permissions to start the WebLogic Server on a given
machine. By default, when WebLogic is installed, the
administrative user is called system.

3 After you are authenticated, the MicroStrategy Web


Administrator page appears. Add and connect to an
Intelligence Server.

Launch the Web Universal project, as described below.

2005 MicroStrategy, Inc. Deploying with WebLogic and Apache 155


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Launching the project

The address to launch MicroStrategy Web Universal is


different for each deployment method. The table below lists
the URL you can use to access MicroStrategy Web Universal.

Deployment Method Address

Automatic
deployment:

When deployed Access Web Universal from a browser using


from a duplicate either of the following addresses:
WAR file. http://IPaddress:7001/context_
name/servlet/mstrWeb
http://IPaddress/context_name/
servlet/mstrWeb
The first URL accesses the Web application
through port 7001, which is the default port for
the application server. The second URL goes
through the Apache Web server.
The context_name is the name you gave to
the WAR file and IPaddress is the IP address
of your machine.

When deployed Access Web Universal from a browser using


from an exploded the address:
directory. http://IPaddress:7001/
context_folder/servlet/mstrWeb
where the context_folder is the name of
the folder where the application was exploded
and IPaddress is the IP address of your
machine.

Manual deployment Access Web Universal from a browser using


the address:
http://IPaddress/name/servlet/mstr
Web
where IPaddress is the IP address of your
machine. Replace the name variable with the
name you specified in the Name field when
configuring from WLS Admin console, for
example, MyWebApp.

156 Deploying with WebLogic and Apache 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Re-deploy the application


If you have already deployed MicroStrategy Web Universal
with WebLogic and you change any parameters in the
web.xml file, you must re-deploy the application using the
WLS Admin Console. This allows the changes to take effect in
the deployed application.

To re-deploy the application from the WLS Admin console

1 Open the WLS Admin Console by accessing the following


address:

http://IP address:port/console/

2 Type a valid user ID and password at the prompt.

3 In the left frame, select mydomain, point to


Deployments, and then choose Web Applications. The
Web Application table opens, which lists the
MicroStrategy Web Universal applications that have been
deployed.

4 Click the application to re-deploy, such as


MicroStrategy. The information for the application
appears.

5 Perform the appropriate steps for your version of


WebLogic, as follows:
In the right frame, select the Deploy tab.
Click Redeploy. The application is re-deployed.

2005 MicroStrategy, Inc. Deploying with WebLogic and Apache 157


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Performance-based setup information


The performance of MicroStrategy Web Universal can be
increased by configuring it on various component levels.
These additional setup settings are not required, but if you
want to increase the performance of MicroStrategy Web
Universal, some changes must be done before or after the
deployment procedure. This section provides the following
configurations:

Setting the Java heap size

Precompiling JSP files

Disable/relax auto-reload parameters

Configuring Apache Web server to serve static files

Setting the Java heap size

The Java heap size for the WebLogic Server can be increased
by modifying the JAVA_OPTIONS variable in the
startWebLogic.sh script.

To increase the Java heap size

1 Open the startWebLogic.sh script from


/<WEBLOGIC_MYDOMAIN_FOLDER>/startWebLogic.
sh.

2 Look for the following line in the script:

JAVA_OPTIONS=-ms128m -mx128m

This line reflects a Java heap size of 128 MB. Set the
appropriate size. MicroStrategy recommends the initial
java heap size be set at a minimum of 500MB, assuming
the machine has enough memory space.

3 Stop and start the application server.

158 Deploying with WebLogic and Apache 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Precompiling JSP files

To avoid the time taken to load the Web pages in the


application server when you access it for the first time, you
must precompile the Java Server Pages (JSP) files before
deploying the application. Do this by setting the application
server to load all the pages in the application before
deployment. Thus, when you connect for the first time, the
pages are already loaded and the performance is better.

To precompile the JSP files

1 Open the weblogic.xml file located in the /WEB-INF


directory.

 The weblogic.xml file is located in the


MicroStrategy.war file so you must expand or
unzip the WAR file first. You can expand the WAR
file by typing jar -xvf MicroStrategy.war.

2 In the jsp-descriptor section, set the


keepgenerated and the precompile parameters to
TRUE, as follows:
<jsp-descriptor>
:
:
<jsp-param>
<param-name>keepgenerated</param-name>
<param-value>TRUE</param-value>
</jsp-param>
<jsp-param>
<param-name>precompile</param-name>
<param-value>TRUE</param-value>
</jsp-param>
:
:
</jsp-descriptor>
3 Save the file and compress the WAR file again by typing
the following command:
#jar -cvf MicroStrategy.war *

2005 MicroStrategy, Inc. Deploying with WebLogic and Apache 159


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Disable/relax auto-reload parameters

To disable/relax auto-reload parameters, complete the


following:

Set the pageCheckSeconds parameter

Set the WebLogic Reload Period parameter

Each parameter is explained below.

Set the pageCheckSeconds parameter

The pageCheckSeconds parameter sets the interval, in


seconds, at which the WebLogic Server checks to see if JSP
files have changed and need recompiling. Dependencies are
also checked and recursively reloaded if changed.

You can set the following values:

Value Description

0 Pages are checked on every request.

-1 The page is not checked until the server is restarted. Any


classes used by the JSP page that live in the servlet
classpath are also reloaded.

n Interval (in seconds) in which WebLogic Server checks if


JSP files have changed. For example, if this is set to 1,
WebLogic checks the pages every second to see if the
JSP has changed and needs recompiling.

To set the pageCheckSeconds parameter

1 Open the weblogic.xml file located in the /WEB-INF


directory.

 The weblogic.xml file is located in the


MicroStrategy.war file. You must first expand
or unzip the WAR file. You can expand the WAR
file by typing jar -xvf MicroStrategy.war.

160 Deploying with WebLogic and Apache 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

2 In the jsp-descriptor section, set the


pageCheckSeconds parameter value. For example, the
following code sets the value to -1:
<jsp-descriptor>
:
:
<jsp-param>
<param-name>pageCheckSeconds
</param-name>
<param-value>-1</param-value>
</jsp-param>
:
:
</jsp-descriptor>
3 Save the file and compress the WAR file again by typing
the following command:
#jar -cvf MicroStrategy.war *
Set the WebLogic Reload Period parameter

In WebLogic, the Reload Period parameter sets how often


WebLogic checks whether a servlet has been modified. If the
servlet has been modified, WebLogic reloads it. As the Web
Universal servlets do not change after they have been
deployed, MicroStrategy recommends that you disable the
reload period by setting it to -1. A value of -1 means never
reload, and a value of 0 means always reload.

Use the appropriate procedure below, depending on whether


or not you are using WebLogic 8.x and have Web Universal
deployed as a duplicate WAR file.

To set the WebLogic Reload Period

1 Open the WLS Admin Console by accessing the following


address:

http://IP address:port/console/

2 Type a valid user ID and password at the prompt.

2005 MicroStrategy, Inc. Deploying with WebLogic and Apache 161


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

3 Select mydomain, point to Deployments, and then


choose Web Applications. The Web Application table
opens, which lists the MicroStrategy Web Universal
applications that have been deployed.

4 Click the application to configure, such as


MicroStrategy. The information for the application
appears.

5 Select the Configuration tab.

For WebLogic 7.x select the Files tab.

For WebLogic 8.x select the Descriptor tab.

6 Type the new value. The values are:

-1 to never reload

0 to always reload

Depending on your version of WebLogic, type the value in


the following location:

For WebLogic 7.x type the new value for the Reload
Period.
For WebLogic 8.x type the new value for Servlet
Reload Check Secs.

7 Click Apply.

8 For WebLogic 7.x only, stop and start the application


server.

To set the WebLogic Reload Period in WebLogic 8.x when


MicroStrategy Web Universal is deployed as a duplicate WAR
file

1 Open the weblogic.xml file located in the /WEB-INF


directory.

 The weblogic.xml file is located in the


MicroStrategy.war file. You must expand or unzip
the WAR file first. You can expand the WAR file by
typing jar -xvf MicroStrategy.war.

162 Deploying with WebLogic and Apache 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

2 In the container-descriptor section, set the


servlet-reload-check-secs parameter value. For
example, the following code sets the value to -1:

<container-descriptor>

<servlet-reload-check-secs>-1</servlet-rel
oad-check-secs>

</container-descriptor>

3 Save the file and compress the WAR file again by typing
the following command:

#jar -cvf MicroStrategy.war *

Configuring Apache Web server to serve static


files

Because Web servers are tuned to effectively serve static files,


the perceived performance of MicroStrategy Web Universal is
significantly enhanced if image, style sheet, and JavaScript
files are served via the Apache Web server, and the WebLogic
Server handles only the servlet requests. Do this by editing
two main parameters, Alias and MatchExpression, in the
Apache configuration file httpd.conf.

The Alias parameter is used to create a virtual directory


in the Apache Web server. The virtual directory is needed
to serve static files such as images, style sheets, and
JavaScript.
The MatchExpression parameter is used to configure
the Apache plug-in so that the WebLogic Server handles
only the servlet requests.

2005 MicroStrategy, Inc. Deploying with WebLogic and Apache 163


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

To configure the Apache Web server to serve static files

1 To change the Alias parameter, add the following lines


in the httpd.conf file:

Alias
/MSTRWeb/images/"/<WEBLOGIC_MYDOMAIN_
FOLDER>/applications/MSTRWeb/images/"

<Directory
"/<WEBLOGIC_MYDOMAIN_FOLDER>/
applications/MSTRWeb/images">

Options Indexes MultiViews

AllowOverride None

Order allow, deny

Allow from all

</Directory>

 These code excerpts assume the application name


is MSTRWeb. See Deploying with WebLogic and
Apache for information on default folder structure.

2 Repeat the previous step for the JavaScript and style sheet
folders, replacing the word images in the previous code
with the folder name where the JavaScript and style sheet
files are located.

3 Change the MatchExpression parameter by typing


*/servlet/* in the MatchExpression parameter. For
example,
<IfModule mod_weblogic.c>
WebLogicHost 10.15.133.56
WebLogicPort 7001
MatchExpression */servlet/*
</IfModule>
4 Stop and start the Apache Web server using the
commands apachectl start and apachectl stop.

164 Deploying with WebLogic and Apache 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

The Web server now serves image (GIF), style sheet (CSS),
JavaScript, and all other static files, thus reducing the load on
the application server and increasing the applications
performance.

Deploying with WebSphere 5.x and IBM HTTP


Server
This section provides information used to deploy and
configure MicroStrategy Web Universal on an AIX machine
using the WebSphere 5.x Server and the IBM HTTP Web
Server.

This section includes the following information:

Preconfiguration information: Configuration that must


occur before you begin deploying Web Universal.

Deploying MicroStrategy Web Universal: Instructions


for deploying the application.
Performance-based setup information: Optional
settings to increase the applications performance.

 These additional settings are not required, but can


increase the performance of Web Universal.
Review this information prior to deployment to see
if any of these options are of interest to you.

Preconfiguration information
This section provides the preconfiguration information
necessary to deploy MicroStrategy Web Universal on your
machine. Preconfiguration includes the following step:

Locating the WAR file

This section also provides additional setup information for


the machine where the application server and Web server are
already installed.

2005 MicroStrategy, Inc. Deploying with WebSphere 5.x and IBM HTTP Server 165
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

This section uses the following configuration. While your


configuration may vary slightly, for example, you may have
different versions of these applications, the overall process
remains the same.

Requirement Recommended

Operating system AIX 5.2


Repository None

Web server IBM HTTP Server 2.0.47

Application server IBM WebSphere V5.x

JRE IBM JRE 1.3.1

 Note the following:


WebSphere 5.0.x uses IBM JDK 1.3.1 whereas
WebSphere 5.1.x uses IBM JDK 1.4.1.
For information on the version numbers certified and
supported by MicroStrategy, see the MicroStrategy
Readme file.

Locating the WAR file

The MicroStrategy Web Universal application is packaged


within a single file, called a WAR (Web ARchive) file,
following the J2EE specifications. You must deploy this file to
run the application in your application server environment.

To locate the WAR file

1 Locate the MicroStrategy.war file in the Web


Universal Deployment Directory you specified during
installation. For more information, see Installation
procedures on UNIX or Linux, page 72 in Chapter 4,
Installing MicroStrategy on UNIX and Linux.

2 Copy the WAR file to the


<WAS5_HOME>/installableApps directory, where
<WAS5_HOME> is the WebSphere 5.x application server
home path.

166 Deploying with WebSphere 5.x and IBM HTTP Server 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

The deployment process in this chapter assumes that


MicroStrategy.war file is stored in this directory.

 After deploying MicroStrategy.war file, you can


view the WEB-INF folder, which contains a subfolder
named log. The log folder retains all the log files,
except for the ncsportal.log files. They are created
in the Application server root folder. For more
information on the directory structure after deploying
the WAR file, see Directory structure after deploying
the WAR file, page 84 in Chapter 4, Installing
MicroStrategy on UNIX and Linux.

Deploying MicroStrategy Web Universal


Once your machine has the necessary settings configured,
you can deploy MicroStrategy Web Universal on the
WebSphere-AIX machine. Deployment involves the following
steps:

1 Launching the WebSphere Administrative Console

2 Starting the WebSphere default application server

3 Installing the Enterprise Application

4 Regenerating plugin-cfg.xml

5 Restarting the application server

6 Accessing the MicroStrategy Web Administrator page

7 Launching the project

 The Performance-based setup information section


provides information on additional settings to increase
application performance. These additional settings are
not required, but can increase the performance of Web
Universal. Review this information prior to
deployment to see if any of these options are of
interest to you.

2005 MicroStrategy, Inc. Deploying with WebSphere 5.x and IBM HTTP Server 167
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Launching the WebSphere Administrative


Console

The WebSphere Administrative Console can be accessed only


if the WebSphere server is started on the machine.

To start the Websphere Application Server

1 Execute the startServer script as follows:

cd <WAS5_HOME>/bin

# ./startServer.sh <SERVER_NAME>

 Typically, server1 is the default server name in


WebSphere 5.x.

2 Ensure that the Administrative Server has started


successfully. Execute the following commands:
cd <WAS5_HOME>/bin

# ./serverStatus.sh -all

To launch the WebSphere Administrative Console

In a Web browser, type the URL for the administrative


console.
The default port in WebSphere 5.0.x is 9090 for HTTP
and 9043 for HTTPS.
http://<hostname>:9090/admin
https://<hostname>:9043/admin

The default port in WebSphere 5.1.x is 7090 for HTTP and


7043 for HTTPS.
http://<hostname>:7090/admin
https://<hostname>:7043/admin

168 Deploying with WebSphere 5.x and IBM HTTP Server 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Starting the WebSphere default application


server

After you launch the WebSphere Administrative Console, you


can deploy MicroStrategy Web Universal by starting the
default application server.

 This is applicable for Websphere Network Deployment


Edition or Websphere Enterprise Edition. For
Websphere Express or Websphere Base Editions,
there is no distinction between an administrative
server and a default server. The StartServer.sh
command starts the default application server
automatically.

To start the default application server

When the WebSphere Administrative Console opens, a tree


view is displayed.

1 Expand the Servers node, or click the link to expand the


view.

2 Click the Applications Servers link. A table listing the


application servers displays to the right of the navigation
tree. This area is the Workspace.

3 Select the box next to the application server to start.

4 Click Start above the table.

Installing the Enterprise Application

To install the Enterprise Application

1 Expand Applications, and then Enterprise Applications


to display a list of installed applications.

2 Click Install.

2005 MicroStrategy, Inc. Deploying with WebSphere 5.x and IBM HTTP Server 169
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Preparing for the application installation

The following steps describe the settings that must be


specified for the installation.

To specify settings for the installation

1 Specify the path to the WAR file by selecting the Server


Path option and then typing in the full path for the
location of the MicroStrategy.war file. Type a suitable
name for ContextRoot, which is case-sensitive.

 The URL to access MicroStrategy Web Universal


(http://machine-name/ContextRoot/serv
let/mstrWeb) contains ContextRoot, which
should be replaced by any name of your choice. For
example, you can use the default name of the WAR
file, which is MicroStrategy.

2 Click Next.

3 Select Do not override existing bindings.

4 For the Default virtual host name for Web modules, select
default host.

5 Click Next. The Provide options to perform the


installation page opens. In the screens that follow, you are
selecting settings that are used during the installation.

6 Click Next.

7 Make the following changes:

Select Enable pre-compile of JSPs.

Specify the value for the Directory to Install


Application as
${APP_INSTALL_ROOT}/DefaultNode

Specify an Application Name of your choice.

Enter the value of -1 as the Reload Interval.

170 Deploying with WebSphere 5.x and IBM HTTP Server 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

8 Click Next. The Map virtual hosts for web modules page
opens.

9 Select Web Tier (default host) and click Next. The Map
modules to application servers page opens.

10 Select the application server and click Apply.

11 Select Web Tier (selected application server) and click


Next.

12 Map the admin role to the users or groups that will be


given the MicroStrategy Web Administrator privileges.
Role mapping enables the mapped users to access the
MicroStrategy Web Administrator page.

 Security must be enabled for the WebSphere


Server for this feature to work.

13 Click Next. The Summary Page opens.

14 Review the summary and click Finish. A message appears


stating that the installation and precompilation of JSPs
was successful. Save the changes to the master repository.

Regenerating plugin-cfg.xml

To regenerate plugin-cfg.xml

1 Select Environment, and then click Update WebServer


Plugin.

2 Click OK, and then click Save to master configuration.

Restarting the application server

This section explains how to stop and start the application


server. Performing these steps stops and starts all the
applications running on the application server. To stop and
start only the application in which you are working, see To
start the Web module, page 173.

2005 MicroStrategy, Inc. Deploying with WebSphere 5.x and IBM HTTP Server 171
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

To restart the application server

 The option to stop and start the application server


through the administrative console is available only
for the Websphere Network Deployment and
Websphere Enterprise Editions. To stop and start the
application server in Websphere Express and
Websphere Base editions, see below.

1 Expand the Servers node.

2 Click the Application Servers link. A table listing the


application servers and an icon indicating their status
appears:

red: stopped

green: started

3 Select the box next to the application server you want to


stop, and click Stop. The status icon changes from green
to red.

4 Select the application server you want to start and click


Start. The application server starts and the status icon
changes to green.

To stop and start the application server in Websphere


Express and Websphere Base editions, use the following
commands:
stopServer.sh server1 to stop the application
server

startServer.sh server1 to start the application


server.

172 Deploying with WebSphere 5.x and IBM HTTP Server 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Starting the Web module

This process starts only the Web application, rather than all
the applications running on the application server. To stop
and start all applications, see Restarting the application
server, above.

To start the Web module

1 Expand Applications.

2 Click the Enterprise Applications link. A list of installed


applications are displayed in the table to the right, along
with icons indicating their status:

red: stopped

green: started

3 Select the box next to the application to start and click


Start.

Controlling access to the MicroStrategy Web


Administrator page

The Web Administrator page (mstrWebAdmin servlet) is


accessible only to users with an administrator role. To create
the set of users and passwords that are authorized to access
the administrator page, you must create the necessary role
mapping between these users and the admin role for the
MicroStrategy Web Universal application. Refer to your IBM
documentation for more information, or contact
MicroStrategy Technical Support.

2005 MicroStrategy, Inc. Deploying with WebSphere 5.x and IBM HTTP Server 173
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Accessing the MicroStrategy Web Administrator


page

Before you start MicroStrategy Web Universal, you must


configure the Web Administrator page, which is the
mstrWebAdmin servlet.

To access the MicroStrategy Web Administrator page

1 Access the mstrWebAdmin servlet by typing the following


URL in a Web browser:
http://IPAddress/context_root/servlet/
mstrWebAdmin

where context_root is the name you provided for the


Context root for Web Module box in the Preparing for
the application installation page. For example, the default
name of the WAR file, which is MicroStrategy. For
more information, refer to Preparing for the application
installation, page 170.

 The servlet names are case-sensitive. Use the


correct case when typing the mstrWebAdmin
name. If the application server is enabled with
security, a dialog box related to the administrator
authentication opens.

2 Type the user ID and password assigned with the


administrator role.

3 After you are authenticated, the MicroStrategy Web


Administrator page opens. Use it to add and connect to an
Intelligence Server.

Proceed to launch the MicroStrategy Web Universal project.


For more information, see Launching the project
immediately below.

174 Deploying with WebSphere 5.x and IBM HTTP Server 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Launching the project

After configuring the Web Administrator page, you must


follow the steps described in this section to launch your
project.

To launch the project

1 Start the Apache Web server by using the following


command:

# /usr/<HTTPServer>/bin/apachectl start

For example, if the IBM HTTP server is installed in the


default location /usr/IBMIHS, then use the following
command:

/usr/IBMIHS/bin/apachect1

2 In a Web browser, specify the following URL:

http://<machine-name>/<context_root>/
servlet/ mstrWeb

Alternatively, you can use the IP address of your machine


for remote access, as shown below:
http://<IPaddress>/<context_root>/servlet/
mstrWeb

 provided
In these addresses, context_root is the name you
for the Context root for Web Module box
on Preparing for the application installation page. For
example, the default name of the WAR file, which is
MicroStrategy. For more information, refer to
Preparing for the application installation, page 170.

You can now access the MicroStrategy Web Universal


application.

2005 MicroStrategy, Inc. Deploying with WebSphere 5.x and IBM HTTP Server 175
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Uninstalling MicroStrategy Web application

You can uninstall the MicroStrategy Web Universal


application through the WebSphere Administrative console.

To uninstall MicroStrategy Web application

1 Expand Applications.

2 Click Enterprise Applications. A list of installed


applications are displayed in the table to the right.

3 Select the desired MicroStrategy Web application.

4 Click Uninstall.

5 Save the configuration in the master repository.

Performance-based setup information


The performance of MicroStrategy Web Universal can be
increased by configuring it on various component levels.
These additional settings are not necessary, but can increase
the performance of MicroStrategy Web Universal. This
section explains the following changes:

Setting the Java heap size


Precompiling JSP files

Disable/relax auto-load parameters

Configuring the IBM HTTP Server to serve static files

176 Deploying with WebSphere 5.x and IBM HTTP Server 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Setting the Java heap size

You can increase the Java heap size for a given application
server by configuring the WebSphere Administrative
Console.

To increase the Java heap size

1 Access the Administrative Console.

2 Expand the Servers node.

3 Click the Application Servers link to view the list of


application servers.

4 Click the application server name, scroll to Additional


Properties and click Process Definition.

5 Click JVM Settings to set the Java heap size settings.


MicroStrategy recommends that you initially set the java
heap size to a minimum of 500MB, assuming the machine
has enough memory space.

6 Click Apply and save your changes.

7 Stop and start the application server.

Precompiling JSP files

To avoid the time taken to load the Web pages in the


application server when you access it for the first time, you
must precompile the Java Server Pages (JSP) files.
Precompilation can be done during deployment by selecting
the Enable pre-compile of JSPs setting. Otherwise, it can
be done after deploying the application.

To precompile the JSPs after deployment, set the application


server to load all the pages in the application. Then when you
connect for the first time, the pages are already loaded and
performance is improved.

2005 MicroStrategy, Inc. Deploying with WebSphere 5.x and IBM HTTP Server 177
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Before you precompile the JSP files, make sure that:

The MicroStrategy Web Universal application is deployed


in the WebSphere environment.

You know the defined application name and the Web


Modules name. You can retrieve these names from the
Administrative Console. Locate the application name
under the Enterprise Applications node. Locate the Web
Module name by expanding the application and clicking
Web Modules. The default name is Web Tier.

To precompile the JSP files

1 Change the directory to <WAS_ROOT>/bin.

2 Run the following command:


./JspBatchCompiler.sh -enterpriseapp.name
ApplicationName -webmodule.name webModule
-cell.name cellName -node.name nodeName
-server.name serverName -keepgenerated
TRUE
If the administrative server is running in a security
enabled mode, you are prompted for the user ID and
password to connect to the Admin server.

username userID

password password

3 For each JSP file compiled without error, the following


message appears: Code generation successful.

Disable/relax auto-load parameters

Application servers typically reload certain resources more


often than necessary in a production environment. To disable
or relax such parameters to improve system performance, see
the application servers documentation.

178 Deploying with WebSphere 5.x and IBM HTTP Server 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Configuring the IBM HTTP Server to serve static


files

The IBM HTTP Server (Web server) is tuned to effectively


serve static files. As a result, perceived performance is greatly
enhanced if you configure the IBM HTTP Server to serve
image, style sheet, and JavaScript files. This also reduces the
load on the WebSphere Server so that it can handle only
dynamic files while IBM HTTP Server handles static files.
This requires that you do the following:

Configure the application server level to serve the Java


Server Pages (JSPs) and servlets, which are dynamic files
and handled by WebSphere.

Configure the Web server level to serve the images,


JavaScripts, and style sheets, which are static files and
handled by the IBM HTTP Server.

For more information, see the IBM WebSphere Application


Server V5.0 redbook covering System Management and
Configuration. This book discusses separating static content
from dynamic content.

Deploying with Sun ONE (iPlanet) 8.0


This section provides information used to deploy and
configure MicroStrategy Web Universal on a Sun ONE
application server (previously known as iPlanet) in a
UNIX/Linux environment. It includes the following
information:

Preconfiguration information: Configuration that must


occur before you begin deploying Web Universal.
Deploying MicroStrategy Web Universal: Instructions
for deploying.

Performance-based setup information: Optional


settings to increase the applications performance.

2005 MicroStrategy, Inc. Deploying with Sun ONE (iPlanet) 8.0 179
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

 These additional settings are not required, but can


increase the performance of Web Universal. Review
this information prior to deployment to see if any of
these options are of interest to you.

Undeploying MicroStrategy Web Universal using the


command line utility: Instructions for undeploying Web
Universal.

 Throughout this guide iPlanet is referred to as Sun


ONE (iPlanet). Sun Microsystems purchased iPlanet
and renamed it Sun ONE Application Server.

Preconfiguration information
This section provides the preconfiguration information
necessary for deploying MicroStrategy Web Universal on
your machine. This includes:

Locating the WAR file

It also provides additional setup information that needs to be


done on the machine on which the application server and
Web server are already installed.

UNIX/Linux environment

The following table shows the recommended machine


configuration to deploy MicroStrategy Web Universal with
Sun ONE (iPlanet) 8.0 in a UNIX/Linux environment:

Requirement Recommended

Operating system Solaris 8


Web server iPlanet Web Server 6.x

Application server Sun ONE (iPlanet) Application Server 8.0

JRE SUN JRE 1.3.1

For information on the version numbers certified and


supported by MicroStrategy, see the MicroStrategy Readme
file.

180 Deploying with Sun ONE (iPlanet) 8.0 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Windows environment

The following table shows the recommended machine


configuration for deploying MicroStrategy Web Universal in
a Windows environment:

Requirement Recommended

Operating system Windows 2000/2003 Server

Web server iPlanet Web Server Enterprise Edition 6.0 SP5

Application server Sun ONE (iPlanet) Application Server 8.0

JRE and JDK Java 2 Platform, Standard Edition (J2SE) for


Windows

 Make sure you install both the JRE and JDK for
running Sun ONE (iPlanet) on the Windows
environment.

For information on the version numbers certified and


supported by MicroStrategy, see the MicroStrategy Readme
file.

Locating the WAR file

The MicroStrategy Web Universal application is packaged


within a single file, called a WAR file (Web ARchive),
following the J2EE specifications. You must deploy this WAR
file to run the application in your application server
environment.

The Web Universal WAR file (MicroStrategy.war)is


located in the Web Universal deployment directory you
specified during installation. For more information, see
Installation procedure, page 50.

2005 MicroStrategy, Inc. Deploying with Sun ONE (iPlanet) 8.0 181
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

 After deploying the MicroStrategy.war file, you


can view the WEB-INF/log folder. The log folder
retains all the log files except for the ncsportal.log
files, which are created in the application server root
folder. For more information on the directory
structure after deploying the WAR file, see Directory
structure after deploying the WAR file, page 84 in
Chapter 4, Installing MicroStrategy on UNIX and
Linux.

Deploying MicroStrategy Web Universal


Once your machine has been configured, you can deploy
MicroStrategy Web Universal with Sun ONE (iPlanet) 8.0.

 The Performance-based setup information section


provides information on additional settings that can
increase application performance. These additional
settings are not required but can increase the
performance of Web Universal. Review this
information prior to deployment to see if any of these
settings are of interest to you.

The deployment involves the steps below, which are


explained in detail in the following sections:

1 Launching the Sun One Application Server Admin


Console

2 Deploying MicroStrategy Web Universal

3 Accessing the MicroStrategy Web Administrator page

4 Connecting to the project page

 The administration and deployment tools in Sun ONE


(iPlanet) 8.0 have the same interface regardless of the
operating system on which they run. Therefore, the
deployment process is the same for all operating
systems, and is described below. There are some
minor changes in the Windows environment, which
are highlighted where necessary.

182 Deploying with Sun ONE (iPlanet) 8.0 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Launching the Sun One Application Server


Admin Console

This procedure describes the steps to launch the Sun One


Application Server.

To launch the Sun One Application Server Admin Console

1 Access the Sun One Application Server Admin Console by


typing the following URL:

http://<machine_name>:<admin_port>

where machine_name is the IP address or the name of


the machine where you installed Sun One, and
admin_port is the administration server port you
provided during the installation. By default, the
admin_port is 4848.

 Inpointa Windows environment, from the Start menu,


to Programs, then Sun MicroSystems, then
Application Server 8.0, and then choose Admin
Console.

2 Enter the user name and password that you provided


during the installation.

 Bypassword
default, the user name is admin. There is no
set by default. It is mandatory for you to
assign a password during the installation.

3 If the Administration Server is not running, an error


message appears. To start the Administration Server,
navigate to the following directory in the command
prompt:

<install-dir>/bin

and type the following command:

>asadmin start-domain domain1

where domain1 is the default domain server, or the


server you are currently working on.

2005 MicroStrategy, Inc. Deploying with Sun ONE (iPlanet) 8.0 183
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Once the Administration Server starts, type the URL to


access Administration Server.

4 If the Administration Server is running, the following


messages appear:

>asadmin start-domain domain1

Starting Domain domain1, please wait.

Log redirected to
C:\Sun\AppServer8\domains\domain1\logs\ser
ver.log.

Domain domain1 is ready to receive client


requests. Additional services are being
started in background

Deploying MicroStrategy Web Universal

After launching the Sun One Application Server Admin


Console, follow the steps below to deploy MicroStrategy Web
Universal as a WAR file.

To deploy MicroStrategy Web Universal as a WAR file

1 Access the Admin Console.

2 Enter the user name and password that you assigned


during the installation. By default, the user name is
admin.

3 Expand the Application Server tree view.

4 Expand Applications under the server you are using. By


default, the application server created is server1.

5 Select Web Applications and click Deploy. Deploy Web


Module opens in the right pane.

6 Type the full path or browse to the location where you


want to deploy the WAR file.

184 Deploying with Sun ONE (iPlanet) 8.0 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

7 Select or clear the following check boxes according to your


requirements:

Redeploy if already exists

Run Verifier

Precompile JSPs

 Itcheck
is recommended you select the Precompile JSPs
box to quickly load the Web pages in the
application server when you access it for the first
time.

Virtual Servers

8 Click OK.

Controlling access to the MicroStrategy Web


Administrator page

For security purposes, you must only assign certain users the
authorization to access the MicroStrategy Web Administrator
page. To do this, map the Admin security role to only those
users for whom you want to grant permission to work in the
MicroStrategy Web Administrator page.

Sun ONE (iPlanet) 8.0 supports the following authentication


realms:

file
admin-realm

certificate

 Asecurity
realm, also called a security policy domain or
domain, is a scope over which a common
security policy is defined and enforced by the security
administrator of the security service. For more
information, see the following resource:
http://docs.sun.com/db/prod/s1.asse#hic

2005 MicroStrategy, Inc. Deploying with Sun ONE (iPlanet) 8.0 185
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

In Sun One (iPlanet) 8.0, the file realm is selected by default.


To create users in the default realm, click File, then click
Manage Users to start creating users authorized to access
the MicroStrategy Web Administrator page.

Mapping security role

A descriptor file, sun-web.xml, enables Sun One to map the


existing users or groups to different security roles. This file is
located in the <webapplication_root_dir>/WEB-INF
folder. You can modify this file if you want to change the
default values for security roles.

The contents of this file are as follows:

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE sun-web-app PUBLIC "-//Sun


Microsystems, Inc.//DTD Application Server
8.1 Servlet 2.4//EN"
"http://www.sun.com/software/appserver/dtds/s
un-web-app_2_4-1.dtd">

<sun-web-app
xmlns="http://java.sun.com/xml/ns/j2ee">

<context-root>/MicroStrategy</context-root>

<security-role-mapping>

<role-name>admin</role-name>

<principal-name>admin</principal-name>

</security-role-mapping>

</sun-web-app>

186 Deploying with Sun ONE (iPlanet) 8.0 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

For mapping security roles to users and user groups, the


sun-web.xml file assumes the default values that are
provided during installation of Sun One 8.0 (iPlanet) and
deployment of MicroStrategy Web Universal. The following
are the values taken for context-root, role mapping, and the
user or principal user:

Context-root is set to MicroStrategy. This is the default


value for the context name when deploying MicroStrategy
Web Universal.
Role mapping is set to admin. This is the default value
specified in the web.xml file.

The user or principle name is also set to admin. This is the


default name assigned to the user when installing Sun
One 8.0 (iPlanet).

 Ifrole,youormake changes to the default values of context,


user name while installing Sun One 8.0
(iPlanet) or deploying MicroStrategy Web Universal,
be sure that you update the sun-web.xml file before
you deploy MicroStrategy Web Universal.

Accessing the MicroStrategy Web Administrator


page

When installing Sun One 8.0 (iPlanet), the user that you
create is saved in the admin realm. By default, the user name
is admin. You must enable this admin user to access the
MicroStrategy Web Administrator page.

To access the admin user, you must change the default realm,
file, to the admin realm.

To access the MicroStrategy Web Administrator page

1 Expand Configuration from the tree view, and select


Security. Security features are displayed on the right
pane.

2 Select the admin realm from the Default Realm


drop-down list.

2005 MicroStrategy, Inc. Deploying with Sun ONE (iPlanet) 8.0 187
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

3 Click Save to change the default realm.

4 Stop and restart the application server. For more


information, see Restarting the application server,
page 188.

Restarting the application server

You must stop and restart the application server instance to


apply changes. This is necessary after most changes to the
application server configuration, such as creating a user.

To restart the application server

After changing the application server configuration or


creating a user, a message Apply Changes Required is
displayed.

1 Click on the message Apply Changes Required.

If the server must be restarted, the Restart Required


message is displayed.

2 Click Restart.

You can also restart the application server by navigating


through the left menu, as follows:

1 Expand Application Server.

2 Select the server instance you are currently working on


and click the Stop Instance button displayed on the right
panel. The Sun Java System Application Server
Administration Console window opens.

3 Follow the instructions given in the Sun Java System


Application Server Administration Console window to
stop and restart the application server.

After restarting the application server, follow the procedure


below to connect to the project page.

188 Deploying with Sun ONE (iPlanet) 8.0 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Connecting to the project page

After restarting the application server, follow the steps


described here to connect to the project page.

To connect to the Project page

In a Web browser, type the following URL:

http://machine_name:HTTP_port/context

If you have used all the default variables, you can access
the following URLs:

http://localhost:80/MicroStrategy/

or

http://localhost:80/MicroStrategy/servlet/
mstrWeb

You are now ready to use MicroStrategy Web Universal.

Performance-based setup information


The performance of MicroStrategy Web Universal can be
increased by configuring various components. These
additional settings are not necessary, but they can improve
the performance of Web Universal. This section provides the
following configurations:
Setting the Java heap size

Undeploying MicroStrategy Web Universal using the


command line utility, after deployment

2005 MicroStrategy, Inc. Deploying with Sun ONE (iPlanet) 8.0 189
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Setting the Java heap size

The maximum Java heap size, which handles all the Java
requests, is set to 512MB by default.

To set the Java heap size

1 Navigate to Application server.

2 Click JVM Settings and select JVM Options. You can


view the argument -Xmx512. This is the default value for
the maximum heap size.

3 Click Add JVM Options to include additional arguments


using -Xmx -Xms. For example, if you want to set the
maximum heap size to 1GB and minimum heap size to
512MB, then the argument you provide is -Xmx1024m
and -Xms512m.

Undeploying MicroStrategy Web Universal using


the command line utility

Sun recommends undeploying an application before


deploying a newer version. To undeploy an existing
MicroStrategy Web Universal application, use the following
command:

-undeploy -user admin-user -password password


-port4849 MicroStrategy

You are not required to provide the path to the WAR file.
When an application is deployed, Sun ONE (iPlanet) saves a
copy of the WAR file under the <install-dir>/ias/JARS
folder and looks for that copy when undeploying.

After the undeployment is finished, stop and restart the


application server for the changes to take effect.

190 Deploying with Sun ONE (iPlanet) 8.0 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Deploying with Tomcat (Linux)


This section provides information on how to deploy and
configure MicroStrategy Web Universal with Tomcat in a
Linux environment.

This chapter has the following sections:

Preconfiguration information: Configuration that must


occur before you begin deploying Web Universal

Deploying MicroStrategy Web Universal: Instructions for


deploying, including detailed steps

Preconfiguration information
This section provides the preconfiguration information
necessary to deploy MicroStrategy Web Universal with
Tomcat on your Windows machine.

Installing the JDK

Configuring the JDK

Installing Tomcat

Configuring Tomcat

Locating the WAR file

This section uses the following setup. While your setup may
vary slightly, for example, you may have different versions of
these applications, the overall process remains the same.

Requirement Recommended

Operating system RedHat Enterprise Linux AS Version 3 (64-bit)


update 3 -OR- Version 4 (64-bit)

Application server Tomcat 5.x

JDK SUN JDK 1.3.1 -OR- 1.4.2

2005 MicroStrategy, Inc. Deploying with Tomcat (Linux) 191


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Installing the JDK

If you have not installed SUN JDK 1.3.1 or 1.4.2 yet,


download it from the
http://java.sun.com/j2se/<version>/
download.html website, where <version> is 1.3 or 1.4.
Be sure to install the JDK, not the JRE.

From the location in which to install the JDK, run the


following shell file:

j2sdk-<version>_08-linux-i586.bin

For example, to install version 1.4.2, type the following:

j2sdk-1_4_2_08-linux-i586.bin

Configuring the JDK

After you install the Sun JDK, you must configure it.

To configure the JDK

1 Open the /etc/profile file using a program that allows


you to edit the file.

2 Add the following line:


JAVA_HOME=/<path_name>/j2sdk<version>_08;
export JAVA_HOME

where <path_name> is the destination folder where you


installed the JDK and <version> is the version, such as
1.4.2, of JDK.

 Ifxalan.jar
you are using Sun JDK 1.4.x, you must remove the
and xerces.jar files once you have
deployed MicroStrategy Web Universal because they
conflict with the JRE parser. The files are located by
default in the following location:

<tomcat_home>\webapps\MicroStrategy
<version>\WEB-INF\lib

192 Deploying with Tomcat (Linux) 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Installing Tomcat

If you have not installed Tomcat 4.0 yet, download it from the
http://jakarta.apache.org/site/downloads/down
loads_tomcat-5.cgi website. For Linux, you need the
jakarta-tomcat-Y.M.D.zip file, for example,
jakarta-tomcat-4.1.29.zip.

From the location in which to install Tomcat, uncompress the


file with the following command:

untar jakarta-tomcat-Y.M.D.zip

Instructions for downloading and installing Tomcat are also


available on the Apache website.

Configuring Tomcat

After you install Tomcat, you must configure it by editing the


following files in the <Tomcat directory>/bin directory,
where <Tomcat directory> is the directory in which
Tomcat is installed:

startup.sh

shutdown.sh

setclasspath.sh

To edit the startup.sh file

1 Type the following command to edit the startup.sh


file:

dtpad startup.sh

2 Set the JAVA_HOME variable to the location where JDK is


installed.

3 Save and close the file.

2005 MicroStrategy, Inc. Deploying with Tomcat (Linux) 193


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

To edit the shutdown.sh file

1 Type the following command to edit the shutdown.sh


file:

dtpad shutdown.sh

2 Set the JAVA_HOME variable to the location where JDK is


installed.

3 Save and close the file.

To edit the setclasspath.sh file

1 Type the following command to edit the


setclasspath.sh file:
dtpad setclasspath.sh

2 Set the CLASSPATH variable to the following:

<tomcat-directory>/server/lib

where <tomcat-directory> is the location where


Tomcat is installed.

3 Save and close the file.

Locating the WAR file

The MicroStrategy Web Universal application is packaged


within a single file, called a WAR file (Web ARchive),
following the J2EE specifications. You must deploy the WAR
file to run the application in your application server
environment.

The Web Universal WAR file (MicroStrategy.war) is


located in the path you specified when installing Web
Universal. The default location is
/<Install_directory>/MicroStrategy/Web JSP/.

194 Deploying with Tomcat (Linux) 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

To deploy the MicroStrategy.war file, you must follow a


set of steps that are specific to the application server you are
using. For more details, see your application server vendor
documentation or follow the instructions within this guide.
You should also follow any relevant preconfiguration
instructions within this chapter.

 After deploying the MicroStrategy.war file, you


can view the WEB-INF folder, which contains a
subfolder named log. The log folder retains all the
log files except for the ncsportal.log files. They are
created in the Application server root folder. For more
information on the directory structure after deploying
the WAR file, see Directory structure after deploying
the WAR file, page 84 in Chapter 8, Configuring and
Deploying MicroStrategy Web Universal.

Deploying MicroStrategy Web Universal


After you have performed the configurations described
above, you can begin deploying MicroStrategy Web Universal
with Tomcat. This involves the following steps:

1 Deploying using Tomcat as a standalone Web container

2 Accessing the MicroStrategy Web Administrator page

3 Launching the project

2005 MicroStrategy, Inc. Deploying with Tomcat (Linux) 195


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Deploying using Tomcat as a standalone Web


container

To deploy MicroStrategy Web Universal using Tomcat as a


standalone Web container

1 Copy the MicroStrategy.war file to the


<tomcat-directory>\webapps directory.

2 In the <tomcat-directory>/bin, type startup.sh


to start Tomcat, which deploys automatically. There is
now a MicroStrategy folder under the
<tomcat-directory>\webapps directory.

Controlling access to the MicroStrategy Web


Administrator page

The Web Administrator page, mstrWebAdmin servlet, is


accessible only to users with an admin role. To create a user
and password set that is authorized to access the
Administrator page, you must create the users and assign
them the admin role under the Tomcat user configuration
file.

To control access to the MicroStrategy Web Administrator


page

1 In the <tomcat-directory>/conf directory, open the


tomcat-users.xml file using a program that allows you
to edit the file.

2 Add the following tags and save the file:

<role rolename=admin/>

<user username=admin password=admin


roles=admin/>

<user username=system
password=goldengate roles=admin/>

196 Deploying with Tomcat (Linux) 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

 password
You can specify any value in the user name and
fields. These are used to log in to the
MicroStrategy Web Administrator page. The
roles field must be admin.

3 Stop and restart Tomcat.

Now you can start Web Administrator to add and connect to


an Intelligence Server. To configure MicroStrategy Web
Administrator, see Accessing the MicroStrategy Web
Administrator page, page 197.

Accessing the MicroStrategy Web Administrator


page

 Before you begin this procedure, be sure you have


removed the xalan.jar and xerces.jar files, as
directed in the warning in the Configure the JDK
section, above.

To configure the MicroStrategy Web Administrator page

1 In a Web browser, access the MicroStrategy Web


Administrator page by specifying the following URL:
http://localhost:8080/MicroStrategy/

servlet/mstrWebAdmin

The servlet names are case-sensitive. Be sure to use the


correct case when typing the mstrWebAdmin name. If
the application server is enabled with security, a dialog
box related to the administrator authentication opens.

2 When prompted for a user name and password, use the


same values you specified in the tomcat-users.xml
file.

3 When you log in, the MicroStrategy Web Administrator


page is displayed.

4 Add and connect to an Intelligence Server.

2005 MicroStrategy, Inc. Deploying with Tomcat (Linux) 197


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Proceed to launch the Web Universal project. For more


information, see Launching the project, page 198.

Launching the project

In a Web browser, access MicroStrategy Web Universal using


the following URL:
http://localhost:8080/MicroStrategy/servlet/
mstrWeb
MicroStrategy Web Universal is ready to use.

198 Deploying with Tomcat (Linux) 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Deploying with Oracle 10g


This chapter provides information used to deploy and
configure MicroStrategy Web Universal on the Windows
2000 operating system with Apache as the Web server and
Oracle 10g as the application server.

This chapter has the following sections:

Preconfiguration information: Configuration that must


occur before you begin deploying Web Universal.

Deploying MicroStrategy Web Universal: Instructions for


deploying, including detailed steps.

Preconfiguration information
This section provides the preconfiguration information
necessary to deploy MicroStrategy Web Universal on your
machine. The following are covered in this section:

Locating the WAR file

Modifying the XML parser used by the application server

This section uses the following setup. While your setup may
vary slightly, for example, you may have different versions of
these applications, the overall process remains the same.

Requirement Recommended

Operating system Windows 2000

Application server Oracle 10g 9.0.x


Web server Apache

JRE SUN JRE 1.4.x

2005 MicroStrategy, Inc. Deploying with Oracle 10g 199


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Locating the WAR file

The MicroStrategy Web Universal application is packaged


within a single file, called a WAR file (Web ARchive),
following the J2EE specifications, which you must deploy to
run the application in your application server environment.

The Web Universal WAR file (MicroStrategy.war) is


located in the path you specified when installing Web
Universal. The default location is C:\Program
Files\MicroStrategy\WebUniversal\ServerApps.

To deploy the MicroStrategy.war file, you must follow a


set of steps that are specific to the application server you are
using. For more details, see your application server vendor
documentation or follow the instructions within this guide.

 After deploying the MicroStrategy.war file, you


can view the WEB-INF folder, which contains a
subfolder named log. The log folder retains all the
log files except for the ncsportal.log files. They are
created in the application server root folder. For more
information on the directory structure after deploying
the WAR file, see Directory structure after deploying
the WAR file, page 84 in Chapter 4, Installing
MicroStrategy on UNIX and Linux.

Modifying the XML parser used by the


application server

The Web application class loader in Oracle 10g by default


looks for a class under the Oracle common library before the
individual Web application library. This creates some parsing
issues when using MicroStrategy Web Universal without
further configuration. To ensure that the Oracle application
server uses the XML/XSL parser distributed in MicroStrategy
Web Universal, follow the steps below.

200 Deploying with Oracle 10g 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

To use the correct XML parser in Oracle 10g

1 Unzip the MicroStrategy.war file and copy the


xerces.jar and xalan.jar files in the
MicroStrategy/WEB-INF/lib directory.

2 Paste the xerces.jar and xalan.jar files to the


following directory:
<ORACLE_10g_HOME>\jdk\jre\lib\ext

3 Keep a copy of the MicroStrategy.war file. You will


need it later when deploying Web Universal on the Oracle
application server.

Deploying MicroStrategy Web Universal


After your machine is configured, you can start the
deployment of MicroStrategy Web Universal with Oracle 10g.

To deploy Web Universal, perform the following procedures:

1 Deploying using the Oracle Enterprise Manager

2 Accessing the MicroStrategy Web Administrator page

3 Launching the project

Deploying using the Oracle Enterprise Manager

You can access Oracle Enterprise Manager from the following


url:

http://machine_name:1810

2005 MicroStrategy, Inc. Deploying with Oracle 10g 201


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

To deploy with the Oracle Enterprise Manager

1 Start the Apache Web Server. From the Start menu, point
to OracleAS 10g - DEFAULT_HOME1, and then choose
Start
<application_server_name>.<machine_name>.<doma
in>.

2 To verify that the Apache Web Server has started, access


the Oracle Enterprise Manager, select HTTP Server and
click Start.

3 Select the OC4J instance where you want to deploy


MicroStrategy Web Universal.

4 Click Deploy WAR file. The Deploy Web Application page


opens.

 You can deploy the WAR file or the EAR file. The
procedure for deploying the WAR file and EAR file
is the same.

5 For the Web Applications field, click Browse, then locate


and select the MicroStrategy.war file.

6 Type the Application name, such as MicroStrategy.

7 In the Map to URL box, type / before the name you


specified in Application name, such as
/MicroStrategy.

8 Click Deploy.

Controlling access to the MicroStrategy Web


Administrator page

The Web Administrator page (mstrWebAdmin servlet) is


accessible only to users with an admin role. To control access
to it, map the admin security role to only those users for
whom you want to grant permission to work in the Web
Administrator page. In Oracle 10g, the security users and
groups are defined in the Oracle Enterprise Manager.

202 Deploying with Oracle 10g 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

To map a security role in Oracle 10g

1 Access the Oracle Enterprise Manager.

2 Click the OC4J instance where you have deployed Web


Universal.

3 Click the application name, such as MicroStrategy. A


page displaying the Web Module opens.

4 Under Administration, click Security.

5 Click Add Group. Type the group name to which you


want to assign the admin role, for example Group1. Save
the group.

6 Click Add User. Type the user name and assign the
password. Make sure that the user is a member of the
group you created in the previous step. Save the user(s).

7 In the <ORACLE 10g_HOME>\j2ee\<OC4J instance


name>\application-deployments\MicroStrateg
y directory, edit the oracle
orion-application.xml file.

8 At the bottom of the file just before the </


orion-application> tag, add the following:
<security-role-mapping name=admin>
<group name=group1 />
</security-role-mapping>

 The group name must match the name of the


group you created above. The
security-role-mapping name must be
admin.

9 Save the file.

10 Stop and restart the Apache server.

Now you can access MicroStrategy Web Administrator page


to add and connect to an Intelligence Server. For information
about this, see Accessing the MicroStrategy Web
Administrator page, page 197.

2005 MicroStrategy, Inc. Deploying with Oracle 10g 203


8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Accessing the MicroStrategy Web Administrator


page

To configure the MicroStrategy Web Administrator page

1 In a Web browser, access the MicroStrategy Web


Administrator page by specifying the following URL:

http://IP_address/MicroStrategy/servlet/ms
trWebAdmin

where IP address is the IP address of the Oracle


machine. The servlet name is case-sensitive. Be sure to
use the correct case when typing the mstrWebAdmin
name. If the application server is enabled with Security, a
dialog box related to the administrator authentication
opens.

2 When prompted for a user name and password, specify


the values you used earlier when creating the user
mapped to the security role. For more information, refer
to the steps described in Controlling access to the
MicroStrategy Web Administrator page, page 173.

3 After you log in, the MicroStrategy Web Administrator


page appears.

4 Add and connect to an Intelligence Server.

You can now launch the MicroStrategy Web Universal


project. For details, see Launching the project, page 198.

Launching the project

In a Web browser, access MicroStrategy Web Universal using


this URL:
http://IP address/MicroStrategy/servlet/
mstrWeb
where IP address is the IP address of the Oracle machine.

The projects on the Intelligence Server appear, and you are


ready to use MicroStrategy Web Universal.

204 Deploying with Oracle 10g 2005 MicroStrategy, Inc.


Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Using the MicroStrategy Web Administrator


Console
The MicroStrategy Web Administrator page allows you to
configure and manage MicroStrategy Web Universal
connections to MicroStrategy Intelligence Servers.
Specifically, you can do the following:

Connect or disconnect MicroStrategy Web Universal from


MicroStrategy Intelligence Servers

Modify MicroStrategy Intelligence Server property


settings

Configure MicroStrategy Web Universal to recognize


MicroStrategy Narrowcast Server and enable the
Scheduled E-mail and Send Now options

Configure MicroStrategy Web Universal logging and


statistics information, and view log files

Configure security options for MicroStrategy Web


Universal

After you deploy MicroStrategy Web Universal and log on to


the mstrWebAdmin servlet, the MicroStrategy Web
Administrator Page opens.

The four main options you use to configure MicroStrategy


Web Universal appear under the heading Web Server. You
can expand the links on the left to display sub-options. Under
Need help? is a link for the online help. The page displays the
following four settings:
Intelligence Servers page

Narrowcast Server Integration page

Diagnostics page

Security

2005 MicroStrategy, Inc. Using the MicroStrategy Web Administrator Console 205
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Intelligence Servers page


The Intelligence Servers page is the default page you see
when you log in to the Administrator Page. It displays
information in the following sections:

Connected servers: Displays the list of connected


Intelligence Servers. Click Disconnect to disconnect a
server.
Unconnected servers: Displays the list of disconnected
Intelligence Servers. Click Connect to connect a server.

Add a server manually: Allows you to add and connect


to a new Intelligence Server.

 Ifaccessed,
this is the first time the Administrator Page has been
the first two sections do not have any
Intelligence Servers listed.

When you disconnect a server from the connected list, or if


the server is stopped, all configuration information about the
server is saved and you can connect again. The Administrator
Page displays configuration settings for all connected and
disconnected servers.

You can perform the following tasks from the Intelligence


Servers page:

Add and connect to an Intelligence Server

Configure or modify server properties

Add and connect to an Intelligence Server

To work with the Administrator Page, you must add and


connect to an Intelligence Server.

To add and connect to an Intelligence Server

1 In the Add a server manually box, type the name of the


Intelligence Server to add.

206 Using the MicroStrategy Web Administrator Console 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

2 To configure advanced options for the specified


Intelligence Server connection, click Add. The Server
Properties page appears. Change settings as necessary.
For a description of the settings, see Configure or modify
server properties, page 207.

3 Click Connect. This saves any changes you may have


made and connects to the Intelligence Server. The server
is added and is displayed in the Connected Servers list.
Clicking Save only saves the connection settings you
specify in the page.

 ToModify
change the server properties at a later time, click
in the Connected Servers section. You can also
click Disconnect to disconnect the server.

Configure or modify server properties

The Default Server Properties page and Server Properties


page allow you to configure advanced options for the
Intelligence Server being added. In both these pages you can
update the server properties such as connection mode, pool
size, login modes, and so on.

The difference between the Default Server Properties page


and Server Properties page is that, in the Server Properties
page the Project List, Server busy timeout, and Request
timeout options are not displayed. The Delete button, which
is used to delete the Intelligence Server and remove it from
the Connected or Unconnected servers list is also not
available.

These pages can be accessed using the following procedures:

To access the Default Server Properties page

Click Default properties, the Default Server Properties page


opens.

2005 MicroStrategy, Inc. Using the MicroStrategy Web Administrator Console 207
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

To access the Server Properties page

Do one of the following:

In the Connected Servers or Unconnected Servers list,


click Modify next to any of the servers. The Server
Properties page opens, providing additional details and
parameters for that server.

When you add an Intelligence Server for the first time,


you can click Add to open the Server properties page. This
page displays the following options:

Options Description

Connection
Properties:

Server name: This Displays the name of the MicroStrategy Intelligence


is not displayed in Server for which you are configuring the connection
the Server properties.
Properties page.

Connected Indicates whether the Intelligence Server is currently


connected.

Connect mode Determines whether an Intelligence Server connects


automatically or manually. The options for the connect
mode of Intelligence Server are:
Automatically connect to Intelligence Server
when Web Server or Intelligence Server is
restarted: Specifies that the Web server reconnects
to the Intelligence Server when the Web server is
started or restarted, or when the Intelligence Server
is restarted. By default, this check box is cleared.
MicroStrategy recommends using this setting for
production environments.
User manually connects Web to Intelligence
Server: Specifies that the administrator must actively
create the connection by clicking the Connect button
in the interface. By default, this check box is
selected.

Port Specifies the port number through which the Web


Server communicates with the Intelligence Server. If the
server is already connected, you cannot change this
option. The default is 0.

208 Using the MicroStrategy Web Administrator Console 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Options Description

Initial pool size Specifies the initial pool size for the server cluster if the
server is not connected. The pool is the number of
connections between the Web and the Intelligence
Server. This is defined at the Intelligence Server level,
not at the cluster level. You must define the pool size for
each Intelligence Server, which allows you to grant
more or fewer initial connections depending on the size
of the Intelligence Server machine. If the server is
already connected, you cannot change this option. The
default is 5.

Maximum pool size Specifies the maximum pool size for the server cluster if
the server is not connected. If the server is already
connected, you cannot change this option. The default
is 50.

Load balance Specifies the division of jobs between Intelligence


factor Servers in a cluster. You can specify the load balance
factor if the server is not connected. If the server is
already connected, you cannot change this option. The
default value is 1. This value can be increased for more
powerful servers in a cluster to provide an appropriate
balance. A larger load balance factor means the server
supports a greater load in the server cluster in which it
resides.
For example, if two servers make up a cluster, one
server with a balance factor of 3 and the other with a
balance factor of 2, and there are 20 logins, 12 logins
are supported by the first server and 8 by the second.

Server busy Length of time, in minutes, that a Web request waits for
timeout: This is not a connection from the connection pool, if the maximum
displayed in the number of connections are all busy. The default value is
Server Properties 10.
page.

Request timeout: Length of time, in minutes that Web Universal waits to


This is not receive a response from Intelligence Server. The default
displayed in the value is 40.
Server Properties
page.

Keep the Used when there is a firewall between the Web Server
connection alive and the Intelligence Server. This setting ensures that
between Web the firewall does not remove connections between the
Server and Web Server and Intelligence Server.
Intelligence Server

2005 MicroStrategy, Inc. Using the MicroStrategy Web Administrator Console 209
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Options Description

Login Provides information about the login mode, whether that


mode is enabled or disabled, and which mode is the
default. The login modes include the following:
Standard (user name & password): default mode for
login
LDAP Authentication
Database Authentication
Guest
Windows Authentication: enabled only on
Windows-based Web Servers
By default all of the modes are enabled and the default
login mode is set to Standard.
Refer to Chapter 3, Deploying the System, in the
System Administration Guide for details about the
different modes. You can enable or disable these modes
and also make any of the modes the default login mode.

Project List: This is This allows you to specify whether the user must log in
not displayed in the before or after the projects are shown. You can choose
Server Properties the following options:
page. Show all the projects connected to the Web Server
before the user logs in. This option is selected by
default.
Log in, then show the projects accessible by the
supplied login.
If users log in after the projects are shown, then all
projects from all Intelligence Servers are presented to
the users. This is the default behavior.
If they log in before the projects are shown, then the
users should only see projects available to them.

Save Allows you to save the changes you made on this page.

Cancel Allows you to cancel the operation. It resets the page to


the previously saved settings.

Connect Allows you to make a connection to the Intelligence


Server. This button is displayed when you add a server
for the first time.

Delete: This is not Allows you to remove the Intelligence Server from the
displayed in the list. This button is displayed when the server is
Default Server disconnected.
Properties page.

210 Using the MicroStrategy Web Administrator Console 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Narrowcast Server Integration page


Use the Narrowcast Server link at the top of the
Administrator Page to access the Narrowcast Server
Integration page. This page allows you to configure
MicroStrategy Web Universal to enable the Scheduled E-mail
and Send Now features in MicroStrategy Web Universal.

The Scheduled E-mail feature allows users to have a report or


document sent to a specified e-mail address on a certain
schedule. These schedules are defined in MicroStrategy
Narrowcast Server and are separate from the schedules
maintained in MicroStrategy Intelligence Server. The Send
Now feature allows users to send a report or document
immediately to an e-mail address that they specify.

 You must already have MicroStrategy Narrowcast


Server installed and configured before the Scheduled
E-mail and Send Now options work. For more
information, see the MicroStrategy Narrowcast
Server Application Designer Guide.

Diagnostics page
Diagnostics allows you to define what information is logged
by the Web and SDK, as well as where it is logged. It also
provides an interface to view these messages.

 The diagnostics settings are stored in the


logger.properties file, which is saved by default
in the
CATALINA_HOME\webapps\MicroStrategy\
WEB-INF\log folder.

Click the Diagnostics link on the Administrator Page. The


Diagnostics page allows you to do the following:
Configure internal or custom log file settings

Configure how logs are displayed

Configure and view statistics

2005 MicroStrategy, Inc. Using the MicroStrategy Web Administrator Console 211
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Configure internal or custom log file settings

Logs are records of all low-level activity, which can be


aggregated and used for troubleshooting a specific problem
or for server and system analysis. When you run the
MicroStrategy Web Universal application, the operations
performed by the user can generate errors, warnings, or
messages. This information can be stored and you can specify
how much of this content is written to the log file. For
example, to write only the errors generated by MicroStrategy
Web Universal, select Errors in the Diagnostics
Configuration page.

To open the Diagnostics Configuration page, click


Diagnostics on the Administrator Page. It has these options:

Options Description

Internal diagnostics This is the default option and is used to set the
setup type of information logged in the log file. The
settings defined here are written in the
logger.properties file.

Level Allows you to select the level at which the


information is written in the log file. You can
choose from the following levels:
OFF: This is the default option. Nothing is
written in the log file.
Errors: Errors generated by MicroStrategy
Web Universal are written in the log file.
Warnings: Errors and warnings generated by
MicroStrategy Web Universal are written in
the log file.
Messages: Messages, errors, and warnings
generated by MicroStrategy Web Universal
are written in the log file.

Log files directory Displays the default path where the log files are
saved; use / as the directory delimiter in the path.
You can also specify a different path. The log file
is generated in the specified path in the
MSTRmmddyyyy.log_num format. Naming of
the log file is handled by the
logger.properties file. For example, the first
log file created on 01/02/2003 appears as
MSTR01022003.log_1.

212 Using the MicroStrategy Web Administrator Console 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Options Description

Custom diagnostics A typical use of this setting is to load a


setup logger.properties file provided by Technical
Support. You can load those diagnostics settings
and send the output to Technical Support. When
Technical Support is finished, they can reset it to
your original settings. This allows a detailed level
of logging without requiring you to write the
logger.properties file.

Save Saves the settings.

Load default values Allows you to set the options to the default values
shipped with MicroStrategy Web Universal. This
option deletes settings that you have previously
configured.

Configure how logs are displayed

When you start working with MicroStrategy Web Universal,


the log file can record errors, warnings, or messages,
depending on how you Configure internal or custom log file
settings, page 212. This information can be difficult to
understand if you read it directly from the log file.
MicroStrategy Web Universal provides a way to view this
information in a Web page. This helps you troubleshoot and
diagnose application errors and the system.

You can view the log file information in the Administrator


Page by configuring the View Logs page. It displays the data
from the log file at a level of detail up to the level set in the
Diagnostics Configuration page. The View Logs page can be
customized to display warnings, messages, and errors at the
bottom of the page.

2005 MicroStrategy, Inc. Using the MicroStrategy Web Administrator Console 213
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

To view logs, you can filter the type of information to display


depending on the date period. The View Logs page requires
the following information:

Options Description

Display Provides the following choices:


Errors (default)
Warnings
Messages
Used to filter the displaying of logs on the screen.
Depending on what option you choose and on the
date setting, the Web page displays the information at
the bottom of the page. The logs that are displayed
depend on the level you choose in the Diagnostics
Configuration page. If you do not choose to record the
information, you are not able to see any logs on the
screen.

From The first date to display log file information for. By


default it displays the current date. Together the From
and To date settings specify the range of log
information to be displayed. If these settings are
equal, logs are viewed for that day only.

To The last date to display log file information for. By


default it displays the current date. Together the From
and To date settings specify the range of log
information to be displayed. If these settings are
equal, logs are viewed for that day only.

Refresh After you specify the log display options, click


Refresh to execute the new settings. The log file
information includes the following:
The time and date when the event log was created
The name of the user who logged in
The IP address of the user
The level of the information log
The class
The method related to this log
The entire message

Load Default Values Allows you to return to the default values in the Web
page.

214 Using the MicroStrategy Web Administrator Console 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

The following conditions determine which logs are displayed:

The information recorded in the log file: If on a specific


date you turned the level OFF in the Diagnostics
Configuration page, the log file is empty for that date and
you do not see any information for it in the View Logs
page. Alternatively, it cannot display messages if you did
not select Messages to be recorded.

The levels you choose to display on the View Logs page: If


you select the check box for each of the levels, the page
displays all levels, assuming that all levels were saved in
the log file.

The date period: You can specify one or more days to


display using the From and To settings.

To configure how logs are displayed

1 In the Administrator Page, click View logs under the


Diagnostics section. A new View Logs Web page opens.

2 From the Display section, select the type of log, Error,


Messages, or Warning, to display in the log file.

3 Specify the date range to see the data available for that
period using the From and To options. This setting is
optional. If you do not specify the date range, the data for
the current date displays.

4 Click Refresh to execute your new settings.

Configure and view statistics

The statistics in the Administrator Page provide information


about the time taken by the Web Server and Intelligence
Server to complete an operation, how much data is received
and sent, the waiting time to receive some data from the
Intelligence Server, and so on. The Statistics section gives you
the option to turn the logging mode on or off, and to specify
whether the logs should be displayed on individual pages or
stored in a text file. You can enable this option to interpret

2005 MicroStrategy, Inc. Using the MicroStrategy Web Administrator Console 215
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

and analyze the system and server performance. The


information can be used as a source for analyzing statistical
information about MicroStrategy Web Universal. If multiple
users work on the same server, displaying statistics to each of
them is not recommended as it can have an impact on the
system and server performance.

 Ifgrows
the statistics are being saved in a file, the file size
quickly. For this reason, this feature should not
be used under normal circumstances. It is useful only
when the system is not working properly and you want
to analyze the data for system tuning or
troubleshooting.

To access the Statistics page, select Statistics on the


Administrator Page, under Diagnostics.

The following table provides information about the options


available on the Statistics page.

Options Description

Mode Sets the show statistics mode to one of the


following options:
OFF: The statistics are not displayed on the
screen nor saved in a file. This is the default
setting.
Screen: The application statistics are
displayed in the lower left corner of all Web
pages.
File: The statistics are saved in the specified
file and you can open the file to see them.
Specify the absolute file path with / as a
directory delimiter in the Statistics File box.
Screen and File: The statistics are displayed
on the screen and written in the file you
specify. Specify the absolute file path with /
as a directory delimiter in the Statistics File
box.

Statistics File If you select File or File and Screen mode, you
must specify an absolute path in this box. Use /
as the directory delimiter in the path.

Save Allows you to save the settings.

Load Default Values Allows you to revert to the default settings.

 For this page, the absolute path is the path where the
Web Server is installed.

216 Using the MicroStrategy Web Administrator Console 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

When you set the mode to show statistics on the screen, the
following information is displayed on the left side of all the
Web pages:

Total Web Server + IServer processing time: Total


time, in milliseconds, taken by Web Server and
Intelligence Server to process a request.
Web Server processing time: Total time, in
milliseconds, taken by the Web Server to process the
request.

IServer processing time: Total time, in milliseconds,


taken by Intelligence Server to process the request.
IServer API time: Time, in milliseconds, spent by
Intelligence Server to process the XML API calls and to
execute and retrieve results. A percentage is displayed
after the unit and corresponds to the percent of time spent
processing the Intelligence Server API calls versus the
total time.

IServer polling time: Total time, in milliseconds, spent


waiting for results to come back from Intelligence Server
in milliseconds. MicroStrategy Web Universal is polling
Intelligence Server during that time. A percentage is
displayed after the unit and corresponds to the percent of
time spent polling Intelligence Server before it comes
back.

 The polling interval is 110 milliseconds.


Number of Web API calls: Total number of API calls,
some to Intelligence Server, some made locally on the
Web Server, to access privileges, which are cached on the
Web server for each user.

Number of Web API polling calls: Number of calls made


to Intelligence Server for that request until the results are
ready.
Bytes sent and bytes received: Number of bytes
exchanged and received between the Web Server and
Intelligence Server throughout the request.

2005 MicroStrategy, Inc. Using the MicroStrategy Web Administrator Console 217
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

Security
MicroStrategy provides various security features to make
your application more secure and reliable. The Web
Administrators Security Web page allows you to enable or
disable various security options for users working with
MicroStrategy Web Universal.

To access the Security page, click Security on the


Administrator Page. The Security Web page allows you to
configure the following:

Encryption: This section determines whether or not to


encrypt the following information:

Traffic between the Web and IServer machines is


encrypted: The data transferred between
MicroStrategy Web Universal and Intelligence Server
is not encrypted by default because it increases the
load on Intelligence Server. As a result, the application
can become slow. If the data is valuable and sensitive,
you can encrypt it by selecting this option.

Cookies security level: You can choose to:

Disable cookies: By default all cookies are disabled in


the application. This means that no settings are saved
in a session or in the metadata when using the
application. Select this option to make your
application highly secure.
Allow temporary cookies (deleted when the
session is closed): When you enable this option,
temporary information is saved within a session.
While you browse through the application and view
Web pages, information such as the last page visited,
filter or template definitions for execution, shared
report location, and so on is saved in the cookies. The
information is lost when the session is closed, or when
you close the browser.

218 Using the MicroStrategy Web Administrator Console 2005 MicroStrategy, Inc.
Installation and Configuration Guide Configuring and Deploying MicroStrategy Web Universal 8

Allow temporary and permanent cookies


(maintained across sessions): When you enable this
option, permanent information such as editor status
settings is saved in the metadata and can be used in
another session. This occurs if you close the browser
and open a new session. Enabling this option also sets
the application to save temporary information within a
session. This option is selected by default.

For more information about cookies, see the related appendix


in the MicroStrategy System Administration Guide.

You also have an option to enable or disable the following:


Store Intelligence Server information in temporary
cookies instead of on the Web Server: This option
specifies whether Intelligence Server session
information should be saved in cookies. It is not secure
to turn on this option in most cases as the Intelligence
Server information is sensitive. This option checks in
the cases when a cluster is set up and does not
automatically handle session replication. The session
replication is the distribution of the session
information on the client instead of on the Web server
so that the user can connect seamlessly to any of the
Intelligence Server machines.

When you enable this, temporary information such as


the Session ID of the Intelligence Server sessions is
saved.

 Ifinformation
the Disable cookies option is selected, no
is saved in the cookies.

URL: You can enable or disable the following setting:

Session information is included in the URL: By


default, the application allows you to bookmark the
page you are in by adding it in your Favorites list. This
option specifies whether you want to bookmark the
page you are browsing and pass the information as
part of the URL. If you do not want to allow the user to
bookmark the page visited, turn off this option.

2005 MicroStrategy, Inc. Using the MicroStrategy Web Administrator Console 219
8 Configuring and Deploying MicroStrategy Web Universal Installation and Configuration Guide

 Even with the session information in the URL,


bookmarks only support basic pages that
correspond to saved objects or static links. This
means you cannot bookmark a report page after
you have applied manipulations.

User input filtering: You can enable or disable the


following setting:

Allow use of HTML in the print header and footer.


This setting will allow users to execute script in
the browser: This setting allows you to write HTML
code, including script, only in the print header and
footer dialog box. This allows you to include your own
images in the header and footer layout. If the check
box is cleared, the HTML text or script specified in the
print header and footer dialog box is encoded and not
interpreted, and it is printed as it appears in the dialog
box.

Login: You can enable or disable the following login


properties for MicroStrategy Web Universal users:

Allow automatic login if session is lost: This setting


allows Windows authentication users to automatically
reconnect to the MicroStrategy Web Universal
application if the session is lost. Others who are not
Windows authentication users must log in manually
again if the session is lost. By default this option is
selected.

Allow users to change expired password:


Passwords can be expired after a certain period of time
that you can set when creating a user in MicroStrategy
Desktop. A reminder is sent to the user to change the
password before it expires. If the password is not
changed within the specified time period, it is expired.
By default users cannot change the expired password.
However, if you enable this option, users have the
permission to change their expired password, except
those users who do not have privileges to change their
passwords. The change password privilege is assigned
to a user by the administrator in the User Editor of
MicroStrategy Desktop.

Save: Click to save the configuration settings in this page.

Cancel: Click to cancel the operation.

220 Using the MicroStrategy Web Administrator Console 2005 MicroStrategy, Inc.
9
9. SETTING UP DOCUMENTS AND
HTML DOCUMENTS

Introduction

This chapter explains the setup required for the Intelligence


Server to execute HTML documents and Report Services
documents on UNIX or Linux platforms.

This chapter includes the following sections:


Before you start

Overview

Setup for creating and executing HTML documents

Setup for executing existing HTML documents

Setup for executing Report Services documents

2005 MicroStrategy, Inc. 221


9 Setting up Documents and HTML Documents Installation and Configuration Guide

Before you start


This chapter assumes the following:

You are familiar with UNIX or Linux.

You are familiar with MicroStrategy Desktop and


MicroStrategy Intelligence Server.

You are familiar with MicroStrategy HTML documents


and Report Services documents.

You have installed MicroStrategy Desktop as well as


MicroStrategy Intelligence Server.

 Some of the steps described in this document may


require root access permissions.

222 Before you start 2005 MicroStrategy, Inc.


Installation and Configuration Guide Setting up Documents and HTML Documents 9

Overview
An HTML document is a container for formatting, displaying,
and distributing multiple reports on the same page, or at the
same time within a project. An HTML document object is the
standard container for creating dashboards and scorecards to
display a group of reports within the MicroStrategy platform.

HTML documents are created using MicroStrategy Desktop.


Before creating or executing HTML documents, you must
specify the HTML document directory using the Project
Configuration Editor in MicroStrategy Desktop. The HTML
document directory stores HTML templates that are required
by the MicroStrategy Intelligence Server for executing HTML
documents.

A MicroStrategy Report Services document contains objects


representing data coming from one or more reports, as well
as positioning and formatting information. It is used to
format data from multiple reports in a single display that can
be used for presentations. When you create a document, you
can specify the data that appears, control the layout,
formatting, grouping, and subtotaling of data and specify the
position of page breaks. In addition, you can insert pictures
and draw borders in the document.

 InServices
this chapter, the term document signifies a Report
document.

For additional information on HTML documents, see the


HTML Documents chapter in the MicroStrategy Advanced
Reporting Guide.

For additional information on Report Services documents,


refer to the MicroStrategy Document Creation Guide.

2005 MicroStrategy, Inc. Overview 223


9 Setting up Documents and HTML Documents Installation and Configuration Guide

Setup for creating and executing HTML


documents
Using the Project Configuration Editor in MicroStrategy
Desktop, you must specify the location of the HTML
document directory as an absolute path. This document
directory can be on a local machine or on a remote machine.
Users require appropriate read and write permissions to
access this directory. When MicroStrategy Intelligence Server
executes HTML documents, it uses the same HTML files and
requires read permission to this document directory.

For the procedure below, the following assumptions are


made:

You have installed MicroStrategy Desktop as well as


MicroStrategy Intelligence Server.

The HTML document directory is stored on a UNIX or


Linux machine.

The location of the HTML document directory is


/machine-name/share/htmldocuments.
MicroStrategy Desktop users have at least read
permissions to the HTML document directory for
executing existing HTML documents. Write permissions
are required for MicroStrategy Desktop users to create
new HTML documents.

To set up HTML document creation

1 Share the HTML documents directory with MicroStrategy


Desktop installed on the Microsoft Windows platform. If
the HTML documents are not stored on the computer that
has Intelligence Server installed, then store them on a
computer that has Intelligence Server installed.

224 Setup for creating and executing HTML documents 2005 MicroStrategy, Inc.
Installation and Configuration Guide Setting up Documents and HTML Documents 9

2 Install Samba software on the UNIX computer that has


the HTML documents directory. With this software, the
HTML documents directory becomes accessible to
MicroStrategy Desktop installed on Microsoft Windows.
You can get the latest version of Samba at
http://www.samba.org.

3 Share the top-level directory that includes the HTML


documents directory as NFS shared directory, as well as
a Samba shared. For example, you must share
/machine-name/share.

4 From the Microsoft Windows computer that has


MicroStrategy Desktop installed, click Start, select Run,
and open the top-level shared documents directory. For
example, \\machine-name\share. This caches the
connection so that MicroStrategy Desktop users are not
prompted for authentication each time the shared
directory is accessed.

 This must be performed every time you restart the


computer.

5 Using the Project Configuration Editor in MicroStrategy


Desktop, set the HTML document directory as an absolute
path, such as
\\machine-name\share\htmldocuments.

6 Perform one of the following, depending on whether the


HTML Document is on the same computer as the
Intelligence Server:
If the HTML documents directory is not on the same
computer as the Intelligence Server, place the HTML
documents directory on the computer that has the
Intelligence Server installed in it. Root privileges are
required for this. Type the command su and the root
password at the command prompt to log in as a
superuser, or log in as root. The command prompt
changes to the pound sign (#). Type the following:

mkdir / machine-name/share/htmldocuments

cd /

mount machine-name:/share /machine-name

2005 MicroStrategy, Inc. Setup for creating and executing HTML documents 225
9 Setting up Documents and HTML Documents Installation and Configuration Guide

If the HTML documents directory is on the same


computer as the Intelligence Server, you can store it in
the user space for root, or create a link such that it can
be accessed.

An example of the command follows:

# cd /

# mkdir <machine-name>

# cd <machine-name>

# mkdir share

# cd share

# mkdir myhtmldocuments

# ln -s /home/install/myhtmldocuments
myhtmldocuments

7 Create a directory named xsls under the HTML


document directory and copy the XSL files you require for
creating HTML documents to the xsls directory,
/machine-name/share/htmldocuments/xsls.

8 If you want to insert images into the HTML document,


create a directory named images under the HTML
document directory, and copy the images to the directory
/machine-name/share/htmldocuments/images.

9 Create your HTML documents in the HTML document


directory.

You are now ready to create and execute your HTML


documents.

226 Setup for creating and executing HTML documents 2005 MicroStrategy, Inc.
Installation and Configuration Guide Setting up Documents and HTML Documents 9

Setup for executing existing HTML documents


If you already have existing HTML documents, follow the
steps in this section to execute the HTML documents using
the MicroStrategy Intelligence Server.

For the procedure of setting up HTML document execution,


the following assumptions are made:

You have completed all the steps listed in the section,


Setup for creating and executing HTML documents,
page 224.

The location of the HTML document directory is


/machine-name/share/htmldocuments.

To set up HTML document execution

1 Copy the HTML file for any existing HTML document to


/machine-name/share/htmldocuments.

2 View the source code of each HTML file and copy the XSL
file used by each HTML document in an appropriate
directory under
/machine-name/share/htmldocuments.

For example, if the location of the XSL file in the source


code is xsl="\xsls\myxsl.xsl, then copy myxsl.xsl
to /machine-name/share/htmldocuments/xsls. If
the location of the XSL file in the source code is
xsl="\myxsl.xsl, then copy myxsl.xsl to
/machine-name/share/htmldocuments.

3 View the source code for the images used and follow the
instructions provided in the step above for XSLs.

You are now ready to execute your HTML documents.

2005 MicroStrategy, Inc. Setup for executing existing HTML documents 227
9 Setting up Documents and HTML Documents Installation and Configuration Guide

Setup for executing Report Services documents


A MicroStrategy Report Services document contains objects
representing data from one or more reports, and also
contains positioning and formatting information. A
MicroStrategy Report Services document is used to format
data from multiple reports. The formatted data can be used to
create presentations. A Report Services document can be
exported in a PDF format.

Follow the steps in this section to execute documents.

To set up document execution

1 In a UNIX console, browse to <INSTALL_PATH>, where


<INSTALL_PATH> is the directory you specified as the
install directory during installation. Browse to the folder
PDFGeneratorFiles.

2 To export documents to PDF, make sure that the


appropriate TrueType fonts (.ttf files) or the TrueType
Collection files (.ttc files) are in the PDFGeneratorFiles
folder.

For more information on documents, see the Document


Basics chapter in the MicroStrategy Document Creation
Guide.

228 Setup for executing Report Services documents 2005 MicroStrategy, Inc.
10
AUTOMATED INSTALLATION
10.

AND CONFIGURATION ON
WINDOWS

Introduction

This chapter explains the various possibilities for performing


fully automated and unattended installations within the
MicroStrategy platform. This includes customizations to the
installation and configuration routines available with the
product. It explains the different resources you can use to
deploy MicroStrategy products through various scenarios
including
deploying the MicroStrategy platform across the network
through the Microsoft System Management Server (SMS)
or its equivalent (for example, IBM Tivoli)

embedding the MicroStrategy platform within third party


custom applications and other installation routines

customizing the MicroStrategy installation to meet the


various environment-specific requirements for a given
site

2005 MicroStrategy, Inc. 229


10 Automated Installation and Configuration on Windows Installation and Configuration Guide

This chapter covers the following topics:

The different types of installations that can be performed


with MicroStrategy products.

How to perform a fully automated MicroStrategy


installation and configuration by modifying various
installation parameters in Windows ini-like response
files.

How to perform a partial, factory-like installation that can


be further completed by a customer. This particular set of
features enables any Original Equipment Manufacturer
(OEM) to easily embed the MicroStrategy platform within
another application.

How to customize certain aspects of the MicroStrategy


installation to meet various site-specific requirements for
multi-user environments, such as strict standards for
software deployment to user communities and so on.

230 2005 MicroStrategy, Inc.


Installation and Configuration Guide Automated Installation and Configuration on Windows 10

Methods of installation
The methods of installations discussed in this chapter are

response.ini file installation

Silent installation

Response.ini file installation


The response.ini file installation allows you to automate
certain aspects of the installation by modifying a Windows
ini-like response file. This option is typically implemented by
OEM applications that embed MicroStrategy installations
within other products. It can also be implemented by IT
departments who want to have more control over Desktop
installations.

Silent installation
Silent installations do not present any graphical user
interface (GUI) and are typically implemented by IT
departments that perform package-based installations across
the network (SMS, for example). Although not as commonly
used as the response file installations, this scenario can also
be used for OEM installations.

2005 MicroStrategy, Inc. Methods of installation 231


10 Automated Installation and Configuration on Windows Installation and Configuration Guide

Installation log file


Before you begin to learn about automated installation
options, it is important to know about the installation log file.
The setup program generates a log file in text format. This log
file contains records of all actions performed by the setup
program and by other executable files related to installation.
The installation log file can be particularly helpful if you
encounter errors during the installation process. For
example, the log can tell you if a registry key or path was not
added or if a critical file was not registered successfully. The
setup.exe file writes to this log file. The log file data
includes

update dates

machine specifications

user selections

list of files to be registered

list of files that do not require registration

list of registry entries

identification of files that fail during registration

installation activity such as performance counter loading


and DSN creation
reboot time file registration results

The default location for the install.log file is in the


Program Files\Common Files\MicroStrategy folder,
but both the location and the name can be changed. You can
specify the log file name and location in the following places:

command line, reading the parameter LogFile. For


example:
setup.exe --LogFile=C:\install.log

response file in [LogFile]. See Configuring a response.ini


file for installation, page 233 for more information.

232 Installation log file 2005 MicroStrategy, Inc.


Installation and Configuration Guide Automated Installation and Configuration on Windows 10

Installing and configuring with a response.ini


file
The response.ini file can facilitate the installation and
setup of MicroStrategy products by allowing you to progress
through the installation and project creation processes with a
single keystroke. A response.ini file is an initialization file
that is used to send parameters or selections to the
InstallShield Wizard. This allows you to run it silently as all
the options are pre-selected in that file. The following types of
response.ini files are described:
installation

Configuration Wizard

Configuring a response.ini file for installation


The response.ini file for installation allows you to
automate certain aspects of the installation by modifying a
Windows ini-like response file. This option is typically
implemented by

OEM applications that embed MicroStrategy installations


within other products

IT departments who want to have more control over


desktop installations

The response.ini file specifies all the selections you want


to make during the installation in the InstallShield Wizard.
You can either run it with all the InstallShield Wizard options
that are pre-selected, or run it without having to use the
wizard at all.

 The response.ini file should not be confused with


the setup.iss file, which is used by the InstallShield
to perform silent installation. When both
response.ini and setup.iss are included in the
setup, response.ini overrides setup.iss. For
details on the setup.iss file, see Silent installation,
page 265.

2005 MicroStrategy, Inc. Installing and configuring with a response.ini file 233
10 Automated Installation and Configuration on Windows Installation and Configuration Guide

Creating a response.ini file

You can create a response.ini file in any text editor and


save the file as response.ini in the desired folder. You
must save the file as ANSI encoding. The following tables
describe the parameters and options for the all the sections,
such as Installer, Paths, and so on in the response.ini file.
It is followed by a sample response.ini file for your
reference.

 The options are case sensitive, therefore they must


be entered as indicated in the tables below.

Installer

Options Description

[Installer] Section that begins the installation.

HideAllDialogs = TRUE or FALSE. Indicates whether the


installation uses all default values.
FALSE displays all the dialog boxes and
you must browse using the Next buttons.
The default is FALSE.

LogFile = Location where the install.log file is


generated. If left empty, it takes the
default location and file name of
C:\Program Files\Common
Files\MicroStrategy\
install.log.

CreateShortcuts = TRUE or FALSE. TRUE creates a shortcut


called MicroStrategy in the Windows
Start menu. The default is TRUE.

PreventReboot = TRUE or FALSE. TRUE prevents the


machine from rebooting after installation
is done. Note the following conditions:
If both ForceReboot = TRUE and
PreventReboot = TRUE, then
PreventReboot applies first.
If both ForceReboot and
PreventReboot are FALSE and
HideDialog for [Finish] is set to
TRUE, then the machine reboots only
if it is required.
The default is FALSE.

ForceReboot = TRUE or FALSE. TRUE reboots the


machine after the installation is done.
The default is FALSE.

234 Installing and configuring with a response.ini file 2005 MicroStrategy, Inc.
Installation and Configuration Guide Automated Installation and Configuration on Windows 10

Options Description

EnterpriseManagerOve TRUE or FALSE. If you select FALSE, the


rwrite = warehouse and metadata files are not
updated but the rest of the files for
Enterprise Manager are updated. This
prompt only impacts the files in the
Microsoft Access database. The default
is FALSE.

ShowConfigWizard = TRUE or FALSE. When using silent


install, set to FALSE to prevent the
Configuration Wizard from coming up
after reboot. The default is TRUE.

RunConfigWizard = TRUE or FALSE. Set this option to


specify whether to run the Configuration
Wizard. The default is FALSE.

ConfigWizardResponse Specify the name of the response file for


File = the Configuration Wizard; otherwise, it
takes the default name of
response.ini.
For more details on configuring the
response.ini file for the
Configuration Wizard, see Configuring a
response.ini file for the Configuration
Wizard, page 257.

BackupFiles = TRUE or FALSE. If you set the value to


TRUE, it creates a backup of the
following files:
*.pds
*.xsl
*.asp
*.css
*.js
*.sql
The default is FALSE.

StopAllServices = TRUE or FALSE. Set this option to stop


all MicroStrategy services that are
running on the machine during
installation. The default is FALSE.

StopIIS = TRUE or FALSE. Set this option to stop


Internet Information Services (IIS) during
installation. The default is FALSE.

AnalyticsOverwrite = TRUE or FALSE. This option overwrites


the Analytics Modules from a previous
install. The default is FALSE.

2005 MicroStrategy, Inc. Installing and configuring with a response.ini file 235
10 Automated Installation and Configuration on Windows Installation and Configuration Guide

Options Description

TutReportingOverwrit TRUE or FALSE. Set this option to


e = overwrite the Reporting Tutorial from a
previous installation. The default is
FALSE.

eTrainerForWebOverwr TRUE or FALSE. Set this option to


ite = overwrite the MicroStrategy eTrainer for
Web database from a previous
installation. The default is FALSE.

TutDeliveryOverwrite TRUE or FALSE. Set this option to


= overwrite the Delivery Tutorial from a
previous installation. The default is
FALSE.

CheckRenameOperation TRUE or FALSE. In some instances, as a


s = result of a previous installation or an
uninstall, certain files may be missing or
irreplaceable during installation.
Therefore, you are prompted to do one
of the following:
Reboot at the beginning of
installation to replace this file. It is
recommended that you select this
option.
Continue with the installation at the
risk of the software not functioning
properly.
If you enter FALSE, the prompt does not
display. The default is TRUE.

EnableTracing = TRUE or FALSE. Set this option to trace


the setup process in a log file that is
saved in the Temp folder. The log file
records errors that are encountered
during the installation. The default is
FALSE.

EnableASPNETServices TRUE or FALSE. Set this option to


= enable the ASP.NET Web Services
extensions that IIS Admin requires. The
default is FALSE.

EnableASPServices = TRUE or FALSE. Set this option to


enable the ASP Web Services
extensions that IIS Admin requires. The
default is FALSE.

ShowWelcomeScreen = TRUE or FALSE. Set to TRUE to display


the Welcome screen after reboot. The
Welcome screen is displayed only once
after reboot. The default is TRUE.

236 Installing and configuring with a response.ini file 2005 MicroStrategy, Inc.
Installation and Configuration Guide Automated Installation and Configuration on Windows 10

Paths

Options Description

[InitialPaths] Section for specifying the path for the


products that you select to install.

COMMONFILES = Location where the common files like


response.ini, install.log, and
so on will be installed. If left empty, it
takes the default location of
C:\Program Files\Common
Files\MicroStrategy.

Desktop = Location where Desktop will be


installed. If left empty, it takes the
default location of C:\Program
Files\MicroStrategy\Desktop.

ObjectManager = Location where Object Manager will be


installed. If left empty, it takes the
default location of C:\Program
Files\MicroStrategy\
Administrator\Object Manager.

CommandManager = Location where Command Manager will


be installed. If left empty, it takes the
default location of C:\Program
Files\MicroStrategy\
Administrator\Command
Manager.

EnterpriseManager = Location where Enterprise Manager will


be installed. If left empty, it takes the
default location of C:\Program
Files\MicroStrategy\
Administrator\Enterprise
Manager.

Server = Location where the MicroStrategy


Intelligence Server will be installed. If
left empty, it takes the default location
of C:\Program Files\
MicroStrategy\Intelligence
Server.

Web = Location where MicroStrategy Web will


be installed. If left empty, it takes the
default location of C:\Program
Files\MicroStrategy\Web ASPx.

WebUniversal = Location where MicroStrategy Web


Universal will be installed. If left empty,
it takes the default location of
C:\Program Files\
MicroStrategy\Web JSP.

2005 MicroStrategy, Inc. Installing and configuring with a response.ini file 237
10 Automated Installation and Configuration on Windows Installation and Configuration Guide

Options Description

WebServices = Location where MicroStrategy Web


Services will be installed. If left empty, it
takes the default location of
C:\Program Files\
MicroStrategy\Web Services.

SDK = Location where the SDK will be


installed. If left empty, it takes the
default location of C:\Program
Files\MicroStrategy\SDK.

Office = Location where MicroStrategy Office


will be installed. If left empty, it takes the
default location of C:\Program
Files\MicroStrategy\Office.

TutorialReporting = Location where MicroStrategy Tutorial -


Reporting will be installed. If left empty,
it takes the default location of
C:\Program Files\
MicroStrategy\Tutorial
Reporting.

eTrainer= Location where eTrainer for Web will be


installed. If left empty, it takes the
default location of C:\Program
Files\Microstrategy\eTrainer.

AnalyticsModules = Location where the Analytics Modules


will be installed. If left empty, it takes the
default location of C:\Program
Files\MicroStrategy\
Analytics Modules.

NCSAdminDeliveryEngin Location where the Narrowcast Server


e = Delivery Engine will be installed. If left
empty, it takes the default location of
C:\Program Files\
MicroStrategy\Narrowcast
Server\Delivery Engine.

SubscriptionPortal = Location where the Subscription Portal


will be installed. If left empty, it takes the
default location of C:\Program
Files\MicroStrategy\Narrowcas
t Server\Subscription Portal.

TutorialDelivery = Location where MicroStrategy Tutorial -


Delivery will be installed. If left empty, it
takes the default location of
C:\Program
Files\MicroStrategy\Narrowcas
t Server\Tutorial

238 Installing and configuring with a response.ini file 2005 MicroStrategy, Inc.
Installation and Configuration Guide Automated Installation and Configuration on Windows 10

Welcome dialog box

Options Description

[Welcome] Section for configuring the Welcome


dialog box.

HideDialog = TRUE or FALSE. True displays the


dialog box. The default is FALSE.

RemoveAll = TRUE or FALSE. This option is for the


uninstall process only. Setting it to TRUE
removes all MicroStrategy products
during the uninstall process. The default
is FALSE.

Customer Information dialog box

Options Description

[UserRegistration] Section for specifying the customer


information.

HideDialog = TRUE or FALSE. True displays the dialog


box. The default is FALSE.

UserName = Indicates the user name of the currently


logged user or a user who is already
registered. If no information is provided,
you cannot proceed to the next page.

CompanyName = The name of the company for which the


software is registered. The default is the
company name in the registry.

LicenseKey = Specify the license key for the software.


If you do not specify the license key, the
Setup Wizard will ask for it when it
reaches that step. By default it is blank
for a fresh install or displays the license
key from a previous install.

2005 MicroStrategy, Inc. Installing and configuring with a response.ini file 239
10 Automated Installation and Configuration on Windows Installation and Configuration Guide

Setup Type dialog box

Options Description

[SetupType] Section for setting the appropriate dialog


boxes to display for Typical or Advanced
installation. This dialog box offers the
option to select the installation type.

HideDialog = TRUE or FALSE. True displays the dialog


box. The default is FALSE.

Type = This determines whether the installation


is Typical or Advanced.
One of the following two parameters can
be entered:
typical
advanced
Typical or Advanced. If set to
typical, the installation paths specified
in the [InstallPaths] section are
used. If set to Advanced, you are
prompted to enter the path for each
product. For more information, refer to
GUI, page 43 in Chapter 2, Planning Your
Installation. The default is Advanced.

Choose Destination Location dialog box

Options Description

[SuiteTarget] Section specifying the name of the target


directory from where you can run the
MicroStrategy products.

HideDialog = TRUE or FALSE. True displays the dialog


box. The default is FALSE.

TargetDirectory = Location of the root directory for the


Program Files. The default is set to
C:\Program Files\MicroStrategy.

240 Installing and configuring with a response.ini file 2005 MicroStrategy, Inc.
Installation and Configuration Guide Automated Installation and Configuration on Windows 10

Select Components dialog box

In the InstallShield Wizard, the Select Components dialog


box contains check boxes to select or clear for products to be
installed. The [ComponentSelection] options specify
whether you want the following products to be visible to the
user. In addition, you can set the default selection for each
product.

Options Description

[ComponentSelection] Equivalent to the Select Components


dialog box that you see during
installation. For the Visible option,
you can either enter TRUE to show a
product or FALSE to hide it. If you do
not specify a TRUE or FALSE value for
each product, TRUE is used for all
products. For the Select option, you
can enter TRUE to select the check box
next to a product. If you enter FALSE,
the check box next to the product is not
selected.

HideDialog = TRUE or FALSE. True displays the


dialog box. The default is FALSE.

DesktopDesignerVisible MicroStrategy Desktop Designer


=

DestopAnalystVisible = MicroStrategy Desktop Analyst

ArchitectVisible = MicroStrategy Architect

ServerAdminVisible = MicroStrategy Server Administrator

ProjectBuilderVisible MicroStrategy Project Builder


=

CommandManagerVisible MicroStrategy Command Manager


=

EnterpriseManagerVisib MicroStrategy Enterprise Manager


le =

ObjectManagerVisible = MicroStrategy Object Manager


IServerVisible = MicroStrategy Intelligence Server

WebAnalystVisible = MicroStrategy Web Analyst

WebProfessionalVisible MicroStrategy Web Professional


=

WebReporterVisible = MicroStrategy Web Reporter

2005 MicroStrategy, Inc. Installing and configuring with a response.ini file 241
10 Automated Installation and Configuration on Windows Installation and Configuration Guide

Options Description

WebUniversalAnalystVis MicroStrategy Web Universal Analyst


ible =

WebUniversalProfession MicroStrategy Web Universal


alVisible = Professional

WebUniversalReporterVi MicroStrategy Web Universal Reporter


sible =

WebServicesASPNETVisib MicroStrategy Web Services


le = (ASP.NET)

SDKVisible = MicroStrategy SDK

OfficeVisible = MicroStrategy Office

TutorialReportingVisib MicroStrategy Tutorial - Reporting


le =

eTrainer for MicroStrategy eTrainer for Web


WebVisible =

AnalyticsModulesVisibl MicroStrategy Analytics Modules


e =

NCSAdminVisible = MicroStrategy Narrowcast


Administrator

DeliveryEngineVisible MicroStrategy Delivery Engine


=

SubscriptionPortalVisi MicroStrategy Subscription Portal


ble =

TutorialDeliveryInstal MicroStrategy Tutorial - Delivery


lVisible = Installation

TutorialDeliveryConfig MicroStrategy Tutorial - Delivery


ureVisible = Configuration

JMSGatewayVisible = JMS Gateway

WebGatewayVisible = Web Gateway

242 Installing and configuring with a response.ini file 2005 MicroStrategy, Inc.
Installation and Configuration Guide Automated Installation and Configuration on Windows 10

During the installation process in the InstallShield Wizard,


the Select Components dialog box contains check boxes to
select or clear for products to be installed. You can either
specify TRUE to install a product or FALSE to uninstall it. If
you do not specify a TRUE or FALSE value for each product,
it always uses the most recent selection from a previous
install. If you specify TRUE, the product check box is selected.
The [ComponentSelection] options specify whether the
check box for each product will be selected or cleared.

Options Description

DesktopDesignerSelect = MicroStrategy Desktop Designer

DestopAnalystSelect = MicroStrategy Desktop Analyst

ServerAdminSelect = MicroStrategy Server Administrator

ArchitectSelect = MicroStrategy Architect

ProjectBuilderSelect = MicroStrategy Project Builder

ObjectManagerSelect = MicroStrategy Object Manager

CommandManagerSelect = MicroStrategy Command Manager

EnterpriseManagerSelect MicroStrategy Enterprise Manager


=

IServerSelect = MicroStrategy Intelligence Server

WebServerASPNETSelect = MicroStrategy Web Server

WebAnalystSelect = MicroStrategy Web Analyst

WebProfessionalSelect = MicroStrategy Web Professional

WebReporterSelect = MicroStrategy Web Reporter

WebUniversalServerASPNE MicroStrategy Web Universal Server


TSelect = (ASP.NET)

WebUniversalServerJSPSe MicroStrategy Web Universal Server


lect = (JSP)

WebUniversalAnalystSele MicroStrategy Web Universal Analyst


ct =

WebUniversalProfessiona MicroStrategy Web Universal


lSelect = Professional

WebUniversalReporterSel MicroStrategy Web Universal Reporter


ect =

WebServicesASPNETSelect MicroStrategy Web Services


= (ASP.NET)

SDKSelect = MicroStrategy SDK

2005 MicroStrategy, Inc. Installing and configuring with a response.ini file 243
10 Automated Installation and Configuration on Windows Installation and Configuration Guide

Options Description

OfficeSelect = MicroStrategy Office

TutorialReportingSelect MicroStrategy Tutorial - Reporting


=

eTrainer for WebSelect MicroStrategy eTrainer for Web


=

AnalyticsModulesSelect= MicroStrategy Analytics Modules

NCSAdminSelect = MicroStrategy Narrowcast


Administrator

DeliveryEngineSelect = MicroStrategy Delivery Engine

SubscriptionPortalSelec MicroStrategy Subscription Portal


t =

TutorialDeliveryInstall MicroStrategy Tutorial - Delivery


Select = Installation

TutorialDeliveryConfigu MicroStrategy Tutorial - Delivery


reSelect = Configuration

JMSGatewaySelect = JMS Gateway

WebGatewaySelect = Web Gateway

MicroStrategy Web virtual directory

Options Description

[WebVirtualDirectory] Section that specifies the virtual


directory to be used for the
MicroStrategy Web application.

HideDialog = TRUE or FALSE. True displays the


dialog box. The default is FALSE.

VirtualDirectory = Enter a name for the virtual directory.


The default is MicroStrategy8.

RemoveVD = YES or NO. This option is for the


uninstall only. Set this option to
remove an existing MicroStrategy
Web virtual directory from a previous
installation. The default is NO.

244 Installing and configuring with a response.ini file 2005 MicroStrategy, Inc.
Installation and Configuration Guide Automated Installation and Configuration on Windows 10

Subscription Portal virtual directory

Options Description

[PortalVirtualDirector Section that specifies the virtual


y] directory to be used for MicroStrategy
Subscription Portal.

HideDialog = TRUE or FALSE. The default is


FALSE.

VirtualDirectory = Enter a name for the virtual directory.


The default is NarrowcastServer8.

RemoveVD = YES or NO. This option is for the


uninstall only. Set this option to
remove an existing MicroStrategy
Subscription Portal virtual directory
from a previous installation. The
default is NO.

Web Services virtual directory

Options Description

[WebServicesDirectory] Section that specifies the virtual


directory to be used for MicroStrategy
Web Services.

HideDialog = TRUE or FALSE. True displays the


dialog box. The default is FALSE.

VirtualDirectory = Enter a name for the virtual directory.


The default is MicroStrategyWS.

RemoveVD = YES or NO. This option is for the


uninstall only. Set this option to
remove an existing MicroStrategy
Subscription Portal virtual directory
from a previous installation. The
default is NO.

2005 MicroStrategy, Inc. Installing and configuring with a response.ini file 245
10 Automated Installation and Configuration on Windows Installation and Configuration Guide

eTrainerForWeb virtual directory

Options Description

[eTrainerForWebVirtual Section that specifies the virtual


Directory] directory to be used for MicroStrategy
eTrainer.

HideDialog = TRUE or FALSE. Set this option to not


display the MicroStrategy eTrainer for
Web Virtual Directory Setting dialog
box, or the prompt for removal of the
virtual directory while MicroStrategy
eTrainer for Web is being uninstalled.
The default is FALSE.

VirtualDirectory = Enter a name for the virtual directory.


If left empty, it takes the value of
eTrainer.

RemoveVD = YES or NO. Set this option to specify


whether upon uninstallation the
MicroStrategy eTrainer for Web virtual
directory should be removed. The
default value is NO.

Program folder

Options Description

[ProgramFolder] Section specifying the Windows Start


name of the folder from where you can
run the MicroStrategy products. The
folder will be created under the default
Start\Programs\.

HideDialog = TRUE or FALSE. True displays the


dialog box. The default is FALSE.

Name = Enter the name of the folder, for


example, MicroStrategy.

246 Installing and configuring with a response.ini file 2005 MicroStrategy, Inc.
Installation and Configuration Guide Automated Installation and Configuration on Windows 10

Intelligence Server service account

Options Description

[IServerServiceAccount Section specifying the Windows


] account for the MicroStrategy
Intelligence Server service. You have
two options:
bypass entering the account
information
enter the account information
HideDialog = TRUE or FALSE. True displays the
dialog box. The default is FALSE.

SkipAccountSetting = TRUE or FALSE. Set TRUE to bypass


the service account setting in the
MicroStrategy Intelligence Server
Setting dialog box. If you bypass it,
then the service runs with the local
system account that is installing the
products. The default is FALSE.

Domain = Enter the domain where the account is


located.

Login = Enter the user name of the account to


use.

Password = Enter the password for the account.

ServiceStartup = AUTO or MANUAL. Select to set the


Intelligence Server service startup to
be automatic or manual. The default is
AUTO.

Narrowcast Server service account

Options Description

[NarrowcastServiceAcco Section specifying the Windows


unt] account from which the MicroStrategy
Narrowcast Server service will run.

HideDialog = TRUE or FALSE. True displays the


dialog box. The default is FALSE.

2005 MicroStrategy, Inc. Installing and configuring with a response.ini file 247
10 Automated Installation and Configuration on Windows Installation and Configuration Guide

Options Description

SkipAccountSetting = TRUE or FALSE.


If you specify this value as FALSE, the
service account settings are not
skipped and the MicroStrategy
Narrowcast Server setting dialog box is
displayed. Specify the details of the
Windows account that the
MicroStrategy Narrowcast Server
services will use to log on and click
Next to proceed with the installation
process.

Domain = Enter the domain where the account is


located.

Login = Enter the user name of the account to


use.

Password = Enter the password for the account.

Web Universal URL setting

Options Description

[WebUDeployment] Section specifying the URL for


MicroStrategy Web Universal.

HideDialog = TRUE or FALSE. True displays the


dialog box. The default is FALSE.

SkipDeploymentSetting TRUE or FALSE. TRUE skips the


= Deployment setting. The default is
FALSE.

DeploymentDirectory = Specify a location for MicroStrategy


Web Universal installation, for
example, C:\Program
Files\MicroStrategy\Web JSP.

Web Services URL setting

Options Description

[OfficeWebServicesURL] Section specifying the URL for


MicroStrategy Web Services.

HideDialog = TRUE or FALSE. True displays the


dialog box. The default is FALSE.

248 Installing and configuring with a response.ini file 2005 MicroStrategy, Inc.
Installation and Configuration Guide Automated Installation and Configuration on Windows 10

Options Description

AllowBlankURL = TRUE or FALSE. Specify whether to


allow a blank URL. The installation
routine validates the provided URL. If
no URL is provided, the user is
informed that it has been left blank and
needs to be configured with the
MicroStrategy Office Configuration
Tool. If this is set to TRUE, the user
message is not displayed if the URL is
left blank. The default is FALSE.

URL = Enter a URL pointing to a valid


MicroStrategy Web Services
installation, for example,
http://localhost/Microstrate
gyWS/MSTRWS.asmx

MicroStrategy Office setting

Options Description

[MSOfficeLoadOptions] Section specifying the options that


determine if the MicroStrategy Office
toolbar is loaded in the installed
Microsoft Office applications.

HideDialog = TRUE or FALSE. True displays the


dialog box. The default is FALSE.

ConfigureExcel = TRUE or FALSE. Specify to load the


MicroStrategy Office toolbar by default
when the Microsoft Excel application
runs. This applies only if Excel is
installed in the target machine. The
default is TRUE.

ConfigureWord = TRUE or FALSE. Specify to load the


MicroStrategy Office toolbar by default
when the Microsoft Word application
runs. This applies only if Word is
installed on the target machine. The
default is TRUE.

ConfigurePowerpoint = TRUE or FALSE. Specify to load the


MicroStrategy Office toolbar by default
when the Microsoft PowerPoint
application runs. This applies only if
PowerPoint is installed on the target
machine. The default is TRUE.

2005 MicroStrategy, Inc. Installing and configuring with a response.ini file 249
10 Automated Installation and Configuration on Windows Installation and Configuration Guide

Intelligence Server definition setting

Options Description

[ServerDefinitionSetti Section specifying whether or not the


ng] MicroStrategy Intelligence Server will
use the server definition included with
the Tutorial.

HideDialog = TRUE or FALSE. True displays the


dialog box. The default is FALSE.

OverwriteServerDefinit TRUE or FALSE. This option relates to


ion = the Tutorial. Set this option to overwrite
existing MicroStrategy Intelligence
Server definitions from a previous
install. The default is FALSE.

Tutorial reporting setting

Options Description

[TutorialReportingSett Section that specifies the DSN used to


ing] connect to the MicroStrategy Tutorial.

HideDialog = TRUE or FALSE. True displays the


dialog box. The default is FALSE.

OverwriteDSN = TRUE or FALSE. Set this option to


overwrite an existing DSN with the
same name. The data source names
are as follows:
MicroStrategy_Tutorial_Meta
data
MicroStrategy_Tutorial_Data
The default is FALSE.

Start Copying Files dialog box

Options Description

[Summary] Section that specifies the installation


summary in the Start Copying Files
dialog box.

HideDialog = TRUE or FALSE. True displays the


dialog box. The default is FALSE.

250 Installing and configuring with a response.ini file 2005 MicroStrategy, Inc.
Installation and Configuration Guide Automated Installation and Configuration on Windows 10

InstallShield Wizard Complete dialog box

Options Description

[Finish] Section that specifies the InstallShield


Wizard Complete dialog box.

HideDialog = TRUE or FALSE. True displays the


dialog box. The default is FALSE.

Example of a response.ini file


[Installer]
PropertiesFilesOverwrite=FALSE
EnableTracing=FALSE
HideAllDialogs=TRUE
ForceReboot=TRUE
PreventReboot=FALSE
CheckTCPIP=TRUE
CheckIIS=TRUE
CheckSP=TRUE
CreateShortcuts=TRUE
CheckRenameOperations=TRUE
AnalyticsOverwrite=FALSE
TutReportingOverwrite=FALSE
TutDeliveryOverwrite=FALSE
BackupFiles=FALSE
RunConfigWizard=FALSE
StopAllServices=TRUE
StopIIS=TRUE
EnableASPServices=TRUE
EnableASPNETServices=TRUE
eTrainerForWebOverwrite=FALSE
ShowWelcomeScreen=FALSE
ShowConfigWizard=FALSE
EnterpriseManagerOverwrite=FALSE
ConfigWizardResponseFile=Response.ini
RegistrySizeReq=512
LogFile=c:\Program Files\install.log

[Welcome]
HideDialog=TRUE
RemoveAll=FALSE

[UserRegistration]

2005 MicroStrategy, Inc. Installing and configuring with a response.ini file 251
10 Automated Installation and Configuration on Windows Installation and Configuration Guide

HideDialog=TRUE
UserName=<user name here>
CompanyName=<Company name here>
LicenseKey=<Customer License Key here>

[SetupType]
HideDialog=TRUE
Type=TYPICAL

[SuiteTarget]
HideDialog=TRUE
TargetDirectory=C:\Program
Files\MicroStrategy

[ComponentSelection]
HideDialog=TRUE

### Visible Components ###


DesktopAnalystVisible=TRUE
DesktopDesignerVisible=TRUE
ArchitectVisible=TRUE
ProjectBuilderVisible=TRUE
ServerAdminVisible=TRUE
CommandManagerVisible=TRUE
EnterpriseManagerVisible=TRUE
ObjectManagerVisible=TRUE
IServerVisible=TRUE
WebReporterVisible=TRUE
WebAnalystVisible=TRUE
WebProfessionalVisible=FALSE
SDKVisible=TRUE
MDXAdapterVisible=TRUE
AnalyticsModulesVisible=TRUE
NCSAdminVisible=TRUE
DeliveryEngineVisible=TRUE
SubscriptionEngineVisible=FALSE
SubscriptionPortalVisible=TRUE
TransactorVisible=TRUE
TransactorServerComponentsVisible=TRUE
TransactorAdminVisible=TRUE
JMSGatewayVisible=FALSE
WebGatewayVisible=FALSE
TransactorDemoVisible=FALSE
TutorialReportingVisible=TRUE
TutorialDeliveryInstallVisible=TRUE
TutorialDeliveryConfigureVisible=TRUE

252 Installing and configuring with a response.ini file 2005 MicroStrategy, Inc.
Installation and Configuration Guide Automated Installation and Configuration on Windows 10

JDataConnectVisible=FALSE
RealAudioPlayerVisible=TRUE
WebUniversalReporterVisible=FALSE
WebUniversalAnalystVisible=FALSE
WebUniversalProfessionalVisible=FALSE
WebServicesASPNETVisible=TRUE
OfficeVisible=TRUE
eTrainerForWebVisible=TRUE
FunctionPluginVisible=TRUE
SequeLinkVisible=TRUE
IServerOLAPServicesVisible=TRUE
IServerReportServicesVisible=TRUE

### Components To Install (TRUE) or Remove


(FALSE) ###
DesktopAnalystSelect=TRUE
DesktopDesignerSelect=TRUE
ArchitectSelect=TRUE
ProjectBuilderSelect=TRUE
ServerAdminSelect=TRUE
CommandManagerSelect=TRUE
EnterpriseManagerSelect=TRUE
ObjectManagerSelect=TRUE
IServerSelect=TRUE
WebReporterSelect=TRUE
WebAnalystSelect=TRUE
WebProfessionalSelect=TRUE
SDKSelect=TRUE
MDXAdapterSelect=TRUE
AnalyticsModulesSelect=FALSE
NCSAdminSelect=TRUE
DeliveryEngineSelect=TRUE
SubscriptionPortalSelect=TRUE
TransactorSelect=TRUE
TransactorServerComponentsSelect=TRUE
TransactorAdminSelect=TRUE
TutorialReportingSelect=TRUE
TutorialDeliveryInstallSelect=TRUE
TutorialDeliveryConfigureSelect=TRUE
RealAudioPlayerSelect=TRUE
WebUniversalReporterSelect=FALSE
WebUniversalAnalystSelect=FALSE
WebUniversalProfessionalSelect=FALSE
WebServicesASPNETSelect=FALSE
OfficeSelect=TRUE
WebServerASPNETSelect=TRUE

2005 MicroStrategy, Inc. Installing and configuring with a response.ini file 253
10 Automated Installation and Configuration on Windows Installation and Configuration Guide

WebUniversalServerJSPSelect=TRUE
WebUniversalServerASPSelect=FALSE
eTrainerForWebSelect=TRUE
FunctionPluginSelect=FALSE
SequeLinkSelect=TRUE
IServerOLAPServicesSelect=TRUE
IServerReportServicesSelect=TRUE

[ServerDefinitionSetting]
HideDialog=TRUE
OverwriteServerDefinition=FALSE

[TutorialReportingSetting]
HideDialog=TRUE
OverwriteDSN=FALSE

[Transactor]
LoggerOutput=TRUE
LoggerDirectory=Logger

[WebVirtualDirectory]
HideDialog=TRUE
VirtualDirectory=MicroStrategy
ReconfigureVirtualDirectory=TRUE

[PortalVirtualDirectory]
HideDialog=TRUE
VirtualDirectory=NarrowcastServer
ReconfigureVirtualDirectory=TRUE

[WebServicesVirtualDirectory]
HideDialog=TRUE
VirtualDirectory=MicroStrategyWS
ReconfigureVirtualDirectory=TRUE

[eTrainerForWebVirtualDirectory]
HideDialog=TRUE
VirtualDirectory=eTrainer
ReconfigureVirtualDirectory=TRUE

[OfficeWebServicesURL]
HideDialog=TRUE
AllowBlankURL=FALSE
URL=http://localhost/MicroStrategyWS/mstrws.a
smx

254 Installing and configuring with a response.ini file 2005 MicroStrategy, Inc.
Installation and Configuration Guide Automated Installation and Configuration on Windows 10

[MSOfficeLoadOptions]
HideDialog=TRUE
ConfigureExcel=TRUE
ConfigurePowerpoint=TRUE
ConfigureWord=TRUE

[IServerServiceAccount]
HideDialog=TRUE
SkipAccountSetting=FALSE
Login=<NT userlogin here>
Password=<user password here>
Domain=<domain here>
ServiceStartUp=AUTO

[NarrowcastServiceAccount]
HideDialog=TRUE
SkipAccountSetting=FALSE
Login=<NT userlogin here>
Password=<user password here>
Domain=<domain here>

[TransactorServiceAccount]
HideDialog=TRUE
SkipAccountSetting=FALSE
Login=<NT userlogin here>
Password=<user password here>
Domain=<domain here>

[WebUDeployment]
HideDialog=TRUE
SkipDeploymentSetting=FALSE
DeploymentDirectory=C:\Program
Files\MicroStrategy\Web
JSP

[Programfolder]
HideDialog=TRUE
Name=MicroStrategy

[Summary]
HideDialog=TRUE

[Finish]
HideDialog=TRUE

2005 MicroStrategy, Inc. Installing and configuring with a response.ini file 255
10 Automated Installation and Configuration on Windows Installation and Configuration Guide

 Copy and paste this example to create a


response.ini file. Make sure you check for the
spaces and new lines for the file paths in the
[InitialPaths] section.

Using the response.ini file

To use the response.ini file, do one of the following:

Type the following command in the Windows command


line:

Setup.exe --ResponseFile=C:\response.ini

From the Windows Start menu, choose Run to open the


Run dialog box. Enter the same command in the box and
click OK.

The setup program supports several command-line


parameters. The following applies to this function:
Parameters using double dashes, such as --auto, are
defined by MicroStrategy. For example, you can use the
--auto parameter as follows:
setup.exe --Auto=TRUE
--LogFile=C:\install.log

The command line is not case sensitive.

The following parameters are supported by the setup


program:
Auto= instructs the setup program to use the response
file and default values to enable a one-click installation. If
a component, such as serial key or disk space has an
invalid value, the setup program automatically reverts to
multiple-click mode, and all dialog boxes are displayed.

ResponseFile= contains responses to installation


questions and redefines default parameters. The path and
file name must be in double quotes ( ). If you use this
parameter, do not use any other parameters.

ConfigFile= used by the Configuration Wizard to set


up a repository, a server, or a client. The path and file
name must be in double quotes ( ).

256 Installing and configuring with a response.ini file 2005 MicroStrategy, Inc.
Installation and Configuration Guide Automated Installation and Configuration on Windows 10

LogFile= used to specify an alternative location and/or


name (other than install.log) for the log file in the
Common Files directory. If only the file name is entered,
the default location remains the Common Files directory.
Once specified, the alternative file becomes the default.

Configuring a response.ini file for the Configuration Wizard


The Configuration Wizard walks you through the process of
setting up the environment for the MicroStrategy products
installed in your system. It is possible to configure server
definition, project source names, and the metadata repository
using a response.ini file.

To generate the response.ini file for the Configuration


Wizard you can use any of the following methods:

create a response.ini file in the Configuration Wizard


by clicking the Advanced button in the interface

create a response.ini file through a text editor

To create the response.ini file through the Configuration


Wizard

1 From the Windows Start menu, point to Programs then


MicroStrategy, and then choose Configuration Wizard.
The Configuration Wizard opens.

2 Click Advanced. The Advanced Options dialog box


opens.

3 Select one of the following:

Use Response File: to reuse an existing response file

Generate Response File: to create a new response


file, overwriting the existing one if there is any

 Itresponse.ini
is recommended that you always generate
file and configure it through the
Configuration Wizard.

2005 MicroStrategy, Inc. Installing and configuring with a response.ini file 257
10 Automated Installation and Configuration on Windows Installation and Configuration Guide

You can specify the location of the ini file in the


response.ini file of the installation or by adding the -r
switch when running the setup.exe from the command
line. For more information, see Using response.ini for
the Configuration Wizard, page 262 of this chapter.

The response.ini file has the following parameters and


options.

 0 means FALSE and 1 means TRUE.


Options Description

[Repository] This section configures the metadata


repository and statistics tables.

Repository = 1 or 0. If this is set to 1 then the Configuration


Wizard configures the metadata repository and
statistics table.

ConnType = This sets the type of database connection.

CreateConfig = 1 or 0. If it is set to 1, then the Configure


Default Configuration option is set.
Note: If CreateMDTables option is 1, then
you cannot set this option to 0 as this task will
be performed by default.

CreateMDTables = 1 or 0. If set to 1, the Configuration Wizard


performs the Create metadata table task to
create a metadata repository in the database
location of your choice. Also, the
CreateConfig option will be automatically
configured if this value is set to 1.

CreateStatTable 1 or 0. If this is set to 1, then the Configuration


= Wizard performs the Create statistics table
task.

MetadataPath = Specifies the path to the SQL scripts for


creating the metadata tables, for example,
C:\Program Files\Common Files
\MicroStrategy\MD8SQL8.sql.

StatisticsPath = Specifies the path to the SQL scripts for


creating the statistics table, for example,
C:\Program Files\Common
Files\MicroStrategy\statistics_SQL
Server.SQL

DSNName = Specifies the Data Source Name for


configuring a metadata repository in the ODBC
database.

258 Installing and configuring with a response.ini file 2005 MicroStrategy, Inc.
Installation and Configuration Guide Automated Installation and Configuration on Windows 10

Options Description

UserName = Specifies the user name to log into the


database.

UserPwd = Specifies the password to log into the


database.

DSNNameStats = Specifies the Data Source Name for


configuring a statistics table in the ODBC
database.

UserNameStats = Specifies the user name to log into the


database for configuring statistics tables.

UserPwdStats = Specifies the password to log into the database


for configuring statistics tables.

UsingMVS = 1 or 0. To create a repository in DB2 MVS, set


this option to 1.

DBName = Specifies the database name to create tables in


MVS.

TBName = Specifies the table name to be created in the


database.

EncryptPassword 1 or 0. By default it is set to 0. You can type the


= password in the response.ini file if it is set
to 1. If it is set to 0 then the value you type will
not be the same.

[Server] In this section you can configure the


Intelligence Server definition. You can have
more than one [Server] section.

Server = 1 or 0. To configure the Setup MicroStrategy


Intelligence Server option of Configuration
Wizard, set this option to 1.

Action = This option takes the following two values for


Intelligence Server configuration:
Set to 1 to create a new server definition
Set to 2 to use an existing server definition

InstanceName = Specifies the name of the Intelligence Server


instance.

DSName = Specifies the data source name, for example,


TEST.

DSNUser = Specifies the user name to log into the ODBC


database.

DSNPwd = Specifies the password to log into the ODBC


database.

2005 MicroStrategy, Inc. Installing and configuring with a response.ini file 259
10 Automated Installation and Configuration on Windows Installation and Configuration Guide

Options Description

EncryptPassword 1 or 0. By default it is set to 0. You can type the


= password in the response.ini file. If it is set
to 0, the value you type is not the same.

DSSUser = Specifies the MicroStrategy user name to log


into the project.

UseMultiProcess TRUE or FALSE sets the following options:


= TRUE to use MultiProcess
FALSE to use MultiThreaded
UseAsDefault = TRUE or FALSE. Set it to TRUE to use the newly
created Intelligence Server definition as the
default.
[Client] In this section you can configure the project
source name. You can have more than one
[Client] section. Additional client sections
can be written as [Client1], [Client2]
and so on.

Client = 1 or 0. To configure project sources, set this


option to 1.

DataSource = Specifies the name of the new project source to


create.

ConnType = Specifies the connection type. The following


connection types are supported:
2 connects to the metadata using an
ODBC DSN.
3 connects to the metadata through a
MicroStrategy Intelligence Server (3-tier).

DSN = If using connection type 2, specifies the name


of the ODBC database.

UserName = If using connection type 2, specifies the user


name to connect to the ODBC database.

UserPwd = If using connection type 2, specifies the


password to log into the database.

ServerName = If using connection type 3, specifies the name


of the MicroStrategy Intelligence Server that
you would like to connect to.

Port = If using connection type 3, specifies the port


number for the Intelligence Server when
creating a project source (3-tier project
source). The default port number for
MicroStrategy Intelligence Server is 34952.

MDType= 1 or 0. Specify the metadata type. By default it


is always 0.

260 Installing and configuring with a response.ini file 2005 MicroStrategy, Inc.
Installation and Configuration Guide Automated Installation and Configuration on Windows 10

Options Description

Hide = TRUE or FALSE. To hide the default project


sources displayed in the MicroStrategy
Desktop environment, set this option to TRUE.
By default it is always FALSE.

Authentication = The following authentication modes are


supported:
1Standard or login ID and password
entered by the user
2Network login ID (Windows
authentication)
8Guest account (Anonymous
authentication)
16LDAP authentication

Example of a Configuration Wizard


response.ini file

#This section configures the Metadata


Repository and Statistics Tables:
[Repository]
Repository=1
ConnType=1
CreateConfig=1
CreateMDTables=1
CreateStatTables=1
MetadataPath=C:\Program Files\Common
Files\MicroStrategy\MD7SQL7.sql
StatisticsPath=C:\Program Files\Common
Files\MicroStrategy\statistics_SQLServer.SQL
DSNName=
UserName=
UserPwd=
DSNNameStats=
UserNameStats=
UserPwdStats=
EncryptPassword=1
#In this section you can configure the server
definitions:
[Server]
Server=1
Action=1

2005 MicroStrategy, Inc. Installing and configuring with a response.ini file 261
10 Automated Installation and Configuration on Windows Installation and Configuration Guide

InstanceName=
DSName=TEST
DSNUser=vmall
EncryptPassword=1
DSSUser=Administrator
DSNPwd=wnnnbcmomx
UseMultiProcess=True
#In this section you can configure the
Project Source Names. You can have more than
one [Client] section.
[Client]
Client=1
DataSource=Test PSN
ConnType=3
UserName=AccessUser
ServerName=
Port=34952
DSSFile=C:\WINNT\
MDType=0
Hide=False
Authentication=1

Using response.ini for the Configuration


Wizard

To use the response.ini file, do one of the following:

Type the following command in the Windows command


line:
macfgwiz.exe -r c:\response.ini

 macfgwiz.exe
executable.
is the Configuration Wizard

From the Windows Start menu, choose Run to open the


Run dialog box. Enter the same command in the box and
click OK.

 For more details on configuring the Configuration


Wizard, see Chapter 5, Configuring MicroStrategy
Intelligence Server of this guide.

262 Installing and configuring with a response.ini file 2005 MicroStrategy, Inc.
Installation and Configuration Guide Automated Installation and Configuration on Windows 10

Uninstalling using a response.ini file


You can uninstall all MicroStrategy products at once using a
response.ini file. You must create a response file with the
RemoveAll parameter set to TRUE in the Welcome section.
This is also known as a silent uninstall.

Before uninstallation begins, the MicroStrategy application

Checks for user privileges. If they are not valid,


uninstallation stops.

Checks for running components. If one is found,


uninstallation stops.

Stops and deletes the MicroStrategy Intelligence Server


service.
Deletes application created files.

Example of a response.ini file


You can use the following response file to remove all
MicroStrategy products:

[Installer]
PropertiesFilesOverwrite=FALSE
EnableTracing=FALSE
HideAllDialogs=TRUE
ForceReboot=TRUE
PreventReboot=FALSE
CheckTCPIP=TRUE
CheckIIS=TRUE
CheckSP=TRUE
CreateShortcuts=TRUE
CheckRenameOperations=TRUE
AnalyticsOverwrite=FALSE
TutReportingOverwrite=FALSE
TutDeliveryOverwrite=FALSE
BackupFiles=FALSE
RunConfigWizard=FALSE

2005 MicroStrategy, Inc. Uninstalling using a response.ini file 263


10 Automated Installation and Configuration on Windows Installation and Configuration Guide

StopAllServices=TRUE
StopIIS=TRUE
EnableASPServices=FALSE
ConfigWizardResponseFile=
RegistrySizeReq=
LogFile=

[Welcome]
HideDialog=TRUE
RemoveAll=TRUE

[WebVirtualDirectory]
HideDialog=TRUE
VirtualDirectory=MicroStrategy
RemoveVD=YES

[PortalVirtualDirectory]
HideDialog=TRUE
VirtualDirectory=NarrowcastServer
RemoveVD=YES

[WebServicesDirectory]
HideDialog=TRUE
VirtualDirectory=MicroStrategyWS
RemoveVD=YES

[eTrainerForWebVirtualDirectory]
HideDialog=TRUE
VirtualDirectory=eTrainer
RemoveVD=YES

[Finish]
HideDialog=TRUE

For details on creating a response.ini file, see Creating a


response.ini file, page 234.

After you have created a response.ini file, use the


following script at the command prompt to uninstall all
MicroStrategy products:

<path>\setup.exe --ResponseFile=
<path>\<responsefilename>

where the path for setup.exe must be the path to the


original setup.exe used to install MicroStrategy products.

264 Uninstalling using a response.ini file 2005 MicroStrategy, Inc.


Installation and Configuration Guide Automated Installation and Configuration on Windows 10

Silent installation
A silent, or unattended, installation is one that presents no
user interface. Silent installations are useful for system
administrators who do not want users to interfere with the
installation. They are typically implemented by IT
departments that perform package-based installations across
the network, such as SMS. The silent installation can be used
for

deployment with Microsoft System Management Server


(SMS)

OEM installations

Silent installation through System Management


Server (SMS) environments

Upon setup completion, the System Management Server


(SMS) generates a Management Information Format (MIF)
file. There are two ways to generate the MIF file:

using the command line with the switch

-m<filename without extension>

adding the MIF section to the setup.ini file

 Uninstallation in SMS also generates a corresponding


MIF file if you use the command line with the switch
-m<filename without extension>.

OEM silent installation

You can use silent installation to easily embed MicroStrategy


products with other applications. The following sections
discuss the procedures for OEM silent installations.

All the requirements listed for standard installation must be


observed for successful silent installation. For details, see
Chapter 3, Installing MicroStrategy on Windows of this
guide.

2005 MicroStrategy, Inc. Silent installation 265


10 Automated Installation and Configuration on Windows Installation and Configuration Guide

To perform an OEM silent installation

When MicroStrategy products are installed as bundled


software with another product, the following procedure is
strongly recommended:

1 Create an installation response (response.ini) file for


the MicroStrategy products to install. The table that
follows shows which sections of the file are mandatory
and which are optional.

For detailed information regarding the contents of the


response.ini file, see Configuring a response.ini file
for installation, page 233.

Response File Section Selection

[Installer] Required

HideAllDialogs = Required

PreventReboot = Optional

StopAllServices = Optional

StopIIS = Optional

CheckRenameOperations = Optional

[UserRegistration] Required

[ComponentSelection] Required

EnterpriseManagerSelect = Required

[InitialPaths] Required

EnterpriseManager = Required

 for
Setting HideAllDialogs = TRUE causes the script
the response file to

use default values as specified in the response.ini


file

not require user input

keep the dialog flow consistent from one instance to


the next

266 Silent installation 2005 MicroStrategy, Inc.


Installation and Configuration Guide Automated Installation and Configuration on Windows 10

Consistency in the response file script from one instance


to the next is necessary; if setup.iss detects an
inconsistency in the dialog flow, installation is terminated
and a log file for the failure is created.

The only dialog flow modifications pertinent to silent


installation are specific to file location; therefore, the only
portion of the response.ini that may need to be
modified is the [InitialPaths] section.

2 Create the setup.iss file for the silent installation using


the response file, as follows:

[InstallShield Silent]
Version=v7.00
File=ResponseFile
[File Transfer]
OverwrittenReadOnly=NoToAll
[Application]
Name=MicroStrategy
Version=x.y.z
#x.y.z represent the version of the
product#
Company=MicroStrategy
Lang=0009
[{B339F3B3-E78C-45E8-B4D2-3C46C1C13663}-Dl
gOrder]
Count=0

3 Run the silent install with the response file as follows:

<path>\setup.exe -L0009
--ResponseFile="c:\response.ini" -s
-f1c:\setup.iss -f2c:\setup.log

You can bypass the language prompt by running setup.exe


with the command line option for the language. The following
table lists the values for the different languages that
MicroStrategy supports.

Language Value

English L0009

Italian L0010

Portuguese L0016

German L0007

2005 MicroStrategy, Inc. Silent installation 267


10 Automated Installation and Configuration on Windows Installation and Configuration Guide

Language Value

Spanish L000A

Japanese L0011

Korean L0012
Chinese L0004

Swedish L001D

French L000C

For example, to select Spanish as the user language, run the


silent install with the command line option for Spanish as
follows:

<path>\setup.exe -L000A

If the silent installation is successful, the resulting code value


is zero (ResultCode=0) in the setup.log file. If the setup
program encounters an invalid value for an installation
requirement, setup terminates and silent installation ceases.

Silent installation output

The system verifies compliance with installation


prerequisites and places related messages in a file created for
that purpose. The following applies to the generation and
storage of output messages during silent installation:
The MSTRInst.log file is created and placed in the
Temp folder.
The MSTRInst.log file is maintained during the entire
setup.

All system-generated messages, including messages


containing reasons for pre-installation termination, are
stored in the MSTRInst.log file.

 Ifsubsequent
there are installation termination messages in
installation instances that use the same
dialog flow, they are also stored in the
MSTRInst.log.

268 Silent installation 2005 MicroStrategy, Inc.


Installation and Configuration Guide Automated Installation and Configuration on Windows 10

The table below identifies the information that the


MSTRInst.log file includes.

Line Description

Function [F] Identifies the function calls in the


setup script.

Information [I] Logs information about the setup that


is running.

Warning [W] Includes feedback that you must


verify related to the setup. For
example, in normal mode, when
MicroStrategy applications are
running on a machine where the
setup is being run, you are prompted
to close all MicroStrategy applications
before proceeding. In silent mode,
you are not prompted, and instead
the setup terminates.

Severe [S] Includes fatal problems that prevent


the setup from proceeding. For
example, the Intelligence Server
Service cannot be created and setup
fails as a result.

A typical line in the MSTRInst.log file includes source file


name, function name, source line number, and time. It would
appear as follows:
[Z:\InstallMaster\Setup\Script
Files\MALicense.rul][UseDLL][l:
28][1318179ms][W] Le file
C:\WINDOWS\TEMP\{84D0D5E2-719A-
11D7-847C-000C293B5019}\{B339F3B3-E78C-45E
8-B4D2-3C46C1C13663}\MAInst.dll couldn't
be loaded in memory.

 When reviewing warning messages in the


MSTRInst.log file, look for [W] and [S] to find
related problems.

2005 MicroStrategy, Inc. Silent installation 269


10 Automated Installation and Configuration on Windows Installation and Configuration Guide

Troubleshooting silent installation

Silent installation may not work if you are installing in a


different environment than the one you recorded. This is the
case because any dialog box that was not recorded previously
is not recognized, such as if you are prompted to stop your
Intelligence Server or your IIS Web server. If this happens,
check
the version of Intelligence Server to ensure that you have
the right one for the products you are installing

you do not have any MicroStrategy applications running

the setup.log file to see if the ResultCode=0.

Check the install.log for any recorded errors during


installation and the MSTRInst.log file for any possible
errors

The most common errors are

-8, which is an invalid path to the InstallShield Silent


Response File .iss file.

-12, which is dialog boxes out of order. This occurs


because an unrecorded screen opened when playing
the silent install.

It is recommended that you create a silent install that can be


used with a response.ini file. For more information, see
OEM silent installation, page 265. This way you can change
the settings in the response.ini file without having to
generate a new .iss file.

270 Silent installation 2005 MicroStrategy, Inc.


Installation and Configuration Guide Automated Installation and Configuration on Windows 10

Silent installation of a hotfix


A hotfix is a file or a collection of files that you can apply to
MicroStrategy products installed on your computer to correct
a specific problem. Hotfixes are packaged in an executable
(.exe) file, which is a self-installing format. When you install a
hotfix, files are backed up automatically so that you can
remove the hotfix later.

You can apply a hotfix to MicroStrategy products using silent


installation. MicroStrategy supports silent installation of
hotfixes only for versions 7.5.3 and later.

To perform a silent installation of a hotfix

1 Insert the CD containing the Hotfix installable in the CD


drive.

2 Access the CD-ROM drive through the command prompt.

3 Run the silent install with the following command:

setup.exe /v" /qn

You can check the status of the silent installation in Windows


Task Manager. After applying the Hotfix, you can view it in
the Add/Remove Programs window.

2005 MicroStrategy, Inc. Silent installation 271


10 Automated Installation and Configuration on Windows Installation and Configuration Guide

272 Silent installation 2005 MicroStrategy, Inc.


11
AUTOMATED INSTALLATION
11.

AND CONFIGURATION ON
UNIX

Introduction

This chapter explains the various methods of performing a


fully automated and unattended installation and
configuration within the MicroStrategy platform when you do
not have access to a UNIX graphical user interface (GUI). The
chapter includes the following sections:
Silent installation

Configuring through command line mode

2005 MicroStrategy, Inc. 273


11 Automated Installation and Configuration on UNIX Installation and Configuration Guide

Silent installation
A silent or unattended installation is one that presents no
graphical user interface (GUI). Silent installations allow you
to automate the installation, so it can be called from a script
and executed without user interaction. Silent installations are
useful for system administrators who do not want users to
run the installation themselves. The silent installation can be
done on one or more computers.

Creating an options file


To run silent installation, you first create an options file and
then run it with the MicroStrategy InstallShield Wizard. Save
the options file as options.txt.

This options file or response file is used with the command


line argument -options to modify the wizard settings. The
settings that can be specified for the wizard are listed in the
next section, Settings that can be changed, page 275.

To use the options file

1 Log on to the computer where you are installing one or


more MicroStrategy products.

2 You can access the installation files and the options file
from a CD-ROM or you can ask your system
administrator to share the files in a network location. For
information on mounting or unmounting CD-ROMs, see
Mounting CD-ROMs, page 400 in Appendix E,
Troubleshooting.

3 Browse to the MicroStrategy7Installation/


QueryReportingAnalysis_UNIX directory and open
options.txt in a text editor.

4 Specify a value for a setting by replacing the characters


<value>. For information on how to specify its value, see
Chapter 4, Installing MicroStrategy on UNIX and Linux.

274 Silent installation 2005 MicroStrategy, Inc.


Installation and Configuration Guide Automated Installation and Configuration on UNIX 11

5 Save the changes to the options.txt file.

6 To use the options file on a silent installation, specify


-silent -options <file-name> as a command line
argument to the wizard, where <file-name> is the name of
this options file, for example, options.txt.

The following are examples using the native launchers:

Solaris: >setupsol.bin -silent -options


options.txt

AIX: >setupAIX.bin -silent -options


options.txt

Settings that can be changed


The following settings can be changed for a silent installation.
For details on settings, see Chapter 4, Installing
MicroStrategy on UNIX and Linux.

The settings follow their descriptions, in the format

-W settingname=<value>

Customer information

Your name, the name of the company for which you work,
and the license key.

User

-W userRegistration.user=<value>

Company

-W userRegistration.company=<value>

2005 MicroStrategy, Inc. Silent installation 275


11 Automated Installation and Configuration on UNIX Installation and Configuration Guide

License key

-W userRegistration.cdkey=<value>

MicroStrategy install locations

The install locations of the product. Specify valid directories


where the product should be installed.

Home directory

-W silent.homeDirectory=<value>

Install directory

-W silent.installDirectory=<value>

Log directory

-W silent.logDirectory=<value>

Product features

Legal values that you provide for all the product features are

true, which indicates that the feature is selected for


installation
false, which indicates that the feature is not selected for
installation

MicroStrategy Intelligence Server

The selection state of MicroStrategy Intelligence Server.

-P IServerFeature.active=<value>

For example, to select MicroStrategy Intelligence Server for


installation, use

-P IServerFeature.active=true

276 Silent installation 2005 MicroStrategy, Inc.


Installation and Configuration Guide Automated Installation and Configuration on UNIX 11

MicroStrategy Web Universal Analyst

The selection state of MicroStrategy Web Universal Analyst.

-P WebUAnalystFeature.active=<value>

For example, to select MicroStrategy Web Universal Analyst


for installation, use

-P WebUAnalystFeature.active=true

MicroStrategy Web Universal Reporter

The selection state of MicroStrategy Web Universal


Reporter.

-P WebUReporterFeature.active=<value>

For example, to select MicroStrategy Web Universal Reporter


for installation, use

-P WebUReporterFeature.active=true

MicroStrategy Web Universal Professional

-P WebUProfFeature.active=<value>

For example, to select MicroStrategy Web Universal


Professional for installation, use
-P WebUProfFeature.active=true

MicroStrategy SDK

The selection state of MicroStrategy SDK.


-P SDKFeature.active=<value>

For example, to select MicroStrategy SDK for installation, use

-P SDKFeature.active=true

2005 MicroStrategy, Inc. Silent installation 277


11 Automated Installation and Configuration on UNIX Installation and Configuration Guide

CPU license information

This value should be specified when the license being used for
MicroStrategy Intelligence Server is based on CPUs. Legal
values are integers between 1 and either the number of CPUs
allowed by the license or the number of CPUs in the machine,
whichever is lower.

-W cpuCountBean.cpuNumber=<value>

For example, the value

-W cpuCountBean.cpuNumber=
$J(install.cpuCount.maximum)

sets this option to the maximum value allowed.

MicroStrategy Web Universal application


deployment location

The deployment path of the application server where


MicroStrategy Web Universal is installed.

-W silent.keepDefaultDeployPath=<value>

You can keep the default application deployment path if you


are not using a WebLogic application server. To retain the
default path, set the value to true.

If you are using a WebLogic application server, set the value


for the default path to false. Then specify the absolute path
to the MicroStrategy Web Universal deployment location.
This location is used for reading and writing configuration
and log files.

-W silent.applicationDeployPath=<value>

MicroStrategy SDK installation location

The installation location for the MicroStrategy SDK.

-W silent.sdkDirectory="<value>"

278 Silent installation 2005 MicroStrategy, Inc.


Installation and Configuration Guide Automated Installation and Configuration on UNIX 11

Override options

The silent installation always overrides files from previous


installations.

 To preserve some files, do not use a silent installation.


Silent installation output
The installation returns 0 if the installation is successful and
any other value if it is not. The install.log file located in
the InstallPath directory provides more information on
possible errors. For more information on the install.log
file, see Installation log file, page 232 in Chapter 3, Installing
MicroStrategy on Windows.

 Ifstarts
the installation fails on any of the steps before it
copying the files, it does not give any feedback
other than the return value different from 0.

Configuring through command line mode


The MicroStrategy Configuration Wizard is provided in
command line mode so that you can use the Configuration
wizard through the operating system console if you do not
have access to the GUI. The Configuration Wizard (command
line mode) provides the following options:
Client: Creates MicroStrategy data sources in a 3-tier
mode.

 2-tier data sources are available only on the


Windows operating system.

Repository: Creates metadata and statistics tables.

Server: Creates new MicroStrategy Intelligence Server


definitions in the metadata, assigns an existing server
definition for the Intelligence Server, and deletes existing
server definitions.

2005 MicroStrategy, Inc. Configuring through command line mode 279


11 Automated Installation and Configuration on UNIX Installation and Configuration Guide

Using the Configuration Wizard in command line mode, you


can also generate a response file through the operating
system console and run it from the same console. See Using
the response.ini file through the Configuration Wizard,
page 288 for more details about this feature.

Creating a response.ini file for the Configuration Wizard


Using a response.ini file with the Configuration Wizard,
you can configure the server definition, project source names,
and the metadata repository. For more information on a
response.ini file, see Installing and configuring with a
response.ini file, page 233 in Chapter 10, Automated
Installation and Configuration on Windows.

To create the response.ini file for the Configuration


Wizard you can use any of the following methods:

Create a response.ini file in the GUI mode of the


Configuration Wizard by clicking the Advanced button in
the interface.

Create a response.ini file using the Configuration


Wizard in command line mode.

 Itresponse.ini
is recommended that you always create the
file through the GUI mode of the
Configuration Wizard. For more information, refer to
Creating a response.ini file for the Configuration
Wizard, page 280.

280 Configuring through command line mode 2005 MicroStrategy, Inc.


Installation and Configuration Guide Automated Installation and Configuration on UNIX 11

To create the response.ini file through the GUI mode of the


Configuration Wizard

 This procedure describes how to create a response file


while you are using the GUI mode of the Configuration
Wizard. To complete the entire configuration process
with the GUI mode, see Chapter 5, Configuring
MicroStrategy Intelligence Server.

1 In a UNIX console window, browse to <HOME_PATH>,


where <HOME_PATH> is the directory you specified as the
Home Directory during installation. Browse to the folder
bin.

2 Type ./mstrcfgwiz, then press ENTER. The


Configuration Wizard opens and the Welcome Screen is
displayed.

3 Click Advanced. The Configuration Wizard displays the


Advanced Options dialog box.

4 Select the Generate Response File option. Browse to the


path where the response file is to be saved.

5 Click Next. The Welcome Screen for the Configuration


Wizard opens again.

6 You must complete the wizard to generate the response


file; see Configuring MicroStrategy using the command
line mode, page 289 for steps to complete the
configuration.

7 At the end of the configuration, the following message


appears:

A response file will be generated. Would


you like to perform the configuration as
well?

Select Yes to perform both the tasks, or select No to


generate only the response file.

2005 MicroStrategy, Inc. Configuring through command line mode 281


11 Automated Installation and Configuration on UNIX Installation and Configuration Guide

To create the response.ini file through the Configuration


Wizard in command line mode

 This procedure describes how to create a response file


while you are using the command line mode of the
Configuration Wizard. To complete the entire
configuration process with the command line mode,
see Configuring MicroStrategy using the command
line mode, page 289.

1 In a UNIX console window, browse to <HOME_PATH>


where <HOME_PATH> is the directory you specified as the
Home Directory during installation. Browse to the folder
bin.

2 Type ./mstrcfgwiz-editor, then press ENTER. The


Configuration Wizard in command line mode opens.

3 Type 2 to select the Create Response file option, and


press ENTER. To complete the remaining steps to
generate the response file, see Configuring
MicroStrategy using the command line mode, page 289.

 Itresponse.ini
is recommended that you always create the
file through the GUI mode of the
Configuration Wizard.

Parameters and options in the response file

The response.ini file has the following parameters and


options.

Option Description

[Repository] Configures the metadata repository and


statistics tables. You can have more than one
[Repository] section.

Repository 1 or 0.
1: TRUE. The Configuration Wizard
configures the metadata repository and
statistics table.
0: FALSE.

282 Configuring through command line mode 2005 MicroStrategy, Inc.


Installation and Configuration Guide Automated Installation and Configuration on UNIX 11

Option Description

CreateConfig 1 or 0.
1: TRUE. The Configure Default
Configuration option is set. This setting is
dependent on the CreateMDTables setting,
described below. If the CreateMDTables
option is set to 1, then you cannot set the
CreateConfig option to 0 because this task
is performed by default.
0: FALSE.

DSNName Specifies the Data Source Name for


configuring a metadata repository in the ODBC
database.

UserName Specifies the user name to log into the


database.

UserPwd Specifies the password to log into the


database.

ConnType Sets the type of database connection.

CreateMDTables 1 or 0.
1: TRUE. The Configuration Wizard
performs the Create metadata table task to
create a metadata repository in the
database location of your choice. If this
value is set to 1, the CreateConfig option
above is automatically configured.
0: FALSE.

MetadataPath Specifies the path to the SQL scripts for


creating the metadata tables, for example,
\<INTELLIGENCE_SERVER_INSTALL_PATH
\md7sql.sql.

CreateStatTables 1 or 0.
1: TRUE. The Configuration Wizard
performs the Create statistics table task.
0: FALSE.

DSNNameStats Specifies the Data Source Name for


configuring a statistics table in the ODBC
database.

UserNameStats Specifies the user name to log into the


database for configuring statistics tables.

UserPwdStats Specifies the password to log into the


database for configuring statistics tables.

StatisticsPath Specifies the path to the SQL scripts for


creating the statistics table, for example,
\<INTELLIGENCE_SERVER_INSTALL_PATH
\statistics_DB2.sql.

2005 MicroStrategy, Inc. Configuring through command line mode 283


11 Automated Installation and Configuration on UNIX Installation and Configuration Guide

Option Description

MDPrefix Specifies the prefix for the metadata repository


tables.

UsingMVS 1 or 0. 1 represents TRUE and 0 FALSE.


1: TRUE. To create a repository in DB2
MVS (Multiple Virtual System), set this
option to 1.
0: FALSE.

DBName Specifies the database name to create tables


in MVS.

TBName Specifies the table name to be created in the


database.
EncryptPassword 1 or 0.
1: TRUE. Indicates that the password
indicated in the response.ini file will be
encrypted.
0: FALSE. Indicates that the password
indicated in the response.ini file will be
used exactly as typed, that is, it will not be
encrypted.

[Server] Configures the Intelligence Server definition.


You can have more than one [Server]
section.

Server 1 or 0.
1: TRUE. Configures the Setup
MicroStrategy Intelligence Server option of
the Configuration Wizard.
0: FALSE.

Action 1, 2, 3, or 4.
1: Creates a new Intelligence Server
definition.
2: Uses an existing Intelligence Server
definition.
3: Removes an existing Intelligence Server
definition.
4: Creates a new Intelligence Server
definition and use that as the default.

DSName Specifies the data source name, for example


TEST.

DSNUser Specifies the user name to log into the ODBC


database.

DSNPwd Specifies the password to log into the ODBC


database.

DSSUser Specifies the MicroStrategy user name to log


into the project.

284 Configuring through command line mode 2005 MicroStrategy, Inc.


Installation and Configuration Guide Automated Installation and Configuration on UNIX 11

Option Description

DSSPwd Specifies the password to log into the project.

UseMultiProcess TRUE or FALSE.


TRUE: Use MultiProcess.
FALSE: Use MultiThreaded.

MDPrefix Specifies the prefix for the metadata repository


tables.

TempTable Specifies the prefix to be used for the


temporary tables used by the server definition.

Port Specifies the port used by the Intelligence


Server.

InstanceName Specifies the Intelligence Server server


instance name.

ProjectsToRegiste Specifies the projects to register.


r

ProjectsToUnRegis Specifies the projects to unregister.


ter

EncryptPassword 1 or 0.
1: TRUE. Indicates that the password
indicated in the response.ini file will be
encrypted.
0: FALSE. Indicates that the password
indicated in the response.ini file will be
used exactly as typed, that is, it will not be
encrypted.

[Client] Configures the project source name. You can


have more than one [Client] section.
Additional client sections can be labeled as
[Client1], [Client2], and so on.

Client 1 or 0.
1: TRUE. Configures project sources.
0: FALSE.

DataSource Specify the name of the new project source to


create.

ConnType Specifies the connection type. The following


connection types are supported:
2: Connects to the metadata using an
ODBC DSN.
3: Connects to the metadata through a
MicroStrategy Intelligence Server 3-tier.

DSN If using connection type (ConnType) 2 above,


specifies the name of the ODBC database.

2005 MicroStrategy, Inc. Configuring through command line mode 285


11 Automated Installation and Configuration on UNIX Installation and Configuration Guide

Option Description

UserName If using connection type (ConnType) 2 above,


specifies the user name to connect to the
ODBC database.

UserPwd If using connection type (ConnType) 2 above,


specifies the password to log into the
database.

MDPrefix Specifies the prefix for the metadata repository


tables.
ServerName If using connection type (ConnType) 3 above,
specifies the name of the MicroStrategy
Intelligence Server to connect to.

Port If using connection type (ConnType) 3 above,


specifies the port number for the Intelligence
Server when creating a 3-tier project source.
The default port number for MicroStrategy
Intelligence Server is 34952.

Hide 1 or 0.
1: Hides the default project sources
displayed in the MicroStrategy Desktop
environment.
0: Default.

Authentication The following authentication modes are


supported:
1: Standard login ID and password entered
by the user.
2: Network login ID (Windows
authentication).
8: Guest account (anonymous
authentication).
16: LDAP authentication.

EncryptPassword 1 or 0.
1: TRUE. Indicates that the password
indicated in the response.ini file will be
encrypted.
0: FALSE. Indicates that the password
indicated in the response.ini file will be
used exactly as typed, that is, it will not be
encrypted.

286 Configuring through command line mode 2005 MicroStrategy, Inc.


Installation and Configuration Guide Automated Installation and Configuration on UNIX 11

Example of a response.ini file

#This section configures the metadata repository and


statistics tables:
[Repository]
Repository=1
CreateConfig=1
DSNName=Test DSN
UserName=svradm
UserPwd=
CreateDefaultPSN=0
DefaultPSN=
ConnType=300
CreateMDTables=1
MetadataPath=
CreateStatTables=1
DSNNameStats=Test DSN
UserNameStats=svradm
UserPwdStats=
StatisticsPath=
MDPrefix=
UsingMVS=0
DBName=
TBName=
EncryptPassword=1

#In this section you can configure the server defini-


tions:
[Server]
Server=1
Action=4
DSName=Test DSN
DSNUser=svradm
DSNPwd=
DSSUser=Administrator
DSSPwd=UseMultiProcess=1
MDPrefix=
TempTable=
Port=
InstanceName=
EncryptPassword=1

2005 MicroStrategy, Inc. Configuring through command line mode 287


11 Automated Installation and Configuration on UNIX Installation and Configuration Guide

#In this section you can configure the project source


names. You can have more than one [Client] section.
[Client]
Client=1
DataSource=Test PSN
ConnType=4
DSN=
UserName=User
UserPwd=
MDPrefix=null
ServerName=
Port=33333
Hide=0
Authentication=1
EncryptPassword=1

Using the response.ini file through the Configuration Wizard


This section describes how to use the response.ini file
through the MicroStrategy Configuration Wizard. For
information on how to configure through MicroStrategy
Configuration Wizard, see Configuring MicroStrategy using
the command line mode, page 289.

To use the response.ini file through the Configuration Wizard


in command line mode

1 In a UNIX console window, browse to <HOME_PATH>


where <HOME_PATH> is the directory you specified as the
Home Directory during installation. Browse to the folder
bin.

2 Type ./mstrcfgwiz, then press ENTER. The


Configuration Wizard opens with the Welcome page
displayed.

3 Click Advanced. The Configuration Wizard displays the


Advanced Options dialog box.

4 Select the Use Response File option and browse to the


location of the response.ini file.

288 Configuring through command line mode 2005 MicroStrategy, Inc.


Installation and Configuration Guide Automated Installation and Configuration on UNIX 11

5 Click Next. The summary information is displayed.

6 Click Finish to start the configuration.

Configuring MicroStrategy using the command line mode


This section describes how to configure MicroStrategy using
the command line mode.

To configure MicroStrategy using the command line mode

1 In a UNIX console window, browse to <HOME_PATH>


where <HOME_PATH> is the directory you specified as the
Home Directory during installation. Browse to the bin
directory.

2 At the command prompt, type ./mstrcfgwiz-editor,


then press ENTER. The Configuration Wizard in command
line mode opens.

The sections or pages of the wizard displayed depend on


your selections. All the sections are described in the
sequence in which they appear:

Welcome message

Section Content Options

Welcome statement Press any key to proceed to the


next section of the editor.

Main menu

Section Content Options

Options to use an existing Press 1 and ENTER to use an


response file or to create a new existing response file.
response file Press 2 and ENTER to create a
new response file.

2005 MicroStrategy, Inc. Configuring through command line mode 289


11 Automated Installation and Configuration on UNIX Installation and Configuration Guide

The next section that appears depends on your choice in this


step:

If you press 1, the Use response section is displayed. Refer


to Use response file, page 290.

If you press 2, the Configuration Wizard section is


displayed. Refer to Configuration Wizard main tasks,
page 290.

Use response file

Section Content Options

Prompt for response file path to be Type a valid path for the existing
executed in an unattended mode response file.

 Note the following:


If the path and the response file are valid, the
configuration is performed and the Successful
message appears. This step confirms that the
configuration was successful and the editor closes.

If an error occurs before or during the process, the Use


Response File Error message appears. This message
displays the error that occurred when executing the
response file, and the editor closes.

Configuration Wizard main tasks

Section Content Options

Options to configure metadata Press 1 and ENTER to configure


repository or statistics tables, to set tables for metadata repository
up MicroStrategy Intelligence and statistics.
Server, or to create a project Press 2 and ENTER to set up
source your MicroStrategy Intelligence
Server.
Press 3 and ENTER to create a
project source.

290 Configuring through command line mode 2005 MicroStrategy, Inc.


Installation and Configuration Guide Automated Installation and Configuration on UNIX 11

The next screen that appears depends on your choice in this


step:

If you press 1, the Create metadata tables section is


displayed. For more information, see Configuring
metadata and statistics tables, page 291.

If you press 2, the ODBC data source for server section is


displayed. For more information, see Setting up
MicroStrategy Intelligence Server, page 298.

If you press 3, the Project source name section is


displayed. For more information, see Creating a project
source, page 304.

Configuring metadata and statistics tables


You access this section by selecting option 1, Configure
Metadata Repository or Statistics tables, from the
Configuration Wizard main tasks window.

Create metadata tables

Section Content Options

Option to create metadata tables Press Y or N and ENTER. The


default answer is yes.

The next screen that appears depends on your choice in this


step:

If you choose to create metadata tables, ODBC data source


for metadata configuration section is displayed. For more
information, see ODBC data source for metadata
configuration, page 292.

If you choose not to create metadata tables, Create


metadata configuration section is displayed. For more
information, see Create metadata configuration,
page 294.

2005 MicroStrategy, Inc. Configuring through command line mode 291


11 Automated Installation and Configuration on UNIX Installation and Configuration Guide

ODBC data source for metadata configuration

Section Content Options

Option to specify name of the Type the name and press ENTER.
ODBC data source

If you specify a valid name for the ODBC data source, the
ODBC metadata login section is displayed. If you provide a
name that does not exist or the data source is not supported
for the metadata connection, an error message is displayed
along with the option to specify the correct name.

ODBC metadata login

Section Content Options

Option to specify login for the Type the name and press ENTER.
metadata

If you specify a login, the ODBC metadata password section is


displayed. If you do not enter a login, an error message is
displayed along with the option to specify a valid login.

ODBC metadata password

Section Content Options

Option to specify password for the Type the password and press
metadata ENTER.

After you specify a password, the Metadata prefix section is


displayed.

292 Configuring through command line mode 2005 MicroStrategy, Inc.


Installation and Configuration Guide Automated Installation and Configuration on UNIX 11

Metadata prefix

This step is optional.

Section Content Options

Option to specify prefix for the Type the prefix and press ENTER.
metadata To ignore this step, press ENTER.

The next section displayed depends on your ODBC data


source details:

If the data source points to a DB2 MVS database, MVS


database section is displayed. For more information, see
MVS database name, page 293.

If the data source does not point to an MVS database,


Metadata script section is displayed. For more
information, see Metadata script, page 294.

MVS database name

This step is optional.

Section Content Options

Option to specify name for the Type the name and press ENTER.
MVS database To ignore this step, press ENTER.

If you do not provide a name for the MVS database, the


default database is used. The next section displayed is the
MVS table space name.

MVS table space name

This step is optional.

Section Content Options

Option to specify name of the table Type the name and press ENTER.
space for the MVS database To ignore this step, press ENTER.

2005 MicroStrategy, Inc. Configuring through command line mode 293


11 Automated Installation and Configuration on UNIX Installation and Configuration Guide

If you do not provide a table space name for the MVS


database, the default name of the table space is used. The
next section displayed is the Metadata script section.

Metadata script

This step is optional.

Section Content Options

Option to specify location of the Type the path and press ENTER.
metadata script To use the default script, press
ENTER.

If you specify a valid path, the Create statistics tables section


is displayed. If the path is invalid, an error message is
displayed along with the option to specify a valid path.

Create metadata configuration

As described in the Create metadata tables section, Create


metadata configuration section is displayed if you choose not
to create metadata tables.

Section Content Options

Option to create metadata Press Y or N and ENTER.


configuration The default answer is yes.

The next screen that appears depends on your choice in this


step:
If you choose to create a metadata configuration, ODBC
data source for metadata configuration section is
displayed. For more information, see ODBC data source
for metadata configuration, page 292.

If you choose not to create a metadata configuration,


Create statistics tables section is displayed. For more
information, see Create statistics tables, page 295.

294 Configuring through command line mode 2005 MicroStrategy, Inc.


Installation and Configuration Guide Automated Installation and Configuration on UNIX 11

Create statistics tables

You access this step if you specify a valid path in the Metadata
script section, or if you choose not to create metadata tables
in the Create metadata tables section.

Section Content Options

Option to create statistics tables Press Y or N and ENTER.


The default answer is yes.

The next screen that appears depends on your choice in this


step:

If you choose to create statistics tables, the next section


that is displayed depends upon how you accessed this
Create statistics tables section:

If you answered Yes to the Create metadata tables


section above or Yes to the Create metadata
configuration section above, then you have already set
up information about ODBC. In this scenario, the Use
same ODBC info section is displayed. For more
information, see Use same ODBC info, page 296.

If you answered No to the Create metadata


configuration section, the ODBC data source for
statistics configuration section is displayed. For more
information, see ODBC data source for statistics
configuration, page 296.
If you choose not to create statistics tables, the Save
response file section is displayed. For more information,
see Save response file, page 297.

2005 MicroStrategy, Inc. Configuring through command line mode 295


11 Automated Installation and Configuration on UNIX Installation and Configuration Guide

Use same ODBC info

Section Content Options

Option to use ODBC information Press Y or N and ENTER.


provided earlier The default answer is yes.

The next screen that appears depends on your choice in this


step:

If you choose to use the ODBC information, the Statistics


script section is displayed. For more information, see
Statistics script, page 297.

If you choose not to use the same ODBC information, the


ODBC data source for statistics configuration section is
displayed. For more information, see ODBC data source
for statistics configuration, page 296.

ODBC data source for statistics configuration

Section Content Options

Option to specify name of the Type the name and press ENTER.
ODBC data source for statistics
configuration

If you specify a valid name for the ODBC data source for
statistics configuration, the ODBC statistics login section is
displayed. If you provide a name that does not exist or the
data source uses a database that is not allowed to create
statistics, an error message is displayed along with the option
to specify the correct name.

ODBC statistics login

Section Content Options

Option to specify login for the Type the name and press ENTER.
ODBC statistics

296 Configuring through command line mode 2005 MicroStrategy, Inc.


Installation and Configuration Guide Automated Installation and Configuration on UNIX 11

If you specify a login, the ODBC statistics password section is


displayed. If you do not enter a login, an error message is
displayed along with the option to specify the login.

ODBC statistics password

Section Content Options

Option to specify password for the Type the password and press
ODBC statistics ENTER.

After you specify a password, the Statistics script section is


displayed.

Statistics script

Section Content Options

Option to specify location of the Type the path and press ENTER.
statistics script To use the default script, simply
press ENTER.

If you specify a valid path, the Save response file section is


displayed. If the path is invalid, an error message is displayed
along with the option to specify a valid path.

Save response file

You access this step by specifying the location of the statistics


script in the Statistics script section above, or by answering
No in the Create statistics tables section above.

Section Content Options

Option to specify location where The default path is shown.


the response file will be saved To change the location, type a new
path and press ENTER.

2005 MicroStrategy, Inc. Configuring through command line mode 297


11 Automated Installation and Configuration on UNIX Installation and Configuration Guide

If you specify a valid path and the response file is saved, the
Finish metadata process section is displayed. If the path is
invalid or if there is a problem saving the response file, an
error message is displayed along with the option to specify a
valid path.

Finish metadata process

Section Content Options

Option to execute the response file Press Y or N and ENTER.


created The default answer is yes.

If you choose to execute the response file and the path is


valid, the configuration is performed and the Successful
message appears. This step confirms that the configuration
was successful and the editor closes. If you choose not to
execute the response file, the editor closes.

Setting up MicroStrategy Intelligence Server


You access this section by selecting option 2, Set Up a
MicroStrategy Intelligence Server from the Configuration
Wizard main tasks section.

ODBC data source for server

Section Content Options

Option to specify name of the Type the name and press ENTER.
ODBC data source for Intelligence
Server

If you specify a valid name for the ODBC data source, the
ODBC server login section is displayed. If you provide a name
that does not exist or the data source is not supported for the
metadata connection, an error message is dis