Installation Config
Installation Config
International Components for Unicode Copyright 1999-2013 Compaq Computer Corporation Copyright 1999-2013 Hewlett-Packard Company Copyright 1999-2013 IBM Corporation Copyright 1999-2013 Hummingbird Communications Ltd. Copyright 1999-2013 Silicon Graphics, Inc. Copyright 1999-2013 Sun Microsystems, Inc. Copyright 1999-2013 The Open Group All rights reserved. Real Player and RealJukebox are included under license from Real Networks, Inc. Copyright 1999-2013. All rights reserved.
CONTENTS
Book Overview and Additional Resources Description of this guide.......................................................... xiii About this book ............................................................................ xiv Additional formats .................................................................. xiv How to find business scenarios and examples .......................xv Whats new in this guide .........................................................xv Prerequisites .......................................................................... xvi Who should use this guide..................................................... xvi Resources................................................................................... xvii Documentation...................................................................... xvii Education ............................................................................. xxvi Consulting ............................................................................ xxvi International support ............................................................ xxvi Technical Support ............................................................... xxvii Feedback .................................................................................. xxxii 1. Planning Your Installation Introduction.................................................................................. 1 Upgrade considerations................................................................. 2 MicroStrategy components ............................................................ 2 MicroStrategy Developer products........................................... 3 MicroStrategy Command Manager .......................................... 4 MicroStrategy Object Manager ................................................ 5 MicroStrategy Enterprise Manager .......................................... 6 MicroStrategy Intelligence Server ............................................ 6 MicroStrategy Web and Web Universal ................................. 11 MicroStrategy Mobile ............................................................. 14 MicroStrategy SDK ................................................................ 15 MicroStrategy Integrity Manager............................................ 17
2013 MicroStrategy, Inc.
Contents
MicroStrategy System Manager............................................. 18 MicroStrategy Office .............................................................. 19 MicroStrategy Narrowcast Server .......................................... 20 MicroStrategy Analytics Modules........................................... 21 MicroStrategy Health Center.................................................. 22 Installation prerequisites .............................................................. 23 Recommended installation location and example deployments .......................................................................... 24 Hardware requirements and recommendations..................... 27 Software requirements and recommendations ...................... 38 Installation considerations ........................................................... 79 System sizing guidelines........................................................ 79 International support .............................................................. 86 MicroStrategy Web and Intelligence Server compatibility...... 86 Certified ODBC drivers for MicroStrategy Intelligence Server .................................................................................... 87 Recommended system settings for UNIX and Linux ............. 93 Methods of installation ................................................................. 94 Graphical user interface......................................................... 94 Command line........................................................................ 95 Silent installation .................................................................... 95 Creating custom installation packages .................................. 96 Licensing information................................................................... 98 Types of licenses ................................................................... 99 Installation and configuration checklists ...................................... 99 Installing and configuring MicroStrategy on Windows ......... 100 Installing and configuring MicroStrategy on UNIX and Linux .................................................................................... 101 2. Installing MicroStrategy on Windows Introduction.............................................................................. 103 Installation procedure ................................................................ 104 Installing with the MicroStrategy Installation Wizard............ 105 Installation verification ......................................................... 121 Installing with a guided MicroStrategy introduction.............. 122 Configuring your MicroStrategy installation ............................... 122 3. Installing MicroStrategy on UNIX and Linux Introduction.............................................................................. 125 Installation procedures on UNIX and Linux ............................... 126 Different methods of installation........................................... 127 Installing with the MicroStrategy Installation Wizard............ 129
vi
Contents
Unique post-installation configurations. ............................... 141 Verifying installation ............................................................. 142 Directory structure................................................................ 143 Configuring your MicroStrategy installation ............................... 144 4. Activating Your Installation Introduction.............................................................................. 145 Request an Activation Code ...................................................... 146 Activate your installation ............................................................ 148 Configuring your MicroStrategy installation ............................... 149 Server Activation FAQ ............................................................... 149 5. Configuring and Connecting Intelligence Server Introduction.............................................................................. 157 Communicating with databases: ODBC and DSNs ................... 158 Setting up ODBC ................................................................. 160 Defining DSNs ..................................................................... 165 Testing ODBC connectivity .................................................. 169 Initial MicroStrategy configuration.............................................. 171 Configuration Wizard prerequisites...................................... 172 Configuring MicroStrategy software..................................... 173 Creating metadata, History List, and statistics repositories .......................................................................... 179 Setting up MicroStrategy Intelligence Server....................... 190 Creating project sources ...................................................... 196 Configuring MicroStrategy with a response file.................... 201 Connecting to a data source...................................................... 210 Specifying warehouse connection information..................... 211 Creating a project ...................................................................... 227 Configuring your MicroStrategy installation ............................... 227 6. Deploying MicroStrategy Web and Mobile Server Introduction.............................................................................. 229 Deploying with IIS (Windows) .................................................... 230 Deploying MicroStrategy Web ............................................. 231 Deploying Mobile Server...................................................... 232 General steps to deploy MicroStrategy Web Universal or Mobile Server (JSP)................................................................... 234 Directory structure after deploying the WAR file .................. 235 Deploying with WebLogic and Apache (Solaris)........................ 236 WebLogic paths and folder locations ................................... 236
vii
Contents
Preconfiguration information ................................................ 237 Deploying MicroStrategy Web Universal or Mobile Server (JSP) ........................................................................ 239 Re-deploy the application .................................................... 248 Performance-based setup information................................. 248 Deploying with WebSphere and IBM HTTP Server (AIX).......... 253 Preconfiguration information ................................................ 254 Deploying MicroStrategy Web Universal or Mobile Server (JSP) ........................................................................ 256 Performance-based setup information................................. 264 Deploying with Oracle Glassfish Server (Solaris) ...................... 266 Preconfiguration information ................................................ 267 Deploying MicroStrategy Web Universal or Mobile Server (JSP) ........................................................................ 268 Undeploying MicroStrategy Web Universal or Mobile Server JSP........................................................................... 277 Deploying with Tomcat (Windows) ............................................ 278 Preconfiguration information ................................................ 278 Deploying MicroStrategy Web Universal or Mobile Server (JSP) ........................................................................ 282 Deploying with Tomcat (Linux) .................................................. 286 Preconfiguration information ................................................ 286 Deploying MicroStrategy Web Universal or Mobile Server (JSP) ........................................................................ 290 Deploying with SAP NetWeaver (Windows) .............................. 293 Preconfiguration information ................................................ 293 Deploying MicroStrategy Web Universal or Mobile Server (JSP) ........................................................................ 295 Deploying with Oracle 10g (Windows)....................................... 298 Preconfiguration information ................................................ 298 Deploying MicroStrategy Web Universal or Mobile Server (JSP) ........................................................................ 300 Deploying with JBoss (Windows)............................................... 303 Preconfiguration information ................................................ 304 Deploying MicroStrategy Web Universal or Mobile Server (JSP) ........................................................................ 306 Administering your MicroStrategy Web deployment.................. 310 Enabling users to install MicroStrategy Office from Web..... 310 Using absolute paths to share configuration files ...................... 312 Configuring Salesforce.com for Import Data.............................. 312 Configuring your MicroStrategy installation ............................... 315
viii
Contents
7. Setting Up Documents Introduction.............................................................................. 317 and HTML Documents Prerequisites.............................................................................. 318 Executing documents and HTML documents in UNIX/Linux ..... 318 Setup for creating and executing HTML documents............ 319 Setup for executing existing HTML documents ................... 323 Setup for executing Report Services documents................. 324 Configuring your MicroStrategy installation ............................... 325 8. Automated Installation on Windows Introduction.............................................................................. 327 Installation log file ...................................................................... 328 Methods of installation ............................................................... 329 Installing and configuring with a response.ini file....................... 329 Configuring a response.ini file to install MicroStrategy ........ 330 Configuring your installation with a response.ini file ............ 370 Uninstalling with a response.ini file ...................................... 371 Silent installation........................................................................ 373 Silent installations through System Management Server environments ....................................................................... 373 OEM silent installations........................................................ 374 Silent installation output ....................................................... 374 Activating silent installations ................................................ 375 Troubleshooting silent installations ...................................... 375 Silent installation of a hotfix ................................................. 376 Silent installation of MicroStrategy Office ............................ 377 Configuring your MicroStrategy installation ............................... 379 9. Automated Installation on UNIX and Linux Introduction.............................................................................. 381 Silent installation........................................................................ 382 Creating an options file ........................................................ 382 Parameters for a silent installation....................................... 385 Unique post-installation configurations ................................ 398 Silent installation output ....................................................... 398 Activating a silent installation ............................................... 399 Configuring MicroStrategy in command line mode .................... 399 Configuring your MicroStrategy installation ............................... 399 10. Deploying OEM Applications Introduction.............................................................................. 401 Creating DSNs for OEM environments...................................... 402
ix
Contents
Creating DSNs as part of an OEM deployment ................... 403 Configuring a MicroStrategy installation .................................... 404 Designing a project and reporting environment ......................... 404 Customizing MicroStrategy Web ............................................... 405 Deploying a MicroStrategy OEM application ............................. 406 OEM silent installations........................................................ 406 Configuring an OEM deployment installation....................... 410 Tuning an OEM deployment ...................................................... 411 Tuning with Command Manager.......................................... 411 Configuring MicroStrategy in command line mode .............. 412 Updating OEM applications ....................................................... 412 Modifying deployed OEM applications................................. 412 Deploying an OEM application update................................. 413 Troubleshooting support for MicroStrategy OEM applications................................................................................ 414 11. Configuring MicroStrategy Using Command Line Tools Introduction.............................................................................. 415 Creating a DSN for a data source.............................................. 416 Testing and examining ODBC connectivity ............................... 417 Configuring MicroStrategy with a response.ini file..................... 418 Creating a response.ini file .................................................. 419 Using the response.ini file to configure MicroStrategy......... 436 Parameters and options in the response.ini file ................... 436 Configuring and controlling Intelligence Server ......................... 437 Starting, configuring, and monitoring Intelligence Server with mstrsvr .............................................................. 437 Configuring the default server instance with mstrsvr-configure ................................................................. 438 Creating and configuring Intelligence Server instances with mstrctl ........................................................................... 439 Supporting reserved words and characters ............................... 441 Configuring your MicroStrategy installation ............................... 442 12. Adding or Removing MicroStrategy Components Introduction.............................................................................. 443 Adding or removing MicroStrategy components on Windows ... 444 Re-installing MicroStrategy components on Windows............... 445 Re-installing MicroStrategy Office........................................ 446 Uninstalling MicroStrategy components on Windows................ 447
Contents
Uninstalling MicroStrategy Office......................................... 448 Uninstalling MicroStrategy components on UNIX and Linux ..... 449 A. Connecting to Databases: ODBC and DSNs Introduction.............................................................................. 451 Creating DSNs for specific ODBC drivers ................................. 451 MicroStrategy ODBC Driver for DB2 Wire Protocol for Windows .............................................................................. 455 MicroStrategy ODBC Driver for DB2 for UNIX/Linux ........... 455 MicroStrategy ODBC Driver for DB2 Wire Protocol for iSeries/DB2 for i for Windows and UNIX/Linux .................... 456 MicroStrategy ODBC Driver for DB2 z/OS for Windows and UNIX/Linux.................................................................... 457 MicroStrategy ODBC Driver for Greenplum Wire Protocol for Windows and UNIX/Linux ............................................... 457 MicroStrategy ODBC Driver for Apache Hive Wire Protocol for Windows and UNIX/Linux................................. 458 MicroStrategy ODBC Driver for Impala Wire Protocol for Windows and UNIX/Linux .................................................... 458 MicroStrategy ODBC Driver for Informix Wire Protocol for Windows and UNIX/Linux .................................................... 459 MicroStrategy ODBC Driver for Informix 8 for Windows ...... 459 MicroStrategy ODBC Driver for MySQL Wire Protocol for Windows and Linux.............................................................. 460 MicroStrategy ODBC Driver for Oracle Wire Protocol for Windows and UNIX/Linux .................................................... 461 MicroStrategy ODBC Driver for Sybase ASE Wire Protocol for Windows and UNIX/Linux................................. 462 MicroStrategy ODBC Driver for PostgreSQL Wire Protocol for Windows and UNIX/Linux................................. 463 SQL Server for Windows and UNIX/Linux ........................... 463 Netezza SQL for Windows................................................... 465 MicroStrategy ODBC Driver for SequeLink.......................... 465 MicroStrategy ODBC Driver for Salesforce.......................... 470 ODBC Driver for Red Brick for UNIX/Linux.......................... 471 ODBC Driver for Sybase Adaptive Server IQ for UNIX/Linux........................................................................... 473 ODBC Driver for Teradata for UNIX/Linux ........................... 474 ODBC Driver for Informix 8 for UNIX ................................... 475 ODBC Driver for Netezza for UNIX/Linux ............................ 477 ODBC Driver for MySQL Community Server 5.x for Linux .................................................................................... 478 ODBC Driver for Aster Database for Linux .......................... 480 ODBC Driver for Vertica for Linux or Solaris........................ 482 ODBC Driver for SAP HANA for Windows and Linux .......... 484 xi
Contents
Other data sources and relational databases for Windows .............................................................................. 487 Configuring ODBC parameters with odbc.ini ............................. 493 Oracle Wire Protocol............................................................ 495 DB2 Wire Protocol ............................................................... 499 Informix 8 (XPS) .................................................................. 502 Informix Wire Protocol.......................................................... 504 Salesforce ............................................................................ 505 Sybase ASE Wire Protocol .................................................. 507 SQL Server Wire Protocol.................................................... 509 MySQL Wire Protocol .......................................................... 510 PostgreSQL and Greenplum Wire Protocols ....................... 512 ODBC .................................................................................. 514 Red Brick 6.x ....................................................................... 515 Sybase IQ ............................................................................ 515 Teradata Server ................................................................... 516 Netezza................................................................................ 518 B. Troubleshooting Introduction.............................................................................. 521 Installing MicroStrategy on UNIX............................................... 521 Mounting and unmounting CD-ROMs.................................. 522 Reviewing general installation errors......................................... 526 Graph and document support of non-Western European fonts ........................................................................................... 526 Server port number errors ......................................................... 527 I forgot the server port number ............................................ 527 Port number is in use ........................................................... 527 DSN connection errors .............................................................. 528 Testing the DSN connection failed in DSN Creator ............. 528 Metadata and other repository creation errors........................... 528 Creating a metadata fails due to insufficient page size........ 529 Creating a History List repository fails due to insufficient page size ............................................................................. 529 Permission errors....................................................................... 530 Missing JVM file ................................................................... 530 Glossary................................................................................................................................... 531 Index......................................................................................................................................... 537
xii
xiii
Your Installation, for important installation prerequisites before you begin installing MicroStrategy. details on how to progress through the remaining chapters of this For guide, see the section Installation and configuration checklists, page 99 of Chapter 1, Planning Your Installation. The appendixes contain the following additional reference information, which you may require depending on your specific needs: Appendix A, Connecting to Databases: ODBC and DSNs, provides details and steps to configure ODBC and DSNs for your data warehouse connections. Appendix B, Troubleshooting, provides various troubleshooting steps and techniques to take in certain installation and configuration scenarios.
in the MicroStrategy Tutorial project are updated to reflect the Dates current year. The sample documents and images in this guide, as well as the procedures, were created with dates that may no longer be available in the Tutorial project. Replace them with the first year of data in your Tutorial project.
Additional formats
This book is also available as an electronic publication in the Apple iBookstore, and can be read on an iPhone or iPad with the iBooks app
installed. To download this book, search for the books title in the iBookstore search bar, or scan the QR code below using your device's camera.
xv
MicroStrategy 9.4
Installation prerequisites and other important information has been updated to reflect MicroStrategy 9.4. This information is provided in Chapter 1, Planning Your Installation. Information on configuring the MicroStrategy ODBC Driver for Impala Wire Protocol is provided in MicroStrategy ODBC Driver for Impala Wire Protocol for Windows and UNIX/Linux, page 458.
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 Your systems configuration, including details such as hardware configuration, installed applications, available memory, and so on If installing on UNIX or Linux, the basics of the UNIX or Linux operating system
Resources
Documentation
MicroStrategy provides both manuals and online help; these two information sources provide different types of information, as described below: Manuals: In general, MicroStrategy manuals provide:
Introductory information and concepts Examples and images Checklists and high-level procedures to get started
The steps to access the manuals are described in Accessing manuals and other documentation sources, page xxiii. Most of these manuals are also available printed in a bound, soft cover format. To purchase printed manuals, contact your MicroStrategy Account Executive with a purchase order number. Help: In general, MicroStrategy help provides:
Detailed steps to perform procedures Descriptions of each option on every software screen
Translations
For the most up-to-date translations of MicroStrategy documentation, refer to the MicroStrategy Knowledge Base. Due to translation time, manuals in languages other than English may contain information that is one or more releases behind. You can see the version number on the title page of each manual.
Finding information
You can search all MicroStrategy books and Help for a word or phrase, with a simple Google search at www.google.com. For example, type MicroStrategy derived metric or MicroStrategy logical table into a Google search. As described above, books typically describe general concepts and examples; Help typically provides detailed steps and screen options. To limit
Resources
xvii
your search to MicroStrategy books, on Googles main page you can click More, then select Books.
xviii Resources
MicroStrategy Project Design Guide Information to create and modify MicroStrategy projects, and understand facts, attributes, hierarchies, transformations, advanced schemas, and project optimization.
MicroStrategy Basic Reporting Guide Instructions to get started with MicroStrategy Developer and MicroStrategy Web, and how to analyze data in a report. Includes the basics for creating reports, metrics, filters, and prompts.
MicroStrategy Advanced Reporting Guide: Enhancing Your Business Intelligence Application Instructions for advanced topics in the MicroStrategy system, building on information in the Basic Reporting Guide. Topics include reports, Freeform SQL reports, Query Builder reports, filters, metrics, Data Mining Services, custom groups, consolidations, and prompts.
Document and Dashboard Analysis Guide Instructions for a business analyst to execute and analyze a document in MicroStrategy Developer and MicroStrategy Web, building on basic concepts about projects and reports presented in the MicroStrategy Basic Reporting Guide.
MicroStrategy Report Services Document Creation Guide: Creating Boardroom Quality Documents Instructions to design and create Report Services documents, building on information in the Document and Dashboard Analysis Guide. It is organized to help guide you through creating a new document, from creating the document itself, to adding objects to the new document, and formatting the document and its objects.
MicroStrategy Dashboards and Widgets Creation Guide: Creating Interactive Dashboards for your Data Instructions for designing and creating MicroStrategy Report Services dashboards, a type of document that is optimized for viewing online and for user interactivity. It builds on the basic concepts about documents presented in the MicroStrategy Report Services Document Creation Guide.
Resources
xix
MicroStrategy OLAP Services Guide Information on MicroStrategy OLAP Services, which is an extension of MicroStrategy Intelligence Server. OLAP Services features include Intelligent Cubes, derived metrics, derived elements, dynamic aggregation, view filters, and dynamic sourcing.
MicroStrategy Office User Guide Instructions for using MicroStrategy Office to work with MicroStrategy reports and documents in Microsoft Excel, PowerPoint, and Word, to analyze, format, and distribute business data.
MicroStrategy Mobile Analysis Guide: Analyzing Data with MicroStrategy Mobile Information and instructions for using MicroStrategy Mobile to view and analyze data, and perform other business tasks with MicroStrategy reports and documents on a mobile device.
MicroStrategy Mobile Design and Administration Guide: A Platform for Mobile Intelligence Information and instructions to install and configure MicroStrategy Mobile, as well as instructions for a designer working in MicroStrategy Developer or MicroStrategy Web to create effective reports and documents for use with MicroStrategy Mobile.
MicroStrategy System Administration Guide: Tuning, Monitoring, and Troubleshooting your MicroStrategy Business Intelligence System Concepts and high-level steps to implement, deploy, maintain, tune, and troubleshoot a MicroStrategy business intelligence system.
MicroStrategy Supplemental Reference for System Administration: VLDB Properties, Internationalization, User Privileges, and other Supplemental Information for Administrators Information and instructions for MicroStrategy administrative tasks such as configuring VLDB properties and defining data and metadata internationalization, and reference material for other administrative tasks.
MicroStrategy Functions Reference Function syntax and formula components; instructions to use functions in metrics, filters, attribute forms; examples of functions in business scenarios.
xx Resources
MicroStrategy MDX Cube Reporting Guide Information to integrate MicroStrategy with MDX cube sources. You can integrate data from MDX cube sources into your MicroStrategy projects and applications.
Resources
xxi
xxii Resources
Help
Each MicroStrategy product includes an integrated help system to complement the various interfaces of the product as well as the tasks that can be accomplished using the product. Some of the MicroStrategy help systems require a web browser to be viewed. For supported web browsers, see the MicroStrategy Readme. MicroStrategy provides several ways to access help: Help button: Use the Help button or ? (question mark) icon on most software windows to see help for that window. Help menu: From the Help menu or link at the top of any screen, select MicroStrategy Help to see the table of contents, the Search field, and the index for the help system. F1 key: Press F1 to see context-sensitive help that describes each option in the software window you are currently viewing. MicroStrategy Web, MicroStrategy Web Administrator, and For MicroStrategy Mobile Server, pressing the F1 key opens the context-sensitive help for the web browser you are using to access these MicroStrategy interfaces. Use the Help menu or ? (question mark) icon to access help for these MicroStrategy interfaces.
Resources
xxiii
1 Visit http://www.microstrategy.com/producthelp.
To access documentation resources on Windows
1 From the Windows Start menu, choose Programs (or All Programs), MicroStrategy Documentation, then Product Manuals. A page opens in your browser showing a list of available manuals in PDF format and other documentation sources. 2 Click the link for the desired manual or other documentation source. 3 If you click the link for the Narrowcast Services SDK Guide, a File Download dialog box opens. This documentation resource must be downloaded. Select Open this file from its current location, and click OK. bookmarks are not visible on the left side of an Acrobat (PDF) If manual, from the View menu click Bookmarks and Page. This step varies slightly depending on your version of Adobe Acrobat Reader.
To access documentation resources on UNIX and Linux
1 Within your UNIX or Linux machine, navigate to the directory where you installed MicroStrategy. The default location is /opt/MicroStrategy, or $HOME/MicroStrategy/install if you do not have write access to /opt/MicroStrategy. 2 From the MicroStrategy installation directory, open the Help folder. 3 Open the Product_Manuals.htm file in a web browser. A page opens in your browser showing a list of available manuals in PDF format and other documentation sources. 4 Click the link for the desired manual or other documentation source. 5 If you click the link for the Narrowcast Services SDK Guide, a File Download dialog box opens. This documentation resource must be
xxiv Resources
downloaded. Select Open this file from its current location, and click OK. bookmarks are not visible on the left side of an Acrobat (PDF) If manual, from the View menu click Bookmarks and Page. This step varies slightly depending on your version of Adobe Acrobat Reader.
Documentation standards
MicroStrategy online help and PDF manuals (available both online and in printed format) use standards to help you identify certain types of content. The following table lists these standards. standards may differ depending on the language of this manual; These some languages have rules that supersede the table below.
Type bold Indicates Button names, check boxes, options, lists, and menus that are the focus of actions or part of a list of such GUI elements and their definitions Example: Click Select Warehouse. italic Names of other product manuals and documentation resources When part of a command syntax, indicates variable information to be replaced by the user Example: The aggregation level is the level of calculation for the metric. Example: Type copy c:\filename d:\foldername\filename Calculations Code samples Registry keys Path and file names URLs Messages displayed in the screen Text to be entered by the user
Courier font
Example: Sum(revenue)/number of months. Example: Type cmdmgr -f scriptfile.scp and press Enter. + A keyboard command that calls for the use of more than one key (for example, SHIFT+F1). A note icon indicates helpful information for specific situations. A warning icon alerts you to important information such as potential security risks; these should be read before continuing.
Resources
xxv
Education
MicroStrategy Education Services provides a comprehensive curriculum and highly skilled education consultants. Many customers and partners from over 800 different organizations have benefited from MicroStrategy instruction. Courses that can help you prepare for using this manual or that address some of the information in this manual include: MicroStrategy Developer: Reporting Essentials MicroStrategy Web: Report Analysis MicroStrategy Web: Report Design
For a detailed description of education offerings and course curriculums, visit www.microstrategy.com/Education.
Consulting
MicroStrategy Consulting Services provides proven methods for delivering leading-edge technology solutions. Offerings include complex security architecture designs, performance and tuning, project and testing strategies and recommendations, strategic planning, and more. For a detailed description of consulting offerings, visit http://www.microstrategy.com/ Services.
International support
MicroStrategy supports several locales. Support for a locale typically includes native database and operating system support, support for date formats, numeric formats, currency symbols, and availability of translated interfaces and certain documentation. 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), Chinese (Traditional), Danish, and Swedish. A translated user interface is available in each of the above languages. For information on specific languages supported by individual MicroStrategy system components, see the MicroStrategy readme.
xxvi Resources
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.
Technical Support
If you have questions about a specific MicroStrategy product, you should: 1 Consult the product guides, Help, and readme files. Locations to access each are described above. 2 Consult the MicroStrategy Knowledge Base online at https:// resource.microstrategy.com/support. technical administrator in your organization may be able to help A you resolve your issues immediately. 3 If the resources listed in the steps above do not provide a solution, contact MicroStrategy Technical Support directly. To ensure the most productive relationship with MicroStrategy Technical Support, review the Policies and Procedures document in your language, posted at http:// www.microstrategy.com/Support/Policies. Refer to the terms of your purchase agreement to determine the type of support available to you. MicroStrategy Technical Support can be contacted by your companys Support Liaison. A Support Liaison is a person whom your company has designated as a point-of-contact with MicroStrategys support personnel. All customer inquiries and case communications must come through these named individuals. Your company may designate two employees to serve as their Support Liaisons, and can request to change their Support Liaisons two times per year with prior written notice to MicroStrategy Technical Support. It is recommended that you designate Support Liaisons who have MicroStrategy Administrator privileges. This can eliminate security conflicts and improve case resolution time. When troubleshooting and researching issues, MicroStrategy Technical Support personnel may make recommendations that require administrative privileges within MicroStrategy, or that assume that the designated Support 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.
Resources
xxvii
xxviii Resources
Interface. The individual Technical Support Centers are closed on certain public holidays.
North America Email: [email protected] Web: https://resource.microstrategy.com/support Fax: (703) 8428709 Phone: (703) 8488700 Hours: 9:00 A.M.7:00 P.M. Eastern Time, MondayFriday except holidays Email: [email protected] Web: https://resource.microstrategy.com/support Fax: +44 (0) 208 711 2525 The European Technical Support Centre is closed on national public holidays in each country. Phone: Belgium: + 32 2792 0436 France: +33 17 099 4737 Germany: +49 22 16501 0609 Ireland: +353 1436 0916 Italy: +39 023626 9668 Poland: +48 22 459 52 52 Scandinavia & Finland: +46 8505 20421 Spain: +34 91788 9852 The Netherlands: +31 20 794 8425 UK: +44 (0) 208 080 2182 International distributors: +44 (0) 208 080 2183 Hours: United Kingdom: 9:00 A.M.6:00 P.M. GMT, Monday-Friday except holidays EMEA (except UK): 9:00 A.M.6:00 P.M. CET, Monday-Friday except holidays Email: [email protected] Web: https://resource.microstrategy.com/support Phone: Australia: +61 2 9333 6499 Korea: +82 2 560 6565 Fax: +82 2 560 6555 Japan: +81 3 3511 6720 Fax: +81 3 3511 6740 Singapore: +65 6303 8969 Fax: +65 6303 8999 Asia Pacific (except Australia, Japan, Korea, and Singapore): +86 571 8526 8067 Fax: +86 571 8848 0977 Hours: Japan and Korea: 9:00 A.M.6:00 P.M. JST (Tokyo), Monday-Friday except holidays Asia Pacific (except Japan and Korea): 7 A.M.-6 P.M. (Singapore) Monday-Friday except holidays Email: [email protected] Web: https://resource.microstrategy.com/support Phone: LATAM (except Brazil and Argentina): +54 11 5222 9360 Fax: +54 11 5222 9355 Argentina: 0 800 444 MSTR Fax: +54 11 5222 9355 Brazil: +55 11 3054 1010 Fax: +55 11 3044 4088 Hours: Latin America (except Brazil): 9:00 A.M.7:00 P.M. (Buenos Aires), Monday-Friday except holidays Brazil: 9 A.M. - 6 P.M. (So Paulo), MondayFriday except holidays
Asia Pacific
Latin America
Resources
xxix
Support Liaisons should contact the Technical Support Center from which they obtained their MicroStrategy software licenses or the Technical Support Center to which they have been designated.
Name (first and last) Company and customer site (if different from company) Contact information (phone and fax numbers, e-mail addresses)
Case details:
Configuration information, including MicroStrategy software product(s) and versions Full description of the case including symptoms, error messages(s), and steps taken to troubleshoot the case thus far
Business/system impact
If this is the Support Liaisons first call, they should also be prepared to provide the following: Street address Phone number Fax number Email address
To help the Technical Support representative resolve the problem promptly and effectively, be prepared to provide the following additional information: Case number: Please keep a record of the number assigned to each case logged with MicroStrategy Technical Support, and be ready to provide it when inquiring about an existing case Software version and product registration numbers of the MicroStrategy software products you are using
xxx Resources
Case 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, or 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 depends on the nature of the problem; not all items listed below 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, the Support Liaison and the MicroStrategy Technical Support representative should agree on certain action items to be performed. The Support Liaison should perform any agreed-upon actions before contacting MicroStrategy Technical Support again regarding the issue. If the Technical Support representative is responsible for an action item, the Support Liaison may call MicroStrategy Technical Support at any time to inquire about the status of the issue.
Resources
xxxi
Feedback
Please send any comments or suggestions about user documentation for MicroStrategy products to: [email protected] Send suggestions for product enhancements to: [email protected] 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.
xxxii Feedback
1
1.
Introduction
MicroStrategy business intelligence tools help organizations to monitor, report, and analyze all of their enterprise data. MicroStrategy 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 and describes important installation prerequisites that should be considered before you start installing MicroStrategy products. MicroStrategy products that you can install depend on your The MicroStrategy license. Contact your MicroStrategy account executive with MicroStrategy licensing questions. This chapter provides the following information: Upgrade considerations, page 2 MicroStrategy components, page 2 Installation prerequisites, page 23
1
Installation considerations, page 79 Methods of installation, page 94 Licensing information, page 98 Installation and configuration checklists, page 99
Upgrade considerations
If you have MicroStrategy products installed and want to upgrade them, refer to the MicroStrategy Upgrade Guide. The upgrade procedures on Windows, UNIX, and Linux are covered in this guide. It is recommended that you read this guide before deciding to upgrade an existing metadata.
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. you are familiar with MicroStrategy components and If subcomponents, you can skip this section and go to Installation prerequisites, page 23. section discusses MicroStrategy components and their This subcomponents in relation to how the components are grouped together during the installation routine. These groups are meant to help guide you in selecting MicroStrategy products during your installation. The groups do NOT represent MicroStrategy product license requirements. For information on license requirements for MicroStrategy products, contact your MicroStrategy account executive.
2 Upgrade considerations
MicroStrategy Architect, page 4, which is a new project design tool. MicroStrategy Function Plug-in Wizard is an add-in to the Microsoft Visual C++ compiler, which comes with a standard MicroStrategy installation. It allows you to create a C++ project, with which you can implement your own custom MicroStrategy function plug-in. The option to install this component is enabled only if Microsoft Visual C++ version 2005 (8.0) or version 2010 (10.0) is present on the system where the installation is being performed. Customers interested in deploying analytics from the R programming language into MicroStrategy can do so using the R Integration Pack, available separately from the CodePlex open source community web site. For more information, go to http://www.codeplex.com and search for the RIntegrationPack project (current as of March 1, 2013).
MicroStrategy components
MicroStrategy Server Administrator is a MicroStrategy Intelligence Server administrative console that provides functionality such as system monitoring, cache management, and user and group management. installing MicroStrategy Developer, your license key must When be licensed for MicroStrategy Intelligence Server to install and access MicroStrategy Server Administrator.
For information on various options present in Developer to create and run reports, refer to the MicroStrategy Basic Reporting Guide. After you are familiar with basic Developer concepts, refer to the MicroStrategy Advanced Reporting Guide for information on advanced Developer functionality.
MicroStrategy Architect
MicroStrategy includes a project design tool known as Architect. Architect allows you to define all the required components of your project from a centralized interface. Architect also provides a visual representation of your project as you create it, which helps to provide an intuitive workflow. For information on using Architect to design a project in MicroStrategy, see the Project Design Guide.
4 MicroStrategy components
Additionally, Command Manager allows you to manage various configuration settings within the MicroStrategy platform.
For information on using Command Manager, see the System Administration Guide.
For information on using Object Manager, see the System Administration Guide.
MicroStrategy components
For information on using Enterprise Manager, see the System Administration Guide.
6 MicroStrategy components
Efficiently manages thousands of end-user requests (jobs) Serves as a central point for the MicroStrategy metadata
Intelligence Server also provides a library of over 150 different sophisticated mathematical and statistical functions, which can be added to. See the Functions Reference for details about these functions. All other products in the platform work in conjunction with Intelligence Server and benefit from its broad functionality. MicroStrategy has different editions of Intelligence Server, which are: Enterprise edition Universal edition
The Enterprise edition is a Windows versions of Intelligence Server, whereas the Universal edition is platform-independent. The Universal edition can be installed on various operating systems such as Windows, UNIX, Linux, and so on. The Enterprise and Universal editions of 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.
Functionality Windows Authentication Custom Function Plug-in Intelligence Server SDK Intelligence Server Universal Edition Supported Not supported MicroStrategy SDK applications can be run against Intelligence Server Universal Edition, but they need to be executed from a Windows machine Supported, through the use of the MicroStrategy ODBC Driver for SequeLink (see MicroStrategy ODBC Driver for SequeLink, page 465) Supports Windows and UNIX/Linux operating systems for all applicable CPU architectures. For information on the supported CPU architectures, see: Windows: MicroStrategy product: Intelligence Server, page 44 UNIX/Linux: Intelligence Server Universal software requirements on UNIX/Linux, page 57 Intelligence Enterprise Edition Supported Supported Supported
Microsoft Access
Supported
MicroStrategy components
8 MicroStrategy components
For information on Report Services, see the Report Services Document Creation Guide and the Document and Dashboard Analysis Guide.
MicroStrategy components
dashboards, and business performance alerts via email, file servers, and networked printers.
MultiSource Option
MicroStrategy includes an extension to Intelligence Server referred to as MultiSource Option. With this feature, you can connect a project to multiple relational data sources. This allows you to integrate all your information from various databases and other relational data sources into a single MicroStrategy project for reporting and analysis purpose. All data sources
10 MicroStrategy components
included using the MultiSource Option are integrated as part of the same relational schema for a project.
For information on using MultiSource Option, see the Project Design Guide.
MicroStrategy components
In addition to the powerful functionality that MicroStrategy Web offers, MicroStrategy Web Universal provides the added benefit of working with: Operating systems such as Oracle Solaris, IBM AIX, and HP-UX Application servers such as Oracle WebLogic and IBM WebSphere Web servers and Web browsers
For information on how to deploy MicroStrategy Web and Web Universal, see Chapter 6, Deploying MicroStrategy Web and Mobile Server. 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.
Server license options provide access to certain services Intelligence in MicroStrategy Web and Web Universal versions. For example, the Web Analyst version allows for the creation of derived metrics only if the Intelligence Server license includes OLAP Services.
12 MicroStrategy components
MicroStrategy Portlets
Though different portal products typically require different integration approaches, you can integrate MicroStrategy content and functionality into your portal using one of the out-of-the-box MicroStrategy Portlets. Each out-of-the-box MicroStrategy Portlet provides a full complement of portlet features that are not found in any single portal server product, and combines the most useful features of the portlet mechanisms currently available. These portlets are designed to take advantage of the storage and repository mechanisms of its particular portal product, without requiring users to make any adjustments or changes when implementing portlets within a portal. MicroStrategy Portlets can embed folders, reports, documents, user History Lists, and a search page into the portals through easy-to-configure screens. The portlets provide the full range of OLAP manipulations such as sort, pivot, add subtotals, export, and add new calculations, as well as design functionalities such as changing the report display between grids and graphs, and toggling thresholds. In portal environments, users are commonly already logged in and authenticated with the portal. This authentication can also be used to provide access to MicroStrategy Web within the portal without having to re-enter their login information. This process is known as single sign-on. Out-of-the-box MicroStrategy Portlets automatically include support for single sign-on. For information on how to install and configure out-of-the-box MicroStrategy Portlets for several major enterprise portal servers, see the Enterprise Portal Integration Help. This resource can be accessed from the MicroStrategy Product Manuals page, as described in Accessing manuals and other documentation sources, page xxiii.
MicroStrategy components
13
MicroStrategy Mobile
MicroStrategy Mobile is an interactive interface of the MicroStrategy BI platform that lets mobile business users harness the analytical power of MicroStrategy through the use of their mobile devices: MicroStrategy Mobile for BlackBerry: MicroStrategy Mobile for BlackBerry lets mobile business users run reports and dashboards directly from their BlackBerry mobile devices from Research in Motion. With MicroStrategy Mobile, business users receive the same reports on their BlackBerry smartphones as they do via MicroStrategy Web, MicroStrategy Office, or MicroStrategy Developer, without the need for reformatting or retrofitting existing reports. The report manipulation features available in MicroStrategy Mobile allow users to view even the largest reports within the compact screen size of the BlackBerry smartphone. Designed for all levels of users, MicroStrategy Mobile reports are displayed in an easy-to-view and easy-to-navigate format, enabling users to review, analyze, and interact with important data at their convenience. Users can also access reports while they are offline, or when their BlackBerry is not within connectivity range. MicroStrategy Mobile uses the same robust security features of the MicroStrategy platform as well as the security infrastructure provided by the BlackBerry Enterprise Server. MicroStrategy Mobile for iPhone, iPad, and Android devices: MicroStrategy Mobile and the MicroStrategy Mobile Server provide MicroStrategy reporting and analysis capabilities on iPhone, iPad, and Android devices. MicroStrategy uses the intuitive interfaces of these mobile device to let users explore information using touch and smart gestures. MicroStrategy Mobile Business Intelligence applications can support workflows that lead users through data to decisions. MicroStrategy Mobile also provides application developers a new way to develop and deploy Mobile applications that is faster, easier, and more maintainable than using traditional Integrated Development Environments. MicroStrategy Mobile offers the following benefits:
Reduces the time to develop new Mobile applications: MicroStrategys Mobile application platform includes the infrastructure needed to support each new Mobile application, so that application developers only need to focus on creating the user experience and not on the back-end infrastructure. Easy for non-developers to create professional Mobile applications: MicroStrategys Mobile applications do not require any
14 MicroStrategy components
coding. Using MicroStrategy's Mobile application platform, Mobile applications are assembled in a point-and-click fashion. Application designers can choose from an array of finely-designed displays and controls that are optimized for mobile devices.
Easy for companies to rapidly deploy Mobile application updates: MicroStrategys Mobile application platform uses an on-demand form of application deployment called in-stream deployment. As soon as new or updated applications are ready, they are instantly available to Mobile users directly from MicroStrategys Mobile application platform. One design for all devices: MicroStrategy Mobiles ability to render the same application across different mobile device operating systems means less development time, less application management, and quicker support for a heterogeneous deployment of mobile devices.
To learn more about MicroStrategy Mobile, see the MicroStrategy Mobile Design and Administration Guide and the MicroStrategy Mobile Analysis Guide. If you plan to use IIS 6.x on 64-bit Windows operating systems, MicroStrategy Mobile must be configured as a 64-bit application. These requirements are described in Supporting MicroStrategy products with IIS 6.x on 64-bit Windows operating systems, page 78.
MicroStrategy SDK
The MicroStrategy SDK is a collection of programming tools, utilities, documentation, and libraries of functions or classes that are designed to allow users to customize and extend MicroStrategy products and to integrate them within other applications. The programming tools provided by the MicroStrategy SDK including programming instructions, points of access, and guidelines for developers allow programmers to enhance the operation of their software by customizing and embedding the robust functionality of the MicroStrategy BI platform. MicroStrategy SDK and MicroStrategy Developer Library The (MSDL) are not included in the MicroStrategy installation. You can download the MicroStrategy SDK from the MicroStrategy support site https://resource.microstrategy.com/msdz/default.asp. You can also
MicroStrategy components
15
access the MicroStrategy Developer Library from the MicroStrategy support site.
The MicroStrategy SDK provides access to the entire MicroStrategy platform and includes all of the services and utilities required for building a robust, feature-filled business intelligence-enabled application. The MicroStrategy SDK is made up of the following components: The MicroStrategy SDK includes the following individual SDKs, which are described in detail in the MicroStrategy Developer Library:
Web SDK. Visualization SDK. Mobile SDK. Web Services SDK. Narrowcast Server SDK. Intelligence Server SDK. MicroStrategy Office SDK.
16 MicroStrategy components
Each of the individual SDKs listed above is made up of some or all of the following specific components:
A comprehensive set of APIs that includes: COM-based client-server API. XML-based Web API with support for Java/COM. Web Services API. Narrowcast Server API.
The set of MicroStrategy APIs provides support for a variety of development environments, including Java, C++, VB, XML, and standard Web and client-server technologies.
A complete set of SDK documentation for all the MicroStrategy products that includes: Reference guides such as Javadocs for the APIs. The MicroStrategy Developer Library (MSDL), which provides all the information required to understand and use the MicroStrategy SDK.
A variety of development tools that include: Source code and sample application code for typical customization tasks. Development tools and production-ready utilities that reduce code creation and maintenance and help you build customized applications. Specialized development tools, such as the Portal Integration Kit and the Web Services Development Kit. Features for packaging your application, including embedded (silent) installation, project mover for project maintenance and upgrade, and schema services to upgrade the metadata
MicroStrategy components
17
MicroStrategy Integrity Manager, and as HTML and XML summary files that are generated to provide easily distributed results to other users.
To learn more about MicroStrategy Integrity Manager, see the MicroStrategy System Administration Guide.
18 MicroStrategy components
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 MicroStrategy 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 MicroStrategy Office, refer to the MicroStrategy Office User Guide and MicroStrategy Office online help. Office requires that MicroStrategy Web Services is also MicroStrategy installed. For information on Web Services, see MicroStrategy Web Services (ASP.NET) and Web Services (J2EE), page 20.
1 Insert the MicroStrategy installation disk into the disk drive and close the MicroStrategy Main Menu window that opens automatically. 2 Browse to the Installations folder on the MicroStrategy installation disk. 3 Copy the Office folder and paste it to a network location of your choice. ensure that ASP.NET Framework and Web Services To Enhancements (WSE) Runtime are installed on users machines when they install MicroStrategy Office, copy the Utilities folder to the network location so that it is on the same folder level as the Office folder. The WSE Runtime is installed only if it is not already installed on the users machine.
2013 MicroStrategy, Inc. MicroStrategy components
19
4 Share the network location with any users who need to install MicroStrategy Office. 5 Notify MicroStrategy Office users to run either MicroStrategyOffice.msi or MicroStrategyOffice64.msi from within the Office folder to install MicroStrategy Office. These .msi files are for installing MicroStrategy Office on 32-bit and 64-bit versions of Microsoft Office, respectively. These users will need Microsoft Windows Installer 4.5 on their machine to install MicroStrategy Office. addition to allowing users to install MicroStrategy Office from a In network location, you can also use the MicroStrategyOffice.msi or MicroStrategyOffice64.msi files to perform a silent installation of MicroStrategy Office (see Silent installation of MicroStrategy Office, page 377).
To support alternative ways to access the MicroStrategy business intelligence platform using the latest web services technologies such as ASP.NET, JNI, Java and Web protocols, such as Apache Axis, refer to the MicroStrategy SDK and the accompanying MSDL. For information on deploying MicroStrategy Web Services ASP.NET and J2EE versions, refer to the MicroStrategy Office User Guide.
20 MicroStrategy components
variety of devices, including mobile phones, PDAs, email, 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. 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. Subscriptions can also be supported through Intelligence Server with the introduction of Distribution Services. For information on Distribution Services, see MicroStrategy Distribution Services, page 9. For information on Narrowcast Server subcomponents, refer to the MicroStrategy Narrowcast Server Installation and Configuration Guide.
MicroStrategy components
21
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 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
For more information on the Tutorial project, refer to the Project Design Guide.
22 MicroStrategy components
package and transmit this package to MicroStrategy Technical Support for review and troubleshooting.
Health Center is provided with a MicroStrategy installation. For information on using Health Center to diagnose and fix problems in your MicroStrategy environment, refer to the System Administration Guide.
Installation prerequisites
Before you install MicroStrategy, you must have the following: MicroStrategy installation files You can access the installation files from the MicroStrategy disk or you can ask your system administrator to share the files on a network location. For information on mounting or unmounting CD-ROM drives, see Mounting and unmounting CD-ROMs, page 522, in Appendix B, Troubleshooting. You can reduce the amount of data that has to be downloaded for an installation by excluding some of the installation files located in the Installations/DataFiles folder. During installation, the MicroStrategy Installation Wizard then lists which of these files are required for your MicroStrategy installation. You can use this technique to provide only the files required to complete a MicroStrategy installation, which can then be used to reduce the amount of data
Installation prerequisites
23
packaged and downloaded for other MicroStrategy installations within your organization. For steps to use this technique to create custom installation packages, see Creating custom installation packages, page 96. License key from MicroStrategy you begin upgrading any MicroStrategy systems, contact Before your MicroStrategy account executive to obtain a new license key for the version of software you are installing. To install MicroStrategy products, you must first obtain a license key specific to the version of MicroStrategy software you intend to install. Installation location for your MicroStrategy products
To install MicroStrategy, you must have the following permissions and privileges: Windows:
You must log on to your machine using a domain account with Windows administrative privileges for the domain or target machine. The user installing MicroStrategy needs write permissions in the installation directory to complete the installation; otherwise the installation fails
You need root access permissions for installation if you have purchased the CPU-based MicroStrategy license.
Apart from the information provided above, review the following sections before you start the installation: Recommended installation location and example deployments, page 24 Hardware requirements and recommendations, page 27 Software requirements and recommendations, page 38
24 Installation prerequisites
though, the following recommendations are usually true for a typical business intelligence system: 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.
are just suggestions to help you get started. Read the rest of this These chapter for more detailed guidelines. The following sections provide basic examples of differently sized production deployments with MicroStrategy products. The examples are generalized and do not include all of the MicroStrategy products. You can use these examples to help plan how to deploy MicroStrategy products.
Installation prerequisites
25
26 Installation prerequisites
Installation prerequisites
27
For more details and exact information regarding supported and certified operating system versions for a particular MicroStrategy release, see the MicroStrategy Readme or contact Technical Support. For UNIX and Linux systems, a number of system settings can affect the performance of MicroStrategy Intelligence Server Universal. These settings do not need to be set prior to a MicroStrategy installation. For more information on these settings and their recommended values, see Recommended system settings for UNIX and Linux, page 93.
MicroStrategy installs a set of common files that are shared when installing multiple MicroStrategy products on the same machine. With a typical installation setup type, these files are installed on the C: drive. In addition to the storage requirements listed for the products in the table below, you should estimate an additional 2 GB of storage space for the common files that are shared amongst all products. While this estimate is conservatively high, planning for this additional space helps to ensure a successful installation.
The storage requirements listed in the table below for Intelligence Server and Narrowcast Server include additional space than is required for the initial installation. This additional space is to support the creation of the various files that these products require throughout their use in a MicroStrategy environment. Additional space may be required depending on the use of Intelligence Server and Narrowcast Server in your MicroStrategy environment.
28 Installation prerequisites
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 licensed, installation fails. Additionally, you must have an Intelligence Server Universal license to install on 64-bit Windows operating systems. See the MicroStrategy System Administration Guide for more information about licensing.
Memory 2 GB 2 GB Storage 0.5 GB 0.25 GB
MicroStrategy Product MicroStrategy System Manager MicroStrategy Command Manager MicroStrategy Enterprise Manager MicroStrategy Object Manager MicroStrategy Developer products MicroStrategy Intelligence Server
1 GB
0.25 GB
1 GB 2 GB or higher
0.25 GB 0.25 GB
x86 compatible
4 GB or higher
Three times the amount of RAM available to Intelligence Server. For example, an Intelligence Server that is provided 4 GB of RAM requires 12 GB of hard drive space.
Installation prerequisites
29
Memory 4 GB or higher The use of 4 GB of RAM is a minimum level of support for the MicroStrategy Product Suite, which does not take into account the performance of a production system. Performance testing has shown that 64 GB or more of RAM should be available to allow MicroStrategy Intelligence Server Universal to fully support and take advantage of the complete feature set of the MicroStrategy Product Suite, while obtaining system-wide high performance. This level of system resources allows MicroStrategy Intelligence Server Universal to fully utilize performance-improving technologies such as MicroStrategy OLAP Services, and to support optimal performance for MicroStrategy Report Services documents and dashboards and the other features of the MicroStrategy Product Suite.
Storage Three times the amount of RAM available to Intelligence Server. For example, an Intelligence Server that is provided 4 GB of RAM requires 12 GB of hard drive space.
MicroStrategy Integrity Manager MicroStrategy Office MicroStrategy Mobile Server MicroStrategy Narrowcast Server MicroStrategy SDK
2 GB or higher 2 GB
0.25 GB 0.5 GB
The MicroStrategy Mobile Server hardware requirements are the same as those for MicroStrategy Web Server hardware requirements. x86 or x64 compatible 4 GB 4 GB
The SDK is not included in the MicroStrategy installation and can instead be downloaded from the MicroStrategy support site. Not applicable 4 GB or higher 0.5 GB 0.5 GB
MicroStrategy Not applicable Analytics Modules MicroStrategy Web: Web Server x86 compatible
30 Installation prerequisites
Memory 2 GB or higher
Storage MicroStrategy Web can be accessed from a third-party web browser, which means there are no additional storage requirements. 0.5 GB
MicroStrategy Web Universal: Web Server MicroStrategy Web Universal: Web Client
4 GB or higher
2 GB or higher
MicroStrategy Web can be accessed from a third-party web browser, which means there are no additional storage requirements.
The storage recommendations listed in the table below provide an estimate for installing and supporting each MicroStrategy product on a separate machine. For information on the total size of a MicroStrategy installation when installing all MicroStrategy products on the same machine, see Storage requirements for all MicroStrategy products on UNIX/Linux, page 34.
Installation prerequisites
31
A successful configuration of Intelligence Server Universal depends on a valid combination of an operating system and a CPU architecture. For example, Intelligence Server Universal is certified to run on a machine with a Oracle Solaris operating system compatible with a SPARC CPU architecture. Valid operating system and CPU architecture combinations for Intelligence Server Universal are listed in the table below. The storage requirements listed in the table below for Intelligence Server include additional space than is required for the initial installation. This additional space is to support the creation of the various files that these products require throughout their use in a MicroStrategy environment. Additional space may be required depending on the use of Intelligence Server in your MicroStrategy environment.
Memory 2 GB or higher Storage Recommendation 4 GB on IBM AIX 3GB on other UNIX operating systems
Processor Oracle Solaris: SPARC platforms IBM AIX: IBM POWER Architecture HP-UX: Intel Itanium Red Hat and SUSE Linux: x86-64 compatible
Oracle Solaris: SPARC platforms IBM AIX: IBM POWER Architecture HP-UX: Intel Itanium Red Hat and SUSE Linux: x86-64 compatible
2 GB or higher
32 Installation prerequisites
Processor Oracle Solaris: SPARC platforms IBM AIX: IBM POWER Architecture HP-UX: Intel Itanium Red Hat and SUSE Linux: x86-64 compatible
Memory 4 GB or higher The use of 4 GB of RAM is a minimum level of support for the MicroStrategy Product Suite, which does not take into account the performance of a production system. Performance testing has shown that 64 GB or more of RAM should be available to allow MicroStrategy Intelligence Server Universal to fully support and take advantage of the complete feature set of the MicroStrategy Product Suite, while obtaining system-wide high performance. This level of system resources allows MicroStrategy Intelligence Server Universal to fully utilize performance-improving technologies such as MicroStrategy OLAP Services, and to support optimal performance for MicroStrategy Report Services documents and dashboards and the other features of the MicroStrategy Product Suite. 2 GB or higher
Storage Recommendation Three times the amount of RAM available to Intelligence Server. For example, an Intelligence Server that is provided 4 GB of RAM requires 12 GB of hard drive space.
Oracle Solaris: SPARC platforms IBM AIX: IBM POWER Architecture HP-UX: Intel Itanium Red Hat and SUSE Linux: x86-64 compatible
Oracle Solaris: SPARC platforms IBM AIX: IBM POWER Architecture HP-UX: Intel Itanium Red Hat and SUSE Linux: x86-64 compatible
2 GB or higher
The MicroStrategy Mobile Server hardware requirements are the same as those for MicroStrategy Web Server hardware requirements. The SDK is not included in the MicroStrategy installation and can instead be downloaded from the MicroStrategy support site.
Installation prerequisites
33
Processor Oracle Solaris: SPARC platforms IBM AIX: IBM POWER Architecture HP-UX: Intel Itanium Red Hat and SUSE Linux: x86-64 compatible
Memory 4 GB or higher
Oracle Solaris: SPARC platforms IBM AIX: IBM POWER Architecture HP-UX: Intel Itanium Red Hat and SUSE Linux: x86-64 compatible
2 GB or higher
MicroStrategy Web can be accessed from a third-party web browser, which means there are no additional storage requirements.
34 Installation prerequisites
need free space in the temporary directory. The default location of the temporary directory is: Solaris: /var/tmp AIX, HP-UX, and Linux: /tmp
If the space in the default temporary directory is inadequate, you can use the 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: ./setup.sh tempdir /home/user/tmp you change the location of the temporary directory, free space is still If required in the default location of the temporary directory to launch the MicroStrategy installation routine.
Flash memory
Requirement Flash memory Minimum 32 MB Recommended 64 MB
BlackBerry devices
Devices BlackBerry Bold 9900 Series BlackBerry Torch 9800 Series BlackBerry Bold 9790 BlackBerry Bold 9700 Series BlackBerry Style 9670 BlackBerry Bold 9650 Status Supported Supported Supported Supported Supported Supported
Installation prerequisites
35
Devices BlackBerry Tour 9630 BlackBerry Curve 3G 9300 Series BlackBerry Pearl 3G 9100 Series BlackBerry Bold 9000 Series BlackBerry Curve 8900 Series BlackBerry 8800 Series BlackBerry 8700 Series BlackBerry Curve 8500 Series Blackberry Curve 8300 Series BlackBerry Pearl Flip 8200 Series BlackBerry Pearl 8100 Series BlackBerry 7200 Series BlackBerry 7100 Series
Status Supported Supported Supported Certified Supported Certified Certified Supported Certified Supported Certified Certified Certified
iPad devices
Devices iPad Wi-Fi iPad Wi-Fi + 3G iPad 2 Wi-Fi iPad 2 Wi-Fi + 3G iPad 3 (New iPad) Wi-Fi Status Certified Certified Certified Certified Certified
36 Installation prerequisites
Devices iPad 3 (New iPad) Wi-Fi + Cellular iPad 4 (iPad with Retina display) Wi-Fi iPad 4 (iPad with Retina display) Wi-Fi + Cellular iPad Mini Wi-Fi iPad Mini Wi-Fi + Cellular
Android devices
Devices Acer Iconia Tab A100 Acer Iconia Tab A500 ASUS Nexus 7 Wi-Fi ASUS Nexus 7 3G ASUS Transformer ASUS Transformer Prime HTC One S T-Mobile version HTC One X International version HTC Vivid LG Nexus 4 International version LG Optimus G AT&T version LG Spectrum LG Thrill Motorola Atrix 2 Motorola Droid 4 Motorola Droid Bionic Motorola Droid Razr and Razr MAXX Motorola Xoom 3G tablet Motorola Xoom Wi-Fi Motorola XY Board 10.1 LTE Samsung Galaxy Nexus GSM version Samsung Galaxy Nexus Verizon version Status Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified
Installation prerequisites
37
Devices Samsung Galaxy Note International version Samsung Galaxy Note 10.1 Wi-Fi Samsung Galaxy Note 2 International version Samsung Galaxy S2 AT&T version Samsung Galaxy S2 T-Mobile version Samsung Galaxy S2 Skyrocket AT&T version Samsung Galaxy S3 AT&T version Samsung Galaxy S3 International version Samsung Galaxy S3 Verizon version Samsung Galaxy Tab 10.1 Wi-Fi Samsung Galaxy Tab 2 7.0 Wi-Fi Samsung Galaxy Tab 7 Plus Samsung Nexus 10 Samsung Nexus S Samsung Nexus S 4G Sony Tablet S Sony Xperia Arc International version Sony Xperia S International version Toshiba Thrive
Status Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified Certified
38 Installation prerequisites
The operating systems listed below are deemed supported or certified to reflect the level of internal testing that each configuration was exposed to for the current release. MicroStrategy recommends using certified configurations over the supported configurations.
MicroStrategy certifies and supports operating systems that are compatible with a set of CPU chipsets, referred to as CPU architectures, that are binary-compatible. MicroStrategy tests on at least one of the CPU chipsets within a set of binary-compatible CPU architectures for purposes of certifying and supporting operating systems with MicroStrategy products. A valid CPU architecture is provided in parentheses () to clarify the operating system software certified or supported for MicroStrategy products.
Installation prerequisites
39
40 Installation prerequisites
Installation prerequisites
41
Software Requirements Export devices can open a PDF file created by using MicroStrategy to export an object as a PDF. You can load a PDF file exported from MicroStrategy onto an export device in a couple of different ways. You can connect the export device directly to the machine that stores the PDF to load it onto the export device. You can also email the PDF file to the email account for the export device. Certified: Nook firmware version 1.x Kindle firmware version 2.x Kindle firmware version 6.x Kindle Fire
Flash player
Certified: Adobe Flash Player 11.x Adobe Flash Player 10.3.x Supported: Adobe Flash Player 10.1.x
42 Installation prerequisites
Software Requirements Certified: Microsoft Internet Explorer 8.x Microsoft Internet Explorer 9.x Microsoft Internet Explorer 10.x Supported: Microsoft Internet Explorer 7.x
Microsoft .NET Framework 4.0 or 4.5. This must be installed prior to installing MicroStrategy.
Databases (Enterprise Certified: Manager warehouse) IBM DB2 UDB for Linux, UNIX, & Windows 9.5 with Fix Pack 10 IBM DB2 UDB for Linux, UNIX, & Windows 9.7 with Fix Pack 8 IBM DB2 UDB for Linux, UNIX, & Windows 10.1 with Fix Pack 2 IBM DB2 for Linux, UNIX, & Windows 10.5 Microsoft SQL Server 2005 SP4 Microsoft SQL Server 2008 SP3 and 2008 R2 SP1/SP2 Microsoft SQL Server 2012 SP1 Oracle 10g and 10gR2 Partitioning is supported for the Oracle Enterprise Edition of these database platforms. Oracle 11g and 11gR2 Partitioning is supported for the Oracle Enterprise Edition of these database platforms. Oracle 12c Partitioning is supported for the Oracle Enterprise Edition of these database platforms. Sybase ASE 15.5 Sybase ASE 15.7 Teradata V12 Teradata V13 Teradata V14.0 Teradata V14.10
Supported: Oracle 9i and 9iR2 Partitioning is supported for the Oracle Enterprise Edition of these database platforms. Sybase ASE 15
Installation prerequisites
43
MicroStrategy Intelligence Server Analytics Enterprise contains new features and numerous enhancements that may require additional hardware resources when migrating from MicroStrategy 8.x production systems running on Windows 32-bit platforms.
Intelligence Server Universal on Windows (64-bit) You must have an Intelligence Server Universal license to install on 64-bit Windows operating systems.
Software Operating system Software Requirements Certified: Windows Server 2003 Enterprise Edition SP2 (on x64) Windows Server 2003 Standard Edition SP2 (on x64) Windows Server 2003 Enterprise Edition R2 SP2 (on x64) Windows Server 2003 Standard Edition R2 SP2 (on x64) Windows Server 2008 Standard Edition R2 SP1 (on x64) Windows Server 2008 Enterprise Edition R2 SP1 (on x64) Windows Server 2008 Standard Edition SP2 (on x64) Windows Server 2008 Enterprise Edition SP2 (on x64) Windows Server 2012 Standard (on x64) Supported for demonstration purposes only: Windows Vista Business Edition SP2 (on x64) Windows Vista Enterprise Edition SP2 (on x64) Windows 7 Professional Edition SP1 (on x64) Windows 7 Enterprise Edition SP1 (on x64) Windows 8 all editions (on x64)
44 Installation prerequisites
Installation prerequisites
45
To include Flash-enabled documents in Excel, PowerPoint, and Word, you must have Adobe Flash Player installed on your machine. If Flash Player is not installed, a dialog box is displayed when you execute a document. The dialog box provides a link to the Adobe download website, from which you can install Flash Player. Certified: Adobe Flash Player 11.x Adobe Flash Player 10.3.x Supported: Adobe Flash Player 10.1 (version 10.1.82.76 or higher)
Microsoft .NET Framework 4.0 or 4.5. This must be installed prior to installing MicroStrategy.
46 Installation prerequisites
Software Requirements Microsoft Web Services Enhancements (WSE) Runtime 3.0 which is automatically installed with MicroStrategy Office if not found on the client machine. MicroStrategy Web Services configured and running.
MicroStrategy Web Services server system certified and supported configurations The following are supported and certified requirements to support and deploy MicroStrategy Web Services ASP.NET. For a list of software requirements and recommendations for MicroStrategy Web Services J2EE, see MicroStrategy Web Services J2EE software requirements and recommendations, page 70.
Software Operating System Software Requirements Certified: Windows Server 2012 Standard (on x64) Windows Server 2008 Standard Edition SP2 (on x64) Windows Server 2008 Enterprise Edition SP2 (on x64) Windows Server 2008 Standard Edition R2 SP1 (on x64) Windows Server 2008 Enterprise Edition R2 SP1 (on x64) Windows Server 2003 Web Edition SP2 (on x86 or x64) Windows Server 2003 Standard Edition SP2 (on x64) Windows Server 2003 Enterprise Edition SP2 (on x64) Windows Server 2003 Standard Edition R2 SP2 (on x64) Windows Server 2003 Enterprise Edition R2 SP2 (on x64) Supported: Windows Server 2003 Web Edition SP2 (on x86) Windows Server 2003 Standard Edition SP2 (on x86) Windows Server 2003 Enterprise Edition SP2 (on x86) Windows Server 2003 Standard Edition R2 SP2 (on x86) Windows Server 2003 Enterprise Edition R2 SP2 (on x86) Supported for demonstration purposes only: Windows Vista Business Edition SP2 (on x64) Windows Vista Enterprise Edition SP2 (on x64) Windows 7 Professional Edition SP1 (on x86 or x64) Windows 7 Enterprise Edition SP1 (on x86 or x64) Windows 8 all editions (on x86 or x64) Web server Microsoft Internet Information Services 6.x, 7.0.x, 7.5.x, and 8.x If you plan to use IIS 7.0.x or 7.5.x as the web server for MicroStrategy Web Services, you must ensure that some IIS settings are enabled, as described in Supporting IIS 7.0.x or IIS 7.5.x as a web server for MicroStrategy Web or Mobile Server, page 76.
Installation prerequisites
47
Software Requirements .NET Framework 4.0 or 4.5 (32-bit versions or 64-bit versions). This must be installed prior to installing MicroStrategy. Oracle JRE 1.7.0 (32-bit versions or 64-bit versions). Oracle JRE 1.6.0 (32-bit versions or 64-bit versions). Microsoft Web Services Enhancements (WSE) Runtime 3.0 for Microsoft .NET.
48 Installation prerequisites
Software Requirements Certified: Microsoft Internet Explorer 8.x, 9.x, and 10.x Firefox 16.x, 17.x, 18.x, 19.x, 20.x, 21.x, and 22.x Supported: Microsoft Internet Explorer 7.x, Google Chrome 22.x, 23.x, 24.x, 25.x, 26.x, 27.x, and 28.x A Google Chrome security update prevents WebHelp systems that are in locally stored file systems from being displayed properly. This is a known issue with Google Chrome. To view the online help documentation for System Manager, you can: Open Google Chrome using the command line option allow-file-access-from-files. Be aware that this disables some of the security features of Google Chrome. Use one of the other web browsers supported for System Manager.
Microsoft .NET Framework 4.0 or 4.5. This must be installed prior to installing MicroStrategy.
Installation prerequisites
49
50 Installation prerequisites
Software Requirements MicroStrategy Portlets allow MicroStrategy Web to be easily integrated and configured on portal environments. Certified: IBM WebSphere Portal 7.x IBM WebSphere Portal 8.0.x Microsoft Office SharePoint Server 2007 SP2 Microsoft SharePoint Server 2010 SP1 Microsoft SharePoint Server 2013 Oracle WebLogic Portal 10.3.x SAP NetWeaver Composition Environment 7.3.x Liferay Portal 6.x Drupal 6.2.x DotNetNuke web content management system 5.6.x Supported: Liferay Portal 5.2.x JSR168-Compliant Portals
GIS components
MicroStrategy GIS Connectors let you integrate with ESRI to create sophisticated GIS applications. The following GIS components are required to support this GIS integration. Certified: ArcGIS 9.3.1 ArcGIS 10.0 ArcGIS 10.1
Certified: Microsoft Internet Explorer 8x, 9.x, and 10.x Firefox 16.x, 17.x, 18.x, 19.x, 20.x, 21.x, and 22.x Google Chrome 22.x, 23.x, 24.x, 25.x, 26.x, 27.x, and 28.x Supported: Microsoft Internet Explorer 7.x
Export application
Certified: Adobe Acrobat Reader 10.x and 11.x Microsoft Office 2003 SP3 Microsoft Office 2007 SP2 Microsoft Office 2010 SP1 Microsoft Office 2013 Microsoft Office for Mac 2011 SP2 OpenOffice.org Calc 3.3.0 For guidelines to support certain exporting features in OpenOffice.org Calc, refer to the MicroStrategy Readme.
Installation prerequisites
51
Software Requirements Export devices can open a PDF file created by using MicroStrategy to export an object as a PDF. You can load a PDF file exported from MicroStrategy onto an export device in a couple of different ways. You can connect the export device directly to the machine that stores the PDF to load it onto the export device. You can also email the PDF file to the email account for the export device. Certified: Nook firmware version 1.x Kindle firmware version 2.x Kindle firmware version 6.x Kindle Fire
.NET Framework 4.0 or 4.5 (32-bit versions). This must be installed prior to installing MicroStrategy. Certified: Adobe Flash Player 11.x Adobe Flash Player 10.3.x Supported: Adobe Flash Player 10.1.x
.NET and JRE For ASP.NET deployments of MicroStrategy SDK customizations .NET 4.0 or 4.5 (32-bit or 64-bit version) Oracle JRE 1.7.0 (32-bit or 64-bit version) Oracle JRE 1.6.0 (32-bit or 64-bit version) For JSP deployments of MicroStrategy SDK customizations, see MicroStrategy SDK software requirements and recommendations for JSP environments, page 72. IDEs for Flex Application Development Certified: Adobe Flash Builder 4.0.1 with Adobe Flex SDK 4.1 Supported: Adobe Flash Builder 4.6 with Adobe Flex SDK 4.1 The Adobe Flash Builder application is not included with a MicroStrategy installation. This application is required to develop custom visualizations you can include in MicroStrategy with the use of MicroStrategy SDK. Refer to http://www.adobe.com to install the Adobe Flash Builder application.
52 Installation prerequisites
Software Requirements Certified: Eclipse 3.x The Web Customization Editor is an Eclipse READY product that easily integrates into the Eclipse IDE. This allows you to use the Web Customization Editor as well as the complete functionality of the IDE to perform basic as well as advanced customization tasks. Refer to http://www.eclipse.org to install the Eclipse IDE.
The Web Services SDK provides a jump start to developers who want to develop and deploy Web Services-based applications. It is built using the Web SDK and makes use of the multi-layered MicroStrategy Web architecture that clearly separates functionality from presentation. Creating task-based Web Services To support the creation of Web Services SDK customizations using the Web Customization Editor, your system must meet the following requirements: Certified: Windows Server 2008 Enterprise Edition R2 SP1 (on x64) Windows Server 2003 R2 SP2 Standard Edition (on x86 or x64) Apache Ant 1.8.x Apache Axis 1.5.4 .NET SDK 2.0 Deploying task-based Web Services To support the deployment of your Web Services SDK customizations as part of your MicroStrategy Web applications, your web server system must meet the following requirements: Certified: Windows Server 2008 Enterprise Edition R2 SP1 (on x64) Windows Server 2003 R2 SP2 Standard Edition (on x86 or x64)
The MicroStrategy Mobile SDK allows you to create customizations for MicroStrategy Mobile. To support the creation of MicroStrategy Mobile SDK customizations, your system must meet the following requirements: Certified IDE: Xcode IDE 4.x Certified SDK for iPhone and iPad: iOS SDK 5.x iOS SDK 6.x Certified SDK for Android: Android SDK 4.2.x
Installation prerequisites
53
Web browser
Certified: Microsoft Internet Explorer 8.x, 9.x, and 10.x Firefox 16.x, 17.x, 18.x, 19.x, 20.x, 21.x, and 22.x Supported: Microsoft Internet Explorer 7.x Google Chrome 22.x, 23.x, 24.x, 25.x, 26.x, 27.x, and 28.x A Google Chrome security update prevents WebHelp systems that are in locally stored file systems from being displayed properly. This is a known issue with Google Chrome. To view the online help documentation for Integrity Manager, you can: Open Google Chrome using the command line option allow-file-access-from-files. Be aware that this disables some of the security features of Google Chrome. Use one of the other web browsers supported for Integrity Manager.
54 Installation prerequisites
Installation prerequisites
55
Software Requirements MicroStrategy Narrowcast Server can deliver Adobe Flash content as the body of an email, as an email attachment, or to a file location. The support for Flash content deliveries by some third-party products is discussed below. Warning: The third-party products discussed below are manufactured by vendors independent of MicroStrategy, and the information provided is subject to change. Refer to the appropriate third-party vendor documentation for updated Flash support information. Microsoft Outlook Express and Microsoft Outlook 2003 support Flash content both in the email body and as an attachment. Hotmail, YahooMail, and Gmail support Flash content only as a Flash.mht attachment. Flash content in the body of an email is not supported. Web browsers: Internet Explorer 7.x, Internet Explorer 8.x, Internet Explorer 9.x, Internet Explorer 10.x, Firefox 16.x, Firefox 17.x, Firefox 18.x, Firefox 19.x, Firefox 20.x, Firefox 21.x, Firefox 22.x, Google Chrome 22.x, Google Chrome 23.x, Google Chrome 24.x, Google Chrome 25.x, Google Chrome 26.x, Google Chrome 27.x, and Google Chrome 28.x support Flash content.
Web server
Microsoft Internet Information Services 6.x If you plan to use IIS 6.x on 64-bit Windows operating systems, some MicroStrategy products must be configured as 64-bit applications, and some MicroStrategy products must be configured as 32-bit applications. These requirements are described in Supporting MicroStrategy products with IIS 6.x on 64-bit Windows operating systems, page 78. Microsoft Internet Information Services 7.0.x Microsoft Internet Information Services 7.5.x Microsoft Internet Information Services 8.x
Connectivity to the Object Repository, Subscription Book Repository, and Portal Repository databases SequeLink (installed with the product) Certified: Adobe Acrobat Reader 10.x and 11.x Microsoft Office 2003 SP3 Microsoft Office 2007 SP2 (Microsoft Office 2007 .xlsx files can be included as a static attachment for a Narrowcast service. However, .xlsx files are not supported as imported templates in Narrowcast Server. Save the Excel 2007 .xlsx file in Excel 97-2003 workbook format. You can then import the file as a template. ) Microsoft Office 2010 SP1 Microsoft Office 2013 Microsoft Office for Mac 2011 SP2 OpenOffice.org Calc 3.3.0 For guidelines to support certain exporting features in OpenOffice.org Calc, refer to the MicroStrategy Readme.
56 Installation prerequisites
Software Requirements Export devices can open a PDF file created by using MicroStrategy to export an object as a PDF. You can load a PDF file exported from MicroStrategy onto an export device in a couple of different ways. You can connect the export device directly to the machine that stores the PDF to load it onto the export device. You can also email the PDF file to the email account for the export device. Certified: Nook firmware version 1.x Kindle firmware version 2.x Kindle firmware version 6.x Kindle Fire
The following requirements also apply to all UNIX and Linux platforms: A Web browser (for example, Firefox) is required for viewing the MicroStrategy Readmes and online help. Windows Services for UNIX (http://technet.microsoft.com/en-us/ interopmigration/bb380242.aspx) or Samba (http:// www.samba.org) is required for HTML document support. Samba 3.0 is required for the support of HTML documents with alphanumeric names.
Installation prerequisites
57
The requirements listed below describe general requirements as well as requirements specific to the UNIX and Linux platforms: Configuring shared memory resources, page 58 Oracle Solaris, page 60 IBM AIX, page 61 HP-UX, page 62 Red Hat and SUSE Linux, page 62
The operating systems listed are deemed supported or certified to reflect the level of internal testing that each configuration was exposed to for the current release. MicroStrategy recommends using certified configurations over the supported configurations. MicroStrategy certifies and supports operating systems that are compatible with a set of CPU chipsets, referred to as CPU architectures, that are binary-compatible. MicroStrategy tests on at least one of the CPU chipsets within a set of binary-compatible CPU architectures for purposes of certifying and supporting operating systems with MicroStrategy products. A valid CPU architecture is provided in parentheses () to clarify the operating system software certified or supported for Intelligence Server Universal. All UNIX and Linux operating systems are 64-bit. For information on LDAP Servers certified and supported for LDAP authentication with various Intelligence Server machine environments, see the MicroStrategy Readme.
58 Installation prerequisites
During installation (on the System Requirements page, see System Requirements, page 136), you have the following options: Exit the MicroStrategy setup wizard to do the required system changes (Recommended): Select this option to cancel the installation and make the required system resource limit changes to support shared memory resources. This option is recommended for production environments. Information on the recommended resource limits is provided below. Allow the setup to reconfigure MicroStrategy to use Pipe as the Default IPC Mechanism: Select this option to disable the use of shared memory resources for Intelligence Server Universal, and instead use the pipe mechanism. Disabling the ability to use shared memory resources can potentially decrease the performance of your MicroStrategy applications, and therefore this is not recommended for production environments. Keep Shared Memory as the Default IPC Mechanism. (MicroStrategy may not work properly): Select this option to keep your system resource limits set at their current values to support shared memory resources. While this allows you to continue installation with the current system resource limits, Intelligence Server may not function properly after installation. If you plan to use shared memory resources for enhanced performance of your production environments, you should select the first option to exit the installation and make the required system changes.
The tables below provide recommended values for various system resource limits on UNIX and Linux. the system resource limits listed below can affect Modifying system-wide behavior and therefore, steps to modify these values are not given. You should refer to your UNIX and Linux documentation and contact your system administrator to modify these settings. Shared memory settings on UNIX and Linux operating systems that may require modification to support Intelligence Server execution are listed in the table below:
Setting Name shmmni shmseg Description Maximum number of shared memory identifiers at any given time. Maximum number of segments per process. Recommended Value 2048 2048 Note: This setting does not exist on Solaris, AIX, or Linux operating systems.
Installation prerequisites
59
Semaphores are used to synchronize shared memory communications. The names of the settings that control semaphores differ between operating systems as listed in the tables below:
Setting Name on Description Solaris, AIX, and HP-UX semmni semmns Maximum number of system wide semaphore sets. Maximum number of semaphores in the system. Recommended Value 2048 2048
Description Maximum number of semaphores in a semaphore set. Maximum number of semaphores in the system. Maximum number of operations in a simple semop call. Maximum number of semaphore sets.
Oracle Solaris
Operating System Oracle Solaris 10.x Requirements Oracle Solaris 10.x (on SPARC) Patch requirements: Oracle-recommended Patch Cluster dated 08/11/ 2009 (kernel patch 141414-08) or later. Oracle Solaris 11.x Oracle Solaris 11.x (on SPARC) You must include the Solaris 10.x gnome library libgdk-x11-2.0.so.0.400.9 in the location /usr/lib/sparcv9. This gnome library is available with the Solaris 10.x install media as part of the SUNWgnome-base-libs package. Once this library is available on the Solaris 11.x machine, within the /
60 Installation prerequisites
IBM AIX
Operating Systems IBM AIX 5.3.x Requirements IBM AIX 5L Version 5.3.x (on IBM POWER Architecture) Supported patch requirements: Technology Level 11, with the following filesets: bos.rte.libc 5.3.0.00 or higher XL C/C++ Runtime 9.0.0.0 or higher (xlC.rte) C/C++ Runtime 9.0.0.0 or higher for AIX 5.3 (xlC.aix50.rte) bos.perf.libperfstat 5.3.0.00 or higher Warning: To successfully register MicroStrategy Intelligence Server Universal as a service or support the use of CPU licenses on IBM AIX 5.3, you must obtain the IBM Authorized Program Analysis Report (APAR) IY81136. Contact IBM Production Support for help with obtaining and configuring this APAR. This APAR is available at the following URL, which is valid as of the release of this manual: http://www-01.ibm.com/support/docview.wss?rs=0&q1=IY81136&uid= isg1IY81136&loc=en_US&cs=utf-8&cc=us&lang=en IBM AIX 6.1.x IBM AIX 6.1.x (on IBM POWER Architecture) Patch requirements: Technology Level 1, with the following file sets: bos.rte.libc 5.3.9.3 or higher XL C/C++ Runtime V10.1.0.2 for AIX (xlC.aix50.rte) bos.perf.libperfstat 5.3.9.1 or higher IBM AIX 7.1.x IBM AIX 7.1.x (on IBM POWER Architecture) With the following file sets: bos.rte 7.1.0.2 or higher XL C/C++ Runtime V11.1.0.1 for AIX (xlC.rte) bos.perf.libperfstat 7.1.0.1 or higher LPAR for AIX Refer to your third-party IBM documentation for information on LPAR. MicroStrategy certifies the installation of Intelligence Server Universal on AIX 6.1.x and 7.1.x LPAR architectures for micropartitions, which meet all applicable AIX 6.1.x or 7.1.x requirements. This support also requires the use of MicroStrategy named user licenses. Refer to your third-party IBM documentation for information on LPAR. MicroStrategy supports the installation of Intelligence Server Universal on AIX LPAR architecture for dedicated partitions, which meets all applicable AIX requirements.
Installation prerequisites
61
HP-UX
Operating Systems HP-UX 11i v2 Requirements HP-UX 11i v2 Foundation Operating Environment (on Intel Itanium) Patch requirements: Base Quality Pack Bundle for HP-UX 11i v2 dated December 2007 HP-UX 11i v3 HP-UX 11i v3 (on Intel Itanium) Patch requirements: Base Quality Pack Bundle for HP-UX 11i v3 dated September 2008
62 Installation prerequisites
Operating Systems
Requirements
Red Hat Enterprise Linux 6.1.x Red Hat Enterprise Linux 6.1.x (on x86-64) You must install the packages compat-libstdc++-33.i686.rpm, libXp.x86_64.rpm, elfutils-devel.x86_64.rpm, elfutils-libelf-devel.x86_64.rpm, libstdc++-4.4.5-6.el6.i686.rpm, krb5-libs.i686.rpm, nss-pam-ldapd.i686.rpm, and ksh-20100621-12.el6.x86_64.rpm which are provided with the Red Hat Enterprise Linux install media. Red Hat Enterprise Linux 6.2.x Red Hat Enterprise Linux 6.2.x (on x86-64) You must install the packages compat-libstdc++-33.i686.rpm, libXp.x86_64.rpm, elfutils-devel.x86_64.rpm, elfutils-libelf-devel.x86_64.rpm, libstdc++-4.4.5-6.el6.i686.rpm, krb5-libs.i686.rpm, nss-pam-ldapd.i686.rpm, and ksh-20100621-12.el6.x86_64.rpm which are provided with the Red Hat Enterprise Linux install media. Red Hat Enterprise Linux 6.3.x Red Hat Enterprise Linux 6.3.x (on x86-64) You must install the packages compat-libstdc++-33.el6.i686.rpm, libXp-1.0.0.1.el6.x86_64.rpm, elfutils-devel-0.152.el6.x86_64.rpm, elfutils-libelf-devel-0.152.el6.x86_64.rpm, libstdc++-4.4.6.el6.i686.rpm, krb5-libs-1.9.el6.i686.rpm, nss-pam-ldapd-0.7.5.el6_2.1.i686.rpm, and ksh-20100621.el6.x86_64.rpm, which are provided with the Red Hat Enterprise Linux install media. Red Hat Enterprise Linux 6.4.x Red Hat Enterprise Linux 6.4.x (on x86-64) You must install the packages compat-libstdc++-33.i686.rpm, libXp.x86_64.rpm, elfutils-devel.x86_64.rpm, elfutils-libelf-devel.x86_64.rpm, libstdc++-4.4.7-3.el6.i686.rpm, krb5-libs.i686.rpm, nss-pam-ldapd.i686.rpm, and ksh-20100621-XX.el6.x86_64 (where XX is the version number), which are provided with the Red Hat Enterprise Linux install media. SUSE Linux Enterprise Server 11.0.x SUSE Linux Enterprise Server 11.1.x SUSE Linux Enterprise Server 11.2.x SUSE Linux Enterprise Server 11.0.x (on x86-64) SUSE Linux Enterprise Server 11.1.x (on x86-64) SUSE Linux Enterprise Server 11.2.x (on x86-64)
Installation prerequisites
63
Requirements Oracle Linux (on x86-64) distributed through the Oracle Unbreakable Linux program, for use with Red Hat Enterprise Linux. Refer to the MicroStrategy certification and support requirements for Red Hat Enterprise Linux for any additional requirements to support MicroStrategy systems on Oracle Linux.
Supporting Intelligence Server Universal memory allocation on Linux In addition to the operating system requirements listed above, MicroStrategy recommends that the Linux kernel setting vm.max_map_count be defined as 5,242,880 bytes. This allows Intelligence Server Universal to utilize system memory resources. If a lower value is used, Intelligence Server Universal may not be able to use all available system resources. This can cause some Intelligence Server Universal actions to fail due to lack of system resources, which could be completed if the additional system resources were made available by increasing the value for this kernel setting. For information on this setting, including how to modify its value, refer to your third-party Linux operating system documentation.
64 Installation prerequisites
Installation prerequisites
65
Requirement PDF viewer (for viewing and exporting PDF documents) Adobe Flash Player
Recommended Certified: Adobe Acrobat Reader 10.x and 11.x Certified: Adobe Flash Player 11.x Adobe Flash Player 10.3.x Supported: Adobe Flash Player 10.1.x
66 Installation prerequisites
Recommended MicroStrategy Web Universal JSP server on 64-bit operating systems Certified: Windows Server 2012 Standard (on x64) Windows Server 2008 Enterprise Edition SP2 (on x64) Windows Server 2008 Standard Edition SP2 (on x64) Windows Server 2008 Enterprise Edition R2 SP1 (on x64) Windows Server 2008 Standard Edition R2 SP1 (on x64) Windows 2003 Standard Edition SP2 (on x64) Windows 2003 Enterprise Edition SP2 (on x64) Windows 2003 Standard Edition R2 SP2 (on x64) Windows 2003 Enterprise Edition R2 SP2 (on x64) IBM AIX 6.1.x Technology Level 1 (on IBM POWER Architecture) IBM AIX 7.1.x (on IBM POWER Architecture) Oracle Solaris 10.x (on SPARC) Oracle Solaris 11.x (on SPARC) Hewlett Packard HP-UX 11i v2 (on Intel Itanium) Hewlett Packard HP-UX 11i v3 (on Intel Itanium) Red Hat Enterprise Linux 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, and 5.9 and RedHat Enterprise Linux Advanced Platform 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, and 5.9 (on x86-64) Red Hat Enterprise Linux 6.0.x, 6.1.x, 6.2.x, 6.3.x, and 6.4.x (on x86-64) SUSE Linux Enterprise Server 11.0.x (on x86-64) SUSE Linux Enterprise Server 11.1.x (on x86-64) SUSE Linux Enterprise Server 11.2.x (on x86-64) Oracle Linux (on x86-64) - distributed through Oracle Unbreakable Linux Supported: Windows 7 Professional Edition SP1 (on x64), for demonstration purposes only Windows 7 Enterprise Edition SP1 (on x64), for demonstration purposes only Windows 8 all editions (on x64), for demonstration purposes only Windows Vista Business Edition SP2 (on x64), for demonstration purposes only Windows Vista Enterprise Edition SP2 (on x64), for demonstration purposes only IBM AIX 5.3.x Technology Level 11 (on IBM POWER Architecture)
Installation prerequisites
67
Recommended MicroStrategy Web Universal is certified to work with the following application servers. MicroStrategy Web Universal JSP server general requirements Certified: Oracle Web Application Server 10g Release 3 (10.1.3) Oracle WebLogic 12c Oracle WebLogic 10.3.x Oracle GlassFish Server 3.1.x IBM WebSphere 8.5.x IBM WebSphere 8.0.x IBM WebSphere 7.x Apache Tomcat 7.0.x Apache Tomcat 6.0.x Apache TomEE 1.5.x SAP NetWeaver Application Server 7.3.x JBoss Enterprise Application Platform 6.x Supported: JBoss Enterprise Web Platform 5.1.x JBoss Enterprise Application Platform 5.1.x JBoss Application Server 7.x JBoss Application Server 5.1.x
68 Installation prerequisites
Recommended MicroStrategy Web Universal is certified to work with the following web servers. Certified MicroStrategy Web Universal JSP server general requirements: Apache 2.x IBM HTTP Server 8.x IBM HTTP Server 7.x IBM HTTP Server 6.x Oracle iPlanet Web Server 6.1.x Oracle iPlanet Web Server 7.x Oracle HTTP Server 10g R3 Microsoft Internet Information Services 6.x and 7.0.x If you plan to use IIS 7.0.x as the web server for MicroStrategy Web Universal, you must ensure that some IIS options are enabled, as described in Supporting IIS 7.0.x or IIS 7.5.x as a web server for MicroStrategy Web or Mobile Server, page 76 Microsoft Internet Information Services 7.5.x If you plan to use IIS 7.5.x as the web server for MicroStrategy Web Universal, you must ensure that some IIS options are enabled, as described in Supporting IIS 7.0.x or IIS 7.5.x as a web server for MicroStrategy Web or Mobile Server, page 76 Microsoft Internet Information Services 8.x Certified MicroStrategy Web ASP.Net server on 64-bit operating systems: Internet Information Services 6.x, 7.0.x, 7.5.x, and 8.x If you plan to use IIS 7.0.x or 7.5.x as the web server for MicroStrategy Web Universal, you must ensure that some IIS options are enabled, as described in Supporting IIS 7.0.x or IIS 7.5.x as a web server for MicroStrategy Web or Mobile Server, page 76
Portal server
MicroStrategy Portlets allow MicroStrategy Web Universal to be easily integrated and configured on portal environments. Certified: IBM WebSphere Portal 7.x IBM WebSphere Portal 8.0.x Microsoft Office SharePoint Server 2007 SP2 Microsoft SharePoint Server 2010 SP1 Microsoft SharePoint Server 2013 Oracle WebLogic Portal 10.3.x SAP NetWeaver Composition Environment 7.3.x Liferay Portal 6.x Drupal 6.2.x DotNetNuke 5.6.x web content management system Supported: Liferay Portal 5.2.x JSR168-Compliant Portals
Installation prerequisites
69
Recommended MicroStrategy GIS Connectors let you integrate with ESRI to create sophisticated GIS applications. The following GIS components are required to support this GIS integration. Certified: ArcGIS 9.3.1 ArcGIS 10.0 ArcGIS 10.1
MicroStrategy Web Universal is certified to use the following Java development kits, Java virtual machines, and .NET Runtime. MicroStrategy Web Universal JSP server on 32-bit operating systems. Certified: Oracle JDK 1.7 (32-bit version) Oracle JDK 1.6 (32-bit version) IBM JDK 1.6 (32-bit version) Oracle JRockit 1.6.0 R28 (32-bit version) Supported: Oracle JRockit 1.6.0 R27 (32-bit version) MicroStrategy Web Universal JSP server on 64-bit operating systems. Certified: Oracle JDK 1.7 (32-bit and 64-bit versions) Oracle JDK 1.6 (32-bit and 64-bit versions) IBM JDK 1.6 (32-bit and 64-bit versions) HP-UX JDK 1.6 (64-bit versions) HP-UX JDK 1.7 (64-bit versions) Oracle JRockit 1.6.0 R28 (32-bit and 64-bit versions) SAP JDK 1.6 (64-bit version) Supported: Oracle JRockit 1.6.0 R27 (32-bit and 64-bit versions) MicroStrategy Web ASP.Net server on 64-bit operating systems. Certified: .Net Runtime 4.0 or 4.5 (64-bit version) Oracle JRE 1.6.0 (64-bit version)
70 Installation prerequisites
requirements for UNIX and Linux operating systems, see Intelligence Server Universal software requirements on UNIX/Linux, page 57.
Requirement Operating system Recommended Certified: Windows Server 2003 Web Edition SP2 (on x64) Windows Server 2003 Standard Edition SP2 (on x64) Windows Server 2003 Enterprise Edition SP2 (on x64) Windows Server 2003 Standard Edition R2 SP2 (on x64) Windows Server 2003 Enterprise Edition R2 SP2 (on x64) Windows Server 2008 Standard Edition SP2 (on x64) Windows Server 2008 Enterprise Edition SP2 (on x64) Windows Server 2008 Standard Edition R2 SP1 (on x64) Windows Server 2008 Enterprise Edition R2 SP1 (on x64) Windows Server 2012 Standard (on x64) Solaris 10.x (on SPARC) Solaris 11.x (on SPARC) AIX 6.1.x Technology Level 1 (on IBM POWER Architecture) AIX 7.1.x (on IBM POWER Architecture) Red Hat Enterprise Linux 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, and 5.9 and RedHat Enterprise Linux Advanced Platform 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, and 5.9 (on x86-64) Red Hat Enterprise Linux 6.0.x, 6.1.x, 6.2.x, 6.3.x, and 6.4.x(on x86-64) Oracle Linux (on x86-64) distributed through the Oracle Unbreakable Linux program. SUSE Linux Enterprise Server 11.0.x (on x86-64) SUSE Linux Enterprise Server 11.1.x (on x86-64) SUSE Linux Enterprise Server 11.2.x (on x86-64) HP-UX 11i v2 Foundation Operating Environment (on Intel Itanium) HP-UX 11i v3 (on Intel Itanium) Supported: Windows Server 2003 Web Edition SP2 (on x86) Windows Server 2003 Standard Edition SP2 (on x86) Windows Server 2003 Enterprise Edition SP2 (on x86) Windows Server 2003 Standard Edition R2 SP2 (on x86) Windows Server 2003 Enterprise Edition R2 SP2 (on x86) Windows Vista Business Edition SP2 (on x64), for demonstration purposes only. Windows Vista Enterprise Edition SP2 (on x64), for demonstration purposes only. Windows 7 Professional Edition SP1 (on x86 or x64), for demonstration purposes only Windows 7 Enterprise Edition SP1 (on x86 or x64), for demonstration purposes only Windows 8 all editions (on x86 or x64), for demonstration purposes only IBM AIX 5.3.x Technology Level 11 (on IBM POWER Architecture)
Installation prerequisites
71
Recommended Certified: Oracle Web Application Server 10g Release 3 (10.1.3) Oracle WebLogic 12c Oracle WebLogic 10.3.x Oracle GlassFish Server 3.1.x IBM WebSphere 8.5.x IBM WebSphere 8.0.x IBM WebSphere 7.x Apache Tomcat 7.0.x Apache Tomcat 6.0.x Apache TomEE 1.5.x SAP NetWeaver Application Server 7.3.x JBoss Enterprise Application Platform 6.0.x Supported: JBoss Enterprise Web Platform 5.1.x JBoss Enterprise Application Platform 5.1.x JBoss Application Server 7.x JBoss Application Server 5.1.x
Certified: Oracle JDK 1.6 (32-bit or 64-bit) Oracle JDK 1.7 (32-bit or 64-bit) IBM JDK 1.6 (32-bit or 64-bit) IBM JDK 1.7 (32-bit or 64-bit) HP-UX JDK 1.6 (64-bit) HP-UX JDK 1.7 (64-bit) Oracle JRockit 1.6.0 R28 (32-bit and 64-bit) SAP JDK 1.6 (64-bit version) Supported: Oracle JRockit 1.6.0 R27 (32-bit and 64-bit)
72 Installation prerequisites
MicroStrategy SDK software requirements, including ASP.NET environment requirements, see MicroStrategy product: SDK, page 52.
Requirement JDK, JRE, and JVM Recommended Certified: Oracle JDK 1.6 (32-bit or 64-bit) Oracle JDK 1.7 (32-bit or 64-bit) IBM JDK 1.6 (32-bit or 64-bit) HP-UX JDK 1.6 (64-bit) HP-UX JDK 1.7 (64-bit) Oracle JRockit 1.6.0 R28 (32-bit and 64-bit) SAP JDK 1.6 (64-bit version) Supported: Oracle JRockit 1.6.0 R27 (32-bit and 64-bit)
Installation prerequisites
73
74 Installation prerequisites
Installation prerequisites
75
Supporting IIS 7.0.x or IIS 7.5.x as a web server for MicroStrategy Web or Mobile Server
If you plan to use IIS 7.0.x or IIS 7.5.x as the web server for MicroStrategy Web or Mobile Server, you must ensure that some IIS options are enabled. The procedure below describes how to enable the options that are required to support IIS 7.0.x or IIS 7.5.x as a web server for MicroStrategy Web or Mobile Server.
76 Installation prerequisites
To support IIS 7.0.x or 7.5.x as a web server for MicroStrategy Web or Mobile Server
third-party products discussed below are manufactured by The vendors independent of MicroStrategy, and the steps to configure these products is subject to change. Refer to the appropriate Microsoft documentation for steps to configure IIS 7.0.x or IIS 7.5.x. 1 On a Windows machine, open the Control Panel. 2 Double-click Programs and Features. 3 Click the Turn Windows features on or off task. The Windows Features dialog box opens. 4 Expand Internet Information Services, and select the following options: a Expand Web Management Tools and select: IIS Management Console IIS Management Scripts and Tools IIS Management Service
b Expand World Wide Web Services, then expand Application Development Features, and select: c .NET Extensibility ASP.NET ISAPI Extensions ISAPI Filters
Within World Wide Web Services, expand Common Http Features, and select: Default Document Static Content
Installation prerequisites
77
Supporting MicroStrategy products with IIS 6.x on 64-bit Windows operating systems
If you plan to use IIS 6.x on 64-bit Windows operating systems, some MicroStrategy products must be configured as 64-bit applications, and some MicroStrategy products must be configured as 32-bit applications. These requirements are described below: For MicroStrategy products that must be configured as 32-bit applications on 64-bit Windows operating systems, you must define the IIS parameter Enable32BitAppOnWin64 as True (1). These MicroStrategy products include:
Subscription Portal
For MicroStrategy products that must be configured as 64-bit applications on 64-bit Windows operating systems, you must define the IIS parameter Enable32BitAppOnWin64 as False (0). These MicroStrategy products include:
MicroStrategy Web Server (ASP.NET) MicroStrategy Mobile Server (ASP.NET) MicroStrategy Web Services (ASP.NET)
See your Microsoft documentation for steps to define the Enable32BitAppOnWin64 parameter. Information on defining this parameter is available at http://support.microsoft.com/kb/ 894435.
Since these MicroStrategy product groups require different IIS 6.x settings, you can only install products from one of the product groups listed above on 64-bit Windows operating systems with IIS 6.x. For example, you cannot install and host MicroStrategy Mobile Server and Subscription Portal on the same 64-bit Windows operating system with IIS 6.x. If you use IIS 7.0.x, there are no restrictions as to the products that can be installed and hosted through IIS on 64-bit Windows operating systems.
78 Installation prerequisites
Installation considerations
The following section contains guidelines and considerations you must keep in mind during MicroStrategy installation.
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. 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
Installation considerations
79
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. database server processes the SQL that Intelligence Server The 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.
80 Installation considerations
OLAP Services
OLAP Services store reports as Intelligent Cubes in the physical memory of the Intelligence Server. When these Intelligent Cubes are cached in memory, report manipulations, such as adding derived metrics and derived elements, formatting, and drilling within the Intelligent 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. For
Installation considerations
81
information on OLAP Services, see the OLAP Services Guide. Additional performance tuning best practices for OLAP Services are provided in the System Administration Guide.
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: Developer 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 Developer 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 MicroStrategy Web servers to Intelligence ServersIn a typical system you should have a 1:1 ratio of Intelligence Servers to MicroStrategy Web servers. This ensures that resources on both sides are optimized. However, you might find it useful to add Intelligence Servers or MicroStrategy 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.
82 Installation considerations
In just one week, MicroStrategy Professional Services, will conduct a thorough examination of your Business Intelligence implementation, providing you with actionable recommendations on these five key areas to improve overall performance. The MicroStrategy Performance Analysis service delivers: Performance optimization roadmap: A customized report with prioritized recommendations to achieve performance goals. System configuration: Optimum configuration setting recommendations to achieve efficient use of resources across different MicroStrategy products. Performance monitoring plan: A set of performance related metrics to proactively monitor and identify performance opportunities.
To learn how MicroStrategy Professional Services can help you assess and prioritize your performance opportunities with a Performance Analysis, see http://www.microstrategy.com/services-support/overview.
Installation considerations
83
Why should I increase memory on the machine that hosts Intelligence Server?
If the physical disk is utilized too much on a machine hosting Intelligence Server, it can indicate that there is a bottleneck in the systems performance. To monitor this on a Windows machine, use the Windows Performance Monitor for the object PhysicalDisk and the counter % Disk Time. If you see that the counter is greater than 80% on average, it may indicate that there is not enough memory on the machine. For more detailed information on tuning your machines memory for your MicroStrategy environment, see the section Managing system resources in the System Administration Guide.
being used. To monitor this on a Windows machine, use the Windows Performance Monitor for the object Network Interface, and the watch the counter Total bytes/sec as a percent of your networks bandwidth. If it is consistently greater than 60% (for example), it may indicate that the network is negatively affecting the systems performance. 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. For more detailed information on tuning your network for your MicroStrategy environment, see the section How the network can affect performance in the System Administration Guide.
What is the largest Intelligent Cube size that I can store in an Intelligence Server?
Intelligent Cubes must be stored in Intelligence Server memory for reports to access their data. While this can improve performance of these reports, loading too much data onto Intelligence Server memory can have a negative impact on Intelligence Servers ability to process jobs. For this reason, it is
2013 MicroStrategy, Inc. Installation considerations
85
important to govern how much Intelligent Cube data can be stored on the Intelligence Server. For information on governing Intelligent Cube memory usage, loading, and storage, see the System Administration Guide.
International support
The following table lists the language selection possibilities for different installation cases.
Installation Fresh installation on a system in which MicroStrategy application has never been installed before Result The MicroStrategy Installation Wizard prompts you to select the language from the drop-down list. The user language in the product interface is the language that you select during installation. Once the product is installed, the Online Help is displayed in the same language that the user selects in the language prompt of the installation routine. Repair or maintenance installation on a system on which MicroStrategy application has been installed before All subsequent executions of the installation routine are displayed in the language that you selected the first time you installed the product on the system. The user language in the product interface is also the language that you selected the first time you installed the product on the system. Completely uninstalling all the MicroStrategy products and installing the same version or a newer version If you uninstall all the products and install either the same version or a higher version again, the MicroStrategy Installation Wizard prompts you to select the language from the drop-down list. Note: Even if you select a language from the language prompt in the installation routine, it has no effect on the default language of the product interfaces.
MicroStrategy Web and Intelligence Server versions, refer to the MicroStrategy Readme. to the MicroStrategy General Information Readme for the Refer complete MicroStrategy platform compatibility and interoperability specification. In addition, you can contact MicroStrategy Technical Support for the latest information and updates.
MD: Metadata repository. MD also signifies certification or support for History List repositories, except where explicitly noted otherwise. ST: Statistics repository. NCS: MicroStrategy Narrowcast Server. MicroStrategy certifies 32-bit ODBC drivers for connection to DBMSs on Windows, Solaris, AIX, and Linux. MicroStrategy does not certify 64-bit ODBC drivers for DBMSs on these operating systems. MicroStrategy certifies 64-bit ODBC drivers for connection to DBMSs on the HP-UX platform. Only certified configurations are listed in the table below. For a complete list of certified and supported configurations with exact version numbers, refer to the certified and supported
Installation considerations
87
WH
WH
WH WH WH
Simba BigQuery ODBC Driver MicroStrategy ODBC Driver for Greenplum Wire Protocol Vertica ODBC driver
WH WH WH WH WH WH WH WH WH WH
MD WH ST NCS WH
MD WH ST
MD WH ST
MD WH ST
MD WH ST
WH
WH
WH
WH
88 Installation considerations
32-bit ODBC drivers DBMS Driver Windows Solaris IBM Informix IDS: 11.5 IBM Informix Ultimate Edition: 11.7 12.1 IBM Informix XPS 8.5 MicroStrategy ODBC Driver for Informix 8 with Informix Client SDK IBM Netezza ODBC Driver WH WH WH MicroStrategy ODBC Driver for Informix Wire Protocol WH WH AIX WH Linux WH
IBM Netezza: 5.0.x 6.0.x 7.0.x IBM Red Brick 6.3 Infobright 4.0.x Kognitio WX2 7.1.x 7.2.x Maria DB 5.5.x Microsoft SQL Database
WH
WH
WH
WH
WH
Red Brick Driver MicroStrategy ODBC Driver for MySQL Wire Protocol ODBC Driver for Kognitio WX2
WH WH WH
WH WH
WH WH
WH WH WH
MySQL ODBC Driver MicroStrategy ODBC Driver for SQL Server Wire Protocol Microsoft SQL Server
WH WH WH MD WH ST MD WH ST NCS WH MD WH ST WH
WH WH WH
Microsoft SQL Server: 2005 SP4 2008 SP3 2008 R2 SP1/SP2 2012 SP1
MicroStrategy ODBC Driver for SQL Server Wire Protocol Microsoft SQL Server
MD WH ST
MD WH ST
Microsoft SQL Server Microsoft SQL Server Parallel Parallel Data Warehouse Data Warehouse ODBC Client 2008 R2 Microsoft SQL Server Microsoft SQL Server Native Parallel Data Warehouse Client ODBC Driver 2012
WH
Installation considerations
89
32-bit ODBC drivers DBMS Driver Windows Solaris MySQL Community Server: 5.5 5.6 MySQL Enterprise: 5.5 5.6 Oracle: 10g 10gR2 11g 11gR2 12c ParAccel: 3.1 3.5 4.0 PostgreSQL: 8.4 9.0 9.1 9.2 Salesforce.com SAND CDBMS: 6.1 7.1 SAP HANA: 1.0 SP4 1.0 SP5 SAP Sybase ASE: 15.5 15.7 MySQL ODBC Driver MD WH AIX Linux MD WH
MicroStrategy ODBC Driver for MySQL Wire Protocol MicroStrategy ODBC Driver for Oracle Wire Protocol
MD WH MD WH ST NCS
MD WH MD WH ST
MD WH MD WH ST
MD WH MD WH ST
MD WH MD WH ST
WH
WH
MD WH
MD WH
MD WH
MD WH
MD WH
WH WH
WH
WH
WH
WH
HDBODC32 Driver
WH
WH
MD WH ST
MD WH ST
MD WH ST
MD WH ST
MD WH ST
90 Installation considerations
32-bit ODBC drivers DBMS Driver Windows Solaris SAP Sybase IQ: 15.1 15.2 15.3 15.4 16.0 Teradata: V12 V13 V13.10 V14.0 V14.10 Sybase IQ ODBC Driver WH WH Solaris 10.x only AIX WH Linux WH
MD WH ST
MD WH ST
MD WH ST
MD WH ST
MD WH ST
MicroStrategy Connectivity Wizard exposes only the 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 A, Connecting to Databases: ODBC and DSNs.
Installation considerations
91
Status Hadoop Distributions Pivotal HD Hortonworks HDP Recommended Client Windows Solaris MicroStrategy ODBC Driver for Apache Hive Wire Protocol Hortonworks ODBC Driver MicroStrategy ODBC Driver for Apache Hive Wire Protocol MapR MapR ODBC Driver MicroStrategy ODBC Driver for Apache Hive Wire Protocol Intel Distribution for Apache Hadoop MicroStrategy ODBC Driver for Apache Hive Wire Protocol WH WH WH WH WH WH WH WH WH WH WH WH WH AIX WH Linux WH WH WH WH WH WH WH WH WH HP-UX WH
MicroStrategy certifies Impala 1.x components of the listed Hadoop distributions. The following configurations of Apache Hadoop distributions have been tested:
Status Hadoop Distributions Cloudera Impala Recommended Client Windows Solaris MicroStrategy ODBC Driver for Apache Hive Wire Protocol Hive ODBC Driver from Cloudera WH WH WH AIX WH Linux WH WH HP-UX WH
MicroStrategy certifies InfoSphere BigInsights 2.x components of the listed Hadoop distributions. The following configurations of Apache Hadoop distributions have been tested:
Status Hadoop Distributions IBM InfoSphere BigInsights Recommended Client Windows Solaris BigInsights ODBC Driver WH AIX Linux WH HP-UX
92 Installation considerations
Installation considerations
93
Recommended Value Unlimited, or as large as the system virtual memory allows. Your system's virtual memory constraints affect the data size you can set for a processs heap size. The value should be the same as the maximum size for core dump files (coredumpsize). 200 MB. Set this value to the same value as the maximum heap size per process (datasize). If core dump files are created that are larger than this value, the files are corrupted and unusable. Unlimited, or as large as the physical memory of your system allows. Unlimited, or as large as your system virtual memory allows. 8192.
Maximum stack size per process. Maximum size for a single core dump file.
memoryuse (memory)
Maximum size of physical memory allotted per process. Maximum size of virtual memory allowed per process.
vmemoryuse (vmemory)
descriptors (nofiles) Maximum number of file descriptors (open files) per process.
Methods of installation
The methods of MicroStrategy installation are: Graphical user interface (GUI) Command line Silent installation
94 Methods of installation
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 Installation Wizard. Finish (only on the MicroStrategy Installation Wizard Complete page): Click to complete the setup and close the wizard.
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 MicroStrategy Installation 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 Installation Wizard. On the last page, which is MicroStrategy Installation 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 3, 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
95
Methods of installation
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 373, in Chapter 8, Automated Installation on Windows and Silent installation, page 382, in Chapter 9, Automated Installation on UNIX and Linux.
1 Retrieve the MicroStrategy installation files from the installation disk or the MicroStrategy download site. Save these files to a folder. Contact your MicroStrategy sales representative to determine the location and login credentials for the MicroStrategy download site. 2 Within the location where you saved the MicroStrategy installation files, browse to the DataFiles folder. 3 You can determine the required installation files in the following ways: For Windows installations, you can use the MicroStrategy Installation Wizard to determine the required files, as described in To determine the required installation files for Windows installations. For UNIX and Linux installations, the table below lists which installation files are required for each MicroStrategy component. Once you determine the required installation files, you can include
96 Methods of installation
them in your custom installation as described in To specify the location of the installation files below.
Installation File mstr1.tzp mstr3.tzp mstr4.tzp mstr5.tzp mstr6.tzp mstr7.tzp mstr8.tzp mstr9.tzp mstr10.tzp mstr11.tzp mstr12.tzp mstr13.tzp MicroStrategy Components That Require The Installation File All MicroStrategy components and products MicroStrategy Intelligence Server Universal and all of its components MicroStrategy Web Universal, including Web Analyst, Web Reporter, and Web Professional MicroStrategy Web Services for Office MicroStrategy Command Manager MicroStrategy Integrity Manager MicroStrategy System Manager MicroStrategy Mobile Client MicroStrategy Mobile Server MicroStrategy Portlets, which is a component of MicroStrategy Web Universal MicroStrategy GIS Connectors, which is a component of MicroStrategy Web Universal All MicroStrategy components and products
4 Move all of the compressed .zip files within this folder to a different folder location. 5 Use the MicroStrategy Installation Wizard to begin a MicroStrategy installation. For steps to locate and use the MicroStrategy Installation Wizard, see Chapter 2, Installing MicroStrategy on Windows. 6 Complete the steps up to and including the step to select the MicroStrategy components to be installed. 7 After selecting the MicroStrategy components to be installed and clicking Next, a message is displayed that lists the required installation files. Store all of these files in a location that can be accessed by the machine that will use the custom installation package. 8 Click Cancel to close the MicroStrategy Installation Wizard.
Methods of installation
97
9 When performing the installation, you can specify the location of these files as follows: For Windows installations, you can specify the location of these files using a response.ini file, as described in Installation Files, page 342. For UNIX installations, you can specify the location of these files using an options.txt file, as described in Providing installation files for smaller installations, page 397.
Licensing information
If you have installed the Evaluation version of MicroStrategy, you cannot use its license key with a Generally Available (GA) license key in the same environment. Hence, the Evaluation version of MicroStrategy cannot be used for your production environment. For example, if you have MicroStrategy 7.5.0 installed, your installation does not support MicroStrategy Office. This is due to the fact that its license key does not contain the license for MicroStrategy Office. If you want to test the capabilities of MicroStrategy Office, you can run the evaluation license key on your client computers. This can be done after downloading MicroStrategy Office, to test it in your environment. You must then configure MicroStrategy Office to connect to your development Intelligence Server, which was installed by the permanent GA license 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 because the license keys on the client machine and on the Intelligence Server are different. Therefore, the same license key must be used on both Intelligence Server and on the client machine for the client to connect to Intelligence Server. workaround for this scenario is to create a testing environment, A built entirely on the Evaluation license key. This enables customers to test any products they want to evaluate.
98 Licensing information
Types of licenses
Refer to your MicroStrategy contract and any accompanying contract documentation for descriptions of the different MicroStrategy license types.
99
101
Complete Chapter and Installation Task Chapter 7, 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, which are only necessary on a UNIX or Linux environment. 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
2
2.
Introduction
This chapter describes the procedures for installing the MicroStrategy products that are necessary to run your business intelligence application on a Windows environment. Before installing MicroStrategy products, you should refer to Chapter 1, Planning Your Installation for important pre-installation information. Some MicroStrategy products are available in two versions, as described below. Windows only: The Windows only versions, labeled as MicroStrategy Intelligence Server, MicroStrategy Web, and so on, are compatible only with a Windows platform. With these versions, MicroStrategy Web can be deployed quickly and easily using MicroStrategys Internet Information Services (IIS) Web Server. The drawback is that IIS is the only Web server that can be used to deploy the Windows only version of MicroStrategy Web. Windows only version of Intelligence Server can be used with The MicroStrategy Web Universal.
103
Universal (platform independent): The universal versions, labeled as MicroStrategy Intelligence Server Universal, MicroStrategy Web Universal, and so on, are compatible with Windows as well as UNIX/ Linux platforms. Installing the universal versions on Windows lets you deploy MicroStrategy Web Universal with different application and Web server combinations. For example, instead of using IIS to deploy MicroStrategy Web Universal, you can use Apache Tomcat, Oracle 10g, and so on.
you have used the Evaluation Edition of the MicroStrategy If 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, page 104 Configuring your MicroStrategy installation, page 122
If you are installing MicroStrategy on UNIX or Linux, refer to Installation procedures on UNIX and Linux, page 126 in Chapter 3, Installing MicroStrategy on UNIX and Linux. Additionally, Chapter 10, Deploying OEM Applications explains the common workflow for deploying the MicroStrategy platform as an Original Equipment Manufacturer (OEM) application.
Installation procedure
The MicroStrategy Installation Wizard provides steps to guide you through installing one or more MicroStrategy products in a Windows environment. The following sections can assist you in installing MicroStrategy products: Installing with the MicroStrategy Installation Wizard, page 105 Installation verification, page 121
There are a number of installation alternatives and procedures to support your MicroStrategy installation documented in this guide, including the following: For information on installation prerequisites, see Installation prerequisites, page 23 in Chapter 1, Planning Your Installation. For information about advanced installation functionality, such as installing in an SMS environment or using installation response files, see Chapter 8, Automated Installation on Windows. For information about installing and deploying MicroStrategy Web Universal with other Web and application servers, see Chapter 6, Deploying MicroStrategy Web and Mobile Server. For information about deploying MicroStrategy Web Services ASP.NET and J2EE, see the MicroStrategy Office User Guide.
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. Although MicroStrategy supports Windows Terminal Services, using Windows Terminal Services is not recommended for installation. It can affect the functionality of some MicroStrategy components.
1 Log on to the machine where you are installing one or more MicroStrategy products.
Installation procedure
105
2 Exit all Windows applications before beginning the installation process. 3 You can access the MicroStrategy Installation Wizard in the following ways: From the disk: Insert the disk into the disk drive and wait for the MicroStrategy Main Menu window to display automatically. If the MicroStrategy Main Menu does not display, locate and run Setup.exe on the disk. From the download site: Download the files from the MicroStrategy download site. Locate and run the Setup.exe file. Be aware of the following: Contact your MicroStrategy sales representative to determine the location and login credentials for the MicroStrategy download site. You may have to extract the downloaded files to locate the Setup.exe file. When extracting the files, ensure that the extraction software maintains the folder structure of the compressed files. Most extraction software maintains the folder structure by default, but if you use WinRAR, ensure that you select the Extract full paths option. To review an alternative, guided introduction to installing MicroStrategy software, you can locate and run the MICROSTRATEGY.exe file. For information on this installation alternative, see Installing with a guided MicroStrategy introduction, page 122. You can reduce the amount of data that has to be downloaded for the installation by excluding all of the .zip files, located in the Installations/DataFiles folder, from the download. You can use this technique to download only the files required to complete your MicroStrategy installation, which can then also be used to reduce the amount of data packaged and downloaded for other MicroStrategy installations. For steps to create these custom installation packages, see Creating custom installation packages, page 96. Details on using a response.ini file to provide the location of the installation files are provided in Chapter 8, Automated Installation on Windows and the parameters used to specify the location of the required installation files are described in Installation Files, page 342. 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 MicroStrategy Installation Wizard opens and leads you through the rest of the installation process. The sections below describe the actions you must take for each page in the wizard. After you enter all required information on an installation page, click Next to proceed to the next page of the installation routine. If any 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.
Welcome
Read the information on the welcome screen and proceed to the next step. If you opened the MicroStrategy Installation Wizard through the Microsoft Control Panel using the Add/Remove Programs option, the wizard opens the Welcome page in maintenance mode. For more information on modifying, repairing, or removing all or part of your MicroStrategy installation, see Chapter 12, Adding or Removing MicroStrategy Components.
License Agreement
Read the license agreement, and accept or decline the agreement by clicking the appropriate button. If you decline, you cannot install MicroStrategy products.
Click Print to print a copy of the license agreement for your records.
Customer Information
Enter the following customer information: User Name Company Name License Key users can contact Technical Support to obtain a license Licensed key.
Installation procedure
107
Select Features
You can select the MicroStrategy products to install as well as define the location in which to install the products. you have selected all required MicroStrategy products and Once defined the proper installation locations, if you are prompted to stop your MicroStrategy Web server, click Yes. If you click No, you cannot continue with the installation until you stop your MicroStrategy Web server.
see Recommended installation location and example deployments, page 24 in Chapter 1, Planning Your Installation. on your license key, you can install the Universal (platform Depending independent) version of some of the products listed below. For example, instead of MicroStrategy Web you may see MicroStrategy Web Universal. MicroStrategy Intelligence Server (see MicroStrategy Intelligence Server, page 6)
MicroStrategy Intelligence Server subcomponents (see MicroStrategy Intelligence Server subcomponents, page 8) such as MicroStrategy OLAP Services, MicroStrategy Report Services, MicroStrategy Distribution Services, MicroStrategy Transaction Services, MicroStrategy MultiSource Option, and MicroStrategy Clustering Option.
MicroStrategy Web (see MicroStrategy Web and Web Universal, page 11)
MicroStrategy Portlets (see MicroStrategy Portlets, page 13) MicroStrategy GIS Connectors (see MicroStrategy GIS Connectors, page 13)
MicroStrategy Web Services for Office (see MicroStrategy Web Services (ASP.NET) and Web Services (J2EE), page 20)
you are a MicroStrategy Web administrator, you can allow Web If users to install MicroStrategy Office by making an Install MicroStrategy Office link available in MicroStrategy Web. When a user chooses to install MicroStrategy Office, MicroStrategy Office is installed as a stand-alone product on his or her machine. MicroStrategy Office can be installed even if no other MicroStrategy products are available on his or her machine. For steps to enable users to install MicroStrategy Office from Web, see Enabling users to install MicroStrategy Office from Web, page 310 of Chapter 6, Deploying MicroStrategy Web and Mobile Server. MicroStrategy Mobile (see MicroStrategy Mobile, page 14) MicroStrategy Developer Products (see MicroStrategy Developer products, page 3)
Installation procedure
109
MicroStrategy Object Manager (see MicroStrategy Object Manager, page 5) MicroStrategy Command Manager (see MicroStrategy Command Manager, page 4) MicroStrategy Enterprise Manager (see MicroStrategy Enterprise Manager, page 6) MicroStrategy Integrity Manager (see MicroStrategy Integrity Manager, page 17) MicroStrategy System Manager (see MicroStrategy System Manager, page 18) MicroStrategy Narrowcast Server (see MicroStrategy Narrowcast Server, page 20) MicroStrategy Analytics Modules (see MicroStrategy Analytics Modules, page 21) also includes MicroStrategy Tutorial Reporting (see This MicroStrategy Tutorial Reporting, page 22)
Other components:
SequeLink ODBC Socket Server is required to support MicroStrategy Narrowcast Server. It can also be used to access Microsoft Access databases and Microsoft Excel files stored on a Windows machine from an Intelligence Server hosted on a UNIX or Linux machine (see MicroStrategy ODBC Driver for SequeLink, page 465). SequeLink ODBC Socket Server that is provided with a The MicroStrategy installation is for exclusive use with the MicroStrategy Product Suite. You are not licensed to use this product with any application other than MicroStrategy products.
The MicroStrategy MDX Cube Provider is required to connect to IBM Cognos TM1 data sources. It can also be used to connect to Microsoft Analysis Services data sources. For information on connecting to these MDX Cube data sources, see the MDX Cube Reporting Guide.
MicroStrategy SDK and MicroStrategy Developer Library The (MSDL) are not included in the MicroStrategy installation. You can download the MicroStrategy SDK from the MicroStrategy support site https://resource.microstrategy.com/msdz/default.asp. You can also access the MicroStrategy Developer Library from the MicroStrategy support site.
Many of the platform components have subcomponents. If you expand the different MicroStrategy products, you can select the appropriate check boxes to specify the subcomponents to install. For information on MicroStrategy components and subcomponents, see MicroStrategy components, page 2 in Chapter 1, Planning Your Installation.
Installation procedure
111
to and select the folder that stores the installation files. If all the required installation files are provided in the folder you select, you can click Next to continue the MicroStrategy installation.
Login: A Windows login of the form Domain\User with full administrative privileges under which to run the Health Center service. user account used to run Health Center must have full The administrator privileges for the local machine. If the administrator default privileges have been modified for the user account, connection errors can occur.
Password: A valid password for the Windows login entered in the Login field. Confirmation: Retype the password to confirm that it is correct.
2013 MicroStrategy, Inc.
Server Activation
If you install one or more MicroStrategy Server products, you can request an Activation Code to activate your MicroStrategy Server products upon completion of the installation process. The next few pages of the installation process guide you in providing the information you must submit to MicroStrategy to request an Activation Code. MicroStrategy Server products include: MicroStrategy Intelligence Server MicroStrategy Web or Web Universal MicroStrategy Mobile Server MicroStrategy Narrowcast Server Delivery Engine
Welcome
Read the information on the Welcome screen and click Next to proceed to the next step.
Server Information
Specify information about your Intelligence Server installation. Enter the following characteristics: Name: Distinguishes the name of this Intelligence Server installation from any other Intelligence Server installations in your company Location: Physical location of the machine on which Intelligence Server is installed Use: Description of how Intelligence Server is used
Installer Information
Specify contact information of the person installing the software. After your installation is complete an email containing the Activation Code is sent to the
Installation procedure
113
email address you confirm in this software activation step. Enter the following installer information: Specify whether you are an employee of the licensed company or installing on behalf of the licensed company. For descriptions of what information to include in the other text fields, press F1 to view the MicroStrategy online help.
Select the check box at the bottom of the page to receive notifications about product updates, events, and special offers from MicroStrategy.
Contact Information
You see this page if you indicated that you are not an employee of the company licensed to use this software, and are installing the software on behalf of that company. Specify contact information for the employee licensed to use the software. After your installation is complete an email containing the Activation Code is sent to the email address you confirm in this software activation step. For descriptions of what information to include in the text fields, press F1 to view the MicroStrategy online help.
Select the check box at the bottom of the page if you want to receive notifications about product updates, events, and special offers from MicroStrategy. Click Privacy Statement to view the MicroStrategy Privacy Statement.
addresses specified in the Installer Information and Contact Information pages. This email is sent upon completion of the installation process. Select No, I will request the Activation Code at a later time and click Next to request an Activation Code at a later time. If you choose to request an Activation Code at a later time, a message is displayed that instructs you how to request an Activation Code after the installation procedure is completed. For more instructions on requesting an Activation Code at a later time, see Request an Activation Code, page 146 in Chapter 4, Activating Your Installation. You have a grace period of 30 calendar days to activate your installation. If you do not complete the activation before the grace period expires, your MicroStrategy products stop functioning until you activate it. If you wait to activate your installation, you receive periodic reminders. Once your installation is complete and you request an Activation Code, an email is sent to the email addresses you specified in the Installer Information and Contact Information pages of the software activation procedure. The email provides instructions on how to use the requested Activation Code to activate your software. To activate your installation, you can also use the steps given in Activate your installation, page 148 in Chapter 4, Activating Your Installation. When the Activation Code request process is finished, you are prompted to either view the MicroStrategy Readme or go directly to the MicroStrategy Installation Wizard Complete page. Click Yes to read the MicroStrategy Readme or No to go to the MicroStrategy Installation Wizard Complete page.
Installation procedure
115
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. Therefore, 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.
MicroStrategy automatically configures the MicroStrategy Web virtual directory to run with the version of .NET Framework that it requires.
If you have a previous version of MicroStrategy Mobile Server installed on the machine, the new version you install uses the same virtual directory the previous version is using. Therefore, 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. MicroStrategy automatically configures the MicroStrategy Mobile Server virtual directory to run with the version of .NET Framework that it requires.
Installation procedure
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. name provided for a virtual directory must be unique. You cannot The use the same name as the default for other MicroStrategy products.
Select the check box to use the local system account as the Intelligence Server service account. If you clear the check box to set a different Intelligence Server service account, enter the following information: Login: a Windows login of the form Domain\User with full administrative privileges under which to run the Intelligence Server service user account used to run Intelligence Server must have full The administrator privileges for the local machine. If the administrator default privileges have been modified for the user account, connection errors can occur. For example, if the user account is denied access to the DSN accessed by Intelligence Server, Intelligence Server connection fails. Password: a valid password for the Windows login entered in the Login box Confirmation: retype the password to confirm it is correct
the password you supply changes, you must reconfigure the If Windows service to use the new password. Otherwise, Intelligence Server connections fail when the connection attempts to authenticate the login and password.
you change the password for this account, you must reconfigure the If Narrowcast Server Windows services to use the new password.
Installation procedure
119
Refer to the MicroStrategy Narrowcast Server Installation and Configuration Guide for additional details about this setting.
URL for MicroStrategy Web Services Service accounts for MicroStrategy Narrowcast Server and Intelligence Server Location of the installation log file License details
Click Install to continue with the installation process, which can take several minutes depending on your computers hardware configuration.
Installation verification
During the installation routine, the MicroStrategy Installation Wizard gathers and records information about your system and your installation selections. You can verify installation setup information through the installation log file (install.log), located by default in: 32-bit Windows environments: C:\Program Files\Common Files\ MicroStrategy. 64-bit Windows environments: C:\Program Files (x86)\ Common Files\MicroStrategy.
The installation log file includes the following information: Installation date Target directories
Installation procedure
121
Program folder name Operating system identification Hardware specifications Selected installation options Registry paths List of registered files
installation log file can be helpful if you encounter errors during The 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.
section Installing and configuring MicroStrategy on Windows, page 100 in Chapter 1, Planning Your Installation, for an installation and configuration checklist.
The next chapter in the installation and configuration checklist and in this guide covers software activation steps with MicroStrategy. These steps should be done before or soon after the Configuration Wizard tasks mentioned below. For more information, refer to Chapter 4, Activating Your Installation.
After restarting your machine to complete an initial MicroStrategy installation, the MicroStrategy Configuration Wizard opens. The Configuration Wizard allows you to configure your MicroStrategy production environment. For more information, refer to Chapter 5, Configuring and Connecting Intelligence Server.
123
3
3.
Introduction
This chapter describes the procedure for installing MicroStrategy on UNIX and Linux platforms. MicroStrategy products are compatible with Solaris, AIX, HP-UX, RedHat, and SUSE. The installation procedure described in this chapter refer to installing MicroStrategy on Solaris, AIX, HP-UX, RedHat, and SUSE. This chapter covers the following sections: Installation procedures on UNIX and Linux, page 126 Configuring your MicroStrategy installation, page 144
Before installing MicroStrategy products, you should refer to Chapter 1, Planning Your Installation for important pre-installation information. If you are installing MicroStrategy on Windows, refer to Chapter 2, Installing MicroStrategy on Windows. Additionally, Chapter 10, Deploying OEM Applications explains the common workflow for deploying the MicroStrategy platform as an Original Equipment Manufacturer (OEM) application.
125
MicroStrategy SDK and MicroStrategy Developer Library The (MSDL) are not included in the MicroStrategy installation. You can download the MicroStrategy SDK from the MicroStrategy support site https://resource.microstrategy.com/msdz/default.asp. You can also access the MicroStrategy Developer Library from the MicroStrategy support site. For more information about these products, see MicroStrategy components, page 2 in Chapter 1, Planning Your Installation. It is recommended that you install MicroStrategy products as the root user.
If you are installing MicroStrategy products with a CPU-based license, you must be logged in as the root user; otherwise an error message is displayed and the installation fails. If you want a non-root user to be the administrator of the server, you must manually change the ownership after running the installation. Intelligence Server operation is dependent on root user privileges and permissions. Therefore, changing the ownership of Intelligence Server to a non-root user is not a certified or recommended practice.
Only a user with root permissions can register MicroStrategy Intelligence Server as a service. If the Intelligence Server is registered as an application during installation, the root user can register the server as a service after running the installation. For more information on running Intelligence Server as a service, see the System Administration Guide. During installation, the user account for Intelligence Server is tested to verify that it can successfully support the use of common system tools for the operating system. If you change the user account for Intelligence Server, you must verify that this user account can use and access common system tools for the operating system. Script files within HOME_PATH/env and other configuration files within HOME_PATH (see Choose Destination Location, page 133 for information on this MicroStrategy directory) are overwritten anytime a new MicroStrategy product is installed on a machine. Backup copies of the previous file are also created during the installation. These backup copies can be used to update the new versions of the script and configuration files to include any prior modifications. For example, Intelligence Server is installed on a machine. Then a week later Command Manager is installed on the same machine. During this installation of Command Manager, script files such as ODBC.sh are overwritten and a backup copy of each of these files prior to the installation of Command Manager is also created.
127
Press 3 and then press ENTER to cancel the installation and close the MicroStrategy Installation Wizard. On the last page, which is MicroStrategy Installation Wizard Complete, press 3 and then press ENTER to complete the setup and close the wizard.
You need root access permissions for installation if you have purchased the CPU-based MicroStrategy license. If you want to enable additional error and troubleshooting issue logging for the MicroStrategy installation routine, contact MicroStrategy Technical Support.
1 Log on to the machine on which you are installing one or more MicroStrategy products. 2 Browse to the MicroStrategy Installation folder. Depending on your UNIX or Linux environment, browse to one of the following folders: Solaris: QueryReportingAnalysis_SunOS AIX: QueryReportingAnalysis_AIX HP-UX: QueryReportingAnalysis_HP-UX Linux: QueryReportingAnalysis_Linux
You can access the installation files from a disk or ask your system administrator to share the files on a network location. There are different disks for installing MicroStrategy products on different platforms; Windows, Solaris, AIX, HP-UX, and Linux. For
129
information on mounting or unmounting CD-ROM drives, refer to Mounting and unmounting CD-ROMs, page 522 in Appendix B, Troubleshooting. If your CD-ROM drive is configured to display directories with short names in lowercase font the directory names are in the form instal_1/queryr_1/. You can still run the installation but it is not as easy to locate the correct directories. For information on mounting CD-ROM drives, refer to Mounting and unmounting CD-ROMs, page 522 in Appendix B, Troubleshooting. You can reduce the amount of data that has to be downloaded for the installation by excluding all of the .tzp files located in the DataFiles folder. You can use this technique to download only the files required to complete your MicroStrategy installation, which can then also be used to reduce the amount of data packaged and downloaded for other MicroStrategy installations. For steps to create these custom installation packages, see Creating custom installation packages, page 96. Details on using a options.txt file to provide the location of the installation files are provided in Chapter 9, Automated Installation on UNIX and Linux and the parameters used to specify the location of the required installation files are described in Providing installation files for smaller installations, page 397.
3 Type the one of the following commands, depending on the installation mode you chose: To run the wizard in GUI mode: ./setup.sh To run the wizard in command line mode: ./setup.sh -console To run the wizard in silent mode: ./setup.sh -silent -options options.txt For information on performing a silent installation with an options.txt file, see Creating an options file, page 382.
4 The MicroStrategy Installation 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.
To complete the installation, you must have write permissions in the installation directory; otherwise the installation fails. After you enter all required information on an installation page, click Next, or press 1 and then press ENTER, to proceed to the next page of the installation routine.
At any time during the setup, you can click Cancel, or press 3 and then press ENTER, to quit the installation.
Language Setup
Specify the language to be used for the MicroStrategy installation and proceed to the next step.
Welcome
Read the information on the welcome screen and proceed to the next step.
131
various installation configurations. Select the installation you want to modify from the drop-down list, and then select one of the following installation configurations. The installation configuration options that are available depend on the type of installation that is being performed:
Modify: Select this option to add new program components or to remove currently installed components. If you want to remove all MicroStrategy components, use the Uninstall option described below. The remaining pages are the same as for a first-time installation, although some pages may be skipped if they are not required as part of the installation modification. Repair: Select this option to re-install program components if you have problems with previously installed components. Your program components are returned to their original installation state. As part of a repair installation, you can also designate this machine as a Health Agent. Uninstall: Select this option to uninstall all MicroStrategy components. Upgrade: Select this option to upgrade all MicroStrategy components to the version you are installing. This option is only available if the version you are installing is a more recent version of MicroStrategy than the current installation. Only the MicroStrategy components currently installed are upgraded, you cannot install or uninstall MicroStrategy components as part of an upgrade. For best practices and steps to upgrade your MicroStrategy installation, see the Upgrade Guide. Remove hotfix: Select this option to uninstall a MicroStrategy hotfix installation.
License Agreement
Read the license agreement, and select to accept or decline the agreement. If you choose to decline, you cannot install MicroStrategy products.
Customer Information
Enter the following customer information: User Company
License Key users can contact Technical Support to obtain a license Licensed key.
The default location is /var/opt/MicroStrategy, or $HOME/ MicroStrategy if you do not have write access to /var/opt/ MicroStrategy. Do not install the MicroStrategy configuration files directly to your UNIX or Linux Home Directory ($HOME). To ensure that the required permissions can be defined for the MicroStrategy configuration files, you must install these files within a separate directory. For example, the default path of $HOME/MicroStrategy uses the MicroStrategy directory within $HOME to ensure permissions on these files are defined correctly. The path specified for the home directory is referred to as HOME_PATH in this guide. Do not change the names of folders within the HOME_PATH after installing Intelligence Server. When including paths during a MicroStrategy installation, include absolute paths rather than relative paths.
MicroStrategy Install Directory: Specify the location where the MicroStrategy products are to be installed, according to the following guidelines:
The default location is /opt/MicroStrategy, or $HOME/ MicroStrategy/install if you do not have write access to /opt/ MicroStrategy. The path specified for the install directory is referred to as INSTALL_PATH in this guide. Do not change the names of folders within the INSTALL_PATH after installing Intelligence Server.
133
When including paths during a MicroStrategy installation, include absolute paths rather than relative paths.
MicroStrategy Log Directory: Specify the location where the MicroStrategy application logs are to be created, according to the following guidelines:
The default location is /var/log/MicroStrategy, or $HOME/ MicroStrategy/log if you do not have write access to /var/log/ MicroStrategy. The path specified for the log directory is referred to as LOG_PATH in this guide. When including paths during a MicroStrategy installation, include absolute paths rather than relative paths.
Select Components
Select the check box of a MicroStrategy product to include that product in the installation. Alternatively, you can clear a check box to uninstall or exclude a MicroStrategy product from the installation. The installation pages you see after this step depend on the products you choose to install. These instructions describe all possible pages. Many of the platform components have subcomponents. If you expand the different MicroStrategy products, you can select the appropriate check boxes to specify the subcomponents to install. For information on MicroStrategy components and subcomponents, see MicroStrategy components, page 2 in Chapter 1, Planning Your Installation. can only see MicroStrategy products that are available with your You license key.
Destination Folder
You can select MicroStrategy products and their sub-components to define their installation locations. When you select a MicroStrategy product or sub-component, the Destination Folder area near the bottom of the interface displays the current installation folder for the product. Click Browse to select a different installation folder. If you select a MicroStrategy product or sub-component and the Browse button is not accessible, this means that the installation location cannot be
changed. For example, if you select MicroStrategy Mobile you cannot define an installation location. However, if you expand this product, you can define the installation location for its subcomponents.
Provide the location of the installation files using an options.txt file. This lets you access the installation files stored on a folder or stored at a URL and accessed using HTTP or HTTPS. Details on using an options.txt file as part of an installation are provided in Chapter 9, Automated Installation on UNIX and Linux and the parameters used to
135
specify the location of the required installation files are described in Providing installation files for smaller installations, page 397. If the files required for the installation are stored in a folder, you can instead click Browse to navigate to and select the folder that stores the installation files. If all the required installation files are provided in the folder you select, you can click Enter to continue the MicroStrategy installation.
Missing Requirements
This page is displayed only if there are system requirements that are not met to install the MicroStrategy products you selected. Review the list of requirements to determine if you can proceed with the installation, or if the installation must be cancelled. If you are installing MicroStrategy Intelligence Server Universal on Linux, you may see a warning about the value for the Linux kernel setting vm.max_map_count. For information on this setting and MicroStrategys recommendation on its value, see Supporting Intelligence Server Universal memory allocation on Linux, page 64. To improve the performance of MicroStrategy Intelligence Server Universal for large scale production applications, Intelligence Server Universal can be configured to use shared memory resources. If a semaphore configuration warning is displayed, some system resource limits are not configured to fully support the use of shared memory resources. To support this configuration, cancel the installation and refer to the limit recommendations provided in Configuring shared memory resources, page 58.
System Requirements
This page is displayed only if the machine you are installing Intelligence Server Universal on does not use the recommended system resource limits to support the use of shared memory resources. It is recommended that you exit the installation and configure these system settings to support shared memory resources. For information on this requirement and the options available to complete the installation, see Configuring shared memory resources, page 58.
137
Software Activation
If you have installed one or more MicroStrategy server products, you can request an Activation Code to activate your MicroStrategy server products upon completion of the installation process. The next few pages of the installation process guide you in providing the information you must submit to MicroStrategy to request an Activation Code. MicroStrategy server products include: MicroStrategy Intelligence Server MicroStrategy Web or Web Universal MicroStrategy Mobile Server
Welcome
Read the information on the welcome screen and proceed to the next step.
Server Information
Specify information about your MicroStrategy server installation. Enter the following characteristics: Name: Distinguishes the name of this MicroStrategy server product installation from any other MicroStrategy server product installations in your company. Location: Physical location of the machine on which MicroStrategy server products are installed. Use: Description of how the server is used.
Installer Information
Specify contact information of the person installing the software. After your installation is complete an email containing the Activation Code is sent to the email address you confirm in this software activation step. Enter the following installer information: Specify whether you are an employee of the licensed company or installing on behalf of the licensed company.
Enter the necessary data into all text fields. Make sure the email address you enter is correct. This email address is the recipient of the Activation Code.
Select the check box at the bottom of the page to receive notifications about product updates, events, and special offers from MicroStrategy.
Contact Information
You see this page if you indicated that you are not an employee of the company licensed to use this software, and are installing the software on behalf of that company. Specify contact information for the employee license to use the software. Enter the necessary data into all text fields. Make sure the email address you enter is correct. After your installation is complete an email containing the Activation Code is sent to the email address you confirm in this software activation step.
Select the check box at the bottom of the page to receive notifications about product updates, events, and special offers from MicroStrategy.
139
If you choose to request an Activation Code at a later time, a message is displayed that instructs you how to request an Activation Code after the installation procedure is completed. For more instructions on requesting an Activation Code at a later time, see Request an Activation Code, page 146 in Chapter 4, Activating Your Installation. You have a grace period of 30 calendar days to activate your installation. 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. Once you request an Activation Code, an email is sent to the email addresses you specify in the Installer Information and Contact Information pages of the software activation procedure. The email provides instructions on how to use the requested Activation Code to activate your software. To activate your installation, you can also use the steps given in Activate your installation, page 148 in Chapter 4, Activating Your Installation.
1 In a console window, browse to the system folder usr/lib64. 2 In a console window, create the link of libssl.so.4 to libssl.so.0.9.7 with the command, ln libssl.so.0.9.7 libssl.so.4
141
3 In a console window, create the link of libcrypto.so.4 to libcrypto.so.0.9.7 with the command, ln libcrypto.so.0.9.7 libcrypto.so.4
This occurs because the fonts required by the PDF component are missing from UNIX and Linux machines running Intelligence Server Universal. cannot package these fonts with Intelligence Server MicroStrategy Universal due to licensing restrictions. For steps to support fonts such as Microsoft True Type fonts for the MicroStrategy features listed above, see Setup for executing Report Services documents, page 324.
Verifying installation
During the installation routine, the MicroStrategy Installation 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 MicroStrategy Installation Wizard. The log file includes information about the following: Installation date Target directory
2013 MicroStrategy, Inc.
log file can be helpful if you encounter errors during the This 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. an installation on HP-UX, the folders INSTALL_PATH/bin32 For and INSTALL_PATH/lib32 are not created because HP-UX uses 64-bit ODBC drivers, which allows all the binary files to be in 64-bit format.
PATH/Directory HOME_PATH HOME_PATH/env Contents Configuration files that can be modified after installation. Scripts to set up the proper environment for the MicroStrategy applications. If additional products are installed on the same machine at a later time, backups of the original scripts are saved here. Scripts to launch the MicroStrategy applications. Files that are not supposed to change after the installation is complete. MicroStrategy Command Manager files. This is the default directory for Command Manager but another location can be selected during installation. Documentation and Help for MicroStrategy products. MicroStrategy Portlet files. This is the default directory for the Portlets but another location can be selected during installation. Intelligence Server-specific binary files. MicroStrategy Mobile and Mobile Server JSP files. This is the default directory for Mobile but another location can be selected during installation.
INSTALL_PATH/Help INSTALL_PATH/GISConnectors
143
Contents Support files (fonts) for the PDF generation feature of Intelligence Server. MicroStrategy Readme for this release of MicroStrategy products. MicroStrategy Portlet files. This is the default directory for the Portlets but another location can be selected during installation. MicroStrategy System Manager files. This is the default directory for System Manager but another location can be selected during installation. MicroStrategy Web Services deployment path. MicroStrategy Web Universal deployment path. 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. Launch files for uninstalling MicroStrategy Universal. 64-bit binary files. 32-bit binary files. Online help files. Java libraries. 64-bit binary libraries. 32-bit binary libraries. ODBC support messages. The ODBC drivers are copied to /lib32. MicroStrategy application log files, which includes Intelligence Server log files.
INSTALL_PATH/SystemManager
4
4.
Introduction
After your MicroStrategy installation is complete, you have 30 days to activate your installation. Before you activate your installation you must request an Activation Code from MicroStrategy. You can complete this request when you install MicroStrategy with the MicroStrategy Installation Wizard or after the installation using MicroStrategy License Manager. This chapter describes the following procedures: Request an Activation Code Activate your installation
For answers to commonly asked questions about server activation, see Server Activation FAQ.
145
If you requested an Activation Code during installation you can skip this procedure and activate your installation by following the instructions in the next procedure, Activate your software installation, page 148. 1 Open MicroStrategy License Manager: Windows: From the Start menu, point to Programs, then MicroStrategy Tools, and then select License Manager. License Manager opens. UNIX/Linux: License Manager can be run in GUI mode or command line mode. GUI: In a UNIX or Linux 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 ./ mstrlicmgr, then press ENTER. The MicroStrategy License Manager opens in GUI mode. Command line: In a UNIX or Linux 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 ./mstrlicmgr -console, then press ENTER. The MicroStrategy License Manager opens in command line mode. steps to request an Activation Code in command line mode of The License Manager vary from the steps below. Refer to the License Manager command line prompts to guide you through the steps to request an Activation Code. For more information specific to requesting an Activation Code for your installation in command line mode, refer to MicroStrategy Tech Note TN13550. 2 Select the License Administration tab. Under Server Activation select the Activate Server Installation option and click Next to continue to the next page. 3 Select the Generate Activation File and Request Activation Code option and click Next to continue to the next page. 4 Enter the characteristics of your server installation and click Next to continue to the next page. 5 Enter the contact information for the person who installed the software. Make sure to correctly select whether you are an employee of the licensed company or installing the software on the licensed companys behalf. If you select that you are an employee of the licensed company, click Next to continue to the next page. Once you complete the following step, the Activation Code is sent to the email address given; therefore it is important that the email address is valid and entered correctly. If you select that you are not an employee of the licensed company, a contact information page is displayed after you click Next. Enter the contact information for the licensed company. Click Next to continue to the next page. Once you complete the following step, the Activation Code is sent to the email address given; therefore it is important that the email address is valid and entered correctly.
6 Select Yes, I want to request an Activation Code now and click Next. An email containing the Activation Code is sent to the email address or addresses you confirmed in the steps above.
147
This procedure assumes that you have requested an Activation Code and received an email from MicroStrategy containing the Activation Code. 1 Open MicroStrategy License Manager: Windows: From the Start menu, point to Programs, then MicroStrategy Tools, and then select License Manager. License Manager opens. UNIX/Linux: License Manager can be run in GUI mode or command line mode. GUI: In a UNIX or Linux 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 ./ mstrlicmgr, then press ENTER. The MicroStrategy License Manager opens in GUI mode. Command line: In a UNIX or Linux 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 ./mstrlicmgr -console, then press ENTER. The MicroStrategy License Manager opens in command line mode. steps to activate your installation in command line mode of The License Manager vary from the steps below. Refer to the License Manager command line prompts to guide you through the steps to activate your installation. For more information specific to activating your installation in command line mode, refer to MicroStrategy Tech Note TN13550. 2 Select the License Administration tab. Under Server Activation select the Activate Server Installation option and click Next to continue to the next page. step above is not necessary for License Manager in command The line mode.
3 Select the Server Activation using Activation Code option and enter your Activation Code in the text field. Click Next to activate your software installation. 4 A verification message is displayed, click OK to close it. You must restart your Intelligence Server for the activation status to update. You must also restart your Web server for the activation status to update in MicroStrategy Web.
149
If more than one server product is installed on the same machine, does each server product need to be activated and deactivated separately?
No. All MicroStrategy server products installed on a single machine are grouped as a Server Installation and will be activated and deactivated as a group.
Is Server Activation required for both Named-user and CPU based licenses?
Yes. Server Activation is required for both Named-user and CPU based licenses. Server Activation is designed to track software installations regardless of licensing model. Server Activation does not manage or limit the number of servers on which server software is installed.
Does Server Activation aggregate the total number of licenses installed and prevent over-installation of products?
No. Server Activation and the licensing models are independent. However, using Server Activation information available at https:// licensing.microstrategy.com, organizations can monitor the number of installations. Deactivating Server Installations that are not being used will ensure this information is up-to-date.
151
MicroStrategy Tech Support liaisons. The Activation Code must be manually entered into License Manager on the target Server Installation.
Can the Server Installation be automatically activated after automatically requesting an activation code?
No, the Activation Code is sent to the installer and to the MicroStrategy Tech Support contacts by email. Upon receiving the activation code, the Server Installation needs to be manually activated by entering the activation code using License Manager. For manual activations, the Activation Code can be copied from the Activation website, and pasted into License Manager.
Installation timestamp Activation ID (if the installation has previously been activated) Contract information CD Key used in installation Installer contact details name, address, email Company contact details name, address, email Server Installation information name, location, use
Hardware information:
Unique Hardware Identifier CPU Information type, bit-size, clock speed, total quantity Physical Memory installed
Additional information 4GT mode and hyperthreading in Windows, LPAR ID, number of pooled CPUs, SMT used in AIX
MicroStrategy information:
Install Type new/modify/upgrade Products and version installed Number of CPUs allocated for CPU licenses
Database information:
Metadata database and ODBC driver Data warehouse database and ODBC driver
153
Solaris: Host ID RedHat Linux: An identifier generated from a one-way hash of the network interface card MAC address HP-UX: Exposes a unique Machine ID that can be obtained from the Operating System command line, using the following command: getconf CS_MACHINE_IDENT
Is there a grace period from the time server products are installed to when it can be activated?
Yes. There is a 30 calendar day grace period from installation (7 days for Evaluation Edition) before a server installation must be activated.
What should be done if automatic request for an Activation Code does not work at all?
The Server Installation should be manually activated using License Manager on a machine that has access to the Web. The Activation XML file should be copied from the Server Installation that requires activation to this computer. If this does not work, contact MicroStrategy Technical Support.
What if the server machine has a catastrophic failure and cannot be deactivated automatically or manually?
If a machine has a catastrophic failure and the server products cannot be uninstalled or deactivated, contact MicroStrategy Technical Support to update the status of this Server.
If there is more than one server product installed on a machine and one is removed, does the Server Installation need to be deactivated?
Upon removal of a server product, all remaining server products are automatically deactivated. The remaining server product(s) need to be reactivated to reflect the new product configuration on that machine. For example, if a machine contains MicroStrategy Narrowcast Server and MicroStrategy Web, and MicroStrategy Narrowcast Server is removed,
155
MicroStrategy Web will be automatically deactivated. MicroStrategy Web will need to be reactivated.
The Installation ID is a unique identifier for Server Installations. This ID is provided along with the Activation Code in the email received when requesting activation.
5
5.
Introduction
After installing MicroStrategy, you must complete a few configuration tasks. This chapter addresses the processes used to configure the databases you intend to use in your business intelligence system, as well as an installed MicroStrategy suite of products. MicroStrategy platform includes a Tutorial project, which is a The 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 information: Communicating with databases: ODBC and DSNs, page 158 Initial MicroStrategy configuration, page 171 Connecting to a data source, page 210
157
Creating a project, page 227 Configuring your MicroStrategy installation, page 227
If you are configuring MicroStrategy on a UNIX or Linux machine that does not have a GUI, you can perform configuration tasks with command line tools. For steps to perform configuration tasks using command line tools in UNIX and Linux, see Chapter 11, Configuring MicroStrategy Using Command Line Tools.
The diagram below illustrates the three-tier metadata and data warehouse connectivity used in the MicroStrategy system.
The diagram shown above illustrates projects that connect to only one data source. However, MicroStrategy allows connection to multiple data sources in the following ways: With MicroStrategy MultiSource Option, a MicroStrategy project can connect to multiple relational data sources. For information on MultiSource Option, see Chapter 9, Optimizing and Maintaining Your Project in the Project Design Guide. You can integrate MDX cube sources such as SAP BW, Microsoft Analysis Services, and Hyperion Essbase with your MicroStrategy projects. For information on integrating these MDX cubes sources into MicroStrategy, see the MDX Cube Reporting Guide.
159
This section provides information and instructions on the following tasks: Setting up ODBC, page 160 Defining DSNs, page 165 Testing ODBC connectivity, page 169
Setting up ODBC
The following information assists you in setting up ODBC between Intelligence Server and your metadata database and data warehouse. ODBC is a standard method of communicating with database servers. Intelligence Server uses ODBC to connect to and communicate with all database servers in the system. Specifically, ODBC connects to and transfers data to and from data sources within relational databases. ODBC permits maximum interoperabilityan application can access data in diverse DBMSs through a single framework. A client application uses a database driver and a driver manager to make a connection to the data source. A data source, identified by a data source name, is the database or file accessed by a driver. Data source is another term for a logical database within a database server. A database server can contain multiple logical databases or data sources. When setting up the ODBC environment, you must create a separate ODBC connection to the data warehouse and metadata repository. This requirement is true even if both databases are accessed through the same DBMS. Further description of these two requirements is provided below: A data warehouse stores the data that users of the system must analyze to track and respond to business trends, and to facilitate forecasting and planning efforts. Metadata is a repository whose data associates the tables and columns of a data warehouse with user-defined attributes and facts to enable the mapping of business views, terms, and needs to the underlying database structure. Metadata can reside on the same server as the data warehouse or on a different server. It can be stored in different relational DBMSs.
A successful ODBC connection requires the following information: A data source name (DSN) is the name for a pointer used by a client application to find and connect to a data source. A data source is the database accessed by a driver. The information obtained through a DSN
2013 MicroStrategy, Inc.
generally includes the host computer name or IP address, instance name, and database name. However, the exact information varies depending on the type of database server. An ODBC driver is a type of software that translates information between the client application (Intelligence Server) and the database server API. Different database servers speak through different APIs. For example, Informix database servers use Informix Command Line Interface (CLI), Oracle database servers use the Oracle API, Sybase database servers use another API, and so on. For more information on ODBC drivers and how they work with MicroStrategy, see ODBC drivers, page 162. A connection string stores the information required to connect to a database server. A connection string usually includes a DSN, as well as the user ID and password required to log in to the database server. This information varies depending on the particular database server. The ODBC driver manager coordinates communication between a client application and a database server. The client application tells the driver manager that it needs to connect using a particular connection string. The DSN found in this connection string provides the driver manager with the type of database server to which the application needs access along with the driver to be used. From this information, the driver manager initiates the communication.
161
The following diagram illustrates the ODBC connection requirements to connect MicroStrategy to a database.
Windows, MicroStrategy uses the ODBC driver manager In provided by Microsoft. In UNIX/Linux environments, MicroStrategy includes its own ODBC driver manager to facilitate the MicroStrategy to database server communication. This MicroStrategy ODBC driver manager has the equivalent functionality of the Microsoft Windows ODBC Driver Manager.
ODBC drivers
ODBC drivers are DBMS-specific and must be installed on MicroStrategy Intelligence Server prior to creating the ODBC connection to the warehouse and metadata databases. MicroStrategy embeds and brands DataDirect ODBC drivers in the MicroStrategy platform. These drivers are certified to work with MicroStrategy products. In addition, on Windows, a MicroStrategy installation includes Microsoft SQL Server ODBC from Microsofts MDAC component. The purpose of an ODBC driver is to translate MicroStrategy Intelligence Server requests into commands that the DBMS understands. ODBC drivers
162 Communicating with databases: ODBC and DSNs
2013 MicroStrategy, Inc.
submit SQL requests and also return results from the data warehouse to MicroStrategy Intelligence Server. Users of the MicroStrategy platform can employ the MicroStrategy-branded ODBC drivers to connect MicroStrategy products to various DBMSs. For a list of the available ODBC drivers for Windows, Solaris, AIX, HP-UX, and Redhat or SUSE Linux that are certified for Intelligence Server and different DBMS types, see Certified ODBC drivers for MicroStrategy Intelligence Server, page 87. See the MicroStrategy Readme file for details about supported and certified ODBC drivers. To access the MicroStrategy Readme: On Windows: From the Start menu, point to Programs, then to MicroStrategy Documentation, and then choose ReadMe. On UNIX/Linux: From the UNIX/Linux File Manager, browse to INSTALL_PATH, where INSTALL_PATH is the directory that you specified as the install directory during installation. Double-click the ReadMe.htm file.
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.
163
The database-specific ODBC drivers are installed in the locations specified during the installation of the drivers. MicroStrategy-branded drivers are installed in C:\Program Files\Common Files\MicroStrategy. If you installed MicroStrategy on a 64-bit Windows environment, MicroStrategy-branded drivers are installed in C:\ Program Files (x86)\Common Files\MicroStrategy.
Default location for ODBC and driver files for UNIX and Linux
The ODBC driver manager and support libraries are usually installed in the following default directories:
Operating System Solaris AIX HP-UX RedHat and SUSE Linux Default Location for ODBC Driver Manager Libraries INSTALL_PATH/lib32 INSTALL_PATH/lib32 INSTALL_PATH/lib INSTALL_PATH/lib32
The database-specific ODBC drivers are installed in the locations specified during the installation of the drivers. MicroStrategy-branded ODBC drivers are installed in INSTALL_PATH/lib32 for Solaris, AIX, and Linux, where INSTALL_PATH is the directory you specified as the Install Directory in the Install Wizard. If you install on HP-UX, the MicroStrategy-branded ODBC drivers are installed in INSTALL_PATH/lib. MicroStrategy Connectivity Wizard lists only the The MicroStrategy-branded ODBC drivers. However, this guide also provides information on how to install drivers from other vendors with MicroStrategy. For more information, Creating DSNs for specific ODBC drivers, page 451.
Defining DSNs
After you install an ODBC driver, you can define one or more data sources for it. The DSN should provide a unique description of the data, for example, Payroll_Project_Metadata or Payroll_Warehouse. The DSN is the name for a pointer used by a client application (in this case MicroStrategy) to find and connect to a data source. Multiple DSNs can point to the same data source and one DSN can be used by different applications. You can define a data source connection with a DSN by using: The MicroStrategy Connectivity Wizardconfigures connectivity to data sources by creating a DSN that uses a MicroStrategy-branded ODBC driver (see Creating a DSN for a data source, page 165). The Microsoft ODBC Data Source Administratorcreates a DSN for an ODBC driver that is not MicroStrategy-branded (see Managing ODBC and data sources with Microsoft ODBC Data Source Administrator, page 168).
It is strongly recommended you use the MicroStrategy Connectivity Wizard when creating a new DSN for a MicroStrategy-branded ODBC driver. Use the Microsoft ODBC Data Source Administrator only if you intend to use a driver that is not MicroStrategy-branded. If you create DSNs using the Microsoft ODBC Data Source Administrator, you must create system DSNs. Otherwise, MicroStrategy interfaces will not recognize them.
165
To create a DSN
1 If you are creating a DSN: On Windows, perform the following steps: Log in to the system as an administrator. From the Start menu, point to Programs, then MicroStrategy Tools, and then select Connectivity Wizard. The Welcome page of the Connectivity Wizard opens. On UNIX or Linux using the Connectivity Wizard interface, perform the following steps: From a UNIX/Linux console window, browse to HOME_PATH, where HOME_PATH is the directory that you specified as the home directory during installation. Browse to the folder bin and type ./mstrconnectwiz, and then press ENTER. The Welcome page of the Connectivity Wizard opens. On UNIX or Linux from the command line, then perform the following steps: From a UNIX/Linux console window, browse to HOME_PATH, where HOME_PATH is the directory that you specified as the home directory during installation. Browse to the folder bin and type ./mstrconnectwiz -h, and then press ENTER. This command displays command line operation syntax and examples for different database platforms. Create your command based on the syntax and examples displayed. Once you perform your command, the DSN is created and you can skip the rest of this procedure. For detailed steps on how to use the command line version of this tool, see Creating a DSN for a data source, page 416 in Chapter 11, Configuring MicroStrategy Using Command Line Tools. 2 Click Next. A list of database drivers is displayed. The list available for Windows is different than the list available for UNIX/Linux. For a list of the available ODBC drivers for Windows, Solaris, AIX, HP-UX, and Redhat or SUSE Linux that are certified for Intelligence Server and
different DBMS types, see Certified ODBC drivers for MicroStrategy Intelligence Server, page 87. Windows, if you select Other Relational Databases and click For Next, you see a list of all other drivers installed on your machine, excluding the MicroStrategy and Microsoft SQL Server drivers. 3 Select a database driver with which to create a DSN and click Next. The Driver Details page opens. a few databases can contain metadata repositories. For Only details, refer to the MicroStrategy Readme. Only DSNs created to connect to these databases can be used to connect to metadata repositories. 4 Enter the information in the appropriate fields for connecting with the selected database driver. The information to enter varies depending on the database platform that you selected. For more information, see Creating DSNs for specific ODBC drivers, page 451. 5 Click Test to verify the connection. The Test Connection dialog box opens. 6 Enter the User Name and Password to connect to the database. 7 Click Connect to test and verify the connection. If the test is performed successfully, the connection with the database is established. If the test fails, verify the correct connection information with your database administrator and make any required changes to the information you provided in the previous steps. 8 Click Close, and then Finish to create the new DSN. you already have an existing DSN with the same name as the one If you provided, a message box appears. You have the following options: Select Yes to make sure the DSN points to the location you are expecting. This overwrites the existing DSN. Select No to save the DSN with a different name.
9 Repeat the above steps to create as many DSNs as you require. At a minimum, create one for your metadata and one for your warehouse.
167
Managing ODBC and data sources with Microsoft ODBC Data Source Administrator
The Microsoft ODBC Data Source Administrator manages database drivers and data sources on Windows. The Microsoft ODBC Data Source Administrator utility creates a log with which to trace calls to data sources and to view, create, and edit DSNs. The utility is available from Microsoft and is usually included with the purchase of an ODBC driver.
It is strongly recommended that you use the Connectivity Wizard when creating a new DSN for a MicroStrategy-branded ODBC Driver. Use the Microsoft ODBC Data Source Administrator only if you intend to use a non-MicroStrategy driver. If you choose to create DSNs using the Microsoft ODBC Data Source Administrator, they must be system DSNs. Otherwise, MicroStrategy interfaces cannot recognize them.
1 Log in to the machine as an administrator. This gives you the ability to create a system-wide DSN, rather than a user-specific DSN. 2 In most Windows systems you can access the ODBC Data Source Administrator from the Control Panel. Refer to your third-party Microsoft documentation for steps to access the ODBC Data Source Administrator tool. you are using a 64-bit version of Windows, the Microsoft ODBC If Data Source Administrator accessed from the Control Panel only displays 64-bit drivers. To view MicroStrategy ODBC drivers, which are all 32-bit drivers, you must use the 32-bit version of Microsoft ODBC Data Source Administrator. To access this version of the tool, locate the Windows SysWOW64 folder. Within this folder, double-click the odbcad32.exe file. 3 Click the System DSN tab. A list displays all the existing system data sources and their associated drivers.
To view all the installed ODBC drivers, click the Drivers tab.
4 Click Add. The Create New Data Source dialog box opens.
168 Communicating with databases: ODBC and DSNs
2013 MicroStrategy, Inc.
5 Select the desired driver and click Finish. A driver setup dialog box is displayed. is recommended that you select a MicroStrategy ODBC driver. It These drivers, whose names start with MicroStrategy, were installed when you installed the MicroStrategy application on the computer. 6 Enter the information in the appropriate fields to create a data source for the selected database driver. The information to enter varies depending on the database platform that you selected, which is discussed in Creating DSNs for specific ODBC drivers, page 451. 7 Click OK to create a new DSN.
test method described above reflects the situation when the The ODBC driver and the database network software are bundled. If they are not bundled, they must be configured and tested separately, using database-specific tools.
169
Prerequisites Before you use the DB Query Tool, test the network layer with the network layer utility, PING.EXE. Consult your operating system or network system documentation for details.
To use the DB Query Tool
1 To use the DB Query Tool: On Windows using the DB Query Tool interface, perform the following step: From the Windows Start menu, point to Programs, then MicroStrategy Tools, and then choose DB Query Tool. On Windows from the command line, perform the following steps: From the Windows Start menu, select Run. The Run dialog box opens. In the Open drop-down list, type cmd and click OK. A command prompt opens. Type todbcx.exe and press ENTER. Prompts guide you through testing your ODBC connection from the command line and should be used in place of the steps below. For detailed steps on how to use the command line version of this tool, see Testing and examining ODBC connectivity, page 417 in Chapter 11, Configuring MicroStrategy Using Command Line Tools. On UNIX or Linux using the DB Query Tool interface, perform the following steps: In a UNIX/Linux console window, browse to HOME_PATH, where HOME_PATH is the directory that you specified as the home directory during installation. Browse to the folder bin and type ./mstrdbquerytool, then press ENTER. On UNIX or Linux from the command line, perform the following steps: In a UNIX/Linux console window, browse to HOME_PATH, where HOME_PATH is the directory that you specified as the home directory during installation.
Browse to the folder bin and type ./mstrtodbcx, then press ENTER. Prompts guide you through testing your ODBC connection from the command line and should be used in place of the steps below. For detailed steps on how to use the command line version of this tool, see Testing and examining ODBC connectivity, page 417 in Chapter 11, Configuring MicroStrategy Using Command Line Tools. 2 From the Session menu, select Open Connection, or click the Connect icon on the toolbar. The Connect dialog box opens. The connection interface varies depending on the destination database. 3 Select the DSN for a data source. 4 Enter the appropriate user name and password. 5 Click Connect. After your connection is opened, the connection string is displayed in the MicroStrategy DB Query Tool at the bottom. Your cursor is inserted automatically in the SQL Statement window. 6 In the SQL Statement window, type a SQL query such as: select count (*) from Table where Table is a system-defined table, such as SYSOBJECTS for Microsoft SQL Server or a MicroStrategy-created table such as DSSMDSYSPROP in the MicroStrategy metadata. 7 From the Queries menu, select Execute Query. A table of data from the database is displayed in the Query Result window. 8 From the Session menu, select Close Connection to close the database connection. 9 From the File menu, select Exit to close the MicroStrategy DB Query Tool. The DB Query Tool includes many useful features not discussed here. Refer to the DB Query Tool Online Help for details.
171
required. With this tool, you can configure the metadata repository, statistics tables, History List tables, MicroStrategy Intelligence Server, and multiple project sources. If you are configuring MicroStrategy using the Windows operating system, you must have administrative privileges on the computer on which the Intelligence Server is installed, so that you can define the parameters necessary to start the Intelligence Server and to invoke server-definition objects. You can also configure your MicroStrategy installation using the Configuration Wizard in silent or unattended mode. This allows you to load an existing setup routine to configure your MicroStrategy installation. For information on running the Configuration Wizard with a response file, see Configuring MicroStrategy with a response file, page 201. can also use the Configuration Wizard to configure MicroStrategy You Health Center, which can help you prevent, diagnose, and fix problems in your MicroStrategy system. Health Center detects known problems and provides an immediate solution to many of them. For steps on how to configure Health Center using the Configuration Wizard, see the System Administration Guide.
IP-address local-machine-name For example, 123.4.5.6 FakeISmachine. Modifying the hosts file may require an account with root privileges. MicroStrategy products must be configured on the machine on which they are installed. You cannot configure them remotely.
173
repository, Intelligence Server, and the project source interact with each other.
MicroStrategy Web (four-tier) setup involves configuring a web A server to communicate between Intelligence Server and MicroStrategy Web or Web Universal. For more information on deploying MicroStrategy Web or Web Universal, see Chapter 6, Deploying MicroStrategy Web and Mobile Server. The figure below describes how to configure MicroStrategy to suit a direct (two-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.
is not recommended to use a direct setup for the production It environment. The procedure below provides the high-level steps to configure MicroStrategy software through the Configuration Wizard.
To configure MicroStrategy through the Configuration Wizard
1 If you are configuring MicroStrategy on: Windows, then perform the following step: From the Start menu, point to Programs, then MicroStrategy Tools, and then choose Configuration Wizard. The Configuration Wizard opens. Continue to the steps provided in To select a configuration task, page 176. Windows from the command line, then perform the following steps: From the Windows Start menu, select Run. The Run dialog box opens. In the Open drop-down list, type cmd and click OK. A command prompt opens. Type macfgwiz and press ENTER. This command displays the command line version of the Configuration Wizard. You can configure the connection of a data source to Intelligence Server by creating a response file or using an existing response file. The command line prompts guide you
175
through configuring the connection of a data source to Intelligence Server by creating a response file or using an existing response file and should be used in place of the steps below. For information on using a response file to configure MicroStrategy, see Configuring MicroStrategy with a response file, page 201. UNIX or Linux using the Configuration Wizard interface, then perform the following steps: From a UNIX/Linux console window, browse to HOME_PATH, where HOME_PATH is the directory that you specified as the home directory during installation. Browse to the folder bin and type ./mstrcfgwiz, then press ENTER. The Configuration Wizard opens. Continue to the steps provided in To select a configuration task, page 176. UNIX or Linux from the command line, then perform the following steps: From a UNIX/Linux console window, browse to HOME_PATH, where HOME_PATH is the directory that you specified as the home directory during installation. Browse to the folder bin and type ./mstrcfgwiz-editor, then press ENTER. This command displays the command line version of the Configuration Wizard. You can configure the connection of a data source to Intelligence Server by creating a response file or using an existing response file. The command line prompts guide you through configuring the connection of a data source to Intelligence Server by creating a response file or using an existing response file and should be used in place of the steps below. For information on using a response file to configure MicroStrategy, see Configuring MicroStrategy in command line mode, page 399.
To select a configuration task
2 Choose from the following configuration tasks and then click Next to begin the selected task. Create Metadata, History List and Statistics Repository Tables: Runs the SQL scripts necessary to create and initialize the metadata repository, History List tables, and statistics tables in the database location that you select. For steps to complete these configuration tasks, see Metadata, History List, and statistics repository tables, page 177.
Configure Intelligence Server: Creates a new server definition object in the metadata repository that you select. This setup provides Intelligence Server (three-tier) access to all projects that are stored in the repository. This option also allows you to use or delete an existing server definition. For steps to complete these configuration tasks, see MicroStrategy Intelligence Server, page 178. Create Project Sources: A project source contains the configuration information that each client system requires to access an existing project. It stores the location of the metadata repository and Intelligence Server that is used to run the project. A project source determines how MicroStrategy Developer, Web, and other client applications access the metadata. For steps to complete these configuration tasks, see Project sources, page 178. Upgrade existing environment to MicroStrategy Analytics Enterprise: You can use the Configuration Wizard to upgrade your MicroStrategy environment and migrate various features to the new version. For all available upgrade and migration options, see the MicroStrategy Upgrade Guide. Health Center Configuration: You can use the Configuration Wizard to configure MicroStrategy Health Center, which can help you prevent, diagnose, and fix problems in your MicroStrategy system. Health Center detects known problems and provides an immediate solution to many of them. For steps on how to configure Health Center using the Configuration Wizard, see the System Administration Guide.
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, see the MicroStrategy Project Design Guide.
177
objects such as reports and documents. It is mandatory to have a metadata repository to which Intelligence Server can connect. History List tables are used to store users report and document results for future use. History Lists can be stored on file systems of a server machine. The History List tables provide an alternative option to store History List information in a centralized database. For information on managing History Lists, see the System Administration Guide. 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 then use MicroStrategy Enterprise Manager to analyze the data and locate opportunities for system performance tuning. For information on the statistics tables and Enterprise Manager, refer to the System Administration Guide. For steps to create metadata, History List, and statistics repositories, see Creating metadata, History List, and statistics repositories, page 179.
Project sources
Project sources are the highest level objects in the MicroStrategy environment, which 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
178 Initial MicroStrategy configuration
2013 MicroStrategy, Inc.
that is used to run the project. Through a project source you can create, manipulate, and administer MicroStrategy projects. For steps to create project sources, see Creating project sources, page 196.
As you complete the configuration process, messages may be displayed. For details on system messages displayed during the configuration process, see Configuration messages, page 190.
Required database permissions to create metadata, History List, and statistics repositories
To create metadata, History List, and statistics repositories in a database, you need a database user account to associate with the tables created for the repositories. MicroStrategy recommends that the database user account used to create these repositories is granted full permissions for the database. If the database user account cannot be granted full permissions to the database, be aware that this account requires Select, Insert, Update, Create,
179
Drop, and Delete permissions. These permissions are required for various database objects depending on the database type you are using. For example, the following database object permissions are required where applicable for your database type:
Database Object Tables Indexes Triggers Functions Packages Procedures Type of Permissions Required Select, Insert, Update, Create, Drop, Delete Create, Drop Create, Drop Create, Execute Create Create, Execute
creating metadata, History List, and statistics repositories, the While Configuration Wizard provides an option to preview the SQL statements that will be executed. You can review this SQL preview to have a better understanding of the tasks that will be required as part of creating metadata, History List, and statistics repositories. Refer to your third-party database documentation for specific names and details on database permissions and database objects.
combination. For a list of certified metadata repository environments, see the MicroStrategy Readme. A database user account to associate with the metadata tables. MicroStrategy recommends that the database user account used to create a metadata repository is granted full permissions for the database. If the database user account cannot be granted full permissions to the database, refer to Required database permissions to create metadata, History List, and statistics repositories, page 179 for additional details on the database permissions required for this configuration. While metadata creation errors are rare in general, you can review a list of potential errors in Metadata and other repository creation errors, page 528 to prepare for or avoid specific scenarios that can cause errors.
1 Open the MicroStrategy Configuration Wizard. To do this, see To configure MicroStrategy through the Configuration Wizard, page 175. 2 Select Metadata, History List and Statistics Repository Tables, and click Next. The Repository Configuration: Repository Types page opens. 3 Select the Metadata Tables check box and click Next. The Repository Configuration: Metadata tables page opens. You can also select to create a History List and a statistics repository immediately after creating a metadata repository. If you create a History List or statistics repository as part of the same configuration routine as creating a new metadata repository, and the configuration is being done on a Windows environment, database instances are automatically created for the History List and statistics repositories. 4 From the DSN drop-down list, select the DSN for your metadata repository. If a DSN for your metadata repository does not exist, you can click New to open the Connectivity Wizard and create a new DSN. The steps to create a new DSN with the Connectivity Wizard are described in Creating a DSN for a data source, page 165. it is possible to use the Microsoft Access database for the Although 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.
2013 MicroStrategy, Inc. Initial MicroStrategy configuration
181
5 Type a User Name and Password that can connect to the data source. The database user that you provide becomes the owner of all metadata tables and objects. The database user is required to have the Select, Insert, and Update permissions. Intermediate tables are created in the metadata for recursive search queries, which requires Create and Drop permissions as well. Updating the schema requires the Delete permission. 6 After providing a valid user name and password, you can click SQL Preview to open the SQL Preview dialog box. This dialog box provides the SQL statements that will be executed on your data source to create the metadata tables. Click Close once you are done reviewing the SQL statements to return to the Configuration Wizard. If you use the advanced options to change the SQL script, you can click SQL Preview after selecting the new script to see an updated listing of the SQL statements that will be executed.
To specify a metadata table prefix and complete metadata repository creation
7 Click Advanced. Options to specify a table prefix and a SQL script to create metadata tables are displayed. 8 In the Table Prefix field, you can specify a prefix to be used when metadata tables are created in the database you select. This is an optional configuration. However, you must use different prefixes for your metadata tables and your History List tables if you store them in the same database. Most databases use a prefix of two characters. However, you can supply as many letters, numbers, underscores (_), and periods (.) as required to support your database prefixes. To determine character limits for a prefix, refer to your third-party database vendor documentation. 9 In the Script field, a SQL script to create metadata tables optimized for your database is selected. If you want to select a different script, click ... to browse to and select a customized script. For more information on the default SQL scripts, see SQL scripts, page 189. 10 Click Next. The next configuration page that opens depends on your configuration scenario: If your metadata repository does not need to be upgraded and you did not select to create History List or statistics tables, the Summary page
opens. You can complete your configuration as described in To review and save your metadata configuration below. If your metadata repository does not need to be upgraded and you selected to configure History List or statistics tables, you are prompted to configure these options as described in Creating a History List repository, page 183 and Creating a statistics repository, page 186. If your metadata repository needs to be upgraded, cancel this metadata creation process. If you continue with this process of creating metadata tables, your current metadata will be overwritten with a brand new metadata. For information on upgrading your metadata and suite of MicroStrategy projects, refer to the Upgrade Guide.
11 Review the summary information. You can click Save to save the configuration as a response (.ini) file to configure metadata repositories on other systems or to run silent configurations at a later time. For information on running the Configuration Wizard with a response file, see Configuring MicroStrategy with a response file, page 201. 12 Click Finish to apply the configuration and create the metadata repository. The summary information is updated as the configurations are completed, providing a way to track the progress of the configurations.
183
separately, you create it for an existing metadata repository, or you create it on a UNIX or Linux environment, you must create a database instance for the History List repository. For information on creating a database instance, see Creating a database instance, page 215. you are upgrading your History List repository from a previous If version of MicroStrategy rather than creating a brand new History List repository, see the Upgrade Guide. Prerequisites Before you create a History List repository, you should ensure that you are storing it on a certified database, ODBC driver, and operating system combination. For a list of certified History List repository environments, see the MicroStrategy Readme. A database user account to associate with the History List tables. MicroStrategy recommends that the database user account used to create History List Tables is granted full permissions for the database. If the database user account cannot be granted full permissions to the database, refer to Required database permissions to create metadata, History List, and statistics repositories, page 179 for additional details on the database permissions required for this configuration. The steps below are specific to creating a History List repository. If you also select to create a metadata repository, you must first complete the steps described in Creating a metadata repository, page 180. While History List creation errors are rare in general, you can review a list of potential errors in Metadata and other repository creation errors, page 528 to prepare for or avoid specific scenarios that may cause errors.
1 Open the MicroStrategy Configuration Wizard. To do this, see To configure MicroStrategy through the Configuration Wizard, page 175. 2 Select Metadata, History List and Statistics Repository Tables and click Next. The Repository Configuration: Repository Types page opens. 3 Select the History List Tables check box and click Next. The Repository Configuration: History List tables page opens.
4 From the DSN drop-down list, select the DSN for your History List repository. If a DSN for your History List repository does not exist, you can select New to open the Connectivity Wizard and create a new DSN. The steps to create a new DSN with the Connectivity Wizard are described in Creating a DSN for a data source, page 165. 5 Type a User Name and Password that can connect to the data source. The database user you provide becomes the owner of all History List tables and objects. The database user is required to have the Select, Create, Insert, and Drop permissions. 6 After providing a valid user name and password, you can click SQL Preview to open the SQL Preview dialog box. This dialog box provides the SQL statements that will be executed on your data source to create the History List tables. Click Close once you are done reviewing the SQL statements to return to the Configuration Wizard. If you use the advanced options to change the SQL script, you can click SQL Preview after selecting the new script to see an updated listing of the SQL statements that will be executed.
To specify a History List table prefix and complete History List repository creation
7 Click Advanced. Options to specify a table prefix and a SQL script to create History List tables are displayed. 8 In the Table Prefix field, you can specify a prefix to be used when History List tables are created in the database you select. This is an optional configuration. However, you must use different prefixes for your metadata tables and your History List tables if you store them in the same database. Most databases use a prefix of two characters. However, you can supply as many letters, numbers, underscores (_), and periods (.) as required to support your database prefixes. To determine character limits for a prefix, refer to your third-party database vendor documentation. If you use a table prefix for your History List tables, you must also define this table prefix when you create a database instance to connect to the History List tables. For information on creating a database instance, see Creating a database instance, page 215. 9 In the Script field, a SQL script to create History List tables optimized for your database is selected. If you want to specify a different script, click ...
2013 MicroStrategy, Inc. Initial MicroStrategy configuration
185
to browse to and select a customized script. For more information on the default SQL scripts, see SQL scripts, page 189. 10 Click Next. The next configuration page that opens depends on your configuration scenario: If you did not select to create statistics tables, the Summary page opens. You can complete your configuration as described in To review and save your History List configuration below. If you selected to configure statistics tables, you are prompted to configure these options as described in Creating a statistics repository, page 186.
11 Review the summary information. You can click Save to save the configuration as a response (.ini) file to configure History List repositories on other systems or to run silent configurations at a later time. For information on running the Configuration Wizard with a response file, see Configuring MicroStrategy with a response file, page 201. 12 Click Finish to apply the configuration and create the History List repository. The summary information is updated as the configurations are completed, providing a way to track the progress of the configurations. Once you are finished configuring Intelligence Server and your project sources, a database instance to connect a project to a History List repository must be created. If you created the History List repository as part of the same configuration routine to create a metadata repository and the configuration is being done on a Windows environment, a database instance is automatically created for the History List repository. For information on creating a database instance, see Creating a database instance, page 215.
types associated with each field for MicroStrategy Intelligence Server, refer to the Enterprise Manager Data Model and Object Definitions chapter in the Supplemental Reference for System Administration Guide. For details on how to configure projects to log statistics, refer to the Monitoring System Usage chapter in the System Administration Guide. If you create a statistics repository as part of the same configuration routine to create a metadata repository, and the configuration is being done on a Windows environment, a database instance is automatically created for the statistics repository. If you create the statistics repository separately, you create it for an existing metadata repository, or you create it on a UNIX or Linux environment, you must create a database instance for the statistics repository. For information on creating a database instance, see Creating a database instance, page 215. you are upgrading your statistics repository from a previous version If of MicroStrategy rather than creating a brand new statistics repository, see the Upgrade Guide. Prerequisites Before you create a statistics repository, you should ensure that you are storing it on a certified database, ODBC driver, and operating system combination. For a list of certified statistics repository environments, see the MicroStrategy Readme. A database user account to associate with the statistics tables. MicroStrategy recommends that the database user account used to create statistics tables is granted full permissions for the database. If the database user account cannot be granted full permissions to the database, refer to Required database permissions to create metadata, History List, and statistics repositories, page 179 for additional details on the database permissions required for this configuration. The steps below are specific to creating a statistics repository. If you also select to create a metadata repository or History List repository, you must first complete the steps described in Creating a metadata repository, page 180 or Creating a History List repository, page 183, respectively. While statistics creation errors are rare in general, you can review a list of potential errors in Metadata and other repository creation errors, page 528 to prepare for or avoid specific scenarios that may cause errors.
187
1 Open the MicroStrategy Configuration Wizard. To do this, see To configure MicroStrategy through the Configuration Wizard, page 175. 2 Select Metadata, History List and Statistics Repository Tables and click Next. The Repository Configuration: Repository Types page opens. 3 Select the Statistics Tables check box and click Next. The Repository Configuration: Statistics Tables page opens. 4 From the DSN drop-down list, select the DSN for your statistics repository. If a DSN for your statistics repository does not exist, you can select New to open the Connectivity Wizard and create a new DSN. The steps to create a new DSN with the Connectivity Wizard are described in the section Creating a DSN for a data source, page 165. 5 Type a User Name and Password that can connect to the data source. The database user you provide becomes the owner of all statistics tables and objects. The database user is required to have the Select, Create, Insert, and Drop permissions. 6 After providing a valid user name and password, you can click SQL Preview to open the SQL Preview dialog box. This dialog box provides the SQL statements that will be executed on your data source to create the statistics tables. Click Close once you are done reviewing the SQL statements to return to the Configuration Wizard. If you use the advanced options to change the SQL script, you can click SQL Preview after selecting the new script to see an updated listing of the SQL statements that will be executed.
To specify a statistics table prefix and complete statistics repository creation
7 Click Advanced. Options to specify a table prefix and a SQL script to create statistics tables are displayed. 8 In the Table Prefix field, you can specify a prefix to be used when statistics tables are created in the database you select. This is an optional configuration.
Most databases use a prefix of two characters. However, you can supply as many letters, numbers, underscores (_), and periods (.) as required to support your database prefixes. To determine character limits for a prefix, refer to your third-party database vendor documentation. If you use a table prefix for your statistics tables, you must also define this table prefix when you create a database instance to connect to the statistics tables. For information on creating a database instance, see Creating a database instance, page 215. 9 In the Script field, a SQL script to create statistics tables optimized for your database is selected. If you want to specify a different script, click ... to browse to and select a customized script. For more information on the default SQL scripts, see SQL scripts, page 189. 10 Click Next. The Summary page opens. 11 Review the summary information. You can click Save to save the configuration as a response (.ini) file to configure statistics repositories on other systems or to run silent configurations at a later time. For information on running the Configuration Wizard with a response file, see Configuring MicroStrategy with a response file, page 201. 12 Click Finish to apply the configuration and create the statistics repository. The summary information is updated as the configurations are completed, providing a way to track the progress of the configurations. Once you are finished configuring Intelligence Server and your project sources, a database instance to connect a project to a statistics repository must be created. If you created the statistics repository as part of the same configuration routine to create a metadata repository and the configuration is being done on a Windows environment, a database instance is automatically created for the statistics repository. For information on creating a database instance, see Creating a database instance, page 215.
SQL scripts
MicroStrategy has database-specific SQL scripts for creating metadata, History List, 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.
189
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.
Configuration messages
Depending on the selected ODBC database, different messages might be displayed prompting you to complete the configuration successfully. Two examples are described below: Metadata tables already exist at this location. Would you like to recreate them? (This will drop all existing information in the Metadata) This message is displayed if the Configuration Wizard detects an existing metadata repository in the database location you specified. you continue, all information in the existing metadata repository If is overwritten. No Metadata Tables were found at this location, do you wish to create them now? This message is displayed if there is no existing metadata repository and you have not chosen to create one.
Use: When you use an existing server definition different from the current server definition, 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 Intelligence Server software that you installed.
If you create a new server definition or use 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 Server Configuration: Metadata Connection page in the Configuration Wizard to update your password. A procedure to use the Configuration Wizard to define server definitions is provided in To set up MicroStrategy Intelligence Server below. You can choose to configure the server definition, project source names, and the metadata and statistics repositories using a response file with the Configuration Wizard. This lets you provide users with a configuration file to complete the configuration tasks rather than requiring users to step through the Configuration Wizard. Creating and using a response file can be done using the Configuration Wizard interface or a command line tool available for UNIX and Linux. The steps to perform these two configuration options are provided in the sections listed below: Configuring MicroStrategy with a response file, page 201 Configuring MicroStrategy with a response.ini file, page 418 in Chapter 11, Configuring MicroStrategy Using Command Line Tools
1 Open the MicroStrategy Configuration Wizard. To do this, see To configure MicroStrategy through the Configuration Wizard, page 175. 2 Select MicroStrategy Intelligence Server, and click Next. The Server Configuration: Metadata Connection page opens.
191
3 From the DSN drop-down list, select a DSN for the data source that stores the metadata and specify a User Name and Password. You can also use the options listed below: New to create a new DSN (see Creating a DSN for a data source, page 165) Advanced if you want to specify a metadata table prefix, which is an identifier stored in the project metadata associated with a table or tables and is used to generate SQL
it is possible to use the Microsoft Access database for the Although 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. 4 Click Next. If a message is displayed that your metadata is not up to date with the most recent version of MicroStrategy, you must upgrade your metadata to take advantage of the new features available in the most recent version of MicroStrategy. You can upgrade your MicroStrategy metadata as described in the MicroStrategy Upgrade Guide. 5 In the Server Configuration: MicroStrategy Authentication page, specify the MicroStrategy administrators User Name and Password. By default, the user name is Administrator and it has no password. If you are setting up Intelligence Server for the first time, use the default user name and password. security reasons, you should change the Administrator user For name and password as soon as possible after you initially configure the system. Refer to the System Administration Guide for details about passwords and other user management information. 6 Click Next. The Server Configuration: Server Definitions page opens.
To create, use, or delete a server definition
7 You can create a new server definition, use an existing server definition, or delete a current server definition. You can perform one of the following tasks: To create a server definition, select Create New Server Definition. In the Name field, type a name to identify the server definition. Select the Use as the active server definition check box to define
Intelligence Server to use the new server definition when Intelligence Server starts. Click Next. The Server Configuration: Settings page opens, described in To define the Intelligence Server port number and other settings below. To use an existing server definition, select Use the selected Server Definition as active. From the Existing Server Definitions pane, select a server definition to use. Click Next. The Server Configuration: Settings page opens, described in To define the Intelligence Server port number and other settings below. To delete an existing server definition, select Delete Selected Server Definition. From the Existing Server Definitions pane, select a server definition to delete. Click Next. The Summary page opens, described in To complete Intelligence Server configurations below.
8 If you select to create a server definition or use an existing server definition, you can define the Intelligence Server port number and other settings, as described below: Port number: You can use the default port number or specify another port number. The port number is how a server process identifies itself on the machine on which it is running. If the port number is used by another process, such as in a shared environment, specify an available port number. For instructions on how to find an available port number, see Port number is in use, page 527. Register Intelligence Server as a Service: This option is only available if you are configuring Intelligence Server on a UNIX or Linux machine, and you have root access and permissions to the UNIX or Linux machine that Intelligence Server is installed on. Select this check box to register Intelligence Server as a service. In Windows, Intelligence Server is automatically registered as a service upon completion of the configuration process. the Configuration Wizard again and clearing this check Running box does not unregister Intelligence Server as a service. To unregister Intelligence Server on UNIX or Linux, you must stop the service, and then use the mstrctl command line tool. The syntax is mstrctl -s IntelligenceServer us, where IntelligenceServer is the name of a server definition. For
193
information on starting, stopping, and registering Intelligence Server as a service, see the System Administration Guide. Projects to load at startup: This pane displays all the projects that are in the metadata repository. You can select projects to use with the server definition that you have chosen. The projects that you select are loaded on the server at startup. Start Intelligence Server when finished: Select this check box to have Intelligence Server start once you complete this configuration. If you use Windows NT authentication with SQL Server, you must type the Windows NT account user name and password in the Service Manager to successfully start Intelligence Server. For information on the Service Manager, see the System Administration Guide. Identify missing DSNs: Select this check box to verify that all DSNs, which are used for database instances created in MicroStrategy, are locally available. This helps to ensure that your database instances in MicroStrategy can connect successfully to their associated data sources. By default, this check box is cleared, which means the availability of all local DSNs used in database instances is not verified. While this may mean that all DSNs used in database instances are not available, it can save system resources required for the Intelligence Server configuration process. 9 Click Next. The SSL Configuration Page opens.
To encrypt the communications between Developer and Intelligence Server
10 You can enable or disable secure socket layer (SSL) protocol to encrypt the communication between Intelligence Server and Developer: Configure SSL: This option specifies whether to enable Intelligence Server and Developer to communicate using the SSL protocol. Clear this check box to disable the use of the SSL protocol for Intelligence Server and Developer communications. Select this check box to enable the use of the SSL protocol for Intelligence Server and Developer communications. Be aware that you must ensure the following prerequisites are met to enable the SSL protocol:
You must have access to the SSL certificate you created for Intelligence Server.
You must have the private key file that you created while requesting a certificate for Intelligence Server. For information on creating a private key and obtaining an SSL certificate, refer to the System Administration Guide.
When you select to enable the SSL protocol, you must provide the following information:
Certificate: The SSL certificate file you created for Intelligence Server. Click ... (the browse button) to navigate to and select the certificate file. Key: The private key file you created while requesting the certificate for Intelligence Server. Click ... (the browse button) to navigate to and select the private key file. Password: The password that you used while creating the private key for the SSL certificate. SSL Port: The port number to use for SSL access. By default, the port is 39321.
To enable SSL protocol communication in Developer, you must use the Project Source Editor. For steps to complete the other tasks required to enable SSL protocol communications, refer to the System Administration Guide. 11 Click Next. The Summary page opens.
To complete Intelligence Server configurations
12 Review the summary information. You can click Save to save the configuration as a response (.ini) file to configure Intelligence Server on other systems or to run silent configurations at a later time. For information on running the Configuration Wizard with a response file, see Configuring MicroStrategy with a response file, page 201. 13 Click Finish to apply the Intelligence Server configuration. The summary information is updated as the configurations are completed, providing a way to track the progress of the configurations. If you created a new server definition, it is displayed in the list of existing server definitions for that metadata.
195
If you assigned an existing server definition to Intelligence Server and the existing project source uses this Intelligence Server, a related message is displayed.
Prerequisites For Windows, the Project Source option is available only if the Developer product is installed on the machine.
You can choose to create project sources using a response file with the Configuration Wizard. This lets you provide users with a configuration file to complete the configuration tasks rather than requiring users to step through the Configuration Wizard. Creating and using a response file can be done using the Configuration Wizard interface or a command line tool available for UNIX and Linux. The steps to perform these two configuration options are provided in the sections listed below: Configuring MicroStrategy with a response file, page 201 Configuring MicroStrategy with a response.ini file, page 418 in Chapter 11, Configuring MicroStrategy Using Command Line Tools
Direct (two-tier)
A direct project source is used to connect directly to the metadata repository using ODBC. A direct project source connection does not allow you to access MicroStrategy Web, run Report Services documents, or use any of the other MicroStrategy features that are provided through Intelligence Server. You cannot create a direct project source on UNIX or Linux.
To create to a direct project source
1 Open the MicroStrategy Configuration Wizard. To do this, see To configure MicroStrategy through the Configuration Wizard, page 175. 2 Select Project Sources, and click Next. The Project Source Creation: Name page opens. 3 In the Project Source Name field, type a name for the project source. 4 Under Connection Type, select Direct (2-tier), and click Next. The Project Source Creation: Metadata Location page opens. 5 From the DSN drop-down list, select a DSN for the data source that stores the metadata and specify a User Name and Password. You can also click New to create a new DSN (see Creating a DSN for a data source, page 165) and click Advanced to specify a metadata table prefix if necessary. 6 Click Next. The Project Source Creation: Authentication page opens. 7 Select the authentication mode for the project source. For information on the available authentication modes, see the Authentication modes, page 199. 8 Click Next. The Summary page opens. 9 Review the summary information. You can click Save to save the configuration as a response (.ini) file to configure a direct project source on other systems or to run silent configurations at a later time. For information on running the Configuration Wizard with a response file, see Configuring MicroStrategy with a response file, page 201.
197
10 Click Finish to create the project source. The summary information is updated as the configurations are completed, providing a way to track the progress of the configurations.
1 Open the MicroStrategy Configuration Wizard. To do this, see To configure MicroStrategy through the Configuration Wizard, page 175. 2 Select Project Sources and click Next. The Project Source Creation: Name page opens. 3 In the Project Source Name field, type a name for the project source. 4 Under Connection Type, select MicroStrategy Intelligence Server (3-tier), and click Next. The Project Source Creation: Metadata Location page opens. 5 In the MicroStrategy Intelligence Server Machine Name drop-down list, select the Intelligence Server to connect to. 6 In the Port Number used by MicroStrategy Intelligence Server field, type the port number for the Intelligence Server to connect to. The port number is how the Intelligence Server process identifies itself on the server on which it is running. The default port number for Intelligence Server is 34952. If you use a non-default port number, this number must be provided while connecting through MicroStrategy Developer. 7 Select the Connection times out after (mins) check box to define and enforce a connection time out for inactive users connected to a project
source. In the field below, type a numerical value (in minutes) for the amount of inactivity that is allowed before a user is automatically disconnected from a project source. If this check box is cleared, users are not disconnected from project sources due to inactivity. 8 Click Next. The Project Source Creation: Authentication page opens. 9 Select the authentication mode for the project source. For information on the available authentication modes, see the Authentication modes, page 199. 10 Click Next. The Summary page opens. 11 Review the summary information. You can click Save to save the configuration as a response (.ini) file to configure a server project source on other systems or to run silent configurations at a later time. For information on running the Configuration Wizard with a response file, see Configuring MicroStrategy with a response file, page 201. 12 Click Finish to create the project source. The summary information is updated as the configurations are completed, providing a way to track the progress of the configurations.
Authentication modes
Authentication is the process through which the system identifies the user. Several authentication modes are supported for MicroStrategy project sources. They vary primarily by the system that verifies and accepts the login/password credentials provided by the user. Some authentication modes require a server project source (three-tier). Therefore, if you are creating a direct project source (two-tier) some of the authentication options listed below cannot be used: Network login ID: Windows authentication, page 200 Login ID and password entered by the user: Standard authentication, page 200 Guest account: Anonymous authentication, page 200 LDAP authentication, page 201
199
Login ID and password entered by the user for the warehouse: Database authentication, page 201 Integrated authentication, page 201
For information on the benefits of the various authentication modes and other authentication topics, see the System Administration Guide.
LDAP authentication
Lightweight Directory Access Protocol (LDAP) authentication identifies users within a repository of users stored in an LDAP server (such as Novell Directory Services). If you use an LDAP directory to centrally manage users in your environment, you may want to use LDAP authentication. Group membership can be maintained in the LDAP directory without having to also be defined in the MicroStrategy Intelligence Server. When using LDAP authentication, LDAP users or groups are linked to users or groups in the MicroStrategy environment.
Login ID and password entered by the user for the warehouse: Database authentication
This mode of database authentication identifies users using a login ID and password stored in the data warehouse database. Under this mode of authentication, a warehouse database is associated with each project. When users log in to a project source, they are logging in to the Intelligence Server. Use database authentication if you want the data warehouse RDBMS to be the authority for identifying users and you do not want to maintain user credentials in the Intelligence Server as well as the RDBMS.
Integrated authentication
Integrated authentication enables a Windows user to log in once to their Windows machine. The user does not need to log in again separately to MicroStrategy Developer or MicroStrategy Web. This type of authentication uses Kerberos to validate a users credentials.
be accomplished by using a response file. For steps to upgrade MicroStrategy using a response file, see the Upgrade Guide. For steps to configure Health Center with a response file, see the System Administration Guide.
1 Open the MicroStrategy Configuration Wizard. To do this, see To configure MicroStrategy through the Configuration Wizard, page 175. 2 Any configuration tasks you complete with the Configuration Wizard can be saved to a response file. For steps to complete various configurations tasks with the Configuration Wizard, see the sections listed below: Creating metadata, History List, and statistics repositories, page 179 Setting up MicroStrategy Intelligence Server, page 190 Creating project sources, page 196
3 Once you reach the Summary page for a configuration, click Save. The Save dialog box opens. 4 Specify a name and location to save the response file, and click Save. You are returned to the Summary page. 5 To also perform the configuration task, click Finish. The summary information is updated as the configurations are completed, providing a way to track the progress of the configurations.
Steps to use a response file to configure MicroStrategy are covered in Using a response file to configure MicroStrategy installations below. You can modify a response file with a text editor to make configuration changes such as entering different user login and password information. For information on the parameters and options available in response files, see Response configuration parameters and options, page 204.
1 Open the MicroStrategy Configuration Wizard. To do this, see To configure MicroStrategy through the Configuration Wizard, page 175.
203
2 Click Load. The Open dialog box displays. 3 Browse to the path where the response file is saved and click Open. The Summary page opens. 4 An overview of all of the configuration tasks performed by the response file is displayed. Review the configuration tasks and click Finish to perform the configuration. The summary information is updated as the configurations are completed, providing a way to track the progress of the configurations.
To use a response file through the Windows command line
The steps below are specific to configuring MicroStrategy installed on Windows. For steps to create and use a response file as well as perform other configurations using command line tools in UNIX and Linux, see Chapter 11, Configuring MicroStrategy Using Command Line Tools. 1 Type the following command in the Windows command line: macfgwiz.exe -r Path\response.ini Where Path\ is the fully qualified path to the response file. For example, the common location of a response file is: C:\Program Files\Common Files\MicroStrategy\ RESPONSE.INI 2 If an error message is displayed, check the path and name you supplied for the response file and make any required changes. Repeat the previous step to execute the configuration.
The response file for configuring MicroStrategy is divided into three areas of configuration, which are described in the sections below: Creating metadata, History List, and statistics repositories, page 205 Setting up MicroStrategy Intelligence Server, page 207 Creating and configuring project sources, page 209
Repository=
CreateMDTables=
CreateHistListTab les=
CreateStatTables=
MetadataPath=
205
Options HistoryListPath=
Description Locates the SQL scripts for creating the History List repository. Example paths to SQL scripts in different environments are listed below: 32-bit Windows environment: C:\Program Files\Common Files\ MicroStrategy\content_server_db_Oracle.sql. 64-bit Windows environment: C:\Program Files (x86)\ Common Files\MicroStrategy\content_server_db_Oracle.sql. UNIX/Linux: /INTELLIGENCE_SERVER_INSTALL_PATH/ content_server_db_Oracle.sql. Locates the SQL scripts for creating the statistics repository. Example paths to SQL scripts in different environments are listed below: 32-bit Windows environment: C:\Program Files\Common Files\ MicroStrategy\statistics_SQLServer.SQL 64-bit Windows environment: C:\Program Files (x86)\ Common Files\MicroStrategy\statistics_SQLServer.SQL UNIX/Linux: /INTELLIGENCE_SERVER_INSTALL_PATH/ statistics_DB2.sql. Defines the Data Source Name for configuring a metadata repository in the ODBC database. Defines the user name to log in to the database containing the metadata repository. Defines the password to log in to the database containing the metadata repository. Defines the Data Source Name for configuring the History List repository in the ODBC database. Defines the user name to log in to the database for configuring the History List repository. Defines the password to log in to the database for configuring the History List repository. Defines the Data Source Name for configuring the statistics repository in the ODBC database. Defines the user name to log in to the database for configuring the statistics repository. Defines the password to log in to the database for configuring the statistics repository. Defines whether the password is encrypted in the response file, as determined by the following values: 0: The password is not encrypted in the response file, which enables you to modify the password in the response file later using a text editor. You can then distribute the response file to multiple users with various login and password credentials. However, be aware that this can compromise your database security if you do not remove the password from the response file before distributing it. 1: Encrypts the password in the response file, which ensures that your password is secure. This is the default behavior.
StatisticsPath=
DSNName= UserName= UserPwd= DSNNameHist= UserNameHist= UserPwdHist= DSNNameStats= UserNameStats= UserPwdStats= EncryptPassword=
Description Defines the database name to create tables in DB2 z/OS. This option should only be used when connecting to a DB2 z/OS database. Defines the tablespace name to be created in the database.This option should only be used when connecting to a DB2 z/OS database.
Server=
Action=
InstanceName=
ProjectsToUnRegister=
207
Options EncryptPassword=
Description Defines whether the password is encrypted in the response file, as determined by the following values: 0: The password is not encrypted in the response file, which enables you to modify the password in the response file later using a text editor. You can then distribute the response file to multiple users with various login and password credentials. However, be aware that this can compromise your database security if you do not remove the password from the response file before distributing it. 1: Encrypts the password in the response file, which ensures that your password is secure. This is the default behavior. Defines the MicroStrategy user name to log in to the project. Defines the password for the MicroStrategy user name to log in to the project. Defines a prefix for metadata repository tables used by the server definition. Defines whether the Intelligence Server definition is set as the default server definition to use for Intelligence Server, as determined by the following values: True: Defines the Intelligence Server definition as the default server definition False: Does not define the Intelligence Server definition as the default server definition Defines the port used by the Intelligence Server. This option is only available on Intelligence Servers running on UNIX or Linux operating systems. Defines whether Intelligence Server is registered as a service. Registering Intelligence Server as a service is determined by the following values: 1: Registers Intelligence Server as a service. Performing this task requires a UNIX or Linux login with root level access and privileges. 0: Does not register Intelligence Server as a service.
Port= RegisterAsService=
StartServerAfter Config=
Defines whether Intelligence Server is started after applying the configuration, as determined by the following values: 1: Intelligence Server is started after successfully applying the configuration. 0: Intelligence Server is not started after applying the configuration. Defines whether to enable Intelligence Server and Developer to communicate using the SSL protocol, as determined by the following values: 1: Enables the use of the SSL protocol for Intelligence Server and Developer communications. 0: Disables the use of the SSL protocol for Intelligence Server and Developer communications. Defines the port to use for SSL access. By default, the port is 39321.
ConfigureSSL=
SSLPort=
Description Locates the SSL certificate file you created for Intelligence Server. Type the full path to the SSL certificate file. Locates private key file you created while requesting the certificate for Intelligence Server. Type the full path to the private key file. Defines the password that you used while creating the private key for the SSL certificate.
Client=
EncryptPassword=
DataSource= ConnType=
DSN= UserName=
209
Description If using connection type 2 (ConnType=2), defines the password to log in to the database. If using connection type 3 (ConnType=3), defines the name of the MicroStrategy Intelligence Server to connect to. If using connection type 3 (ConnType=3), defines the port number for the Intelligence Server when creating a server (three-tier) project source. The default port number for MicroStrategy Intelligence Server is 34952. The following authentication modes are supported: 1: Standard or login ID and password entered by the user 2: Network login ID (Windows authentication) 8: Guest account (Anonymous authentication) 16: LDAP authentication 32: Database login ID and password (database authentication) 128: Integrated authentication For information on the available authentication modes, see the Authentication modes, page 199.
Authentication=
MDPrefix= Timeout=
If using connection type 2 (ConnType=2), defines a prefix for metadata repository tables. Defines and enforce a connection time out for inactive users connected to a project source. The following values are supported: 0: Defines that users are not disconnected from project sources due to inactivity. Numerical value greater than 0: A numerical value (in minutes) greater than 0 defines the amount of inactivity that is allowed before a user is automatically disconnected from a project source.
connection tasks from the Project Configuration Editor, which can be accessed by right-clicking a project and selecting Project Configuration. tasks described in this section require MicroStrategy The Administrator privileges.
211
These non-project database instances can allow a project to connect to the data sources for the various features and additional data sources mentioned above, instead of accessing the data from the projects relational schema. For more information on the Warehouse Catalog, see the MicroStrategy Project Design Guide. The database instances that you create are separated into two categories: SQL data warehouses database instances, page 212 MDX cube database instances, page 214
Selecting a database instance check box makes that database instance available in the project for standard MicroStrategy reporting, data marts,
Query Builder, and Freeform SQL. If you have a license for the MultiSource Option, selecting a check box for a database instance also makes the database instance available from the Warehouse Catalog to be part of the projects relational schema. instances can be created as part of the Import Data feature. Database A database instance used for the Import Data feature is displayed with the icon. These database instances are created with security permissions for the user that created them while using the Import Data feature. If you select one of these database instances to be included as an available database instance in the project, it is recommended that you change the security permissions to a MicroStrategy user with administrative privileges. This includes taking ownership of the database instance and defining an appropriate access control list. This ensures that no changes are made to the database instance by other users, which could cause a loss of connectivity to the data source. For information on the Import Data feature, refer to the MicroStrategy Web online help. The shading and color of a database instance in the list of relational database instances reflects how the database instance is being used in the project: Blue text: This is the warehouse database instance, as selected from the warehouse database instance drop-down list. There can only be one warehouse database instance for a project, because this database instances data is populated in the Warehouse Catalog to define the projects relational schema. You cannot choose to disable the warehouse database instance for the project without first selecting a different warehouse database instance. If you have a license for the MultiSource Option, the primary database instance acts as the main source of data for a project and is used as the default database instance for tables added to the project. For information on the Warehouse Catalog as well as accessing multiple data sources with the MultiSource Option, see the Project Design Guide. Bold text: The project contains objects that are dependent on the database instance. You cannot choose to disable a database instance that has dependent objects for the project. Normal text: The database instance is not being used in the project.
Clearing the check box of a database instance removes the database instance from the project and deletes any unused Freeform SQL or Query Builder schemas. You can clear a database instance from a project only if there are no dependent objects in the project for the database instance. For more information on removing a database instance and related Freeform SQL and
2013 MicroStrategy, Inc. Connecting to a data source
213
Query Builder schemas from a project, refer to the MicroStrategy System Administration Guide.
A database instance that has an MDX cube schema is represented with bold text. The shading and color of a database instance in the list of relational database instances reflects how the database instance is being used in the project: Bold: The project contains objects that are dependent on the database instance. You cannot choose to disable a database instance that has dependent objects for the project. Normal: The database instance is not being used in the project.
If you remove an MDX cube database instance from a project, you can delete any unused MDX cube schema objects. You can remove database instance from a project only if there are no dependent objects in the project for the
database instance. For more information on removing a database instance and related MDX cube managed objects from a project, refer to the System Administration Guide. For additional information on configuring MDX cube database instances, refer to the MDX Cube Reporting Guide.
215
source, then expanding Configuration Managers. When you choose to create a new database instance, the Database Instances Editor opens.
can also create a new database instance using the Database You Instance Wizard that is available in the Database Instance Manager shortcut menu. The Database Instances Editor has the following tabs: Generalspecifies the database instance name, connection type (data source platform or applicable data source), and default database connection. database connection type you choose should match your data The source and determines whether the database instance is a relational or an MDX cube database instance. Advancedspecifies the database name for intermediate table storage if a database other than the warehouse is used to store intermediate tables, as well as other options. Advanced tab is not available for MDX cube database The instances. Job Prioritizationspecifies the job prioritization scheme for the instance and the number of prioritized connections.
1 In MicroStrategy Developer, log in to a project source with administrative privileges. 2 Expand Administration, then expand Configuration Managers, and then select Database Instances. 3 From the File menu, point to New, and then select Database Instance. The Database Instances Editor opens. 4 On the General tab, in the Database instance name field, type the name of the database instance. 5 In the Database connection type drop-down list, select the data source connection type according to the data source hosting your database. you have upgraded from a previous version of MicroStrategy, If you can click Upgrade to retrieve any database connection types that have been included since the previous version of MicroStrategy that you used. 6 On the Advanced tab, you can configure various options for the database instance, including: Intermediate table storage: You can specify the database name and table name space to use when intermediate tables are created. Intermediate tables are created to support various queries. Database gateway support: You can support backwards compatibility for database gateway support from MicroStrategy version 6.x. To enable database gateway support, select the Primary database instance check box, and then select a primary database instance from the drop-down list. The primary database instance is the database instance that should be used for element browsing against the selected table and for queries that do not require joins to other tables. For information on database gateway support, see the Project Design Guide.
217
Data mart optimization: You can support data mart optimization if the data source for the database instance is in the same data source that contains data marts. To enable data mart optimization, select the This database instance is located in the same warehouse as check box, and then select a database instance from the drop-down list.
Table prefix: If the tables in your data source use a table prefix, you can include the table prefix to identify the proper collection of tables. Click Select to select a table prefix or define a new table prefix. ODBC Version: You can define which ODBC version to use for the database instance, as described below: Use 2.0 ODBC Calls: ODBC 2.0 was used in pre-9.0 versions of MicroStrategy. You can use this option for backward compatibility if your database management system does not support ODBC 3.x. Use 3.x ODBC Calls: The support of ODBC 3.x is introduced in MicroStrategy 9.0. You should use this option if your database management system supports ODBC 3.x.
7 On the Job Prioritization tab, you can configure how jobs are prioritized for the database instance. For information on configuring job prioritization, see the System Administration Guide. 8 On the General tab, in the Database connection (default) pane, select the default data source connection and click OK. If the necessary database connection does not exist, you can create one by clicking New. For steps to create a database connection, see Creating a database connection below.
the project source. For more information on creating a database connection for MDX cube sources, refer to the MDX Cube Reporting Guide. When you choose to create a new database connection, the Database Connections dialog box opens.
The Database Connections dialog box has different options depending on the database instance type. SQL data warehouse database instances
General: Specifies the database connection name, the warehouse DSN, and the default database login. Advanced: Specifies the database driver mode, driver execution mode, and other miscellaneous warehouse connection settings.
General: Specifies the database connection name, the default database login, and additional connection information that you must provide. For more information on creating a database connection for MDX cube sources, see the MDX Cube Reporting Guide.
219
Advanced: Specifies the connection settings, additional connection string parameters, and connection caching settings.
General: Specifies the database connection name, the default database login, and additional connection information that you must provide. For more information on defining connection information to Hadoop Hive distributions by using a database connection, see ODBC Driver for Red Brick for UNIX/Linux, page 471. Advanced: Specifies the database driver mode, driver execution mode, and other miscellaneous warehouse connection settings.
The steps below show you how to create a database connection for a relational database instance. For information on creating a database connection for MDX cube sources, refer to the MDX Cube Reporting Guide. Prerequisites A database instance has been created, as described in Creating a database instance, page 215.
1 On the General tab, in the Database connection name box, type a name to identify the database connection. 2 In the Local system ODBC data sources pane, select the data source name for the data source. 3 On the Advanced tab, you can define various options per your requirements and the requirements of the database you are connecting to, including: Database driver mode: Select one of the following database driver modes: Multi-process: Each connection to the warehouse database is spawned as a separate process, identified in Windows Task Manager as M8DBMPE.exe. If one process fails, such as when a database access thread hangs or is lost, other processes are not affected. Multi-threaded: All connections to the warehouse database are maintained inside the Intelligence Server process MSTRSVR.exe.
All connections, SQL submissions, and data retrievals from the database are handled within this process. MicroStrategy recommends setting all database drivers to multi-process mode. The robustness and stability which come with multi-process mode greatly overshadow any increased efficiency that may come with multi-threaded mode. Problems that appear random and sporadic in multi-threaded operation can often be resolved by switching to multi-process mode. Driver execution mode: Define the driver execution mode depending on the ODBC driver being used: Asynchronous Connection: All statements allocated within the connection should be able to run SQL asynchronously. Asynchronous Statement: For each statement, the asynchronous mode is explicitly set. Synchronous: Only one statement executes at a time. This is the default value. newer ODBC drivers do not support asynchronous mode Many because the driver is capable of opening a new thread and executing a new query while simultaneously running an earlier query. The MicroStrategy Readme gives recommendations for the driver execution mode options that can be used for different ODBC drivers. Use extended fetch: Select this check box to enable Intelligence Server to fetch blocks of data from the database into memory, instead of row-by-row.
MicroStrategy Readme recommends settings for ODBC The drivers and whether to use the extended fetch feature. Use parameterized queries: Select this check box to enable Intelligence Server to pass data to the database in blocks instead of row-by-row. For information on how parameterized queries can improve performance in MicroStrategy, see the Project Design Guide. Maximum cancel attempt time (sec): Defines the maximum amount of time the MicroStrategy Query Engine waits for a successful attempt before it cancels a query. Values of 0 and -1 indicate no limit. Maximum query execution time (sec): Defines the maximum amount of time a single pass of SQL can execute on the database. Values of 0 and -1 indicate no limit.
221
Maximum connection attempt time (sec): Defines the maximum amount of time Intelligence Server waits to connect to the database. Values of 0 and -1 indicate no limit. Additional connection string parameters: Enables you to pass additional ODBC connection parameters to the database as part of the connection string. This is useful if you need to change ODBC defaults. Click Preview to see the entire connection string. Table prefix: Defines a table prefix that specifies the schema containing the tables to access. Character set encoding for Windows drivers: The options listed below are only relevant when Intelligence Server is running on a Windows machine: Non UTF-8: Select this option if the ODBC driver returns information in a character encoding other than UTF-8. UTF-8: Select this option if the ODBC driver returns information in UTF-8 character encoding. Drivers for Teradata databases may require UTF-8 encoding.
Character set encoding for UNIX drivers: The options listed below are only relevant when Intelligence Server is running on a UNIX machine: Non UTF-8: Select this option if the ODBC driver returns information in a character encoding other than UTF-8. UTF-8: Select this option if the ODBC driver returns information in UTF-8 character encoding. Drivers for Teradata databases may require UTF-8 encoding.
Connection Caching: Specify the caching of the database connection using the following options: Connection lifetime (sec): Defines the amount of time an active database connection can remain open and cached on Intelligence Server to be re-used for additional jobs. You must also set the Connection idle timeout, described below, to a value greater than zero for database connections to be used by more than a single job. If a job requires a database connection to be open past its connection lifetime, the job is first allowed to complete, and then the database connection is dropped upon job completion. If you type a value of 0, when the job associated with a database connection is completed, the database connection is deleted and not put into a cache. If you type a value of -1, the lifetime of a
database connection is unlimited, which means it remains on Intelligence Server memory until the database connection is manually deleted or Intelligence Server is restarted. This can cause the memory resources to be reserved by the database connection for a potentially long time, and therefore it is recommended that you set finite limits on the connection lifetime. When defining the connection lifetime, you should determine whether the data source for the database connection also enforces connection lifetimes. Most databases enforce some type of limit on a connection lifetime. You should define the connection lifetime in MicroStrategy to be less than any limits on connection lifetimes for the data source. This is to avoid the scenario that the data source ends the database connection before MicroStrategy can complete the processing being done for that same database connection. Connection idle timeout (sec): Defines the amount of time an inactive connection to the database remains cached until it is terminated. You must also set the Connection lifetime, described above, to a value greater than zero for database connections to be used by more than a single job. Enforcement of the connection idle timeout can cause a database connection to be removed before it reaches its connection lifetime. You can use this connection idle timeout to ensure that database connections do not remain in Intelligence Server memory in an idle state for an extended amount of time. If you type a value of 0, when the job associated with a database connection is completed, the database connection is deleted and not put into a cache. If you type a value of -1, a database connection can remain idle and considered for new jobs until the database connection lifetime is reached. 4 On the General tab, in the Default database login name pane, select the default database login and click OK. If the necessary database login does not exist, you can create one by clicking New. For steps to create a database connection, see Creating a database login below.
223
login for MicroStrategy users, however users and groups can be mapped to other database logins using connection mapping. mapping is explained in User connection mapping, Connection page 225. You create database logins in the Database Connections dialog box by clicking New on the General tab. Any database login created within the Database Connections dialog box is available for use across all database connections in the project source. MicroStrategy reporting and analysis features require a general set of database login permissions that can connect to and modify the data source and metadata, as described below: For the metadata, the Select, Insert, and Update permissions are required. Intermediate tables are created in the metadata for recursive search queries, which requires Create and Drop permissions as well. Updating the schema requires the Delete permission. For the data warehouse, the Select, Create, Insert, and Drop permissions are required.
When you choose to create a new database login, the Database logins dialog box opens.
Prerequisites A database instance has been created, as described in Creating a database instance, page 215. A database connection has been created, as described in Creating a database connection, page 218.
1 In the Database Login field, type the name of the database login. 2 Provide the user ID and password required to access the data source, using one of the following methods: Type the user ID in the Login ID field, and type the password for that user ID in the Password field. Select the Use network login ID check box to connect to the data source using the network user credentials which are also used to run Intelligence Server. If Intelligence Server is running as a service, this is the user that is running the mstrsvr.exe process. To determine this user, in MicroStrategy Service Manager, select MicroStrategy Intelligence Server and click Options. The user is listed on the Service Startup tab, in the Login field. If the Service Account Name is defined as System Account, the Windows user credentials are used to access the data source.
3 Click OK. logins are passed to the data source any time a user executes Database a report or browses attribute elements. Therefore, all database logins created in MicroStrategy Developer must be also be created as valid logins in the data source.
225
You can map users to connections and logins in the Project Configuration Editor or Command Manager. For information about how connection maps are used, see the System Administration Guide. MicroStrategy reporting and analysis features require a general set of database login permissions to connect to and modify the data warehouse and metadata, as described below: For the metadata, the Select, Insert, and Update permissions are required. Intermediate tables are created in the metadata for recursive search queries, which requires Create and Drop permissions as well. Updating the schema requires the Delete permission. For the data warehouse, the Select, Create, Insert, and Drop permissions are required.
Prerequisites A database instance has been created, as described in Creating a database instance, page 215. A database connection has been created, as described in Creating a database connection, page 218. A database login has been created, as described in Creating a database login, page 223.
1 In Developer, log in to a project. 2 Right-click the project and select Project Configuration. The Project Configuration Editor opens. 3 In the Categories list, expand the Database Instances category, and then select Connection mapping. 4 Right-click in the Database instances - Connection mapping pane, and select New. A new connection mapping is added. 5 You can define the connection mapping by specifying the information described below: Database Instance: The database instance which connects to the data source required for the connection mapping.
User: The user or user group to apply the connection mapping to. Language: The language of the data accessed by the connection mapping. You can use connection mappings to support data internationalization. For information on supporting data internationalization with connection mappings, see the Project Design Guide. Database connection: The data source to connect to. Database Login: The database login for the connection mapping.
6 Click OK.
Creating a project
Now you have configured Intelligence Server 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 the Project Design Guide. MicroStrategy platform provides a Tutorial project, which is a The 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 Basic Reporting Guide for more information. To create a new project using your own data, see the Project Design Guide.
Creating a project
227
6
6.
Introduction
This chapter describes the procedure to deploy a project to your user community using MicroStrategy Web and Mobile Server. The process of deploying the ASP.NET version of MicroStrategy Web or MicroStrategy Mobile Server on Windows with Microsoft Internet Information Services (IIS) is explained in detail. Steps to deploy MicroStrategy Web Universal or MicroStrategy Mobile Server (JSP) in a UNIX/Linux and Windows environment with various Web and application servers are also explained in detail. MicroStrategy Web Universal and Mobile Server (JSP) are platform-independent and can be deployed using different combinations of operating systems, Web servers, and application servers. application servers are not MicroStrategy products, so detailed Web 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 you should refer to the vendor-provided information and documentation for details specific to your configuration, or contact MicroStrategy Technical Support.
229
MicroStrategy Web simplifies the job of deploying to large user groups because end users machines only need a supported browser. MicroStrategy Web can be accessed from any supported browser because no code must be downloaded. Working as a thin client, MicroStrategy Web provides the functionality that end users and power users require to take full advantage of the MicroStrategy product suite. This chapter has the following sections: Deploying with IIS (Windows), page 230 with IIS is the only setup given for MicroStrategy Web, Deploying which is an ASP.NET version for Windows, as well as the ASP.NET version of Mobile Server. The other deployment procedures use MicroStrategy Web Universal and Mobile Server (JSP), which is platform-independent and can be deployed with different Web and application servers. General steps to deploy MicroStrategy Web Universal or Mobile Server (JSP), page 234 Deploying with WebLogic and Apache (Solaris), page 236 Deploying with WebSphere and IBM HTTP Server (AIX), page 253 Deploying with Oracle Glassfish Server (Solaris), page 266 Deploying with Tomcat (Windows), page 278 Deploying with Tomcat (Linux), page 286 Deploying with SAP NetWeaver (Windows), page 293 Deploying with Oracle 10g (Windows), page 298 Deploying with JBoss (Windows), page 303 Administering your MicroStrategy Web deployment, page 310 Configuring your MicroStrategy installation, page 315
32-bit Windows environments: C:\Program Files\ Common Files\MicroStrategy 64-bit Windows environments: C:\Program Files (x86)\ Common Files\MicroStrategy
1 On the Windows Start menu, point to Programs, then to MicroStrategy Tools, and then choose Web Administrator. The MicroStrategy 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 MicroStrategy Web Administrator page.
231
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 You have manually connected MicroStrategy Web to the Intelligence Server. 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.
use Administrator as the login with no password. After the first time, the user name and password should be changed for security purposes. The Users group for Microsoft Windows must have read and execute permissions to all of the files within the MicroStrategy common files folder. This ensures that IIS has the required permissions to host MicroStrategy Mobile Server. By default, this folder is stored in the following directory location:
32-bit Windows environments: C:\Program Files\ Common Files\MicroStrategy 64-bit Windows environments: C:\Program Files (x86)\ Common Files\MicroStrategy
1 On the Windows Start menu, point to Programs, then to MicroStrategy Tools, and then select Mobile Administrator. The MicroStrategy Mobile Server Administrator page opens. This is the page where you connect MicroStrategy Mobile Server to the Intelligence Server. 2 Type the name of your Intelligence Server in the Add a server manually box on the MicroStrategy Mobile Server Administrator page. 3 Click Connect. 4 Click Mobile Configuration to configure your MicroStrategy Mobile applications to communicate with Mobile Server and Intelligence Server. For steps on how to define this configuration, see the MicroStrategy Mobile Design and Administration Guide. You have manually connected MicroStrategy Mobile Server to the Intelligence Server. You can also connect automatically whenever MicroStrategy Mobile Server or Intelligence Server starts.
To make MicroStrategy Mobile Server connect to the Intelligence Server automatically
1 On the MicroStrategy Mobile Server Administrator page, click Modify in the Properties column of the Intelligence Server.
233
2 Select the Automatically connect to Intelligence Server when Mobile Server or Intelligence Server is restarted option. 3 Click Save.
must perform extra configuration steps to allow graphs to You support non-Western European fonts on MicroStrategy Web Universal for a UNIX system. For more information, see Graph and document support of non-Western European fonts, page 526 of Appendix B, Troubleshooting. The same general steps used to deploy MicroStrategy Web Universal can also be used to deploy MicroStrategy Mobile Server (JSP). Therefore, you can use the deployment steps for the various environments documented in this
234 General steps to deploy MicroStrategy Web Universal or Mobile Server (JSP)
chapter to deploy MicroStrategy Mobile Server (JSP), and substitute a few configuration requirements specific to deploying Mobile Server (JSP).
High-Level Deployment Steps 1 Log on to the application server by using the proper user name and password. 2 Locate the MicroStrategyMobile.war file in the MicroStrategy Mobile Server (JSP) Deployment Directory you specified during installation. 3 To increase the performance of the application before proceeding with the deployment, see the Performance-based setup information section, if available, for your environment and configure as necessary. Also, after deploying MicroStrategy Mobile Server (JSP) on your machine, there may be a few performance-based setup steps that you should complete. 4 Choose the desired deployment method and follow the deployment procedure. 5 Log on to the MicroStrategy Mobile Server Administrator Page. 6 From the MicroStrategy Mobile Server Administrator Page, configure your MicroStrategy Mobile applications to communicate with Mobile Server and Intelligence Server. For steps on how to define this configuration, as well as steps to deploy and configure a certificate server for Mobile Server, see the MicroStrategy Mobile Design and Administration Guide. 7 Start working with the application.
235
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.
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 Setting up Apache Web server to proxy requests to WebLogic
This section supports 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 Operating system Web server Application server JDK Recommended Oracle Solaris 10.x or 11.x (on SPARC) Apache 2.x WebLogic 10.3 Oracle JDK 1.6.0 or 1.7.0 You can download the JDK from the following location: http://www.oracle.com/technetwork/java/index.html
For information on the version numbers supported or certified by MicroStrategy, see the MicroStrategy Readme.
237
For information on installing these products, see http:// www.oracle.com/technology/products/weblogic/ integration/index.html Before you start the deployment process, locate the machine name and IP address.
processes used to deploy the MicroStrategy Web Universal WAR file to deploy the Mobile Server (JSP) WAR file.
239
3 Launching the project, page 248. Performance-based setup information section provides The information on additional settings to increase application performance. These additional settings are not required but can increase the performance of MicroStrategy Web Universal. Review this information prior to deployment to see if these options are of interest to you. 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 240. Choose the development mode in the /WEBLOGIC_MYDOMAIN_FOLDER/bin/ 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 243.
1 Locate the MicroStrategy.war file in the MicroStrategy Web Universal Deployment Directory you specified during installation. For more information, see Installation procedures on UNIX and Linux, page 126. If you are deploying MicroStrategy Mobile Server (JSP) instead, locate the MicroStrategyMobile.war file. Use this WAR file for the rest of the steps in this procedure. 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. you do not change the name of the file, remember to replace If context_name with MicroStrategy when accessing the application from the URL.
To modify the web.xml file for multiple MicroStrategy Web Universal deployments
3 If you are deploying more than one MicroStrategy Web Universal environment on the same WebLogic application server, prior to deployment, you must modify the web.xml file as described below: a Unzip the WAR file by using the following command: jar -xvf MicroStrategy.war b Open the web.xml file located in the /WEB-INF directory. c Modify the contextPath parameter. By default, this parameter does not have a value. Type a unique string for the value of the contextPath parameter. For example, type WebDep2.
d Save the web.xml file. e Zip the WAR file by using the following command: jar -cvf MicroStrategy.war *
241
4 Transfer the WAR file to the following directory: /WEBLOGIC_MYDOMAIN_FOLDER/autodeploy The application is automatically deployed. To add and connect to an Intelligence Server, see Configuring the MicroStrategy Web Administrator and MicroStrategy Mobile Server Administrator pages, page 246. increase the performance of MicroStrategy Web Universal, you can To configure additional settings after deployment. For more information, see Performance-based setup information, page 248.
To automatically deploy MicroStrategy Web Universal from an exploded directory
WAR file must be uncompressed by the same Solaris user who The started the application. 1 Locate the MicroStrategy.war file. It is located in the MicroStrategy Web Universal Deployment Directory you specified during installation. For more information, see Installation procedures on UNIX and Linux, page 126. If you are deploying MicroStrategy Mobile Server (JSP) instead, locate the MicroStrategyMobile.war file. Use this WAR file for the rest of the steps in this procedure. 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. can create the new folder anywhere except in the following You location: /WEBLOGIC_MYDOMAIN_FOLDER/autodeploy 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 using the following command: # rm MicroStrategy.war 6 Move the folder to the autodeploy folder with the following commands: # cd.. # mv context_folder /WEBLOGIC_MYDOMAIN_FOLDER/ autodeploy The application is automatically deployed. To add and connect to an Intelligence Server, see Configuring the MicroStrategy Web Administrator and MicroStrategy Mobile Server Administrator pages, page 246. increase the performance of MicroStrategy Web Universal, you can To configure additional settings after deployment. For more information, see Performance-based setup information, page 248.
1 Locate the MicroStrategy.war file. It is located in the MicroStrategy Web Universal Deployment path, as described in Directory structure, page 143.
2013 MicroStrategy, Inc. Deploying with WebLogic and Apache (Solaris)
243
If you are deploying MicroStrategy Mobile Server (JSP) instead, locate the MicroStrategyMobile.war file. Use this WAR file for the rest of the steps in this procedure.
To modify the web.xml file for multiple MicroStrategy Web Universal deployments
2 If you are deploying more than one MicroStrategy Web Universal environment on the same WebLogic application server, prior to deployment, you must modify the web.xml file as described below: a Unzip the WAR file by using the following command: #jar -xvf MicroStrategy.war b Open the web.xml file located in the /WEB-INF directory. c Modify the contextPath parameter. By default, this parameter does not have a value. Type a unique string for the value of the contextPath parameter. For example, type WebDep2.
d Save the web.xml file. e Zip the WAR file by using the following command: #jar -cvf MicroStrategy.war *
To deploy the WAR file
3 Transfer the WAR file to the /WEBLOGIC_MYDOMAIN_FOLDER/ autodeploy directory. 4 Open the WebLogic Server Administration Console (WLS Admin Console) by typing the following address: http://IP address:port/console/ where IP address is the IP address of the machine on which you installed the WebLogic application server and port is the port number for the WebLogic application server. 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. 6 To complete this operation, see Configuring from the WebLogic Server Administration Console, page 245.
To manually deploy MicroStrategy Web Universal or Mobile Server (JSP) from the exploded directory
1 Locate the MicroStrategy.war file. It is located in the MicroStrategy Web Universal Deployment Directory you specified during installation. For more information, see Installation procedures on UNIX and Linux, page 126. If you are deploying MicroStrategy Mobile Server (JSP) instead, locate the MicroStrategyMobile.war file. Use this WAR file for the rest of the steps in this procedure. 2 Create a folder in the /WEBLOGIC_MYDOMAIN_FOLDER/autodeploy 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 WebLogic Server Administration Console by accessing the following address: http://IP address:Port/console/ where IP address is the IP address of the machine on which you installed the WebLogic application server and Port is the port number for the WebLogic application server. 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. 6 To complete this operation, see Configuring from the WebLogic Server Administration Console below.
245
To launch MicroStrategy Web Administrator and to configure MicroStrategy Intelligence Server, see Configuring the MicroStrategy Web Administrator and MicroStrategy Mobile Server Administrator pages, page 246. increase the performance of MicroStrategy Web Universal, you can To configure additional settings after deployment. For more information, see Performance-based setup information, page 248.
Configuring the MicroStrategy Web Administrator and MicroStrategy Mobile Server Administrator pages
Before you start MicroStrategy Web Universal, you must configure the MicroStrategy Web Administrator page, which is the mstrWebAdmin servlet.
To access the MicroStrategy Web Administrator and Mobile Server Administrator pages
1 The address to launch MicroStrategy Web is different for each deployment method. The following table lists the URL to access MicroStrategy Web Administrator as well as MicroStrategy Mobile Server Administrator. servlet names are case-sensitive. Make sure to use the correct The 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 Access the Administrator page from a web browser using this URL: For Web Universal: http://IPaddress:7001/context_folder_Web/ servlet/mstrWebAdmin In the URL listed above, context_folder_Web is the name of the folder where the Web Universal application was exploded and IPaddress is the IP address of your machine. For Mobile Server (JSP): http://IPaddress:7001/ context_folder_Mobile/servlet/mstrWebAdmin In the URL listed above, context_folder_Mobile is the name of the folder where the Mobile Server application was exploded and IPaddress is the IP address of your machine. Manual deployment Access the Administrator page from a browser using this address: For Web Universal: http://IPaddress:7001/Web_name/servlet/ mstrWebAdmin In the URL listed above, IPaddress is the IP address of your machine. Replace the Web_name variable with the name you specified in the deployed name field when configuring Web Universal from WebLogic Server Administration Console, for example, MyWebApp. For Mobile Server (JSP): http://IPaddress:7001/Mobile_name/ servlet/mstrWebAdmin In the URL listed above, IPaddress is the IP address of your machine. Replace the Mobile_name variable with the name you specified in the deployed name field when configuring Mobile Server from WebLogic Server Administration Console, for example, MyMobileApp.
2 Type the same user ID and password that was used to start the WebLogic Server on your machine. In WebLogic, the deployment of MicroStrategy 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. 3 After you are authenticated, the MicroStrategy Web Administrator page appears. Add and connect to an Intelligence Server. If you are deploying MicroStrategy Mobile Server (JSP), after you are authenticated, the MicroStrategy Mobile Server Administrator page appears. Add and connect to an Intelligence Server. Once connected, click Mobile Configuration to configure your MicroStrategy Mobile applications to communicate with Mobile Server and Intelligence Server. For steps on how to define this configuration, see the MicroStrategy
2013 MicroStrategy, Inc. Deploying with WebLogic and Apache (Solaris)
247
Mobile Design and Administration Guide. Creating a configuration completes the steps required to deploy Mobile Server (JSP). 4 Launch the MicroStrategy Web Universal project, as described below.
Automatic deployment Access MicroStrategy Web Universal from a web browser using this URL: http://IPaddress:7001/context_folder/servlet/mstrWeb 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 MicroStrategy Web Universal from a browser using the address: http://IPaddress/name/servlet/mstrWeb where IPaddress is the IP address of your machine. Replace the name variable with the name you specified in the deployed name field when configuring from WebLogic Server Administration Console, for example, MyWebApp.
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
1 Open the startWebLogic.sh script from / WEBLOGIC_MYDOMAIN_FOLDER/bin/startWebLogic.sh. 2 Define the following line in the script: MEM_ARGS=-Xms512m -Xmx1024m This line reflects an initial Java heap size of 512 MB. MicroStrategy recommends the initial java heap size be set at a minimum of 512MB, assuming the machine has enough memory space. This value may need to be modified to reflect the requirements of your specific environment. Refer to your third-party application server documentation for information on how to determine a satisfactory Java heap size for your environment. 3 Stop and start the application server.
249
1 Open the weblogic.xml file located in the /WEB-INF directory. 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.
1 Open the weblogic.xml file located in the /WEB-INF directory. 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.
1 Open the weblogic.xml file located in the /WEB-INF directory. 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-reload-check-secs> </container-descriptor> 3 Save the file.
1 To change the Alias parameter, add the following lines in the httpd.conf file: Alias /MicroStrategy/images/"/ WEBLOGIC_MYDOMAIN_FOLDER/autodeploy/MicroStrategy/ images/"
<Directory "/WEBLOGIC_MYDOMAIN_FOLDER/autodeploy/ MicroStrategy/images"> Options Indexes MultiViews AllowOverride None Order allow, deny Allow from all </Directory> code excerpts assume the application name is These MicroStrategy. See Deploying with WebLogic and Apache (Solaris) 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. 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.
253
This section includes the following information: Preconfiguration information: Configuration that must occur before you begin deploying MicroStrategy Web Universal or Mobile Server (JSP). Deploying MicroStrategy Web Universal or Mobile Server (JSP): Instructions for deploying the application. Performance-based setup information: Optional settings to increase the applications performance. additional settings are not required, but can increase the These performance of MicroStrategy 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. This section supports 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 Operating system Web server Application server JDK Recommended AIX 5.3.x, 6.1.x, or 7.1.x(on IBM POWER Architecture) IBM HTTP Server 6.x, 7.x, or 8.x IBM WebSphere application server 7.x, 8.x, or 8.5.x IBM JDK 1.6.0 You can download these JDKs from the following location: http://www.ibm.com/developerworks/java/jdk/aix/service.html
information on the version numbers certified and supported by For MicroStrategy, see the MicroStrategy Readme.
1 Locate the MicroStrategy.war file in the MicroStrategy Web Universal Deployment Directory you specified during installation. For more information, see Installation procedures on UNIX and Linux, page 126. If you are deploying MicroStrategy Mobile Server (JSP) instead, locate the MicroStrategyMobile.war file. Use this WAR file for the rest of the steps in this procedure. 2 Copy the WAR file to the WAS_HOME/installableApps directory, where WAS_HOME is the WebSphere application server home path. The deployment process in this chapter assumes that MicroStrategy.war file is stored in this directory. deploy the WAR file, you must follow a set of steps that are specific To 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. For information on the directory structure after deploying the WAR file, see Directory structure after deploying the WAR file, page 235.
255
2 Ensure that the Administrative Server has started successfully. Execute the following commands: cd WAS_HOME/bin # ./serverStatus.sh -all
To launch the WebSphere Administrative Console
1 In a browser, type the URL for the administrative console. The URL is of the following form: http://IP Address:Port/ibm/console where IP Address is the IP address of the computer on which you installed the WebSphere application server and Port is the port number for the WebSphere Administrative Console. Refer to your third-party WebSphere documentation to confirm the default port number for the administrative console.
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.
2013 MicroStrategy, Inc. Deploying with WebSphere and IBM HTTP Server (AIX)
257
1 Expand Applications, and then Enterprise Applications to display a list of installed applications. 2 Click Install.
1 To begin the installation for IBM WebSphere, expand Applications, then expand Application Types, and then select WebSphere enterprise applications. A list of enterprise applications is displayed. 2 Click Install. Options to specify the path to the new application are displayed. 3 You must specify the path to the WAR file by selecting either the local file system or remote file system option. For local file systems, you can click browse to navigate to the location of the MicroStrategy.war file. For remote file systems, type in the full path for the location of the MicroStrategy.war file. If you are deploying MicroStrategy Mobile Server (JSP) instead, browse to or type the full path for the MicroStrategyMobile.war file. 4 Click Next to continue the installation. 5 Select to perform either a Fast Path or Detailed installation. Either type of installation can support the deployment of MicroStrategy Web or MicroStrategy Mobile.
6 Select the Generate Default Binding check box, and ensure that the Override existing bindings check box is cleared. 7 Click Next. The Select installation options page opens. In the screens that follow, you are selecting settings that are used during the installation. 8 Perform the following configuration steps: Select the Precompile Java Server Pages files check box. Specify the value for the Directory to Install Application as ${APP_INSTALL_ROOT}/DefaultNode Specify an Application Name of your choice. Ensure that the Override class reloading settings for Web and EJB modules check box is cleared.
9 Click Next. The Map modules to application servers page opens. 10 Select the Web Tier check box and click Next. The Map context roots for web modules page opens. 11 Type a suitable name for ContextRoot, which is case-sensitive. Do not include .war in the name for ContextRoot as this can cause errors when attempting to start the application. URL to access MicroStrategy Web Universal (http:// The machine-name/ContextRoot/servlet/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. 12 Click Next. The Summary Page opens. 13 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. 14 As part of deploying MicroStrategy Web or MicroStrategy Mobile, you can control access to the MicroStrategy Web Administrator page or MicroStrategy Mobile Server Administrator page respectively. To perform this configuration, 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 and MicroStrategy Mobile Server Administrator
259
page. To access these options in WebSphere, expand the Security options, and then click Global Security. must be enabled for the WebSphere Server for this feature Security to work.
Regenerating plugin-cfg.xml
To regenerate plugin-cfg.xml
1 Expand Environment, and then click Update global WebServer Plug-in configuration. 2 Click OK, and then click Save to master configuration.
option to stop and start the application server through the 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 Servers, and then click the WebSphere Application Servers link. A table listing the application servers and an icon indicating their status appears: red: stopped green: started
2 Select the box next to the application server you want to stop, and click Stop. The status icon changes from green to red.
3 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.
4 Expand Applications, then expand Application Types, and then select WebSphere enterprise applications. A list of enterprise applications is displayed, along with icons indicating their status: red: stopped green: started
5 Select the box next to the application to start and click Start.
Accessing the MicroStrategy Web Administrator or MicroStrategy Mobile Server Administrator page
The MicroStrategy Web Administrator page (mstrWebAdmin servlet) is accessible only to users with an admin 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. The steps to perform this setup are given above in the section Preparing for the application installation, page 258. For more information, you can refer to your IBM documentation. Before you start MicroStrategy Web Universal, you must configure the MicroStrategy Web Administrator page, which is the mstrWebAdmin
261
servlet. If you are deploying Mobile Server (JSP), you can use the steps below to configure the MicroStrategy Mobile Server Administrator page, which also uses the mstrWebAdmin servlet.
To access the MicroStrategy Web Administrator or MicroStrategy Mobile Server Administrator page
1 Access the servlet by typing the following URL in a Web browser: For Web Universal: http://IPAddress/ContextRootWeb/ servlet/mstrWebAdmin In the URL listed above, ContextRootWeb is the name you provided for the ContextRoot for Web Module box in the section Preparing for the application installation. For example, the default name of the WAR file, which is MicroStrategy. For Mobile Server (JSP): http://IPAddress/ ContextRootMobile/servlet/mstrWebAdmin In the URL listed above, ContextRootMobile is the name you provided for the ContextRoot for Web Module box in the section Preparing for the application installation. For example, the default name of the WAR file, which is MicroStrategyMobile. servlet names are case-sensitive. Use the correct case when The 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 admin role. 3 After you are authenticated, the MicroStrategy Web Administrator page opens. Use it to add and connect to an Intelligence Server. If you are deploying MicroStrategy Mobile Server (JSP), after you are authenticated, the MicroStrategy Mobile Server Administrator page appears. Add and connect to an Intelligence Server. Once connected, click Mobile Configuration to configure your MicroStrategy Mobile applications to communicate with Mobile Server and Intelligence Server. For steps on how to define this configuration, see the MicroStrategy Mobile Design and Administration Guide. Creating a configuration completes the steps required to deploy Mobile Server (JSP). 4 Proceed to launch the MicroStrategy Web Universal project. For more information, see Launching the project immediately below.
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://MachineName/ContextRoot/servlet/mstrWeb Alternatively, you can use the IP address of your machine for remote access, as shown below: http://IPAddress/ContextRoot/servlet/mstrWeb these addresses, ContextRoot is the name you provided for the In 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 258. You can now access the MicroStrategy Web Universal application.
1 Expand Applications, then expand Application Types, and then select WebSphere enterprise applications. A list of enterprise applications is displayed.
263
2 Select the desired MicroStrategy Web application. 3 Click Uninstall. 4 Save the configuration in the master repository.
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. This value may need to be modified to reflect the requirements of your specific environment. Refer to your third-party application server
documentation for information on how to determine a satisfactory Java heap size for your environment. 6 Click Apply and save your changes. 7 Stop and start the application server.
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.
265
username userID password password For each JSP file compiled without error, the following message appears: Code generation successful.
For more information, see the IBM WebSphere Application Server redbook covering System Management and Configuration. This book discusses separating static content from dynamic content.
Undeploying MicroStrategy Web Universal or Mobile Server JSP: Instructions for undeploying MicroStrategy Web Universal or Mobile Server JSP.
Preconfiguration information
This section provides the preconfiguration information necessary for deploying MicroStrategy Web Universal on your machine, which includes Locating the WAR file, page 267. 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. While your configuration may vary slightly, for example, you may have different versions of these applications, the overall process remains the same:
Requirement Operating system Web server Application server JDK Configuration Details Solaris 10.x or 11.x (on SPARC) Oracle iPlanet Web Server 7.0 Oracle Glassfish Server 3.1.x You can download the JDK from the following location: http://www.oracle.com/technetwork/java/index.html
For information on the version numbers certified and supported by MicroStrategy, see the MicroStrategy Readme.
267
1 Do one of the following: If you are deploying MicroStrategy Web Universal, locate the MicroStrategy.war file in the MicroStrategy Web Universal Deployment Directory that you specified during installation. For more information, see Installation procedures on UNIX and Linux, page 126. If you are deploying MicroStrategy Mobile Server (JSP), locate the MicroStrategyMobile.war file in the folder that you specified when installing Mobile Server (JSP).
2 Copy the WAR file to the same machine as the Oracle Glassfish Server, or to a location that is accessible to the Oracle Glassfish Server machine. The deployment process in this chapter assumes that the MicroStrategy.war or MicroStrategyMobile.war file is stored in this directory. deploy the WAR file, you must follow a set of steps that are specific To 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. For information on the directory structure after deploying the WAR file, see Directory structure after deploying the WAR file, page 235.
3 Controlling access to the MicroStrategy Web Administrator and Mobile Server Administrator pages, page 272 4 Accessing the MicroStrategy Web Administrator or MicroStrategy Mobile Server Administrator page, page 275 5 Connecting to the Web Universal project page, page 276 administration and deployment tools in Oracle Glassfish Server The 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.
1 Navigate to the following directory in the command prompt: InstallDir/bin where InstallDir is the directory where you installed Oracle Glassfish Server. 2 Type the following command to start the domain: asadmin start-domain --domaindir DomainDirectory DomainName
269
where: DomainDirectory is the path you defined when creating the domain. You can remove the --domaindir option if the domain uses the default directory. DomainName is the name of the domain you created in the previous steps.
For example, to start domain1, which is the default domain, type the following command: asadmin start-domain domain1 3 Access the Oracle Glassfish Server Administration Console by typing the following URL: http://MachineName:PortNumber where: MachineName is the IP address or the name of the machine where you installed Oracle Glassfish Server. PortNumber is the port number you provided when creating the domain. The default port number is 4848.
4 If prompted, type the user name and password that you provided when creating the domain.
to users can be done within the Oracle Glassfish Server Administration Console after deploying the WAR file. While this default behavior supports most deployment requirements, if you have specific security requirements for your system, you must modify the security role details prior to deploying the WAR file, as described in Managing the admin security role for specialized group authentication requirements, page 274.
To deploy MicroStrategy Web Universal or Mobile Server (JSP) as a WAR file
1 Access the Administration Console by typing the following URL: http://MachineName:PortNumber where: MachineName is the IP address or the name of the machine where you installed Oracle Glassfish Server. PortNumber is the port number you provided when creating the domain. The default port number is 4848.
2 If prompted, type the user name and password that you used to create the domain. 3 Expand the Tree pane on the left side of the Administration Console. 4 Click Applications. The Applications page is displayed. 5 Click Deploy. The Deploy Applications or Modules page is displayed. 6 Select Local Packaged File or Directory That Is Accessible from GlassFish Server, and then click Browse Files. The Browse Server dialog box opens. the WAR file in this manner is recommended as the Selecting Packaged File to Be Uploaded to the Server option uploads the WAR file via HTTP, which can require considerable time and system resources. 7 Browse to the location where you saved the MicroStrategy Web Universal (MicroStrategy.war) WAR file. If you are deploying MicroStrategy Mobile Server (JSP) instead, browse to the MicroStrategyMobile.war file for the deployment process.
271
8 Once you select the appropriate WAR file, click Choose File. 9 From the Type drop-down list, select Web Application. 10 In the Context Root field, type the context root for the application, which is included in various URLs for the application.
The URL to access MicroStrategy Web Universal (http:// IPAddress:PortNumber/ContextRoot/servlet/ mstrWeb) includes the applications context root, 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. The URL to access the MicroStrategy Mobile Server Administrator Page (http://IPAddress:PortNumber/ ContextRoot/servlet/mstrWebAdmin) includes the applications context root, which should be replaced by any name of your choice. For example, you can use the default name of the WAR file, which is MicroStrategyMobile.
11 In the Application Name field, type a descriptive name to distinguish the application from within the Administration Console. 12 In the Virtual Servers list, select the appropriate server. 13 Select or clear the additional deployment option check boxes according to your requirements. is recommended you select the Precompile JSPs check box to It quickly load the Web pages in the application server when you access it for the first time. 14 Click OK to deploy the application.
Controlling access to the MicroStrategy Web Administrator and Mobile Server Administrator pages
For security purposes, you must only assign certain users the authorization to access the MicroStrategy Web Administrator and Mobile Server Administrator pages. To do this, users for whom you want to grant permission to access the MicroStrategy Web Administrator or Mobile Server Administrator pages need to be assigned to the mstradmin group, which is part of the admin security role.
272 Deploying with Oracle Glassfish Server (Solaris)
2013 MicroStrategy, Inc.
Oracle Glassfish Server supports the following authentication realms out-of-the-box: File realm Administration realm Certificate realm
realm, also called a security policy domain or security domain, is a 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.oracle.com/cd/E18930_01/html/821-2435/ ggkuk.html#gkbiy In Oracle Glassfish Server, the file realm is the default realm. For controlling access to the Administration pages, you can create users and user groups and assign the mstradmin group to users in your security realm.
To create users that are assigned to the mstradmin group in the file realm
1 In the Administration Console, from the Tree pane on the left, click server (Admin Server). Ensure that the server is running or click Start to start the server. 2 From the Tree pane on the left, expand Configuration, then server-config, then Security, then Realms, and then select file. The Edit Realm page is displayed. 3 Click Manage Users. The File Users page is displayed. 4 Click New to create a new user. The New File Realm User page is displayed. 5 Type the following information for the new user: User ID: The ID that the user provides when authenticating with the system. Group List: The groups that the user is a member of. Type mstradmin to provide the user access to the MicroStrategy Web Universal or MicroStrategy Mobile Server (JSP) Administrator pages. New Password: The password used to authenticate a user.
273
Confirm New Password: A confirmation of the password, required when creating a new user.
6 Click OK to create the user. You are returned to the File Users page, where you can continue to create and manage users for the administration realm. 7 To apply all of these changes, stop and restart the application server: a In the Administration Console, from the Tree pane on the left, select server (Admin Server). The General Information page is displayed. b Click Restart.
Managing the admin security role for specialized group authentication requirements
MicroStrategy provides a descriptor file, glassfish-web.xml, which enables Oracle Glassfish Server to map the existing users or groups to security roles. This file is located within the MicroStrategy WAR files, and after deployment can be found in the WebApplicationRootDir/WEB-INF folder. By default, the admin security role and its mstradmin group defined in this glassfish-web.xml file can be used to grant access to the MicroStrategy Web Administrator and Mobile Server Administrator pages. This provides administrative access without having to make any modifications to glassfish-web.xml. In these scenarios, you can use the steps provided in Deploying MicroStrategy Web Universal or Mobile Server (JSP), page 270 and Controlling access to the MicroStrategy Web Administrator and Mobile Server Administrator pages, page 272 to complete the deployment and authentication requirements. While this default behavior supports most deployment requirements, you can modify this glassfish-web.xml file if you have specialized group authentication requirements to use a group other than the default mstradmin group defined for the admin security role. Any groups that are used must be included as part of the admin security role. changes made to the glassfish-web.xml file must be done Any prior to deploying the MicroStrategy Web Universal or MicroStrategy Mobile Server (JSP) application.
The contents of this file are as follows, which may differ depending on your installation of Oracle Glassfish Server: <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE glassfish-web-app PUBLIC "-//GlassFish.org// DTD GlassFish Application Server 3.1 Servlet 3.0//EN" "http://glassfish.org/dtds/glassfish-web-app_3_0-1.dtd"> <glassfish-web-app> <security-role-mapping> <role-name>admin</role-name> <group-name>mstradmin</group-name> </security-role-mapping> </glassfish-web-app> Once you make any changes to this file, you must deploy the application (see Deploying MicroStrategy Web Universal or Mobile Server (JSP), page 270) and assign the security role to the necessary user accounts (see Controlling access to the MicroStrategy Web Administrator and Mobile Server Administrator pages, page 272).
Accessing the MicroStrategy Web Administrator or MicroStrategy Mobile Server Administrator page
Before you start MicroStrategy Web Universal, you must configure the MicroStrategy Web Administrator page, which is the mstrWebAdmin servlet. If you are deploying Mobile Server (JSP), you can use the steps below to configure the MicroStrategy Mobile Server Administrator page, which also uses the mstrWebAdmin servlet.
To access the MicroStrategy Web Administrator and MicroStrategy Mobile Server pages
1 Access the servlet by typing the following URL in a Web browser: For Web Universal: http://IPAddress:PortNumber/ ContextRootWeb/servlet/mstrWebAdmin In the URL listed above, ContextRootWeb is the name you provided for the ContextRoot for Web Module box in the section Deploying MicroStrategy Web Universal or Mobile Server (JSP), page 270. For example, you can use the default name of the WAR file, which is MicroStrategy. The default port number is 8080.
275
For Mobile Server (JSP): http://IPAddress:PortNumber/ ContextRootMobile/servlet/mstrWebAdmin In the URL listed above, ContextRootMobile is the name you provided for the ContextRoot for Web Module box in the section Deploying MicroStrategy Web Universal or Mobile Server (JSP), page 270. For example, you can use the default name of the WAR file, which is MicroStrategyMobile. The default port number is 8080.
servlet names are case-sensitive. Use the correct case when The 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 for a user who is a member of the mstradmin group, as described in Controlling access to the MicroStrategy Web Administrator and Mobile Server Administrator pages, page 272. 3 After you are authenticated, the MicroStrategy Web Administrator page opens. Use it to add and connect to an Intelligence Server. If you are deploying MicroStrategy Mobile Server (JSP), after you are authenticated, the MicroStrategy Mobile Server Administrator page appears. Add and connect to an Intelligence Server. Once connected, click Mobile Configuration to configure your MicroStrategy Mobile applications to communicate with Mobile Server and Intelligence Server. For steps on how to define this configuration, see the MicroStrategy Mobile Design and Administration Guide. Creating a configuration completes the steps required to deploy Mobile Server (JSP). 4 Proceed to launch the MicroStrategy Web Universal project. For more information, see Connecting to the Web Universal project page immediately below.
In a Web browser, type the following URL: http://MachineName:PortNumber/ContextRoot If you have used all the default values, you can access the following URLs: http://localhost:8080/MicroStrategy/ or http://localhost:8080/MicroStrategy/servlet/mstrWeb You are now ready to use MicroStrategy Web Universal.
1 In the Administration Console, from the Tree pane on the left, click Applications. The Applications page is displayed. 2 Select the check box for the Web Universal application or Mobile Server (JSP) application. 3 Click Undeploy. 4 After the undeployment is finished, stop and restart the application server for the changes to take effect.
277
Preconfiguration information
This section provides the preconfiguration information necessary to deploy MicroStrategy Web Universal on Tomcat on your machine. While your setup may vary slightly, for example, you may have different versions of these applications, the overall process remains the same.
Requirement Operating system Application server JDK Recommended Windows 2008 Enterprise Edition SP2 (on x64) Tomcat 6.0.x or 7.0.x Oracle JDK 1.6.0 or 1.7.0 You can download the JDK from the following location: http://www.oracle.com/technetwork/java/index.html
development kit (which is termed JDK or SDK) rather than installing only the JRE. configure the JDK, a system variable must point to the folder To where you install the JDK. If you install the JDK to a simple folder path such as C:\ setting the system variable is easier and more likely to be correct. After you install the Oracle JDK, you must configure it.
To configure the JDK
1 On your Windows machine, access the environment variables using the steps below: third-party products discussed below are manufactured by The vendors independent of MicroStrategy, and the steps to configure these products is subject to change. Refer to the appropriate Microsoft documentation for steps to access and modify the environment variables. a From the Start menu, select Computer. The Computer dialog box opens. b Click System properties. The System dialog box opens. c Click Advanced system settings. The System Properties dialog box opens.
d Click Environment Variables. The Environment Variables dialog box opens. 2 Under System Variables, click New to create a system variable. The New System Variable dialog box opens. 3 In the Variable Name field, type JAVA_HOME. 4 In the Variable Value field, type the path of the folder where you installed the JDK and click OK. For example, if the fully qualified path to your JDK executable is C:\ jdk1.6.0\bin\java.exe, the value of your JAVA_HOME variable is C:\jdk1.6.0. you have installed JDK under the Program Files folder, type If Progra~1 when specifying the folder name in the Variable Value box;
279
otherwise the system does not recognize the folder. For example, type C:\Progra~1\jdk1.6.0 in the Variable Value box.
Configuring Tomcat
This procedure assumes that you have downloaded and installed Tomcat on your machine. You can download Tomcat from the Apache website; depending on the version you want to download, you may need to locate the appropriate file in Apaches Archive area. Instructions for downloading and installing Tomcat are also available on the Apache website. To configure Tomcat, a system variable must point to the folder where you install Tomcat. If you install Tomcat to a simple folder path such as C:\ Tomcat then setting the system variable is easier and more likely to be correct. After you install Tomcat, you must configure it.
To configure Tomcat
1 On your Windows machine, access the environment variables using the steps below: third-party products discussed below are manufactured by The vendors independent of MicroStrategy, and the steps to configure these products is subject to change. Refer to the appropriate Microsoft documentation for steps to access and modify the environment variables. a From the Start menu, select Computer. The Computer dialog box opens. b Click System properties. The System dialog box opens. c Click Advanced system settings. The System Properties dialog box opens.
d Click Environment Variables. The Environment Variables dialog box opens. 2 Under System Variables, click New to create a system variable. The New System Variable dialog box opens. 3 In the Variable Name field, type CATALINA_HOME.
4 In the Variable Value field, specify the path of the folder where you installed Tomcat and click OK. For example, if you installed Tomcat directly to the C drive, the destination folder is C:\Tomcat. you installed Tomcat under the Program Files folder, type If Progra~1 when specifying the folder in the Variable Value box. Otherwise, the system does not recognize the folder. For example, type C:\Progra~1\Tomcat in the Variable Value box.
281
1 Copy the MicroStrategy.war file to the Tomcat\webapps folder. Instructions on locating the MicroStrategy.war file can be found in the section Locating the WAR file, page 281. If you are deploying MicroStrategy Mobile Server (JSP) instead, locate the MicroStrategyMobile.war file (see Locating the Mobile Server WAR file, page 282).
Stop and start Tomcat from the command line
2 From the Start menu, select Run. The Run dialog box opens.
3 Type cmd in the Open drop-down list and click OK. The command prompt opens. 4 Browse to the Tomcat\bin folder, where Tomcat is the folder in which you installed Tomcat. For example, in the command prompt, type cd C:\Tomcat\bin 5 Press ENTER. C:\Tomcat\bin> is displayed at the command prompt. 6 Type startup to start Tomcat and shutdown to stop it. you installed Tomcat under the Program Files folder, type If Progra~1 when you change folders in the command prompt. Otherwise, the system does not recognize the folder. For example, type C:\Progra~1\Tomcat\bin in the command prompt. MicroStrategy Web Universal or MicroStrategy Mobile Server (JSP) is deployed automatically, based on the following: If you have configured Tomcat to deploy an exploded WAR file, which is often the default behavior:
When deploying MicroStrategy Web Universal, a MicroStrategy folder is created within the Tomcat\webapps folder. When deploying MicroStrategy Mobile Server (JSP), a MicroStrategyMobile folder is created within the Tomcat\ webapps folder.
If you have configured Tomcat to deploy an unexploded WAR file, the configuration files are created within the systems default temporary file directory. For Windows systems, the temporary file directory is commonly defined by the TMP environment variable:
When deploying MicroStrategy Web Universal, a /microstrategy/ web-Version/ folder is created within the temporary file directory, where Version is the version number for the MicroStrategy Web Universal product. Within this folder location, various configuration files can be found within the WEB-INF folder and its subfolders. When deploying MicroStrategy Mobile Server (JSP), a / microstrategy/mobile-Version/ folder is created within the temporary file directory, where Version is the version number for the MicroStrategy Mobile Server (JSP) product. Within this folder location, various configuration files can be found within the WEB-INF folder and its subfolders.
Deploying with Tomcat (Windows)
283
Controlling access to the MicroStrategy Web Administrator and Mobile Server Administrator pages
The MicroStrategy Web Administrator page is accessible only to users with an admin role. To create a user/password set that is authorized to access the Administrator page, you must create the users and assign them the role of admin under the Tomcat user configuration file. The steps to give a user access to the MicroStrategy Web Administrator page follow. If you are deploying Mobile Server (JSP), you can use the steps below to control access to the MicroStrategy Mobile Server Administrator page.
To control access to the MicroStrategy Web Administrator and Mobile Server Administrator pages
1 In the Tomcat\conf folder, open the tomcat-users.xml file in a program that allows you to edit the file, such as Notepad. 2 Add the following tag and save the file: <user name=administrator password=administrator roles= admin/> can specify any value in the user name and password fields. You These are used to log in to the MicroStrategy Web Administrator page. 3 Stop and start Tomcat from the command line. Now you can start MicroStrategy Web Administrator or Mobile Server Administrator to add and connect to an Intelligence Server. To configure MicroStrategy Web Administrator or Mobile Server Administrator, see Accessing the MicroStrategy Web Administrator or Mobile Server Administrator page, page 292.
1 In a Web browser, access the MicroStrategy Web Administrator page or the MicroStrategy Mobile Server Administrator page by specifying the following URL: For Web: http://localhost:8080/MicroStrategy/servlet/ mstrWebAdmin For Mobile Server (JSP): http://localhost:8080/ MicroStrategyMobile/servlet/mstrWebAdmin
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. you are using Tomcat integrated with IIS, you do not need to If specify the port number in the URL. However, when using Tomcat as a stand-alone Web container, you must specify the port number. The default port for Tomcat is 8080. 2 When prompted for a user name and password, use the same values you specified in the tomcat-users.xml file. 3 Once you log in, the MicroStrategy Web Administrator page is displayed. Add and connect to an Intelligence Server. If you are deploying MicroStrategy Mobile Server (JSP), after you are authenticated, the MicroStrategy Mobile Server Administrator page appears. Add and connect to an Intelligence Server. Once connected, click Mobile Configuration to configure your MicroStrategy Mobile applications to communicate with Mobile Server and Intelligence Server. For steps on how to define this configuration, see the MicroStrategy Mobile Design and Administration Guide. Creating a configuration completes the steps required to deploy Mobile Server (JSP). 4 Proceed to launch the MicroStrategy Web Universal project. For more information, see Launching the project, page 286 below.
285
Preconfiguration information
This section provides the preconfiguration information necessary to deploy MicroStrategy Web Universal with Tomcat on your Linux machine: Installing the JDK Configuring the JDK Installing Tomcat Configuring Tomcat Locating the WAR file
While your setup may vary slightly, for example, you may have different versions of these applications, the overall process remains the same.
Requirement Operating system Recommended Red Hat Enterprise Linux 5.8 (on x86-64)
Recommended Tomcat 6.0.x or 7.0.x Oracle JDK 1.6.0 or 1.7.0 You can download the JDK from the following location: http://www.oracle.com/technetwork/java/index.html
1 Open the /etc/profile file using a program that allows you to edit the file.
287
2 Add the following line: export JAVA_HOME=/PathName/jdkVersion; where PathName is the destination folder where you installed the JDK and Version is the version, such as 1_6_0, of the JDK.
Installing Tomcat
This procedure assumes that you have downloaded and installed Tomcat in a directory named Tomcat on your machine. If you have not installed Tomcat yet, download the zip file from the following website Tomcat 6.0.x: http://tomcat.apache.org/download-60.cgi Tomcat 7.0.x: website. http://tomcat.apache.org/ download-70.cgi
your System Administrator or visit the Apache website for Contact instructions on downloading and installing Tomcat.
Configuring Tomcat
After you install Tomcat, you must configure Tomcat. The Tomcat configuration includes creating the environment variable CATALINA_HOME and defining this environment variable to point to the Tomcat directory.
To configure Tomcat
1 Open the etc/profile file in a program that allows you to edit the file. 2 Type the following: export CATALINA_HOME = /PathName where PathName is the directory where you have installed Tomcat. For example, export CATALINA_HOME = /Tomcat
289
processes used to deploy the MicroStrategy Web Universal WAR file to deploy the Mobile Server (JSP) WAR file.
1 Copy the MicroStrategy.war file to the Tomcat/webapps directory. Instructions on locating the MicroStrategy.war file can be found in the previous section, Locating the WAR file, page 289. If you are deploying MicroStrategy Mobile Server (JSP) instead, copy the MicroStrategyMobile.war file to the Tomcat/webapps directory (see Locating the Mobile Server WAR file, page 289). Use this WAR file for the rest of the steps in this procedure.
To start and stop Tomcat from the command line
2 Type # $CATALINA_HOME/bin/startup.sh and press ENTER to start Tomcat, which deploys MicroStrategy Web Universal or MicroStrategy Mobile Server (JSP) automatically, based on the following: If you have configured Tomcat to deploy an exploded WAR file, which is often the default behavior:
When deploying MicroStrategy Web Universal, a MicroStrategy folder is created within the Tomcat\webapps folder.
When deploying MicroStrategy Mobile Server (JSP), a MicroStrategyMobile folder is created within the Tomcat\ webapps folder.
If you have configured Tomcat to deploy an unexploded WAR file, the configuration files are created within the systems default temporary file directory. For UNIX and Linux systems, the temporary file directory is usually /tmp/ or /var/tmp/:
When deploying MicroStrategy Web Universal, a / microstrategy/web-Version/ folder is created within the temporary file directory, where Version is the version number for the MicroStrategy Web Universal product. Within this folder location, various configuration files can be found within the WEB-INF folder and its subfolders. When deploying MicroStrategy Mobile Server (JSP), a / microstrategy/mobile-Version/ folder is created within the temporary file directory, where Version is the version number for the MicroStrategy Mobile Server (JSP) product. Within this folder location, various configuration files can be found within the WEB-INF folder and its subfolders.
Controlling access to the MicroStrategy Web Administrator and Mobile Server Administrator pages
The MicroStrategy 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. If you are deploying Mobile Server (JSP), you can use the steps below to control access to the MicroStrategy Mobile Server Administrator page.
To control access to the MicroStrategy Web Administrator and Mobile Server Administrator pages
1 In the Tomcat/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/>
291
<user username=admin password=admin roles=admin/ > <user username=system password=goldengate roles= admin/> can specify any value in the user name and password fields. You These are used to log in to the MicroStrategy Web Administrator and Mobile Server Administrator pages. The roles field must be admin. 3 Stop and restart Tomcat. Now you can start MicroStrategy Web Administrator or Mobile Server Administrator to add and connect to an Intelligence Server. To configure MicroStrategy Web Administrator or Mobile Server Administrator, see Accessing the MicroStrategy Web Administrator or Mobile Server Administrator page, page 292.
1 In a Web browser, access the MicroStrategy Web Administrator page or the MicroStrategy Mobile Server Administrator page by specifying the following URL: For Web: http://localhost:8080/MicroStrategy/servlet/ mstrWebAdmin For Mobile Server (JSP): http://localhost:8080/ MicroStrategyMobile/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. Add and connect to an Intelligence Server.
If you are deploying MicroStrategy Mobile Server (JSP), after you are authenticated, the MicroStrategy Mobile Server Administrator page appears. Add and connect to an Intelligence Server. Once connected, click Mobile Configuration to configure your MicroStrategy Mobile applications to communicate with Mobile Server and Intelligence Server. For steps on how to define this configuration, see the MicroStrategy Mobile Design and Administration Guide. Creating a configuration completes the steps required to deploy Mobile Server (JSP). 4 Proceed to launch the MicroStrategy Web Universal project. For more information, see Launching the project, page 293.
Preconfiguration information
This section provides the preconfiguration information necessary to deploy MicroStrategy Web Universal on your machine. It also provides additional setup information for the machine where the application server and Web server are already installed. The configuration required to deploy MicroStrategy Web Universal on SAP is provided in the following table. While your configuration may vary slightly,
293
for example, you may have different versions of these applications, the overall process remains the same.
Requirement Operating system Application server Recommended Windows 2008 Enterprise Edition SP2 (on x64) SAP NetWeaver Application Server 7.3.x
information on the version numbers certified and supported by For MicroStrategy, see the MicroStrategy Readme.
processes used to deploy the MicroStrategy Web Universal WAR file to deploy the Mobile Server (JSP) WAR file.
Deploying MicroStrategy Web Universal or Mobile Server (JSP) with the SAP NetWeaver Application Server
Follow the steps provided in this section to deploy MicroStrategy Web Universal or Mobile Server (JSP) as a WAR file.
To deploy MicroStrategy Web Universal or Mobile Server (JSP) as a WAR file
1 Copy the MicroStrategy.war file to the Windows machine hosting your application server. The location in which you store the file is used later and referred to as path_to_war_file. If you are deploying MicroStrategy Mobile Server (JSP) instead, copy the MicroStrategyMobile.war file to the Windows machine hosting your application server. Use this WAR file for the rest of the steps in this procedure. 2 From the Windows Start menu, select Run. The Run dialog box opens. 3 In the Open drop-down list, type cmd, and click OK. A command prompt opens.
295
4 Using the command prompt, browse to the following directory within the SAP Application Server installation directory: /usr/sap/SID/Instance_Number/j2ee/deployment/scripts/ The SID and Instance_Number parameters are defined during installation and configuration of the SAP Application Server. The port number above refers to the P4 port number. The default port number is 50004. 5 Type the following command and press ENTER to deploy the MicroStrategy.war file: Deploy.bat user_name:password@localhost:port_number path_to_war_file The user name and password must have administrative access. The port number above refers to the P4 port number. The default port number is 50004. 6 Access NetWeaver web admin console using the following URL: http://localhost:PortNumber/nwa The PortNumber above refers to the J2EE engine port number. The default port number is 50000. 7 Log in as an administrative user. 8 From the Operation Management tab, select the Systems tab, and then click Start & Stop. 9 Select Java EE Applications. A list of applications deployed on the application server are displayed. 10 Select the MicroStrategy application just deployed from the list. 11 From the Application Details section, select the Status tab, and then click Start. 12 Select On all instances and Set "Started" as Initial State. When application is started, the status is displayed as Started.
Controlling access to the MicroStrategy Web Administrator and Mobile Server Administrator pages
You can configure security roles to control access to the MicroStrategy Web Administrator and Mobile Server Administrator pages. A security role named admin is created for the MicroStrategy Web Universal and Mobile Server applications within SAP NetWeaver, and is mapped to the administrators user group. This is defined in the web-j2ee-engine.xml file. To allow access to the MicroStrategy Web Administrator and Mobile Server Administrator pages, modify this file to map users or groups to this admin security role, or include users in the administrators user group.
1 Access the servlet by typing the following URL in a Web browser: For Web: http://MachineName:PortNumber/MicroStrategy/ servlet/mstrWebAdmin For Mobile Server (JSP): http://MachineName:PortNumber/ MicroStrategyMobile/servlet/mstrWebAdmin
servlet names are case-sensitive. Use the correct case when The typing the mstrWebAdmin name. The login dialog box opens. 2 Specify a user name and password.
297
3 After you are authenticated, the MicroStrategy Web Administrator page opens. Use it to add and connect to an Intelligence Server. If you are deploying MicroStrategy Mobile Server (JSP), after you are authenticated, the MicroStrategy Mobile Server Administrator page appears. Add and connect to an Intelligence Server. Once connected, click Mobile Configuration to configure your MicroStrategy Mobile applications to communicate with Mobile Server and Intelligence Server. For steps on how to define this configuration, see the MicroStrategy Mobile Design and Administration Guide. Creating a configuration completes the steps required to deploy Mobile Server (JSP). 4 Access the MicroStrategy Web Application on SAP Web Server by specifying the following URL in the Web browser: http://MachineName:PortNumber/MicroStrategy/servlet/ mstrWeb
Preconfiguration information
This section provides the preconfiguration information necessary to deploy MicroStrategy Web Universal on your machine.
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 Operating system Application server Web server JDK Recommended Windows 2003 SP2 (on x86) Oracle Application Server 10g 10.1.3 Apache 2.x Oracle JDK 1.6.0 or 1.7.0 You can download the JDK from the following location: http://www.oracle.com/technetwork/java/index.html
299
processes used to deploy the MicroStrategy Web Universal WAR file to deploy the Mobile Server (JSP) WAR file.
1 Start the Apache Web Server. From the Start menu, point to OracleAS 10g - DEFAULT_HOME1, and then choose Start ApplicationServerName.MachineName.domain. 2 To verify that the Apache Web Server has started, open Oracle Enterprise Manager, select HTTP Server, and then click Start. 3 Select the OC4J instance where you want to deploy MicroStrategy Web Universal. This procedure assumes you are using the default instance name home. Click home. The OC4J: home page opens.
4 Select the Applications tab. 5 Click Deploy. The Deploy: Select Archive page opens. 6 In the Archive area, select Archive is present on local host. 7 Click Browse to navigate to and select the MicroStrategy.war file. If you are deploying MicroStrategy Mobile Server (JSP) instead, locate the MicroStrategyMobile.war file. Use this WAR file for the rest of the steps in this procedure. more information on locating the WAR file, see Locating the For WAR file, page 299. 8 In the Deployment Plan area, select Automatically create a new deployment plan and click Next. The Deploy: Application Attributes page opens. 9 Enter the Application Name and Context Root. This section on deploying MicroStrategy Web Universal with Oracle 10g uses MicroStrategy as the Application Name and /MicroStrategy as the Context Root. For Mobile Server Universal, this section uses MicroStrategyMobile as the Application Name and / MicroStrategyMobile as the Context Root. 10 Click Next. The Deploy: Deployment Settings page opens.
To map a user to the admin security role
The MicroStrategy Web Administrator page (mstrWebAdmin servlet) is accessible only to users with an admin security role. To control access to it, map the admin security role only to those users for whom you want to grant permission to work in the MicroStrategy Web Administrator page. In Oracle 10g, the security users and groups are defined in the Oracle Enterprise Manager. If you are deploying MicroStrategy Mobile Server (JSP) instead, you can use the same steps provided below to control access to the MicroStrategy Mobile Server Administrator page (mstrWebAdmin servlet). 11 In the Map Security Roles task name, click the Go To Task (pencil) icon. The Deployment Settings: Map Security Roles page opens. 12 For the admin security role, select the Map Role (pencil) icon. The Deployment Settings: Map Security Role: admin page opens.
301
13 Select Map selected users and groups to this role. 14 In the Map Role to Users area, in the User field, type the user name to map to the admin security role and click Add. Repeat this step to add all users for whom you want to grant permission to work in the MicroStrategy Web Administrator and Mobile Server Administrator pages. 15 Click Continue, and then click OK. You are returned to the Deploy: Deployment Settings page. 16 Click on Deploy to deploy the application. 17 Stop and restart the Apache Web Server. Any users mapped to the admin security role can now access the MicroStrategy Web Administrator and Mobile Server Administrator pages to add and connect to an Intelligence Server. For information about this, see Accessing the MicroStrategy Web Administrator or Mobile Server Administrator page below.
1 In a Web browser, access the administrator page by specifying the following URL: For Web: http://IPAddress:PortNumber/MicroStrategy/ servlet/mstrWebAdmin For Mobile Server (JSP): http://IPAddress:PortNumber/ MicroStrategyMobile/servlet/mstrWebAdmin
where IPAddress is the IP address of the Oracle machine and PortNumber is the port number used by the Oracle Application Server. The servlet name is case-sensitive, so be sure to use the correct case when typing the mstrWebAdmin name.
2 When prompted for a user name and password, specify the values you used earlier when creating the user mapped to the admin security role (see Deploying using the Oracle Enterprise Manager above). 3 After you log in, the MicroStrategy Web Administrator page appears. Add and connect to an Intelligence Server. If you are deploying MicroStrategy Mobile Server (JSP), after you are authenticated, the MicroStrategy Mobile Server Administrator page appears. Add and connect to an Intelligence Server. Once connected, click Mobile Configuration to configure your MicroStrategy Mobile applications to communicate with Mobile Server and Intelligence Server. For steps on how to define this configuration, see the MicroStrategy Mobile Design and Administration Guide. Creating a configuration completes the steps required to deploy Mobile Server (JSP). 4 You can now launch the MicroStrategy Web Universal project. For details, see Launching the project below.
303
Preconfiguration information
This section provides the preconfiguration information necessary to deploy MicroStrategy Web Universal on JBoss on your machine. This section uses the following configuration. While your setup may vary slightly, for example, you may have different versions of these applications, the overall process remains the same.
Requirement Operating system Application server JDK Recommended Windows 2008 Enterprise Edition SP2 (on x64) JBoss 5.1.x or 7.x Oracle JDK 1.6.0 or 1.7.0 You can download the JDK from the following location: http://www.oracle.com/technetwork/java/index.html
1 On your Windows machine, access the environment variables using the steps below: third-party products discussed below are manufactured by The vendors independent of MicroStrategy, and the steps to configure these products is subject to change. Refer to the appropriate
Microsoft documentation for steps to access and modify the environment variables. a From the Start menu, select Computer. The Computer dialog box opens. b Click System properties. The System dialog box opens. c Click Advanced system settings. The System Properties dialog box opens.
d Click Environment Variables. The Environment Variables dialog box opens. 2 Under System Variables, click New to create a system variable. The New System Variable dialog box opens. 3 In the Variable Name box, type JAVA_HOME. 4 In the Variable Value box, specify the destination folder where you installed the JDK and click OK. For example, if the fully qualified path to your JDK executable is C:\ jsdk1.6.0\bin\java.exe, the value of your JAVA_HOME variable is C:\jsdk1.6.0. you have installed JDK under the Program Files folder, type If Progra~1 in the destination folder; otherwise the system does not recognize the folder. For example, C:\Progra~1\jsdk1.6.0.
Installing JBoss
You can download and install JBoss from the following website: http://www.jboss.org/jbossas/downloads Keep track of the location in which you install JBoss, as this location is used later (referred to as JBOSS_HOME) to configure JBoss with a MicroStrategy Web Universal deployment.
305
which you must deploy to run the application in your application server environment. The MicroStrategy Web Universal WAR file (MicroStrategy.war) is located in the path you specified when installing MicroStrategy Web Universal. The default location when installing on 32-bit Windows environments is C:\Program Files\MicroStrategy\WebJSP. The default location when installing on 64-bit Windows environments is C:\ Program Files (x86)\MicroStrategy\WebJSP. The default location when installing on UNIX or Linux is described in Directory structure, page 143. To deploy it, you must follow a set of steps that 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.
1 Copy the MicroStrategy.war file to the JBOSS_HOME\server\ default\deploy directory. Instructions on locating the MicroStrategy.war file can be found in the previous section, Locating the WAR file, page 305. If you are deploying MicroStrategy Mobile Server (JSP) instead, locate the MicroStrategyMobile.war file. Use this WAR file for the rest of the steps in this procedure. 2 To start JBoss, browse to JBOSS_HOME\bin. Then run the following command: run.bat -b 0.0.0.0 MicroStrategy Web Universal or Mobile Server (JSP) is deployed automatically, based on the following: If you have configured JBoss to deploy an exploded WAR file, which is often the default behavior:
When deploying MicroStrategy Web Universal, a MicroStrategy folder is created within the JBOSS_HOME\server\default\ deploy directory. When deploying MicroStrategy Mobile Server (JSP), a MicroStrategyMobile folder is created within the JBOSS_HOME\ server\default\deploy directory.
If you have configured JBoss to deploy an unexploded WAR file, the configuration files are created within the systems default temporary file directory. For Windows systems, the temporary file directory is commonly defined by the TMP environment variable:
When deploying MicroStrategy Web Universal, a /microstrategy/ web-Version/ folder is created within the temporary file directory, where Version is the version number for the MicroStrategy Web Universal product. Within this folder location, various configuration files can be found within the WEB-INF folder and its subfolders. When deploying MicroStrategy Mobile Server (JSP), a / microstrategy/mobile-Version/ folder is created within the
307
temporary file directory, where Version is the version number for the MicroStrategy Mobile Server (JSP) product. Within this folder location, various configuration files can be found within the WEB-INF folder and its subfolders.
Controlling access to the MicroStrategy Web Administrator and Mobile Server Administrator pages
The MicroStrategy Web Administrator page is accessible only to users with an admin role. To create a user name and password set that is authorized to access the Administrator page, you must create the users and assign them the role of admin under the JBoss user configuration files. The steps below show you how to give a user access to the MicroStrategy Web Administrator page. If you are deploying Mobile Server (JSP), you can use the steps below to provide access to the MicroStrategy Mobile Server Administrator page.
To control access to the MicroStrategy Web Administrator and Mobile Server Administrator pages
1 Browse to the directory JBOSS_HOME\server\default\conf, where JBOSS_HOME is the location in which you installed JBoss. 2 Create the following two files within this directory:
users.properties roles.properties
3 Open the users.properties file in a text editor. 4 Include one line for each user to grant access to the Web Administrator and Mobile Server Administrator pages, using the following syntax: user_id=user_password For example, you create UserA and UserB with passwords 1234 and 5678 respectively using the following syntax: UserA=1234 UserB=5678 5 Save your changes and close the users.properties file.
6 Open the roles.properties file in a text editor. 7 Include one line for each user you included in the users.properties file and grant them administrative access, using the following syntax: user_id=admin For example, you define UserA and UserB to have administrative access using the following syntax: UserA=admin UserB=admin 8 Save your changes and close the roles.properties file. 9 To start JBoss, browse to JBOSS_HOME\bin. Then run the following command: run.bat -b 0.0.0.0 Now you can start MicroStrategy Web Administrator or Mobile Server Administrator to add and connect to an Intelligence Server. To configure MicroStrategy Web Administrator or Mobile Server Administrator, see Accessing the MicroStrategy Web Administrator or Mobile Server Administrator page, page 309.
1 In a Web browser, access the administrator page by specifying the following URL: For Web: http://localhost:8080/MicroStrategy/servlet/ mstrWebAdmin For Mobile Server (JSP): http://localhost:8080/ MicroStrategyMobile/servlet/mstrWebAdmin
The servlet names are case-sensitive. Make sure to use the correct case when typing the mstrWebAdmin name. If the application server is
309
enabled with security, a dialog box related to the administrator authentication opens. 2 When prompted for a user name and password, type the user name for the administrator user you created in the roles.properties file and the login information in the users.properties file. 3 Once you log in, the MicroStrategy Web Administrator page is displayed. Add and connect to an Intelligence Server. If you are deploying MicroStrategy Mobile Server (JSP), after you are authenticated, the MicroStrategy Mobile Server Administrator page appears. Add and connect to an Intelligence Server. Once connected, click Mobile Configuration to configure your MicroStrategy Mobile applications to communicate with Mobile Server and Intelligence Server. For steps on how to define this configuration, see the MicroStrategy Mobile Design and Administration Guide. Creating a configuration completes the steps required to deploy Mobile Server (JSP). 4 Proceed to launch the MicroStrategy Web Universal project. For more information, see Launching the project, page 310 below.
whether or not a link to Office installation information appears in the MicroStrategy Web interface. Prerequisites You must install and deploy MicroStrategy Web Services to allow the installation of MicroStrategy Office from MicroStrategy Web. For information on deploying MicroStrategy Web Services, see the MicroStrategy Office User Guide.
To specify the path to MicroStrategy Office and determine whether or not users can install MicroStrategy Office from Web
1 From the Windows Start menu, select Programs, MicroStrategy Tools, and then Web Administrator. The MicroStrategy Web Administrator page opens.
Login pages check box. When users click the 'Install MicroStrategy Office' link, a page opens with instructions on how to install MicroStrategy Office on their machine. 7 Click Save to save the settings.
You can modify these to use absolute paths, as shown in the examples below:
<parameter name="serverConfigFilesDefaultLocation" value= "ABSOLUTE:/usr/User1/MicroStrategy/xml/" /> <parameter name="serverLogFilesDefaultLocation" value= "ABSOLUTE:/usr/User1/MicroStrategy/xml/log/" />
To import data from a Salesforce.com report, you first need to configure a connection between your Salesforce.com reports and MicroStrategy Web. The steps below show you how to make Salesforce.com reports available for import into MicroStrategy Web. Prerequisites You have set up a reporting environment in Salesforce.com. You need a Salesforce.com login with developer credentials to perform some of the steps provided below. You have deployed MicroStrategy Web. In addition, you must deploy MicroStrategy Web so that it uses secure, encrypted communications. For steps to enable secure communications for your MicroStrategy Web deployment, refer to the System Administration Guide. To ensure proper numeric value integration and formatting when using Import Data, your Salesforce.com reports must use the English locale. If you use a different locale for your Salesforce.com reports, you can still integrate this data into MicroStrategy using Import Data if you connect to Salesforce.com using the MicroStrategy ODBC Driver for Salesforce. For steps to configure this type of a connection to Salesforce.com, see MicroStrategy ODBC Driver for Salesforce, page 470.
To configure a connection between Salesforce.com and MicroStrategy Web for Import Data
1 Log in to Salesforce.com by accessing https://login.salesforce.com/. 2 You must configure MicroStrategy Web as a remote access application in Salesforce.com. For the steps to define remote access applications in Salesforce.com, refer to your third-party Salesforce.com documentation. When configuring MicroStrategy Web as a remote access application in Salesforce.com, you must define the callback URL as the URL to access MicroStrategy Web, including the event 3137. Depending on how you deployed MicroStrategy Web, the syntax for this URL can take one of the following forms: For MicroStrategy Web deployments: https://WebServer/WebApplicationName/asp/ Main.aspx?evt=3137&src=Main.aspx.3137 For MicroStrategy Web Universal deployments:
313
https://WebServer:PortNumber/WebApplicationName/ servlet/mstrWeb?evt=3137&src=mstrWeb.3137 In the example URLs above: WebServer is the full domain name of your web server that is hosting MicroStrategy Web. Ensure that you use the full domain name rather than using an IP address, as using an IP address can require re-authentication when making the connection. PortNumber is the port number of your web server. WebApplicationName is the name of the MicroStrategy Web application. The default name for the MicroStrategy Web application is MicroStrategy.
3 When you save MicroStrategy Web as a remote access application, Salesforce.com provides a Consumer Key and a Consumer Secret. Save these two values as they are required later to configure the connection. 4 Access the MicroStrategy Web Administrator page. 5 On the left, click Security. The Security page is displayed. 6 In the Salesforce area, provide the following information: Consumer Key: Type the Consumer Key acquired by configuring MicroStrategy Web as a remote access application in Salesforce.com. Consumer Secret: Type the Consumer Secret acquired by configuring MicroStrategy Web as a remote access application in Salesforce.com. Callback URL: Type the MicroStrategy Web URL you used above to configure MicroStrategy Web as a remote access application in Salesforce.com.
7 Click Save to save your changes 8 Restart the web server that hosts MicroStrategy Web. The next time you log in to Web and use Import Data, Salesforce.com is now an available option. For steps to use Import Data to integrate data from Salesforce.com into MicroStrategy, refer to the Advanced Reporting Guide.
315
7
7.
Introduction
This chapter explains the setup required for the Intelligence Server Universal to execute HTML documents and Report Services documents on UNIX and Linux platforms. This chapter includes the following sections: Prerequisites, page 318 Executing documents and HTML documents in UNIX/Linux, page 318
Setup for creating and executing HTML documents, page 319 Setup for executing existing HTML documents, page 323 Setup for executing Report Services documents, page 324
317
Prerequisites
This chapter assumes the following: You are familiar with UNIX or Linux. You are familiar with MicroStrategy Developer and MicroStrategy Intelligence Server Universal. You are familiar with MicroStrategy HTML documents and Report Services documents. You have a Report Services product license if you are using Report Services documents. HTML documents do not require a Report Services product license. You have installed MicroStrategy Developer on a Windows machine. You have installed MicroStrategy Intelligence Server Universal on a UNIX or Linux machine.
Some of the steps described in this document may require root access permissions.
You must perform extra configuration steps to allow Report Services documents to support non-Western European fonts on a UNIX system. For more information, see Graph and document support of non-Western European fonts, page 526 of Appendix B, Troubleshooting.
318 Prerequisites
breaks. In addition, you can insert pictures and draw borders in the document. this chapter, the term document signifies a Report Services In document. For additional information on Report Services documents, refer to the MicroStrategy Document Creation Guide. 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. You can create dashboards and scorecards to display a group of reports within the MicroStrategy platform. HTML documents are created using MicroStrategy Developer. Before creating or executing HTML documents, you must specify the HTML document directory using the Project Configuration dialog box in MicroStrategy Developer. The HTML document directory stores HTML templates that are required by the MicroStrategy Intelligence Server Universal for executing HTML documents. You can store the HTML document directory on a UNIX or Linux platform, but you must share the directory with the Windows platform that includes MicroStrategy Developer. For more information on setting up the HTML document directory on a UNIX or Linux platform, see Setup for creating and executing HTML documents, page 319. additional information on HTML documents, see the HTML For Documents chapter in the MicroStrategy Advanced Reporting Guide.
319
For the procedure of setting up an HTML document directory between Windows and UNIX and Linux computers below, the following assumptions are made: You have installed MicroStrategy Developer on a Windows computer and installed MicroStrategy Intelligence Server Universal on a UNIX or Linux computer.
MicroStrategy Developer users have at least read permissions to the HTML document directory for executing existing HTML documents. Write permissions to the directory are required for MicroStrategy Developer users to create new HTML documents. For the file paths described in the procedure below, machine-name is used to represent the name of the machine you store the HTML document directory on. For example, if you store the directory on a machine named UNIX1, machine-name should be replaced with UNIX1. This machine must have Samba installed to provide access to the folder on a Windows computer. You must have root permissions on any UNIX or Linux computer used to set up the HTML document directory. This includes the computer that stores the HTML document directory as well as any computer that must be setup to access the directory.
1 Create a directory to hold the HTML document directory on the desired UNIX or Linux computer. This procedure assumes that the path of the HTML document directory is machine-name:/share/ htmldocuments. This is the machine that is referenced as machine-name in the steps below. To create this directory, enter the commands below: # cd / # mkdir share # cd share # mkdir htmldocuments 2 Install Samba software on the UNIX or Linux computer that you created the HTML documents directory in the step above. With this software, the HTML documents directory is accessible to the Windows computer with
320 Executing documents and HTML documents in UNIX/Linux
MicroStrategy Developer installed. You can get the latest version of Samba at http://www.samba.org. that Samba uses a .org extension and not the more Notice common .com extension. Using a .com extension takes you to an incorrect website. 3 Share the directory machine-name:/share across the network through NFS. For example, you must share UNIX1:/share. Make sure read and write permissions are set for the share. This step allows other UNIX/ Linux computers to access the directory. 4 Create a Samba share, named share, with read and write permissions that points to the directory machine-name:/share. For example, you must share UNIX1:/share.This step allows Windows computers to access the directory. The Samba share is created in the Samba smb.conf file. For specific instructions on how to setup a Samba share, refer to the Samba website at http://www.samba.org. 5 Restart Samba. 6 Mount the HTML document directory on the computer that has the Intelligence Server installed on it. Root privileges are required for this. On the computer with Intelligence Server, 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 (#). Perform the commands below: the commands below, machine-name refers to the machine In name of the computer where you stored the HTML documents directory and created an NFS and Samba share. This may be a different name than the computer that you are mounting the directory on. final mount command contains a space between / The htmldocuments and /machine-name. cd / mkdir machine-name cd machine-name mkdir share cd share
321
mkdir htmldocuments cd / mount machine-name:/share/htmldocuments / machine-name/share/htmldocuments 7 You can cache the connection to the UNIX/Linux HTML documents directory from the Windows computer so that you are not prompted for authentication each time the directory is accessed: a From the Windows computer that has MicroStrategy Developer installed, click Start, and select Run. The Run dialog box opens. b Type \\machine-name\share\htmldocuments, and click OK to open the top-level shared HTML documents directory. For example, type \\UNIX1\share\htmldocuments.
d Click OK to accept the changes. 9 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. If you stored XSL files in a different directory or did not copy them from their original default directory, you must copy them into the new xsls directory. For example, the default HTML document directory for the Tutorial project is Program Files\MicroStrategy\ Tutorial Reporting. 10 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. You are now ready to create and execute your HTML documents. Remember to create your HTML documents in the HTML document directory, otherwise, Intelligence Server cannot execute the HTML documents correctly.
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/
323
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 by each HTML document in an appropriate directory under /machine-name/share/ htmldocuments. For example, if the location of the image file in the source code is \ images\myimage.gif, then copy myimage.gif to /machine-name/ share/htmldocuments/images. If the location of the XSL file in the source code is \myimage.gif, then copy myimage.gif to / machine-name/share/htmldocuments. You are now ready to execute your HTML documents.
This occurs because the fonts required by the PDF component are missing from UNIX and Linux machines running Intelligence Server Universal. The missing fonts may include Microsoft True Type fonts. does not distribute or license Microsoft fonts, and MicroStrategy therefore cannot package Microsoft fonts with Intelligence Server Universal. To resolve this issue, you must install the font files in the PDFGeneratorFiles folder within the MicroStrategy installation path on the UNIX or Linux machine, as described below.
324 Executing documents and HTML documents in UNIX/Linux
2013 MicroStrategy, Inc.
1 Log in to your UNIX or Linux machine that hosts Intelligence Server Universal. 2 Install the Microsoft True Type fonts. Refer to the following resources for information on licensing requirements for and installing Microsoft True Type fonts: http://www.microsoft.com/typography/RedistributionFAQ.mspx http://www.ascendercorp.com/msfonts/msfonts_main.html http://corefonts.sourceforge.net/
3 Copy the font files into the INSTALL_PATH/PDFGeneratorFiles directory, where INSTALL_PATH is the directory you specified as the MicroStrategy install directory during installation. 4 To update the list of fonts available, you must restart the Intelligence Server.
325
8
8.
Introduction
This chapter explains the various possibilities for performing fully automated and unattended installations within the MicroStrategy platform. This includes customizations to the installation 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
This chapter provides the following information: The different types of installations that can be performed with MicroStrategy products.
327
How to perform a fully automated MicroStrategy installation by modifying various installation parameters in Windows ini-like response files. 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.
and silent installations require advanced techniques such Automated as creating and running response.ini files. Therefore, automated and silent installations should be handled by system administrators with full knowledge of the environment and the desired MicroStrategy installation. Before installing MicroStrategy products, you should refer to Chapter 1, Planning Your Installation for important pre-installation information.
The default location for the install.log file is: 32-bit Windows environments: Program Files\Common Files\ MicroStrategy 64-bit Windows environments: Program Files (x86)\ Common Files\MicroStrategy
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 to install MicroStrategy, page 330 for more information.
Methods of installation
The installation methods discussed in this chapter are: Installing and configuring with a response.ini file, page 329 Silent installation, page 373
329
The response.ini file specifies all the selections you want to make during the installation in the MicroStrategy Installation Wizard. You can either run it with all the MicroStrategy Installation 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 MicroStrategy Installation Wizard 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 373.
Component dependencies
When you use a response.ini file to install MicroStrategy products, there are some key dependencies among separate components you should be aware of. The products listed below require either pre-installed software or certain MicroStrategy components to be selected to successfully install the products with a response.ini file: MicroStrategy Narrowcast Server Administrator requires SequeLink ODBC Socket Server to be included in the installation. MicroStrategy Narrowcast Server Subscription Portal requires SequeLink ODBC Socket Server to be included in the installation. MicroStrategy Function Plug-in Wizard requires Microsoft Visual C++ to be installed before running your response.ini file. MicroStrategy Analytic Modules requires MicroStrategy Developer or a combination of MicroStrategy Analyst and MicroStrategy Architect to be included in the installation.
2013 MicroStrategy, Inc.
MicroStrategy Office can be installed along with other MicroStrategy components by using a response.ini file. However, you can also install MicroStrategy Office as its own stand-alone installation, which lets you install only MicroStrategy Office. For information on using the stand-alone installation of MicroStrategy Office, including performing the installation silently, see Silent installation of MicroStrategy Office, page 377.
Installer
Options [Installer] HideAllDialogs = Description Section that begins the installation. 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. Location where the install.log file is generated. If left empty, it takes the default location and file name of: 32-bit Windows environments: C:\Program Files\ Common Files\MicroStrategy\install.log. 64-bit Windows environments: C:\ Program Files (x86)\Common Files\ MicroStrategy\install.log. TRUE or FALSE. TRUE creates the shortcuts for MicroStrategy products, tools, and documentation. The default is TRUE.
LogFile =
CreateShortcuts =
331
Options PreventReboot =
Description 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. TRUE or FALSE. TRUE reboots the machine after the installation is done. The default is FALSE. TRUE or FALSE. If you select FALSE, the 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. TRUE or FALSE. When using silent install, set to FALSE to prevent the Configuration Wizard from coming up after reboot. The default is TRUE. TRUE or FALSE. Set this option to specify whether to run the Configuration Wizard. The default is FALSE. Specify the name of the response file for 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 your installation with a response.ini file, page 370.
ForceReboot = EnterpriseManagerOverwrite =
ShowConfigWizard =
RunConfigWizard = ConfigWizardResponseFile =
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. TRUE or FALSE. Set this option to stop Internet Information Services (IIS) during installation. The default is FALSE. TRUE or FALSE. This option overwrites the Analytics Modules from a previous install. The default is FALSE. TRUE or FALSE. Set this option to overwrite the Delivery Tutorial from a previous installation. The default is FALSE.
Options CheckRenameOperations =
Description TRUE or FALSE. In some instances, as a 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. TRUE or FALSE. Set this option to enable the ASP.NET MicroStrategy Web Services extensions that IIS Admin requires. The default is FALSE. TRUE or FALSE. Set this option to enable the ASP MicroStrategy Web Services extensions that IIS Admin requires. The default is FALSE. 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. TRUE or FALSE. Set to TRUE to create new properties files. These files are related to the Tutorial Delivery component. The default is FALSE, which uses the current version of the properties files. The default is FALSE. TRUE or FALSE. Set to TRUE to check that the TCP/IP network protocol is active. If set to FALSE, the setup doesn't check for it. The default is TRUE. TRUE or FALSE. Set to TRUE to check for Internet Information Services. The default is TRUE. TRUE or FALSE. Set to TRUE to stop all services required to be stopped to complete a MicroStrategy installation. If set to FALSE, the user is prompted if services need to be stopped. The default is TRUE.
EnableASPNETServices =
EnableASPServices =
ShowWelcomeScreen =
PropertiesFilesOverwrite=
CheckTCPIP=
CheckIIS= StopAllServices=
333
Paths
Options [InitialPaths] COMMONFILES = Description Section for specifying the path for the products that you select to install. 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: 32-bit Windows environments: C:\Program Files\ Common Files\MicroStrategy 64-bit Windows environments: C:\Program Files (x86)\ Common Files\MicroStrategy Location where Developer will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Desktop 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Desktop Location where Object Manager will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Object Manager 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Object Manager Location where Command Manager will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Command Manager 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Command Manager Location where Enterprise Manager will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Enterprise Manager 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Enterprise Manager Location where the MicroStrategy Intelligence Server will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Intelligence Server 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Intelligence Server Location where MicroStrategy Web will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Web ASPx 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Web ASPx
Developer =
ObjectManager =
CommandManager =
EnterpriseManager =
Server =
Web =
Options WebUniversal =
Description Location where MicroStrategy Web Universal will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Web JSP 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Web JSP Location where MicroStrategy Web Services will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Web Services 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Web Services Location where MicroStrategy Web Services Universal will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Web Services JSP 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Web Services JSP Location where MicroStrategy Office will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Office 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Office Location where MicroStrategy Tutorial - Reporting will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Tutorial Reporting 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Tutorial Reporting Location where the Analytics Modules will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Analytics Modules 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Analytics Modules Location where the Narrowcast Server Delivery Engine will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Narrowcast Server\Delivery Engine 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Narrowcast Server\Delivery Engine
WebServices =
WebServicesUniversal =
Office =
TutorialReporting =
AnalyticsModules =
NCSAdminDeliveryEngine =
335
Options SubscriptionPortal =
Description Location where the Subscription Portal will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Narrowcast Server\ Subscription Portal 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Narrowcast Server\ Subscription Portal Location where MicroStrategy Tutorial - Delivery will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Narrowcast Server\Tutorial 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Narrowcast Server\Tutorial Location where MicroStrategy Integrity Manager will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Integrity Manager 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Integrity Manager Location where MicroStrategy Mobile will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Mobile Clients 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Mobile Clients Location where MicroStrategy Mobile Server ASP.NET will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Mobile Server ASPx 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Mobile Server ASPx Location where MicroStrategy Mobile Server JSP will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Mobile Server JSP 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Mobile Server JSP Location where MicroStrategy Portlets will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\Portlets 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\Portlets
TutorialDelivery =
IntegrityManager =
Mobile =
MobileASPPath =
MobileJSPPath =
Portlets =
Options MDXCubeProvider =
Description Location where the MicroStrategy MDX Cube Provider will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\MDX Cube Provider 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\MDX Cube Provider Location where the MicroStrategy GIS Connectors will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\GISConnectors 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\GISConnectors Location where the MicroStrategy System Manager will be installed. If left empty, it takes the default location of: 32-bit Windows environments: C:\Program Files\ MicroStrategy\SystemManager 64-bit Windows environments: C:\Program Files (x86)\ MicroStrategy\SystemManager
GISConnectors =
SystemManager =
337
Description The name of the company for which the software is registered. The default is the company name in the registry. Specify the license key for the software. If you do not specify the license key, the MicroStrategy Installation 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.
Options CommandManagerVisible = DeliveryEngineVisible = DeveloperVisible = AnalystVisible = EnterpriseManagerVisible = FunctionPluginVisible = GISConnectorsVisible = IntegrityManagerVisible = IServerDistributionServicesVisible = IServerOLAPServicesVisible = IServerReportServicesVisible = IServerTransactionServicesVisible = IServerVisible = MobileClientVisible = MobileServerASPVisible = MobileServerJSPVisible = MobileVisible = NCSAdminVisible = ObjectManagerVisible = OfficeVisible = PortletsVisible = SequeLinkVisible = ServerAdminVisible = SubscriptionPortalVisible = SystemManagerVisible = MDXCubeProviderVisible = TutorialDeliveryConfigureVisible = TutorialDeliveryInstallVisible = WebAnalystVisible = WebProfessionalVisible =
Description MicroStrategy Command Manager MicroStrategy Delivery Engine MicroStrategy Developer MicroStrategy Analyst MicroStrategy Enterprise Manager MicroStrategy Function Plug-In Wizard MicroStrategy GIS Connectors MicroStrategy Integrity Manager MicroStrategy Distribution Services MicroStrategy OLAP Services MicroStrategy Report Services MicroStrategy Transaction Services MicroStrategy Intelligence Server MicroStrategy Mobile for BlackBerry client MicroStrategy Mobile Server (ASP.NET) MicroStrategy Mobile Server (JSP) MicroStrategy Mobile MicroStrategy Narrowcast Administrator MicroStrategy Object Manager MicroStrategy Office MicroStrategy Portlets SequeLink ODBC Socket Server MicroStrategy Server Administrator MicroStrategy Subscription Portal MicroStrategy System Manager MicroStrategy MDX Cube Provider MicroStrategy Tutorial - Delivery Configuration MicroStrategy Tutorial - Delivery Installation MicroStrategy Web Analyst MicroStrategy Web Professional
339
Description MicroStrategy Web Reporter MicroStrategy Web Server (ASP.NET) MicroStrategy Web Server (JSP) MicroStrategy Web Services (ASP.NET) MicroStrategy Web Services Universal (JSP)
During the installation process in the MicroStrategy Installation 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, the installation always uses the most recent selection from a previous install. means that if you have a product installed and you do not specify This a TRUE or FALSE value, the product is upgraded. 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 AnalyticsModulesSelect = ArchitectSelect = CommandManagerSelect = DeliveryEngineSelect = DeveloperSelect = AnalystSelect = EnterpriseManagerSelect = FunctionPluginSelect = GISConnectorsSelect = IntegrityManagerSelect = IServerDistributionServicesSelect = IServerOLAPServicesSelect = IServerReportServicesSelect = IServerSelect = Description MicroStrategy Analytics Modules MicroStrategy Architect MicroStrategy Command Manager MicroStrategy Delivery Engine MicroStrategy Developer MicroStrategy Analyst MicroStrategy Enterprise Manager MicroStrategy Function Plug-In Wizard MicroStrategy GIS Connectors MicroStrategy Integrity Manager MicroStrategy Distribution Services MicroStrategy OLAP Services MicroStrategy Report Services MicroStrategy Intelligence Server
Options IServerTransactionServicesSelect = MobileClientSelect = MobileSelect = MobileServerASPSelect = MobileServerJSPSelect = NCSAdminSelect = ObjectManagerSelect = OfficeSelect = PortletsSelect = SequeLinkSelect = ServerAdminSelect = SubscriptionPortalSelect = SystemManagerSelect = MDXCubeProviderSelect = TutorialDeliveryConfigureSelect = TutorialDeliveryInstallSelect = WebAnalystSelect = WebProfessionalSelect = WebReporterSelect = WebServerASPNETSelect = WebServerJSPSelect = WebServicesASPNETSelect = WebServicesJSPSelect =
Description MicroStrategy Transaction Services MicroStrategy Mobile BlackBerry client MicroStrategy Mobile MicroStrategy Mobile Server (ASP.NET) MicroStrategy Mobile Server (JSP) MicroStrategy Narrowcast Administrator MicroStrategy Object Manager MicroStrategy Office MicroStrategy Portlets SequeLink ODBC Socket Server MicroStrategy Server Administrator MicroStrategy Subscription Portal MicroStrategy System Manager MicroStrategy MDX Cube Provider MicroStrategy Tutorial - Delivery Configuration MicroStrategy Tutorial - Delivery Installation MicroStrategy Web Analyst MicroStrategy Web Professional MicroStrategy Web Reporter MicroStrategy Web Server (ASP.NET) MicroStrategy Web Server JSP MicroStrategy Web Services (ASP.NET) MicroStrategy Web Services Universal (JSP)
341
Installation Files
Options [IODSourceLocation] Description Section specifying the location of the files required to install the MicroStrategy components you have selected for installation. Specifying the location of the installation files is only required if you have downloaded only a subset of the MicroStrategy installation files and stored some of the files in another location. For steps to determine the files required for your installation, see Creating custom installation packages, page 96. Determines whether the required installation files are provided in a folder or at a URL. You must define this parameter with one of the following values: FILESERVER: Type this value if the required installation files are stored in a folder on the local machine or a server machine. You must also provide the location of the files using the SourceLocation parameter. HTTP: Type this value if the required installation files are stored at an unsecured URL. You must also provide the location of the files using the URL parameter. HTTPS: Type this value if the required installation files are stored at a secured URL. You must also provide the location of the files using the URL parameter, as well as the user name and password to access the URL using the UserName and Password parameters. Location of the folder that stores any required installation files. Type the location of the local file path. If you store the files in a local folder, do not provide a location in the URL parameter. Location of the URL for the HTTP or HTTPS location that stores any required installation files. Type the URL for the location that stores any required installation files. If you store the files at an HTTP or HTTPS location, do not provide a location in the SourceLocation parameter. If you retrieve the installation files from a URL location, type a user name that has access to the URL location. If there is no login required to the URL or you retrieve the installation files from a local folder, you can leave this field blank. If you retrieve the installation files from a URL location, type a password for the user name. If there is no login required to the URL or you retrieve the installation files from a local folder, you can leave this field blank.
Style =
SourceLocation =
URL =
UserName =
Password =
Description Enter a name for the virtual directory. The default is MicroStrategy. 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.
RemoveVD =
[HealthCenterService Section that configures the machine running the silent installation as a Health Agent. Account] HideDialog = Port = AccessCode =
TRUE or FALSE. FALSE displays the dialog box. The default is FALSE. Type the port number to use to connect to the Health Agent machine. The default port is 44440. Type the access code that must be provided by Health Center to access this Health Agent. If you leave this field blank, no access code is required to access this Health Agent. Health Agent, and you must supply the other information. The default is TRUE, which skips the configuration of the machine as a Health Agent.
Domain =
Type the domain of a Windows login with full administrative privileges under which to run the Health Center service.
343
Options
Description Type the user name of a Windows login with full administrative privileges under which to run the Health Center service. Warning: The user account used to run Health Center must have full administrator privileges for the local machine. If the administrator default privileges have been modified for the user account, connection errors can occur.
Login =
Password =
HideDialog = SkipAccountSetting =
345
Options SkipAccountSetting =
Description 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.
Enter the domain where the account is located. Enter the user name of the account to use. Enter the password for the account.
URL =
Options ConfigureWord =
Description 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. 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.
ConfigurePowerpoint =
347
[Welcome]
348 Installing and configuring with a response.ini file
2013 MicroStrategy, Inc.
HideDialog=TRUE RemoveAll=FALSE [UserRegistration] HideDialog=TRUE UserName=<UserNameHere> CompanyName=<CompanyNameHere> LicenseKey=<CustomerLicenseKeyHere> [SuiteTarget] HideDialog=TRUE TargetDirectory=C:\Program Files\MicroStrategy [ComponentSelection] HideDialog=TRUE ### Visible Components ### DeveloperVisible=TRUE AnalystVisible=TRUE ArchitectVisible=TRUE ServerAdminVisible=TRUE FunctionPluginVisible=FALSE CommandManagerVisible=TRUE EnterpriseManagerVisible=TRUE ObjectManagerVisible=TRUE IntegrityManagerVisible=TRUE IServerVisible=TRUE IServerOLAPServicesVisible=TRUE IServerReportServicesVisible=TRUE IServerDistributionServicesVisible=TRUE IServerTransactionServicesVisible=TRUE WebAnalystVisible=TRUE WebProfessionalVisible=TRUE WebReporterVisible=TRUE WebServerASPNETVisible=TRUE WebServerJSPVisible=FALSE WebServicesASPNETVisible=TRUE WebServicesJSPVisible=FALSE OfficeVisible=TRUE MobileVisible=TRUE MobileClientVisible=TRUE MobileServerASPVisible=TRUE MobileServerJSPVisible=FALSE AnalyticsModulesVisible=TRUE NCSAdminVisible=TRUE DeliveryEngineVisible=TRUE
349
SubscriptionPortalVisible=TRUE TutorialDeliveryInstallVisible=TRUE TutorialDeliveryConfigureVisible=TRUE SequeLinkVisible=TRUE PortletsVisible=TRUE MDXCubeProviderVisible=TRUE GISConnectorsVisible=TRUE SystemManagerVisible=TRUE ### Components To Install (TRUE) or Remove(FALSE) ### DeveloperSelect=TRUE AnalystSelect=TRUE ArchitectSelect=TRUE ServerAdminSelect=TRUE FunctionPluginSelect=FALSE CommandManagerSelect=TRUE EnterpriseManagerSelect=TRUE ObjectManagerSelect=TRUE IntegrityManagerSelect=TRUE IServerSelect=TRUE IServerOLAPServicesSelect=TRUE IServerReportServicesSelect=TRUE IServerDistributionServicesSelect=TRUE IServerTransactionServicesSelect=TRUE WebAnalystSelect=TRUE WebProfessionalSelect=TRUE WebReporterSelect=TRUE WebServerASPNETSelect=TRUE WebServerJSPSelect=FALSE WebServicesASPNETSelect=TRUE WebServicesJSPSelect=FALSE OfficeSelect=TRUE MobileSelect=TRUE MobileClientSelect=TRUE MobileServerASPSelect=TRUE MobileServerJSPSelect=FALSE AnalyticsModulesSelect=TRUE NCSAdminSelect=TRUE DeliveryEngineSelect=TRUE SubscriptionPortalSelect=TRUE TutorialDeliveryInstallSelect=TRUE TutorialDeliveryConfigureSelect=TRUE SequeLinkSelect=TRUE PortletsSelect=TRUE MDXCubeProviderSelect=TRUE
GISConnectorsSelect=TRUE SystemManagerSelect=TRUE [ServerDefinitionSetting] HideDialog=TRUE OverwriteServerDefinition=FALSE [HealthCenterServiceAccount] HideDialog=TRUE Port=<PortNumber> AccessCode=<AccessCode> SkipAccountSetting=FALSE Domain=<WindowsLoginDomain> Login=<WindowsLogin> Password=<WindowsLoginPassword> [AnalyticsSetting] HideDialog=TRUE OverwriteDSN=FALSE [WebVirtualDirectory] HideDialog=TRUE VirtualDirectory=MicroStrategy ReconfigureVirtualDirectory=TRUE [MobileVirtualDirectory] HideDialog=TRUE VirtualDirectory=MicroStrategyMobile ReconfigureVirtualDirectory=TRUE [PortalVirtualDirectory] HideDialog=TRUE VirtualDirectory=NarrowcastServer ReconfigureVirtualDirectory=TRUE [WebServicesVirtualDirectory] HideDialog=TRUE VirtualDirectory=MicroStrategyWS ReconfigureVirtualDirectory=TRUE [OfficeWebServicesURL] HideDialog=TRUE AllowBlankURL=FALSE URL=http://localhost/MicroStrategyWS/mstrws.asmx [MSOfficeLoadOptions]
351
HideDialog=TRUE ConfigureExcel=TRUE ConfigurePowerpoint=TRUE ConfigureWord=TRUE [IServerServiceAccount] HideDialog=TRUE SkipAccountSetting=FALSE Login=<NT_UserLoginHere> Password=<UserPasswordHere> Domain=<DomainHere> ServiceStartUp=AUTO [NarrowcastServiceAccount] HideDialog=TRUE SkipAccountSetting=FALSE Login=<NT_UserLoginHere> Password=<UserPasswordHere> Domain=<DomainHere> [Summary] HideDialog=TRUE [Finish] HideDialog=TRUE Copy and paste this example to create a response.ini file. Replace any text between angled brackets (<>) with your own specific information. For example, change UserName=UserNameHere to UserName=jsmith. Make sure you check for correct spaces and new lines in all file paths. license key determines which MicroStrategy components will be Your available for your installation. For example, if your license key does not include MicroStrategy OLAP Services, then you cannot use IServerOLAPServicesSelect=TRUE and IServerOLAPServicesVisible=TRUE to install these components.
Example of a response.ini file: Installs Intelligence Server, Enterprise Manager, and other components
[Installer] HideAllDialogs=TRUE ForceReboot=TRUE StopAllServices=TRUE StopIIS=TRUE
352 Installing and configuring with a response.ini file
2013 MicroStrategy, Inc.
EnterpriseManagerOverwrite=TRUE [Welcome] HideDialog=TRUE RemoveAll=FALSE [UserRegistration] HideDialog=TRUE UserName=<UserNameHere> CompanyName=<CompanyNameHere> LicenseKey=<CustomerLicenseKeyHere> [SuiteTarget] HideDialog=TRUE TargetDirectory=C:\Program Files\MicroStrategy [ComponentSelection] HideDialog=TRUE ### Visible Components ### ServerAdminVisible=TRUE CommandManagerVisible=TRUE EnterpriseManagerVisible=TRUE ObjectManagerVisible=TRUE IServerVisible=TRUE IServerOLAPServicesVisible=TRUE IServerReportServicesVisible=TRUE IServerDistributionServicesVisible=TRUE IServerTransactionServicesVisible=TRUE IntegrityManagerVisible=TRUE SystemManagerVisible=TRUE DeveloperVisible=FALSE AnalystVisible=FALSE ArchitectVisible=FALSE FunctionPluginVisible=FALSE WebAnalystVisible=FALSE WebProfessionalVisible=FALSE WebReporterVisible=FALSE WebServerASPNETVisible=FALSE WebServerJSPVisible=FALSE WebServicesASPNETVisible=FALSE WebServicesJSPVisible=FALSE OfficeVisible=FALSE MobileVisible=FALSE MobileClientVisible=FALSE MobileServerASPVisible=FALSE
2013 MicroStrategy, Inc. Installing and configuring with a response.ini file
353
MobileServerJSPVisible=FALSE AnalyticsModulesVisible=FALSE NCSAdminVisible=FALSE DeliveryEngineVisible=FALSE SubscriptionPortalVisible=FALSE TutorialDeliveryInstallVisible=FALSE TutorialDeliveryConfigureVisible=FALSE SequeLinkVisible=FALSE PortletsVisible=FALSE MDXCubeProviderVisible=FALSE GISConnectorsVisible=FALSE ### Components To Install (TRUE) or Remove (FALSE) ### ServerAdminSelect=TRUE CommandManagerSelect=TRUE EnterpriseManagerSelect=TRUE ObjectManagerSelect=TRUE IServerSelect=TRUE IServerOLAPServicesSelect=TRUE IServerReportServicesSelect=TRUE IServerDistributionServicesSelect=TRUE IServerTransactionServicesSelect=TRUE IntegrityManagerSelect=TRUE SystemManagerSelect=TRUE DeveloperSelect=FALSE AnalystSelect=FALSE ArchitectSelect=FALSE FunctionPluginSelect=FALSE WebAnalystSelect=FALSE WebProfessionalSelect=FALSE WebReporterSelect=FALSE WebServerASPNETSelect=FALSE WebServerJSPSelect=FALSE WebServicesASPNETSelect=FALSE WebServicesJSPSelect=FALSE OfficeSelect=FALSE MobileSelect=FALSE MobileClientSelect=FALSE MobileServerASPSelect=FALSE MobileServerJSPSelect=FALSE AnalyticsModulesSelect=FALSE NCSAdminSelect=FALSE DeliveryEngineSelect=FALSE SubscriptionPortalSelect=FALSE TutorialDeliveryInstallSelect=FALSE
TutorialDeliveryConfigureSelect=FALSE SequeLinkSelect=FALSE PortletsSelect=FALSE MDXCubeProviderSelect=FALSE GISConnectorsSelect=FALSE [IServerServiceAccount] HideDialog=TRUE SkipAccountSetting=FALSE Login=<UserName> Password=<Password> Domain=<Domain> ServiceStartUp=AUTO [Summary] HideDialog=TRUE [Finish] HideDialog=TRUE Copy and paste this example to create a response.ini file. Replace any text between angled brackets (<>) with your own specific information. For example, change UserName=<UserNameHere> to UserName=jsmith. Make sure to check that all file paths are entered with correct spacing. license key determines which MicroStrategy components will be Your available for your installation. For example, if your license key does not include MicroStrategy OLAP Services, then you cannot use IServerOLAPServicesSelect=TRUE and IServerOLAPServicesVisible=TRUE to install these components.
355
[SuiteTarget] HideDialog=TRUE TargetDirectory=C:\Program Files\MicroStrategy [ComponentSelection] HideDialog=TRUE ### Visible Components ### ServerAdminVisible=TRUE IServerVisible=TRUE IServerOLAPServicesVisible=TRUE IServerReportServicesVisible=TRUE IServerDistributionServicesVisible=TRUE IServerTransactionServicesVisible=TRUE CommandManagerVisible=FALSE EnterpriseManagerVisible=FALSE ObjectManagerVisible=FALSE IntegrityManagerVisible=FALSE DeveloperVisible=FALSE AnalystVisible=FALSE ArchitectVisible=FALSE FunctionPluginVisible=FALSE WebAnalystVisible=FALSE WebProfessionalVisible=FALSE WebReporterVisible=FALSE WebServerASPNETVisible=FALSE WebServerJSPVisible=FALSE WebServicesASPNETVisible=FALSE WebServicesJSPVisible=FALSE OfficeVisible=FALSE MobileVisible=FALSE MobileClientVisible=FALSE MobileServerASPVisible=FALSE MobileServerJSPVisible=FALSE AnalyticsModulesVisible=FALSE NCSAdminVisible=FALSE DeliveryEngineVisible=FALSE SubscriptionPortalVisible=FALSE TutorialDeliveryInstallVisible=FALSE
TutorialDeliveryConfigureVisible=FALSE SequeLinkVisible=FALSE PortletsVisible=FALSE MDXCubeProviderVisible=FALSE GISConnectorsVisible=FALSE SystemManagerVisible=FALSE ### Components To Install (TRUE) or Remove (FALSE) ### ServerAdminSelect=TRUE IServerSelect=TRUE IServerOLAPServicesSelect=TRUE IServerReportServicesSelect=TRUE IServerDistributionServicesSelect=TRUE IServerTransactionServicesSelect=TRUE CommandManagerSelect=FALSE EnterpriseManagerSelect=FALSE ObjectManagerSelect=FALSE IntegrityManagerSelect=FALSE DeveloperSelect=FALSE AnalystSelect=FALSE ArchitectSelect=FALSE FunctionPluginSelect=FALSE WebAnalystSelect=FALSE WebProfessionalSelect=FALSE WebReporterSelect=FALSE WebServerASPNETSelect=FALSE WebServerJSPSelect=FALSE WebServicesASPNETSelect=FALSE WebServicesJSPSelect=FALSE OfficeSelect=FALSE MobileSelect=FALSE MobileClientSelect=FALSE MobileServerASPSelect=FALSE MobileServerJSPSelect=FALSE AnalyticsModulesSelect=FALSE NCSAdminSelect=FALSE DeliveryEngineSelect=FALSE SubscriptionPortalSelect=FALSE TutorialDeliveryInstallSelect=FALSE TutorialDeliveryConfigureSelect=FALSE SequeLinkSelect=FALSE PortletsSelect=FALSE MDXCubeProviderSelect=FALSE GISConnectorsSelect=FALSE
357
SystemManagerSelect=FALSE [IServerServiceAccount] HideDialog=TRUE SkipAccountSetting=FALSE Login=<UserName> Password=<Password> Domain=<Domain> ServiceStartUp=AUTO [Summary] HideDialog=TRUE [Finish] HideDialog=TRUE Copy and paste this example to create a response.ini file. Replace any text between angled brackets (<>) with your own specific information. For example, change UserName=<UserNameHere> to UserName=jsmith. Make sure to check that all file paths are entered with correct spacing. license key determines which MicroStrategy components will be Your available for your installation. For example, if your license key does not include MicroStrategy OLAP Services, then you cannot use IServerOLAPServicesSelect=TRUE and IServerOLAPServicesVisible=TRUE to install these components.
UserName=<UserNameHere> CompanyName=<CompanyNameHere> LicenseKey=<CustomerLicenseKeyHere> [SuiteTarget] HideDialog=TRUE TargetDirectory=C:\Program Files\MicroStrategy [ComponentSelection] HideDialog=TRUE ### Visible Components ### WebReporterVisible=TRUE WebAnalystVisible=TRUE WebProfessionalVisible=TRUE WebServerASPNETVisible=TRUE WebServerJSPVisible=TRUE WebServicesASPNETVisible=TRUE WebServicesJSPVisible=TRUE ServerAdminVisible=FALSE IServerVisible=FALSE IServerOLAPServicesVisible=FALSE IServerReportServicesVisible=FALSE IServerDistributionServicesVisible=FALSE IServerTransactionServicesVisible=FALSE CommandManagerVisible=FALSE EnterpriseManagerVisible=FALSE ObjectManagerVisible=FALSE IntegrityManagerVisible=FALSE DeveloperVisible=FALSE AnalystVisible=FALSE ArchitectVisible=FALSE FunctionPluginVisible=FALSE OfficeVisible=FALSE MobileVisible=FALSE MobileClientVisible=FALSE MobileServerASPVisible=FALSE MobileServerJSPVisible=FALSE AnalyticsModulesVisible=FALSE NCSAdminVisible=FALSE DeliveryEngineVisible=FALSE SubscriptionPortalVisible=FALSE TutorialDeliveryInstallVisible=FALSE TutorialDeliveryConfigureVisible=FALSE SequeLinkVisible=FALSE PortletsVisible=FALSE
359
MDXCubeProviderVisible=FALSE GISConnectorsVisible=FALSE SystemManagerVisible=FALSE ### Components To Install (TRUE) or Remove (FALSE) ### WebReporterSelect=TRUE WebAnalystSelect=TRUE WebProfessionalSelect=TRUE WebServerASPNETSelect=TRUE WebServerJSPSelect=TRUE WebServicesASPNETSelect=TRUE WebServicesJSPSelect=TRUE ServerAdminSelect=FALSE IServerSelect=FALSE IServerOLAPServicesSelect=FALSE IServerReportServicesSelect=FALSE IServerDistributionServicesSelect=FALSE IServerTransactionServicesSelect=FALSE CommandManagerSelect=FALSE EnterpriseManagerSelect=FALSE ObjectManagerSelect=FALSE IntegrityManagerSelect=FALSE DeveloperSelect=FALSE AnalystSelect=FALSE ArchitectSelect=FALSE FunctionPluginSelect=FALSE OfficeSelect=FALSE MobileSelect=FALSE MobileClientSelect=FALSE MobileServerASPSelect=FALSE MobileServerJSPSelect=FALSE AnalyticsModulesSelect=FALSE NCSAdminSelect=FALSE DeliveryEngineSelect=FALSE SubscriptionPortalSelect=FALSE TutorialDeliveryInstallSelect=FALSE TutorialDeliveryConfigureSelect=FALSE SequeLinkSelect=FALSE PortletsSelect=FALSE MDXCubeProviderSelect=FALSE GISConnectorsSelect=FALSE SystemManagerSelect=FALSE [WebVirtualDirectory] HideDialog=TRUE
360 Installing and configuring with a response.ini file
2013 MicroStrategy, Inc.
VirtualDirectory=MicroStrategy ReconfigureVirtualDirectory=TRUE [WebServicesVirtualDirectory] HideDialog=TRUE VirtualDirectory=MicroStrategyWS ReconfigureVirtualDirectory=TRUE [Summary] HideDialog=TRUE [Finish] HideDialog=TRUE Copy and paste this example to create a response.ini file. Replace any text between angled brackets (<>) with your own specific information. For example, change UserName=<UserNameHere> to UserName=jsmith. Make sure to check that all file paths are entered with correct spacing. license key determines which MicroStrategy components will be Your available for your installation. For example, if your license key does not include MicroStrategy Web Reporter, then you cannot use WebReporterVisible=TRUE and WebReporterSelect=TRUE to install these components.
361
TargetDirectory=C:\Program Files\MicroStrategy [ComponentSelection] HideDialog=TRUE ### Visible Components ### EnterpriseManagerVisible=TRUE ServerAdminVisible=FALSE CommandManagerVisible=FALSE ObjectManagerVisible=FALSE IServerVisible=FALSE IServerOLAPServicesVisible=FALSE IServerReportServicesVisible=FALSE IServerDistributionServicesVisible=FALSE IServerTransactionServicesVisible=FALSE IntegrityManagerVisible=FALSE DeveloperVisible=FALSE AnalystVisible=FALSE ArchitectVisible=FALSE FunctionPluginVisible=FALSE WebAnalystVisible=FALSE WebProfessionalVisible=FALSE WebReporterVisible=FALSE WebServerASPNETVisible=FALSE WebServerJSPVisible=FALSE WebServicesASPNETVisible=FALSE WebServicesJSPVisible=FALSE OfficeVisible=FALSE MobileVisible=FALSE MobileClientVisible=FALSE MobileServerASPVisible=FALSE MobileServerJSPVisible=FALSE AnalyticsModulesVisible=FALSE NCSAdminVisible=FALSE DeliveryEngineVisible=FALSE SubscriptionPortalVisible=FALSE TutorialDeliveryInstallVisible=FALSE TutorialDeliveryConfigureVisible=FALSE SequeLinkVisible=FALSE PortletsVisible=FALSE MDXCubeProviderVisible=FALSE GISConnectorsVisible=FALSE SystemManagerVisible=FALSE ### Components To Install (TRUE) or Remove (FALSE) ###
362 Installing and configuring with a response.ini file
2013 MicroStrategy, Inc.
EnterpriseManagerSelect=TRUE ServerAdminSelect=FALSE CommandManagerSelect=FALSE ObjectManagerSelect=FALSE IServerSelect=FALSE IServerOLAPServicesSelect=FALSE IServerReportServicesSelect=FALSE IServerDistributionServicesSelect=FALSE IServerTransactionServicesSelect=FALSE IntegrityManagerSelect=FALSE DeveloperSelect=FALSE AnalystSelect=FALSE ArchitectSelect=FALSE FunctionPluginSelect=FALSE WebAnalystSelect=FALSE WebProfessionalSelect=FALSE WebReporterSelect=FALSE WebServerASPNETSelect=FALSE WebServerJSPSelect=FALSE WebServicesASPNETSelect=FALSE WebServicesJSPSelect=FALSE OfficeSelect=FALSE MobileSelect=FALSE MobileClientSelect=FALSE MobileServerASPSelect=FALSE MobileServerJSPSelect=FALSE AnalyticsModulesSelect=FALSE NCSAdminSelect=FALSE DeliveryEngineSelect=FALSE SubscriptionPortalSelect=FALSE TutorialDeliveryInstallSelect=FALSE TutorialDeliveryConfigureSelect=FALSE SequeLinkSelect=FALSE PortletsSelect=FALSE MDXCubeProviderSelect=FALSE GISConnectorsSelect=FALSE SystemManagerSelect=FALSE [Summary] HideDialog=TRUE [Finish] HideDialog=TRUE Copy and paste this example to create a response.ini file. Replace any text between angled brackets (<>) with your own specific information. For
363
example, change UserName=<UserNameHere> to UserName=jsmith. Make sure to check that all file paths are entered with correct spacing. license key determines which MicroStrategy components will be Your available for your installation. For example, if your license key does not include MicroStrategy Enterprise Manager, then you cannot use EnterpriseManagerVisible=TRUE and EnterpriseManagerSelect=TRUE to install these components.
IServerOLAPServicesVisible=FALSE IServerReportServicesVisible=FALSE IServerDistributionServicesVisible=FALSE IServerTransactionServicesVisible=FALSE IntegrityManagerVisible=FALSE WebAnalystVisible=FALSE WebProfessionalVisible=FALSE WebReporterVisible=FALSE WebServerASPNETVisible=FALSE WebServerJSPVisible=FALSE WebServicesASPNETVisible=FALSE WebServicesJSPVisible=FALSE OfficeVisible=FALSE MobileVisibile=FALSE MobileClientVisible=FALSE MobileServerASPVisible=FALSE MobileServerJSPVisible=FALSE AnalyticsModulesVisible=FALSE NCSAdminVisible=FALSE DeliveryEngineVisible=FALSE SubscriptionPortalVisible=FALSE TutorialDeliveryInstallVisible=FALSE TutorialDeliveryConfigureVisible=FALSE SequeLinkVisible=FALSE PortletsVisible=FALSE MDXCubeProviderVisible=FALSE GISConnectorsVisible=FALSE SystemManagerVisible=FALSE ### Components To Install (TRUE) or Remove (FALSE) AnalystSelect=TRUE DeveloperSelect=TRUE ArchitectSelect=TRUE CommandManagerSelect=TRUE EnterpriseManagerSelect=TRUE ObjectManagerSelect=TRUE FunctionPluginSelect=TRUE ServerAdminSelect=FALSE IServerSelect=FALSE IServerOLAPServicesSelect=FALSE IServerReportServicesSelect=FALSE IServerDistributionServicesSelect=FALSE IServerTransactionServicesSelect=FALSE IntegrityManagerSelect=FALSE WebAnalystSelect=FALSE WebProfessionalSelect=FALSE ###
365
WebReporterSelect=FALSE WebServerASPNETSelect=FALSE WebServerJSPSelect=FALSE WebServicesASPNETSelect=FALSE WebServicesJSPSelect=FALSE OfficeSelect=FALSE MobileSelect=FALSE MobileClientSelect=FALSE MobileServerASPSelect=FALSE MobileServerJSPSelect=FALSE AnalyticsModulesSelect=FALSE NCSAdminSelect=FALSE DeliveryEngineSelect=FALSE SubscriptionPortalSelect=FALSE TutorialDeliveryInstallSelect=FALSE TutorialDeliveryConfigureSelect=FALSE SequeLinkSelect=FALSE PortletsSelect=FALSE MDXCubeProviderSelect=FALSE GISConnectorsSelect=FALSE SystemManagerSelect=FALSE [Summary] HideDialog=TRUE [Finish] HideDialog=TRUE Copy and paste this example to create a response.ini file. Replace any text between angled brackets (<>) with your own specific information. Make sure to check that all file paths are entered with correct spacing. license key determines which MicroStrategy components will be Your available for your installation. For example, if your license key does not include MicroStrategy Developer, then you cannot use DeveloperVisible=TRUE and DeveloperSelect=TRUE to install these components.
[Welcome] HideDialog=TRUE RemoveAll=FALSE [UserRegistration] HideDialog=TRUE UserName=<UserNameHere> CompanyName=<CompanyNameHere> LicenseKey=<CustomerLicenseKeyHere> [SuiteTarget] HideDialog=TRUE TargetDirectory=C:\Program Files\MicroStrategy [ComponentSelection] HideDialog=TRUE ### Visible Components ### AnalystVisible=TRUE DeveloperVisible=TRUE ArchitectVisible=FALSE FunctionPluginVisible=FALSE CommandManagerVisible=FALSE EnterpriseManagerVisible=FALSE ObjectManagerVisible=FALSE ServerAdminVisible=FALSE IServerVisible=FALSE IServerOLAPServicesVisible=FALSE IServerReportServicesVisible=FALSE IServerDistributionServicesVisible=FALSE IServerTransactionServicesVisible=FALSE IntegrityManagerVisible=FALSE WebAnalystVisible=FALSE WebProfessionalVisible=FALSE WebReporterVisible=FALSE WebServerASPNETVisible=FALSE WebServerJSPVisible=FALSE WebServicesASPNETVisible=FALSE WebServicesJSPVisible=FALSE OfficeVisible=FALSE MobileVisible=FALSE MobileClientVisible=FALSE MobileServerASPVisible=FALSE MobileServerJSPVisible=FALSE AnalyticsModulesVisible=FALSE NCSAdminVisible=FALSE
367
DeliveryEngineVisible=FALSE SubscriptionPortalVisible=FALSE TutorialDeliveryInstallVisible=FALSE TutorialDeliveryConfigureVisible=FALSE SequeLinkVisible=FALSE PortletsVisible=FALSE MDXCubeProviderVisible=FALSE GISConnectorsVisible=FALSE SystemManagerVisible=FALSE ### Components To Install (TRUE) or Remove (FALSE) ### AnalystSelect=TRUE DeveloperSelect=TRUE ArchitectSelect=FALSE FunctionPluginSelect=FALSE CommandManagerSelect=FALSE EnterpriseManagerSelect=FALSE ObjectManagerSelect=FALSE ServerAdminSelect=FALSE IServerSelect=FALSE IServerOLAPServicesSelect=FALSE IServerReportServicesSelect=FALSE IServerDistributionServicesSelect=FALSE IServerTransactionServicesSelect=FALSE IntegrityManagerSelect=FALSE WebAnalystSelect=FALSE WebProfessionalSelect=FALSE WebReporterSelect=FALSE WebServerASPNETSelect=FALSE WebServerJSPSelect=FALSE WebServicesASPNETSelect=FALSE WebServicesJSPSelect=FALSE OfficeSelect=FALSE MobileSelect=FALSE MobileClientSelect=FALSE MobileServerASPSelect=FALSE MobileServerJSPSelect=FALSE AnalyticsModulesSelect=FALSE NCSAdminSelect=FALSE DeliveryEngineSelect=FALSE SubscriptionPortalSelect=FALSE TutorialDeliveryInstallSelect=FALSE TutorialDeliveryConfigureSelect=FALSE SequeLinkSelect=FALSE PortletsSelect=FALSE
MDXCubeProviderSelect=FALSE GISConnectorsSelect=FALSE SystemManagerSelect=FALSE [Summary] HideDialog=TRUE [Finish] HideDialog=TRUE Copy and paste this example to create a response.ini file. Replace any text between angled brackets (<>) with your own specific information. Make sure to check that all file paths are entered with correct spacing. license key determines which MicroStrategy components will be Your available for your installation. For example, if your license key does not include MicroStrategy Developer, then you cannot use DeveloperVisible=TRUE and DeveloperSelect=TRUE to install these components.
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 ( ).
369
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.
1 Save your response.ini file to the directory C:\. You can save to a different directory, but the example command provided in these steps assumes the response file is saved to the directory location C:\. 2 From the Windows Start menu, select Programs, then select Accessories, and then right-click Command Prompt and select Run as Administrator. The User Account Control dialog box opens. steps to open a Windows command prompt with The administrator privileges may be different depending on your version of Windows. 3 Click Yes to open the command prompt with administrator privileges. The command prompt is displayed. 4 Type the following command in the Windows command line: Path\setup.exe --ResponseFile=C:\response.ini Where Path is the directory where the setup.exe file is stored. Press ENTER to begin the installation.
create a response.ini file to configure MicroStrategy are provided in Configuring MicroStrategy with a response file, page 201.
371
RegistrySizeReq= LogFile= [Welcome] HideDialog=TRUE RemoveAll=TRUE [WebVirtualDirectory] HideDialog=TRUE VirtualDirectory=MicroStrategy RemoveVD=YES [MobileVirtualDirectory] HideDialog=TRUE VirtualDirectory=MicroStrategyMobile RemoveVD=YES [PortalVirtualDirectory] HideDialog=TRUE VirtualDirectory=NarrowcastServer RemoveVD=YES [WebServicesDirectory] HideDialog=TRUE VirtualDirectory=MicroStrategyWS RemoveVD=YES [Finish] HideDialog=TRUE For details on creating a response.ini file, see Creating a response.ini file, page 331. After you have created a response.ini file, open a Windows command prompt to uninstall all MicroStrategy products. From the Windows Start menu, select Programs, then select Accessories, and then right-click Command Prompt and select Run as Administrator. The User Account Control dialog box opens. steps to open a Windows command prompt with administrator The privileges may be different depending on your version of Windows. Click Yes to open the command prompt with administrator privileges. The command prompt is displayed. Type the following script at the command prompt to uninstall all MicroStrategy products: Path1\setup.exe --ResponseFile= Path2\response.ini
372 Installing and configuring with a response.ini file
Where the Path1 for setup.exe must be the path to the original setup.exe used to install MicroStrategy products. The Path2 for the response file is the path where you saved your response.ini file.
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
installations with MicroStrategy must use a response.ini Silent file in conjunction with a setup.iss file. Using a setup.iss file without a response.ini file is not recommended or supported.
in SMS also generates a corresponding MIF file if you Uninstallation use the command line with the switch -mFileNameWithoutExtension.
Silent installation
373
there are installation termination messages in subsequent If installation instances that use the same dialog flow, they are also stored in the MSTRInst.log. The table below identifies the information that the MSTRInst.log file includes.
Line Function [F] Information [I] Warning [W] Description Identifies the function calls in the setup script. Logs information about the setup that is running. 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. Includes fatal problems that prevent the setup from proceeding. For example, the Intelligence Server Service cannot be created and setup fails as a result.
Severe [S]
A typical line in the MSTRInst.log file includes source file name, function name, source line number, and time. It appears as follows: [Z:\InstallMaster\Setup\Script Files\ MALicense.rul][UseDLL][l: 28][1318179ms][W] Le file
374 Silent installation
2013 MicroStrategy, Inc.
C:\WINDOWS\TEMP\ {84D0D5E2-719A-11D7-847C-000C293B5019}\ {B339F3B3-E78C-45E8-B4D2-3C46C1C13663}\MAInst.dll couldn't be loaded in memory. reviewing warning messages in the MSTRInst.log file, look When for [W] and [S] to find related problems.
It is recommended that you create a silent install that can be used with a response.ini file. For more information, see OEM silent installations,
Silent installation
375
page 374. This way you can change the settings in the response.ini file without having to generate a new .iss file.
you are installing a hotfix of MicroStrategy Office, see Silent If installation of MicroStrategy Office, page 377. 1 Insert the disk containing the Hotfix installable in the disk drive. 2 From the Windows Start menu, select Programs, then select Accessories, and then right-click Command Prompt and select Run as Administrator. The User Account Control dialog box opens. steps to open a Windows command prompt with The administrator privileges may be different depending on your version of Windows. 3 Click Yes to open the command prompt with administrator privileges. The command prompt is displayed. 4 Access the disk drive through the command prompt.
5 Run the silent installation with the following command: InstallPath\setup.exe -LLanguageValue --ResponseFile= "C:\HFresponse.ini" -s -f1C:\HFsetup.iss In the command listed above, you must supply the following information: InstallPath: The location in which to install the MicroStrategy hotfix. LanguageValue: Determines the language for the installation. Refer to Language settings for silent installations, page 409, for an explanation of the LanguageValue parameter.
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.
Silent installation
377
1 Download the MicroStrategy Office stand-alone installation files. You can retrieve these from the MicroStrategy installation disk, or from the MicroStrategy download site. The MicroStrategy Office stand-alone installation files include files named MicroStrategyOffice.msi and MicroStrategyOffice64.msi. These .msi files are for installing MicroStrategy Office on 32-bit and 64-bit versions of Microsoft Office, respectively. 2 From the Windows Start menu, select Programs, then select Accessories, and then right-click Command Prompt and select Run as Administrator. The User Account Control dialog box opens. steps to open a Windows command prompt with The administrator privileges may be different depending on your version of Windows. 3 Click Yes to open the command prompt with administrator privileges. The command prompt is displayed. 4 From a command prompt, navigate to the MicroStrategy Office hotfix installation folder. 5 To view information on the options to run the silent install command, enter the following command: msiexec.msi /? This includes information on options to log the installation details to a log file. 6 To run the silent installation using installation options defined by the current MicroStrategy Office configuration, enter one of the following commands: To install on 32-bit versions of Microsoft Office: msiexec.exe /i MicroStrategyOffice.msi /qn To install on 64-bit versions of Microsoft Office: msiexec.exe /i MicroStrategyOffice64.msi /qn can also use additional parameters as part of the silent You installation command, including the following:
INSTALLDIR: Defines the directory in which MicroStrategy Office will be installed. For example, you can define this parameter as INSTALLDIR=C:\Program Files\ MicroStrategy\Office. WSURL: Defines the URL for MicroStrategy Web Services. For example, you can define this parameter as WSURL=http:// localhost/MicroStrategyWS/MSTRWS.asmx. LW: Specify whether to load the MicroStrategy Office toolbar by default when the Microsoft Word application runs. This applies only if Word is installed in the target machine. The default is 3, which loads the toolbar. You can set this option to 2 to not load the toolbar for Microsoft Word. LE: Specify whether 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 3, which loads the toolbar. You can set this option to 2 to not load the toolbar for Microsoft Excel. LP: Specify whether to load the MicroStrategy Office toolbar by default when the Microsoft PowerPoint application runs. This applies only if PowerPoint is installed in the target machine. The default is 3, which loads the toolbar. You can set this option to 2 to not load the toolbar for Microsoft PowerPoint. OFFICECREATESHORTCUTS: Specify whether to create a shortcut for MicroStrategy Office in the Windows Start menu. The default is 1, which creates the shortcut. You can set this option to 0 to exclude the creation of this shortcut.
379
9
9.
Introduction
This chapter explains the various methods of performing a fully automated and unattended installation within the MicroStrategy platform when you do not have access to a UNIX or Linux graphical user interface (GUI). Server Universal configurations possible through the Intelligence command line on UNIX and Linux are covered in Chapter 11, Configuring MicroStrategy Using Command Line Tools. This chapter includes the following section(s): Silent installation, page 382
Before installing MicroStrategy products, you should refer to Chapter 1, Planning Your Installation for important pre-installation information.
381
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.
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 disk or you can ask your system administrator to share the files in a network location. For information on mounting or unmounting CD-ROM drives, see Mounting and unmounting CD-ROMs, page 522 in Appendix B, Troubleshooting. 3 Browse to the MicroStrategyInstallation/ QueryReportingAnalysis_UNIX directory. Depending on your UNIX or Linux environment, browse to one of the following folders: Solaris: QueryReportingAnalysis_SunOS AIX: QueryReportingAnalysis_AIX
4 Open options.txt in a text editor. 5 Specify a value for a setting by replacing the characters Value. For detailed information on the parameters and values that can be supplied with the options.txt file for a silent installation, see Parameters for a silent installation, page 385. 6 Save the changes to the options.txt file. 7 To use the options file on a silent installation, specify -silent -options FileName as a command line argument to the wizard, where FileName is the name of this options file, for example, options.txt. For example, type the command: setup.sh -silent -options options.txt If you are installing a MicroStrategy hotfix, use the setupHF.sh file instead. For example, type the command: setupHF.sh -silent -options options.txt
The example below assumes you are not using a CPU-based license for MicroStrategy Intelligence Server. For CPU-based licenses, you must add the parameter: cpuCount.number=maximum
The example below assumes you are using the full set of installation files to support the MicroStrategy installation. If you have downloaded only a subset of the .tzp files that are required
Silent installation
383
for the MicroStrategy installation, you must define where these files are stored, using the parameters described in Providing installation files for smaller installations, page 397. licenseAgreement.accept=true userRegistration.user=UserName userRegistration.company=CompanyName userRegistration.cdKey=License install.Instance=new install.Operation=FRESH_INSTALL suite.homeDirectory=Path suite.installDirectory=Path suite.logDirectory=Path SelectComponents.visible=true IntelligenceServer.visible=true IntelligenceServer.active=true ReportServices.visible=true ReportServices.active=true OLAPServices.visible=true OLAPServices.active=true DistributionServices.visible=true DistributionServices.active=true TransactionServices.visible=true TransactionServices.active=true WebAnalyst.visible=true WebAnalyst.active=true WebReporter.visible=true WebReporter.active=true WebProfessional.visible=true WebProfessional.active=true Portlets.visible=true Portlets.active=true GISConnectors.visible=true GISConnectors.active=true WebServices.visible=true WebServices.active=true MobileClient.visible=true MobileClient.active=true MobileServer.visible=true MobileServer.active=true CommandManager.visible=true CommandManager.active=true SystemManager.visible=true SystemManager.active=true IntegrityManager.visible=true IntegrityManager.active=true
WebUniversal.deployDirectory=Path Portlets.installDirectory=Path GISConnectors.installDirectory=Path WebServices.installDirectory=Path MobileClient.installDirectory=Path MobileServer.installDirectory=Path CommandManager.installDirectory=Path SystemManager.installDirectory=Path HealthCenter.port=PortNumber HealthCenter.accessCode=AccessCode HealthCenter.configureDaemon=true
License agreement
Define whether the license agreement is accepted by default. licenseAgreement.accept=Value You can define this parameter with one of the following values: true: The MicroStrategy license agreement is accepted by default. If you perform the installation as a silent installation that does not display the MicroStrategy Installation Wizard, you must use this value to install MicroStrategy successfully. false: The MicroStrategy license agreement is not accepted by default. The user that installs MicroStrategy must select to accept the license agreement to continue with the MicroStrategy installation.
Customer information
Your name, the name of the company for which you work, and the license key.
Silent installation
385
User: userRegistration.user=Value
Company: userRegistration.company=Value
MicroStrategy operations
In addition to installing MicroStrategy, you can also modify, repair, uninstall, and upgrade existing MicroStrategy installations. To install a new instance of MicroStrategy: install.Operation=FRESH_INSTALL To modify an existing MicroStrategy installation: install.Operation=MODIFY To repair an existing MicroStrategy installation by performing the previous installation attempt: install.Operation=REPAIR To uninstall an existing MicroStrategy installation: install.Operation=UNINSTALL
Product features
When you install products using an options file, the following two values may be specified for each product:
Silent installation
387
Each product includes a visible option, which can use one of the following values:
true: Indicates that the feature is displayed in the MicroStrategy Installation Wizard as available for installation. false: Indicates that the feature is not displayed in the MicroStrategy Installation Wizard as available for installation. If you define a products visible option as false, it cannot be installed.
If you do not specify a true or false value for each product, true is used for all products. You can also define the visible option for all products using the parameter SelectComponents.visible. You can exclude these visible options for each product if you are using the options file as part of a completely silent installation where no user interface is displayed to the user. Each product includes an active option, which can use one of the following values:
true: Indicates that the feature is selected for installation. false: Indicates that the feature is not selected for installation, or the product is to be uninstalled as part of an installation that modifies or uninstalls previously installed MicroStrategy software.
MicroStrategy Intelligence Server Universal is installed if you select to install any of the following MicroStrategy products: MicroStrategy Report Services, page 389 MicroStrategy OLAP Services, page 389 MicroStrategy Distribution Services, page 390 MicroStrategy Transaction Services, page 390
Silent installation
389
For example, to select MicroStrategy Web Universal Analyst for installation, use: WebAnalyst.visible=true WebAnalyst.active=true
Silent installation
391
MicroStrategy Portlets
The state of whether MicroStrategy Portlets is displayed in the MicroStrategy Installation Wizard: Portlets.visible=Value The selection state of MicroStrategy Portlets. Portlets.active=Value For example, to select MicroStrategy Portlets for installation, use: Portlets.visible=true Portlets.active=true
For example, to select MicroStrategy Web Services J2EE for installation, use: WebServices.visible=true WebServices.active=true
Silent installation
393
For example, to select MicroStrategy Integrity Manager for installation, use: IntegrityManager.visible=true IntegrityManager.active=true
Silent installation
395
HealthCenter.configureDaemon=true Configures this Health Agent as a daemon, so that the Health Agent process is constantly running in the background. This requires you to configure the Health Agent using an account that has root access privileges to the machine.
HealthCenter.configureDaemon=false Configures the Health Agent as an application, which is required if you do not have root access to the machine. In this case, be careful not to stop the Health Agent process, so that the machine can remain part of the Health Center system at all times.
FILESERVER: Type this value if the required installation files are stored in a folder on the local machine or a server machine. You must also provide the location of the files using the InstallOnDemand.sourceLocation parameter. HTTP: Type this value if the required installation files are stored at an unsecured URL. You must also provide the location of the files using the InstallOnDemand.url parameter. HTTPS: Type this value if the required installation files are stored at a secured URL. You must also provide the location of the files using the InstallOnDemand.url parameter, as well as the user name and password to access the URL using the InstallOnDemand.username and InstallOnDemand.password parameters.
InstallOnDemand.sourceLocation=Value Location of the folder that stores any required installation files. Type the location of the local file path. If you store the files in a local folder, do not provide a location for the InstallOnDemand.url parameter.
Silent installation
397
InstallOnDemand.url=Value Location of the URL for the HTTP or HTTPS location that stores any required installation files. Type the URL for the location that stores any required installation files. If you store the files at an HTTP or HTTPS location, do not provide a location for the InstallOnDemand.sourceLocation parameter.
InstallOnDemand.username=Value If you retrieve the installation files from a URL location, type a user name that has access to the URL location. If there is no login required to the URL or you retrieve the installation files from a local folder, you do not need to define a value for this parameter.
InstallOnDemand.password=Value If you retrieve the installation files from a URL location, type a password for the user name. If there is no login required to the URL or you retrieve the installation files from a local folder, you do not need to define a value for this parameter.
399
10
10.
Introduction
This chapter explains the common workflow for deploying the MicroStrategy platform as an Original Equipment Manufacturer (OEM) application. The MicroStrategy platform can be deployed as an OEM application in various ways: MicroStrategy can be deployed as a software as a service model through the use of MicroStrategy Web. In this scenario MicroStrategy is installed and configured at a centralized location using the standard process, and the customized application is deployed as an OEM application using MicroStrategy Web. For information on deploying MicroStrategy Web, see Chapter 6, Deploying MicroStrategy Web and Mobile Server. For information on customizing MicroStrategy Web, see Customizing MicroStrategy Web, page 405. MicroStrategy can be deployed as part of an OEM software bundle directly to a customer environment. This chapter focuses on the development and deployment of this type of OEM application.
The table below provides a best practices checklist of how to deploy MicroStrategy as an OEM application. In addition to using the checklist
401
10
below to deploy a MicroStrategy as an OEM application, you can also use MicroStrategy System Manager. System Manager lets you define multiple configurations for your MicroStrategy environment that can be executed in a single workflow. For steps to use System Manager to deploy MicroStrategy configurations, see the System Administration Guide.
Complete Task Install MicroStrategy on an OEM environment. For information on installing MicroStrategy, see: Chapter 2, Installing MicroStrategy on Windows Chapter 3, Installing MicroStrategy on UNIX and Linux Create DSNs using the Connectivity Wizard, as described in Creating DSNs for OEM environments, page 402. Configure MicroStrategy using the Configuration Wizard. This tool allows you to save configurations as response files that can be used to automate the configuration for the OEM deployment. This allows you to re-use all the configurations performed when developing an OEM application for the deployment process as well, as described in Configuring a MicroStrategy installation, page 404. Design projects and a reporting environment. You can use the various MicroStrategy products and relevant documentation to create the required MicroStrategy environment. For additional best practices when designing a reporting environment, see Designing a project and reporting environment, page 404. Customize MicroStrategy Web through the use of the MicroStrategy SDK, as described in Customizing MicroStrategy Web, page 405. Deploy a MicroStrategy OEM application on an OEMs customer environment, as described in Deploying a MicroStrategy OEM application, page 406. Create DSNs on the OEMs customer environment as necessary, as described in Creating DSNs for OEM environments, page 402. Configure and tune an OEM deployment through the use of various MicroStrategy tools, as described in Tuning an OEM deployment, page 411. If you are modifying a project that has already been deployed as an OEM application, see Updating OEM applications, page 412 for best practices on how to incorporate any custom reports or objects that may have been created for the deployed application. Troubleshoot your MicroStrategy OEM applications using MicroStrategy Health Center, as described in Troubleshooting support for MicroStrategy OEM applications, page 414
10
to store the data warehouse and the MicroStrategy metadata, which are both required to support a MicroStrategy reporting environment. To create a connection to these data sources you need an ODBC driver as well as a data source name (DSN). MicroStrategy comes packaged with ODBC drivers to support connecting to various data sources. For more information on ODBC drivers, see Communicating with databases: ODBC and DSNs, page 158. When setting up your OEM environment, you must create a separate DSN to connect to the main data source and the metadata repository. This requirement is true even if the data source and metadata repository are stored in the same database or other data source. The main data source and the metadata are described below: A data source stores the data that users of the system can analyze through BI capabilities offered by MicroStrategy products. Metadata is a repository whose data associates the tables and columns of a data warehouse with user-defined attributes and facts to enable the mapping of business views, terms, and needs to the underlying database structure. Metadata can reside on the same server as the data warehouse or on a different server. It can be also be stored in a different relational database than your data warehouse. A metadata can be created using the Configuration Wizard, as described in Configuring a MicroStrategy installation, page 404.
A DSN can be created using the MicroStrategy Connectivity Wizard, as described in Defining DSNs, page 165.
403
10
10
Portals External security and user management systems Advanced data visualizations
Extending functionality to support composite applications includes such things as writeback capabilities and other custom features.
To customize MicroStrategy Web using the MicroStrategy SDK, refer to the MicroStrategy Developer Library (MSDL). The MSDL contains details about the architecture, object models, customization scenarios, code samples, and so on that are useful for building a sophisticated and highly functional, customized application. The MicroStrategy SDK and MicroStrategy Developer Library (MSDL) are not included in the MicroStrategy installation. You can download the MicroStrategy SDK from the MicroStrategy support site https:// resource.microstrategy.com/msdz/default.asp. You can also access the MicroStrategy Developer Library from the MicroStrategy support site.
405
10
2 Additional configurations are required, as described in Configuring an OEM deployment installation, page 410.
When MicroStrategy products are installed as software bundled with another product, the following procedure is strongly recommended: 1 Create an installation response file (response.ini) for the MicroStrategy products to install. The table that follows shows which sections of the file are mandatory and which are optional.
10
For detailed information regarding the contents of the response.ini file, see Configuring a response.ini file to install MicroStrategy, page 330.
Response File Section [Installer] HideAllDialogs = PreventReboot = StopAllServices = StopIIS = CheckRenameOperations = [UserRegistration] [ComponentSelection] EnterpriseManagerSelect = [InitialPaths] EnterpriseManager = Selection Required Required Optional Optional Optional Optional Required Required Required Required Required
HideAllDialogs = TRUE causes the script for the Setting 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. 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. The rest of this procedure assumes you have saved the response.ini file to the file path C:\. If you save it to another file path, replace C:\ response.ini with the file path of your response.ini file. You must save the response.ini file as ANSI encoding.
407
10
2 Create the setup.iss file to use in conjunction with the response.ini file for the silent installation. Use a text editor to create the setup.iss file with the following information: [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=LanguageValue [{8CCF3F6C-55B7-4A27-8C68-ADF21D0585A2}-DlgOrder] Count=0 You must save the setup.iss file as ANSI encoding.
The version in the setup.iss file must match the MicroStrategy version you are installing exactly. For example, if you are installing version 9.3.0 you must enter Version=9.3.0. Entering a version as Version=9 or Version=9.3.x causes an error when trying to perform a silent installation of version 9.3.0. Refer to Language settings for silent installations, page 409, for an explanation of the LanguageValue parameter within the line Lang=LanguageValue.
3 From the Windows Start menu, select Programs, then select Accessories, and then right-click Command Prompt and select Run as Administrator. The User Account Control dialog box opens. steps to open a Windows command prompt with The administrator privileges may be different depending on your version of Windows. 4 Click Yes to open the command prompt with administrator privileges. The command prompt is displayed. 5 Run the silent install with the response.ini file in conjunction with the setup.iss file as follows: to Language settings for silent installations, page 409, for Refer an explanation of the LanguageValue parameter.
408 Deploying a MicroStrategy OEM application
2013 MicroStrategy, Inc.
10
INSTALL_PATH\setup.exe -LLanguageValue --ResponseFile="C:\response.ini" -s -f1c:\setup.iss -f2c:\setup.log In the syntax shown above, the -s parameter indicates that the installation is to be completely silent. If the -s parameter is not included in the command, then an interface is displayed during the installation that shows the progress of the installation. the setup program encounters an invalid value for an If installation requirement, the setup terminates and the silent installation is ended. You can review any errors in the setup.log file. 6 If a restart is required after the installation is complete, a restart of the machine is automatically triggered. Power the machine back on to allow for the completion of any configurations that are required after the restart of the machine. 7 After the installation is complete, you can check the result of the installation process. If the silent installation is successful, the resulting code value is zero (ResultCode=0) in the setup.log file. This is the only indication of the installation being completed if the installation is completely silent and a restart of the machine is not required.
The following table lists the values for the different languages that MicroStrategy supports.
Language Danish Dutch English French Value 0006 0019 0009 0012
409
10
Language German Italian Japanese Korean Portuguese Simplified Chinese Spanish Swedish Traditional Chinese
Value 0007 0016 0017 0018 0022 2052 0010 0029 1028
For example, to select English as the language: For the setup.iss file, change Lang=LanguageValue to: Lang=0009 To run the silent install, use the command line option as follows: Path\setup.exe -L0009 For the command line option, you must type -L in front of the language code to signify that you are entering a language.
10
information on using the Configuration Wizard, see Configuring a MicroStrategy installation, page 404. Configure and tune an OEM deployment through the use of various MicroStrategy tools, as described in Tuning an OEM deployment, page 411.
411
10
Command Manager Runtime uses a subset of the commands available for the full version of Command Manager. If you try to execute a script with statements that are not available in Command Manager Runtime, the script fails with the message You are not licensed to run this command. For a list of the commands available in Command Manager Runtime, with syntax and examples for each command, refer to the Supplemental Reference for System Administration.
10
Any new objects deployed as part of the OEM application update should be tested to ensure that they do not negatively affect the objects provided with the previous deployment of the OEM application. MicroStrategy Integrity Manager can be used to automate the testing of including new objects in an OEM application. For information on Integrity Manager, refer to the System Administration Guide.
413
10
These update packages can be developed using Object Manager. Once the package is ready for deployment, it can be deployed using Object Manager or Command Manager Runtime. For information on creating and deploying an update package with Object Manager, refer to the information on managing projects provided in the System Administration Guide. For information on Command Manager Runtime, refer to the Supplemental Reference for System Administration.
11
11.
Introduction
MicroStrategy tools are provided in command line mode on UNIX and Linux so that you can perform various configuration tasks through the operating system console. This enables you to perform your required configurations even if you do not have access to the MicroStrategy interface. On a Windows machine, it is recommended to use the appropriate MicroStrategy interfaces to perform the configurations described in this chapter. you perform MicroStrategy configuration tasks through the When UNIX or Linux operating system console, you must make sure reserved words and characters are not mistakenly included in your commands. To avoid issues caused by reserved words and characters, see Supporting reserved words and characters, page 441. This chapter covers the configurations listed below: Creating a DSN for a data source, page 416 Testing and examining ODBC connectivity, page 417
415
11
Configuring MicroStrategy with a response.ini file, page 418 Configuring and controlling Intelligence Server, page 437
1 From a UNIX/Linux console window, browse to HOME_PATH, where HOME_PATH is the directory that you specified as the home directory during installation. 2 Browse to the folder bin. 3 Type mstrconnectwiz -h, and then press ENTER to display command line syntax and examples for different database platforms. 4 Create your command based on the syntax and examples displayed. For example, the command below creates a DSN for an Oracle database and tests login credentials: mstrconnectwiz ORCLW MyOracleDSN 12.34.56.78 orcl 1521 -u:OracleUser -p:OracleUserPasword
11
1 In a UNIX/Linux console window, browse to HOME_PATH, where HOME_PATH is the directory that you specified as the home directory during installation. 2 Browse to the folder bin. 3 Type mstrtodbcx, and then press ENTER. A welcome message is displayed. 4 Type .help, and then press ENTER to display command line syntax and available options. 5 To connect to a DSN, enter the command below: .cn -d DSN -u UserName -p Password In the syntax above, DSN is the data source name, UserName is the login name for the data source, and Password is the password for the data source login. To continue the example from To create a DSN on UNIX/ Linux from the command line, page 416, connect to the Oracle DSN with the following command: .cn -d MyOracleDSN -u OracleUser -p OracleUserPassword Basic connection information is displayed for the successful connection. 6 Run any required tests and options. For example, type .lt -t USER% and press ENTER to list all tables that start with USER. The % symbol is used as a wildcard character in this command.
417
11
7 Once you are finished testing and review ODBC connectivity, type .disconnect and press ENTER to close the connection. 8 Type .quit and press ENTER to close the MicroStrategy DB Query Tool.
can also configure MicroStrategy using the Configuration Wizard You in command line mode on a Windows machine. However, on a Windows machine, it is recommended to use the Configuration
11
Wizard graphical user interface to create and use a response file, which is described in Configuring MicroStrategy with a response file, page 201. Before you can configure MicroStrategy with the Configuration Wizard in command line mode, you must ensure that you meet the prerequisites listed in Configuration Wizard prerequisites, page 172.
1 In a UNIX or Linux console window, browse to HOME_PATH where HOME_PATH is the directory you specified as the Home Directory during installation. 2 Browse to the bin directory. 3 At the command prompt, type mstrcfgwiz-editor, then press ENTER. The Configuration Wizard opens in command line mode. The sections or pages of the wizard displayed depend on your selections. 4 Review the information on the welcome screen and press ENTER to continue. 5 You can select to use a response.ini file to configure MicroStrategy, or create a new response.ini file to support a new configuration, as described below: Type 1, and then press ENTER to use a response.ini file to configure MicroStrategy. For steps to use a response.ini file in command line mode, see Using the response.ini file to configure MicroStrategy, page 436. Type 2, and then press ENTER to create a new response.ini file. You can select from various configuration tasks, as described in the Configuration tasks section within this procedure.
419
11
Configuration tasks
6 You can support the configuration tasks described in the sections listed below: Type 1, and then press ENTER to create metadata, History List, and statistics tables. Refer to Creating metadata, History List, and statistics tables, page 420 for steps to create metadata and statistics tables. Type 2, and then press ENTER to configure a MicroStrategy Intelligence Server definition. Refer to Setting up MicroStrategy Intelligence Server, page 429 for steps to configure an Intelligence Server definition. Type 3, and then press ENTER to create project sources. Refer to Creating a project source, page 434 for steps to create project sources.
11
1 In the prompt asking whether to create metadata tables, type Y, and then press ENTER. You are then prompted for ODBC data source information. 2 Type the number corresponding to the ODBC DSN for the database to store your metadata tables, and then press ENTER. you do not have a DSN defined on your UNIX or Linux machine, If see Creating a DSN for a data source, page 416. 3 If the Configuration Wizard detects an existing metadata repository in the database location you specified, a message is displayed on whether to re-create the metadata tables. If you type Y and press enter, all information in the existing metadata repository is overwritten when the response file is executed at a later time. 4 Depending on your database type, you may be prompted to provide a login and password to your DSN: a Type a login name for your database that stores your metadata tables, and then press ENTER. You are then prompted to provide a password for the login name. b Type a password for the login name provided, and then press ENTER. You are then prompted to provide a metadata prefix for the metadata tables. 5 Depending on your database type, you can enter characters to use as a prefix for the names of your metadata tables or use no prefix, as described below: Type the required prefix characters, and then press ENTER. Leave the prompt blank, and then press ENTER to provide no metadata prefix.
6 The next configuration displayed depends on your ODBC data source details: If the data source points to a DB2 MVS database, steps to configure a DB2 MVS database are displayed. These are described in the To configure DB2 MVS database options section within this procedure.
421
11
If the data source does not point to a DB2 MVS database, the step to select a metadata script is displayed. This step is described in the To select a metadata script, page 422 section within this procedure.
These steps are displayed if you are creating your metadata tables in a DB2 MVS database. 7 You can enter the database name to use or use the default name, as described below: Type the database name to use, and then press ENTER. Leave the prompt blank, and then press ENTER to use the default database.
You are then prompted to provide the MVS table space name. 8 You can enter characters to use as a table space name for your metadata tables or use the default table space name, as described below: Type the required table space name characters, and then press ENTER. Leave the prompt blank, and then press ENTER to use the default table space name.
You are then prompted to select a metadata script to create the metadata tables.
To select a metadata script
9 You can select the script used to create the metadata tables or use the default script, as described below: Enter a valid path to a script file, and then press ENTER. Leave the field blank, and then press ENTER to use the default script for your database type.
10 You can choose whether to create History List tables or not, as described below: Type Y, and then press ENTER to create History List tables. Creating History List tables is described in Creating statistics tables, page 427.
11
Type N, and then press ENTER to skip History List table creation. You are then prompted to create statistics tables, as described in the To create statistics tables section within this procedure.
11 You can choose whether to create statistics tables or not, as described below. Type Y, and then press ENTER to create statistics tables. Creating statistics tables is described in Creating statistics tables, page 427. Type N, and then press ENTER to skip statistics tables creation. You are then prompted to provide a name for the response.ini file, as described in the To generate a response.ini file section within this procedure.
12 By default, the configuration is saved as Response.ini in the / HOME_PATH/ directory, where HOME_PATH is the directory you specified as the Home Directory during installation. You can leave the field blank to use the default name or type a different name, and then press ENTER. The response.ini file is generated, and you are prompted whether to run the configuration immediately. 13 You can choose to run the configuration you just completed or to run the configuration using the response.ini file at a different time, as described below: Type Y, and then press ENTER to run the configuration.
You can also use the response.ini file created for future configurations, as described in Using the response.ini file to configure MicroStrategy, page 436. Type N, and then press ENTER to quit without running the configuration. You can use the response.ini file created for future configurations, as described in Using the response.ini file to configure MicroStrategy, page 436.
423
11
Prerequisite This procedure assumes you have already opened the Configuration Wizard in command line mode and selected to create metadata, History List, and statistics tables, as described in Creating a response.ini file, page 419.
1 After you create metadata tables (see Creating metadata tables, page 420) or skip both of the creation of metadata tables, you are prompted to create History List tables. To create History List tables, type Y, and then press ENTER. You are then prompted for ODBC data source information. 2 You can supply ODBC DSN information in various ways described below, which depend on whether you previously created metadata tables as part of the configuration process: If you did not create metadata tables as part of the configuration process, you are prompted to enter ODBC DSN information. The steps to enter this information is described in the To provide ODBC DSN information section within this procedure. If you created metadata tables as part of the configuration process, you are prompted whether to use the same metadata table ODBC DSN information for your History List tables. You have the following options: Type Y, and then press ENTER to create History List tables with the same ODBC DSN information entered for your metadata tables. You are then prompted to select a History List script to create the History List tables, which is described in the To select a History List script section within this procedure. Type N, and then press ENTER to provide different ODBC DSN information, which is described in the To provide ODBC DSN information section within this procedure.
11
3 Type the number corresponding to the ODBC DSN for a database to create your History List tables in, and then press ENTER. you do not have a DSN defined on your UNIX or Linux machine, If see Creating a DSN for a data source, page 416. 4 Depending on your database type, you may be prompted to provide a login and password to your DSN: a Type a login name for your database to create your History List tables in, and then press ENTER. You are then prompted to provide a password for the login name. b Type a password for the login name provided, and then press ENTER. 5 The next configuration displayed depends on your ODBC data source details: If the data source points to a DB2 MVS database, steps to configure a DB2 MVS database are displayed. These are described in the To configure DB2 MVS database options section within this procedure. If the data source does not point to a DB2 MVS database, the step to select a statistics script to create statistics tables is displayed. This step is described in the To select a History List script section within this procedure.
These steps are displayed if you are creating your metadata tables in a DB2 MVS database. 6 You can enter the database name to use or use the default name, as described below: Type the database name to use, and then press ENTER. Leave the prompt blank, and then press ENTER to use the default database.
You are then prompted to provide the MVS table space name. 7 You can enter characters to use as a table space name for your metadata tables or use the default table space name, as described below: Type the required table space name characters, and then press ENTER.
425
11
Leave the prompt blank, and then press ENTER to use the default table space name.
You are then prompted to select a statistics script to create statistics tables.
To select a History List script
8 You can select the script used to create the History List tables or use the default script, as described below: Enter a valid path to a script file, and then press ENTER. Leave the field blank, and then press ENTER to use the default script for your database type.
9 You can choose whether to create statistics tables or not, as described below. Type Y, and then press ENTER to create statistics tables. Creating statistics tables is described in Creating statistics tables, page 427. Type N, and then press ENTER to skip statistics tables creation. You are then prompted to provide a name for the response.ini file, as described in the To generate a response.ini file section within this procedure.
10 By default, the configuration is saved as Response.ini in the / HOME_PATH/ directory, where HOME_PATH is the directory you specified as the Home Directory during installation. You can leave the field blank to use the default name or type a different name, and then press ENTER. The response.ini file is generated, and you are prompted whether to run the configuration immediately. 11 You can choose to run the configuration you just completed or to run the configuration using the response.ini file at a different time, as described below: Type Y, and then press ENTER to run the configuration. You can also use the response.ini file created for future configurations, as described in Using the response.ini file to configure MicroStrategy, page 436.
426 Configuring MicroStrategy with a response.ini file
2013 MicroStrategy, Inc.
11
Type N, and then press ENTER to quit without running the configuration. You can use the response.ini file created for future configurations, as described in Using the response.ini file to configure MicroStrategy, page 436.
1 After you create metadata tables (see Creating metadata tables, page 420), create History List tables (Creating History List tables, page 423), or skip both of these procedures, you are prompted to create statistics tables. To create statistics tables, type Y, and then press ENTER. You are then prompted for ODBC data source information. 2 You can supply ODBC DSN information in various ways described below, which depend on whether you previously created metadata tables as part of the configuration process: If you did not create metadata tables as part of the configuration process, you are prompted to enter ODBC DSN information. The steps to enter this information is described in the To provide ODBC DSN information section within this procedure. If you created metadata tables as part of the configuration process, you are prompted whether to use the same metadata table ODBC DSN information for your statistics tables. You have the following options: Type Y, and then press ENTER to create statistics tables with the same ODBC DSN information entered for your metadata tables. You are then prompted to select a statistics script to create the statistics tables, which is described in the To select a statistics script section within this procedure.
2013 MicroStrategy, Inc. Configuring MicroStrategy with a response.ini file
427
11
Type N, and then press ENTER to provide different ODBC DSN information, which is described in the To provide ODBC DSN information section within this procedure.
To provide ODBC DSN information
3 Type a valid ODBC DSN for a database to create your statistics tables in, and then press ENTER. You are then prompted to provide a login to your DSN. 4 Type a login name for your database to create your statistics tables in, and then press ENTER. You are then prompted to provide a password for the login name. 5 Type a password for the login name provided, and then press ENTER. The next configuration displayed depends on your ODBC data source details: If the data source points to a DB2 MVS database, steps to configure a DB2 MVS database are displayed. These are described in the To configure DB2 MVS database options section within this procedure. If the data source does not point to a DB2 MVS database, the step to select a statistics script to create statistics tables is displayed. This step is described in the To select a statistics script section within this procedure.
These steps are displayed if you are creating your metadata tables in a DB2 MVS database. 6 You can enter the database name to use or use the default name, as described below: Type the database name to use, and then press ENTER. Leave the prompt blank, and then press ENTER to use the default database.
You are then prompted to provide the MVS table space name. 7 You can enter characters to use as a table space name for your metadata tables or use the default table space name, as described below: Type the required table space name characters, and then press ENTER.
11
Leave the prompt blank, and then press ENTER to use the default table space name.
You are then prompted to select a statistics script to create statistics tables.
To select a statistics script
8 You can select the script used to create the statistics tables or use the default script, as described below: Enter a valid path to a script file, and then press ENTER. Leave the field blank, and then press ENTER to use the default script for your database type.
You are then prompted to provide a name for the response.ini file.
To generate a response.ini file
9 By default, the configuration is saved as Response.ini in the / HOME_PATH/ directory, where HOME_PATH is the directory you specified as the Home Directory during installation. You can leave the field blank to use the default name or type a different name, and then press ENTER. The response.ini file is generated, and you are prompted whether to run the configuration immediately. 10 You can choose to run the configuration you just completed or to run the configuration using the response.ini file at a different time, as described below: Type Y, and then press ENTER to run the configuration. You can also use the response.ini file created for future configurations, as described in Using the response.ini file to configure MicroStrategy, page 436. Type N, and then press ENTER to quit without running the configuration. You can use the response.ini file created for future configurations, as described in Using the response.ini file to configure MicroStrategy, page 436.
429
11
To begin setting up your server definition, you must enter information about your ODBC DSN and MicroStrategy connections.
To set up MicroStrategy Intelligence Server
1 Type the corresponding number for the ODBC DSN for a database to connect Intelligence Server to. This should be the data source that stores your metadata. Then press ENTER. You are then prompted to provide a login to your DSN. 2 Type a login name for your database to create your statistics tables in, and then press ENTER. You are then prompted to provide a password for the login name. 3 Type a password for the login name provided, and then press ENTER. You are then prompted to provide a metadata prefix. 4 You can enter characters to use as a prefix for the names of your metadata tables or use no prefix, as described below: Type the required prefix characters, and then press ENTER. Leave the prompt blank, and then press ENTER to provide no metadata prefix.
You are then prompted to provide a temp table prefix. 5 You can enter characters to use as a prefix for the names of temp tables or use no prefix, as described below: Type the required prefix characters, and then press ENTER. Leave the prompt blank, and then press ENTER to provide no temp table prefix.
You are then prompted to provide a MicroStrategy user login. 6 Type a valid MicroStrategy user login that has administrator privileges, and then press ENTER.You are then prompted to provide a password for the login name. The default administrator account is Administrator with a blank password. This should be changed after you initial configuration.
11
7 Type a password for the MicroStrategy user login provided, and then press ENTER. You are then prompted to choose the type of Intelligence Server configuration to complete. 8 You can perform one of the Intelligence Server configuration tasks, which are described in the sections below: Type 1, and then press ENTER to create a new server definition. Refer to Creating and using a server definition, page 431 for steps to create a new server definition. Type 2, and then press ENTER to use an exiting server definition. This configuration follows the same steps for creating a new server definition, which are described in Creating and using a server definition, page 431. Type 3, and then press ENTER to delete a server definition. Refer to Deleting a server definition, page 433 for steps to delete a server definition. Type 4, and then press ENTER to create a new server definition and use it as the default server definition. This configuration follows the same steps for creating a new server definition, which are described in Creating and using a server definition, page 431.
The action taken depends on what action you selected to complete in the procedure To set up MicroStrategy Intelligence Server, page 430. Prerequisites This procedure assumes you have already opened the Configuration Wizard in command line mode and entered configuration information for your Intelligence Server, as described in Setting up MicroStrategy Intelligence Server, page 429.
431
11
1 In the prompt that asks for a server definition name, type the name that distinguishes the server definition, and press ENTER. You can press ENTER without entering any information to use the default server definition. You are then prompted to choose the projects to load for the server definition. 2 Type the names of projects to load when the server definition starts, and then press ENTER. Separate the project names with the \ character. You are then prompted to choose projects to not load for the server definition. 3 Type the names of projects to not load when the server definition starts, and then press ENTER. Separate the project names with the \ character. You are then prompted to provide a TCP port to use for Intelligence Server. 4 You can use the default port number or enter a different port number for Intelligence Server, as described below: Leave the prompt blank, and then press ENTER to use the default port number. Type a port number, and then press ENTER.
You are then prompted whether to register Intelligence Server as a service. 5 You can choose whether to register Intelligence Server as a service, as described below: Type Y, and then press ENTER to register Intelligence Server as a service. To perform this configuration, you must be logged into your UNIX or Linux machine with an account that has root level access and permissions. Type N, and then press ENTER to not register Intelligence Server as a service.
You are then prompted whether to start Intelligence Server when finished 6 Type y and press ENTER to start Intelligence Server after the response file is executed. You are then prompted to provide a name for the response.ini file.
11
7 By default, the configuration is saved as Response.ini in the / HOME_PATH/ directory, where HOME_PATH is the directory you specified as the Home Directory during installation. You can leave the field blank to use the default name or type a different name, and then press ENTER. The response.ini file is generated, and you are prompted whether to run the configuration immediately. 8 You can choose to run the configuration you just completed or to run the configuration using the response.ini file at a different time, as described below: Type Y, and then press ENTER to run the configuration. You can also use the response.ini file created for future configurations, as described in Using the response.ini file to configure MicroStrategy, page 436. Type N, and then press ENTER to quit without running the configuration. You can use the response.ini file created for future configurations, as described in Using the response.ini file to configure MicroStrategy, page 436.
1 In the prompt that asks for server definitions to be removed, type the name that distinguishes the server definition, and press ENTER. You can list multiple server definitions to be deleted, separating server definition names with the \ character. You are then prompted to provide a name for the response.ini file.
433
11
2 By default, the configuration is saved as Response.ini in the / HOME_PATH/ directory, where HOME_PATH is the directory you specified as the Home Directory during installation. You can leave the field blank to use the default name or type a different name, and then press ENTER. The response.ini file is generated, and you are prompted whether to run the configuration immediately. 3 You can choose to run the configuration you just completed or to run the configuration using the response.ini file at a different time, as described below: Type Y, and then press ENTER to run the configuration. You can also use the response.ini file created for future configurations, as described in Using the response.ini file to configure MicroStrategy, page 436. Type N, and then press ENTER to quit without running the configuration. You can use the response.ini file created for future configurations, as described in Using the response.ini file to configure MicroStrategy, page 436.
1 In the prompt that asks for a project source name, type the name for the project source to be created, and then press ENTER. You are then prompted to provide the Intelligence Server name. 2 Type the Intelligence Server name, and then press ENTER. You can also press ENTER without typing any information to accept the default Intelligence Server. You are then prompted to provide a TCP port to use for Intelligence Server.
11
3 You can use the default port number or enter a different port number for Intelligence Server, as described below: Leave the prompt blank, and then press ENTER to use the default port number. Type a port number, and then press ENTER.
You are then prompted to define a time interval for a project source connection time out. 4 Type a numerical value (in minutes) for the amount of inactivity that is allowed before a user is automatically disconnected from a project source. This enforces a connection time out for inactive users connected to a project source. Type 0 to define that users are not disconnected from project sources due to inactivity. Then press ENTER. You are then prompted to select an authentication type for the project source. 5 You can type the corresponding number to select one of the authentication types listed in the command line. For information on each authentication type, see Authentication modes, page 199. You are then prompted to provide a name for the response.ini file.
To generate a response.ini file
6 By default, the configuration is saved as Response.ini in the / HOME_PATH/ directory, where HOME_PATH is the directory you specified as the Home Directory during installation. You can leave the field blank to use the default name or type a different name, and then press ENTER. The response.ini file is generated, and you are prompted whether to run the configuration immediately. 7 You can choose to run the configuration you just completed or to run the configuration using the response.ini file at a different time, as described below: Type Y, and then press ENTER to run the configuration. You can also use the response.ini file created for future configurations, as described in Using the response.ini file to configure MicroStrategy, page 436. Type N, and then press ENTER to quit without running the configuration. You can use the response.ini file created for future
435
11
configurations, as described in Using the response.ini file to configure MicroStrategy, page 436.
1 In a UNIX or Linux console window, browse to HOME_PATH where HOME_PATH is the directory you specified as the Home Directory during installation. 2 Browse to the folder bin. 3 Type mstrcfgwiz-editor -r ReponseFile, where ReponseFile is the full qualified path to the response.ini file. For example: mstrcfgwiz-editor -r /home/username/MicroStrategy/ RESPONSE.INI 4 Press ENTER. If the path and the response file are valid, the configuration is performed and a successful configuration message appears. If an error occurs before or during the process, an error message displays the error that occurred when executing the response file.
11
You can then perform various configuration and monitoring tasks for your running Intelligence Server, which includes but is not limited to: Display database connection information Open, idle, and resume projects Check and close jobs Monitor users
437
11
Define server clustering options Monitor memory usage information Stop the server Monitor lock contentions
1 From a UNIX/Linux console window, browse to HOME_PATH, where HOME_PATH is the directory that you specified as the home directory during installation. 2 Browse to the folder bin. 3 Type mstrsvr, and then press ENTER to start Intelligence Server and display available configuration and monitoring options. 4 Once Intelligence Server is started, general configuration information is displayed along with all available configuration and monitoring options. Perform any configuration and monitoring tasks you require. 5 To quit the tool and stop Intelligence Server, type S, and then press ENTER.
1 From a UNIX/Linux console window, browse to HOME_PATH, where HOME_PATH is the directory that you specified as the home directory during installation. 2 Browse to the folder bin.
11
3 Type mstrsvr-configure, and then press ENTER. You are then prompted to provide a port number for Intelligence Server. 4 Type a port number, and then press ENTER. You are then prompted to provide a DSN to connect to. 5 Type a DSN, and then press ENTER. You are then prompted to provide a valid login for the DSN. 6 Type a valid login for the DSN, and then press ENTER. You are then prompted to provide a password for the DSN login. 7 Type a valid password for the DSN login, and then press ENTER. You are then prompted to provide a server definition name. 8 Type a server definition name, and then press ENTER. Your default server instance is configured.
1 From a UNIX/Linux console window, browse to HOME_PATH, where HOME_PATH is the directory that you specified as the home directory during installation. 2 Browse to the folder bin. 3 Type mstrctl -h, and then press ENTER. Help information is displayed, which provides syntax standards and available configuration options. 4 Review the help information and run any required configuration tasks. There are some commands that can output information to a file, or require a long definition that can be retrieved from a file. For information on using files to store output from and provide input to mstrctl commands, see Using files to store output and provide input, page 440.
439
11
You do not need to enter any command to quit the mstrctl tool because it is a one-line command line tool.
The commands that display the configurations listed above output long XML definitions to the command line. The commands that modify the configurations listed above require a long XML definition as input. Rather than displaying and inputting long XML definitions from the command line, you can use files to store and provide input for long XML definitions.
Configuring Intelligence Server with XML files requires extensive knowledge of the various parameters and values used to define Intelligence Server configurations. Providing an incorrect XML definition to configure Intelligence Server can cause errors and unexpected functionality.
Prior to using commands to display and modify service configurations (gsvc and ssvc) you must register Intelligence Server as a service. You can perform this task by using the rs command for mstrctl. To register an Intelligence Server as a service on a UNIX or Linux machine, you must be logged in with an account that has root user privileges and permissions.
The following commands can have their output sent to a file: gsc: Displays a server configuration gsvc: Displays a service configuration gsic: Displays a server instance configuration
11
For example, you can run the following command to output the server instance configuration to an XML file: mstrctl -s IntelligenceServer gsic > ServerInstance.xml A ServerInstance.xml file is saved in the current directory. The following commands can read input from a file: ssc: Modifies a server configuration ssvc: Modifies a service configuration ssic: Modifies a server instance configuration
For example, you can run the following command to modify the server instance configuration by reading input from an XML file: mstrctl -s IntelligenceServer ssic < ServerInstance.xml The XML definition in ServerInstance.xml is used to define the server instance configuration. It would be difficult and time consuming to type a complete server, service, or server instance configuration from the command line. An easier way to provide this type of configuration is to output the current configuration to a file, modify the file with a text editor, and then use the file as input to a command to modify the configuration.
441
11
For example, you use the following command to create a DSN to an Oracle database: mstrconnectwiz ORCLW $MyOracleDSN 12.34.56.78 orcl 1521 -u:OracleUser -p:OracleUserPasword Notice that the name of the DSN begins with the $ character. If this is a reserved character, the command fails to execute properly. To avoid this problem, you can place single quotes () around any character strings that may include reserved words or characters. This prevents the operating system console from interpreting the characters as an operating system action, and instead includes them as part of the character string. For example, the same command as above to create a DSN can be rewritten as follows: mstrconnectwiz ORCLW $MyOracleDSN 12.34.56.78 orcl 1521 -u:OracleUser -p:OracleUserPasword This time, the name of the DSN $MyOracleDSN is enclosed by single quotes, which allows all of the characters to be interpreted as a string of characters.
12
12.
Introduction
This chapter describes how to add or remove MicroStrategy components on different operating systems. This chapter includes the following sections: Adding or removing MicroStrategy components on Windows Re-installing MicroStrategy components on Windows Uninstalling MicroStrategy components on Windows Uninstalling MicroStrategy components on UNIX and Linux
443
12
1 Close all installed MicroStrategy products. 2 On the Windows Start menu, point to Settings, and then choose Control Panel. The Control Panel window opens. 3 Double-click Add/Remove Programs. The Add/Remove Programs dialog box opens. 4 Select MicroStrategy and click Change/Remove. The MicroStrategy Setup Maintenance program opens. 5 Select Modify and click Next. 6 Select to accept the license agreement and click Next. 7 Verify your customer information and click Next. 8 Select the components to add by selecting their check boxes. Clear the check boxes for the components you want to uninstall. Click Next. components that are currently installed are displayed with The their check boxes selected. These components are not re-installed during the modification process. If you clear any of the check boxes, that particular component is uninstalled during the modification process. You are advised not to clear the check boxes of the components that are already installed, unless you want to remove the component. 9 If you are prompted to stop your Web server, click Yes to stop it and continue with adding or removing files. 10 Verify the settings and click Next to begin copying or removing the files.
12
11 After the modification routine is complete, click Finish to close the maintenance program. For more details on each page of the MicroStrategy Installation Wizard, see Chapter 2, Installing MicroStrategy on Windows.
1 Close all installed MicroStrategy products. 2 On the Windows Start menu, select Settings, and then choose Control Panel. The Control Panel window opens. 3 Double-click Add/Remove Programs. The Add/Remove Programs dialog box opens. 4 Select MicroStrategy and click Change/Remove. The MicroStrategy Setup Maintenance program opens. 5 Select Repair and click Next. 6 Accept the license agreement and click Next. 7 You are prompted to select Yes to continue with the re-installation procedure and overwrite the components. If you do not want to overwrite the components, select No.
445
12
8 If you are prompted to stop your Web server, click Yes to stop it and continue with the re-installation. 9 As part of a repair installation, you can also designate this machine as a Health Agent. Provide this configuration information as required and continue with the re-installation routine. 10 After the re-installation routine is complete, click Finish to close the maintenance program. For details on each page of the MicroStrategy Installation Wizard, see Chapter 2, Installing MicroStrategy on Windows.
1 Close all installed MicroStrategy products. 2 On the Windows Start menu, select Settings, and then choose Control Panel. The Control Panel window opens. 3 Double-click the Add/Remove Programs icon. The Add/Remove Programs dialog box opens. 4 Select MicroStrategy Office and click Change/Remove. The MicroStrategy Office Setup Maintenance program opens. 5 Select Repair and click Next. 6 Accept the license agreement and click Next. 7 You are prompted to select Yes to continue with the re-installation procedure and overwrite the components. If you do not want to overwrite components, select No. 8 If you are prompted to stop your Web server, click Yes to stop it and continue with the re-installation.
12
9 After the re-installation routine is complete, click Finish to close the maintenance program. For details on each page of the MicroStrategy Installation Wizard, see Chapter 2, Installing MicroStrategy on Windows.
Before uninstallation begins, the DLL file performs the following functions: Checks for user privileges. If they are not valid, uninstallation stops. Checks for running components. If a component is found running, uninstallation stops. Stops and deletes the MicroStrategy Intelligence Server service. This occurs only when the Intelligence Server is being uninstalled. Deletes files created by the application, such as *.log, *.gid, *.ldb and *.tb.
uninstallation of MicroStrategy Office must be performed The separately. The procedure for uninstalling MicroStrategy Office is explained in the following sections.
To uninstall MicroStrategy components on Windows
1 Close all installed MicroStrategy products. 2 On the Windows Start menu, select Settings, and then Control Panel. The Control Panel window opens.
447
12
3 Double-click Add/Remove Programs. The Add/Remove Programs dialog box opens. 4 Select MicroStrategy and click Change/Remove. The MicroStrategy Setup Maintenance program opens. 5 Select Remove and click Next. 6 Click Yes to any prompts that appear. 7 If you are prompted to stop your Web server, click Yes to stop it and continue with the uninstallation. 8 After the uninstall routine is complete, select Yes to restart your computer, or No to restart it later. 9 Click Finish to close the maintenance program.
1 Close all installed MicroStrategy products. 2 On the Windows Start menu, select Settings, and then Control Panel. The Control Panel window opens. 3 Double-click Add/Remove Programs. The Add/Remove Programs dialog box opens. 4 Select MicroStrategy Office and click Change/Remove. The MicroStrategy Office Setup Maintenance program opens. 5 Select Remove and click Next. 6 You are prompted to select Yes to continue with the uninstallation procedure. To not remove the application with all of its components, select No.
12
7 After the uninstallation routine is complete, click Finish to close the maintenance program.
1 In a UNIX or Linux console window, browse to INSTALL_PATH, where INSTALL_PATH is the directory you specified as the install directory during installation. 2 Browse to the /_uninst folder. 3 You can uninstall MicroStrategy products using the MicroStrategy Installation Wizard or through the command line as described in the options below: To uninstall using the MicroStrategy Installation Wizard, type ./ setup.sh and press ENTER. Follow the steps described in To complete uninstallation with the MicroStrategy Installation Wizard below to complete the uninstallation process. To uninstall through the command line, type ./setup.sh -console and press ENTER. Follow the command line prompts to complete the uninstallation process.
4 A dialog box opens, prompting you to select a language. Specify the language to be used for the MicroStrategy uninstallation and click OK to proceed to the next step. 5 The MicroStrategy Installation Wizard opens with the Welcome page displayed. Click Next. The MicroStrategy Installation Selection page opens.
449
12
6 Select Use an existing installation, and then select the installation from the drop-down list. 7 From the Selected Operation area, select one of the following uninstallation options: Modify: Select this option to uninstall only some of the MicroStrategy products installed on the machine. Click Next and continue with the steps To specify which MicroStrategy products to uninstall below. Uninstall: Select this option to uninstall all MicroStrategy products installed on the machine. Click Next and continue with the steps To specify which MicroStrategy products to uninstall below.
8 The License Agreement page opens. Review the license agreement and select I accept the terms of the license agreement, and then click Next. The Customer Information page opens. 9 Type your user name, company name, and license key for your installation and click Next. The Select Components page opens. 10 Clear the check box for all MicroStrategy products that are to be uninstalled, and then click Next. can also install products as part of the uninstallation by You selecting the check box for any MicroStrategy product not previously installed. 11 On the Product Uninstallation page, select the products to uninstall. Click Next.
To complete the uninstallation process
12 On the Start installer operation page, verify the information and click Start. The products listed are uninstalled. 13 After uninstallation is complete, a message is displayed. Click Finish to complete the process and exit the MicroStrategy Installation Wizard.
A
CONNECTING TO DATABASES: ODBC AND DSNS
A.
Introduction
This appendix describes the DSN parameters required for ODBC drivers to connect MicroStrategy to various databases. DSNs can be created using the MicroStrategy Connectivity Wizard, and in UNIX and Linux, you can also configure ODBC parameters with the odbc.ini file. This appendix discusses these two topics in the following sections: Creating DSNs for specific ODBC drivers, page 451 Configuring ODBC parameters with odbc.ini, page 493
451
systems each ODBC driver is certified for, see Certified ODBC drivers for MicroStrategy Intelligence Server, page 87.
For ODBC-specific driver details, refer to the different ODBC driver sections below the table.
You can create a DSN from the command line in UNIX or Linux. Browse to HOME_PATH/bin, where HOME_PATH is the directory you specified as the home directory during installation. In the console window, type ./mstrconnectwiz -h, then press ENTER. This command displays command line syntax and examples for different database platforms. Create your command based on the syntax and examples displayed. Once you run your command, a DSN is created in the odbc.ini file.
Driver Details Data source name IP address TCP port (in most cases, 50000) Database name Default user ID Password Data source name Host name Database name Port number
ODBC Driver MicroStrategy ODBC Driver for DB2 Wire Protocol for Windows
MicroStrategy ODBC Driver for DB2 Wire Protocol for iSeries/ Data source name DB2 for i for Windows and UNIX/Linux IP address Collection Location Isolation level Package owner TCP port (446 in most cases) MicroStrategy ODBC Driver for DB2 z/OS for Windows and UNIX/Linux Data source name IP address Collection Location Package collection Package owner TCP port (446 in most cases) Data source name Host name Port number (5432 in most cases) Database name
MicroStrategy ODBC Driver for Greenplum Wire Protocol for Windows and UNIX/Linux, page 457
ODBC Driver MicroStrategy ODBC Driver for Apache Hive Wire Protocol for Windows and UNIX/Linux, page 458
Driver Details Data source name Host name Database name Port number (10000 in most cases) Data source name Host name Port number (21050 in most cases) Database name Data source name Server name Host name Port number (1526 in most cases) Database name Data source name Database name Server name Host name Service name Protocol type Data source name Host name Database name Port number User name
MicroStrategy ODBC Driver for Impala Wire Protocol for Windows and UNIX/Linux, page 458
MicroStrategy ODBC Driver for Informix Wire Protocol for Windows and UNIX/Linux, page 459
MicroStrategy ODBC Driver for MySQL Wire Protocol for Windows and Linux, page 460
MicroStrategy ODBC Driver for Oracle Wire Protocol for Windows and UNIX/Linux, page 461
Data source name and either: Standard connection: Host name Port number (in most cases, 1521) SID (MicroStrategy default is ORCL) Service name Alternate servers TNSNames connection: Server name TNSNames file
MicroStrategy ODBC Driver for Sybase ASE Wire Protocol for Windows and UNIX/Linux, page 462
Data source name Network address Database name Enable unicode support Data Source Name Host Name Port Number Database Name User Name
MicroStrategy ODBC Driver for PostgreSQL Wire Protocol for Windows and UNIX/Linux, page 463
453
ODBC Driver SQL Server for Windows and UNIX/Linux, page 463
Driver Details The requirements to configure the ODBC driver for SQL Server depend on whether you are using a Windows environment or a UNIX/Linux environment: SQL Server for Windows, page 463 SQL Server for UNIX/Linux, page 464 Data source name Server name Database name Port number User name Password
The MicroStrategy ODBC Driver for SequeLink allows you to access Microsoft Access databases or Microsoft Excel files stored on a Windows machine from an Intelligence Server hosted on a UNIX or Linux machine. The MicroStrategy ODBC Driver for Salesforce allows you to access resources on Salesforce.com, from an Intelligence Server hosted on a UNIX or Linux machine.
This section also provides information on how to install drivers from other vendors with MicroStrategy. The following ODBC drivers for Windows UNIX from other vendors are described as well: ODBC Driver for Red Brick for UNIX/Linux, page 471 ODBC Driver for Sybase Adaptive Server IQ for UNIX/Linux, page 473 ODBC Driver for Teradata for UNIX/Linux, page 474 ODBC Driver for Informix 8 for UNIX, page 475 ODBC Driver for Informix 8 for UNIX and Linux is a The MicroStrategy-branded ODBC driver, but it is not accessible through the Connectivity Wizard. ODBC Driver for Netezza for UNIX/Linux, page 477 ODBC Driver for MySQL Community Server 5.x for Linux, page 478 ODBC Driver for Aster Database for Linux, page 480
ODBC Driver for Vertica for Linux or Solaris, page 482 Other data sources and relational databases for Windows, page 487
The following sections provide more details about each individual drivers parameters.
to a DB2 for OS/390 database is supported (not certified) Connection for use with MicroStrategy. For information on connecting to a DB2 for OS/390 database, refer to MicroStrategy Tech Note TN11223.
455
Host Name: The name of the machine that runs the DB2 server. Database Name: The name of the database to connect to by default, which is assigned by the database administrator. Port Number: The DB2 server listener's port number. In most cases, the default port number is 50000, but you should check with your database administrator for the correct number.
MicroStrategy ODBC Driver for DB2 Wire Protocol for iSeries/ DB2 for i for Windows and UNIX/Linux
The following information is required for setting up the driver connection for MicroStrategy ODBC Driver for DB2 Wire Protocol for iSeries/DB2 for i: Data Source Name: A name to identify the DB2 for i data source configuration in MicroStrategy. For example, Finance or DB2fori-1 can serve to identify the connection. IP Address: The IP Address of the machine where the catalog tables are stored. This can be either a numeric address such as 123.456.789.98, or a host name. If you use a host name, it must be located in the HOSTS file of the machine or a DNS server. Collection: The name that identifies a logical group of database objects. Location: The DB2 location name, which is defined during the local DB2 installation. Isolation Level: The method by which locks are acquired and released by the system. Package Owner: The package's AuthID if you want to specify a fixed user to create and modify the packages on the database. The AuthID must have authority to execute all the SQL in the package. TCP Port: The DB2 DRDA listener process's port number on the server host machine provided by your database administrator. The default port number is usually 446.
MicroStrategy ODBC Driver for DB2 z/OS for Windows and UNIX/Linux
The following information is required for setting up the driver connection for MicroStrategy ODBC Driver for DB2 z/OS (formerly known as OS/390): Data Source Name: A name to identify the DB2 z/OS data source configuration in MicroStrategy. For example, Finance or DB2z/OS-1 can serve to identify the connection. IP Address: The IP Address of the machine where the catalog tables are stored. This can be either a numeric address such as 123.456.789.98, or a host name. If you use a host name, it must be located in the HOSTS file of the machine or a DNS server. Collection: The name that identifies a logical group of database objects, which is also the current schema. On DB2 z/OS, the user ID should be used as the Collection. Location: The DB2 z/OS location name, which is defined during the local DB2 z/OS installation. To determine the DB2 location, you can run the command DISPLAY DDF. Package Collection: The collection or location name where bind packages are created and stored for searching purposes. Package Owner (Optional): The package's AuthID if you want to specify a fixed user to create and modify the packages on the database. The AuthID must have authority to execute all the SQL in the package. TCP Port: The DB2 DRDA listener process's port number on the server host machine provided by your database administrator. The default port number is usually 446.
MicroStrategy ODBC Driver for Greenplum Wire Protocol for Windows and UNIX/Linux
The following information is required for setting up the driver connection for the MicroStrategy ODBC Driver for Greenplum Wire Protocol: Data Source Name: A name to identify the Greenplum data source configuration in MicroStrategy. For example, Finance or Greenplum-1 can serve to identify the connection.
457
Host Name: The name or IP address of the machine on which the Greenplum data source resides. The system administrator or database administrator assigns the host name. Port Number: The port number for the connection. The default port number for Greenplum is usually 5432. Check with your database administrator for the correct number. Database Name: The name of the database to connect to by default. The database administrator assigns the database name.
MicroStrategy ODBC Driver for Apache Hive Wire Protocol for Windows and UNIX/Linux
The following information is required for setting up the driver connection for the MicroStrategy ODBC Driver for Apache Hive Wire Protocol: Data Source Name: A name to identify the Apache Hive data source configuration in MicroStrategy. For example, Finance or ApacheHive-1 can serve to identify the connection. Host Name: The name or IP address of the machine on which the Apache Hive data source resides. The system administrator or database administrator assigns the host name. Database Name: The name of the database to connect to by default. If no database name is provided, the default database is used for the connection. The database administrator assigns the database name. Port Number: The port number for the connection. The default port number for Apache Hive is usually 10000. Check with your database administrator for the correct number.
MicroStrategy ODBC Driver for Impala Wire Protocol for Windows and UNIX/Linux
The following information is required for setting up the driver connection for the MicroStrategy ODBC Driver for Impala Wire Protocol: Data Source Name: A name to identify the Impala data source configuration in MicroStrategy. For example, Finance or Impala-1 can serve to identify the connection.
Host Name: The name or IP address of the machine on which the Impala data source resides. The system administrator or database administrator assigns the host name. Port Number: The port number for the connection. The default port number for Impala is usually 21050. Check with your database administrator for the correct number. Database Name: The name of the database to connect to by default. If no database name is provided, the default database is used for the connection. The database administrator assigns the database name.
MicroStrategy ODBC Driver for Informix Wire Protocol for Windows and UNIX/Linux
The following information is required for setting up the driver connection for the MicroStrategy ODBC Driver for Informix Wire Protocol: Data Source Name: A name to identify the Informix data source configuration in MicroStrategy. For example, Finance or Informix-1 can serve to identify the connection. Server Name: The client connection string designating the server and database to be accessed. Host Name: The name of the machine on which the Informix server resides. The system administrator or database administrator assigns the host name. Port Number: The Informix server listener's port number. The default port number for Informix is commonly 1526. Database Name: The name of the database to connect to by default, which is assigned by the database administrator.
459
the database vendor or a third party. For more information, see ODBC Driver for Informix 8 for UNIX, page 475. does not support this platform for use as a metadata MicroStrategy repository. The following information is required for setting up the driver connection for the MicroStrategy ODBC Driver for Informix 8: Data Source Name: A name to identify the Informix data source configuration in MicroStrategy. For example, Finance or Informix-1 can serve to identify the connection. Database: The name of the database to connect to by default, which is assigned by the database administrator. Server Name: The client connection string designating the server and database to be accessed. Host Name: The name of the machine on which the Informix server resides. Service Name: The service name, as it exists on the host machine. The system administrator assigns the service name. Protocol Type: The protocol used to communicate with the server.
MicroStrategy ODBC Driver for MySQL Wire Protocol for Windows and Linux
The MicroStrategy ODBC Driver for MySQL Wire Protocol is for use with MySQL Enterprise 5.0 on Windows and Linux. The following information is required for setting up the driver connection for the MicroStrategy ODBC driver for MySQL Wire Protocol: Data Source Name: A name to identify the MySQL data source configuration in MicroStrategy. For example, Finance or MySQL-1 can serve to identify the connection. Host Name: The name or IP address of the machine on which MySQL Enterprise 5.0 resides. The system administrator or database administrator assigns the host name. Database Name: The name of the database to connect to by default. The database administrator assigns the database name.
Port Number: The port number for the connection. The default port number for MySQL is usually 3306. Check with your database administrator for the correct number. User Name: The name of a valid user for MySQL Enterprise 5.0.
MicroStrategy ODBC Driver for Oracle Wire Protocol for Windows and UNIX/Linux
The following information is required for setting up the driver connection for MicroStrategy ODBC driver for Oracle Wire Protocol: Data Source Name: Enter a name to identify the Oracle data source configuration in MicroStrategy. For example, Finance or Oracle-1 can serve to identify the connection. A DSN is required for any Oracle Wire Protocol connection. Depending on whether you want to use a standard connection or a TNSNames connection, refer to one of the following lists of options below: Standard Connection: A standard connection is configured through Oracle Wire Protocol with the following connection parameters:
Host Name: The name of the Oracle server to be accessed. This can be a server name such as Oracle-1 or an IP address such as 123.456.789.98. Port Number: The Oracle listener port number provided by your database administrator. The default port number is usually 1521. One of the following parameters; which one you choose is up to your personal preference: SID: The Oracle System Identifier for the instance of Oracle running on the server. The default SID is usually ORCL. Service Name: The global database name, which includes the database name and the domain name. For example, if your database name is finance and its domain is business.com the service name is finance.business.com.
Alternate Servers: A list of alternate database servers to enable connection failover for the driver. If the primary database server entered as the SID or service name is unavailable, a connection to the servers in this list is attempted until a connection can be established.
461
You can list the servers in SID or service name format, as shown in the following examples: Using an SID: (HostName=DB_server_name: PortNumber= 1526:SID=ORCL) Using a Service Name: (HostName=DB_server_name: PortNumber=1526:ServiceName=service.name.com) TNSNames Connection: A TNSNames connection uses a TNSNAMES.ORA file to retrieve host, port number, and SID information from a server (alias or Oracle net service name) listed in the TNSNAMES.ORA file. A TNSNames connection requires the following parameters:
Server Name: A server name, which is included in a TNSNAMES.ORA file included in the TNSNames File text box below. TNSNames File: The location of your TNSNAMES.ORA file. Make sure to enter the entire path to the TNSNAMES.ORA file, including the file name itself. You can specify multiple TNSNAMES.ORA files.
MicroStrategy ODBC Driver for Sybase ASE Wire Protocol for Windows and UNIX/Linux
The following information is required for setting up the driver connection for the MicroStrategy ODBC driver for Sybase ASE Wire Protocol: Data Source Name: A name to identify the Sybase ASE data source configuration in MicroStrategy. For example, Finance or SybaseASE-1 can serve to identify the connection. Network Address: The network address, in the format ServerName_or_IPAddress,PortNumber. For example, if your network supports named servers, you can specify an address such as SybaseASE-1,5000. You can also specify the IP address such as 123.456.789.98,5000. Contact your system administrator for the server name or IP address. Database Name: The name of the database to connect to by default. The database administrator assigns the database name. Enable Unicode support (UTF8): Select this check box if the database supports unicode.
MicroStrategy ODBC Driver for PostgreSQL Wire Protocol for Windows and UNIX/Linux
The following information is required for setting up the driver connection for the MicroStrategy ODBC driver for PostgreSQL Wire Protocol: Data Source Name: A name to identify the PostgreSQL data source configuration in MicroStrategy. For example, Finance or PostgreSQL-1 can serve to identify the connection. Host Name: The name or IP address of the machine on which the PostgreSQL database resides. The system administrator or database administrator assigns the host name. Port Number: The port number for the connection. The default port number for PostgreSQL is usually 5432. Check with your database administrator for the correct number. Database Name: The name of the database to connect to by default. The database administrator assigns the database name. User Name: The name of a valid user for the PostgreSQL database.
463
Additionally, if you use named instances to distinguish SQL Server databases, you can include the named instance along with either the server name or IP address using the format ServerName\ NamedInstance or IPAddress\NamedInstance. The following are examples of providing the server name for your SQL Server database:
SQLServer-1\Instance1,1433 123.45.678.998\Instance1,1433
Database Name: The name of the database to connect to by default. The database administrator assigns the database name. Use Windows NT Authentication for login ID: This option is available if you are configuring the Microsoft SQL Server driver on Windows. Select this check box to use Windows NT authentication to pass a users credentials on the Windows machine to execute against a SQL Server database. If you use Windows NT authentication with SQL Server, you must enter the Windows NT account user name and password in the Service Manager. For information on the Service Manager, see the System Administration Guide. date data into SQL Server 2000 tables can cause errors if Inserting the systems Regional Settings are not set properly. Ensure that the date format is defined to be in an English format.
NamedInstance or IPAddress\NamedInstance. The following are examples of providing the server name for your SQL Server database:
SQLServer-1\Instance1 123.45.678.998\Instance1
Port Number: The port number for the connection. The default port number for SQL Server is usually 1433. Check with your database administrator for the correct number. Database Name: The name of the database to connect to by default. The database administrator assigns the database name. Enable SQL Database (Azure) support: Defines whether the DSN is created to support SQL Azure. Select this check box if the DSN is used to access a SQL Azure data source.
465
The steps below show you how to perform the necessary configurations on the various machines to support this type of configuration: Preparing the Microsoft Access database, page 466 Preparing the Microsoft Excel file, page 468 Configuring the MicroStrategy ODBC driver for SequeLink, page 469
To access Microsoft Access databases from an Intelligence Server hosted on UNIX or Linux
1 On the Windows machine that stores the Access database to connect to, install the SequeLink ODBC Socket Server. This can be installed as part of a MicroStrategy installation, and is included in the Other components options of the MicroStrategy Product Suite (see Select Features, page 108). SequeLink ODBC Socket Server that is provided with a The MicroStrategy installation is for exclusive use with the MicroStrategy Product Suite. You are not licensed to use this product with any application other than MicroStrategy products.
To configure the SequeLink ODBC Socket Server
2 On the Windows machine where you installed the SequeLink ODBC Socket Server, from the Start menu, point to Programs, point to DataDirect SequeLink 5.5 Service for ODBC Socket, and then select SequeLink Management Console Snap-in. 3 Under Console Root, expand SequeLink 5.5 Manager, expand Connected to SLAgent55, expand SequeLink Services, expand
SLSocket55, expand Configuration, and then select Data Source Settings. 4 From the Action menu, point to New, and select Data Source. A new data source is created underneath Data Source Settings. 5 Type a descriptive name for the new data source, such as Access Data Source. 6 Expand the new data source and select Advanced. 7 Right-click DataSourceSOCODBCConnStr and select Properties. The DataSourceSOCODBCConnStr Properties dialog box opens. 8 In the Value field, type DSN=AccessDSN, where AccessDSN is the DSN you created to connect to your Access database. This is different from the data source you created as part of the steps to configure the SequeLink ODBC Socket Server. 9 Click OK. 10 Within the same data source, select User Security. 11 Right click DataSourceLogonMethod and select Properties. The DataSourceLogonMethod Properties dialog box opens. 12 From the Value drop-down list, select Anonymous. This allows connection to the Access database without using a user name and password. 13 Click OK. 14 Right-click the data source, point to All Tasks, and select Save configuration. 15 On the UNIX or Linux machine that hosts your Intelligence Server, you must configure the MicroStrategy ODBC driver for SequeLink to connect to the Access database. For instructions on how to perform this configuration, see Configuring the MicroStrategy ODBC driver for SequeLink, page 469.
467
To access Microsoft Excel files from an Intelligence Server hosted on UNIX or Linux
1 On the Windows machine that stores the Excel files to connect to, install the SequeLink ODBC Socket Server. This can be installed as part of a MicroStrategy installation, and is included in the Other components options of the MicroStrategy Product Suite (see Select Features, page 108).
To configure the SequeLink ODBC Socket Server
2 On the Windows machine where you installed the SequeLink ODBC Socket Server, from the Start menu, point to Programs, point to DataDirect SequeLink 5.5 Service for ODBC Socket, and then select SequeLink Management Console Snap-in. 3 Under Console Root, expand SequeLink 5.5 Manager, expand Connected to SLAgent55, expand SequeLink Services, expand SLSocket55, expand Configuration, and then select Data Source Settings. 4 From the Action menu, point to New, and select Data Source. A new data source is created underneath Data Source Settings. 5 Type a descriptive name for the new data source, such as Excel Data Source. 6 Expand the new data source, and select Advanced.
7 Right-click DataSourceSOCODBCConnStr and select Properties. The DataSourceSOCODBCConnStr Properties dialog box opens. 8 In the Value field, type DSN=ExcelDSN, where ExcelDSN is the DSN you created to connect to your Excel file. This is different from that data source you created as part of the steps to configure the SequeLink ODBC Socket Server. 9 Click OK. 10 Within the same data source, select User Security. 11 Right click DataSourceLogonMethod and select Properties. The DataSourceLogonMethod Properties dialog box opens. 12 From the Value drop-down list, select Anonymous. This allows connection to the Excel file without using a user name and password. 13 Click OK. 14 Right-click the data source, point to All Tasks, and select Save configuration. 15 On the UNIX or Linux machine that hosts your Intelligence Server, you must configure the MicroStrategy ODBC driver for SequeLink to connect to the Excel files. For instructions on how to perform this configuration, see Configuring the MicroStrategy ODBC driver for SequeLink, page 469.
1 On the UNIX or Linux machine that hosts Intelligence Server, browse to HOME_PATH where HOME_PATH is the directory you specified as the Home Directory during installation. 2 Open the odbc.ini.example file and find the section that starts with [SequeLinkODBC]. Copy this section into the odbc.ini file.
469
3 Edit the parameters listed below: Host: Type the IP address of the Windows machine that stores the Access database or Excel files. ServerDataSource: Type the name of the data source for the Access database or Excel file to connect to as a data source. This is the name of the data source that you defined while configuring the SequeLink ODBC Socket Server, as shown in the example image below:
Host Name: The URL used to log in to the Salesforce.com system. You can keep the default of login.salesforce.com to connect to the production instance. However, you can also connect to other systems such as test.salesforce.com if you are connecting to testing environments.
If you attempt to test the connection to your Salesforce.com system, the password syntax is PasswordSecuritytoken, where Password is the password for the user account and Securitytoken is the additional security token required to access Salesforce.com. Do not use any spaces or other characters to separate the password and security token. As part of configuring a connection to your Salesforce.com system, you can include the password and security token as part of the database login, which is a component of a database instance used to access the DSN in MicroStrategy. For steps to create a database login, which you can use to provide the Salesforce.com password and security token, see Creating a database login, page 223.
1 Install ODBC Driver for Red Brick for the correct operating system. For information on installation, refer to the Installation and Configuration Guide for UNIX and Linux provided by IBM. sure you install the Red Brick Client Products (version 6.2 Make and higher) so that they can be accessed by the appropriate users. You need the following components: RISQL Entry Tool, RISQL Reporter, and Client TMU Red Brick ODBCLib (SDK) Red Brick ODBC Driver
directory where Red Brick Client Products are installed should The always be accessible to MicroStrategy Intelligence Server.
471
2 In a UNIX/Linux console window, browse to HOME_PATH, where HOME_PATH is the directory you specified as the Home Directory during installation. Browse to the folder env. 3 Add Write privileges to the ODBC.sh file by entering the following command: chmod u+w ODBC.sh 4 Edit the ODBC.sh file and add the location of the directory where the Red Brick Client Products are installed (RED_BRICK_INSTALL_PATH) to the RB_CONFIG environment variable: RB_CONFIG=RED_BRICK_INSTALL_PATH 5 Save the ODBC.sh file and remove Write privileges from the file by entering the following command: chmod a-w ODBC.sh
Configure a DSN for ODBC Driver for Red Brick
6 In a UNIX/Linux console window, browse to HOME_PATH where HOME_PATH is the directory you specified as the Home Directory during installation. 7 Open the odbc.ini.example file and find the section that starts with [RED_BRICK_62] if you are using Red Brick 6.2 or [RED_BRICK_63] if you are using Red Brick 6.3. Copy the section into the odbc.ini file. 8 Edit the DSN parameters SERVER and DATABASE, and modify the value of RB_CONFIG with the location of the directory where the Red Brick Client Products are installed. 9 Save the odbc.ini file. For details on these DSN parameters, refer to the product documentation provided directly by the database vendor.
1 Install ODBC Driver for Sybase Adaptive Server IQ for the correct operating system. For information on installation, refer to the Installation and Configuration Guide provided by Sybase. directory where ODBC driver for Sybase Adaptive Server IQ is The installed should always be accessible to MicroStrategy Intelligence Server.
Configure the environment for ODBC Driver for Sybase Adaptive Server IQ.
2 In a UNIX/Linux console window, browse to HOME_PATH, where HOME_PATH is the directory you specified as the Home Directory during installation. Browse to the folder env. 3 Add Write privileges to the ODBC.sh file by entering the following command: chmod u+w ODBC.sh 4 Edit the ODBC.sh file and add the location of the directory where the ODBC Driver for Sybase Adaptive Server IQ is installed (SYBASE_ASIQ_INSTALL_PATH) to the ASDIR environment variable: ASDIR=SYBASE_ASIQ_INSTALL_PATH 5 Save the ODBC.sh file and remove Write privileges from the file by entering the following command: chmod a-w ODBC.sh
Configure the DSN for ODBC Driver for Sybase Adaptive Server IQ.
6 In a UNIX/Linux console window, browse to HOME_PATH where HOME_PATH is the directory you specified as the home directory during installation.
473
7 Open the odbc.ini.example file and find the section that starts with [SYBASEIQ]. Copy the section into the odbc.ini file. 8 Edit the DSN parameters EngineName, DatabaseName and CommLinks, and modify the value of ASDIR with the location of the directory where the ODBC Driver for Sybase Adaptive Server IQ is installed. 9 Save the odbc.ini file. For details on these DSN parameters, refer to the product documentation provided directly by the database vendor.
1 Install the ODBC Driver for Teradata for the correct operating system. For information on installation, refer to the product documentation provided directly by the database vendor. directory where the ODBC driver for Teradata is installed The should always be accessible to MicroStrategy Intelligence Server.
Specify the Teradata GSS library installation (AIX only)
2 For AIX only, you need to specify the Teradata GSS library installation in the ODBC.sh. In a UNIX/Linux console window, browse to HOME_PATH where HOME_PATH is the directory you specified as the Home Directory during installation. Browse to the folder env. 3 Add Write privileges to the ODBC.sh file by entering the following command: chmod u+w ODBC.sh
4 Make the following changes to the MicroStrategy Teradata GSS path. Set this path, in the MSTR_TERADATA_PATH parameter, to the location of the local Teradata GSS library installation: MSTR_TERADATA_PATH='<MSTR_TERADATA_PATH> if [ "${MSTR_TERADATA_PATH}" != '<MSTR_TERADATA_PATH>' ]; then mstr_append_path LD_LIBRARY_PATH "${MSTR_TERADATA_PATH:?}"/lib export LD_LIBRARY_PATH 5 Save the ODBC.sh file and remove Write privileges from the file by entering the following command: chmod a-w ODBC.sh
Configure the DSN for ODBC driver for Teradata
6 In a UNIX/Linux console window, browse to HOME_PATH where HOME_PATH is the directory you specified as the Home Directory during installation. 7 Open the odbc.ini.example file and find the section that starts with [TERADATA_SERVER]. Copy that section into the odbc.ini file in the [ODBC Data Sources] section. 8 Edit the DSN parameters DBCName, Database, and DefaultDatabase, and modify the value of MSTR_TERADATA_PATH with the location of the directory where the ODBC Driver for Teradata is installed. You can also edit the parameters in the odbc.ini file to reflect your environment. To support parameterized queries, define the EnableExtendedStmtInfo parameter as EnableExtendedStmtInfo= Yes. This parameter and other Teradata parameters in the odbc.ini file are described in Configuring ODBC parameters with odbc.ini, page 493 and Teradata Server, page 516. 9 Save the odbc.ini file.
475
However, the Informix Client Software Developers Kit (CSDK) must be installed before you create a DSN. This software is not included in the MicroStrategy product suite installation and must be obtained through the database vendor or a third party. For information on installation, refer to the product documentation provided directly by the database vendor. The following steps show how to configure the MicroStrategy ODBC driver for Informix 8.
To configure ODBC Driver for Informix 8
1 Install the Informix CSDK. directory where CSDK is installed should always be accessible The to Intelligence Server.
Configure the environment for ODBC Driver for Informix 8
2 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 env. 3 Add Write privileges to the ODBC.sh file by entering the following command: chmod u+w ODBC.sh 4 Edit the ODBC.sh file and make the following changes: Add the location of the directory where the Informix Client Software Developer's Kit (CSDK) is installed (CSDK_INSTALL_PATH) to the INFORMIXDIR environment variable: INFORMIXDIR=CSDK_INSTALL_PATH Add the name of the Informix Server (INFORMIX_SERVER_NAME) to the INFORMIXSERVER environment variable: INFORMIXSERVER=INFORMIX_SERVER_NAME value is chosen from the list in <INFORMIXDIR>/etc/ This sqlhosts. 5 Save the ODBC.sh file and remove Write privileges from the file by entering the following command: chmod a-w ODBC.sh
476 Creating DSNs for specific ODBC drivers
2013 MicroStrategy, Inc.
6 In a UNIX console window, browse to HOME_PATH where HOME_PATH is the directory you specified as the home directory during installation. 7 Open the odbc.ini.example file and search for the section that starts with [IBM INFORMIX]. Copy the section into the odbc.ini file. 8 Edit the DSN parameters Database, Servername, and Service. 9 Save the odbc.ini file. For details on these DSN parameters, refer to the product documentation provided directly by the database vendor.
1 Install the ODBC Driver for Netezza for the correct operating system. For information on installation, refer to the product documentation provided directly by the database vendor. directory where Netezza is installed should always be The accessible to MicroStrategy Intelligence Server. 2 Configure the DSN for ODBC driver for Netezza.
To modify the odbcinst.ini file
3 In a UNIX/Linux console window, browse to HOME_PATH, where HOME_PATH is the directory you specified as the home directory during installation. 4 Edit the odbcinst.ini file and replace the three instances of netezza_odbc_install_dir with the location of the directory where the Netezza ODBC Driver is installed. An example of this is as follows:
2013 MicroStrategy, Inc. Creating DSNs for specific ODBC drivers
477
If the original path is: Driver = /netezza_odbc_install_dir/lib/ libnzsqlodbc3.so Then the modified path will be: Driver = /usr/odbc/netezzahome/lib/libnzsqlodbc3.so 5 Save the odbcinst.ini file.
To modify the odbc.ini file
6 Open the odbc.ini.example file and search for the section that starts with [IBM NETEZZA]. 7 Open the MicroStrategy odbc.ini file. 8 Copy and paste the contents from the odbc.ini.example file for your Netezza ODBC driver. You should paste the contents of the DSN exactly as they appear in the example file. 9 Make the following changes to the copied sample file: Modify the driver location to match the location of the installed Netezza ODBC Driver, netezza_odbc_install_dir. Change the database, server name, user name, and password, and any other relevant parameters to match the information for your database.
10 Save the odbc.ini file. For details on these DSN parameters, refer to the product documentation provided by the database vendor.
You must modify the odbc.ini file to create the DSN for MySQL Community Server 5.x. third-party product(s) discussed in the procedure below is The manufactured by vendors independent of MicroStrategy. MicroStrategy makes no warranty, express, implied or otherwise, regarding this product, including its performance or reliability.
To configure ODBC driver for MySQL Community Server 5.x
1 Install the 32-bit ODBC Driver for MySQL (3.51) for the Linux operating system, found at the hyperlink http://dev.mysql.com/downloads/ connector/odbc/3.51.html. This site is valid as of the release of this manual. For information on installation, refer to the product documentation provided by the database vendor.
Ensure that the driver files are installed to the /usr/lib directory. For exact version numbers of MySQL drivers certified with MicroStrategy, refer to the MicroStrategy General Information Readme.
3 In a Linux console window, browse to HOME_PATH, where HOME_PATH is the directory you specified as the home directory during installation. 4 Open the odbc.ini.example file and search for the section that starts with [MYSQL]. 5 Open the MicroStrategy odbc.ini file. 6 Copy and paste the contents from the odbc.ini.example file for your MySQL ODBC driver. You should paste the contents of the DSN exactly as they appear in the example file. 7 Make the following changes to the copied sample file: Modify the driver location to match the location of the installed MySQL ODBC Driver.
479
Change the database, server name, user name, password, and any other relevant parameters to match the information for your database.
that there is no white space between the equals sign (=) Ensure which separates the parameter and its value. 8 Save the odbc.ini file. can test a connection to your MySQL database with the You MicroStrategy DB Query Tool. This completes the steps to create a DSN and configure an ODBC driver for MySQL Community Server 5.x. To create a database instance and database connection, see Creating a database instance, page 215 and Creating a database connection, page 218.
1 Install the ODBC Driver for nCluster for the Linux operating system. For information on installation, refer to the product documentation provided by the database vendor.
The path to the installation location you choose for the ODBC driver is used later in this procedure as the value for the Driver parameter in the odbc.ini file.
For exact version numbers of Aster drivers certified with MicroStrategy, refer to the MicroStrategy General Information Readme.
2 Configure the DSN for the ODBC driver for Aster Database.
Configure the environment for ODBC Driver for nCluster
3 In a Linux console window, browse to HOME_PATH, where HOME_PATH is the directory you specified as the Home Directory during installation. Browse to the folder env. 4 Add Write privileges to the ODBC.sh file by entering the following command: chmod u+w ODBC.sh 5 Specify the Aster library installation in the ODBC.sh file. To do this, make the following changes to the MicroStrategy Aster path. Set this path, in the ASTER_PATH parameter, to the location of the local Aster library installation: # # ODBC Driver for Aster nCluster # ASTER_PATH='<ASTER_PATH>' if [ "${ASTER_PATH}" != '<ASTER_PATH>' ]; then export ASTER_PATH mstr_append_path LD_LIBRARY_PATH "${ASTER_PATH:?}" export LD_LIBRARY_PATH fi 6 Save the ODBC.sh file and remove Write privileges from the file by entering the following command: chmod a-w ODBC.sh
To modify the odbc.ini file
7 In a Linux console window, browse to HOME_PATH, where HOME_PATH is the directory you specified as the home directory during installation.
481
8 Open the odbc.ini.example file and search for the section that starts with [Aster Database]. 9 Open the MicroStrategy odbc.ini file. 10 Copy and paste the contents from the odbc.ini.example file for your Aster ODBC driver. You should paste the contents of the DSN exactly as they appear in the example file. 11 Make the following changes to the copied sample file: Modify the driver location to match the location of the installed Aster ODBC Driver. Change the database, server name, user name, password, and any other relevant parameters to match the information for your database.
that there is no white space between the equals sign (=) Ensure which separates the parameter and its value. 12 Save the odbc.ini file. This completes the steps to create a DSN and configure an ODBC driver for Aster Database.
1 Install the ODBC Driver for Vertica for the Linux or Solaris operating system. For information on installation, refer to the product documentation provided by the database vendor.
The path to the installation location you choose for the ODBC driver is used later in this procedure as the value for the Driver parameter in the odbc.ini file. For exact version numbers of Vertica drivers certified with MicroStrategy, refer to the MicroStrategy General Information Readme.
3 In a Linux or Solaris console window, browse to HOME_PATH, where HOME_PATH is the directory you specified as the home directory during installation. 4 Open the odbc.ini.example file and search for the section that starts with [HP VERTICA]. 5 Open the MicroStrategy odbc.ini file. 6 Copy and paste the contents from the odbc.ini.example file for your Vertica ODBC driver. You should paste the contents of the DSN exactly as they appear in the example file. 7 Make the following changes to the copied sample file: Modify the driver location to match the location of the installed Vertica ODBC Driver. Change the database, server name, user name, password, and any other relevant parameters to match the information for your database.
that there is no white space between the equals sign (=) Ensure which separates the parameter and its value. 8 Save the odbc.ini file.
483
This completes the steps to create a DSN and configure an ODBC driver for Vertica.
Prerequisites: MicroStrategy recommends that the SAP HANA user account used to create the database is granted full permissions for the database. If the database user account cannot be granted full permissions to the database, you can use the recommendations listed in Required database permissions to create metadata, History List, and statistics repositories, page 179 to determine the required permissions for the SAP HANA database user account.
1 Install the SAP HANA ODBC driver files on the Windows system that will host the MicroStrategy Intelligence Server. For specific installation steps, refer to your third-party SAP documentation. exact version numbers of SAP HANA drivers certified with For MicroStrategy, refer to the MicroStrategy General Information Readme. 2 Using the Microsoft ODBC Data Source Administrator, create a data source name to connect to your SAP HANA data source. best practices on using the Microsoft ODBC Data Source For Administrator to create data source names that are to be used in MicroStrategy, see Managing ODBC and data sources with Microsoft ODBC Data Source Administrator, page 168. 3 You can use the MicroStrategy DB Query Tool to test whether data can be retrieved data from your SAP HANA data source. For information on how to use the MicroStrategy DB Query Tool, see Using the DB Query Tool, page 169.
484 Creating DSNs for specific ODBC drivers
2013 MicroStrategy, Inc.
4 To use an SAP HANA as a data source, you must create a database instance in MicroStrategy. For information on creating a database instance, see Creating a database instance, page 215. creating a database connection, which is part of a database When instance, ensure that you select Non UTF-8 as the character set encoding for Windows drivers. This completes the steps for the initial connection to SAP HANA in MicroStrategy for Windows environments. For additional configuration requirements, see Additional requirements to support SAP HANA, page 487.
To configure an ODBC Driver for SAP HANA
1 Install the SAP HANA ODBC driver files on the Linux system that will host the MicroStrategy Intelligence Server. For specific installation steps, refer to your third-party SAP documentation. exact version numbers of SAP HANA drivers certified with For MicroStrategy, refer to the MicroStrategy General Information Readme.
Configure the environment for ODBC Driver for Red Brick
2 In a Linux console window, browse to HOME_PATH, where HOME_PATH is the directory you specified as the Home Directory during installation. Browse to the folder env. 3 Add Write privileges to the ODBC.sh file by entering the following command: chmod u+w ODBC.sh 4 Edit the ODBC.sh file and add the following configuration information for SAP HANA: # #ODBC Driver for SAP HANA # SAPHANA_PATH=SAPHANAINSTALLPATH if [ "${SAPHANA_PATH}" != 'SAPHANAINSTALLPATH' ]; then export SAPHANA_PATH mstr_append_path LD_LIBRARY_PATH "${SAPHANA_PATH:?}" export LD_LIBRARY_PATH
485
In the syntax listed above, SAPHANAINSTALLPATH is the location where you installed the SAP HANA ODBC driver files. 5 Save the ODBC.sh file and remove Write privileges from the file by entering the following command: chmod a-w ODBC.sh
Configure a DSN
6 In a Linux console window, browse to HOME_PATH where HOME_PATH is the directory you specified as the Home Directory during your MicroStrategy installation. 7 Open the odbc.ini.example file and find the section that starts with [SAP HANA]. Copy the section into the odbc.ini file. 8 Edit the following information from the syntax that you copied to odbc.ini: Driver=<SAPHANA_PATH>/libodbcHDB32.so Replace <SAPHANA_PATH> with the location where you installed the SAP HANA ODBC driver files. Servernode=ip_address:port
Replace ip_address with the IP address for the machine that hosts the SAP HANA database. Replace port with the port number for the connection to the SAP HANA database. Contact your SAP HANA database administrator for the required port number.
PASSWORD=pwd Replace pwd with the password for the SAP HANA user account described above.
9 Save the odbc.ini file. 10 You can use the MicroStrategy DB Query Tool to test whether data can be retrieved data from your SAP HANA data source. For information on how to use the MicroStrategy DB Query Tool, see Using the DB Query Tool, page 169.
11 To use an SAP HANA as a data source, you must create a database instance in MicroStrategy. For information on creating a database instance, see Creating a database instance, page 215. creating a database connection, which is part of a database When instance, for SAP HANA, ensure that you select Non UTF-8 as the character set encoding for UNIX drivers. This completes the steps for the initial connection to SAP HANA in MicroStrategy for Windows environments. For additional configuration requirements, see Additional requirements to support SAP HANA below.
Teradata
If you intend to use Teradata, which is certified by MicroStrategy, you need to:
487
Pre-install the NCR ODBC Driver for Teradata RDBMS. Otherwise, you will not see Teradata in the drivers list for Other Relational Databases when using the MicroStrategy ODBC DSN Creator. Ensure that Teradata DSNs are set to Run in Quiet Mode.
If you use Teradata, the following settings are required for setting up the driver connection. In the Teradata ODBC Driver Options dialog box, click Options to set the following required options: Session Mode: Select Teradata as the session mode to apply for the duration of the session. Date Time Format: Set this value to AAA format so the ODBC driver handles the Dates, Time, and Timestamps as ANSI-compatible strings. The ANSI-compatible strings are only available with the V2R3 or later databases. Disable Parsing: Select this check box to disable parsing of SQL statements by the ODBC driver.
For information on other options, refer to the online help by clicking Help.
Microsoft Excel
A Microsoft Excel file can be used as a data source in MicroStrategy. The information provided below explains how to prepare an Excel file for use with MicroStrategy and how to connect to the Excel file. This data can be used as part of a MicroStrategy project in various ways. For example, you can integrate the Excel data in your project using tools such as Architect, as described in the Project Design Guide. You can also use Freeform SQL and Query Builder to access your Excel data, as described in the Advanced Reporting Guide.
1 Prepare the Excel file as follows: Ensure that all column headers are of a valid format: No spaces in the header name (for example, Category_ID instead of Category ID) . Alphanumeric, and beginning with a letter. Ensure that all cells for the ID column have a value in them.
2 In the Excel file, create a table by performing the following: a Highlight the specific rows and columns with the data to use to create a report with, including the column headers, such as Category_ID and Category_DESC. not use the column headings at the top of the Excel Do spreadsheet, marked as A, B, C, and so on to select the whole column. Doing so may include numerous empty cells with NULL values. b In the Name Box, type a name for the highlighted cells, and then press ENTER. The name you type in is used in MicroStrategy as a table name. Name Box is the drop-down list on the left-hand side The below the toolbars. You can create multiple tables in one Excel file by highlighting different parts of the file and assigning them different names. 3 Save the Excel file.
489
1 From the Start menu, point to Programs, then MicroStrategy Tools, and then select Connectivity Wizard. The Welcome page of the Connectivity Wizard opens. 2 Read the Welcome page information and click Next. The Driver Selection page opens. 3 Select Other Relational Databases and click Next. A list of additional drivers is displayed. 4 Select the Microsoft Excel Driver and click Next. The ODBC Excel Setup dialog box is displayed. 5 Type a Data Source Name (DSN) for the Excel data source in the space provided. 6 Click Select Workbook. The Select Workbook dialog box is displayed. 7 Browse to and select the Excel file that you saved and named in the previous procedure To create a table with valid data in an Excel file, page 489. 8 Click OK to close the Select Workbook dialog box. 9 Click OK in the ODBC Excel Setup dialog box to return to the ODBC Data Source Administrator dialog box. 10 Click OK. The ODBC data source is configured. You can use the MicroStrategy DB Query Tool to test whether data can be retrieved from the tables you created from the Excel file. For information on how to use the MicroStrategy DB Query Tool, see Using the DB Query Tool, page 169.
connection type for the database instance. For information on creating a database instance, see Creating a database instance, page 215.
Text files
A text file can be used as a data source in MicroStrategy. The information provided below explains how to prepare a text file for use with MicroStrategy and how to connect to the text file. This data can be used as part of a MicroStrategy project in various ways. For example, you can integrate the text file data in your project using tools such as Architect, as described in the Project Design Guide. You can also use Freeform SQL and Query Builder to access your Excel data, as described in the Advanced Reporting Guide.
This procedure assumes you have an existing text file that is formatted to be used as a data source through an ODBC connection. 1 Ensure that the text file is of type .txt or .csv. 2 Select a delimiter to separate the data in the text file into columns for a database table. The following procedure assumes a comma (,) is used as the delimiter character. 3 Ensure that the column names appear in the first row of the file and are delimited. 4 Save the text file on your machine. The file path is used as the data source directory in MicroStrategy.
491
1 From your machines Control Panel, select Administrative Tools, and then Data Sources (ODBC). The ODBC Data Source Administrator dialog box is displayed. 2 Select the System DSN tab and then click Add. The Create New Data Source dialog box is displayed. 3 Select MicroStrategy ODBC Driver for Text as your ODBC driver and then click Finish. The ODBC Text Driver Setup dialog box is displayed. 4 On the General tab, enter a Data Source Name (DSN). 5 In the Database Directory field, provide the file path of the directory where you saved the text file. 6 Select Comma as the Default Table Type. This assumes a comma (,) is used as the delimiter character for the text file. 7 Select the Column Names in First Line check box. 8 On the Advanced tab, click Define. The Define File dialog box is displayed. 9 Select the text file you want to define and click Open. The Define Table dialog box is displayed. 10 You must associate a table name with the text file. In the Table field within the Table Information area, type the name to be used for the table within MicroStrategy. 11 Select the Column Names in First Line check box. 12 Click Guess to display all the columns contained in this text file. 13 Click OK to return to the Define File dialog box. 14 Click Cancel to return to the ODBC Text Driver Setup dialog box.
15 Click Apply and then OK to return to the ODBC Data Source Administrator dialog box. 16 Click OK. Your data source for the text file is now configured. You can use the MicroStrategy DB Query Tool to test whether data can be retrieved from the tables you created from the text file. For information on how to use the MicroStrategy DB Query Tool, see Using the DB Query Tool, page 169.
493
MicroStrategy ODBC Driver for Greenplum Wire Protocol MicroStrategy ODBC Driver for Informix 8 (XPS) MicroStrategy ODBC Driver for Informix Wire Protocol MicroStrategy ODBC Driver for Salesforce MicroStrategy ODBC Driver for Sybase ASE Wire Protocol MicroStrategy ODBC Driver for Microsoft SQL Server MicroStrategy ODBC Driver for MySQL Wire Protocol MicroStrategy ODBC Driver for PostgreSQL Wire Protocol
This section describes commonly used DSN parameters for all MicroStrategy-branded ODBC drivers. supports ODBC drivers from other vendors that you MicroStrategy can install separately. This involves manually defining the DSN parameters in the odbc.ini file. This section also describes the DSN parameters for the following ODBC drivers from other vendors: ODBC Driver for Red Brick ODBC Driver for Sybase Adaptive Server IQ ODBC Driver for Teradata ODBC Driver for Netezza
Modification of the odbc.ini file is necessary to configure ODBC driver settings or full ODBC drivers that are not accessible through the Connectivity Wizard. However, caution should be taken when modifying the odbc.ini file as incorrect modifications can cause unintended functionality and errors. To see an example of a configuration using an odbc.ini file, refer to the odbc.ini.example file installed in HOME_PATH, where HOME_PATH is the directory you specified as the home directory during installation on UNIX or Linux. You must use the correct syntax when modifying parameters for the odbc.ini file. Most of the parameters are of the form parameter name = parameter value, but some parameters require more complex syntax.
Refer to the table below for documentation standards related to parameter syntax.
Syntax {option1 | option2} Indicates You must select one of the options. For example, if the syntax is {Y | N}, you must type Y, or N. There can be two or more options, with each option separated by a pipe (|) symbol. Anything inside square brackets ([]) is optional. For example, a list of servers can be represented syntactically as Servers=Server1[,...]. The following would be valid syntaxes for the example above: Servers=Server1 Servers=Server1,Server2,Server3
[]
495
Parameter CatalogOptions
Description You can specify whether result columns REMARKS and COLUMN_DEF return values or SQL_NULL_DATA. You have the following options: 0: (Default) The REMARKS and COLUMN_DEF result columns return SQL_NULL_DATA. 1: The REMARKS and COLUMN_DEF result columns return their actual values. You can indicate the number of times this driver will attempt to connect to the primary or alternate servers (if enabled), if the initial attempt fails. The limits of this parameter are: 0: (Default) No reconnection attempt is made. 65535: Maximum number of retries. Description of a data source name. Path where the ODBC driver being used is located. You can enable the ODBC API function SQLDescribeParam. This function causes all parameters to be described with a SQL_VARCHAR data type. You have the following options: 0: (Default) Disables the SQLDescribeParam function. 1: (Default when using Microsoft Remote Data Objects to access data) Enables the SQLDescribeParam function. You can enable support for the N-datatypes NCHAR, NVARCHAR2, and NCLOB. You have the following options: 0: (Default) Disables support for NCHAR, NVARCHAR2, and NCLOB. 1: Enables support for NCHAR, NVARCHAR2, and NCLOB. These N-datatypes are described as SQL_WCHAR, SQL_WVARCHAR, and SQL_WLONGVARCHAR, respectively. Note: This parameter is supported in Oracle 9i and later.
ConnectionRetryCount
EnableNcharSupport
EnableStaticCursorsForL You can enable support for columns with the long data type when using static ongData cursors with your driver. You have the following options: 0: (Default) Disables support for columns with the long data type when using static cursors. 1: Enables support for columns with the long data type when using static cursors. Use this option to persist a result set containing long data types into an XML file. EncryptionMethod Specifies how the driver encrypts data that is sent between the driver and the database server. You have the following options: 0 (Default): the data is not encrypted 1: the data is encrypted using SSL The driver, by default, uses the GSS Client library packaged with the operating system to communicate with the Key Distribution Center. This parameter can be changed to use a different GSS Client library. Name of the host machine where the database server resides. This may also be the IP address.
GSSClient
HostName
Parameter HostNameInCertificate
Description Specifies whether or not the driver validates the Host Name in the certificate that is used in systems operating using SSL authentication. This parameter is ignored if the EncryptionMethod is set to 0, and if the value in ValidateServerCertificate is set to zero. You must provide a value for this parameter if your application is not enabled to support Unicode or you use a non-Unicode database character set. The value that you specify must be the value used for the code page used by your application. The driver on UNIX/Linux determines the value of the applications code page by checking for an IANAAppCodePage value, in the following order: 1 In the connection string 2 In the DataSource section of the odbc.ini file 3 In the ODBC section of the odbc.ini file The default value for this parameter provides support for most environments. If this parameter must be modified to support your code page, refer to the Data Direct documentation provided in the Help\English\odbcHelp folder. This folder location can be located in the MicroStrategy Common Files on Windows environments, and in the MicroStrategy install path on UNIX and Linux environments. Note: The IANAAppCodePage connection string parameter replaces the AppCodePage connection string parameter in earlier versions of Connect for ODBC. The drivers are backward compatible with the AppCodePage parameter, but you must now use the IANAAppCodePage parameter. In this case, the parameter uses the value in the ODBC section of the odbc.ini file.
IANAAppCodePage
KeyPassword KeyStore
The password to access a particular key in the keystore. The path to the location of the keystore, which is the file that contains the list of the client certificates that are trusted by the server for Client Authentication with SSL. The password to gain access to the keystore. You can enable client load balancing when connecting to primary and alternate servers. You have the following options: 0: (Default) Disables client load balancing. Connection attempts to database servers are performed sequentially, starting with the primary server. 1: Enables client load balancing. Connection attempts to database servers are performed in no particular order. Note: Us the AlternateServers parameter to define alternate servers to connect to.
KeyStorePassword LoadBalancing
User ID used to log on to the database. Password for the user account specified as the LogonID. Port number of the database instance.
497
Parameter ProcedureRetResults
Description You can enable the driver to return result sets from stored procedure functions. You have the following options: 0: (Default) The driver does not return result sets from stored procedures. 1: The driver returns result sets from stored procedures. Site Identifier of the Oracle instance you are trying to connect to. You can specify the location of the TNSNAMES.ORA file. Make sure to type the entire path to the TNSNAMES.ORA file, including the file name itself. You can specify multiple TNSNAMES.ORA files. You must set the Server Name parameter to use this option. Using the Server Name and TNSNamesFiles parameters disables the HostName, PortNumber, SID, and Service Name fields. Syntax: (filelocation1[,...])
SID TNSNamesFile
TrustStore
The path for the location to the truststore, which is the file that contains the list of certificate authorities that are trusted by the machine for SSL server authentication. The password to gain access to the truststore. Specifies whether or not the driver validates the servers security certificate during SSL authentication. You have the following options: 0: the certificate is not validated 1(Default): the certificate is validated
TrustStorePassword ValidateServerCertificate
HostNameInCertificate
TrustStore
TrustStorePassword ValidateServerCertificate
499
Parameter XMLDescribeType
Description Specifies what SQL Data Type the SQLGetTypeInfo() returns for the XML Data type. You have the following options: -4: The description SQL_LONGVARBINARY is used for DB2 XML data type columns. -10(Default): The description SQL_WLONGVARCHAR is used for DB2 XML data type columns. Path where the ODBC driver being used is located. Description of this data source. Default user ID to log on to the database. On UNIX/Linux, the LogonID value is your UNIX/Linux user ID. Password for the user account specified as the LogonID. Default qualifier used at connection time for any unqualified object names used in SQL statements. You must set the DB2 permissions to SYSADM. DB2 V5R1 on iSeries does not support this parameter. Specifies the IP address of the machine where the catalog tables are stored, as either a numeric address or address name. If you enter an address name, the address name is retrieved from the workstations HOSTS file or in a DNS server. Name of the database to which to connect. Name that identifies a logical group of database objects. This parameter is valid only if you are connecting to DB2 for z/OS (formerly OS/390) or iSeries/ DB2 for i. On iSeries/DB2 for i, it is also the current Schema. These objects include the DataDirect Connect DB2 Wire Protocol driver for ODBC packages. Specifies the DB2 location name. Use the name defined on the DB2 Server. This parameter is valid only if you are connecting to DB2 for z/OS (formerly OS/390) or iSeries/DB2 for i. Specifies the port number used by the DB2 database instance on the server host machine. You can grant execute privileges on the package you specify as the GrantAuthID. You have the following options: 1: (Default) Privileges are granted. 0: Privileges are not granted. You can indicate to whom execute privileges are granted. By default, this parameter is set to PUBLIC. Note: This parameter is ignored if GranteExecute=0.
IpAddress
Database Collection
Location
TcpPort GrantExecute
GrantAuthid
Parameter DefaultIsolationLevel
Description Method by which locks are acquired and released by the system. ODBC isolation levels map to DB2 isolation levels as follows: ODBC Read Uncommitted Read Committed Repeatable Read Serializable DB2 Uncommitted Read Cursor Stability Read Stability Repeatable Read
Valid values are: 0 - READ_UNCOMMITTED: Other processes can read from the database. Modified data is locked until the end of the transaction. 1 - READ_COMMITTED: (Default) Other processes cannot modify a row if the cursor is on the row or modify records that your application has modified, until your application commits or terminates. Your application cannot read a modified record that has not been committed by another process. 2 - REPEATABLE_READ: Other process cannot access data that your application has read or modified, until the end of the transaction. 3 - SERIALIZABLE: Other processes cannot modify records, including phantom records, that are read or modified by your application until your program commits or terminates. Your application is prevented from reading modified records that have not been committed by another process. If your application opens the same query during a single unit of work, the results table is identical to the previous table. However, results table can contain updates made by your application. 4 - NONE: Your program can read modified records even if they have not been committed by another process. This level can only be set in the data source, not from the application. Note: You must use this level if you have a collection on iSeries/DB2 for i with journaling enabled. DynamicSections CatalogSchema Specifies how many statements the DB2 Wire Protocol driver package can prepare for each user. The default is 200. Specifies the name of a valid DB2 schema to use for Catalog functions. If you do not specify a value, the parameter defaults to the following values: SYSIBM: Default for z/OS. QSYS2: Default for iSeries/DB2 for i. SYSCAT: Default when connected to UNIX/Linux. Specifies the collection or location name where the driver creates and searches for the bind packages. The default is NULLID. Specifies the DB2 user account assigned to the package. This user must have authority to run all the SQL statements in the package.
PackageCollection PackageOwner
501
Parameter UseCurrentSchema
Description You can restrict results to the tables in the current schema when a catalog function call is made either without specifying a schema or when specifying the schema as the wildcard character %. You have the following options: 0: (Default) Results can include tables outside of the current schema. 1: Results are restricted to tables in the current schema. Restricting results to tables in the current schema improves the performance of calls that do not specify a schema.
ApplicationUsingThreads You can specify whether the driver works with single-threaded or multi-threaded applications. You have the following options: 1: (Default) Use this setting to ensure the thread-safe driver works with multi-threaded applications. 0: Use this setting to prevent additional processing, which occurs due to ODBC thread-safety standards, for drivers that work with single-threaded applications. WithHold Specifies the cursor behavior for the application used with this data source. You have the following options: 1: (Default) DB2 leaves all cursors open after a commit or rollback. (SQLGetInfo( ) returns SQL_CB_PRESERVE for SQL_COMMIT_CURSOR_BEHAVIOR.) 0: DB2 closes all open cursors after a commit or rollback. (SQLGetInfo( ) returns SQL_CB_DELETE.)
Informix 8 (XPS)
Parameter Description ApplicationUsingThreads You can specify whether the driver works with single-threaded or multi-threaded applications. You have the following options: 1: (Default) Use this setting to ensure the thread-safe driver works with multi-threaded applications. 0: Use this setting to prevent additional processing, which occurs due to ODBC thread-safety standards, for drivers that work with single-threaded applications. CancelDetectInterval Specifies how often (in seconds) the driver checks whether a query has been canceled. When the driver detects that SQLCancel has been issued by the MicroStrategy Platform, the query is canceled. You have the following options: 0: (Default) Queries are not canceled even if SQLCancel is issued. {5| 10 | 30 | 60}: The driver checks if pending requests have been cancelled with SQLCancel every 5, 10, 30, or 60 seconds.
Parameter CursorBehavior
Description Determines the behavior of cursors at the end of each transaction. You have the following options: 0: (Default) Cursors are closed at the end of each transaction. 1: Cursors are preserved, meaning they are held at the current position at the end of each transaction. Preserving cursor position can slow down your database operations. Name of the database to which to connect. Description of this data source. Path where the ODBC driver being used is located. You can enable Insert cursors. You have the following options. 1: (Default) Insert cursors are enabled. Insert cursors improve performance during multiple Insert operations using the same statement. Insert data can be buffered in memory before being written to disk. 0: Insert cursors are disabled. Specifies whether the database list is returned from the Informix server or from the database list the user entered during driver setup. 1: (Default) The database list is returned from the Informix server. 0: The database list is returned from the database list the user entered during driver setup. Name of the machine on which the Informix server resides. Logon ID used to connect to your database. Password used to connect to your database. Specifies the protocol used to communicate with the server. You can specify one or more values; separate the names with commas. You can enter any of the following protocols: olsocspx olsoctcp onsocspx onsoctcp seipcpip sesocspx sesoctcp ontlitcp Note: For Solaris, the protocol must be ontlitcp. Name of the server running the Informix instance. Note: This can be different from the HostName. Verify what your ServerName is with the Informix database administrator.
GetDBListFromInformix
ServerName
Service TrimBlankFromIndexNa me
Name of the service being used by Informix on the host machine. You can specify whether to trim leading space from a system-generated index name. You have the following options: 1: (Default) The driver trims the leading space. 0: The driver does not trim the space.
503
UseDelimitedIdentifiers
Salesforce
Parameter ConfigOptions Description Determines how data is represented between Salesforce.com and MicroStrategy. The following options should be used to ensure correct integration between Salesforce.com and MicroStrategy: AuditColumns=AuditOnly;MapSystemColumnNames= 0;CustomSuffix=Include Database The configuration files used to connect to and represent the Salesforce.com objects and data on the local machine, for a specific user account. Multiple configuration files with the same file prefix make up the database of configuration files. The location and prefix of the database of configuration files can be provided in the following ways: Leave this parameter blank, which means that the database files are created in the working directory of the application. Additionally, the Salesforce user account is used as the prefix of the database of configuration files. For example, by logging in to Salesforce.com with the account [email protected], the prefix is jdoe. Type only the database files prefix, that is, the name of the database files without any file extension. The current working directory is searched for the database files. Type the database files prefix and the path in which to store the database files. CreateDB Specifies whether a new database of configuration files is created when making a connection to Salesforce.com. You have the following options: 0: The database specified in the Database parameter is used. If no database exists, the database is not created and no connection is made. 1: A new database is created and a connection is made. This new database overwrites any database that exists in the location specified by the Database parameter. 2 (Default): The database specified in the Database parameter is used. If no database exists, a new database is created and a connection is made. MicroStrategy recommends using this option. Determines how many rows of data are processed at a time before they are returned by the driver. The default is 100. MicroStrategy recommends using a value of 160. This ensures that the driver works with MicroStrategy standards to return data, which can in turn improve performance of the data retrieval. Specifies the base URL to log in to Salesforce.com. You can use the default value, which is login.salesforce.com. Alternate URLs can be used to host separate production and testing environments. Specifies the location of the sforce.jar file required to successfully use the driver. By default, MicroStrategy installs sforce.jar in the INSTALL_PATH/lib32 directory. For this we actually will ship a file that can be used by default if needed for troubleshooting. It is called ddlog.properties and is installed with the driver files.
FetchSize
HostName
JVMClasspath
LogConfigFile
505
Description Specifies the user account used to connect to Salesforce.com. Specifies the password for the user account used to connect to Salesforce.com. When using MicroStrategy to connect to Salesforce.com, it is recommended to leave this field blank and instead provide the password as part of the password for the database login. For steps to create a database login, and a database instance that uses the database login, see Creating a database instance, page 215 and Creating a database login, page 223. Specifies the security token required to access Salesforce.com. When using MicroStrategy to connect to Salesforce.com, it is recommended to leave this field blank and instead provide the security token as part of the password for the database login. For steps to create a database login, and a database instance that uses the database login, see Creating a database instance, page 215 and Creating a database login, page 223. Determines how many web services calls can be made in a single SQL statement or query. The default value is 20. When using MicroStrategy to connect to Salesforce.com, it is recommended to use 0, which specifies that a single SQL statement or query can make unlimited web service calls. Determines how manual database transactions are supported, which can provide the ability to rollback changes. You have the following options: 0 (Default): Transactions are not supported by either the data source or the driver. 1: Transactions are not supported by the data source, and the driver always uses auto-commit mode. MicroStrategy recommends using this option. Determines how many rows of data are retrieved with each ODBC call. The default value is 0, which causes each ODBC call to attempt to return the maximum of 2000 rows. MicroStrategy recommends using the default value of 0.
SecurityToken
StmtCallLimit
TransactionMode
WSFetchSize
EnableQuotedIdentifiers
EncryptionMethod
507
Parameter GSSClient
Description The driver, by default, uses the GSS Client library that comes with the operating system to communicate with the Key Distribution Center. This parameter can be changed to use a different GSS Client library. Specifies whether or not the driver validates the Host Name in the certificate that is used in systems operating using SSL authentication. This parameter is ignored if the EncryptionMethod is not set to SSL, and if the value in ValidateServerCertificate is set to zero. Specifies the national language installed on the Sybase server. The default is English. User ID for connecting to the database. Specifies the network address. The format depends on the network protocol chosen under Network Library Name and the Sybase server. If you are choosing Windows Sockets (Winsock), then the format is: {IP address | Hostname}, port number. For example, you might enter 199.226.224.34, 5000 or Sybase_15, 5000. Specifies how stored procedures are prepared when using SQLPrepare. You have the following options: 0: Stored procedures are created for every call to SQLPrepare. Decreased performance occurs when statements that do not contain parameters are processed. 1: (Default) Stored procedures are created only if the statement contains parameters. Otherwise, the statement for the stored procedure is cached and run when SQLExecute is called. 2: Stored procedures are never created. The statement for the stored procedure is cached and run when SQLExecute is called. Any syntax errors or other errors are returned when SQLExecute is called. 3: Stored procedures are never created. This option is identical to option 2 except that any syntax errors or other errors are returned when SQLPrepare is called instead of SQLExecute. Password for connecting to your database.
HostNameInCertificate
OptimizePrepare
Password
RaiseErrorPositionBehav You can configure when errors are returned and where the cursor is ior positioned after encountering a raiseerror. You have the following options: 0: (Default) Raiseerror is handled separately from surrounding statements. Errors are returned when raiseerror is processed via SQLExecute, SQLExecDirect, or SQLMoreResults. 1: (Microsoft-compatible) RaiseError is returned when the next statement is processed and the cursor is positioned on the first row of the subsequent result set. Multiple RaiseErrors may be returned on a single execute. SelectMethod You can enable database cursors for SELECT statements. You have the following options: 0: (Default) Database cursors are enabled. Creating database cursors requires additional overhead, which can negatively affect performance when executing a large number of sequential SELECT statements. 1: Database cursors are disabled for SELECT statements, thus limiting the database to one active statement at a time.
Parameter ServicePrincipalName
Description The Sybase server principal name used for Kerberos authentication. If no name is specified, then the driver defaults to the value forNetworkAddress. This parameter is ignored if an authentication type other than Kerberos is used. The path for the location to the truststore, which is the file that contains the list of certificate authorities that are trusted by the machine for SSL server authentication. The password to gain access to the truststore. Specifies whether or not the driver validates the servers security certificate during SSL authentication. You have the following options: 0: the certificate is not validated 1(Default): the certificate is validated
TrustStore
TrustStorePassword ValidateServerCertificate
AnsiNPW
509
Parameter QuotedId
Description You can choose to handle QUOTED_IDENTIFIERS as defined by SQL-92 or Transact_SQL rules. You have the following options: Yes: QUOTED_IDENTIFIERS are enabled. SQL Server uses SQL-92 rules for quotation marks in SQL statements. No: QUOTED_IDENTIFIERS are disabled. SQL Server uses the legacy Transact_SQL rules for quotation marks in SQL statements. If you are using Microsoft SQL server 2005 and it is configured for snapshot isolation, you can allow the application to use the snapshot isolation level. You have the following choices: 0 (Default): the application uses the serializable isolation level when the isolation level is set to serializable. 1: The application uses the snapshot isolation level when the isolation level is set to serializable.
SnapshotSerializable
ConnectionRetryDelay
Description Specifies the database to use. You can specify the maximum data length, in bytes, that is fetched from Long/ LOB columns. The value must be in multiples of 1024, and is multiplied by 1024 to define the maximum data length in bytes. For example, the default for this parameter is 1024, which is multiplied by 1024, for a total of 1048576 bytes, or 1 megabyte. This parameter also resizes any data passed in a Long/LOB SQL_DATA_AT_EXEC parameter to fit the data length specified, and chunks any data exceeding this data length limit. Description of the data source. Path where the ODBC driver being used is located. You can enable the ODBC API function SQLDescribeParam. This function causes all parameters to be described with a SQL_VARCHAR data type. You have the following options: 0: (Default) Disables the SQLDescribeParam function. 1: (Default when using Microsoft Remote Data Objects to access data) Enables the SQLDescribeParam function. Name of the host machine where the database server resides. This may also be the IP address. Determines which variable is used to determine the amount of time that a connection can idle until the server disconnects it. The possible values are: 0 (Default): the driver uses the value for the global wait_timeout variable to initialize the wait_timeout session 1: the driver uses the global interactive_timeout variable value to initialize the wait_time session The wait_timeout variable, controlled by InteractiveClient, can be modified after the connection has been made.
HostName InteractiveClient
LoadBalancing
You can enable client load balancing when connecting to primary and alternate servers. You have the following options: 0: (Default) disables client load balancing. Connection attempts to database servers are performed sequentially, starting with the primary server. 1: enables client load balancing. Connection attempts to database servers are performed in no particular order. Note: Use the AlternateServers parameter to define alternate servers to connect to.
User ID used to log on to the database. Password for connecting to your database. Port number of the server listener. Default is 3306.
511
Description Specifies the format in which the driver returns errors encountered when converting code pages. Errors are returned with the following message: Code page conversion error encountered. If the error occurs when converting parameter data, the following sentence is added: Error in parameter X, where X is the number of the parameter. You have the following options when specifying the formatting: 0 (Default): For each character that cannot be converted, the driver substitutes 0x1A and does not display an error message. 1: for each character that cannot be converted the driver displays an error message. 2: for each character that cannot be converted, the driver substitutes 0x1A for each unconverted character and displays an error message.
TreatBinaryAsChar
Specifies how the driver returns data that MySQL stores as BINARY or VARBINARY, and specifies the data type the driver uses to describe these values. You have the following options: 0 (Default): data that MySQL has stored as BINARY or VARBINARY is described and returned as BINARY or VARBINARY values, respectively. 1:data that MySQL has stored as BINARY or VARBINARY is described and returned as CHAR or VARCHAR values, respectively.
Parameter ConnectionRetryCount
Description You can indicate the number of times this driver will attempt to connect to the primary or alternate servers (if enabled), if the initial attempt fails. The limits of this parameter are: 0: (Default) No attempt is made to reconnect. 65535: Maximum number of retries. You can specify the amount of time, in seconds, that the driver delays between attempts to connect to the primary server and alternate servers, if specified. Integers within the following limits are valid: 0: There is no delay between attempts to reconnect. 3 (default): The default delay is three seconds. 65535: The maximum delay between attempts to reconnect. This parameter only has an effect if the ConnectionRetryCount parameter is set to a value other than 0.
ConnectionRetryDelay
Specifies the database to use. Description of the data source. Path where the ODBC driver being used is located. You can enable the ODBC API function SQLDescribeParam. You have the following options: 0: (Default) Disables the SQLDescribeParam function. 1: (Default when using Microsoft Remote Data Objects to access data) Enables the SQLDescribeParam function. Name of the host machine where the database server resides. This may also be the IP address. You can enable client load balancing when connecting to primary and alternate servers. You have the following options: 0: (Default) disables client load balancing. Connection attempts to database servers are performed sequentially, starting with the primary server. 1: enables client load balancing. Connection attempts to database servers are performed in no particular order. Note: Use the AlternateServers parameter to define alternate servers to connect to.
HostName LoadBalancing
User ID used to log on to the database. Password for connecting to your database. Port number of the server listener. Default is 5432.
513
Description Specifies the format in which the driver returns errors encountered when converting code pages. Errors are returned with the following message: Code page conversion error encountered. If the error occurs when converting parameter data, the following sentence is added: Error in parameter X, where X is the number of the parameter. You have the following options when specifying the formatting: 0 (Default): For each character that cannot be converted, the driver substitutes 0x1A and does not display an error message. 1: for each character that cannot be converted the driver displays an error message. 2: for each character that cannot be converted, the driver substitutes 0x1A for each unconverted character and displays an error message.
XMLDescribeType
Specifies what SQL Data Type the SQLGetTypeInfo() returns for the XML Data type. You have the following options: -4: The description SQL_LONGVARBINARY is used for DB2 XML data type columns. -10(Default): The description SQL_WLONGVARCHAR is used for DB2 XML data type columns.
ODBC
Parameter IANAAppCodePage Description You must provide a value for this parameter if your application is not enabled to support Unicode or you use a non-Unicode database character set. The value that you specify must be the value used for the code page used by your application. The driver on UNIX/Linux determines the value of the applications code page by checking for an IANAAppCodePage value, in the following order: 1 In the connection string 2 In the DataSource section of the odbc.ini file 3 In the ODBC section of the odbc.ini file The default value for this parameter provides support for most environments. If this parameter must be modified to support your code page, refer to the Data Direct documentation provided in the Help\English\odbcHelp folder. This folder location can be located in the MicroStrategy Common Files on Windows environments, and in the MicroStrategy install path on UNIX and Linux environments. Note: The IANAAppCodePage connection string parameter replaces the AppCodePage connection string parameter in earlier versions of Connect for ODBC. The drivers are backward compatible with the AppCodePage parameter, but you must now use the IANAAppCodePage parameter. In this case, the parameter uses the value in the ODBC section of the odbc.ini file. InstallDir Location where ODBC drivers are installed.
Description Specifies whether tracing is on or off. Location of the ODBC trace shared lib\dll. File where tracing is logged. This setting is not used in UNIX. It specifies whether the CursorLibrary in the driver or the one that comes with the ODBC components is used. On the UNIX platform, no ODBC Manager CursorLibrary is available, which means that the driver CursorLibrary is always used.
Sybase IQ
Parameter AutoStop CommLinks DatabaseName Description Driver EngineName PWD UID Description Specifies whether the database should continue running after connections are disconnected. Host name and port number of the server that runs the database. The value should be as follows: tcpip(host=X.X.X.X;port=x) Name of the database to connect. Description of the data source. Path where the ODBC driver being used is located. Name of the database Server to connect. Password used to connect to your database. User ID to connect to the database.
515
Teradata Server
Parameter CharacterSet Description Specifies the default character set for the session. The default character set for Single Byte Character Sets (SBCS) is ASCII. For DBCS character sets, the value in the KanjiFormat option should match the character set name specified for this option. You have the following options: blank (default for KanjiFormat) ASCII (for SBCS) UTF8 SCHEBCDIC935_2IJ, TCHEBCKIC937_3IB TCHBIG5_1RO, SDTCHBIG5_3RO SCHEGB2312_1TO, SDSCHGB2312_2TO SDSCHEBCDIC935_6IJ, SDTCHEBCDIC937_7IB SDKANJIEBCDIC5026_4IG, SDKANJIEBCDIC5035_4IH SDKANJIEUC_1U3, SDKANJISJIS_1S3 HANGULEBCKIC933_1II, HANGULKSC5601_2R4 SDHANGULEBCKIC933_5II, SDHANGULKSC5601_4R4 KANJISJIS_OS, KANJIEUC_OU Name of the database to connect. Specifies whether the ODBC driver should handle DATEs, TIMEs, and TIMESTAMPs as integer values or ANSI-compatible strings. III specifies that all three should be handled as integer values. AAA specifies that they should be handled as ANSI-compatible strings. Identifies the host by name (alias) or IP Address. Name of the default database. Description of the data source. Path where the ODBC driver being used is located. Specifies whether to enable extended statement information for databases that support extended statement information, which includes Teradata V2R6.2 and later versions. Enabling extended statement information also supports parameterized queries. You have the following options: Yes: Enables extended statement information, which includes supporting the SQLDescribeParam API function. Enabling extended statement information also supports parameterized queries. No: Disables extended statement information and parameterized queries.
Database DateTimeFormat
Parameter IANAAppCodePage
Description Used with the transliteration system. The code page that you specify must be the same as the code page used by your application. The driver on UNIX/ Linux determines the value of the applications code page by checking for an IANAAppCodePage value, in the following order: 1 In the connection string 2 In the DataSource section of the system file (odbc.ini) 3 In the ODBC section of the system file (odbc.ini) The default value for this parameter provides support for most environments. If this parameter must be modified to support your code page, refer to the Data Direct documentation provided in the Help\English\odbcHelp folder. This folder location can be located in the MicroStrategy Common Files on Windows environments, and in the MicroStrategy install path on UNIX and Linux environments. Note: The IANAAppCodePage connection string parameter replaces the AppCodePage connection string parameter in earlier versions of Connect for ODBC. The drivers are backward compatible with the AppCodePage parameter, but you must now use the IANAAppCodePage parameter. In this case, the parameter uses the value in the ODBC section of the odbc.ini file.
LastUser NoScan
Remembers the connection for the last user. You can enable parsing of SQL statements in the driver. You have the following options: Yes: (Default) Parsing is disabled. The parser in the driver is bypassed and the SQL statement is sent directly to Teradata. Setting this option to Yes when the SQL statement contains ODBC-specific syntax results in Teradata Database reporting errors. No: Parsing is enabled in the driver and SQL statements are sent to the parser. Password used to connect to your database. Specifies whether the driver should display standard message boxes on the screen. Specifies the mode for sessions. Values can be Teradata, ANSI, or System Default.
517
Parameter StCheckLevel
Description You can enable enhanced ODBC state checking to detect SQLState 24000 (invalid cursor state error) according to the requirements from the ODBC SDK. You have the following options: 0: (Default) No additional state checking is performed and provides backward compatibility. The ODBC driver does not generate error 24000 when an ODBC function generates a result set (open cursor state), and then another function that generates a result set is called before the first results were fetched or freed. This can be caused by ODBC functions such as SQLExecute, SQLExecDirect, or an ODBC catalog function. 1: The driver generates SQLState 24000 error if an application is in an open cursor state and SQLColumns, SQLColumnPrivileges, SQLExecDirect, SQLExecute, SQLForeignKeys, SQLGetTypeInfo, SQLPrepare, SQLPrimaryKeys, SQLProcedureColumns, SQLProcedures, SQLSpecialColumns, SQLStatistics, SQLTablePrivileges, or SQLTables is called. 2: The driver generates SQLSTate 24000 error if an application is not in an open cursor state and SQLCol, SQLDescribeCol, or SQLFetch is called. Specifies whether native Large Object (LOB) data type mappings are supported. This setting is most relevant for backward compatibility to support databases that do not support native LOB. You have the following options: Yes: (Default for databases that support LOB) Native LOB is supported for the database. ODBC is used to map the SQL_LONGVARBINARY data type to Teradatas Binary Large Object (BLOB), and to map the SQL_LONGVARCHAR data type to Teradatas Character Large Object (CLOB). No: Native LOB is not supported for the database. This option should be used for databases that do not support LOB to maintain backward compatibility. ODBC is used to map the SQL_LONGVARBINARY data type to Teradatas VARBYTE(32000), and to map the SQL_LONGVARCHAR data type to Teradatas LONG VARCHAR. User ID used to connect to your database.
UseNativeLOBSupport
Username
Netezza
Parameter Database Password Port ReadOnly Description Name of the database to connect. Password used to connect to your database. The port number for the connection. Check with your database administrator for the correct number. The default is 5480. Specifies whether intermediate tables can be created. 0: (Default) Intermediate tables can be created. 1: Intermediate tables cannot be created.
Description The machine name or IP address of the host machine for the database. User ID used to connect to the database.
519
B
B.
TROUBLESHOOTING
Introduction
This appendix provides information on common problems that you might encounter while installing and configuring MicroStrategy on UNIX, Linux, and Windows operating systems.
521
Troubleshooting
1 Enter the command su and the root password at the command prompt, or log in as root to become the superuser (su). The command prompt changes to the pound sign (#). 2 If the /cdrom directory does not already exist, enter # mkdir /cdrom 3 If the /cdrom/cdrom0 directory is empty because the CD-ROM was not mounted, or if File Manager did not open a window displaying the contents of the CD-ROM, verify that the vold daemon is running by entering the following: # ps -e | grep vold | grep -v grep The vold process manages the CD-ROM device and performs the mounting. 4 If vold is running, the system displays the process identification number of vold. If the system does not display anything, stop and start the daemon by entering # /usr/sbin/vold & 5 If the vold daemon is running but did not mount the CD-ROM, stop the vold daemon and then stop and start it. To stop it you need to know the identification process number, which can be obtained by entering # ps -ef | grep vold | grep -v grep
Troubleshooting
6 Stop the vold process by entering # kill -15 process_ID_number 7 Stop and start the vold process by entering # /usr/sbin/vold & If you encounter problems using the vold daemon, enter one of the following commands to mount the CD-ROM: # etc/mountall # mount -F hsfs -r ro /dev/dsk/cxtyd0sz /cdrom/cdrom0 where x is the CD-ROM drive controller, y is the CD-ROM drive SCSI ID number, and z is the slice of the partition on which the CD-ROM is located.
To unmount the CD-ROM on Solaris
Type the following commands to unmount the CD-ROM on Solaris: 1 # cd 2 # umount /cdrom/cdrom0 3 # eject
523
Troubleshooting
1 If necessary, use the mkdir command to create a mount point for the CD. The following command creates a mount point at /cdrom; you can mount the CD at any location on the machines local file system. # mkdir /cdrom commands in this procedure assume the CD is mounted at / The cdrom. If you mount the CD at a different location, use that location when issuing commands. 2 Mount the CD-ROM drive by entering # mount -o ro -v cdrfs /dev/cdnumber /cdrom In this command, number is the CD-ROM number for your system, usually 0 (zero). An example of the above command follows: # mount -o ro -v cdrfs /dev/cd0 /cdrom 3 Navigate to the /cdrom directory by entering # cd /cdrom
To unmount the CD-ROM on AIX
Type the following command to unmount the CD-ROM on AIX: # unmount /cdrom This command assumes the CD is mounted at /cdrom. If you mount the CD at a different location, use that location when issuing commands.
Troubleshooting
1 If necessary, use the mkdir command to create a mount point for the CD. The following command creates a mount point at /cdrom; you can mount the CD at any location on the machines local file system. # mkdir /cdrom 2 To return the CD drive file path, enter # ioscan -funC disk 3 Mount the CD-ROM drive by entering # mount filepath /cdrom In this command, filepath is the CD drive file path returned from step 2. An example of the above command follows: # mount /dev/dsk/c0t0d0 /cdrom 4 Navigate to the /cdrom directory by entering # cd /cdrom
To unmount the CD-ROM on HP-UX
Type the following command to unmount the CD-ROM on HP-UX: # unmount /cdrom This command assumes the CD is mounted at /cdrom. If you mount the CD at a different location, use that location when issuing commands.
525
Troubleshooting
1 Browse to INSTALL_PATH where INSTALL_PATH is the directory you specified as the Install Directory during installation 2 Open the install.log file. (For Unix, use an editor with a command like dtpad install.log. For Windows, use Notepad or some other text editor to open the file.) 3 Review the error messages. A common error is to run out of space.
Troubleshooting
2 Click Options. This launches the Service Options dialog box. 3 Click Intelligence Server Options tab to view the port number.
527
Troubleshooting
5 An XML file is returned. Search for the tag <tcp_port_number>, which contains a port number you can use. Record this number.
Troubleshooting
529
Troubleshooting
Permission errors
This section provides troubleshooting information on permission errors in a UNIX or Linux environment.
GLOSSARY
activation code A code used to activate MicroStrategy Intelligence Server. This code is sent to an email address provided during activation. attribute A data level defined by the system architect and associated with one or more columns in a data warehouse lookup table. Attributes include data classifications like Region, Order, Customer, Age, Item, City, and Year. They provide a means for aggregating and filtering at a given level. attribute element A value of any of the attribute forms of an attribute. For example, New York and Dallas are elements of the attribute City; January, February, and March are elements of the attribute Month. caches A special data store holding recently accessed information for quick future access. This is normally done for frequently requested reports, whose execution is faster because they need not run against the database. Results from the data warehouse are stored separately and can be used by new job requests that require the same data. In the MicroStrategy environment, when a user runs a report for the first time, the job is submitted to the database for processing. However, if the results of that report are cached, the results can be returned immediately without having to wait for the database to process the job the next time the report is run.
531
Glossary
connection string Stores the information required to connect to a database server. A connection string usually includes a DSN and the user ID and password required to log in to the database server. This information varies depending on the particular database server. data source name Provides connectivity to a database through an ODBC driver. (DSN) A DSN generally contains host machine name or IP address, instance name, database name, directory, database driver, User ID, password, and other information. The exact information included in the DSN varies by DBMS. Once you create a DSN for a particular database, you can use it in an application to call information from the database. There are three types of DSNs: 1) System DSN: can be used by anyone who has access to the machine. DSN info is stored in the registry. 2) User DSN: is created for a specific user. Also stored in the registry. 3) File DSN: DSN information is stored in a text file with .DSN extension. data warehouse 1) A database, typically very large, containing the historical data of an enterprise. Used for decision support or business intelligence, it organizes data and allows coordinated updates and loads. 2) A copy of transaction data specifically structured for query, reporting, and analysis. document 1. A container for objects representing data coming from one or more reports, as well as positioning and formatting information. A document is used to format data from multiple reports in a single display of presentation quality. 2. The MicroStrategy object that supports the functionality defined in (1). DSN See data source name (DSN).
Glossary
hierarchy A set of attributes defining a meaningful path for element browsing or drilling. The order of the attributes is typicallythough not alwaysdefined such that a higher attribute has a one-to-many relationship with its child attributes. HTML document An HTML document is a container for creating dashboards and scorecards to display a group of reports within the MicroStrategy platform. You can use HTML documents to format data from multiple reports and graphs in a single display of presentation quality. installation log file The MicroStrategy 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. load balancing A strategy aimed at achieving even distribution of MicroStrategy Web Universal user sessions across MicroStrategy Intelligence Servers. MicroStrategy achieves four-tier load balancing by incorporating load balancers into MicroStrategy Web Universal. metadata A repository whose data associates the tables and columns of a data warehouse with user-defined attributes and facts to enable the mapping of the business view, terms, and needs to the underlying database structure. Metadata can reside on the same server as the data warehouse or on a different database server. It can even be held in a different RDBMS. ODBC See Open Database Connectivity. ODBC driver A software routine that translates MicroStrategy Intelligence Server requests into commands that the DBMS understands. ODBC driver manager Coordinates communication between a client application and database server. The client application tells the driver manager that it needs to connect using a particular connection string. The DSN found in this connection string
533
Glossary: hierarchy
Glossary
provides the driver manager with the type of database server to which the application needs access. From this information, the driver manager decides what driver to use and initiates the communication. Open Database An open standard with which client computers can Connectivity communicate with relational database servers. Client machines make a connection to a particular logical database, on a particular physical database server, using a particular ODBC driver. port number The port number is how a server process identifies itself on the machine on which it is running. For example, when the Intelligence Server machine receives a network call from a client (Developer, Web Universal, Narrowcast Server, Command Manager, and so on), it knows to forward those calls to the Intelligence Server port number that is specified in the call. prefix A prefix is stored in the project metadata associated with a table or tables and is used by the Engine to generate SQL. Also, the Catalog Server uses it to obtain table sample values and row counts. In most cases, it should match the name space field since it is used to qualify on a specific table belonging to a certain owner or name space. Prefixes can be defined and modified from the Warehouse Catalog interface. process An executing application comprising one or more threads. Processes use temporary private address spaces and control operating system resources such as files, dynamic memory allocations, pipes, and synchronization objects. project 1) The highest-level intersection of a data warehouse, metadata repository, and user community, containing reports, filters, metrics, and functions. 2) An object containing the definition of a project, as defined in (1). The project object is specified when requesting the establishment of a session.
Glossary
project source Defines a connection to the metadata database and is used by various MicroStrategy products to access projects. A direct project source is a two-tier connection directly to a metadata repository. A server project source is a three-tier connection to a MicroStrategy Intelligence Server. One project source can contain many projects and the administration tools found at the project source level are used to monitor and administer all projects in the project source. schema object A MicroStrategy object created, usually by a project designer, that relates the information in the logical data model and physical warehouse schema to the MicroStrategy environment. These objects are developed in MicroStrategy Architect, which can be accessed from MicroStrategy Developer. Schema objects directly reflect the warehouse structure and include attributes, facts, functions, hierarchies, operators, partition mappings, tables, and transformations. server definition A MicroStrategy object stored in the metadata containing information about the configuration of an Intelligence Server. server instance The combination of an Intelligence Server running with a particular server definition. statistics tables Tables that are used to record a variety of statistical information about the usage and performance of a MicroStrategy system. Structured Query The query language standardized in 1986 by the American Language (SQL) National Standards Institute (ANSI) and used to request information from tables in a relational database and to manipulate the tables structure and data.
535
Glossary
INDEX
A
absolute path for microstrategy.xml 312 Access. See Microsoft Access. accessing MicroStrategy Connectivity Wizard 166 MicroStrategy Installation Wizard UNIX 129 Windows 105 MicroStrategy Readme 163 MicroStrategy Web Administrator page 262 Oracle Glassfish Server 275 Web Universal 246 activating installation 148 activation code 146 FAQ 149 UNIX 139 Windows 114 activation code defined on 146 activating installation with 148 requesting 146 UNIX 139 Windows 114 adding or removing MicroStrategy components (Windows) 444
2013 MicroStrategy, Inc.
admin role, assigning to a user JBoss - Windows - Web/Web Universal 308 Oracle 10g - Windows - Web/Web Universal 301 Oracle Glassfish Server 272 Tomcat - Linux 291 Tomcat - Windows - Web/Web Universal 284 WebSphere - AIX - Web/Web Universal 261 Administrative Server 256 AIX MicroStrategy Intelligence Server hardware requirements 31 patch requirements 61 Web server OS 66 Analyst. See MicroStrategy Analyst. Analytics Modules. See MicroStrategy Analytics Modules. Apache Hive Wire Protocol ODBC Driver for 458 Apache Tomcat application server 68 Apache TomEE application server 68 Apache Web server 69 configuring to serve a static file 251
537
Index
deploying MicroStrategy Mobile Server JSP with 236 deploying MicroStrategy Web Universal with 236 proxy request to WebLogic 239 starting 263 application server Apache Tomcat 68 Apache TomEE 68 IBM WebSphere 68 JBoss 68 Oracle 10g 68 Oracle WebLogic 68 supported 68 Architect. See MicroStrategy Architect. ASP.NET MicroStrategy Mobile Server and IIS 232 MicroStrategy Web and IIS 231 Aster, ODBC driver for (Linux) 480 attribute element 80 authentication 199 anonymous 200 database 201 Integrated 201 LDAP 201 standard 200 Windows 200 automatic deployment MicroStrategy Mobile Server JSP 240 Web Universal 240 WebLogic 240
C
cache 80 CD-ROM mounting on AIX 524 mounting on HP-UX 525 mounting on Solaris 522 unmounting on AIX 524 unmounting on HP-UX 525 unmounting on Solaris 523 certified database and ODBC driver for MicroStrategy Intelligence Server 87 command line mode configuring metadata 420 creating project source 434 MicroStrategy Configuration Wizard 419 MicroStrategy Intelligence Server setup 429 Command Manager. See MicroStrategy Command Manager. common setups 24 compatibility between Web Universal and Intelligence Server 86 component 2 MicroStrategy Analytics Modules 21 MicroStrategy Developer 3 MicroStrategy Health Center 22 MicroStrategy Intelligence Server 6 MicroStrategy Narrowcast Server 20 MicroStrategy Office 19 MicroStrategy Portlets 13 MicroStrategy SDK 15 MicroStrategy Tutorial Reporting 22 MicroStrategy Web and Web Universal 11 MicroStrategy Web Services 20 SequeLink ODBC Socket Server 21 Configuration Wizard. See MicroStrategy Configuration Wizard.
2013 MicroStrategy, Inc.
B
backup frequency 82
538
Index
configuring Apache Web server to serve a static file 251 command line mode (UNIX) 418 JBoss 305 metadata repository and statistics tables 177 MicroStrategy command line mode 419 Oracle JDK JBoss on Windows 304 Tomcat on Linux 287 Tomcat on Windows 278 Tomcat Linux 288 Windows 280 configuring ODBC UNIX 164 Windows 163 connection errors, data source name 528 connection mapping 225 connection string defined on 161 connectivity 169 Connectivity Wizard. See MicroStrategy Connectivity Wizard.
D
data source name 160 connecting to 179 connection errors 528 creating with Connectivity Wizard 165 creating with Microsoft ODBC Data Source Administrator 168 data warehouse 218 data source, accessing 211 data warehouse defined on 160 communicating with 158 connecting to 210 connection setting 211
2013 MicroStrategy, Inc.
DSN 218 login 223 database authentication 201 database connection defined on 218 certified ODBC driver 87 database instance defined on 211 creating 217 database login defined on 223 creating 223 database management system (DBMS) defined on 158 DB Query Tool 169 DB2 for i ODBC driver 456 DB2 for iSeries ODBC driver 456 DB2 ODBC driver (UNIX/Linux) 455 DB2 Wire Protocol ODBC driver (Windows) 455 DB2 Wire Protocol parameters for odbc.ini 499 DB2 z/OS ODBC driver 457 DBMS. See database management system. deploying MicroStrategy Mobile Server JSP 240 JBoss (Windows) 303 Oracle 10g 298 Oracle Glassfish Server 266, 268 SAP NetWeaver (Windows) 293 Tomcat 278 WAR file with Oracle Glassfish Server 271 WebLogic and Apache 236 WebLogic manual deployment 240 WebSphere and IBM HTTP Server 253 deploying MicroStrategy Mobile Server with ASP.NET and IIS 232 deploying MicroStrategy Web 231 deploying MicroStrategy Web Universal JBoss (Windows) 303 Linux 290
539
Index
manually deploying with WebLogic 240 Oracle 10g 298, 300 Oracle Glassfish Server 266, 268 SAP NetWeaver (Windows) 293, 295 Tomcat 278 Tomcat (Linux) 290 WAR file with Oracle Glassfish Server 271 WebLogic and Apache 236, 239 WebLogic automatic deployment 240 WebSphere 256 WebSphere and IBM HTTP Server 253 Developer. See MicroStrategy Developer. direct project source 196, 197 directory structure for UNIX 143 document defined on 318 driver. See ODBC driver. DSN Creator 528
setup.exe 328 folder structure for WebLogic and Apache 236 Freeform SQL, accessing data sources 211 Function Plug-in Wizard. See MicroStrategy Function Plug-in Wizard.
G
Greenplum Wire Protocol ODBC Driver for 457
H
Hadoop Hive support for 91 hardware recommendations Web Universal on UNIX/Linux 31 Windows 28 hardware requirements for Intelligence Server on UNIX/Linux 31 Health Center. See MicroStrategy Health Center. History List creating repository 183 tables 183 hotfix installation of MicroStrategy Office 377 silent installation (Windows) 376 HP-UX Java development kit 70 MicroStrategy Intelligence Server hardware requirements 31 patch requirements 62 Web server OS 66 HTML document 317, defined on 319 setting up document creation 320 setting up document execution 323
E
element browsing defined on 80 Enterprise Manager. See MicroStrategy Enterprise Manager. example microstrategy.xml 312 response.ini file for installation (Windows) 348 response.ini file for MicroStrategy Configuration Wizard (Windows) 202 response.ini file for uninstallation 371 Excel. See Microsoft Excel.
F
file install.log 329 preinst.log 374
540
Index
I
IBM HTTP Server configuring to serve a static file 266 web server 69 IBM JDK, Java development kit 70 IBM WebSphere, application server 68 IBM, Java development kit 70 IIS. See Microsoft IIS. Impala Wire Protocol ODBC Driver for 458 Informix 8 ODBC driver for (UNIX/Linux) 475 ODBC driver for (Windows) 460 Informix Wire Protocol ODBC Driver for 459 parameters for odbc.ini 504 Informix XPS, parameters for odbc.ini 502 install.log 329 installation creating response.ini file (Windows) 331 install.log file 329 OEM environments 401 OEM silent (Windows) 406 plug-in for Apache 239 reducing download size 23, 96, 106, 130, 397 response.ini file (Windows) 330 silent (UNIX) 382 silent (Windows) 373 silent installation of hotfix (Windows) 376 troubleshooting silent (Windows) 375 installation log file 328, defined on 328 installation method 94 Command line mode 95 GUI mode 94
silent installation 95 installation prerequisites 23 hardware recommendations for Web Universal on UNIX/Linux 31 hardware recommendations for Windows 28 hardware requirements for Intelligence Server on UNIX/Linux 31 large production deployment 27 recommended installation location 24 small production deployment 25 software recommendations for SDK with JSP 72 software recommendations for Web Services J2EE 70 software recommendations for Web Universal 64 software recommendations for Windows 39 software requirements for Intelligence Server on UNIX/Linux 57 installation procedure checklist 99 Linux 126 MicroStrategy Installation Wizard on Linux 129 MicroStrategy Installation Wizard on UNIX 129 MicroStrategy Installation Wizard on Windows 105 UNIX 126 Windows 104 Intelligence Server. See MicroStrategy Intelligence Server. Intelligent Cube size 86 international support xxvi, 86
J
Java development kit
541
Index
IBM JDK 70 Oracle JDK 70 supported 70 Java heap size, setting Tomcat (Web/Web Universal) 281, 289 WebLogic and Apache (Web/Web Universal) 249 WebSphere (Web/Web Universal) 264 JBoss (Windows - Web/Web Universal) configuring 305 preconfiguration information 304 JBoss application server 68 JSP file, precompiling 249, 265
L
launching the project on WebLogic and Apache 248 launching WebSphere Administrative Console on Web/Web Universal 256 LDAP authentication 201 license 98 Linux deploying MicroStrategy Web Universal 290 installation procedure 126 MicroStrategy Installation Wizard 129 MicroStrategy Intelligence Server hardware requirements 31 patch requirements 62 Web server OS 66 log installation 328 statistics 82
M
manual deployment
MicroStrategy Mobile Server JSP 240 Web Universal 240 MDX cube source accessing a data source 211 installing the MDX Cube Provider 118 metadata defined on 160, 177 table 180 metadata repository 172, 177, 192, 404 creating 179 methods of automated installation (Windows) 329 Microsoft Access connecting as data source (UNIX/Linux) 465 preparing database for access 466 Microsoft Excel connecting as data source 488 connecting as data source (UNIX/Linux) 465 creating DSN 489 preparing as data source 488 preparing file for access 468 Microsoft IIS 78, 230 ASP.NET and MicroStrategy Mobile Server 232 ASP.NET and MicroStrategy Web 231 supporting IIS 7 or 7.5 76 web server 69 Microsoft ODBC Data Source Administrator 168 creating a DSN using 168 Microsoft SQL Azure ODBC driver 464 Microsoft SQL Server ODBC driver 464 MicroStrategy MDX Cube Provider 118 uninstalling (UNIX/Linux) 449 MicroStrategy Administrator MicroStrategy Command Manager 4
2013 MicroStrategy, Inc.
542
Index
MicroStrategy Enterprise Manager 6 MicroStrategy Object Manager 5 MicroStrategy Analyst 3 MicroStrategy Analytics Modules 21 MicroStrategy Architect 3 MicroStrategy Command Manager 4 MicroStrategy common setups 24 MicroStrategy component 2 MicroStrategy Analytics Modules 21 MicroStrategy Developer 3 MicroStrategy Health Center 22 MicroStrategy Intelligence Server 6 MicroStrategy Narrowcast Server 20 MicroStrategy Office 19 MicroStrategy Portlets 13 MicroStrategy SDK 15 MicroStrategy Tutorial Reporting 22 MicroStrategy Web and Web Universal 11 MicroStrategy Web Services 20 re-installing 445 re-installing MicroStrategy Office MicroStrategy Office re-installing 446 SequeLink ODBC Socket Server 21 MicroStrategy Configuration Wizard 173 accessing on UNIX/Linux 176 accessing on Windows 175 configuring MicroStrategy Health Center 177 connecting to a DSN 179 creating a metadata repository 179 prerequisites 172 response.ini file (Windows) 201, 370 setting up Intelligence server 190 upgrading MicroStrategy 177 MicroStrategy Connectivity Wizard 165 accessing 166 creating a DSN 165
2013 MicroStrategy, Inc.
MicroStrategy Developer MicroStrategy Analyst 3 MicroStrategy Architect 3 MicroStrategy Function Plug-in Wizard 3 MicroStrategy Server Administrator 4 subcomponents 3 MicroStrategy Distribution Services 9 MicroStrategy Enterprise Manager 6, 186 MicroStrategy Function Plug-in Wizard 3 MicroStrategy Health Center 22 configuring 177 configuring with a response.ini file 201 MicroStrategy installation prerequisites 23 MicroStrategy Installation Wizard Linux 129 UNIX 129 Windows 105 MicroStrategy Intelligence Server 6, 178, 193 certified database and ODBC driver 87 compatibility with Web Universal 86 connecting to Mobile Server 233 connecting to Web 231 creating a server definition 192 database connection 158 Enterprise edition 7 hardware requirements (UNIX/Linux) 31 MicroStrategy Distribution Services 9 MicroStrategy OLAP Services 8 MicroStrategy Report Services 9 migrating from Windows to UNIX/Linux 141 selecting a project 194 setting up 190 software requirements
543
Index
(UNIX/Linux) 57 subcomponents 8 Universal edition 7 MicroStrategy MDX Cube Provider installing 118 MicroStrategy Mobile Server connecting to Intelligence Server 233 deploying with ASP.NET and IIS 232 MicroStrategy Mobile Server Administrator page configuring for Oracle Glassfish Server 275 configuring for WebSphere 262 controlling access to JBoss Windows 308 Tomcat Linux 291 Tomcat Windows 284 controlling access to (Oracle Glassfish Server) 272 MicroStrategy Mobile Server JSP deployment 236 JBoss (Windows) 303 SAP NetWeaver (Windows) 293 WebLogic manual deployment 240 MicroStrategy Mobile support on IIS 7 or 7.5 76 MicroStrategy Narrowcast Server 20 MicroStrategy Object Manager 5 MicroStrategy Office allowing a user to install from a network location 19 allowing installation from MicroStrategy Web 109 hotfix installation 377 silent installation 377 MicroStrategy OLAP Services 8 sizing guidelines 81 MicroStrategy Portlets 13 MicroStrategy Professional Services 83 MicroStrategy Readme, access to 163
544
MicroStrategy Report Services 9 setting up document execution 325 MicroStrategy Server Administrator 4 MicroStrategy System Manager overview 18 MicroStrategy Tutorial Reporting 22 MicroStrategy Web 230 allowing a user to install MicroStrategy Office from 109 ASP.NET 231 connecting to Intelligence Server 231 deploying 231 supporting on IIS 7 or 7.5 76 Web Analyst 12 Web Professional 12 Web Reporter 12 MicroStrategy Web Administrator page 310 accessing (JBoss Windows) 309 accessing (Oracle) 302 accessing (Tomcat Linux) 292 accessing (Tomcat Windows) 285 controlling access to (JBoss Windows) 308 controlling access to (Oracle Glassfish Server) 272 controlling access to (Tomcat Linux) 291 controlling access to (Tomcat Windows) 284 MicroStrategy Web and Web Universal versions 12 MicroStrategy Web Universal 12 compatibility with Intelligence Server 86 deploying automatically with WebLogic 240 deploying manually with WebLogic 240 deploying on Oracle 10g 300
2013 MicroStrategy, Inc.
Index
deploying with JBoss (Windows) 303 deploying with SAP NetWeaver (Windows) 293 launching project (JBoss Windows) 310 launching project (Oracle 10g) 303 launching project (Tomcat Linux) 293 launching project (Tomcat Windows) 286 undeploying 277 Web Analyst 12 Web Professional 12 Web Reporter 12 microstrategy.xml absolute path 312 example 312 sample modified 312 migrating MicroStrategy Intelligence Server 141 MSTRInst.log 374 MultiSource Option 211 MySQL ODBC driver for (Linux) 478 Wire Protocol driver for 460
N
Narrowcast Server. See MicroStrategy Narrowcast Server. Netezza ODBC driver for (UNIX/Linux) 477 ODBC driver for (Windows) 465 parameters for odbc.ini 518 network bandwidth 85
O
Object Manager. See MicroStrategy Object Manager. ODBC defined on 158, 160
2013 MicroStrategy, Inc.
default directory (UNIX) 164 default directory (Windows) 163 parameters for odbc.ini 514 ODBC connectivity 169 ODBC driver defined on 161 Apache Hive Wire Protocol 458 Aster (Linux) 480 certified 162 certified database 87 DB Query Tool 169 DB2 (UNIX/Linux) 455 DB2 (Windows) 455 DB2 for i 456 DB2 for iSeries 456 DB2 z/OS 457 Greenplum Wire Protocol 457 Impala Wire Protocol 458 Informix 8 (UNIX/Linux) 475 Informix 8 (Windows) 460 Informix Wire Protocol 459 Microsoft SQL Azure 464 Microsoft SQL Server 464 MySQL (Linux) 478 MySQL Wire Protocol 460 Netezza (UNIX/Linux) 477 Netezza (Windows) 465 odbc.ini file (UNIX/Linux) 493 Oracle Wire Protocol 461 other relational databases for Windows 487 PostgreSQL Wire Protocol 463 Red Brick (Linux) 471 Salesforce 470 SAP HANA 484 Sequelink 465 Sybase Adaptive Server IQ (UNIX/Linux) 473 Sybase ASE Wire Protocol 462
545
Index
Teradata (UNIX/Linux) 474 Teradata (Windows) 487 testing connectivity 169 text files 491 Vertica (Linux) 482 ODBC driver manager defined on 161 odbc.ini 493 DB2 Wire Protocol 499 Informix Wire Protocol 504 Informix XPS 502 Netezza 518 ODBC 514 Oracle Wire Protocol 495 Red Brick 515 Salesforce 505 Sybase Adaptive Server IQ 515 Sybase ASE Wire Protocol 507 Teradata 516 OEM installation 401 OLAP Services. See MicroStrategy OLAP Services. Open Database Connectivity defined on 158 options file 382 Oracle 10g application server 68 deploying MicroStrategy Mobile Server JSP 298 deploying MicroStrategy Web Universal 298, 300 deploying Web Universal with the Oracle Enterprise Manager 300 locating WAR file (MicroStrategy Mobile Server JSP) 299 locating WAR file (Web/Web Universal) 299 preconfiguration information (Web/Web Universal) 298 Oracle Glassfish Server
accessing MicroStrategy Web Administrator page 275 connecting to the Project page 277 deploying MicroStrategy Mobile Server JSP 266, 268 deploying MicroStrategy Mobile Server JSP as a WAR file 271 deploying MicroStrategy Web Universal 266, 268 deploying MicroStrategy Web Universal as a WAR file 271 locating WAR file 267 locating WAR file (MicroStrategy Mobile Server JSP) 267 recommended configuration for UNIX/Linux 267 undeploying Mobile Server JSP 277 undeploying Web Universal 277 Oracle Glassfish Server (Web/Web Universal) deploying MicroStrategy Mobile Server JSP as a WAR file 271 preconfiguration information 267 recommended configuration for UNIX/Linux 267 Oracle Glassfish Server Admin Console launching 269 Oracle iPlanet Web server 69 Oracle JDK configuring 278, 304 Oracle WebLogic application server 68 Oracle Wire Protocol ODBC driver for 461 parameters for odbc.ini 495
P
pageCheckSeconds parameter 250 parameters DB2 Wire Protocol 499
546
Index
Informix Wire Protocol 504 Oracle Wire Protocol 495 Red Brick 515 password to metadata 191 patch requirements AIX 61 HP-UX 62 Linux 62 Solaris 60 performance-based setup MicroStrategy Professional Services 83 WebLogic and Apache (Web/Web Universal) 248 permission errors 530 plug-in for Apache 239 plugin-cfg.xml, regenerating 260 port number defined on 198 Intelligence Server 193 portlets. See MicroStrategy Portlets. PostgreSQL Wire Protocol ODBC driver for 463 precompiling JSP file in WebLogic 249 JSP file in WebSphere 265 preconfiguration information Apache (Web/Web Universal) 237 JBoss (Windows - Web/Web Universal) 304 Oracle 10g (Web/Web Universal) 298 Oracle Glassfish Server (Web/Web Universal) 267 Tomcat (Linux - Web/Web Universal) 286 Tomcat (Windows - Web/Web Universal) 278 WebLogic (Web/Web Universal) 237 WebSphere (Web/Web Universal) 254 preinst.log 374
prerequisites for MicroStrategy Configuration Wizard 172 processor speed 84 production deployment large 27 small 25 project 211 accessing multiple data sources 211 project source 177, 178 authentication 199 direct 196, 197 server 196 three-tier 198 two-tier 197
Q
Query Builder, accessing data sources 211
R
R (analytics) integrating with MicroStrategy 3 R Integration Pack 3 Red Brick ODBC driver for 471 parameters for odbc.ini 515 re-deploying Web Universal with WebLogic 248 re-installing a MicroStrategy component (Windows) 445 control panel 445 re-installing MicroStrategy Office 446 Report Services. See MicroStrategy Report Services. requesting activation code 146 response.ini file creating for installation (Windows) 331 creating through MicroStrategy Config547
Index
uration Wizard (Windows) 202 example for installation (Windows) 348 example for uninstall (Windows) 371 installation (Windows) 330 MicroStrategy Configuration Wizard (Windows) 201, 370 MicroStrategy Health Center 202 parameters and options for Configuration Wizard (Windows) 205 parameters and options for installation (Windows) 331 uninstalling (Windows) 371 upgrade 202 using for Configuration Wizard (Windows) 204 using for installation (Windows) 370 using through Configuration Wizard (UNIX) 436 restarting WebSphere application server Web/Web Universal 260
S
Salesforce driver parameters for odbc.ini 505 ODBC driver for 470 SAP HANA ODBC driver for 484 SAP NetWeaver (Windows) deploying MicroStrategy Web Universal 295 SAP NetWeaver, locating WAR file 294 SDK. See MicroStrategy SDK. security access to MicroStrategy Web Administrator page 284, 291, 308 SequeLink configuring ODBC driver 469 Sequelink
548
ODBC driver for 465 SequeLink ODBC Socket Server 21 Server Administrator. See MicroStrategy Server Administrator. server definition defined on 178, 192 connectivity setting 210 server project source 196 setting up document creation HTML document 320 setting up document execution HTML document 323 Report Services documents 325 setup command-line parameter (Windows) 369 setup.exe 328 silent installation 373 hotfix (Windows) 376 introduction (UNIX) 382 OEM (Windows) 406 options file (UNIX) 382 output (UNIX) 398 output (Windows) 374 parameters (UNIX) 385 perform on Windows 406 System Management Server (SMS) on Windows 373 troubleshooting (Windows) 375 values for different languages 409 sizing guidelines 79 caching 80 Intelligent Cube size 86 MicroStrategy OLAP Services 81 MicroStrategy Professional Services 83 network bandwidth 85 number of users 79 processor speed 84 report complexity 79 Report Services document 81
2013 MicroStrategy, Inc.
Index
SMS. See System Management Server. software recommendations application server 68 Java development kit 70 SDK for JSP 72 Web Services J2EE 70 Web Universal 64 Windows 39 software requirements for Intelligence Server on UNIX/Linux 57 Solaris MicroStrategy Intelligence Server hardware requirements 31 patch requirements 60 Web server OS 66 specifying a port number 193 SQL query 171 script 189 starting Administrative Server 256 Apache Web Server 263 Web module for WebSphere 261 WebSphere Administrative Console 257 WebSphere default application server 257 static file configuring Apache Web server for 251 configuring IBM HTTP Server 266 statistics log 82 table 186 statistics table defined on 178 Sun Java development kit 70 support international xxvi, 86 support. See technical support.
2013 MicroStrategy, Inc.
supporting IIS 6 78 Sybase Adaptive Server IQ ODBC driver for (UNIX/Linux) 473 parameters for odbc.ini 515 Sybase ASE Wire Protocol ODBC driver for 462 parameters for odbc.ini 507 System Management Server (SMS) on Windows silent installation 373
T
table, metadata 180 technical support xxvii Teradata ODBC driver for (UNIX/Linux) 474 ODBC driver for (Windows) 487 parameters for odbc.ini 516 text file ODBC driver for (Windows) 491 three-tier project source 198 Tomcat deploying MicroStrategy Mobile Server JSP 278 deploying MicroStrategy Web Universal 278 Tomcat (Linux - Web/Web Universal) deploying MicroStrategy Web Universal 290 locating the WAR file 289 preconfiguration information 286 setting Java heap size 289 Tomcat (Web/Web Universal) configuring 280, 288 configuring Oracle JDK 287 Tomcat (Windows - Web/Web Universal) preconfiguration information 278 setting Java heap size 281 troubleshooting
549
Index
DSN connection errors 528 History List creation errors 528 metadata creation errors 528 permission errors 530 server port number errors 527 statistics creation errors 528 UNIX 521 Tutorial Reporting. See MicroStrategy Tutorial Reporting. two-tier project source 197
V
verifying installation UNIX 142 Windows 121 Vertica, ODBC driver for (Linux) 482
W
WAR file locating for JBoss (Windows) (MicroStrategy Mobile Server JSP) 306 locating for Oracle 10g (MicroStrategy Mobile Server JSP) 299 locating for SAP NetWeaver (MicroStrategy Mobile Server JSP) 294 locating for Tomcat (Linux) (MicroStrategy Mobile Server JSP) 289 locating for WebLogic (Mobile Server JSP) 238 locating for WebSphere (MicroStrategy Mobile Server JSP) 255 WAR file (Web/Web Universal) exploding for WebLogic and Apache (Web/Web Universal) 242 locating for JBoss (Windows) 305 locating for Oracle 10g 299 locating for Oracle Glassfish Server 267 locating for SAP NetWeaver 294 locating for Tomcat (Linux) 289 locating for Tomcat (Windows) 281 locating for WebLogic 238 locating for WebSphere 255 unzipping for WebLogic and Apache (Web/Web Universal) 245 Web module for WebSphere, starting 261 Web server
U
unattended installation (UNIX) 382 uninstalling Control Panel (Windows) 447 MicroStrategy (UNIX/Linux) 449 response.ini (Windows) 371 uninstalling MicroStrategy components (Windows) 447 MicroStrategy Office (Windows) 448 UNIX configuring ODBC 164 installation procedure 126 MicroStrategy Installation Wizard 129 verifying installation 142 user assigned to admin role JBoss - Windows (Web/Web Universal) 308 Oracle 10g - Windows (Web/Web Universal) 301 Oracle Glassfish Server 272 Tomcat - Linux 291 Tomcat - Windows (Web/Web Universal) 284 WebSphere - AIX- Web/Web Universal 261 user connection mapping. See connection mapping.
550
Index
Apache 69 IBM HTTP Server 69 Internet Information Server 69 Oracle iPlanet 69 Web server OS AIX 66 HP-UX 66 Linux 66 Solaris 66 Windows 66 Web Universal connection 310 hardware recommendations for UNIX/Linux 31 software recommendations 64 Web Universal. See also MicroStrategy Web Universal. Web. See MicroStrategy Web. web.xml re-deploying the application 248 WebLogic (Solaris - Web/Web Universal) 236 WebLogic and Apache deploying MicroStrategy Mobile Server JSP 236 locating the WAR file (MicroStrategy Mobile Server JSP) 238 production mode 240 WAR file 245 WebLogic and Apache (Web/Web Universal) deploying MicroStrategy Web Universal 236, 239 exploding the WAR file 242 folder structure 236 launching the project 248 locating the WAR file 238 pageCheckSeconds parameter 250 performance-based setup 248
precompiling JSP file 249 preconfiguration information 237 setting Java heap size 249 WebSphere locating the WAR file (MicroStrategy Mobile Server JSP) 255 WebSphere (Web/Web Universal) 253 application installation 258 deploying MicroStrategy Web Universal 256 launching Administrative Console 256 locating the WAR file 255 precompiling the JSP file 265 preconfiguration 254 regenerating plugin-cfg.xml 260 restarting application server 260 setting Java heap size 264 starting default application server 257 WebSphere and IBM HTTP Server deploying MicroStrategy Web Universal 253 Windows authentication 200 configuring ODBC 163 hardware recommendations 28 installation procedure 104 MicroStrategy Installation Wizard 105 software recommendations 39 supporting IIS 6 78 verifying installation 121 Web server OS 66 Windows INI 330
X
XSL report style 82
551
Index
552