Installation and Configuration Guide - MicroStrategyLinkingMicroStrategyLibrarytoMicroStrategyWeb...

Instal lat ion andConf igurat ion Guide

Version 2020

MicroStrategy 2020

March 2020Copyr ight © 2020 by MicroStrategy Incorporated. Al l r ights reserved.

Trademark Information

The fol lowing are ei ther trademarks or registered trademarks of MicroStrategy Incorporated or i ts affi l iates in the Uni ted States and cer tain other countr ies:

MicroStrategy, MicroStrategy 2020, MicroStrategy 2019, MicroStrategy 11, MicroStrategy 10, MicroStrategy 10 SecureEnterprise, MicroStrategy 9, MicroStrategy 9s, MicroStrategy Analytics, MicroStrategy Analytics Platform, MicroStrategyDesktop, MicroStrategy Library, MicroStrategyOperationsManager, MicroStrategy Analytics Enterprise, MicroStrategyEvaluation Edition, MicroStrategy Secure Enterprise, MicroStrategyWeb, MicroStrategyMobile, MicroStrategy Server,MicroStrategy Parallel Relational In-Memory Engine (MicroStrategy PRIME), MicroStrategyMultiSource, MicroStrategyOLAPServices, MicroStrategy Intelligence Server, MicroStrategy Distribution Services, MicroStrategy Report Services, MicroStrategyTransaction Services, MicroStrategy Visual Insight, MicroStrategyWeb Reporter, MicroStrategyWeb Analyst, MicroStrategyOffice, MicroStrategy Data Mining Services, MicroStrategyGeospatial Services, MicroStrategy Narrowcast Server,MicroStrategy Analyst, MicroStrategy Developer, MicroStrategyWeb Professional, MicroStrategy Architect, MicroStrategy SDK,MicroStrategy Command Manager, MicroStrategy Enterprise Manager, MicroStrategyObject Manager, MicroStrategy IntegrityManager, MicroStrategy SystemManager, MicroStrategy Analytics App, MicroStrategyMobile App, MicroStrategy TechSupport App, MicroStrategyMobile App Platform, MicroStrategy Cloud, MicroStrategy R Integration, Dossier, Usher,MicroStrategy Usher, Usher Badge, Usher Security, Usher Security Server, Usher Mobile, Usher Analytics, Usher NetworkManager, Usher Professional, MicroStrategy Identity, MicroStrategy Badge, MicroStrategy Identity Server, MicroStrategyIdentity Analytics, MicroStrategy Identity Manager, MicroStrategy Communicator, MicroStrategy Services, MicroStrategyProfessional Services, MicroStrategy Consulting, MicroStrategy Customer Services, MicroStrategy Education, MicroStrategyUniversity, MicroStrategyManaged Services, BI QuickStrike, Mobile QuickStrike, Transaction ServicesQuickStrike PerennialEducation Pass, MicroStrategyWeb Based Training (WBT), MicroStrategyWorld, Best in Business Intelligence, Pixel Perfect,Global Delivery Center, Direct Connect, Enterprise Grade Security For Every Business, Build Your Own Business Apps, Code-Free, Intelligent Enterprise, HyperIntelligence, HyperCard, HyperVoice, HyperVision, HyperMobile, HyperScreen, Zero-ClickIntelligence, Enterprise Semantic Graph, Information Like Water, TheWorld’sMost Comprehensive Analytics Platform, TheWorld’sMost Comprehensive Analytics Platform. Period.

Other product and company names mentioned herein may be the trademarks of their respective owners.

Speci fications subject to change without notice. MicroStrategy is not responsible for er rors or omissions. MicroStrategy makes no warranties or commitmentsconcerning the avai labi l i ty of future products or versions that may be planned or under development.

CONTENTS

Installation and Configuration Help 9

1. Planning Your Installation 10

Upgrade Considerations 11

Instal lation Prerequisi tes 92

Instal lation Considerations 114

Methods of Instal lation 129

Licensing Information 134

Instal lation and Configuration Checkl ists 135

2. Installing MicroStrategy on Windows 139

Instal lation Procedure in Windows 141

Configuring your MicroStrategy Instal lation 178

3. Installing MicroStrategy on Linux 180

Instal lation Procedures on Linux 181


Installing and Configuring MicroStrategy Library 217

MicroStrategy Library System Requirements 219

Library Administration Control Panel 220

Instal l ing MicroStrategy Library on Windows 226

Instal l ing MicroStrategy Library on Linux 239

MicroStrategy Library Server Configuration Properties 253

Configuring Col laboration Server 258

How to Set Up Appl ication Servers 277

Linking MicroStrategy Library to MicroStrategy Web 285

How to Enable Seamless Login Between Web, Library, and Workstation 286

Ensuring Images in MicroStrategy Web Work With Content in the Library 289

MicroStrategy Library Web International ization 290

Load Balancer and Clustering Considerations for Library & Col laboration Server 293

Command Line Tools to Create Securi ty Arti facts 299

Troubleshooting Your MicroStrategy Library Instal lation 300

Certi ficate Store Integration with MicroStrategy Library 317

4. Installing and Configuring MicroStrategy Identity 326

Overview of Instal l 327

MicroStrategy Identi ty Pre-Instal lation Instructions 327

MicroStrategy Identi ty Instal lation Instructions 338

MicroStrategy Identi ty Post-Instal lation Instructions 338

Troubleshooting Information 348

5. Activating Your Installation 355

Request an Activation Code 356

Activate Your Instal lation 358


Server Activation FAQ 360

6. Configuring and Connecting Intelligence Server 368

Communicating with Databases 369

Ini tial MicroStrategy configuration 382

Connecting to a Data Warehouse and Other Reposi tories 438

Creating a Project 457

How to Connect the Intel l igence Server to a speci fic Export Engine 457


Data Import wi th Proxy 459

7. Deploying MicroStrategy Web and Mobile Server 465

Deploying with IIS (Windows) 466

General Steps to Deploy MicroStrategy JSP Appl ications 470

Deploying with WebLogic and Apache (Solaris) 475

Deploying with WebSphere and IBM HTTP Server (AIX) 493

Deploying with Oracle Glassfish Server (Solaris) 504

Deploying with Tomcat (Windows) 514

Deploying with Tomcat (Linux) 521

Deploying with SAP NetWeaver (Windows) 526

Deploying with Oracle 10g (Windows) 530

Deploying with JBoss (Windows) 534

Administering Your MicroStrategy Web Deployment 540

Using Absolute Paths to Share Configuration Fi les 542

Configuring Third-Party Data Sources for Importing Data 542


8. Setting Up Documents and HTML Documents 546

Prerequisi tes 547

Executing Documents and HTML Documents in Linux 548


9. Automated Installation on Windows 557

Instal lation Log Fi le 558



10. Automated Installation on Linux 620

Si lent Instal lation 621

Configuring MicroStrategy in Command Line Mode 671


11. Deploying OEM Applications 672

Creating DSNs for OEM Environments 674

Configuring a MicroStrategy Instal lation 676

Designing a Project and Reporting Environment 676

Customizing MicroStrategy Web 677

Deploying a MicroStrategy OEM Appl ication 678

Tuning an OEM Deployment 684

Updating OEM Appl ications 686

12. Configuring MicroStrategy Using Command Line Tools 688

Creating a DSN for a Data Source 689

Testing ODBC connectivi ty 690

Configuring MicroStrategy with a response.ini fi le 693

Configuring and Control l ing Intel l igence Server 717

Supporting Reserved Words and Characters 721


13. Adding or Removing MicroStrategy Components 723

Adding or Removing MicroStrategy Components on Windows 724

Re-instal l ing MicroStrategy components on Windows 725

Uninstal l ing MicroStrategy Components on Windows 727

Uninstal l ing MicroStrategy Components on Linux 730

14. Export Engine Configuration 733

Instal lation of Export Engine 734

Export Engine: Puppeteer Integration 737

Export Engine Configuration Properties 741

Enable Local Resource Loading for the Export Engine 745

A.Connecting to Databases and Data Sources 747

Creating DSNs for Speci fic Data Sources 747

Creating Database Connections in Web 785

Configuring ODBC Parameters wi th ODBC.ini 788

MicroStrategy Hadoop Gateway Simplified Installation 790

Introduction to the MicroStrategy Hadoop Gateway 790

Environment Considerations 792

Using the MicroStrategy Hadoop Gateway 798

Troubleshooting 807

Known Issues 816

Frequently Asked Questions 818

Installing and Configuring Topology 824

Introduction to Topology 824

Instal l ing Topology 827

Deploying MicroStrategy Library through a WAR Fi le 830

Enabl ing Topology Communication Through a Firewal l 832

Removing a Service from the Topology Moni tor 833

Restarting the Consul 834

Speci fying the Topology Communication Agent 835

Changing the Moni toring Agent to a Communication Agent 837

Starting and Stopping Services 839

Supported MicroStrategy Platform Services 843

Troubleshooting Topology 857

Configuring Environments wi th Dynamic or Mul tiple IP Addresses 869

Certi fied Operating Systems for Topology 873

Certi fied Web Containers for Topology 873

Installing and Configuring the Identity Messaging Service 875

Identi ty Messaging Service Dependencies 875

Instal l ing the Identi ty Messaging Service on Linux 875

Configuring the Identi ty Messaging Service 878

How to Moni tor the Identi ty Messaging Service Deployment 881

Troubleshooting the Identi ty Messaging Service Instal lation 882

Identi ty Server Configuration to Work With Identi ty Messaging Service 882

19. MicroStrategy Identity Administration 885

Managing MicroStrategy Identi ty Administrators 886

Managing the Signing Certi ficate Authori ty 887

How to Install the Kerberos Authentication Service 894

B.Troubleshooting 898

Reviewing General Instal lation Errors 898

Graph and Document Support of Non-Western European Fonts 898

Server Port Number Errors 899

DSN Connection Errors 900

Metadata and Other Reposi tory Creation Errors 900

Permission Errors 902

Instal lation and Configuration Help

MicroStrategy Instal lation and Configuration provides comprehensive information on how toinstal l and configure MicroStrategy software, as wel l as basic maintenance guidel ines. Thisguide gets you started using the Linux and Windows versions of the MicroStrategy platform.

Copyr ight © 2020 All Rights Reserved 10

PLANNING YOURINSTALLATION

In stal lat io n an d Co n f igu rat io n Gu id e


MicroStrategy business intel l igence tools help organizations to moni tor,report, and analyze al l of their enterprise data. MicroStrategy helps youmake decisions based upon the data within your organization's enterprisedata warehouses and other business data sources.

An overview of the di fferent MicroStrategy components and products isprovided so that you can decide what you need to instal l . This includesdetai ls on supported functional i ty and describes important instal lationprerequisi tes that should be considered before you start instal l ingMicroStrategy products.

The MicroStrategy products that you can install depend on your MicroStrategylicense. Contact your MicroStrategy account executive with MicroStrategylicensing questions.

You can begin determining your instal lation and configuration plan byreviewing the fol lowing topics:

Upgrade Considerations

If you want to upgrade an earl ier version of MicroStrategy products, see theUpgrade Guide before upgrading existing metadata.

Hover over the icons below to see the information related to instal l ing eachpart of the Intel l igence Platform archi tecture.

MicroStrategy WebMicroStrategy Web is an interactive, easy to use interface for al l BusinessIntel l igence (BI) reporting, analysis, and moni toring. With MicroStrategyWeb, business users perform any of or al l the major styles of BI -Scorecards and Dashboards, Enterprise Reporting, OLAP Analysis,Predictive Analysis, and Alerts and Proactive Noti fication - wi thin a single,uni fied Web interface. Business users move seamlessly between al l fivestyles of BI and even combine multiple styles wi thin a single report display.


https://www2.microstrategy.com/producthelp/2020/UpgradeGuide/index.htm


MicroStrategy Web can also be integrated with mapping services to createsophisticated Geospatial Information System (GIS) appl ications through theuse of MicroStrategy GIS Connectors. GIS lets business users visual izedata in forms such as maps, globes, reports, and charts so that they canidenti fy and analyze relationships, patterns, and trends in their data. ThisReadme includes MicroStrategy GIS Connectors certi fication information inthe Certi fied and Supported Configurations page of the Readme.

l Windows Installer 3.0 or later is required to install MicroStrategy products ona Windows platform.

l You can download the software from the MicroStrategy download si te .

l The MicroStrategy Knowledge Base inc ludes technical notes thatdocument the history of changes to MicroStrategy Web files betweenvarious MicroStrategy releases. To find and review this information, searchthe knowledge base using a keyword.

System Requirements

For al l certi fied systems, see Platform Certi fications.

Compatibility and Interoperability

MicroStrategy Web 2020 should be connected only to a MicroStrategyIntel l igence Server of the same version or later for production purposes. Forthe complete MicroStrategy Platform Compatibi l i ty and Interoperabi l i tyspeci fication, see Compatibi l i ty and Interoperabi l i ty.

Web Client

ÁProtocols and PortsHTTP : 8080

HTTPS : 8443


https://www2.microstrategy.com/producthelp/Current/Readme/en-us/content/certified_configurations.htm

https://software.microstrategy.com/Download/index.aspx

https://community.microstrategy.com/s/discussions

https://www2.microstrategy.com/producthelp/Current/Readme/en-us/content/compatibility_and_interoperability.htm


Linux Information

Configuration : <TomcatPath>/webapps/MicroStrategy/WEB-INF/classes

Installation : <InstallPath>/WebUniversal

Log Location : <TomcatPath>/webapps/MicroStrategy/WEB-INF/log

Windows Information

Configuration : <CommonFiles>\MicroStrategy\Tomcat\apache-tomcat-9.0.12\webapps\MicroStrategy\WEB-INF\classes

Installation : <InstallPath>\MicroStrategy\Web JSP

Log Location : <CommonFiles>\MicroStrategy\Tomcat\apache-tomcat-9.0.12\webapps\MicroStrategy\WEB-INF\log

Directory Structure

JSP interface: The fol lowing table l ists folders and fi les of interest that areincluded in the defaul t di rectory structure after deploying yourMicroStrategy Web WAR fi le:

Directory Contents

\assets Support ing f i les

\html Support ing f i les

\images All image f i les

\import Sample f i les for Data Import analysis

\javascript Interface JavaScript f i les



Directory Contents

\jsp Interface JSP code f i les

\plugins Plug-in f i les for customizat ions

\resBundles Flash descriptor f i les

\style Interface style f i les

\swf Support ing f i les for widgets

\VisFramework Support ing f i les for visualizat ions

\WEB-INF Conf igurat ion informat ion for MicroStrategy Web

ASP.NET interface: The fol lowing table l ists folders and fi les of interestthat are included in the defaul t di rectory structure after an instal lation ofMicroStrategy Web.

Directory Contents

\asp .Net f i les

\bin binary f i les








\WEB-INF Conf igurat ion informat ion for MicroStrategy Web



Web Server

ÁProtocols and PortsHTTP (JSP): 8080

HTTPS (JSP): 8443

HTTP (ASP): 80

HTTPS (ASP): 443

Linux Information

Configuration : <TomcatPath>/webapps/MicroStrategy/WEB-INF/classes

Installation : <InstallPath>/WebUniversal

Log Location : <TomcatPath>/webapps/MicroStrategy/WEB-INF/log

Windows Information

Configuration : <CommonFiles>\MicroStrategy\Tomcat\apache-tomcat-9.0.12\webapps\MicroStrategy\WEB-INF\classes


Log Location : <CommonFiles>\MicroStrategy\Tomcat\apache-tomcat-9.0.12\webapps\MicroStrategy\WEB-INF\log

MicroStrategy MobileMicroStrategy Mobi le is an interactive interface of the MicroStrategy BIplatform that lets mobi le business users harness the analytical power ofMicroStrategy through the use of their mobi le devices. It's the easiest,



fastest, and most affordable way to mobi l ize analytics, and information-richapps to an increasingly mobi le and 24 x 7 workforce.

MicroStrategy Mobi le and the MicroStrategy Mobi le Server provideMicroStrategy reporting and analysis capabi l i ties on Apple iOS and Androiddevices. MicroStrategy uses the intui tive interfaces of these mobi le devicesto let users explore information using touch and smart gestures.MicroStrategy Mobi le Business Intel l igence appl ications can supportworkflows that lead users through data to decisions.

MicroStrategy Mobi le also provides appl ication developers a new way todevelop and deploy Mobi le appl ications that is faster, easier, and moremaintainable than using tradi tional Integrated Development Environments.MicroStrategy Mobi le offers the fol lowing benefi ts:

l Reduces the time to develop new Mobile applications: MicroStrategy'sMobi le appl ication platform includes the infrastructure needed to supporteach new Mobi le appl ication, so that appl ication developers only need tofocus on creating the user experience and not on the back-endinfrastructure.

l Easy for non-developers to create professional Mobile applications:MicroStrategy's Mobi le appl ications do not require any coding. UsingMicroStrategy's Mobi le appl ication platform, Mobi le appl ications areassembled in a point-and-cl ick fashion. Appl ication designers can choosefrom an array of finely-designed displays and controls that are optimizedfor mobi le devices.

l Easy for companies to rapidly deploy Mobile application updates:MicroStrategy's Mobi le appl ication platform uses an on-demand form ofappl ication deployment cal led "in-stream" deployment. As soon as new orupdated appl ications are ready, they are instantly avai lable to Mobi leusers directly from MicroStrategy's Mobi le appl ication platform.

l One design for all devices: MicroStrategy Mobi le's abi l i ty to render thesame appl ication across di fferent mobi le device operating systems means



less development time, less appl ication management, and quicker supportfor a heterogeneous deployment of mobi le devices.

To learn more about MicroStrategy Mobi le, see the MicroStrategy Mobi leAdministration Guide and the MicroStrategy Mobi le Design and AnalysisGuide.

For information on how to deploy MicroStrategy Mobi le Server (ASP.NET)and MicroStrategy Mobi le Server (JSP), see Chapter 7, DeployingMicroStrategy Web and Mobi le Server.

System Requirements

For al l certi fied systems, see Platform Certi fications.

Compatibility

MicroStrategy Mobile Clients

See Platform Certi fications for supported versions of iOS and Androidoperating systems.

Creating a Configuration of Multiple MicroStrategy Mobile Servers

To create a configuration that includes multiple MicroStrategy Mobi leServers al l of the MicroStrategy Mobi le Servers must be the same version.For example, you can use a MicroStrategy 2020 Mobi le Server to create aconfiguration including multiple MicroStrategy 2020 Mobi le Servers.

For the complete MicroStrategy Platform Compatibi l i ty and Interoperabi l i tyspeci fications, see Compatibi l i ty and Interoperabi l i ty.


https://www2.microstrategy.com/producthelp/2020/MobileAdmin/WebHelp/Lang_1033/Content/home.htm


https://www2.microstrategy.com/producthelp/Current/MobileAnalysis/index.htm

https://www2.microstrategy.com/producthelp/Current/MobileAnalysis/index.htm



https://www2.microstrategy.com/producthelp/Current/Readme/en-us/content/compatibility_and_interoperability.htm


Mobile Client


HTTPS : 8443

Linux Information

Configuration : <TomcatPath>/webapps/MicroStategyMobile/WEB-INF/classes

Installation : <InstallPath>/Mobile/MobileServer

LogLocation : <TomcatPath>/webapps/MicroStrategyMobile/WEB-INF/log

Windows Information

Configuration : <CommonFiles>\MicroStrategy\Tomcat\apache-tomcat-9.0.12\webapps\MicroStrategyMobile\WEB-

INF\classes


Log Location : <CommonFiles>\MicroStrategy\Tomcat\apache-tomcat-9.0.12\webapps\MicroStrategyMobile\WEB-INF\log

Mobile Server

ÁProtocols and PortsHTTP (JSP): 8080



HTTPS (JSP): 8443

HTTP (ASP): 80

HTTPS (ASP): 443

Linux Information

Configuration : <TomcatPath>/webapps/MicroStategyMobile/WEB-INF/classes

Installation : <InstallPath>/Mobile/MobileServer

LogLocation : <TomcatPath>/webapps/MicroStrategyMobile/WEB-INF/log

Windows Information

Configuration : <CommonFiles>\MicroStrategy\Tomcat\apache-tomcat-9.0.12\webapps\MicroStrategyMobile\WEB-

INF\classes


Log Location : <CommonFiles>\MicroStrategy\Tomcat\apache-tomcat-9.0.12\webapps\MicroStrategyMobile\WEB-INF\log

MicroStrategy Intelligence ServerMicroStrategy Server benefi ts al l user roles. The ful ly featured serverinfrastructure is the backbone of any MicroStrategy implementation andoffers al l the core platform services, which include:

l 64-bi t server infrastructure to scale to big data volumes and a largenumber of users.

l Abi l i ty to connect to and join data from multiple data sources.



l In-memory acceleration of analytical processing for instantaneousresponse.

l Processing of al l analytic styles from sel f-service data discovery tobeauti ful , immersive information apps to the industry's broadest spectrumof advanced analytics.

l Proactive distribution of personal ized reports and alerts.

l Abi l i ty to embed actionable intel l igence in analytical appl ications.

In addi tion to al l the features above, the Server product includes highlyuseful moni toring and automation tools for organizations to effectively andefficiently manage their deployments.

Windows Installer 3.0 or later is required to install MicroStrategy products on aWindows platform.

To install MicroStrategy software, you can download it from theMicroStrategy download si te .

To support the use of a graphical user interface for MicroStrategy tools andinstalling MicroStrategy products on Red Hat Enterprise Linux 6, you mustinstall the libstdc++-4.4.4-XX.el6.i686 package included withyour install media. If you are using Red Hat Enterprise Linux 6.1, you mustalso install the libstdc++-4.4.5-XX.el6.i686 , elfutils-libelf-devel.x86-64.rpm , and libXp.x86-64.rpm packagesincluded with your install media. If you are using Red Hat Enterprise Linux 6.xor 7.x, you must install nss-pam-ldapd.i686.rpm and compat-libstdc++-33-3.2.3-69.el6.i686.rpm .

You must have an Intelligence Server Universal license to install on 64-bitWindows operating systems.

MicroStrategy Intelligence Server

MicroStrategy Intel l igence Server del ivers world-class moni toring,reporting, and analysis on a single integrated platform, offering next


https://software.microstrategy.com/download/


generation BI capabi l i ties for the ful l range of BI appl ications.MicroStrategy Intel l igence Server is the archi tectural foundation of theMicroStrategy platform. It performs the fol lowing cri tical tasks for theMicroStrategy BI platform:

l Runs queries, performs calculations, and formats reports

l Signi ficantly improves user-perceived query performance

l Efficiently manages thousands of end-user requests (jobs)

l Serves as a central point for the MicroStrategy metadata

Intel l igence Server also provides a l ibrary of over 150 di fferentsophisticated mathematical and statistical functions, which can be addedto. See the Functions Reference for detai ls about these functions.

Al l other products in the platform work in conjunction with Intel l igenceServer and benefi t from its broad functional i ty.

The subcomponents of MicroStrategy Intel l igence Server are as fol lows:

l MicroStrategy OLAP Services, page 23

l MicroStrategy Report Services, page 24

l MicroStrategy Distribution Services, page 24

l MicroStrategy Transaction Services, page 25

l MultiSource Option, page 25

l Clustering Option, which al lows you to cluster a group of Intel l igenceServer machines (up to four Intel l igence Server machines) to takeadvantage of the many benefi ts avai lable in a clustered environment.

For information on clustering Intel l igence Servers, see the SystemAdministration Guide.


https://www2.microstrategy.com/producthelp/2020/FunctionsRef/index.htm

https://www2.microstrategy.com/producthelp/2020/SystemAdmin/WebHelp/Lang_1033/index.htm



ÁProtocols and PortsTCP : 30241

TCP : 34952

TCP : 34962

Two-Way SSL : 39320

Two-Way SSL : 39321

Linux Information

Configuration : Metadata object - Registry Fi le

Log Location : <logpath>/DSSerrors.log

Windows Information

Configuration : Metadata object - ServerDef Windows Registry

Installation : <InstallPath>\MicroStrategy\IntelligenceServer

Log Location : <Instal lPath>\CommonFi les\MicroStrategy\log\DSSErrors.log

Directory Structure

The fol lowing table l ists folders and fi les of interest that are included in thedefaul t di rectory structure after instal l ing Intel l igence Server.

The defaul t folder is:

l C:\Program Files (x86)\MicroStrategy\Product Name wheninstal led on a 64-bi t Windows environment.



l /opt/MicroStrategy/Product Name , or$HOME/MicroStrategy/install/Product Name i f you do not havewri te access to /opt/MicroStrategy , when instal led on Linuxenvironments.

If instal l ing over previous versions of the product, the folder remains thesame.

Directory Contents

\Intelligence Server MicroStrategy Intell igence Server root folder

MicroStrategy OLAP Services

MicroStrategy OLAP Services uses the concept of Intel l igent Cube, an in-memory version of a report that can be manipulated by the AnalyticalEngine. MicroStrategy Developer, MicroStrategy Web, and MicroStrategyOffice users can sl ice and dice data in reports wi thin the Intel l igent Cubeswithout having to re-execute SQL against the data warehouse.

For information on OLAP Services, see the In-memory Analytics Guide.


https://www2.microstrategy.com/producthelp/2020/InMemoryAnalytics/WebHelp/Lang_1033/index.htm


MicroStrategy Report Services

MicroStrategy Report Services is the enterprise reporting engine of theMicroStrategy business intel l igence platform. A MicroStrategy ReportServices document contains objects representing data coming from one ormore reports, as wel l as posi tioning and formatting information. It is used toformat data from multiple reports in a single display of presentation qual i ty.

For information on Report Services, see the Document Creation Guide andthe Dashboards and Widgets Creation Guide.

MicroStrategy Distribution Services

MicroStrategy Distribution Services provides high-volume, automateddistribution of reports, documents, dossiers, and business performancealerts via emai l , fi le servers, FTP servers, and networked printers.


https://www2.microstrategy.com/producthelp/2020/DocCreationGuide/WebHelp/Lang_1033/index.htm

https://www2.microstrategy.com/producthelp/2020/DashboardsWidgets/WebHelp/Lang_1033/index.htm


MicroStrategy Transaction Services

MicroStrategy Transaction Services lets you embed wri te-back functional i tyinto reports and dashboards for the purposes of decision-making orini tiating a transaction. These transactions can include one-cl ick approvalsand denials, notes for tracking and directing business activi ty, and wri te-back to data sources in real time.

Users of MicroStrategy Web, MicroStrategy Mobi le for iPhone, andMicroStrategy Mobi le for iPad can employ these transaction capabi l i tiesfrom reports, dashboards, and MicroStrategy Mobi le appl ications.

MultiSource Option

With MultiSource Option, you can connect a project to mul tiple relationaldata sources. This al lows you to integrate al l your information from variousdatabases and other relational data sources into a single MicroStrategyproject for reporting and analysis purpose. Al l data sources included usingthe MultiSource Option are integrated as part of the same relational schemafor a project.



For information on using MultiSource Option, see the Project Design Guide.

MicroStrategy Command Manager

MicroStrategy Command Manager is an appl ication designed to simpl i fyand automate administration tasks, such as add, delete, or updateenterprise-level data associated with large numbers of users and usergroups. Addi tional ly, Command Manager al lows you to manage variousconfiguration settings within the MicroStrategy platform.


https://www2.microstrategy.com/producthelp/2020/ProjectDesignGuide/WebHelp/Lang_1033/index.htm


For information on using Command Manager, see the SystemAdministration Guide.

MicroStrategy Enterprise Manager

MicroStrategy Enterprise Manager provides insights about governing andtuning al l areas of your MicroStrategy environment. With EnterpriseManager, you can see a variety of Intel l igence Server usage statistics. Thestatistics shown in predefined reports displayed by Enterprise Manager canhelp you make schedul ing decisions, analyze bottlenecks, and tuneperformance.





For information on using Enterprise Manager, see the Enterprise ManagerGuide.

MicroStrategy System Manager

MicroStrategy System Manager lets you define multiple configurations foryour MicroStrategy environment that can be executed in a single workflow.This provides the abi l i ty to deploy various configurations to as manysystems as required. You can deploy these configurations using a standardinterface, an interactive command l ine process, or a completely si lentconfiguration process.

System Manager lets you create a workflow visual ly, al lowing you to seethe step-by-step process that leads the workflow from one configuration tothe next. This visual approach to creating a workflow can help you to noticeopportuni ties to troubleshoot and error check configurations as part of aworkflow.

For information on using MicroStrategy System Manager to configure anddeploy your MicroStrategy environments, see the System AdministrationGuide.





MicroStrategy Narrowcast Server

MicroStrategy Narrowcast Server proactively distributes personal izedinformation to employees, business partners, and customers through avariety of devices, including mobi le phones, emai l , and Web pages. Thedistribution of personal ized messages and targeted offers is triggeredaccording to predefined schedules and exception cri teria, del iveringinformation in a timely and convenient manner. Narrowcast Server alsoprovides a sel f-subscription portal , easing administrative responsibi l i tiesand empowering information consumers to choose the information theyreceive. Narrowcast Server can draw information from relational or non-relational sources.

Subscriptions can also be supported through Intel l igence Server wi th theintroduction of Distribution Services. For information on DistributionServices, see MicroStrategy Distribution Services, page 24.

For information on Narrowcast Server subcomponents, see theMicroStrategy Narrowcast Server Instal lation and Configuration Guide.

SequeLink ODBC Socket Server

SequeLink is a complete, end-to-end solution for configuring and managingdata access across virtual ly any number of data stores, operating systems,and deployment options. SequeLink ODBC Socket Server is required tosupport MicroStrategy Narrowcast Server. It can also be used to accessMicrosoft Access databases and Microsoft Excel fi les stored on a Windowsmachine from an Intel l igence Server hosted on a Linux machine (seeMicroStrategy ODBC Driver for SequeLink, page 758).

The SequeLink ODBC Socket Server that is provided with a MicroStrategyinstal lation is for exclusive use with the MicroStrategy Product Sui te. Youare not l icensed to use this product wi th any appl ication other thanMicroStrategy products. You can contact Progress® DataDirect® topurchase the SequeLink ODBC Socket Server for use with non-MicroStrategy products.



MicroStrategy ArchitectMicroStrategy Archi tect is designed to meet the needs of appl icationarchi tects and developers. It includes al l the schema development, changemanagement, and model ing tools that enable archi tects to manage the ful ldevelopment l i fe cycle of MicroStrategy appl ications. The Archi tect productal lows IT organizations to flexibly share and distribute roles andresponsibi l i ties for development, testing, promotions, and migrations duringthe appl ication l i festyle, leading to vast improvements in organizationalefficiency.

MicroStrategy Developer

l Windows Installer 3.0 or later is required to install MicroStrategy products ona Windows platform.

l If you are installing MicroStrategy Developer on Windows Vista or laterversions, you must install Microsoft's DHTML Editing Control forApplications Redistributable Package. The redistributable package containsfiles that were removed with the release of Windows Vista, but are requiredfor MicroStrategy Developer to work properly. For information on thisredistributable package and the necessary installation steps, see thefollowing l ink.

l You can download the software from the MicroStrategy download si te .

l To install and access MicroStrategy Server Administrator, when installingMicroStrategy Developer, your license key must be licensed forMicroStrategy Intelligence Server.

MicroStrategy Developer provides analytical features designed to faci l i tateand perform the deployment of reports. It governs appl ication objects suchas reports, fi l ters, and metrics.

Developer also enables you to create appl ication objects. The appl icationobjects are bui l t on the schema objects that are created in MicroStrategyArchi tect. These appl ication objects are used to analyze and provide


http://www.microsoft.com/downloads/details.aspx?FamilyId=B769A4B8-48ED-41A1-8095-5A086D1937CB&displaylang=en

https://download.microstrategy.com/


insight into relevant data. The fol lowing sections provide a brief descriptionof the subcomponents for these products.

The subcomponents of MicroStrategy Developer include:

l MicroStrategy Analyst is a simpl i fied version of MicroStrategy Developer,providing the basic interactive reporting functional i ty required bymanagers.

l MicroStrategy Developer is a ful l -featured version for power analysts andappl ication developers. With a ful l range of analytical functional i ty, a richl ibrary of functions, and intel l igent workflow, Developer is wel l sui ted forpower users.

l MicroStrategy Archi tect provides project designer functional i ty such asattribute, fact, hierarchy, and project creation and modi fication. Archi tectcontains the fol lowing subcomponents:

l MicroStrategy Function Plug-in Wizard is an add-in to the MicrosoftVisual C++ compi ler, which comes with a standard MicroStrategyinstal lation. It al lows you to create a C++ project, wi th which you canimplement your own custom MicroStrategy function plug-in. The optionto instal l this component is enabled only i f Microsoft Visual C++ version2005 (8.0) or version 2010 (10.0) is present on the system where theinstal lation is being performed.

l Customers interested in deploying analytics from the R programminglanguage into MicroStrategy can do so using the R Integration Pack,avai lable on MicroStrategy's GitHub page.

l MicroStrategy Server Administrator is a MicroStrategy Intel l igence Serveradministrative console that provides functional i ty such as systemmonitoring, cache management, and user and group management.

When installing MicroStrategy Developer, your license key must be licensedfor MicroStrategy Intelligence Server to install and access MicroStrategyServer Administrator.


https://github.com/MicroStrategy/RIntegrationPack


For information on various options present in Developer to create and runreports, see the Basic Reporting Guide. After you are fami l iar wi th basicDeveloper concepts, see the Advanced Reporting Guide for information onadvanced Developer functional i ty.

Directory Structure

The fol lowing table l ists folders and fi les of interest that are included in thedefaul t di rectory structure after an instal lation of Developer.

The defaul t folder is:

C:\Program Files (x86)\MicroStrategy\Product Name wheninstal led on a 64-bi t Windows environment.

If instal led over previous versions of the product, the folder remains thesame.

Directory Contents

\MicroStrategy\Desktop MicroStrategy Developer root directory

\MicroStrategy\Desktop\ ImagesCustom images used by the MicroStrategyDeveloper applicat ion

On a 64-bit Windows environment:

\Program Files (x86)\CommonFiles\MicroStrategy\Log

Log directory, for diagnost ics output

MicroStrategy Architect

MicroStrategy includes a project design tool known as Archi tect. Archi tectal lows you to define al l the required components of your project from acentral ized interface. Archi tect also provides a visual representation of yourproject as you create i t, which helps to provide an intui tive workflow.

For information on using Archi tect to design a project in MicroStrategy, seethe Project Design Guide.


https://www2.microstrategy.com/producthelp/2020/BasicReporting/WebHelp/Lang_1033/index.htm

https://www2.microstrategy.com/producthelp/2020/AdvancedReportingGuide/WebHelp/Lang_1033/index.htm



MicroStrategy Integrity Manager

MicroStrategy Integri ty Manager is an automated report comparison tool .Report SQL, report data, and graphs can be executed and compared inIntegri ty Manager to help customers veri fy change success. In addi tion, thereport comparison output can be analyzed at the report level inMicroStrategy Integri ty Manager, and as HTML and XML summary fi les thatare generated to provide easi ly distributed resul ts to other users.

To learn more about MicroStrategy Integri ty Manager, see the SystemAdministration Guide.

MicroStrategy Object Manager

MicroStrategy Object Manager provides complete l i fe cycle managementcapabi l i ties for MicroStrategy environments. Using Object Manager, youcan copy objects wi thin a project or across related projects.





For information on using Object Manager, see the System AdministrationGuide.

MicroStrategy SDKThe MicroStrategy SDK is a col lection of programming tools, uti l i ties,documentation, and l ibraries of functions or classes designed to customizeand extend MicroStrategy products for integration within other appl ications.The programming tools provided by the MicroStrategy SDK—includingprogramming instructions, points of access, and guidel ines for developers—al low programmers to enhance the operation of their software bycustomizing and embedding the MicroStrategy BI platform.

The MicroStrategy SDK and MicroStrategy Developer Library (MSDL) arenot included in the MicroStrategy instal lation. You can download theMicroStrategy SDK and access the MicroStrategy Developer Library fromthe MicroStrategy support si te.




https://community.microstrategy.com/s/topic/0TO44000000FliLGAS/sdk-u009


The MicroStrategy SDK provides access to the enti re MicroStrategyplatform and includes everything required to bui ld a feature-fi l led businessintel l igence-enabled appl ication. The MicroStrategy SDK is made up of thefol lowing components:

l The MicroStrategy SDK includes the fol lowing individual SDKs, which aredescribed in detai l in the MicroStrategy Developer Library:

l Web SDK

l MicroStrategy REST API

l Visual ization SDK

l MicroStrategyLibrary SDK

l Embedding SDK

l Mobi le SDK

l Narrowcast Server SDK



l Intel l igence Server SDK

l MicroStrategy Office SDK

l Each of the individual SDKs l isted above is made up of some of or al l thefol lowing components:

l A comprehensive set of APIs that includes:

l REST API services

l COM-based cl ient-server API

l XML-based Web API wi th support for Java/COM

l Narrowcast Server API

The set of MicroStrategy APIs provides support for a variety ofdevelopment environments, including Java, C++, VB, XML, and standardWeb and cl ient-server technologies.

l A complete set of SDK documentation for al l the MicroStrategy productsthat includes:

l Reference guides such as Javadocs for the APIs.

l The MicroStrategy Developer Library (MSDL), which provides al l theinformation required to understand and use the MicroStrategy SDK.

l A variety of development tools that include:

l Source code and sample appl ication code for typical customizationtasks

l Development tools and production-ready uti l i ties to reduce codecreation/maintenance and help you bui ld customized appl ications.

l Special ized development tools, such as the Portal Integration Ki t andthe Web Services Development Ki t



l Features for packaging your appl ication, including embedded (si lent)instal lation, project mover for project maintenance and upgrade, andschema services to upgrade the metadata.

MicroStrategy Sample ProjectsMicroStrategy provides a set of packaged analytic components bui l t usingthe MicroStrategy platform. These include the Human Resources AnalysisModule and the MicroStrategy Tutorial .

Human Resources Analysis Module

The Human Resources Analysis Module contains sample dossiers andreports, as wel l as the reporting objects that can be used to create typicalHuman Resources reports. The Human Resources Analysis ModuleReference is a guide that provides sample usages and descriptions foreach of the module's dossiers and reports and the supporting objects thatdefine them.

The Human Resources Analysis Module can be mapped to a di fferentwarehouse or used as a starter ki t to develop custom appl ications. Themodule consists of a MicroStrategy project in a metadata, a referenceguide, and a defaul t data model .

MicroStrategy Tutorial Reporting

MicroStrategy Tutorial Reporting is a sample MicroStrategy project wi th awarehouse, and a set of demonstration dossiers, reports, and other objects,designed to i l lustrate the platform's rich functional i ty. The MicroStrategyTutorial Reporting metadata is provided as part of the MicroStrategyAnalytics Modules metadata.

The theme of the Tutorial project is a retai l store that sel ls electronics,books, movies, and music. The key features include:



l Five hierarchies: Customer, Geography, Products, Promotions, and Time.Each hierarchy can be viewed graphical ly through MicroStrategyDeveloper and MicroStrategy Web (through documents).

l A large number of customers and i tems purchased.

l Five reporting areas: Human Resources, Inventory, Financial , ProductSales, and Suppl ier.

l Options to create reports from MicroStrategy Web or Developer focusingon a particular analysis area, such as Customer, Inventory, Time,Products, Category, Employee, or Cal l Center.

For more information on the Tutorial project, refer to the Project DesignGuide.

MicroStrategy IdentityMicroStrategy Identi ty is a multi -faceted enterprise solution that offers thebest combination of securi ty and convenience for accessing digi tal andphysical assets. The fi rst component of MicroStrategy Identi ty isMicroStrategy Badge; this product creates a mobi le identi ty on yoursmartphone that replaces access control tools l ike keycards, passwords,and securi ty tokens with a uni fied digi tal credential . The second componentis MicroStrategy Communicator, which provides identi ty discovery, locationawareness, and two-way communication. These features can be leveragedto coordinate activi ties across a distributed group of users enabled withMicroStrategy Badge.

Depending on your l icense key, you can choose to instal l :

l MicroStrategy Identity Server: synchronizes identi ties wi th EnterpriseManagement (IDM) systems of record. The MicroStrategy Identi ty Serveraccesses ID reposi tories through gateways and presents the identi ty toassociated devices and systems.

l MicroStrategy Identity Manager: al lows administrators to manage anorganization's network of users, configure access to MicroStrategy





Identi ty-enabled systems and resources, and distribute digi tal badges andkeys.

l MicroStrategy Communicator: provides identi ty discovery, locationawareness, and two-way communication. These features can beleveraged to coordinate activi ties across a distributed group of usersenabled with MicroStrategy Badge.

Once you have instal led one or more of these products, each user in yoursystem can download the MicroStrategy Badge app to their mobi le device.With this app users can val idate their identi ties or access Identi ty-enabledsystems and resources.

MicroStrategy Identity Server

ÁProtocols and PortsSSL : 1443

Two-Way SSL : 2443

Linux Information

Configuration: <InstallPath>/Usher/UsherServer/usherApps/shardIDM/conf

Installation :<InstallPath>/Usher/UsherServer/usherApps/shardIDM

Log Location :

<InstallPath>/Usher/UsherServer/usherApps/shardIDM/logs



Windows Information

Configuration : <InstallPath>\MicroStrategy\Usher\UsherServer\usherApps\shardIDM\conf

Installation : <InstallPath>\MicroStrategy\Usher\UsherServer\usherApps\shardIDM

Log Location : <InstallPath>\MicroStrategy\Usher\UsherServer\usherApps\shardIDM\logs

Identity Manager


Linux Information

Configuration :<InstallPath>/MicroStrategy/Usher/UsherNetworkMgr/db_

configs

Installation :<InstallPath>/MicroStrategy/Usher/UsherNetworkMgr/db_

configs

Log Location :<InstallPath>/MicroStrategy/Usher/UsherNetworkMgr

Windows Information

Configuration : <InstallPath>/MicroStrategy/Usher/Usher

Network Manager/db_configs



Installation : <InstallPath>/MicroStrategy/Usher/Usher

Network Manager/db_configs

Log Location : <InstallPath>/MicroStrategy/Usher/UsherNetwork Manager/tools

MicroStrategy Communicator

ÁProtocols and PortsHTTP

HTTPS

Linux Information

Configuration :<InstallPath>/MicroStrategy/Usher/UsherMobile

Installation : <InstallPath>/MicroStrategy/Usher/UsherMobile

Windows Information

Configuration : <InstallPath>\MicroStrategy\Usher\UsherProfessional\conf

Installation : <InstallPath>\MicroStrategy\Usher\UsherProfessional

For instal lation instructions, see Instal l ing and Configuring MicroStrategyIdenti ty.

MicroStrategy Messaging Services

MicroStrategy Messaging Services on Windows



Messaging Services is a component that is coupled with the Intel l igenceServer during instal lations and upgrades. Messaging Services isconfigured out-of-the-box and runs automatical ly after the instal lation iscompleted.

After instal lation, you can see the fol lowing services are automatical lystarted:

l Apache Kafka (C:\Program Files

(x86)\MicroStrategy\Messaging Services\Kafka\kafka_

2.12-2.2.0 )

l Apache ZooKeeper (C:\Program Files

(x86)\MicroStrategy\Messaging Services\Kafka\kafka_

2.12-2.2.0 )

l MicroStrategy Intelligence Server Log Consumer (C:\ProgramFiles (x86)\MicroStrategy\Intelligence

Server\KafkaConsumer )

By defaul t MicroStrategy wi l l sti l l send Intel l igence Server diagnosticlogs to local disk. Diagnostic logs wi l l be sent to the MessagingServices Server after you perform the fol lowing:

l Enable MicroStrategy Messaging Services

l Turn On the Sending Log to Messaging Services Feature

Afterwards you wi l l see Kafka log fi les created in the Kafka instal lationfolder:

C:\Program Files (x86)\MicroStrategy\Messaging

Services\tmp\kafka-logs

Different Kafka topics wi l l be created to store data for di fferentMicroStrategy components.



Configuring Messaging Services after upgrading

By default, MicroStrategy Messaging Services are installed along with theIntelligence server upgrade.

Once you have completed the upgrade process, you need to enableMicroStrategy Messaging Services. If not, the Intelligence Servercontinues to write to the original log.

Messaging Services Workflow for Intelligence Server

l Intel l igence Server is the Kafka Producer and can be deployed asingle node or cluster.

l Kafka Server can be deployed as a single node or cluster.

l Intel l igence Server Log Consumer can run on any machine that can beconnected to a Kafka Server.

Enable MicroStrategy Messaging Services

Messaging Services configuration is saved in the MicroStrategyIntel l igence Server configuration. It can be enabled or disabled on thefly, wi thout restarting your Intel l igence Server.



Command Manager Scripts for Messaging Services

To check i f Messaging Services is enabled, execute:

LIST ALL PROPERTIES FOR SERVER CONFIGURATION;

To enable Messaging Services through Command Manager, execute:

ALTER SERVER CONFIGURATION ENABLEMESSAGINGSERVICES

TRUE CONFIGUREMESSAGINGSERVICES

"bootstrap.servers:10.15.208.236:9092/batch.num.mess

ages:5000/queue.buffering.max.ms:2000";

In the example above set:

l bootstrap.servers : to your Kafka Server IP address and portnumber.

l batch.num.messages : to the number of messages to send in onebatch when using asynchronous mode.

l queue.buffering.max.ms : to the maximum time to buffer datawhen using asynchronous mode.

You can specify more Kafka Producer configuration settings in thiscommand following the same format.

Turn On the Sending Log to Messaging Services Feature

You can turn on the Sending Log to Messaging Services feature usingei ther MicroStrategy Web or Command Manager.

From MicroStrategy Web

1. Log in using and Administrator account.

2. Open User Preferences > Project Defaults.



3. Locate Sending Log to Messaging Services in the Features forCustomer Feedback section.

4. Select On from the drop-down menu.

5. Cl ick Apply.

From Command Manager

1. Connect to your project source.

2. Execute the fol lowing:

ALTER FEATURE FLAG "SENDING LOG TO MESSAGING

SERVICES" ON;

Modifying Messaging Services Configuration

Apache Kafka Server

The Kafka Server can be configured by modi fying theserver.properties fi le found in:

C:\Program Files (x86)\MicroStrategy\Messaging

Services\Kafka\kafka_2.12-2.2.0\config

Both Apache Kafka Server and ZooKeeper should be restarted aftermodify ing the above configuration file.

Intelligence Server Log Consumer

By defaul t the Log Consumer is connecting to the Local Kafka Server.

There are two ways to modi fy the configuration of Log Consumer:



1. Delete LogConsumer.properties and execute the fol lowingcommand and fol low the steps in the command l ine:

C:\Program Files (x86)\MicroStrategy\Intelligence

Server\KafkaConsumer>java -jar KafkaConsumer.jar

2. Modi fy fi le C:\Program Files

(x86)\MicroStrategy\Intelligence

Server\KafkaConsumer\LogConsumer.properties directly.

The defaul t values after instal lation are:

folder_path=C:\\Program Files (x86)\\CommonFiles\\MicroStrategy\\Log\\DSSErrors # indicatelog file location

is_silent_mode=true # indicate run consumer insilent mode

broker_port=9092 # Kafka Server port number

broker_hostname=127.0.0.1 # Kafka Server IP

poll_time_out=1000 # consumer connection timeout limit in seconds

max_file_size_M=20 # max log file size in MB

max_num_bak=1 # number of backup files

MicroStrategy Messaging Services Configuration for ClusteredEnvironments

If you have clustered your Intel l igence Servers and want to use aseparate machine to run MicroStrategy Messaging Services afterupgrading, complete the fol lowing steps for each node in the cluster.

The minimum number of nodes for a cluster is 3 .

Each node must have the following installed:



l MicroStrategy Messaging Services

l Apache Kafka

l Apache Zookeeper

Configure Zookeeper

1. Browse to folder C:\Program Files

(x86)\MicroStrategy\Messaging

Services\Kafka\kafka_2.12-2.2.0\config .

2. Edi t fi le zookeeper.properties by adding fol lowing l ines:

clientPort=2181

dataDir=C:\\Program Files(x86)\\MicroStrategy\\MessagingServices\\tmp\\zookeeper

maxClientCnxns=0

initLimit=5

syncLimit=2

server.1=10.27.20.16:2888:3888

server.2=10.27.20.60:2888:3888

server.3=10.15.208.236:2888:3888

Each server parameter must contain a unique integer identifier asshown above. You attribute the server id to each machine by creatinga text file named myid , one for each server, which resides in thatserver's data directory, as specified by the configuration fileparameter dataDir = C:\Program Files


Services\tmp\zookeeper



3. Go to folder C:\Program Files

(x86)\MicroStrategy\MessagingServices\Kafka\kafk

a_2.12-2.2.0\config\zookeeper .

4. Create a text fi le named myid containing the identi fying value fromthe server parameter name in the zookeeper.properties fi le.

Configure Kafka

1. Browse to folder C:\Program Files


Services\Kafka\kafka_2.12-2.2.0\config .

2. Edi t fi le server.properties , add a rowzookeeper.connect=10.27.20.16:2181,10.27.20.60:21

81,10.15.208.236:2181 to the Zookeeper section.

############################# Zookeeper#############################

# Zookeeper connection string (see zookeeperdocs for details).

# This is a comma separated host:port pairs,each corresponding to a zk

# server. e.g."127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002".

# You can also append an optional chroot stringto the urls to specify the

# root directory for all kafka znodes.

# zookeeper.connect=localhost:2181

zookeeper.connect=10.27.20.16:2181,10.27.20.60:2181,10.15.208.236:2181



3. Modi fy the broker.id value to a unique integer from other Kafkaservers (the defaul t value is 0), such as for node 10.27.20.60 weuse number 2.

############################# Server Basics#############################

# The id of the broker. This must be set to aunique integer for each broker.

broker.id=2

Start, Stop, Restart, and Check Status of Messaging Services

On Windows instal lations, open Task Manager > Services to start,stop, restart, and check the status of Messaging Services components.

MicroStrategy Messaging Services on Linux

Messaging Services is a component that is coupled with the Intel l igenceServer during instal lations and upgrades. Messaging Services isconfigured out-of-the-box and runs automatical ly after the instal lation iscompleted.

After instal lation, you can see the fol lowing services are automatical lystarted:

l Apache Kafka (/opt/mstr/MicroStrategy/install/MessagingServices/K

afka/kafka_2.12-2.2.0 )

l Apache ZooKeeper (/opt/mstr/MicroStrategy/install/MessagingServices/K

afka/kafka_2.12-2.2.0 )



l MicroStrategy Intelligence Server Log Consumer (/opt/mstr/MicroStrategy/install/IntelligenceServer/

KafkaConsumer )

By defaul t MicroStrategy wi l l sti l l send Intel l igence Server diagnosticlogs to local disk. Diagnostic logs wi l l be sent to the MessagingServices Server after you perform the fol lowing:

l Enable MicroStrategy Messaging Services

l Turn On the Sending Log to Messaging Services Feature

Afterwards you wi l l see Kafka log fi les created in the Kafka instal lationfolder:

/opt/mstr/MicroStrategy/install/MessagingServices/Ka

fka/tmp/kafka-logs

Different Kafka topics wi l l be created to store data for di fferentMicroStrategy components.

Configuring Messaging Services after upgrading

By default, MicroStrategy Messaging Services are installed along with theIntelligence server upgrade.

Once you have completed the upgrade process, you need to enableMicroStrategy Messaging Services. If not, the Intelligence Servercontinues to write to the original log.

Messaging Services Workflow for Intelligence Server

l Intel l igence Server is the Kafka Producer and can be deployed asingle node or cluster.

l Kafka Server can be deployed as a single node or cluster.

l Intel l igence Server log consumer can run on any machine that can be



connected to a Kafka Server.

Enable MicroStrategy Messaging Services

Messaging Services configuration is saved in the MicroStrategyIntel l igence Server configuration. It can be enabled or disabled on thefly, wi thout restarting your Intel l igence Server.

Command Manager Scripts for Messaging Services

To check i f Messaging Services is enabled, execute:

LIST ALL PROPERTIES FOR SERVER CONFIGURATION;

To enable Messaging Services through Command Manager, execute:

ALTER SERVER CONFIGURATION ENABLEMESSAGINGSERVICES

TRUE CONFIGUREMESSAGINGSERVICES

"bootstrap.servers:10.15.208.236:9092/batch.num.mess

ages:5000/queue.buffering.max.ms:2000";

In the example above set:

l bootstrap.servers : to your Kafka Server IP address and portnumber.



l batch.num.messages : to the number of messages to send in onebatch when using asynchronous mode.

l queue.buffering.max.ms : to the maximum time to buffer datawhen using asynchronous mode.

You can specify more Kafka Producer configuration settings in thiscommand following the same format.

Turn On the Sending Log to Messaging Services Feature

You can turn on the Sending Log to Messaging Services feature usingei ther MicroStrategy Web or Command Manager.

From MicroStrategy Web

1. Log in using and Administrator account.

2. Open User Preferences > Project Defaults.

3. Locate Sending Log to Messaging Services in the Features forCustomer Feedback section.

4. Select On from the drop-down menu.

5. Cl ick Apply.

From Command Manager

1. Connect to your project source.

2. Execute the fol lowing:

ALTER FEATURE FLAG "SENDING LOG TO MESSAGING

SERVICES" ON;



Modifying Messaging Services Configuration

Apache Kafka Server

The Kafka Server can be configured by modi fying theserver.properties fi le found in:

/opt/mstr/MicroStrategy/install/MessagingServices/Ka

fka/kafka_2.12-2.2.0

Both Apache Kafka Server and ZooKeeper should be restarted aftermodify ing the above configuration file.

Intelligence Server Log Consumer

By defaul t the Log Consumer is connecting to the Local Kafka Server.

There are two ways to modi fy the configuration of Log Consumer:

1. Delete the LogConsumer.properties fi le from/opt/mstr/MicroStrategy/install/IntelligenceServe

r/KafkaConsumer , execute the fol lowing command, and fol lowthe steps in the terminal :

/opt/mstr/MicroStrategy/install/IntelligenceServe

r/KafkaConsumer java -jar KafkaConsumer.jar

2. Modi fy fi le/opt/mstr/MicroStrategy/install/IntelligenceServe

r/KafkaConsumer/LogConsumer.properties directly.

The defaul t values after instal lation are:

max_num_bak=1 #indicate the number of back upfiles

max_file_size_M=20 #indicate the maximum filesize in MB



broker_port=9092 #Kafka Server port number

is_silent_mode=true #indicate run consumer inslient mode

folder_path=/opt/mstr/MicroStrategy/log/DSSErrors#indicate log folder location

broker_hostname=127.0.0.1 #Kafka Server IP

poll_time_out=1000 #consumer connection time outlimit in seconds

MicroStrategy Messaging Services Configuration for ClusteredEnvironments

If you have clustered your Intel l igence Servers and want to use aseparate machine to run MicroStrategy Messaging Services afterupgrading, complete the fol lowing steps for each node in the cluster.

The minimum number of nodes for a cluster is 3 .

Each node must have the following installed:


l Apache Kafka

l Apache Zookeeper

Configure Zookeeper

1. Browse to folder/opt/mstr/MicroStrategy/install/MicroStrategy/Mes

sagingServices/Kafka/kafka_2.12-2.2.0/config .

2. Edi t fi le zookeeper.properties by adding fol lowing l ines:



maxClientCnxns=0

initLimit=5

syncLimit=2

server.1=10.27.20.16:2888:3888

server.2=10.27.20.60:2888:3888

server.3=10.15.208.236:2888:3888

Each server parameter must contain a unique integer identifier asshown above.

3. Go to folder/opt/mstr/MicroStrategy/install/MicroStrategy/Mes

sagingServices/Kafka/kafka_2.12-

2.2.0/tmp/zookeeper .

4. Create a fi le named myid containing the identi fying value from theserver parameter name in the zookeeper.properties fi le.

Configure Kafka

1. Browse to folder/opt/mstr/MicroStrategy/install/MicroStrategy/Mes

sagingServices/Kafka/kafka_2.12-2.2.0/config .

2. Edi t fi le server.properties , add a rowzookeeper.connect=10.27.20.16:2181,10.27.20.60:21

81,10.15.208.236:2181 to the Zookeeper section.

############################# Zookeeper#############################

# Zookeeper connection string (see zookeeperdocs for details).



# This is a comma separated host:port pairs,each corresponding to a zk

# server. e.g."127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002".

# You can also append an optional chroot stringto the urls to specify the

# root directory for all kafka znodes.

# zookeeper.connect=localhost:2181

zookeeper.connect=10.27.20.16:2181,10.27.20.60:2181,10.15.208.236:2181

3. Modi fy the broker.id value to a unique integer from other Kafkaservers (the defaul t value is 0), such as for node 10.27.20.60 weuse number 2.

############################# Server Basics#############################

# The id of the broker. This must be set to aunique integer for each broker.

broker.id=2

Start, Stop, Restart, and Check Status of Messaging Services

Kafka Server and Zookeeper have been registered as service on Linux,so we can use service command to start, stop, and check status. Therestart command is not supported.

To execute a service command for Kafka Server and Zookeeper, enter:/etc/init.d/kafka-zookeeper {start|stop|status} .



To execute a service command for MicroStrategy Intel l igence ServerLog Consumer, enter: /etc/init.d/consumer-iserver{stop/start/status} .

MicroStrategy Platform AnalyticsPlatform Analytics is the next generation telemetry tool that leverages datafrom across the MicroStrategy platform including:

l Environment composi tion

l System usage

l Project usage

l User activi ty

l Content usage

l Cube usage

l Subscription usage

l Qual i ty

l Licensing

l Identi ty

Data is streamed in real time through the MicroStrategy MessagingServices layer and stored in the Platform Analytics warehouse. PlatformAnalytics provides several ways to access, analyze, and act on thistelemetry, including out of the box standard dossiers and native telemetryinterfaces in MicroStrategy Workstation; empowering administrators toprovide a better experience to MicroStrategy users.

ÁProtocols and PortsTCP : 5432



Linux Information

Configuration :<InstallPath>/MicroStrategy/PlatformAnalytics/conf

Installation : <InstallPath>/MicroStrategy/PlatformAnalytics

Log Location :<InstallPath>/MicroStrategy/PlatformAnalytics/log

Windows Information

Configuration : <InstallPath>\MicroStrategy\PlatformAnalytics\conf

Installation : <InstallPath>\MicroStrategy\Platform Analytics

Log Location : <InstallPath>\MicroStrategy\PlatformAnalytics\log

Accessing Platform Analytics

You can access Platform Analytics data in three di fferent ways dependingon your needs:

l By viewing the Platform Analytics data embedded in Workstation : Oneof the exci ting features of Platform Analytics is that i t exposes some of thedata that i t captures directly in the user interface of Workstation. Thisal lows users who would otherwise not know how to consume PlatformAnalytics data, to gain access to important MicroStrategy data. For moreinformation, see How to View Dossier Usage in the Workstation Onl ineHelp.

l By running the out-of-the-box Platform Analytics dossiers: PlatformAnalytics ships with a MicroStrategy project that provides out-of-the-boxdossiers designed to showcase some of the data that Platform Analytics


https://www2.microstrategy.com/producthelp/2020/Workstation/WebHelp/Lang_1033/index.htm



captures for each of the di fferent system areas. The dossiers includedwith Platform Analytics are:

l Compliance Telemetry: Determine i f a MicroStrategy implementationcompl ies wi th the l icense enti tlements.

l Cube and Cache Monitoring : Ensure that cubes and caches are beingful ly leveraged to improve the performance of key analytics content.

l Error Analysis: Detect errors and anomal ies in the system and improvethe experience of MicroStrategy users by fixing those issues.

l Object Telemetry: Identi fy the most popular analytics content in thesystem and determine who is viewing i t and how fast i t runs.

l Project Overview: Analyze the performance of the MicroStrategyprojects and determine which users connect to them and which productsthey use to connect.

l Subscription Analysis: Determine which analytics content userssubscribe to and how much load these subscriptions create on thesystem.

l User Activity: Moni tor what users do in MicroStrategy and ensure thatthey have a posi tive experience free of performance issues and othererrors.

l By creating your own dossiers: Platform Analytics also supports thecreation of sel f-service content (dossiers, reports, and documents) whichare based on the out-of-the-box schema and appl ication objects includedin the Platform Analytics project.

MicroStrategy RepositoryTo help reduce deployment complexi ty MicroStrategy now includes anembedded reposi tory that can support the fol lowing MicroStrategy products:

l Metadata Reposi tory

l Col laboration Server



l Platform Analytics

The infrastructure is instal led and ready for use should this be the right fi tfor your deployment. This embedded reposi tory is automatical ly configured,optimized, and managed for you with no manual intervention required forroutine usage.

Installation

MicroStrategy Reposi tory is instal led i f ei ther Platform Analytics,Col laboration Server, or both are instal led.

l Product Name: Reposi tory

l Default Installation Path : C:\Program Files (x86)\Common

Files\MicroStrategy\Repository

l Repository directory structure:

l \pgsql

l \repository-administration

How to log in to MicroStrategy Repository

The instal ler wi l l create users and database tables for PlatformAnalytics and Col laboration Server. Default_Accounts.txt is thefi le containing the user names and passwords to the reposi tory createdduring the instal lation. The defaul t location of Default_Accounts.txt is C:\Program Files (x86)\Common

Files\MicroStrategy\Default_Accounts.txt . This fi le shouldbe moved to a secure location upon completing the instal l .

Users created in the Reposi tory by the instal ler:



Username

Access Privileges

mstrMicroStrategy user has access to Plat formAnalyt ics and Collaborat ion Serverdatabases.

Super User

mstr_pa

MicroStrategy user has access to thePlat form Analyt ics database, but does nothave access to the Collaborat ion Serverdatabase.

CREATE DATABASE, SELECTDATABASE, SELECT TABLE,CREATE TABLE, DROP TABLE

mstr_collab

MicroStrategy user has access to theCollaborat ion Server database but does nothave access to the Plat form Analyt icsdatabase.

No Create DB, SELECT,INSERT, CREATE TABLE,DROP TABLE

Databases created in the Reposi tory by the instal ler:

Product Database

Plat form Analyt ics plat form_analyt ics_wh

Collaborat ion Server mstr_collab

To log in navigate to:

C:\Program Files (x86)\CommonFiles\MicroStrategy\Repository\pgsql\bin

and run:

psql.exe -U <UserName> -d <database> -h <host>

Reposi tory is instal led i f ei ther Platform Analytics, Col laboration Server,



or both instal led.

l Product Name: Reposi tory

l Default Installation Path :/opt/mstr/MicroStrategy/install/Repository

l Repository directory structure:

l /bin

l /pgdata

l /postgres11

l /repository-administration

l Default_Accounts.txt

l Compressed file name: mstr36.tzp

To veri fy the version of the PostgreSQL run:

/opt/mstr/MicroStrategy/install/Repository/bin/mstr_pgsql --version

How to log in to MicroStrategy Repository

The instal ler wi l l create users and database tables for PlatformAnalytics and Col laboration Server. Default_Accounts.txt is thefi le containing the user names and passwords to the reposi tory createdduring the instal lation. The defaul t location of Default_Accounts.txt is/opt/mstr/MicroStrategy/install/Repository/Default_

Accounts.txt . This fi le should be moved to a secure location uponcompleting the instal l .

Users created in the Reposi tory by the instal ler:



Username

Access Privileges

mstrMicroStrategy user has access to Plat formAnalyt ics and Collaborat ion Serverdatabases.

Super User

mstr_pa

MicroStrategy user that has access to thePlat form Analyt ics database, but does nothave access to the Collaborat ion Serverdatabase.

CREATE DATABASE, SELECTDATABASE, SELECT TABLE,CREATE TABLE, DROPTABLE

mstr_collab

MicroStrategy user that has access to theCollaborat ion Server database but does nothave access to the Plat form Analyt icsdatabase.

No Create DB, SELECT,INSERT, CREATE TABLE,DROP TABLE

Databases created in the Reposi tory by the instal ler:

Product Database

Plat form Analyt ics plat form_analyt ics_wh

Collaborat ion Server mstr_collab

To log in navigate to:

/opt/mstr/MicroStrategy/install/Repository/bin

and run:

./mstr_psql -U <UserName> -d <database> -h <hostIP>



Installation Scenarios

The tables below explain how the instal lation and configuration ofMicroStrategy Reposi tory is handled based on the instal lation type and thecomponents selected.

Fresh Instal lation

ComponentsInstalled

Result

Plat formAnalyt ics alone isinstalled

Plat form Analyt ics is installed and conf igured with Repository, mstr &mstr_pa user credent ials are populated in the Default_Accounts. txt f i le

Collaborat ionServer alone isinstalled

Collaborat ion Server is installed and conf igured with Repository, mstr &mstr_collab user credent ials are populated in the Default_Accounts. txtf i le

Plat formAnalyt ics andCollaborat ionServer areinstalled

Repository is installed and conf igured with the both products andDefault_Accounts. txt f i le is generated with all three user credent ials

Collaborat ionServer is installedin one node andPlat formAnalyt ics on other

Repository is installed in both nodes mstr & mstr_collab user credent ialsare populated in the Default_Accounts. txt f i le on the Collaborat ionServer installat ion node mstr & mstr_pa user credent ials are populatedin the Default_Accounts. txt f i le on the Plat form Analyt ics installat ionnode

Modify Current Instal lation

CurrentlyInstalledComponents

Modification Result

Neither Add Plat form Repository is installed and conf igured with the both




Modification Result

Plat formAnalyt ics orCollaborat ionServer areinstalled

Analyt ics andCollaborat ionServer

products and Default_Accounts. txt f i le is generated withall three user credent ials.

Add Plat formAnalyt ics

Plat form Analyt ics is installed and conf igured withRepository and mstr, mstr_pa user credent ials arepopulated in the Default_Accounts. txt f i le.

AddCollaborat ionServer

Collaborat ion Server is installed and conf igured withRepository and mstr, mstr_collab user credent ials arepopulated in the Default_Accounts. txt f i le.

Plat formAnalyt ics andCollaborat ionServer areboth installed

RemoveCollaborat ionServer

Collaborat ion Server is uninstalled and all Collaborat iondata is deleted from Repository and Collaborat ion usercredent ials are deleted from Default_Accounts. txt f i le(Users are warned to take the backup of Collaborat ionServer data before performing the install operat ion).

RemovePlat formAnalyt ics

Plat form Analyt ics is uninstalled and all Plat formAnalyt ics data is deleted from Repository and Plat formAnalyt ics user credent ials are deleted from Default_Accounts. txt f i le (Users are warned to take the backup ofPlat form Analyt ics data before performing the installoperat ion).

RemovePlat formAnalyt ics &Collaborat ionServer

Plat form Analyt ics and Collaborat ion Server areuninstalled along with Repository and directories aredeleted (Users are warned to take the backup of Plat formAnalyt ics and Collaborat ion Server data beforeperforming the install operat ion).

Only Plat formAnalyt ics wasinstalled

AddCollaborat ionServer

Collaborat ion Server is installed and conf igured withexist ing Repository and collaborat ion user credent ials areappended in Default_Accounts. txt f i le.

OnlyCollaborat ion

Add Plat formAnalyt ics

Plat form Analyt ics is installed and conf igured withexist ing Repository and Plat form Analyt ics user




Modification Result

Server wasinstalled

credent ials are appended in Default_Accounts. txt f i le.

Upgrade Current Instal lation

CurrentInstallation

UpgradedInstallation

Result

NeitherPlat formAnalyt ics orCollaborat ionServerInstalled

AddingPlat formAnalyt ics

l Plat form Analyt ics is installed and conf igured withRepository.

l mstr & mstr_pa user credent ials are populated in theDefault_Accounts. txt f i le on the Plat form Analyt icsinstallat ion node.

AddingCollaborat ionServer

l Collaborat ion Server is installed and conf igured withRepository.

l mstr & mstr_collab user credent ials are populated in theDefault_Accounts. txt f i le on the Collaborat ion Serverinstallat ion node.

AddingPlat formAnalyt ics &Collaborat ionServer

l Plat form Analyt ics and Collaborat ion Server areinstalled and conf igured with Repository.

l Default_Accounts. txt f i le is generated with all three usercredent ials.

Plat formAnalyt icsInstalled

No Changes

l Plat form Analyt ics is upgraded with exist ing MySQL DBconf igurat ion (Post install the Plat form Analyt icsConsumer wil l be down - user is recommended toupgrade the MySQL WH manually fol lowing thedocumentat ion).

l PostgreSQL Repository f i les are laid.



CurrentInstallation


Result

l Plat form Analyt ics Warehouse is upgraded and mstr &mstr_pa user credent ials are populated in the Default_Accounts. txt f i le.

AddingCollaborat ionServer


l PostgreSQL Repository f i les are laid.

l Plat form Analyt ics Warehouse is created Collaborat iondatabase wil l be created.

l mstr, mstr_pa & mstr_collab user credent ials arepopulated in the Default_Accounts. txt f i le.

RemovePlat formAnalyt ics

l Plat form Analyt ics wil l be uninstalled.

l No Repository f i les are installed.

Collaborat ionServerInstalled

AddingPlat formAnalyt ics

l Collaborat ion Server is upgraded, Plat form Analyt ics isinstalled and both are conf igured with Repository.

l mstr, mstr_pa & mstr_collab user credent ials arepopulated in the Default_Accounts. txt f i le

l MongoDB will be backed-up and restored af ter upgradeinstall with services down (User can manually start theservice and migrate the data following documentat ion).

RemoveCollaborat ionServer

l Collaborat ion Server wil l be uninstalled.

l No Repository f i les are installed.

No Changes

l Collaborat ion Server is upgraded and conf igured withRepository.

l mstr & mstr_collab user credent ials are populated in theDefault_Accounts. txt f i le.



CurrentInstallation


Result


Plat formAnalyt ics orCollaborat ionServerInstalled

No Changes


l PostgreSQL Repository f i les are laid, Plat form Analyt icsWarehouse is created.

l Collaborat ion Server is upgraded and conf igured withRepository.

l mstr, mstr_pa & mstr_collab user credent ials arepopulated in the Default_Accounts. txt f i le.


Repository Services

File Name Location Info

MicroStrategyRepository

C:\Program Files (x86)\CommonFiles\MicroStrategy\Repository\pgsql\bin

This f i le acceptsstart /stop/restart /statusparameters.

MicroStrategyRepositoryadminist rat ion

C:\Program Files (x86)\CommonFiles\MicroStrategy\Repository\ repository-administ rat ion

mstr-root@<TIMESTAMP>-repository-administ rat ionis stored into the initd_




scripts directory when youdecide not to setup theMicroStrategy processesas services, they can usethis script to do it later.

Some people also f ind itpract ical to have all thestartup scripts on thesame directory and withthe t imestamp-less name.


mstr_pg_ct l/opt /mstr/MicroStrategy/ install/Repository/bin

This f i le acceptsstar/stop/restart /statusparameters.

I t is a wrapper point ing to<MSTR_INSTALL_PATH>/Repository/postgres11/bin/pg_ct l

mstr-root@<TIMESTAMP>-repository-server

/etc/ init .d

The PostgreSQL servicecalled when boot ing up orwhen issuingstart /stop/status/restartcommands using the "service"command.

This f i le wil l be created only ifyou have selected to run theMicroStrategy processes as




services during theinstallat ion.

Setup wil l set the service tostart automat ically uponsystem startup. In case of aPlat form Analyt ics upgrade(and collaborat ion is notinstalled), this service is setto manual.

respository-server

/opt /mstr/MicroStrategy/ install/ initd_scripts

mstr-root@<TIMESTAMP>-repository-server is storedinto initd_scripts directorywhen user decides not tosetup the MicroStrategyprocesses as services, theycan use this script to do itlater.

Some people also f ind itpract ical to have all thestartup scripts on the samedirectory and with thet imestamp-less name.

repository-administ rat ion

/opt /mstr/MicroStrategy/ install/ initd_scripts

mstr-root@<TIMESTAMP>-repository-administ rat ion isstored into the initd_scriptsdirectory when you decide notto setup the MicroStrategyprocesses as services, theycan use this script to do itlater.

Some people also f ind itpract ical to have all the




startup scripts on the samedirectory and with thet imestamp-less name.

Repository Administration

The fol lowing database administration tasks are performed by theDatabase Administration Tool :

l Backup at a speci fied frequency or on-demand

l Restore a particular database from previously taken backup fi les

l Restore al l databases from previously taken backup fi les

Configuration File

DBAdminConfig.yaml is a configuration fi le is used to set up thedatabase connection, the backup location, and database administrationtasks frequency.

The defaul t location of DBAdminConfig.yaml is:

C:\Program Files (x86)\Common

Files\MicroStrategy\Repository\repository-

administration\conf

Sample fi le:

---

pgHost: localhost

pgDbNames:

- platform_analytics_wh

- mstr_collab

pgUser: mstr



pgPasswd: sest+9y+e6OdXIXTHjgPoC7osqE0rGMzgjR1zA==,kc7GbAQ8pv5yt32L

pgPort: 5432

pgSSLcert: ~

pgSSLkey: ~

pgSSLrootcert: ~

pgSSLmode: prefer

pgBackupLocation: C:\Program Files (x86)\Common

Files\MicroStrategy\Repository\pgsql\PGDATA

pgMaxAllowedBackupCount: 5

scheduledConfiguration:

startDate: 1993-11-12

backupFrequencyInDays: 2

localTimeOfExecution: 23:00

localTimeOfStatsCollection: 00:30

The following files should be accessible:

l pg_dump

l pg_restore

Database Administration Tool

To launch the Database Administration Tool :

1. Open the command prompt and navigate to the reposi tory-administration bin folder:



administration\bin

2. Run the fi le mstr-repo-ondemand-dba-operations.bat .

This wi l l open the DBAOperations uti l i ty:

****** DBA Tools ******

Enter choice



1) Backup

2) Restore

3) Vacuum

0) Exit

The uti l i ty exi ts after every operation.

To Backup

Selecting the Backup option (1) wi l l l ist al l the databases from theDBAdminConfig.yaml fi le along with the options to backup al ldatabases and exi t the uti l i ty.

User selected: 1 (backup)

Select the database you want to backup.

1) platform_analytics_wh

2) mstr_collab

3) Backup all databases.

0) Exit

Databases wi l l be backed up in the defaul t backup directory, insidetheir individual folders:

l ..\Repository\pgsql\PGDATA\platform_analytics_wh

l ..\Repository\pgsql\PGDATA\mstr_collab

The uti l i ty wi l l compute the fol lowing:

l Database size

l Estimated backup size

l Avai lable free space on disk

(platform_analytics_wh) Database Size: 44.9 MiB

(platform_analytics_wh) Estimated backup size: 4.0 MiB

(platform_analytics_wh) Available Free Space : 12.3 GiB

Backing up database: platform_analytics_wh(platform_analytics_wh) Backup



File Created: backup_platform_analytics_wh_20191010.sql

(platform_analytics_wh) Backup File Size: 1.5 MiB

*** Finished backup operation on database: platform_analytics_wh ***

If the backup was already done on the given day’s timestamp, the uti l i tywi l l ask the user whether he wants to overwri te the existing backup.




(platform_analytics_wh) Backup already done today. Date : 20190930

Overwrite File ? (y/n)

y

(platform_analytics_wh) Overwriting existing backup: backup_platform_

analytics_wh_20190930.sql

Backing up database: platform_analytics_wh(platform_analytics_wh) Backup

File Created: backup_platform_analytics_wh_20191010.sql



To Restore

Ensure that all applications connected to the database you want to restore arestopped. For example, if you want to restore platform_analytics_wh ,you must stop the Platform Analytics Consumer before selecting andperforming the steps in Restore.

Selecting the Restore option (2) on the main menu wi l l show a warningthat the operation wi l l overwri te the existing data. However, the uti l i tywi l l take a backup just before restoring to ensure no data is lost.

****** DBA Tools ******

Enter choice

1) Backup

2) Restore

3) Vacuum

0) Exit



2

User selected: 2 (restore)

*** This operation WILL DELETE ALL EXISTING DATA and overwrite the

database with backup data. Changes CAN NOT be undone later. ***

Do you want to continue? (y/n)

Selecting yes, wi l l move the uti l i ty forward and l ist al l the databasesthat can be restored as wel l as an option to restore everything. IfRestore al l is selected, i t wi l l restore al l the databases with the latestbackup fi le.




y

Select the database you want to restore.


2) mstr_collab

3) Restore all databases.

0) Exit

Selecting a given database wi l l move the uti l i ty forward and display therestore options. The fi rst option wi l l backup the selected database withi ts latest backup fi le. The second option al lows for selection of a custombackup.

If Restore from Latest Backup is selected, the uti l i ty wi l l find the latestbackup fi le in the defaul t di rectory, print the name of the fi le, restore thedatabase, and create a pre-restore backup in the directory to ensuredata is not lost.

Select restore file

1) Restore from Latest Backup

2) Restore from Custom Backup

0) Exit

1

Restoring latest backup



Searching for backup files in C:\Program Files (x86)\Common

Files\MicroStrategy\Repository\pgsql\PGDATA\platform_analytics_wh

Latest backup file found: backup_platform_analytics_wh_20190930.sql

Starting restore process

*** Restoring database : platform_analytics_wh

If Restore from Custom Backup is selected, the uti l i ty wi l l print the pathto the defaul t backup location and ask the user i f they want to search forbackups in that path. The user can then select that path or enter acustom path. After the fi le path is entered, the user needs to enter therestore fi le name. The uti l i ty wi l l search for the fi le and begin restoringi f the fi le is found.

Select restore file



0) Exit

2

Restoring custom backup

Default backup path : C:\Program Files (x86)\Common

Files\MicroStrategy\Repository\pgsql\PGDATA\platform_analytics_wh

Use default backup path ? (y/n)

y

Enter file name to restore. Press x to cancel.

backup_platform_analytics_wh_20190930

File 'backup_platform_analytics_wh_20190930.sql' found.

Restoring file backup_platform_analytics_wh_20190930.sql.


To Vacuum

Whenever rows in a PostgreSQL table are updated or deleted, deadrows are left behind. Vacuum gets rid of them so that space can bereused. If a table doesn’ t get vacuumed, i t wi l l get bloated, whichwastes disk space and slows down sequential table scans.



If the Vacuum option (3) is selected, the uti l i ty computes bloat for al ldatabases and generates a report to the user.

****** DBA Tools ******

Enter choice

1) Backup

2) Restore

3) Vacuum

0) Exit

3

User selected: 3 (vacuum)

*** BLOAT REPORT ***

** Bloat report for database: platform_analytics_wh **

Table Name | Bloat Percent

| Wasted KBs

lu_minute | 2.0

| 65536

etl_lu_status_category | 1.0

| 24576

etl_rel_action_tran_type | 1.3

| 8192

lu_action_type | 2.0

| 8192

lu_date | 1.1

| 8192

lu_privilege | 1.5

| 8192

lu_session_source | 1.0

| 0

lu_sql_pass_type | 1.0

| 0

lu_week | 1.0

| 0

rel_date_timeperiod | 1.0

| 0

rel_date_weektime_window | 0.0

| 0

etl_rel_source_sub_type_object_type | 1.0

| 0



lu_db_type | 1.0

| 0

lu_db_version | 1.0

| 0

lu_object_type | 1.0

| 0

lu_product | 1.0

| 0

** Bloat report for database: mstr_collab **


| Wasted KBs

Select the database you want to vacuum.


2) mstr_collab

3) vacuum all databases

4) Full vacuum all databases.

0) Exit

You can choose to vacuum an individual database, vacuum al ldatabases, or ful l vacuum al l databases.

When performing vacuum , the dead space is reclaimed and madeavai lable for reuse by the same object, table, etc.

Full vacuum all databases writes the entire content of the tableinto a new disk file and releases the wasted space back to the OS. Thiscauses a table-level lock on the table and slows speeds. Full vacuum

all databases should be avoided on a high load system. You muststop the Platform Analytics Consumer before performing full vacuum alldatabases.

*** Vacuum ***

Select vacuum type

1) Vacuum Bloated Tables

2) Vacuum All Tables

3) Full Vacuum (Blocks DB)

0) Exit



1

Starting Vacuum on tables in list

Vacuuming table : lu_minute with 65536 wasted space

Vacuuming table : etl_lu_status_category with 24576 wasted space

Vacuuming table : etl_rel_action_tran_type with 8192 wasted space

Vacuuming table : lu_action_type with 8192 wasted space

Vacuuming table : lu_date with 8192 wasted space

Vacuuming table : lu_privilege with 8192 wasted space

Vacuuming table : lu_session_source with 0 wasted space

Vacuuming table : lu_sql_pass_type with 0 wasted space

Vacuuming table : lu_week with 0 wasted space

Vacuuming table : rel_date_timeperiod with 0 wasted space

Vacuuming table : rel_date_weektime_window with 0 wasted space

Vacuuming table : etl_rel_source_sub_type_object_type with 0 wasted space

Vacuuming table : lu_db_type with 0 wasted space

Vacuuming table : lu_db_version with 0 wasted space

Vacuuming table : lu_object_type with 0 wasted space

Vacuuming table : lu_product with 0 wasted space

Database Capacity Planning

MicroStrategy 2020 also includes a tool to moni tor MicroStrategyReposi tory. For configuration settings, please refer to the ConfigurationFi le section above.

Trigger statistics col lection

Capaci ty planning statistics col lection is turned on by defaul t afterinstal lation. The service is control led with a batch fi le which acceptsstart | stop | restart | status as parameters.

1. From the command prompt, go to:



administration\bin



2. Cal l the fol lowing batch fi le wi th the appl icable parameter:

.\mstr-repo-dba-operations.bat start | stop |

restart | status

To change the time of statistics col lection, see KB483944.

Monitoring Database Status

The Platform Analytics project includes the Database Capaci ty Planningdossier to moni tor the status of MicroStratey Reposi tory.

l Overview page:

The overview wi l l give some basic info about the database, includingdatabase names, IP, and database versions as wel l as the trend ofdatabase size growth.

l Transactions page:


https://community.microstrategy.com/s/article/How-to-Modify-the-Time-of-Statistics-Collection-Using-the-Database-Administration-Tool?language=en_US


Transactions wi l l give the dai ly trend i f the database commits,rol lbacks, disk reads, cache hi ts.

l Table Overview page:

For the table-level information, table overview wi l l show stats abouteach table in the selected database. Right-cl ick on a l isted schema ortable, and cl ick Go To Page: Table Trend to get the detai led data ofthis table or schema.



l Table Trend page:

The fol lowing database administration tasks are performed by the



Database Administration Tool :

l Backup at a speci fied frequency or on-demand

l Restore a particular database from previously taken backup fi les

l Restore al l databases from previously taken backup fi les

DBAdminConfig.yaml is a configuration fi le is used to set up thedatabase connection, the backup location, and database administrationtasks frequency.

The defaul t location of DBAdminConfig.yaml is:

/opt/MicroStrategy/Repository/repository-

administration/conf

Sample fi le:

---

pgHost: localhost

pgDbNames:

- platform_analytics_wh

- mstr_collab

pgUser: mstr

pgPasswd: sest+9y+e6OdXIXTHjgPoC7osqE0rGMzgjR1zA==,kc7GbAQ8pv5yt32L

pgPort: 5432

pgSSLcert: ~

pgSSLkey: ~

pgSSLrootcert: ~

pgSSLmode: prefer

pgBackupLocation: /opt/MicroStrategy/Repository/repository-

administration/backups/

pgMaxAllowedBackupCount: 5

scheduledConfiguration:

startDate: 1993-11-12

backupFrequencyInDays: 2

localTimeOfExecution: 23:00

localTimeOfStatsCollection: 00:30



The following files should be accessible:

l pg_dump

l pg_restore

To change the time of statis tics collection, see KB483944 .

Database Administration Tool

To launch the Database Administration Tool :

1. Open a terminal window and navigate to the reposi tory-administration/bin folder:

/opt/MicroStrategy/Repository/repository-

administration/bin

2. Run ./mstr-repo-ondemand-dba-operations.sh .

This wi l l open the DBAOperations uti l i ty:

****** DBA Tools ******

Enter choice

1) Backup

2) Restore

3) Vacuum

0) Exit

The uti l i ty exi ts after every operation.

To Backup

Selecting the Backup option (1) wi l l l ist al l the databases from theDBAdminConfig.yaml fi le along with the option to backup al ldatabases and exi t the uti l i ty.

User selected: 1 (Backup)

Select the database you want to backup.



https://community.microstrategy.com/s/article/How-to-Modify-the-Time-of-Statistics-Collection-Using-the-Database-Administration-Tool?language=en_US


2) mstr_collab

3) Backup all databases.

0) Exit

Databases wi l l be backed up in the defaul t backup directory, insidetheir individual folders:

l /opt/MicroStrategy/Repository/repository-

administration/backups/platform_analytics_wh

l /opt/MicroStrategy/Repository/repository-

administration/backups/mstr_collab

The uti l i ty wi l l compute the fol lowing:

l Database size

l Estimated backup size

l Avai lable free space on disk



platform_analytics_wh) Available Free Space : 12.3 GiB

Backing up database: platform_analytics_wh

(platform_analytics_wh) Backup File Created: backupplatform_analytics_wh_

20191010.sql



If the backup was already done on the given day’s timestamp, i t wi l l aski f you want to overwri te the existing backup.




(platform_analytics_wh) Backup already done today. Date : 20190930

Overwrite File ? (y/n)

y



(platform_analytics_wh) Overwriting existing backup: backup_platform_

analytics_wh_20190930.sql

Backing up database: platform_analytics_wh

(platform_analytics_wh) Backup File Created:

backup_platform_analytics_wh_20191010.sql



To Restore

Ensure that all applications connected to the database you want to restore arestopped. For example, if you want to restore platform_analytics_wh ,you must stop the Platform Analytics Consumer before selecting andperforming the steps in Restore.

Selecting the Restore option (2) on the main menu wi l l show a warningthat the operation wi l l overwri te the existing data. However, the uti l i tywi l l take a backup just before restoring to ensure no data is lost.




2) mstr_collab

3) Restoreall databases.

0) Exit

2





Selecting yes wi l l move the uti l i ty forward and l ist al l the databases thatcan be restored along with the option to restore everything. Selectingrestore al l wi l l restore al l the databases with the latest backup fi le.






y



2) mstr_collab

3) Restore all databases.

0) Exit

Selecting a given database wi l l move the uti l i ty forward and display therestore options. The fi rst option lets you backup the selected databasewith i ts latest backup fi le. The second option al lows you to select acustom backup.

If Restore from Latest Backup is selected the uti l i ty wi l l find the latestbackup fi le in the defaul t di rectory, print the name of the fi le, restore thedatabase, and create a pre-restore backup in the directory to ensuredata is not lost.

Select restore file



0) Exit

1

Restoring latest backup

Searching for backup files in /opt/MicroStrategy/Repository/repository-


Starting restore process


If Restore from Custom Backup is selected, the uti l i ty wi l l print the pathto the defaul t backup location and ask i f you want to search for backupsin that path. You can then select that path or enter a custom path. Afterthe fi le path is entered, enter the restore fi le name. The uti l i ty wi l lsearch for the fi le and begin restoring i f the fi le is found.

Select restore file





0) Exit

2

Restoring custom backup

Default backup path : /opt/MicroStrategy/Repository/repository-


Use default backup path ? (y/n)

y

Enter file name to restore. Press x to cancel.

backup_platform_analytics_wh_20190930

File 'backup_platform_analytics_wh_20190930.sql' found.

Restoring file backup_platform_analytics_wh_20190930.sql.


To Vacuum

Whenever rows in a PostgreSQL table are updated or deleted, deadrows are left behind. Vacuum gets rid of them so that the space can bereused. If a table doesn’ t get vacuumed, i t wi l l get bloated, whichwastes disk space and slows down sequential table scans.

If the Vacuum option (3) is selected, the uti l i ty computes bloat for al ldatabases and generates a report.

****** DBA Tools ******

Enter choice

1) Backup

2) Restore

3) Vacuum

0) Exit

3

User selected: 3 (vacuum)

*** BLOAT REPORT ***

** Bloat report for database: platform_analytics_wh **


| Wasted KBs

lu_minute | 2.0

| 65536



etl_lu_status_category | 1.0

| 24576

etl_rel_action_tran_type | 1.3

| 8192

lu_action_type | 2.0

| 8192

lu_date | 1.1

| 8192

lu_privilege | 1.5

| 8192

lu_session_source | 1.0

| 0

lu_sql_pass_type | 1.0

| 0

lu_week | 1.0

| 0

rel_date_timeperiod | 1.0

| 0

rel_date_weektime_window | 0.0

| 0

etl_rel_source_sub_type_object_type | 1.0

| 0

lu_db_type | 1.0

| 0

lu_db_version | 1.0

| 0

lu_object_type | 1.0

| 0

lu_product | 1.0

| 0

** Bloat report for database: mstr_collab **


| Wasted KBs

Select the database you want to vacuum.


2) mstr_collab

3) vacuum all databases.



4) Full vacuum all databases.

0) Exit

You can choose to vacuum an individual database, vacuum al ldatabases, or ful l vacuum al l databases.

When performing vacuum , the dead space is reclaimed and madeavai lable for reuse by the same object, table, etc.

Full vacuum all databases writes the entire content of the tableinto a new disk file and releases the wasted space back to the OS. Thiscauses a table-level lock on the table and slows speeds. Full vacuum

all databases should be avoided on a high load system. You muststop the Platform Analytics Consumer before performing full vacuum alldatabases.

*** Vacuum ***

Select vacuum type

1) Vacuum Bloated Tables

2) Vacuum All Tables

3) Full Vacuum (Blocks DB)

0) Exit

1

Starting Vacuum on tables in list

Vacuuming table : lu_minute with 65536 wasted space

Vacuuming table : etl_lu_status_category with 24576 wasted space

Vacuuming table : etl_rel_action_tran_type with 8192 wasted space

Vacuuming table : lu_action_type with 8192 wasted space

Vacuuming table : lu_date with 8192 wasted space

Vacuuming table : lu_privilege with 8192 wasted space

Vacuuming table : lu_session_source with 0 wasted space

Vacuuming table : lu_sql_pass_type with 0 wasted space

Vacuuming table : lu_week with 0 wasted space

Vacuuming table : rel_date_timeperiod with 0 wasted space

Vacuuming table : rel_date_weektime_window with 0 wasted space

Vacuuming table : etl_rel_source_sub_type_object_type with 0 wasted space

Vacuuming table : lu_db_type with 0 wasted space



Vacuuming table : lu_db_version with 0 wasted space

Vacuuming table : lu_object_type with 0 wasted space

Vacuuming table : lu_product with 0 wasted space

Repository Commands

l \q : Qui t/Exi t

l \c __database__ : Connect to a database

l \d __table__ : Show table defini tion including triggers

l \d+ __table__ : More detai led table defini tion including descriptionand physical disk size

l \l : List databases

l \dy : List events

l \df : List functions

l \di : List indexes

l \dn : List schemas

l \dt *.* : List tables from al l schemas (i f *.* is omitted wi l l only showSEARCH_PATH tables)

l \dT+ : List al l data types.

l \dv : List views.

l \df+ __function__ : Show function SQL code.

l \x : Pretty-format query resul ts instead of the not-so-useful ASCII tables.

l \copy (SELECT * FROM __table_name__) TO 'file_path_

and_name.csv' WITH CSV : Export a table as CSV.

User Related:



l \du : List users

l \du __username__ : List a username if present.

l create role __test1__ : Create a role wi th an existing username.

l create role __test2__ noinherit login password __

passsword__; : Create a role wi th username and password.

l set role __test__; : Change role for current session to __test__.

l grant __test2__ to __test1__; : Al low __test1__ to set i ts role as__test2__.

Installation Prerequisites

Before you instal l MicroStrategy, you must have the fol lowing:

l MicroStrategy instal lation fi les.

l Before you begin upgrading any MicroStrategy systems, contact yourMicroStrategy account executive to obtain a new l icense key for theversion of software you are instal l ing.

l License key from MicroStrategy.

l You can access the instal lation fi les by asking your system administratorto share the fi les on a network location.

l You can reduce the amount of data that has to be downloaded for aninstal lation by excluding some of the instal lation fi les in theInstallations/DataFiles folder. During instal lation, theMicroStrategy Instal lation Wizard then l ists which of these fi les arerequired for your MicroStrategy instal lation. You can use this technique toprovide only the fi les required to complete a MicroStrategy instal lation,which can then be used to reduce the amount of data packaged anddownloaded for other MicroStrategy instal lations in your organization. For



steps to use this technique to create custom instal lation packages, seeCreating Custom Instal lation Packages, page 131.

l Instal lation location for your MicroStrategy products

To instal l MicroStrategy on Windows, you must have the fol lowingpermissions and privi leges:

l You must log on to your machine using a domain account wi th Windowsadministrative privi leges for the domain or target machine.

l The user instal l ing MicroStrategy needs wri te permissions in theinstal lation directory to complete the instal lation; otherwise theinstal lation fai ls.

In addi tion to the information provided above, review the fol lowing sectionsbefore the instal lation:

l Recommended Instal lation Location and Example Deployments, page 93

l Hardware Requirements and Recommendations, page 96

l Software Requirements and Recommendations, page 105

Recommended Installation Location and ExampleDeploymentsThere are a countless number of possible arrangements for al l the productsavai lable on the MicroStrategy platform, and what you decide to dodepends largely on your instal lation environment and requirements. Ingeneral , though, the fol lowing recommendations are usual ly true for atypical business intel l igence system:

l Intel l igence Server should be instal led on i ts own dedicated servermachine.

l MicroStrategy Web should be instal led on i ts own dedicated Web servermachine.



l The rest of the products can be instal led in varying combinationsdepending on who intends to use them and on what machines.

These are just suggestions to help you get started. Read the rest of thischapter for more detailed guidelines.

The fol lowing sections provide basic examples of di fferently sizedproduction deployments wi th MicroStrategy products. The examples aregeneral ized and do not include al l of the MicroStrategy products. You canuse these examples to help plan how to deploy MicroStrategy products.

Small production deployment



Medium production deployment



Large production deployment

Hardware Requirements and RecommendationsMicroStrategy acknowledges that variables, such as CPU speed, CPU type,operating system version, service upgrades, fi le space, and physical andswap memory, are factors that play an important role in making yourdeployment of MicroStrategy a successful one.

Determining the necessary hardware requirements to support MicroStrategy isdependent on many factors including the complexity of your MicroStrategyenvironment, the deployment strategy of MicroStrategy features, usercommunity requirements, expected peak usage requirements, and responsetime expectations. Factors such as these must be considered to determine thehardware requirements for your MicroStrategy production environment.

For detai ls and exact information regarding supported and certi fiedoperating system versions for a MicroStrategy release, see the Readme onthe MicroStrategy websi te.


https://www2.microstrategy.com/producthelp/2020/Readme/index.htm


For Linux systems, several system settings can affect the performance ofMicroStrategy Intel l igence Server. These settings do not need to be setbefore a MicroStrategy instal lation. For more information on these settingsand their recommended values, see Recommended System Settings forLinux, page 127.

System hardware requirements and recommendations for Windows

The fol lowing table l ists the recommended and minimum hardwarerequirements for MicroStrategy products. The information provided isintended to give you general guidance on hardware requirements to supportthe MicroStrategy product sui te. Determining the necessary hardwarerequirements to support MicroStrategy is dependent on many factorsincluding but not l imi ted to the complexi ty of your MicroStrategyenvironment, the deployment strategy of MicroStrategy features, usercommunity requirements, expected peak usage requirements, and responsetime expectations. Factors such as these must be considered to determinethe hardware requirements for your MicroStrategy production environment.

To ensure the installation process is completed successfully , allMicroStrategy platform and Update installations require 15 GB of disk spacefor the installer itself. This is in addition to any component or common filestorage requirements lis ted below.

MicroStrategy installs a set of common files that are shared when installingmultiple MicroStrategy products on the same machine. With a typicalinstallation setup type, these files are installed on the C: drive.

In addition to the storage requirements lis ted for the products in the tablebelow, you should estimate an additional 2 GB of storage space for thecommon files that are shared amongst all products. While this estimate isconservatively high, planning for this additional space helps to ensure asuccessful installation.

The storage requirements lis ted in the table below for Intelligence Server andNarrowcast Server include additional space than is required for the initial



installation. This additional space is to support the creation of the various filesthat these products require throughout their use in a MicroStrategyenvironment. Additional space may be required depending on the use ofIntelligence Server and Narrowcast Server in your MicroStrategy environment.

Intelligence Server is licensed based on CPU number and clock speed. Thus,Intelligence Server can only be installed on machines with a maximum clockspeed that equals the licensed clock speed. If you try to install the product on amachine faster than what is licensed, installation fails . See the SystemAdministration Guide for more information about licensing.

MicroStrategy Product Processor Memory Storage

MicroStrategy System Managerx86 or x64compat ible

2 GB 0.5 GB

MicroStrategy Command Managerx86 or x64compat ible

2 GB 0.25 GB

MicroStrategy Enterprise Manager x64 compat ible 1 GB 0.25 GB

MicroStrategy Object Managerx86 or x64compat ible

1 GB 0.25 GB

MicroStrategy Developer productsx86 or x64compat ible

2 GB or higher 0.25 GB

MicroStrategy Intell igence Server x64 compat ible

4 GB or higher

Using 4 GB of RAMis a minimum levelof support for theMicroStrategyProduct Suite,which does not takeinto account theperformance of a

Three t imesthe amount ofRAMavailable toIntell igenceServer. Forexample, anIntell igenceServer that isprovided 4 GBof RAM






product ion system.Performancetest ing has shownthat 64 GB or moreof RAM should beavailable to allowMicroStrategyIntell igence Serverto fully support andtake advantage ofthe completefeature set of theMicroStrategyProduct Suite,while obtainingsystem-wide highperformance. Thislevel of systemresources allowsMicroStrategyIntell igence Serverto fully useperformance-improvingtechnologies suchas MicroStrategyOLAP Services,and to supportopt imalperformance forMicroStrategyReport Servicesdocuments anddossiers and theother features ofthe MicroStrategy

requires 12GB of harddrive space.




MicroStrategy Integrity Manager x64 compat ible 2 GB or higher 0.25 GB

MicroStrategy Off icex86 or x64compat ible

2 GB 0.5 GB

MicroStrategy Mobile ServerThe MicroStrategy Mobile Server hardwarerequirements are the same as those for MicroStrategyWeb Server hardware requirements.

MicroStrategy Narrowcast Serverx86 or x64compat ible

4 GB 4 GB

MicroStrategy SDKThe SDK is not included in the MicroStrategyinstallat ion and can instead be downloaded from theMicroStrategy support site.

MicroStrategy Analyt ics Modules Not applicable Not applicable 0.5 GB

MicroStrategy Web: Web Clientx86 or x64compat ible

2 GB or higher

MicroStrategyWeb can beaccessedfrom a third-party webbrowser,which meansthere are noaddit ionalstoragerequirements.

MicroStrategy Web: Web Server x64 compat ible 4 GB or higher 0.5 GB

System hardware requirements and recommendations on Linux

The fol lowing information is intended to give you general guidance onhardware requirements to support the MicroStrategy product sui te.Determining the necessary hardware requirements to support MicroStrategy



is dependent on many factors including but not l imi ted to the complexi ty ofyour MicroStrategy environment, the deployment strategy of MicroStrategyfeatures, user community requirements, expected peak usage requirements,and response time expectations. Factors such as these must be consideredto determine the hardware requirements for your MicroStrategy productionenvironment.

The storage recommendations lis ted in the table below provide an estimate forinstalling and supporting each MicroStrategy product on a separate machine.For information on the total s ize of a MicroStrategy installation when installingall MicroStrategy products on the same machine, see below.

A successful configuration of Intelligence Server depends on a validcombination of an operating system and a CPU architecture. Valid operatingsystem and CPU architecture combinations for Intelligence Server are lis ted inthe table below.

The storage requirements lis ted in the table below for Intelligence Serverinclude additional space than is required for the initial installation. Thisadditional space is to support the creation of the various files that theseproducts require throughout their use in a MicroStrategy environment.Additional space may be required depending on the use of Intelligence Serverin your MicroStrategy environment.

MicroStrategy Product Processor MemoryStorageRecommendation

MicroStrategy SystemManager

Linux: x86-64compat ible

2 GB or higher3 GB on otherLinux operat ingsystems

MicroStrategy CommandManager



MicroStrategy Intell igenceServer


16 GB or higherThree t imes theamount of RAM




Using 16 GB of RAM isa minimum level ofsupport for theMicroStrategy ProductSuite, which does nottake into account theperformance of aproduct ion system.Performance test ing hasshown that 64 GB ormore of RAM should beavailable to allowMicroStrategyIntell igence Server tofully support and takeadvantage of thecomplete feature set ofthe MicroStrategyProduct Suite, whileobtaining system-widehigh performance. Thislevel of systemresources allowsMicroStrategyIntell igence Server tofully use performance-improving technologiessuch as MicroStrategyOLAP Services, and tosupport opt imalperformance forMicroStrategy ReportServices documents anddossiers and the otherfeatures of the

available toIntell igenceServer.




MicroStrategy ProductSuite.

MicroStrategy IntegrityManager



MicroStrategy WebServices for Off ice



MicroStrategy MobileServer

The MicroStrategy Mobile Server hardware requirements arethe same as those for MicroStrategy Web Server hardwarerequirements.

MicroStrategy SDKThe SDK is not included in the MicroStrategy installat ion andcan instead be downloaded from the MicroStrategy supportsite.

MicroStrategy Web: WebServer



MicroStrategy Web: WebClient


2 GB or higher

MicroStrategyWeb can beaccessed from athird-party webbrowser, whichmeans there areno addit ionalstoragerequirements.

Storage requirements for all MicroStrategy products on Linux

The storage recommendations l isted above provide the storagerecommendations for the MicroStrategy products i f they are instal ledindividual ly on separate machines.



A conservative estimate of the total fi le size i f you instal l al l MicroStrategyproducts on the same machine, which can then share a set of common fi les,is 12 GB.

An update instal lation requires a minimum of 13GB disk space.

Temporary directory requirements for installation

In addi tion to the space requirements l isted above, you also need freespace in the temporary directory. When instal l ing on Linux, the instal lerrequires 100 MB of free space in the temporary directory. The defaul tlocation of the temporary directory is /tmp .

If the space in the defaul t temporary directory is inadequate, you can usethe tempdir command l ine option to change the location of the temporarydirectory. This directory must al ready exist and i t must be speci fied usingi ts absolute path, for example:

./setup.sh –tempdir /home/user/tmp

If you change the location of the temporary directory, free space is stillrequired in the default location of the temporary directory to launch theMicroStrategy installation routine.

MicroStrategy Mobile hardware requirements for mobile devices

The tables below l ist the MicroStrategy Mobi le cl ient appl ication hardwarerequirements for various mobi le devices. To veri fy updated requirementinformation, see the Readme.

Flash memory

Requirement Minimum Recommended

Flash memory 32 MB 64 MB




Android devices

Devices with OS minimum 4.x and certain GPUs are certi fied. Refer to thethi rd-party documentation for your Android device vendor to determine theGraphics Processing Uni t (GPU) for your device. To see the latest l ist ofdevices, see the current MicroStrategy Readme.

Software Requirements and RecommendationsSee the MicroStrategy Readme for the speci fic software requirements andrecommendations for MicroStrategy products on the Windows, UNIX, andLinux platforms.

Intelligence Server software requirements on Linux

For the exact information such as version numbers and space requirements,see the MicroStrategy Readme.

MicroStrategy Integri ty Manager for Linux platforms has the samerequirements as Intel l igence Server. Therefore, you can use the informationin this section for Intel l igence Server and Integri ty Manager requirementson Linux platforms.

The fol lowing MicroStrategy products require an X-windows-enabledenvironment on al l Linux platforms:

l GUI-based MicroStrategy Instal lation Wizard

l Diagnostics and Performance Logging tool

l Service Manager

The fol lowing requirements also apply to al l Linux platforms:

l A Web browser is required for viewing the MicroStrategy Readmes andonl ine help.

l Windows Services for UNIX or Samba is required for HTML documentsupport. Samba 3.0 is required for the support of HTML documents wi thalphanumeric names.





http://technet.microsoft.com/en-us/interopmigration/bb380242.aspx

http://www.samba.org/


The requirements l isted below describe general requirements as wel l asrequirements speci fic to the UNIX and Linux platforms.

Be aware of the following before reviewing the sections lis ted above:

l The operating systems listed are deemed supported or certified to reflect thelevel of internal testing that each configuration was exposed to for thecurrent release. MicroStrategy recommends using certified configurationsover the supported configurations.

l MicroStrategy certifies and supports operating systems that are compatiblewith a set of CPU chipsets, referred to as CPU architectures, that arebinary-compatible. MicroStrategy tests on at least one of the CPU chipsetswithin a set of binary-compatible CPU architectures for purposes ofcertify ing and supporting operating systems with MicroStrategy products. Avalid CPU architecture is provided in parentheses () to clarify the operatingsystem software certified or supported for Intelligence Server.

l All Linux operating systems are 64-bit.

l For information on LDAP Servers certified and supported for LDAPauthentication with various Intelligence Server machine environments, seethe MicroStrategy Readme ..

Configuring shared memory resources

To improve the performance, MicroStrategy Intel l igence Server can beconfigured to use shared memory resources. To support this configuration,you must ensure that the Intel l igence Server host machine uses valuesgreater than or equal to the resource l imi ts described below.

During instal lation you have the fol lowing options:

l Exit the MicroStrategy setup wizard to do the required systemchanges (Recommended): Select this option to cancel the instal lationand make the required system resource l imi t changes to support sharedmemory resources. This option is recommended for production




environments. Information on the recommended resource l imi ts is below.

l Allow the setup to reconfigure MicroStrategy to use Pipe as theDefault IPC Mechanism: Select this option to disable the use of sharedmemory resources for Intel l igence Server, and instead use the pipemechanism. Disabl ing the abi l i ty to use shared memory resources candecrease the performance of your MicroStrategy appl ications; therefore,this is not recommended for production environments.

l Keep Shared Memory as the Default IPC Mechanism. (MicroStrategymay not work properly): Select this option to keep your system resourcel imi ts set at their current values to support shared memory resources.Whi le this al lows you to continue instal lation with the current systemresource l imi ts, Intel l igence Server may not function properly afterinstal lation. If you plan to use shared memory resources for enhancedperformance of your production environments, you should select the fi rstoption to exi t the instal lation and make the required system changes.

The tables below provide recommended values for various system resourcel imi ts on Linux.

Modify ing the system resource limits lis ted below can affect system-widebehavior and therefore, steps to modify these values are not given. You shouldrefer to your Linux documentation and contact your system administrator tomodify these settings.

Semaphores are used to synchronize shared memory communications. Thenames of the settings that control semaphores di ffer between operatingsystems as l isted in the tables below:

Setting Name onLinux

DescriptionRecommendedValue

semmslMaximum number of semaphores in a semaphoreset .

250



Setting Name onLinux

DescriptionRecommendedValue

semmns Maximum number of semaphores in the system. 1024000

semopmMaximum number of operat ions in a simplesemaphore call.

250

semmni Maximum number of semaphore sets. 4096

Linux

For Linux requirements, see the System Requirements in the MicroStrategyReadme.

Supporting Intelligence Server memory allocation on Linux

MicroStrategy recommends that the Linux kernel setting vm.max_map_

count be defined as 5,242,880 bytes. This al lows Intel l igence Server touti l ize system memory resources. If a lower value is used, Intel l igenceServer may not be able to use al l avai lable system resources. This cancause some Intel l igence Server actions to fai l due to lack of systemresources, which could be completed i f the addi tional system resourceswere made avai lable by increasing the value for this kernel setting.

For information on this setting, including how to modi fy i ts value, refer toyour thi rd-party Linux operating system documentation.

MicroStrategy Web JSP software requirements andrecommendations

To confi rm the latest requirement information, see the MicroStrategyReadme. For speci fic patches, fi lesets, technology level , and otherrequirements for UNIX and Linux operating systems, see Intel l igenceServer software requirements on Linux, page 105.



Web server software

For information on the exact version numbers, see the MicroStrategyReadme.

MicroStrategy Web Services J2EE software requirements andrecommendations

To confi rm the latest requirement information, see the MicroStrategyReadme.

MicroStrategy SDK software requirements and recommendationsfor JSP environments

The table below l ists the JDK, JRE, and JVM requirements for theMicroStrategy SDK customizations for JSP environments. For completeMicroStrategy SDK software requirements, including .NET environmentrequirements, see the MicroStrategy Readme.

MicroStrategy System Manager software requirements onUNIX/Linux

For System Manager operating system requirements on Windows platforms,see the MicroStrategy Readme.

MicroStrategy Command Manager software requirements onUNIX/Linux

For Command Manager operating system requirements on Windowsplatforms, see the MicroStrategy Readme.

MicroStrategy Mobile software requirements for mobile devices

The tables below l ist the MicroStrategy Mobi le cl ient appl ication softwarerequirements for iPhone, iPod Touch, and iPad devices. To veri fy updatedrequirement information, see the MicroStrategy Readme.






MicroStrategy Mobile Server software requirements

The sections below l ist the MicroStrategy Mobi le Server softwarerequirements.

Mobile Server deployment requirements

l Mobi le Server ASP.NET can be deployed using the same requirementsl isted for MicroStrategy Web (see the MicroStrategy Readme).

l Mobi le Server JSP can be deployed using the same requirements l istedfor MicroStrategy Web (see MicroStrategy Web JSP softwarerequirements and recommendations, page 108).

Web browsers for Mobile Server

For web browsers that are supported, refer to the MicroStrategy Readme.

Supporting IIS 7.0.x or IIS 7.5.x as a web server for MicroStrategyWeb or Mobile Server

If you plan to use IIS 7.0.x or IIS 7.5.x as the web server for MicroStrategyWeb or Mobi le Server, you must ensure that some IIS options are enabled.The procedure below describes how to enable the options that are requiredto support IIS 7.0.x or IIS 7.5.x as a web server for MicroStrategy Web orMobi le Server.

To support IIS 7.0.x or 7.5.x as a web server for MicroStrategy Web or

Mobile Server

The third-party products discussed below are manufactured by vendorsindependent of MicroStrategy, and the steps to configure these products issubject to change. Refer to the appropriate Microsoft documentation for stepsto configure IIS 7.0.x or IIS 7.5.x.

On a Windows machine, open the Control Panel .





Double-cl ick Programs and Features.

Cl ick the Turn Windows features on or off task.

Expand Internet Information Services, and select the fol lowing options:

Expand Web Management Tools and select:

IIS Management Console

IIS Management Scripts and Tools

IIS Management Service

Expand World Wide Web Services, then expand ApplicationDevelopment Features, and select:

.NET Extensibility

ASP.NET

ISAPI Extensions

ISAPI Filters

Within World Wide Web Services, expand Common Http Features, andselect:

Default Document

Static Content

Expand Security, and select:

Request Filtering

Windows Authentication

Click OK .

Platform Analytics PrerequisitesBefore instal l ing Platform Analytics on a Windows or Linux machine, ensurethat al l of the fol lowing prerequisi tes are met.



l The fol lowing ports must be open and avai lable in the machines whereyou wi l l instal l the Telemetry Server(s) and Platform Analytics:

l 2181

l 2888 and 3888 (only i f you plan to cluster three or more TelemetryServers)

l 5432

l 6379

l 9092

l You must create a MicroStrategy user in the group System Monitors >System Administrators or have access to the defaul t Administrator user.

l For an estimation of resource requirements for stable and performantoperation of the Telemetry Store (previously cal led Platform AnalyticsConsumer) archi tecture under a consistent transactional load, seeKB482872: Capaci ty Planning for Platform Analytics.

l If instal l ing MySQL on another machine, the database user for thePlatform Analytics Reposi tory must be configured to al low remote access.Remote access can be enabled at the time of creating the DB User orafter by fol lowing these steps:

1. Connect to the MySQL Server using any cl ient (MySQL Workbench,DB Query Tool , etc.).

2. Run the command:

UPDATE mysql.user SET Host='%' WHERE Host='localhost' AND User='<DB

User Name>'; FLUSH PRIVILEGES;

3. Replace <DB User Name> with the user instal l ing the PlatformAnalytics Reposi tory.


https://community.microstrategy.com/s/article/KB482872-Capacity-Planning-for-Platform-Analytics


4. The database user can now connect to this MySQL server instancefrom any remote machine.

Required PortsDepending on the MicroStrategy components to be instal led, ensure thatthe fol lowing ports are open for communication.

Dependent MicroStrategy Product Installed Component Required Port

Intell igence Server Intell igence Server 34952

REST Server REST Server 34962

Collaborat ion Server Collaborat ion Server 3000

MicroStrategy Library

MicroStraegy Web

MicroStrategy Mobile

Apache Tomcat 8080

Plat form Analyt ics Apache Kafka 9092

Plat form Analyt ics Apache Zookeeper 2181

Plat form Analyt ics Redis 6379

Collaborat ion Not if icat ions

Plat form Analyt icsMicroStrategy Repository 5432

MicroStrategy Library

MicroStraegy Web

MicroStrategy Mobile

MicroStrategy Export 20100

MicroStrategy Ident ity Ident ity Manager 443

MicroStrategy Ident ity Ident ity Gateway 9501

MicroStrategy Ident ity Ident ity Server (one-way) 1443

MicroStrategy Ident ity Ident ity Server (two-way) 2443



Installation Considerations

The fol lowing section contains guidel ines and considerations forinstal lation.

System Sizing GuidelinesThe fol lowing topics describe sizing guidel ines to consider when youini tial ly set up MicroStrategy. You should periodical ly reevaluate thesystem and update i t based on actual system performance and use.

This section describes only the most basic guidelines. For detailed informationrefer to the System Administration Guide .

Number of users

The number of users can be measured in the fol lowing ways:

l Total users: Users that are registered in the system. For example, i f acorporate websi te is avai lable to be viewed by 950 individuals, the si tehas 950 total users.

l Active users: Users that are logged into the system. If a si te is avai lableto be viewed by 950 total users and 30 of them are logged in to the si te,there are 30 active users.

l Concurrent users: Users that have jobs being processed by a server(MicroStrategy Web, Intel l igence Server, and so on) at the same time. Forexample, a si te is avai lable to 950 total users, and 30 people are loggedin. Of 30 active users, 10 have jobs being processed by the serversimul taneously; 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 youexpect at any given time.




Report complexity

The more complex a report, the more Intel l igence Server resources arerequired. In this context, a "complex" report is one that requires a lot ofanalytical processing. Whi le reports wi th long, compl icated SQL arecertainly complex in nature, they do not necessari ly require addi tionalIntel l igence Server resources to execute. It is the analytical processing in areport that creates addi tional stress on an Intel l igence Server.

Since analytical ly complex reports create a heavier load on the Intel l igenceServer than simpler reports, you should have a general idea of what theaverage report complexi ty is for your system. Knowing this can help youdecide on a caching strategy. For example, you may decide to pre-cachecomplex reports and determine the processing power your Intel l igenceServer needs.

The database server processes the SQL that Intelligence Server generates, soreports with extremely complex SQL can place additional stress on thedatabase server. You should take this into account when siz ing your databaseserver machine.

Ad hoc reports versus caches

Report caches store the resul ts of previously executed reports. If a cl ient(MicroStrategy Web, Developer, and so on) requests a report that is cached,Intel l igence Server returns the cached report resul ts to the cl ient. For anyad hoc reports that are not cached, Intel l igence Server must go through theenti re report execution cycle before i t can return the resul ts. For thisreason, report caching al lows better response time whi le minimizing theload on the Intel l igence Server.

The benefi ts of caching are more apparent for complex reports than forsimple reports. Whi le caching a complex report may signi ficantly improveexecution time, a report cache for a simple report may not make muchdi fference in this regard.



Therefore, the more complex the ad hoc reporting is in your system, thegreater the overal l load on the Intel l igence Server. Be sure to take this intoaccount when sizing your Intel l igence Server machine.

The process for element browsing is similar to ad hoc reporting. Elementbrowsing takes place when you navigate through hierarchies of attributeelements, for example, v iewing the lis t of months in the year attribute. Bydefault, caching is enabled for element browsing. In addition, you can limit thenumber of elements to be retrieved at a time.

Report Services document

Report Services documents uti l ize MicroStrategy objects to run complexand sophisticated reports. The datasets avai lable to a document determinei ts content. Each dataset represents a report and i ts component objects,such as attributes, metrics, custom groups, and consol idations. When adataset is avai lable to a document, the enti re report or any componentobject from that dataset can be included in the document output.

When creating a document, refer to the fol lowing guidel ines to avoid anincrease in the Intel l igence Server execution time and the overal l CPUusage:

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

l The number of grids in the output document should be less in number.Consol idate the data to fi t into fewer grids in the output document, wherepossible.

l Use of complex elements, such as consol idations, custom groups, andsmart metrics can increase the Intel l igence Server usage, especial ly i fari thmetic operators are used in element defini tions.

l Use Custom formatting only when required.



OLAP Services

OLAP Services store reports as Intel l igent Cubes in the physical memory ofthe Intel l igence Server. When these Intel l igent Cubes are cached inmemory, report manipulations, such as adding derived metrics and derivedelements, formatting, and dri l l ing within the Intel l igent Cube, takeconsiderably less time. This is the case because the new SQL is not runagainst the database.

OLAP Services provide enhanced report manipulation functional i ty at thecost of Intel l igence Server resources, as the cubes are stored in thememory of the Intel l igence Server. Consider the fol lowing factors todetermine the size of the Intel l igent Cubes:

l Intel l igence Server resources

l Expected response time

l User concurrency

You must moni tor Intel l igence Server CPU uti l ization and memory usageclosely as OLAP Services might have an impact on the performance of theplatform, particularly the memory and report response time. For informationon OLAP Services, see the In-memory Analytics Guide. Addi tionalperformance tuning best practices for OLAP Services are provided in theSystem Administration Guide.

Additional considerations

Numerous factors can affect system performance, most of them related tosystem speci fics, which makes them difficul t to predict. Listed below arei tems you should consider when determining the requirements for yoursystem:

l Developer versus MicroStrategy Web usage—MicroStrategy products aredesigned with the assumption that the majori ty of users access thesystem through MicroStrategy Web whi le a smal ler percentage use the


https://www2.microstrategy.com/producthelp/2020/InMemoryAnalytics/WebHelp/Lang_1033/index.htm



Developer products.

l Statistics logging—Statistics logging is very useful for analyzing andfurther refining the system configuration based on actual usage. However,logging al l statistics al l the time can create a noticeable increase insystem response time. For this reason, you might choose to log only asubset of the statistics generated or only log statistics periodical ly.

l Backup frequency—Caches can be stored in memory and on disk. Whenyou enable backup, you al low the Intel l igence Server to wri te al l cachefi les to disk. If the backup frequency is set to the defaul t of zero, backupfi les are wri tten to disk as soon as they are created. However, wri ting al lcache fi les to disk al l the time can cause a noticeable reduction in systemperformance.

Set the backup frequency to a value that minimizes disk wri tes andoptimizes memory usage for your system.

l Ratio of MicroStrategy Web servers to Intel l igence Servers—In a typicalsystem you should have a 1:1 ratio of Intel l igence Servers toMicroStrategy Web servers. This ensures that resources on both sides areoptimized. However, you might find i t useful to add Intel l igence Servers orMicroStrategy Web servers depending on your particular requirements.

l Report Styles—MicroStrategy Web provides a set of di fferent XSL reportstyles. These styles provide an easy way for you to customize howreports look. Due to the varying complexi ty of these styles, some mightrequire more processing than others.

MicroStrategy Professional Services for high performance

MicroStrategy Professional Services has identi fied five primary leverscustomers can use to get dramatical ly faster performance:

l Employ in-memory Business Intel l igence

l Design high performance dashboards



l Optimize query efficiency

l Implement effective caching strategies

l Configure MicroStrategy for high performance

In just one week, MicroStrategy Professional Services, wi l l conduct athorough examination of your Business Intel l igence implementation,providing you with actionable recommendations on these five key areas toimprove overal l performance. The MicroStrategy Performance Analysisservice del ivers:

l Performance optimization roadmap : A customized report wi th priori tizedrecommendations to achieve performance goals.

l System configuration : Optimum configuration setting recommendationsto achieve efficient use of resources across di fferent MicroStrategyproducts.

l Performance monitoring plan : A set of performance related metrics toproactively moni tor and identi fy performance opportuni ties.

To learn how MicroStrategy Professional Services can help you assess andpriori tize your performance opportuni ties wi th a Performance Analysis, seeMicroStrategy Services.

Common questions about sizing

The sections below provide brief explanations to common sizing questions.For detai led information on tuning your MicroStrategy environment, see theTuning your System for Best Performance chapter in the SystemAdministration Guide. The sections below also provide other addi tionalresources.

Why should I increase the processor speed of Intelligence Server?

Increasing the processor speed of Intel l igence Server enhancesperformance and reduces execution time for al l analytical tasks and for


https://www.microstrategy.com/us/services




requests from the Extensible Markup Language (XML) and ComponentObject Model (COM) appl ication programming interfaces (APIs). If you seethat the machine or machines are running consistently at a high capaci ty,for example, greater than 80%, i t may be a sign that a faster processorwould improve the system's capaci ty.

For more detai led information on tuning your processors for yourMicroStrategy environment, see the section Managing system resources inthe System Administration Guide.

Why should I add more processors to Intelligence Server?

Adding more processors to the Intel l igence Server al lows for a better loaddistribution among the processors. This provides an overal l performancegain. If you notice that the processor is running consistently at a highcapaci ty, for example, greater than 80%, consider increasing the number ofprocessors.

For more detai led information on tuning your processors for yourMicroStrategy environment, see the section Managing system resources inthe System Administration Guide.

Why should I increase memory on the machine that hosts IntelligenceServer?

If the physical disk is uti l ized too much on a machine hosting Intel l igenceServer, i t can indicate that there is a bottleneck in the system'sperformance. To moni tor this on a Windows machine, use the WindowsPerformance Moni tor for the object PhysicalDisk and the counter % DiskTime. If you see that the counter is greater than 80% on average, i t mayindicate that there is not enough memory on the machine.

For more detai led information on tuning your machine's memory for yourMicroStrategy environment, see the section Managing system resources inthe System Administration Guide.






What would more network bandwidth do for me?

You can tel l whether your network is negatively impacting your system'sperformance by moni toring how much of your network's capaci ty is beingused. To moni tor this on a Windows machine, use the WindowsPerformance Moni tor for the object Network Interface, and the watch thecounter Total bytes/sec as a percent of your network's bandwidth. If i t isconsistently greater than 60% (for example), i t may indicate that the networkis negatively affecting the system's performance.

For very large resul t sets, increasing network bandwidth reducesbottlenecks created by network congestion. The resul t is larger data flowand faster query response time.

For more detai led information on tuning your network for your MicroStrategyenvironment, see the section How the network can affect performance in theSystem Administration Guide.

How many CPUs can a user fully utilize?

One user can ful ly uti l ize up to one CPU, regardless of the number of CPUsavai lable in the server. The load is spl i t across multiple CPUs in multi -processor servers.

For more detai led information on how l icensing can affect the uti l ization ofCPUs, see the System Administration Guide.

What is the advantage of using hyper-threading for a dual processor?

The advantage of using hyper-threading with a dual processor is that i tdecreases the overal l CPU usage. The use of hyper-threading isrecommended i f you have a large number of users.

What is the disadvantage of using hyper-threading for a dual processor?

The disadvantage of using hyper-threading is that i t increases theIntel l igence Server execution time sl ightly. Therefore, for faster processing,





the use of hyper-threading is not recommended.

What is the largest Intelligent Cube size that I can store in an IntelligenceServer?

Intel l igent Cubes must be stored in Intel l igence Server memory for reportsto access their data. Whi le this can improve performance of these reports,loading too much data onto Intel l igence Server memory can have anegative impact on Intel l igence Server's abi l i ty to process jobs. For thisreason, i t is important to govern how much Intel l igent Cube data can bestored on the Intel l igence Server.

For information on governing Intel l igent Cube memory usage, loading, andstorage, see the System Administration Guide.

International SupportThe fol lowing table l ists the language selection possibi l i ties for di fferentinstal lation cases:

Installation Result

Fresh installat ion on a systemin which MicroStrategyapplicat ion has never beeninstalled before

The MicroStrategy Installat ion Wizard prompts you toselect the language from the drop-down list .

The user language in the product interface is thelanguage that you select during installat ion.

Repair or maintenanceinstallat ion on a system onwhich MicroStrategy applicat ionhas been installed before

All subsequent execut ions of the installat ion rout ine aredisplayed in the language that you selected the f irst t imeyou installed the product on the system.

The user language in the product interface is also thelanguage that you selected the f irst t ime you installed theproduct on the system.

Completely uninstall ing all theMicroStrategy products andinstall ing the same version or a

I f you uninstall al l the products and install either the sameversion or a higher version again, the MicroStrategyInstallat ion Wizard prompts you to select the language




Installation Result

newer version

from the drop-down list .

Note: Even if you select a language from the languageprompt in the installat ion rout ine, it has no ef fect on thedefault language of the product interfaces.

During installation, the installation Online Help is displayed in English only.

MicroStrategy Web and Intelligence Server CompatibilityYou must ensure the versions of MicroStrategy Web and Intel l igence Serverare compatible. For example, MicroStrategy Web 2020 can only connect toIntel l igence Server 2020 or later. For a complete l ist of compatibleMicroStrategy Web and Intel l igence Server versions, refer to theMicroStrategy Readme.

Refer to the MicroStrategy Readme for the complete MicroStrategy platformcompatibility and interoperability specification. In addition, you can contactMicroStrategy Technical Support for the latest information and updates.

Certified ODBC Drivers for MicroStrategy Intelligence ServerMicroStrategy certi fies ODBC drivers for Windows and Linux for Intel l igenceServer and di fferent DBMS types. MicroStrategy-branded ODBC drivers areinstal led with the MicroStrategy products.

For a complete l ist of certi fied and supported configurations with exactversion numbers, refer to the certi fied and supported configurations l isted inthe Readme.




Certificates Used During MicroStrategy Identity Installationand Configuration

Name Example file pathWherecertif icates areused

Purpose

MicroStrategyIdent ity ServerSSL/HTTPSCert if icate

/certs/HTTPSServerCert if icate.crt

(1) Within theMicroStrategyInstallat ionWizard, on thepage forMicroStrategyIdent ity, the f ieldlabeled "SSLServer Cert if icate"or "SSL Cert if icatef i le" .

(2) Within theMicroStrategyIdent ityConf igurat ion webinterface, on thef irst page, thef ield labeled"SAMLCert if icate" .

(1) SSLcert if icateused by theTomcat webservices.

(2) SAMLcert if icateprovided byMicroStrategyIdent ityManager.

MicroStrategyIdent ity ServerSSL/HTTPSCert if icatePrivate Key

/certs/HTTPSServerCert if icate.key

(1) Within theMicroStrategyInstallat ionWizard, on thepage forMicroStrategyIdent ity, the f ieldlabeled "SSLServer Cert if icateKey" or "Private

(1) SSL privatekey for thecert if icateused by theTomcat webservices.

(2) SSL privatekey for theSAML




Purpose

Key File" .

(2) Within theMicroStrategyIdent ityConf igurat ion webinterface, on thef irst page, the f ieldlabeled "SAMLKey".

cert if icateprovided byMicroStrategyIdent ityManager.

Thirdy-PartyCert if icateAuthority RootCert if icate

/certs/ca-root .crt

Prior to runningthe MicroStrategyInstallat ionWizard, include itin theMicroStrategyIdent ity ServerCert if icateAuthority Chain(see below).

SSL cert if icaterepresent ingthe Cert if icateAuthority thatsigned theMicroStrategyIdent ity ServerSSL/HTTPSCert if icate.Each CA has 1rootcert if icate.

Third-PartyCert if icateAuthorityIntermediateCert if icate

/certs/ca-intermediate.crt

Prior to runningthe MicroStrategyInstallat ionWizard, include itin theMicroStrategyIdent ity ServerCert if icateAuthority Chain(see below).

SSL cert if icaterepresent ingthe Cert if icateAuthority thatsigned theMicroStrategyIdent ity ServerSSL/HTTPSCert if icate.Each CA may




Purpose

have 1 or moreintermediatecert if icates.

MicroStrategyIdent ity ServerSigningCert if icateAuthorityCert if icate

/certs/ushersigningca.crt

Within theMicroStrategyIdent ityConf igurat ion webinterface, on thef irst page, thef ield labeled "SSLCert if icateAuthorityCert if icate" .

SSL cert if icateused by theMicroStrategyIdent ity Serverto sign anyCert if icateSigningRequest(MicroStrategyBadge,DirectoryAgent , Ident itySDK-basedapps, VPNAgent , etc. )

MicroStrategyIdent ity ServerSigningCert if icateAuthorityPrivate Key

/certs/ushersigningca.key

Within theMicroStrategyIdent ityConf igurat ion webinterface, on thef irst page, the f ieldlabeled "SSLCert if icateAuthority Key".

SSL privatekey for theMicroStrategyIdent ity ServerSigning CA.

MicroStrategyIdent ity ServerCert if icateAuthorityChain

/certs/UsherCAChain.pem

Within theMicroStrategyInstallat ionWizard, on thepage for

Cert if icatestore thatincludes all ofthe Cert if icateAuthority




Purpose

MicroStrategyIdent ity, the f ieldlabeled "CACert if icate Chain"or "SSL Cert if icateChain f i le" .

cert if icatesthat theTomcat webservices wil lt rust . Includesthe third-partyCA andMicroStrategyIdent ity ServerSigning CA.

This table does not include f i les used for MicroStrategy Ident ity components deployedoutside of the MicroStrategy Ident ity Server, such as the Directory Agent , Physical AccessAdapters, and third-party Web/Mobile applicat ions implement ing Ident ity APIs.

Recommended System Settings for LinuxLinux systems al low processes and appl ications to run in a virtualenvironment. This means that each process, depending on i ts owner andthe settings for certain environment variables, are run using a distinct set ofproperties that affect how much memory the process can use, how manyCPU seconds i t can use, what thread model i t can use, how many fi les i tcan open, and so on.

MicroStrategy Intel l igence Server instal ls on Linux systems with therequired environment variables set to ensure that the server's jobs areprocessed correctly. However, as mentioned above, some settings arerelated to the user who starts the process (also known as the owner of theprocess) and other settings can only be set by the system administrator.Some of these settings may also have l imi ts enforced for reasons unrelatedto supporting MicroStrategy.



The table below l ists MicroStrategy's recommendations for system settingsthat can affect the behavior of Intel l igence Server.

Modify ing the system settings lis ted below can affect system-wide behaviorand therefore, steps to modify these values are not given. You should refer toyour Linux documentation and contact your system administrator to modifythese settings.

Setting Name

ulimit name (limitname)

Description Recommended Value

cputime

(time)

MaximumCPUseconds perprocess

Unlimited

filesize

(file)

Maximumsize for asingle f i le

Unlimited, or as large as the f i le system allows. Yoursystem administ rator may enforce limits on the maximumsize of f i les for reasons unrelated to MicroStrategy. Thisvalue must be at least as large as the maximum size forcore dump f i les (coredumpsize).

datasize

(data)

Maximumheap sizeper process

Unlimited, or as large as the system virtual memoryallows. Your system's virtual memory constraints af fectthe data size you can set for a process's heap size. Thevalue should be the same as the maximum size for coredump f i les (coredumpsize).

stacksize

(stack)

Maximumstack sizeper process

200 MB

coredumpsize

(coredump)

Maximumsize for asingle coredump f i le

Set this value to the same value as the maximum heapsize per process (datasize). I f core dump f i les arecreated that are larger than this value, the f i les arecorrupted and unusable.

memoryuse Maximum Unlimited, or as large as the physical memory of your



Setting Name

ulimit name (limitname)

Description Recommended Value

(memory)

size ofphysicalmemoryallot ted perprocess

system allows

vmemoryuse

(vmemory)

Maximumsize ofvirtualmemoryallowed perprocess

Unlimited, or as large as your system virtual memoryallows

descriptors

(nofiles)

Maximumnumber off i ledescriptors(open f i les)per process

8192

processes

(per user)

Maximumnumber ofprocessesper user

8194

This set t ing is a general guideline that has beenobserved to work well on mult iple installs. However,depending on the specif ic environment, this set t ingmay need to be ref ined.

Methods of Installation

The methods of MicroStrategy instal lation are:

Command LineIn command l ine mode, you type the appropriate information at the promptand press Enter. Instructions are included on each page of the



MicroStrategy Instal lation Wizard.

In some cases, you are asked to make a selection by pressing 1 or 2, andEnter. You then press 0 and Enter to continue.

Defaul ts appear next to each prompt and are enclosed in square brackets,for example, [1]. Cl ick Enter to use the defaul t, or type a di fferent responseto the prompt to override the defaul t.

In addi tion, on the command l ine wizard pages, the fol lowing options areavai lable:

l Press 1 and then cl ick Enter to proceed to the next page.

l Press 2 and then cl ick Enter to return to the previous page.

l Press 3 and then cl ick Enter to cancel the instal lation and close theMicroStrategy Instal lation Wizard.

l On the last page, which is MicroStrategy Instal lation Wizard Complete,press 3 and then cl ick Enter to complete the setup and close the wizard.

For information on command l ine instal lation, refer to Chapter 3, Instal l ingMicroStrategy on Linux.

Silent InstallationA si lent, or unattended, instal lation is one that presents no graphical userinterface (GUI). Si lent instal lations are useful for system administrators whodo not want users to run the instal lation themselves. It al lows you toautomate the instal lation, so i t can be cal led from a script and executedwithout user interaction.

For information on si lent instal lation, refer to Si lent Instal lation, page 612 inChapter 9, Automated Instal lation on Windows and Si lent Instal lation, page621 in Chapter 10, Automated Instal lation on Linux.



Creating Custom Installation PackagesYou can reduce the amount of data that has to be downloaded for aninstal lation by providing only the fi les required to complete a MicroStrategyinstal lation. This technique can then be used to reduce the amount of datapackaged and downloaded for other MicroStrategy instal lations within yourorganization.

The steps below show you how to create these custom instal lationpackages.

Create a Custom MicroStrategy Installation Package

1. Retrieve the MicroStrategy instal lation fi les from the instal lation diskor the MicroStrategy download si te. Save these fi les to a folder.Contact your MicroStrategy sales representative to determine thelocation and login credentials for the MicroStrategy download si te.

2. Within the location where you saved the MicroStrategy instal lationfi les, browse to the DataFiles folder.

3. You can determine the required instal lation fi les in the fol lowing ways:

l For Windows instal lations, you can use the MicroStrategyInstal lation Wizard to determine the required fi les, as described inDetermine the required instal lation fi les for Windows instal lation,page 133.

l For Linux instal lations, the table below l ists which instal lation fi lesare required for each MicroStrategy component. Once you determinethe required instal lation fi les, you can include them in your custominstal lation as described in Speci fy the location of the instal lationfi les, page 134 below.



Installation FileMicroStrategy Components That Require TheInstallation File

mstr1.mcf All MicroStrategy components and products

mstr3.mcf MicroStrategy Intell igence Server and all of its components

mstr4.mcfMicroStrategy Web, including Web Analyst , Web Reporter,and Web Professional

mstr5.mcf MicroStrategy Web Services for Off ice

mstr6.mcf MicroStrategy Command Manager

mstr7.mcf MicroStrategy Integrity Manager

mstr8.mcf MicroStrategy System Manager

mstr9.mcf MicroStrategy Mobile Client

mstr10.mcf MicroStrategy Mobile Server

mstr11.mcfMicroStrategy Port lets, which is a component of MicroStrategyWeb

mstr12.mcfMicroStrategy GIS Connectors, which is a component ofMicroStrategy Web

mstr13.mcf All MicroStrategy components and products

mstr14.mcf MicroStrategy Enterprise Manager

mstr15.mcf MicroStrategy MicroStrategy Ident ity Server

mstr16.mcf MicroStrategy MicroStrategy Ident ity Manager

mstr18.mcf MicroStrategy MicroStrategy Communicator

mstr20.mcf MicroStrategy Messaging Services

mstr21.mcf MicroStrategy Library Web & Mobile

mstr22.mcf MicroStrategy Collaborat ion Server




mstr25.mcfNode. js which is installed with Intell igence Server andCollaborat ion Server

mstr26.mcf Applicat ion Schema Server (Early Adopter)

mstr27.mcf Redis which is installed with MicroStrategy Plat form Analyt ics

mstr28.mcf MicroStrategy Plat form Analyt ics

mstr29.mcf Common Files

mstr30.mcf Community Connectors

mstr31.mcf Cert if icate Manager

mstr32.mcf MicroStrategy Export

mstr35.mcf MicroStrategy Modeling Service

mstr36.mcf MicroStrategy Repository

Determine the required installation files for Windows installation

1. Move al l of the compressed .mstr fi les wi thin this folder to a di fferentfolder location.

2. Use the MicroStrategy Instal lation Wizard to begin a MicroStrategyinstal lation. For steps to locate and use the MicroStrategy Instal lationWizard, see Chapter 2, Instal l ing MicroStrategy on Windows.

3. Complete the steps up to and including the step to select theMicroStrategy components to be instal led.

4. After selecting the MicroStrategy components to be instal led andcl icking Next, a message is displayed that l ists the requiredinstal lation fi les. Store al l of these fi les in a location that can beaccessed by the machine that wi l l use the custom instal lation package.

5. Cl ick Cancel.



Specify the location of the installation files

When performing the instal lation, you can speci fy the location of these fi lesas fol lows:

l For Windows instal lation, you can speci fy the location of these fi les usinga response.ini fi le, as described in Instal lation Fi les.

l For Linux instal lation, you can speci fy the location of these fi les using anoptions.txt fi le, as described in Providing instal lation fi les for smal lerinstal lations.

Related Topics

Instal lation Fi les, page 579

Instal l on Demand Options, page 668

Licensing Information

If you have instal led the Evaluation version of MicroStrategy, you cannotuse i ts l icense key with a General ly Avai lable (GA) l icense key in the sameenvironment. Hence, the Evaluation version of MicroStrategy cannot beused for your production environment.

Types of LicensesRefer to your MicroStrategy contract and any accompanying contractdocumentation for descriptions of the di fferent MicroStrategy l icense types.

If you receive access to MicroStrategy Identi ty functional i ty as part ofMicroStrategy analytics software products, ei ther by purchasing l icenses tosuch software products or receiving such software products as part of amaintenance upgrade, your use of this product is restricted to use solely forthe purpose of authentication in conjunction with MicroStrategy analyticssoftware products.


https://www2.microstrategy.com/producthelp/Current/InstallConfig/en-us/Content/Configuring_a_response_ini_file_to_install_MicroSt.htm#ic_advinstallwin_3307235427_1107652

https://www2.microstrategy.com/producthelp/Current/InstallConfig/en-us/Content/Parameters_for_a_silent_installation.htm#ic_advinstallunix_1467027111_1086054

https://www2.microstrategy.com/producthelp/Current/InstallConfig/en-us/Content/Parameters_for_a_silent_installation.htm#ic_advinstallunix_1467027111_1086054


Installation and Configuration Checklists

This guide provides information on how to instal l and configureMicroStrategy products on Windows and Linux. To help you navigatethrough this guide, the fol lowing sections in this chapter l ist the chaptersthat you should refer to depending on the platform on which you areinstal l ing MicroStrategy products. Each l ist also provides a brief overviewof each chapter. It is recommended that you read this section beforeperforming an instal lation. You can use the tables as checkl ists ofinstal lation and configuration tasks to be completed.

The appendixes in this guide are not lis ted in the checklis ts. The checklis tsonly cover the main steps to install and configure MicroStrategy products. Theappendixes in this guide contain important configuration details that are usefulthroughout the life cycle of your MicroStrategy installation.

Installing and Configuring MicroStrategy on WindowsIf you are instal l ing MicroStrategy on Windows, you should refer to thefol lowing sections sequential ly.

l Chapter 1, Planning Your Instal lation: Review this chapter for importantinstal lation prerequisi tes and considerations.

l Chapter 2, Instal l ing MicroStrategy on Windows: This chapter describesthe procedures for instal l ing the MicroStrategy products necessary to runyour business intel l igence appl ication in a Windows environment.

Or

l Chapter 9, Automated Instal lation on Windows: As an al ternative to theregular instal lation, you can perform a ful ly automated and unattendedinstal lation including customization routines avai lable wi th the product.This chapter describes di fferent types of unattended and automatedinstal lations and provides steps to perform these instal lations on



Windows.

Addi tional ly, Chapter 11, Deploying OEM Appl ications explains thecommon workflow for deploying the MicroStrategy platform as an OriginalEquipment Manufacturer (OEM) appl ication.

l Chapter 5, Activating Your Instal lation: After instal l ing MicroStrategyproducts, you have 30 days to activate your software instal lation. If youhave not activated your software after 30 days, some MicroStrategyfeatures may become unavai lable unti l you complete the softwareactivation.

l Chapter 6, Configuring and Connecting Intel l igence Server: Afterinstal l ing and activating MicroStrategy products, you must use theMicroStrategy Configuration Wizard to configure the MicroStrategymetadata reposi tory, statistics tables, history l ist tables, Intel l igenceServer, and project sources. This chapter describes the steps used toconfigure an instal led MicroStrategy sui te of products using theMicroStrategy Configuration Wizard.

l Chapter 7, Deploying MicroStrategy Web and Mobi le Server: You candeploy your project to your user community using MicroStrategy Web.This chapter provides information on how to deploy and configureMicroStrategy Web on Windows and Linux platforms with various Weband appl ication servers.

l Chapter 13, Adding or Removing MicroStrategy Components: Thischapter describes the steps to add and remove MicroStrategy componentson Windows, as wel l as other operating systems. For Windows platforms,refer to the fol lowing sections:

l Adding or Removing MicroStrategy Components on Windows, page 724.

l Re-instal l ing MicroStrategy components on Windows, page 725.

l Uninstal l ing MicroStrategy Components on Windows, page 727.



Installing and Configuring MicroStrategy on LinuxIf you are instal l ing MicroStrategy on Linux operating systems, you shouldrefer to the fol lowing sections sequential ly.

l Chapter 1, Planning Your Instal lation: Review this chapter for importantinstal lation prerequisi tes and considerations.

l Chapter 3, Instal l ing MicroStrategy on Linux: This chapter describes theprocedures for instal l ing the MicroStrategy products necessary to run yourbusiness intel l igence appl ication on a Linux environment.

Or

l Chapter 10, Automated Instal lation on Linux: As an al ternative, you canperform a ful ly automated and unattended instal lation without using thegraphical user interface. This chapter describes di fferent types ofunattended and automated instal lations and steps to perform theseinstal lations on Linux.


l Chapter 5, Activating Your Instal lation: After instal l ing MicroStrategyproducts, you have 30 days to activate your software instal lation. If youhave not activated your software after these 30 days have passed, someMicroStrategy features may become unavai lable unti l you complete thesoftware activation.

l Chapter 6, Configuring and Connecting Intel l igence Server: Afterinstal l ing and activating MicroStrategy products, you must use theMicroStrategy Configuration Wizard to configure the MicroStrategymetadata reposi tory, statistics tables, history l ist tables, Intel l igenceServer, and project sources. This chapter addresses the processesnecessary to configure an instal led MicroStrategy sui te of products using



the Configuration Wizard. If no project sources are defined, then theConfiguration Wizard opens.

Or

l Chapter 12, Configuring MicroStrategy Using Command Line Tools:MicroStrategy tools are provided in command l ine mode on Linux so thatyou can perform various configuration tasks through the operating systemconsole. This enables you to perform your required configurations even i fyou do not have access to the MicroStrategy interface.

l Chapter 7, Deploying MicroStrategy Web and Mobi le Server: You candeploy your project to your user community using MicroStrategy Web.This chapter provides information on how to deploy and configureMicroStrategy Web and Web Universal on Windows and Linux platformswith various Web and appl ication servers.

l Chapter 8, Setting Up Documents and HTML Documents: This chapterexplains the setup required for the Intel l igence Server to create andexecute HTML documents and documents. It also describes the steps tocreate this setup, which are only necessary on a Linux environment.

l Chapter 13, Adding or Removing MicroStrategy Components: Thischapter describes the steps to add and remove MicroStrategy componentson al l supported operating systems. For Linux platforms, refer to thefol lowing section:

l Uninstal l ing MicroStrategy components on Linux



INSTALLINGM ICROSTRATEGY ONW INDOWS



This section describes the procedures for instal l ing the MicroStrategyproducts that are necessary to run your business intel l igence appl ication ona Windows environment.

Before instal l ing MicroStrategy products, see Chapter 1, Planning YourInstal lation for important pre-instal lation information.

Some MicroStrategy products are avai lable in two versions, as describedbelow.

l Windows only: The Windows only versions, labeled as MicroStrategyIntel l igence Server, MicroStrategy Web (ASP.NET), and so on, arecompatible only wi th a Windows platform. With these versions,MicroStrategy Web can be deployed quickly and easi ly usingMicroStrategy's Internet Information Services (IIS) Web Server. Thedrawback is that IIS is the only Web server that can be used to deploy theWindows only version of MicroStrategy Web.

l Universal (platform independent): The universal versions, labeled asMicroStrategy Intel l igence Server, MicroStrategy Web (JSP), and so on,are compatible wi th Windows as wel l as Linux platforms. Instal l ing theuniversal versions on Windows lets you deploy MicroStrategy Web withdi fferent appl ication and Web server combinations. For example, insteadof using IIS to deploy MicroStrategy Web, you can use Apache Tomcat,Oracle 10g, and so on.

If you have used the Evaluation Edition of the MicroStrategy platform, youmay have installed most of these products already. However, additionalconsiderations are important when you are setting up a production businessintelligence system as opposed to running the evaluation software. Youshould read this chapter carefully , even if you already have a workingsystem from your Evaluation Edition.

This section has the fol lowing information:

Instal lation Procedure in Windows 141





Installation Procedure in Windows

The MicroStrategy Instal lation Wizard guides you through instal l ing one ormore MicroStrategy products in a Windows environment. The fol lowingsections can assist you in instal l ing MicroStrategy products:

l Instal l ing with the MicroStrategy Instal lation Wizard for Windows, page142

l Instal lation Veri fication, page 164

There are instal lation al ternatives and procedures to support yourMicroStrategy instal lation documented in this guide, including the fol lowing:

l Prerequisi tes, see Instal lation Prerequisi tes, page 92 in Chapter 1,Planning Your Instal lation.

l Advanced instal lation functional i ty, such as instal l ing in an SMSenvironment or using instal lation response fi les, see Chapter 9,Automated Instal lation on Windows.

l Instal l ing and deploying MicroStrategy Web with other Web andappl ication servers, see Chapter 7, Deploying MicroStrategy Web andMobi le Server.

l Deploying MicroStrategy Web Services ASP.NET and J2EE, see Enabl ingSingle Sign-On with SAML Authentication in System AdministrationGuide.

l Prerequisi tes and procedures for MicroStrategy Identi ty, seeMicroStrategy Identi ty Pre-Instal lation Instructions.

l If you have not uninstalled previous versions of MicroStrategy products, you





are prompted to overwrite them. Click Yes to ensure that all products areinstalled properly. To retain the existing Tutorial metadata repository andwarehouse, rename it or move it to another location before you start theinstallation process.

l Although MicroStrategy supports Windows Terminal Services, usingWindows Terminal Services is not recommended for installation. It canaffect the functionality of some MicroStrategy components.

Installing with the MicroStrategy Installation Wizard forWindowsTo instal l MicroStrategy products, you must log on to your machine using adomain account wi th Windows administrative privi leges for the domain ortarget machine. The domain must include your database servers.

To exi t the instal lation process at any time, cl ick Cancel.

To access the MicroStrategy Installation Wizard

1. Log on to the machine where you are instal l ing one or moreMicroStrategy products.

2. Exi t al l Windows appl ications before beginning the instal lationprocess.

3. Download the fi les from the MicroStrategy download si te. Locate andrun the Setup.exe fi le. Be aware of the fol lowing:

l Contact your MicroStrategy sales representative to determine thelocation and login credentials for the MicroStrategy download si te.

l You need to extract the downloaded fi les to locate the Setup.exe

fi le. When extracting the fi les, ensure that the extraction softwaremaintains the folder structure of the compressed fi les. Mostextraction software maintains the folder structure by defaul t, but i fyou use WinRAR, ensure that you select the Extract ful l paths option.



l To review an al ternative, guided introduction to instal l ingMicroStrategy software, you can locate and run theMICROSTRATEGY.exe fi le. For information on this instal lational ternative, see Instal l ing with a Guided MicroStrategy Introduction,page 165.

l You can reduce the amount of data that has to be downloaded for theinstal lation by excluding al l of the .zip fi les, located in theInstallations/DataFiles folder, from the download. You canuse this technique to download only the fi les required to completeyour MicroStrategy instal lation, which can then also be used toreduce the amount of data packaged and downloaded for otherMicroStrategy instal lations. For steps to create these custominstal lation packages, see Creating Custom Instal lation Packages,page 131. Detai ls on using a response.ini fi le to provide thelocation of the instal lation fi les are provided in Chapter 9, AutomatedInstal lation on Windows and the parameters used to speci fy thelocation of the required instal lation fi les are described in Instal lationFi les, page 579.

4. If this is the fi rst time you have instal led MicroStrategy, you areprompted to choose the language for the wizard. Select the appropriatelanguage from the drop-down l ist and cl ick OK .

The MicroStrategy Instal lation Wizard opens and guides you through therest of the instal lation process. The sections below describe the actions youmust take for each page in the wizard. After you enter al l requiredinformation on an instal lation page, cl ick Next to proceed to the next pageof the instal lation routine.

If any services are running for previously instal led MicroStrategy products,you are prompted to stop them. Cl ick Yes to proceed. If you cl ick No , youcannot instal l MicroStrategy products unti l you stop al l MicroStrategyservices.



Welcome

If you opened the MicroStrategy Instal lation Wizard through the MicrosoftControl Panel using the Add/Remove Programs option, the wizard opensthe Welcome page in maintenance mode. For more information onmodi fying, repairing, or removing al l or part of your MicroStrategyinstal lation, see Chapter 13, Adding or Removing MicroStrategyComponents.

License Agreement

Read the l icense agreement, and accept or decl ine the agreement bycl icking the appropriate button. If you decl ine, you cannot instal lMicroStrategy products.

Click Print to print a copy of the license agreement for your records.

Customer Information

Enter the fol lowing customer information:

l User

l Company

l License Key

To request a license key, go to the license key generator in the MicroStrategyDownload Site , contact your MicroStrategy Representative or contactMicroStrategy Technical Support.

Install Options

Select one of the fol lowing instal l options:


https://software.microstrategy.com/


mailto:[email protected]


l To instal l the enti re platform on a single node environment, cl ickExpress. After instal l ing the complete platform, you wi l l haveMicroStrategy Analytics, Mobi l i ty, and Securi ty instal led on your Windowsserver, as wel l as the required thi rd-party software l ibraries.

For steps to use the Express instal lation, see Performing a MicroStrategyExpress instal lation.

l To instal l on an environment wi th multiple servers, or to select whichMicroStrategy products to instal l , cl ick Custom, and continue with theInstal lation Wizard.

Choose Destination Location

Browse to the locations where the MicroStrategy products andMicroStrategy common fi les are to be instal led:

l MicroStrategy Destination Folder: Browse to and select the locationwhere MicroStrategy products are instal led. This is where executablefi les and other support fi les are instal led for your l icensed MicroStrategyproducts.

Whi le this setting determines the defaul t root di rectory for theMicroStrategy products you instal l , you can change the destination of anindividual product later as part of selecting which MicroStrategy productsto instal l .

You can choose the directory for a product only i f that product is notal ready instal led on the server machine. Otherwise, the product can onlybe instal led in the same directory in which i t al ready exists.

l MicroStrategy Common Files Destination Folder: Browse to and selectthe location where MicroStrategy common fi les are instal led. These fi lesare required to support a MicroStrategy instal lation.



Select Features

Select the check box of a MicroStrategy product to include that product inthe instal lation. Al ternatively, you can clear a check box to uninstal l orexclude a MicroStrategy product from the instal lation.

The instal lation pages you see after this step depend on the products youchoose to instal l . These instructions describe al l possible pages.

If you are installing MicroStrategy Communicator, components ofMicroStrategy Intelligent Enterprise are also installed.

If you previously installed Community Connectors in 11.0 and are installing anewer version of MicroStrategy, your whitelis t.tx t file will be overwritten.

To use your 11.0 whitelis t.tx t file in a newer version of MicroStrategy, backupthe whitelis t.tx t file located in<installPath>\Tomcat\CommunityConnectors\WEB-INF

before performing the upgrade install. After the installation, replace the newwhitelis t.tx t with the backed up whitelis t.tx t file from 11.0.

Many of the platform components have subcomponents. If you expand thedi fferent MicroStrategy products, you can select the appropriate checkboxes to speci fy the subcomponents to instal l . For information onMicroStrategy components and subcomponents, see Hover over the iconsbelow to see the information related to instal l ing each part of theIntel l igence Platform archi tecture. , page 11 in Chapter 1, Planning YourInstal lation.

You can see only MicroStrategy products that are available with your licensekey.

Destination Folder

You can select MicroStrategy products and their subcomponents to definetheir instal lation locations. When you select a MicroStrategy product orsubcomponent, the Destination Folder area near the bottom of the interface


https://www2.microstrategy.com/producthelp/current/WebAdmin/WebHelp/Lang_1033/Content/MicroStrategy_Community_Data.htm


displays the current instal lation folder for the product. Cl ick Browse toselect a di fferent instal lation folder.

If you select a MicroStrategy product or subcomponent and the Browsebutton is not accessible, this means that the instal lation location cannot bechanged. For example, i f you select MicroStrategy Mobi le you cannot definean instal lation location. However, i f you expand this product, you can definethe instal lation location for i ts subcomponents.

MicroStrategy Setup and Choose Data Files Location

You see the MicroStrategy Setup dialog box and the Choose data fi leslocation page only i f some of the fi les, required to instal l the MicroStrategycomponents you have selected for instal lation, are not avai lable. If you areusing this technique to reduce the amount of data that has to bedownloaded for the instal lation, i t is recommended that you do thefol lowing:

l Review the fi les l isted in the MicroStrategy Setup dialog box, and make anote of al l the required fi les. These fi les need to be provided as part ofthe instal lation for the MicroStrategy components you selected using theSelect Features page of the instal lation (see Select Features, page 146).

l Provide the location of the instal lation fi les using a response.ini fi le.This lets you access the instal lation fi les stored on a folder or stored at aURL and accessed using HTTP or HTTPS. Detai ls on using aresponse.ini fi le as part of an instal lation are provided in Chapter 9,Automated Instal lation on Windows and the parameters used to speci fythe location of the required instal lation fi les are described in Instal lationFi les, page 579.

If the fi les required for the instal lation are stored in a folder, you caninstead cl ick Change on this Choose data fi les location page to navigateto and select the folder that stores the instal lation fi les. If al l the requiredinstal lation fi les are provided in the folder you select, you can cl ick Nextto continue the MicroStrategy instal lation.



Topology Configuration

Topology al lows administrators to moni tor MicroStrategy Services andmanage them in MicroStrategy Workstation. The fol lowing functional i ty issupported:

l Service Health Monitor

The administrator can moni tor MicroStrategy services through Workstationand visual ize i f they are running or stopped.

l Service Start/Stop

The administrator can start or stop MicroStrategy services throughWorkstation. This functional i ty is currently l imi ted to SSH authenticationwith username and password.

See the topic, How to View Environment Topology and Moni tor Services inthe Workstation Onl ine Help for more information about using topologywithin Workstation.

The two fol lowing types of l ightweight agents are used to moni tor servicesin Workstation:

l Monitoring Agents

The moni toring agents come with the instal lation of most MicroStrategyservices. Use them to moni tor services and view their heal th status.

l Communication Agents:

Some monitoring agents also act as communication agents. In addi tion tomoni toring services, communication agents help other moni toring agentslocate each other and gather moni toring information. The administratormust pick at least one agent to act as a communication agent, so al l otheragents can locate each other through this agent.

On environments where three or more machines host MicroStrategyServices, i t is recommended that you choose at least threecommunication agents to provide redundancy and improved rel iabi l i ty, in




case one communication agent becomes unavai lable. The machineschosen to act as communication agents must be machines that hostMicroStrategy Services, such as Intel l igence Server or MicroStrategyLibrary. If you decide to use only one communication agent, i t isrecommended that you choose the machine that houses MicroStrategyLibrary (i f deployed through the MicroStrategy instal lation), since Librarycommunicates directly wi th Workstation.

If your Library deployment is done through a WAR fi le or i f you do not usea machine that houses MicroStrategy Library to host the communicationagent, then use a machine that houses Intel l igence Server.

MicroStrategy uses Consul technology for Services Registration. Amonitoring agent corresponds to a Consul agent in client mode. Acommunication agent corresponds to a Consul agent in server mode.


https://www.consul.io/docs/agent/basics.html


1. On the Topology Configuration dialog of the Instal lation wizard, selectwhether your environment has Single or Multiple machines.

2. If your environment contains multiple machines, determine whichmachines in your environment you want to act as communicationagents. Among al l the machines in your environment that wi l l hostMicroStrategy Services, select at least one of them (three arerecommended for mul tiple machine environments) to act as acommunication agent. Enter each machine in the text field, separated



by semicolons. You must input the exact same l ist on al l machines,using the Topology Configuration dialog of the Instal lation wizard,including the moni toring and communication agent machines.

The MicroStrategy Services are as fol lows:

l MicroStrategy Intel l igence Server

l MicroStrategy Web Universal

l MicroStrategy Library

l MicroStrategy Mobi le


l MicroStrategy Platform Analytics

l MicroStrategy Certi ficate Store

l MicroStrategy Identi ty

An odd number of communication agents is required due to the leadershipselection algorithm.

Examples:

servername1.domain.com;servername2.domain.com;servername3.domain.com;

servername1.domain.com;

Example: Your environment contains the fol lowing two machines andyou select one machine to host the communication agent:

l Machine 1 hosts MicroStrategy Library and the communication agent

l Machine 2 hosts the Intel l igence Server

When performing the instal lation, enter the ful l domain name,machine1.domain.com, on both machines.



Example: Your environment contains the fol lowing three machines andyou want al l machines to host a communication agent:

l Machine 1 hosts MicroStrategy Library

l Machine 2 hosts Intel l igence Server 1


When performing the instal lation, entermachine1.domain.com;machine2.domain.com;machine3.domain.com; on al l three machines.

Example: Your environment contains the fol lowing five machines andyou select three machines to host the communication agents:


l Machine 2 hosts Intel l igence Server 1 and a communication agent



l Machine 5 hosts Intel l igence Server or other services

Entermachine1.domain.com;machine2.domain.com;machine3.domain.com; on al l machines.

Some important information to keep in mind:

l In MicroStrategy 2019, OpenSSH is no longer instal led on Windowsmachines. You must instal l Open SSH to start and stop services usingtopology. Upgrading your system from 11.0 to 2019 removes Open SSH.

If consul is al ready instal led on a machine, prior to instal l ingMicroStrategy products, the service registration auto configuration andexecution is affected. We do not recommend a separate consulinstal lation on the same machine.



l If you select Multiple machine environment, you must enter an oddnumber of machines.

l If your environment includes more than one machine and machines withdynamic IP addresses as communication agents, use FQDN for thecommunication agent machine l ist during the instal lation.

l If your environment includes more than one machine and machines withmore than one IP address as communication agents, i t is recommendedthat you use FQDN for the communication agent machine l ist during theinstal lation. If IP address l ist is used, make sure the machine withmultiple IP addresses can be pinged with an IP address included in thel ist.

Topology supports installation on machines with public IP addresses. Toavoid unexpected joins to topology nodes, possibly exposing serviceinformation, you must configure your firewall correctly. Your firewall shouldallows ports for Server RPC (default 8300), and Serf LAN (default 8301), andSerf WAN (default 8302) only for the nodes within the Workstation topologynode cluster. See Enabl ing Topology Communication Through aFirewal l for more information.

After instal l ing the topology feature, see Instal l ing and ConfiguringTopology for addi tional instructions on configuring this feature to work inyour environment.

MicroStrategy Identity Configuration

You see this page i f you have selected to instal l MicroStrategy Identi ty. Ifyou do not have al l the information and want to configure this product later,cl ick Skip to proceed with the instal lation.

l SSL Certificate Authority Certificate: The fi le that contains the trustedRoot CA, Intermediate Root CA bundle (.pem). It must be the completecerti ficate chain for your SSL Server Certi ficate that you obtained from



your IT Administrator.

l SSL Server Certificate: The server certi ficate (.crt) fi le for your Windowsserver.

l SSL Server Certificate Key: The key for your SSL server certi ficate(.key) fi le.

l SSL Certificate Authority Key File Password : If your CA-signedcerti ficate has a password, create a text fi le containing this password andenter the text fi le location.

To ensure that the SSL certificates are valid for your installation, you can runthe following checks:

The results for the following two commands should be identical.

openssl.exe x509 -noout -modulus -in sample.crt |

openssl.exe md5

openssl.exe rsa -noout -modulus -in sample.key |

openssl.exe md5

No error is produced when the command openssl.exe verify -

partial_chain -CAfile sample.pem sample.crt isexecuted.

l SMTP Server: Your company's SMTP server, fol lowed by the port numberin the next box.

l SMTP Authentication : If your server is password protected, then enterthe username and password for the server.

l Email Sender Address: The emai l address that is authorized to sendemai ls from your SMTP server, and wi l l be used to send badge invi tationsfor your MicroStrategy Identi ty network.

l Host Name: Enter the Ful ly Qual i fied Domain Name you are using, forexample, yourFQDN.com .



Messaging Services Cluster Configuration

If Intel l igence Server or Platform Analytics are chosen for instal lation, theoption to configure a Messaging Services cluster is presented.

If no cluster needs to be configured, cl ick Next.

To configure a cluster:

1. Select the I need to create a Messaging Services cluster forPlatform Analytics check box.

2. Local Node: Provide the address for the local node.

3. Remote Nodes: Provide a comma separated l ist of hostnames forremote nodes in the cluster. The node id is determined by alphabeticalorder in node l ist.

For detai led configuration information see, MicroStrategy MessagingServices

Server Activation

If you have instal led one or more MicroStrategy server products, you canrequest an Activation Code to activate your MicroStrategy server productsupon completion of the instal lation process. The next few pages of theinstal lation process guide you in providing the information you must submitto MicroStrategy to request an Activation Code. MicroStrategy serverproducts include:


l MicroStrategy Web

l MicroStrategy Mobi le Server

This page includes a welcome statement for the software activationprocess. Read the welcome statement and cl ick Next to proceed.



Server Information

Speci fy information about your MicroStrategy server instal lation. Enter thefol lowing characteristics:

l Name: Distinguishes the name of this MicroStrategy server productinstal lation from any other MicroStrategy server product instal lations inyour company.

l Location : Physical location of the machine on which MicroStrategy serverproducts are instal led.

l Use: Description of how the server is used.

Click Privacy Statement to view the MicroStrategy Privacy Statement.

Installer Information

Speci fy contact information of the person instal l ing the software. After yourinstal lation is complete an emai l containing the Activation Code is sent tothe emai l address you confi rm in this software activation step. Enter thefol lowing instal ler information:

l Speci fy whether you are an employee of the l icensed company orinstal l ing on behal f of the l icensed company.

l Enter the necessary data into al l text fields. Make sure the emai l addressyou enter is correct. This emai l address is the recipient of the ActivationCode.

l Select the check box at the bottom of the page to receive notifications aboutproduct updates, events, and special offers from MicroStrategy.

l Click Privacy Statement to view the MicroStrategy Privacy Statement.

Contact Information

You see this page i f you indicated that you are not an employee of thecompany l icensed to use this software, and are instal l ing the software on



behal f of that company.

Speci fy contact information for the employee l icense to use the software.Enter the necessary data into al l text fields. Make sure the emai l addressyou enter is correct. After your instal lation is complete an emai l containingthe Activation Code is sent to the emai l address you confi rm in this softwareactivation step.

l Select the check box at the bottom of the page to receive notifications aboutproduct updates, events, and special offers from MicroStrategy.


Request Activation Code

This page includes options to request an Activation Code now or at a latertime. This page provides the fol lowing options:

l Select Yes, I want to request an Activation Code and cl ick Next torequest an Activation Code. The Activation Code is sent to the emai laddresses suppl ied in the Instal ler Information and Contact Informationpages.

l Select No, I will request the Activation Code at a later time and cl ickNext to request an Activation Code at a later time.

If you choose to request an Activation Code at a later time, a message isdisplayed that instructs you how to request an Activation Code after theinstal lation procedure is completed. For more instructions on requestingan Activation Code at a later time, see Request an Activation Code,page 356 in Chapter 5, Activating Your Instal lation.

You have a grace period of 30 calendar days to activate your instal lation. Ifyou do not complete the activation before the grace period expires, yourMicroStrategy product stops functioning unti l you activate i t. If you wai t toactivate your instal lation, you receive periodic reminders.



Once you request an Activation Code, an emai l is sent to the emai laddresses you speci fy in the Instal ler Information and Contact Informationpages of the software activation procedure. The emai l provides instructionson how to use the requested Activation Code to activate your software. Toactivate your instal lation, you can also use the steps given in Activate YourInstal lation, page 358 in Chapter 5, Activating Your Instal lation.

CPU License Information

MicroStrategy Web (ASP.NET) Setting

You see this page only i f you choose to instal l MicroStrategy Web(ASP.NET) and only i f you do not have a previous version of MicroStrategyWeb instal led.

Speci fy the Internet Information Services (IIS) vi rtual di rectory to be createdfor MicroStrategy Web pages. The defaul t is MicroStrategy . In IIS, avi rtual di rectory is the home location for a set of Web pages that the Webserver hosts.

If you have a previous version of MicroStrategy Web installed on the machine,the new version you install uses the same virtual directory the previousversion is using. Therefore, you are not prompted to specify the name of thevirtual directory.

The name provided for a virtual directory must be unique. You cannot use thesame name as the default for other MicroStrategy products.

MicroStrategy automatically configures the MicroStrategy Web virtualdirectory to run with the version of .NET Framework that it requires.

MicroStrategy Web (ASP.NET) CPU Affinity Setting

You see this page only i f you choose to instal l MicroStrategy Web(ASP.NET) and i f the MicroStrategy Web instal lation detects that the



l icense key entered is a CPU-based l icense. This page is not displayed onsingle-processor machines.

Speci fy the number of CPUs that MicroStrategy Web is l icensed to use onthe machine. You can speci fy only the number of CPUs that are al lowed bythe l icense. If MicroStrategy Web is instal led on more than one machine,the total number of CPUs should not exceed the maximum number of CPUsspeci fied by the l icense. For machines that support hyper threadingtechnology, the CPU counts correspond to physical CPUs, not logicalCPUs.

To allow the setting to take effect, the installation stops IIS. After IIS has beenrestarted, the MicroStrategy Web application uses the specified number ofCPUs.

For more information on the MicroStrategy Web CPU affini ty feature, refer tothe System Administration Guide.

MicroStrategy Mobile Server (ASP.NET) Setting

You see this page only i f you choose to instal l MicroStrategy Mobi le Server(ASP.NET) and only i f you do not have a previous version of MicroStrategyMobi le Server instal led.

Speci fy the Internet Information Services (IIS) vi rtual di rectory to be createdfor MicroStrategy Mobi le Server. The defaul t is MicroStrategyMobile .The virtual di rectory is part of the URL used to access the interactivereporting and analysis appl ications deployed on this machine via Mobi leServer.

Mobi le Server can be deployed using the same techniques used to deployMicroStrategy Web, as described in Deploying MicroStrategy Web andMobi le Server, page 465. For addi tional configurations required to deployMobi le Server, see the MicroStrategy Mobi le Administration Guide.

If you have a previous version of MicroStrategy Mobile Server installed on the





machine, the new version you install uses the same virtual directory theprevious version is using. Therefore, you are not prompted to specify the nameof the virtual directory.


MicroStrategy automatically configures the MicroStrategy Mobile Servervirtual directory to run with the version of .NET Framework that it requires.

MicroStrategy Subscription Portal Setting

You see this page only i f you choose to instal l MicroStrategy SubscriptionPortal , which is a component of Narrowcast Server, and only i f you do nothave a previous version of Subscription Portal instal led.

Speci fy the name of the IIS virtual di rectory to be created for MicroStrategySubscription Portal pages. The defaul t is NarrowcastServer . In IIS, avi rtual di rectory is the home location for a set of Web pages that the Webserver hosts.

Subscription Portal offers you the ability to subscribe to and view NarrowcastServer services, service descriptions, and their most recent modificationdates on the Web. For complete information about Subscription Portal andother components of Narrowcast Server, refer to the MicroStrategyNarrowcast Server documentation.


MicroStrategy MDX Cube Provider Setting

You see this page only i f you choose to instal l the MicroStrategy MDX CubeProvider and i f you do not have a previous version instal led.

Speci fy the virtual di rectory to be created for the MicroStrategy MDX CubeProvider. The defaul t is MicroStrategyMDX . This vi rtual di rectory is used



as part of the URL to connect to TM1 data sources or Microsoft AnalysisServices data sources for integration with MicroStrategy. For information onconnecting to these MDX cube data sources, see the MDX Cube ReportingGuide.

MicroStrategy Intelligence Server Setting

You see this page i f you choose to instal l MicroStrategy Intel l igence Server,and i f you do not have a previous version of Intel l igence Server instal led.

Select the check box to use the local system account as the Intel l igenceServer service account. If you clear the check box to set a di fferentIntel l igence Server service account, enter the fol lowing information:

l Login : A Windows login of the form Domain\User with ful ladministrative privi leges under which to run the Intel l igence Serverservice.

The user account used to run Intelligence Server must have fulladministrator priv ileges for the local machine. If the administrator defaultpriv ileges have been modified for the user account, connection errors canoccur. For example, if the user account is denied access to the DSNaccessed by Intelligence Server, Intelligence Server connection fails .

l Password : A val id password for the Windows login entered in the Loginbox

l Confirmation : Retype the password to confi rm i t is correct

If the password you supply changes, you must reconfigure the Windowsservice to use the new password. Otherwise, Intelligence Serverconnections fail when the connection attempts to authenticate the login andpassword.


https://www2.microstrategy.com/producthelp/2020/MDXCubeReporting/WebHelp/Lang_1033/index.htm



MicroStrategy Narrowcast Server Setting

You see this page i f you choose to instal l MicroStrategy Narrowcast Server,and i f you do not have a previous version of Narrowcast Server instal led.

Select the check box to bypass the creation of a Narrowcast Server serviceaccount.

It is recommended you create the Narrowcast Server service account. Clearthe check box, and enter the fol lowing information:

l Login : A Windows login of the form Domain\User with administrativeprivi leges under which to run the Narrowcast Server service

l Password : A val id password for the Windows login entered in the Loginbox

l Confirmation : Retype the password to confi rm that i t is correct

If you change the password for this account, you must reconfigure theNarrowcast Server Windows services to use the new password.

Review Installation Settings

This screen provides a summary of the MicroStrategy products and servicesyou have selected to instal l along with the destination folder where theywi l l be saved. If you wish to automatical ly restart your computer when theinstal lation is complete, select the check box below the l ist of products andservices as shown below. Restarting your computer after instal lation wi l lensure that the system configuration is completed properly.



If you do not choose to restart automatical ly, you can restart manual ly whenthe Instal lation Wizard is complete.

MicroStrategy Installation Wizard Complete

Select Yes I want to restart my computer now as pictured below.Restarting now wi l l ensure the instal lation process is completedsuccessful ly.

Cl ick Finish .

If you encounter errors whi le instal l ing MicroStrategy, refer to Appendix B,Troubleshooting.

Default Passwords for Configuration

During the configuration process, the MicroStrategy Instal ler randomlygenerates a password for the MicroStrategy Web Administration page,MicroStrategy Mobi le Administration page, MicroStrategy Reposi tory,



Tomcat (i f instal led), and MySQL (i f instal led). The username and passwordfor al l three are the same.

l Username: mstr

l Password : The password can be found in the fol lowing fi le on the serverwhere MicroStrategy Secure Enterprise was instal led:


Files\MicroStrategy\Default_Accounts.txt

Note the username and password, and store them securely. Thesecredentials wi l l be used to configure the DSN to the Platform Anlayticsproject.

It is recommended to delete the Default_Accounts.txt fi le after thepassword is stored securely. This password cannot be recovered i f i t is lost.

Installation VerificationDuring the instal lation routine, the MicroStrategy Instal lation Wizardgathers and records information about your system and your instal lationselections. You can veri fy instal lation setup information through theinstal lation log fi le (install.log ), located by defaul t in:

l 32-bi t Windows environments: C:\Program Files\Common

Files\MicroStrategy .

l 64-bi t Windows environments: C:\Program Files (x86)\Common

Files\MicroStrategy .

The instal lation log fi le includes the fol lowing information:

l Instal lation date

l Target di rectories

l Program folder name

l Operating system identi fication


https://www2.microstrategy.com/producthelp/current/PlatformAnalytics/WebHelp/Lang_1033/Content/platform_analytics_project_creation.htm



l Hardware speci fications

l Selected instal lation options

l Registry paths

l List of registered fi les

The installation log file can be helpful if you encounter errors during theinstallation process. For example, the log can tell you if a registry key or pathwas not added or if a critical file was not registered successfully .

Installing with a Guided MicroStrategy IntroductionThe instal lation procedure provided in this chapter assumes that you usethe Setup.exe fi le to instal l MicroStrategy software. As an al ternative, aguided introduction to MicroStrategy software and the instal lation processis also provided. This introduction is provided as an Adobe Flashvisual ization.

To use this Flash visual ization, you must locate and run the fi leMICROSTRATEGY.exe , which is avai lable in the MicroStrategy instal lmedia or the fi les downloaded from the MicroStrategy download si te. Youcan then use the Flash visual ization to review documentation onMicroStrategy software, as wel l as begin the instal lation process.

If you provide the MicroStrategy installation files on a network location, youmust map a network drive for users to access the MICROSTRATEGY.exefile. If users run this file without locating it through the use of a mappednetwork drive, the links to open various product manuals will not functionproperly.

To continue with the instal lation procedure, see Welcome, page 144.

Performing a MicroStrategy Express installationThe Express option instal ls your MicroStrategy Secure Enterprise Platformwith al l the features of Analytics, Mobi l i ty, and MicroStrategy Identi ty. This



guide describes the Express Instal l option, which instal ls the enti re platformon a single machine.

The MicroStrategy Express option instal lation is speci fical ly designed fordeployments of up to 15-20 concurrent users wi th the recommendedhardware speci fications. This makes i t an ideal solution for a developmentenvironment, or for evaluating the MicroStrategy Secure Enterprise Platformcapabi l i ties.

You need to provide some information for the Analytics and MicroStrategyIdenti ty configuration.

After instal l ing the complete Platform, you wi l l have MicroStrategyAnalytics, Mobi l i ty, and MicroStrategy Identi ty instal led on your Windowsserver, as wel l as the required Third-party software l ibraries. For acomplete l ist of al l MicroStrategy components, see What you are instal l ing.

Prerequisites

l System requirements:

l You have a 64-bi t Windows Server: 2008R2, 2012, or 2012R2.

l Windows 7 (64-bi t) and Windows 10 (64-bi t) are supported for demopurposes.

l .Net Framework 4.

l Al l components are instal led on the local C:\ drive, which requires 12GB of disk space.

l To successful ly complete the instal lation process, your server mustnot have any MicroStrategy components instal led.

l 8 GB of RAM

l Multi -core 64bi t processor



l MicroStrategy Badge successful ly instal led on your iPhone or Androidphone.

l MicroStrategy Secure Enterprise software requirements:

l Download and extract the MicroStrategy instal lation package from theMicroStrategy Download Site athttps://download.microstrategy.com/ . In the extracted fi les,locate MicroStrategy.exe or Setup.exe .

l Your MicroStrategy software l icense key is for 64-bi t servers. Torequest a l icense key, go to the l icense key generator in theMicroStrategy Download Site at

https://software.microstrategy.com , contact yourMicroStrategy Representative or contact MicroStrategy TechnicalSupport at [email protected].

l After instal lation, a MicroStrategy Landing page containing l inks to themain MicroStrategy Platform services is displayed. The page requiresJavaScript to be enabled to execute inside a web browser. Contact yourIT administrator for assistance.

l If Microsoft Internet Information Server (IIS) is present on the machine,the Express instal lation includes Subscription Portal and the MDX CubeProvider. If IIS is not present, these two components are not instal led.

l Connectivi ty requirements:

l Your Windows computer must be accessible through a Ful ly Qual i fiedDomain Name.

l Your mobi le device must be able to connect to your Windows server. Ifnot, you wi l l not be able to retrieve your badges with MicroStrategyBadge or download your dossiers from the MicroStrategy Mobi le cl ient.

l The MicroStrategy services l isted in Ports and connectivi ty information



must be able to communicate.

l The fol lowing Windows fi rewal l inbound rules must added:

Name Program

ApacheTomcat 8


Files\MicroStrategy\Tomcat\apache-tomcat-

8.0.30\bin\tomcat8.exe

Apache 2.4C:\Program Files (x86)\Common

Files\MicroStrategy\Apache\Apache24\bin\httpd.exe

MicroStrategyIntell igenceServer x64

C:\Program Files

(x86)\MicroStrategy\Intelligence

Server\MSTRSvr2_64.exe

MicroStrategyOpen Ref ineServer x64

C:\Program Files (x86)\MicroStrategy\Intelligence

Server\MJRefSvr_64.exe

l MicroStrategy Identity requires an SSL web server. If you are notfamiliar with these elements, contact your IT administrator forassistance. The following items are needed to successfully configureand access MicroStrategy Identity:

l An SSL Certi ficate Authori ty Root certi ficate and Intermediatecerti ficates, appended into a chain (.pem) fi le. You need to obtain thisfrom a third-party signing authori ty, such as Verisign or Thawte. Contactyour IT administrator for assistance.

l An HTTPS/SSL server certi ficate (.crt) fi le, and the matching key (.key)fi le. These must match the Ful ly Qual i fied Domain Name of yourMicroStrategy Identi ty web services server.

l Certi ficate paths provided during instal lation must not be changed sincethe MicroStrategy Identi ty Server depends on the certi ficates to operate.



l To al low the MicroStrategy Identi ty Server to send invi tation emai ls,provide the connectivi ty information for the emai l (SMTP) Server,including the port and credentials.



To start the Express installation

1. Log in to the Windows server as a user wi th administrator privi leges.

2. In the instal lation folder, locate and run MicroStrategy.exe .Al ternatively, you can locate and run Setup.exe . Accept the l icenseagreement and continue.

3. On the Customer Information page, complete the fol lowing fields,which are used to create the administrator badge:

l First Name: The fi rst name of the administrator.

l Last Name: The last name of the administrator.

l Email address: The emai l address of the administrator. This is theemai l address where you wi l l receive the badge invi tation for yourMicroStrategy Identi ty network.

l License Key: The l icense key for your instal lation. This key isrequired to instal l the MicroStrategy Platform on a 64-bi t Windowsserver. If you do not have this l icense key, contact to yourMicroStrategy Representative or [email protected].

4. Cl ick Next.

5. On the Instal l Options page, select Express, and cl ick Next.

6. To configure MicroStrategy Identi ty, provide the fol lowing information.If you do not have this information, contact your IT Administrator.

To use MicroStrategy Identity with MySQL 5.7.4 and above, the followingline needs to be added or modified in MySQL my.cnf file, usually under/etc directory: sql-mode="STRICT_TRANS_TABLES,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION" .




l CA Certificate chain : The fi le that contains the trusted Root CA,Intermediate Root CA bundle (.pem). It must be the completecerti ficate chain for your SSL Server Certi ficate that you obtainedfrom your IT Administrator. The path must be speci fied in an absoluteformat such as C:\folder\example.pem .

l SSL Server Certificate: The server certi ficate (.crt) fi le for yourWindows server, speci fied using an absolute path.

l SSL Server Certificate Key: The key for your SSL server certi ficate(.key) fi le, speci fied using an absolute path.

l (Optional) SSL Certificate Key Password File: If your CA-signedcerti ficate has a password, create a text fi le containing this passwordand enter the text fi le location, using an absolute path.

l Email (SMTP Server) Server: Your company's SMTP server,fol lowed by the port number in the next box.

l Authentication (optional): If your server is password protected, thenenter the username and password for the server.

l Email Sender Address: The emai l address that is authorized tosend emai ls from your SMTP server, and wi l l be used to send badgeinvi tations for your MicroStrategy Identi ty network.

l Host Name: Type the Ful ly Qual i fied Domain Name of your Windowsserver, for example, webserver.acme-corporation.net .

If you do not have al l the required information and want to manual lyconfigure MicroStrategy Identi ty later, cl ick Skip . The subsequentsteps assume you have entered al l the information required to set upMicroStrategy Identi ty.

7. Cl ick Next.

8. You have now entered al l the information required to proceed. Tochange settings, cl ick Back.



9. Check the box marked Automatically restart my computer when theinstallation completes i f you wish to enable an automatic systemreboot.

10. Cl ick Install. Instal lation takes approximately 20 minutes with therecommended hardware.

11. If you did not choose to restart automatical ly, restart your machine nowby cl icking Finish . The MicroStrategy software is not configured unti lafter a restart.

12. After your machine has restarted, log in wi th your administrativeaccount. Platform configuration automatical ly begins. This can take upto 30 minutes with the recommended hardware.

l On Windows 7, 2008, 2012, and 2012R2, i t is normal to experience ablack screen, for up to 15 minutes, before a progress bar isdisplayed.

l On Windows 10, the operating system loads as normal , whi le theconfiguration continues in the background. Wait for the progress barto display before resuming normal operations.

l A progress bar displays whi le the post-configuration steps areprocessed.

l You wi l l receive two emai ls wi th instructions to retrieve your badgesduring this time period.

13. When the instal lation is complete, your defaul t browser automatical lyopens the MicroStrategy Secure Enterprise launch page.

l If the launch page does not display, use the shortcut on the desktop.

After the MicroStrategy instal lation is complete, you have 30 days toactivate your instal lation. Before you activate your instal lation you mustrequest an Activation Code from MicroStrategy. You can complete thisrequest when you instal l MicroStrategy with the MicroStrategy Instal lation



Wizard or after the instal lation using MicroStrategy License Manager. Forsteps, see Activating Your Instal lation.

To log in to Identity Manager with MicroStrategy Badge

1. You should have received two badge invi tation emai ls for yourMicroStrategy Identi ty network:

l MicroStrategy Identity Network: This badge can be used to changethe configuration for your MicroStrategy Identi ty Server using Identi tyManager.

l MicroStrategy Administrator: This badge is used to log into Identi tyManager and manage your MicroStrategy Secure Enterprise system(add users, connect to Active Directory, and so on).

If you did not receive badge invitation emails or if the QR code does notload on the Identity Manager page, you may need to complete theMicroStrategy Identity Configuration. See To complete theMicroStrategy Identi ty Configuration (Windows and Linux).

2. From your mobi le device:

l Download MicroStrategy Badge for your iOS or Android device.

l Open each emai l 's invi tation l ink to individual ly download bothbadges for your MicroStrategy Identi ty network. Be sure that yourmobi le device is connected to the same network as your SMTPserver.

3. On the landing page, cl ick Identity Manager.

4. Open the Scanner tab in MicroStrategy Badge and scan the QR code.When prompted, select your MicroStrategy Identi ty Manager badge.

5. From Identi ty Manager, you can add users, and logical /physicalresources.



To log in to MicroStrategy Tutorial

1. You can log into Tutorial by scanning a QR code with MicroStrategyBadge. Open the Scanner tab to scan the QR code.

If you did not configure MicroStrategy Identity , you must log in using theMicroStrategy Administrator credentials, as described below:

l Click Credentials below the QR code.

l Type Administrator for the username and keep the passwordempty.

l Click to log in.

2. After logging in, you can explore the capabi l i ties of MicroStrategy byfol lowing the guided tutorials or exploring on your own, and creatingyour own dossiers.

To log in to the MicroStrategy Web Administration page, the MicroStrategyMobile Administration page, or the MySQL database server

During the configuration process, the MicroStrategy Instal ler randomlygenerates a password for the MicroStrategy Web Administration page,MicroStrategy Mobi le Administration page, MicroStrategy Reposi tory,Tomcat (i f instal led), and MySQL (i f instal led). The username and passwordfor al l three are the same.

l Username: mstr



Files\MicroStrategy\Default_Accounts.txt







Supporting Information

What you are installing

MicroStrategy Analytics and Mobility


l MicroStrategy Web Server


l MicroStrategy Col laboration Server

l MicroStrategy Narrowcast Server

l MicroStrategy Developer




l MicroStrategy Reposi tory

l MicroStrategy Community Connectors

l MicroStrategy Administration Tools

l MicroStrategy Tutorial

MicroStrategy Identity

l MicroStrategy Identi ty Server

l MicroStrategy Identi ty Gateway



l MicroStrategy Identi ty Manager

l MicroStrategy Communicator

Third-party software libraries

The MicroStrategy instal lation instal ls thi rd-party software l ibraries toprovide a streaml ined user experience. For a l ist of the l ibraries andversions, see the "System Requirements" in the Readme.

Ports and connectivity information

The MicroStrategy Express instal lation configures the fol lowing services onthe speci fied ports. It also sets inbound Windows fi rewal l rules to permittraffic on the speci fic ports. During an uninstal l , the ports are closed on theWindows fi rewal l .

l Tomcat: 8080

l MicroStrategy Reposi tory: 5432

l Identi ty Manager: 443

l MicroStrategy Identi ty Server 1-way: 1443

l MicroStrategy Identi ty Server 2-way: 2443

l Identi ty Gateway: 9501

l Intel l igence Server: 34952

l REST Server: 34962

l Col laboration Server: 3000

l Export Engine Micro-Service: 20100

l Apache ZooKeeper: 2181

l Apache Kafka: 9092

l Redis: 6379




Certificate information

In addi tion to the certi ficates provided during instal lation, a Signing CA isgenerated to support al l PKI signing operations of the MicroStrategy Identi tyServer, as wel l as a SAML Certi ficate used in al l SAML transactions at thetime of configuration. These certi ficates have an expiration of one year fromthe time of instal lation and are located in the c:\program files

(x86)\Common Files\MicroStrategy\Certificates folder. Thekeys for the certi ficates can be found in the c:\program files

(x86)\Common Files\MicroStrategy\Keys folder. To reconfigurethis certi ficate, see the MicroStrategy Identi ty Server documentation.

If changes are made to the SSL certi ficates at a later date, the configurationfi les containing references to these certi ficates can be found in thefol lowing locations:

l C:\Program Files

(x86)\MicroStrategy\Usher\MicroStrategy Identity

Server\usherApps\shardIDM\conf\server.xml

l SSLCerti ficateFi le=HTTPSServerCerti ficate.crt

l SSLCerti ficateKeyFi le=HTTPSServerCerti ficate.key

l SSLCACerti ficateFi le=UsherCAChain.pem

l C:\Program Files


Server\usherApps\shardGateway\conf\server.xml

l SSLCerti ficateFi le=HTTPSServerCerti ficate.crt

l SSLCerti ficateKeyFi le=HTTPSServerCerti ficate.key

l SSLCACerti ficateFi le=UsherCAChain.pem

l C:\Program Files (x86)\Common



Files\MicroStrategy\Apache\Apache24\conf\extra\manager

.usher.com.conf

l SSLCerti ficateKeyFi le HTTPSServerCerti ficate.key

l SSLCerti ficateFi le HTTPSServerCerti ficate.crt


Files\MicroStrategy\php\php.ini

l openssl .cafi le=UsherCAChain.pem

In addi tion,

l Certi ficates from UsherCAChain.pem are added to Java Key Store

l UsherSAML.crt is saved to C:\Program Files


Server\usherApps\shardIDM\webapps\files\saml2.crt

Configuring your MicroStrategy Installation

After completing the MicroStrategy Instal lation Wizard steps to instal lMicroStrategy products, you can set up and configure your instal lation. Tohelp guide the rest of your instal lation and configuration steps, refer to thesection Instal l ing and Configuring MicroStrategy on Windows, page 135 inChapter 1, Planning Your Instal lation, for an instal lation and configurationcheckl ist.

The next section in the installation and configuration checklis t and in this guidecovers software activation steps with MicroStrategy. These steps should bedone before or soon after the Configuration Wizard tasks mentioned below. Formore information, refer to Chapter 5, Activating Your Instal lation .

After restarting your machine to complete an initial MicroStrategy installation,the MicroStrategy Configuration Wizard opens. The Configuration Wizardallows you to configure your MicroStrategy production environment. For more



information, refer to Chapter 6, Configuring and Connecting Intel l igenceServer.



INSTALLINGM ICROSTRATEGY ONL INUX



This section describes the procedure for instal l ing MicroStrategy on Linuxplatforms and covers the fol lowing:

Before instal l ing MicroStrategy products, see Chapter 1, Planning YourInstal lation for important pre-instal lation information.


For supporting instal lation information, see Instal l ing MicroStrategy onWindows.

Installation Procedures on Linux

The MicroStrategy products that you can instal l on Linux environments are:


l MicroStrategy Web

l MicroStrategy Portlets

l MicroStrategy GIS Connectors

l MicroStrategy Web Services for Office


l MicroStrategy Command Manager

l MicroStrategy Integri ty Manager


l MicroStrategy System Manager



l MicroStrategy Identi ty:

l MicroStrategy Identi ty Server

l MicroStrategy Identi ty Manager




The MicroStrategy SDK and MicroStrategy Developer Library (MSDL) are notincluded in the MicroStrategy installation. You can download the MicroStrategySDK from the MicroStrategy support si te . You can also access theMicroStrategy Developer Library from the MicroStrategy support s ite.

R and R Integration Pack libraries are optional components that can beinstalled during MicroStrategy platform installation.

For more information about these products, see Hover over the icons belowto see the information related to instal l ing each part of the Intel l igencePlatform archi tecture. , page 11.

The fol lowing processes wi l l be registered as OS services automatical lyfol lowing restart after instal lation is complete:

l Intel l igence Server

l Enterprise Manager Service

l Data Wrangl ing process

l Hadoop Gateway Manager

l Kafka

l Zookeeper

l Intel l igence Server Log consumer

l Export Engine


https://resource.microstrategy.com/msdz/default.asp


It is recommended that you instal l MicroStrategy products as the root user.

To install MicroStrategy MicroStrategy Identity , see MicroStrategy Identi ty Pre-Instal lation Instructions.

If you are installing MicroStrategy Identity Manager, you must create a databaseto manage user identities.

l If you are installing MicroStrategy products with a CPU-based license, youmust be logged in as the root user; otherwise an error message is displayedand the installation fails .

l If you want a non-root user to be the administrator of the server, you mustmanually change the ownership after running the installation. IntelligenceServer operation is dependent on root user priv ileges and permissions.Therefore, changing the ownership of Intelligence Server to a non-root useris not a certified or recommended practice.

l Only a user with root permissions can install MicroStrategy Identitycomponents.

l During installation, the user account for Intelligence Server is tested toverify that it can successfully support the use of common system tools forthe operating system. If you change the user account for Intelligence Server,you must verify that this user account can use and access common systemtools for the operating system.

l Script files within HOME_PATH/env and other configuration files withinHOME_PATH (see Instal l ing with the MicroStrategy Instal lation Wizardfor Linux for information on this MicroStrategy directory) are overwrittenanytime a new MicroStrategy product is installed on a machine. Backupcopies of the previous file are also created during the installation. Thesebackup copies can be used to update the new versions of the script andconfiguration files to include any prior modifications.

For example, Intelligence Server is installed on a machine. Then a weeklater Command Manager is installed on the same machine. During thisinstallation of Command Manager, script files such as ODBC.sh are



overwritten and a backup copy of each of these files is created beforeinstalling Command Manager.

Different methods of installationMicroStrategy products can be instal led on Linux, ei ther in graphical userinterface (GUI) mode or in command l ine mode, using the MicroStrategyInstal lation Wizard. In both cases, the MicroStrategy Instal lation Wizardruns, displaying the same pages and requesting the same information. Themain di fferences are in how you provide the information and navigatethrough the wizard.

Using command line mode

In command l ine mode, you type the appropriate information at the promptand press Enter. Instructions are included for each page of theMicroStrategy Instal lation Wizard.

In some cases, you are asked to make a selection by pressing 1 or 2 ,fol lowed by pressing Enter . You then press 0 and Enter to continue.

Defaul ts appear next to each prompt and are enclosed in square brackets,for example, [1]. cl ick Enter to use the defaul t, or type a di fferent responseto the prompt to override the defaul t.

In addi tion, on the command l ine wizard pages, the fol lowing options areavai lable:

l Press 1 and then cl ick Enter to proceed to the next page.

l Press 2 and then cl ick Enter to return to the previous page.

l Press 3 and then cl ick Enter to cancel the instal lation and close theMicroStrategy Instal lation Wizard.

l On the last page, which is MicroStrategy Instal lation Wizard Complete,press 3 and then cl ick Enter.



Using silent mode

You can perform a ful ly automated and unattended instal lation within theMicroStrategy platform when you do not have access to a Linux graphicaluser interface. This also lets you perform an instal lation on other machines.

For information on how to perform a si lent instal lation on a Linuxenvironment, see Chapter 10, Automated Instal lation on Linux.

Installing with the MicroStrategy Installation Wizard for Linux

To instal l MicroStrategy products, you must log on to your machine using aval id Linux account. For ease of management and maintenance, i t isrecommended that you create a dedicated user account.

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.

To exit the instal lation process at any time, cl ick Cancel.

To access the MicroStrategy Installation Wizard

1. Navigate to the MicroStrategy Instal lation folder and thenQueryReportingAnalysis_Linux

You can access the installation files by asking your system administrator

to share the files on a network location. There are different installation

files for installing MicroStrategy products on different platforms;

Windows and Linux.

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 Instal lation Packages, page 131 .Details on using a options.txt file to provide the location of the

installation files are provided in Chapter 10, Automated Instal lation onLinux and the parameters used to specify the location of the required

installation files are described in Instal l on Demand Options, page668 .

2. Type one of the fol lowing commands, depending on the instal lationmode you chose:

l To run the wizard in GUI mode: ./setup.sh

l To run the wizard in command l ine mode: ./setup.sh -console

l To run the wizard in si lent mode: ./setup.sh -silent -

options options.txt

For information on performing a si lent instal lation with anoptions.txt fi le, see Completing a Si lent Instal lation, page 621.

3. The MicroStrategy Instal lation Wizard opens and leads you through theinstal lation process. The fol lowing sections describe the actions youneed 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 click Enter , to proceed to the next page of theinstallation routine.

To quit the installation at any time during the setup, click Cancel , orpress 3 and then click Enter .

The fol lowing dialogs appear in the Instal l wizard:



l Language Setup

l MicroStrategy Instal lation Selection

l License Agreement

l Customer Information

l Choose Destination Location

l Select Components

l Missing Instal lation Fi les

l Missing Requirements

l System Requirements

l MicroStrategy Identi ty Server Settings: Step 1

l MicroStrategy Identi ty Server Settings: Step 2 for Ports and Certi ficates

l MicroStrategy Identi ty Server Settings: Step 3 for Gateways

l MicroStrategy Identi ty Manager Settings

l Open Source Software Agreement

l MicroStrategy Library Web and Mobi le


l MicroStrategy Messaging Services Cluster Configuration

l Topology Configuration

l Register as a Service

l CPU License Information

l Software Activation

l Start Instal ler Operation

l MicroStrategy Instal l Wizard Complete



Linux Install Wizard - Language Setup

Speci fy the language to be used for the MicroStrategy instal lation.

Linux Install Wizard - MicroStrategy Installation Selection

This dialog appears i f there are instal lations of MicroStrategy software onthe current machine. The steps provided here assume that you are ei therinstal l ing for the fi rst time or creating a new instal lation.

You can support mul tiple instal lations of MicroStrategy on Linux machines.Addi tional ly, you can also modi fy, repair, and upgrade existingMicroStrategy instal lations. This dialog provides the fol lowing instal lationoptions to support these scenarios:

l Create a new installation : Select this option to create a new instal lationof MicroStrategy on the machine. If an instal lation of MicroStrategy isalready present on the machine, you can select this option to instal l acompletely separate copy of MicroStrategy on the machine.

l Use an existing installation : If an instal lation of MicroStrategy is alreadypresent on the machine, you can select this option to perform variousinstal lation configurations. Select the instal lation you want to modi fy fromthe drop-down l ist, and then select one of the fol lowing instal lationconfigurations. The instal lation configuration options that are avai labledepend on the type of instal lation that is being performed:

l Modify: Select this option to add new program components or to removecurrently instal led components. If you want to remove al l MicroStrategycomponents, use the Uninstal l option described below. The remainingdialogs are the same as for a fi rst-time instal lation, al though somedialogs may be skipped i f they are not required as part of theinstal lation modi fication.

l Repair: Select this option to re-instal l program components i f you haveproblems with previously instal led components. Your programcomponents are returned to their original instal lation state. As part of a



repair instal lation, you can also designate this machine as a Heal thAgent.

l Uninstall: Select this option to uninstal l al l MicroStrategy components.

l Upgrade: Select this option to upgrade al l MicroStrategy components tothe version you are instal l ing. This option is only avai lable i f theversion you are instal l ing is a more recent version of MicroStrategy thanthe current instal lation. Only the MicroStrategy components currentlyinstal led are upgraded, you cannot instal l or uninstal l MicroStrategycomponents as part of an upgrade. For best practices and steps toupgrade your MicroStrategy instal lation, see the Upgrade Guide.

l Remove Update: Select this option to uninstal l a MicroStrategy Updateinstal lation.

Linux Install Wizard - License Agreement

Read the l icense agreement and select to accept or decl ine the agreement.If you choose to decl ine, you cannot instal l MicroStrategy products.

Linux Install Wizard - Customer Information

Enter the fol lowing customer information:

l User

l Company

l License Key

To request a license key, go to the license key generator in the MicroStrategyDownload Site , contact your MicroStrategy Representative or contactMicroStrategy Technical Support.







Linux Install Wizard - Choose Destination Location

Speci fy the locations where the MicroStrategy products and MicroStrategycommon fi les are to be instal led:

l MicroStrategy Home Directory: Speci fy the location where theMicroStrategy configuration fi les and appl ication launchers are to beinstal led, according to the fol lowing guidel ines:

l The defaul t location is /var/opt/MicroStrategy , or$HOME/MicroStrategy i f you do not have wri te access to/var/opt/MicroStrategy .

l Do not instal l the MicroStrategy configuration fi les directly to your LinuxHome Directory ($HOME ). To ensure that the required permissions canbe defined for the MicroStrategy configuration fi les, you must instal lthese fi les wi thin a separate directory. For example, the defaul t path of$HOME/MicroStrategy uses the MicroStrategy directory wi thin$HOME to ensure permissions on these fi les are defined correctly.

l The path speci fied for the home directory is referred to as HOME_PATH

in this guide.

l Do not change the names of folders wi thin the HOME_PATH afterinstal l ing Intel l igence Server.

l When including paths during a MicroStrategy instal lation, includeabsolute paths rather than relative paths.

l MicroStrategy Install Directory: Speci fy the location where theMicroStrategy products are to be instal led, according to the fol lowingguidel ines:

l The defaul t location is /opt/MicroStrategy , or$HOME/MicroStrategy/install i f you do not have wri te access to/opt/MicroStrategy .



l The path speci fied for the instal l di rectory is referred to as INSTALL_

PATH in this guide.

l Do not change the names of folders wi thin the INSTALL_PATH afterinstal l ing Intel l igence Server.


l MicroStrategy Log Directory: Speci fy the location where theMicroStrategy appl ication logs are to be created, according to thefol lowing guidel ines:

l The defaul t location is /var/log/MicroStrategy , or$HOME/MicroStrategy/log i f you do not have wri te access to/var/log/MicroStrategy .

l The path speci fied for the log directory is referred to as LOG_PATH inthis guide.


Linux Install Wizard - Select Components

Select a MicroStrategy product to include i t in the instal lation. Al ternatively,you can clear a checkbox to uninstal l or exclude a MicroStrategy productfrom the instal lation.

The instal lation dialogs you see after this step depend on the products youchoose to instal l . These instructions describe al l possible dialogs.

If you are installing MicroStrategy Communicator, components ofMicroStrategy Intelligent Enterprise are also installed.

If you previously installed Community Connectors in 11.0 and are installing anewer version of MicroStrategy, your whitelis t.tx t file will be overwritten.


https://www2.microstrategy.com/producthelp/current/WebAdmin/WebHelp/Lang_1033/Content/MicroStrategy_Community_Data.htm


To use your 11.0 whitelis t.tx t file in a newer version of MicroStrategy, backupthe whitelis t.tx t file located in<installPath>\Tomcat\CommunityConnectors\WEB-INF

before performing the upgrade install. After the installation, replace the newwhitelis t.tx t with the backed up whitelis t.tx t file from 11.0.

Many of the platform components have subcomponents. If you expand thedi fferent MicroStrategy products, you can select the appropriate checkboxesto speci fy the subcomponents to instal l . For information on MicroStrategycomponents and subcomponents, see Hover over the icons below to see theinformation related to instal l ing each part of the Intel l igence Platformarchi tecture. , page 11 in Chapter 1, Planning Your Instal lation.

You can see only MicroStrategy products that are available with your licensekey.

Destination Folder

You can select MicroStrategy products and their subcomponents to definetheir instal lation locations. When you select a MicroStrategy product orsubcomponent, the Destination Folder area near the bottom of the interfacedisplays the current instal lation folder for the product. Cl ick Browse toselect a di fferent instal lation folder.

If you select a MicroStrategy product or subcomponent and the Browsebutton is not accessible, this means that the instal lation location cannot bechanged. For example, i f you select MicroStrategy Mobi le you cannot definean instal lation location. However, i f you expand this product, you can definethe instal lation location for i ts subcomponents.

Linux Install Wizard - Missing Installation Files

You see the Missing Instal lation Fi les message only i f some of the fi les,required to instal l the MicroStrategy components you have selected forinstal lation, are not avai lable. If you are downloading only a subset of the



instal lation fi les to reduce the amount of data that has to be downloaded forthe instal lation, i t is recommended that you do the fol lowing:

l Determine the fi les required for the MicroStrategy components you areinstal l ing. A l ist of instal lation fi le requirements is provided in the tablebelow:


mstr1. tzp All MicroStrategy components and products

mstr3. tzp MicroStrategy Intell igence Server and all of its components

mstr4. tzpMicroStrategy Web, including Web Analyst , Web Reporter, andWeb Professional

mstr5. tzp MicroStrategy Web Services for Off ice

mstr6. tzp MicroStrategy Command Manager

mstr7. tzp MicroStrategy Integrity Manager

mstr8. tzp MicroStrategy System Manager

mstr9. tzp MicroStrategy Mobile Client

mstr10. tzp MicroStrategy Mobile Server

mstr11. tzp MicroStrategy Port lets, which is a component of MicroStrategy Web

mstr12. tzpMicroStrategy GIS Connectors, which is a component ofMicroStrategy Web

mstr13. tzp All MicroStrategy components and products

mstr14. tzp MicroStrategy Enterprise Manager

mstr15. tzp MicroStrategy MicroStrategy Ident ity Server

mstr16. tzp MicroStrategy MicroStrategy Ident ity Manager




mstr18. tzp MicroStrategy MicroStrategy Communicator

mstr20. tzp MicroStrategy Messaging Services

mstr21. tzp MicroStrategy Library Web & Mobile

mstr22. tzp MicroStrategy Collaborat ion Server

mstr25. tzpNode. js which is installed with Intell igence Server andCollaborat ion Server

mstr26. tzp Applicat ion Schema Server (Early Adopter)

mstr27. tzp Redis which is installed with MicroStrategy Plat form Analyt ics

mstr28. tzp MicroStrategy Plat form Analyt ics

mstr29. tzp Common Files

mstr30. tzp Community Connectors

mstr31. tzp Cert if icate Manager

mstr32. tzp MicroStrategy Export

mstr35. tzp MicroStrategy Modeling Service

mstr36. tzp MicroStrategy Repository

l Provide the location of the instal lation fi les using an options.txt fi le.This lets you access the instal lation fi les stored on a folder or stored at aURL and accessed using HTTP or HTTPS. Detai ls on using anoptions.txt fi le as part of an instal lation are provided in Chapter 10,Automated Instal lation on Linux and the parameters used to speci fy thelocation of the required instal lation fi les are described in Instal l onDemand Options, page 668 .

If the fi les required for the instal lation are stored in a folder, you caninstead cl ick Browse to navigate to and select the folder that stores theinstal lation fi les. If al l the required instal lation fi les are provided in the



folder you select, you can cl ick Enter to continue the MicroStrategyinstal lation.

Linux Install Wizard - Missing Requirements

This dialog appears i f there are system requirements that are not met toinstal l the MicroStrategy products you selected. Review the l ist ofrequirements to determine i f you can proceed with the instal lation, or i f theinstal lation must be cancel led.

If you are instal l ing MicroStrategy Intel l igence Server on Linux, you maysee a warning about the value for the Linux kernel setting vm.max_map_

count . For information about this setting and the recommendation for i tsvalue, see Supporting Intel l igence Server memory al location on Linux, page108.

To improve the performance of MicroStrategy Intel l igence Server for largescale production appl ications, Intel l igence Server can be configured to useshared memory resources. If a semaphore configuration warning appears,some system resource l imi ts are not configured to ful ly support the use ofshared memory resources.

To support this configuration, cancel the instal lation and see the l imi trecommendations in Configuring shared memory resources, page 106

Linux Install Wizard - System Requirements

This dialog appears i f the machine you are instal l ing Intel l igence Server ondoes not use the recommended system resource l imi ts to support the use ofshared memory resources. It is recommended that you exi t the instal lationand configure these system settings to support shared memory resources.For information on this requirement and the options avai lable to completethe instal lation, see Configuring shared memory resources, page 106.



Linux Install Wizard - MicroStrategy Identity Server Settings: Step1

The MicroStrategy Identi ty Server instal ls a database which is a system ofrecord for individual user identi ties. Use this page to provide theconfiguration parameters for the MicroStrategy Identi ty Server tocommunicate with the database.

Speci fy the location of the Tomcat Directory. The Instal lation Wizardval idates that the directory exists and contains the correct version ofTomcat, and also that you can wri te to the webapps subfolder. Instal l ingthe MicroStrategy Identi ty Server includes a ROOT.war fi le. You can usethis .war fi le to deploy your MicroStrategy Identi ty Server on your Tomcatweb appl ication server.

Define the database connection information for the database that stores theMicroStrategy Identi ty Server database, using the fol lowing settings:

l Server: The IP address for the machine that hosts the database.

l Port: The port number for the database connection. The defaul t port is3306.

l User Name: The account name for the database user that administers thedatabase.

l Password : The password for the database user speci fied above.

l Server Database Instance: The name of the MicroStrategy Identi tyServer database.

l Log Database Instance: The name of the database that stores loginformation for the MicroStrategy Identi ty Server.

l Enable SSL Certi ficate: Selecting this checkbox al lows you tocommunicate via SSL by defaul t.

To test the database connection, cl ick the Test button. The Instal lationWizard val idates that:



l A connection can be made using the provided server, port, user andpassword information.

l If the server and log instances exist, the instances are ei ther empty or canbe dropped.

l If the server and log instances do not exist, that the provided user has thecorrect privi leges to create the instances.

l The provided user has the correct privi leges to create tables.

Linux Install Wizard - MicroStrategy Identity Server Settings: Step2 for Ports and Certificates

The MicroStrategy Identi ty Server Settings dialog al lows you to set up atrust relationship for the MicroStrategy Identi ty Server using the Publ ic KeyInfrastructure (PKI).

Define your MicroStrategy Identi ty Server's HTTPS port using the fol lowingsettings:

l Server (one-way SSL) authentication only: The defaul t port is 1443 .

l Client and Server (two-way SSL) mutual authentication : The defaul tport is 2443 .

Provide the location of your MicroStrategy Identi ty Server's certi ficate fi lesusing the fol lowing settings:

l SSL Certificate File: The MicroStrategy Identi ty Server SSL/HTTPScerti ficate is used to encrypt the data and enforce authentication. The fi lecontains the certi fication part of the signed certi ficate, as wel l as i tspubl ic key, in a crt format. The defaul t path is USHER_SERVER_

INSTALL_PATH/usherApps/shardIDM/conf/Server_ca.crt .

l Private Key File: The MicroStrategy Identi ty Server SSL/HTTPS PrivateKey fi le is used to decrypt the data and enforce authentication. The fi lecontains the key part of the signed certi ficate in a key format. The defaul t



path is USHER_SERVER_INSTALL_

PATH/usherApps/shardIDM/conf/Server_ca.key .

l SSL Certificate Chain : The MicroStrategy Identi ty Server Certi ficateAuthori ty Chain includes al l the certi ficate authori ty (CA) certi ficates thatthe MicroStrategy Identi ty Server wi l l trust. The fi le contains theinformation in PEM format. The defaul t path is USHER_SERVER_

INSTALL_PATH/usherApps/shardIDM/conf/Server_ca.pem .

The USHER_SERVER_INSTALL_PATH is INSTALL_

PATH/Usher/UsherServer where INSTALL_PATH is the path speci fiedfor the instal l di rectory.

Linux Install Wizard - MicroStrategy Identity Server Settings: Step3 for Gateways

You see the MicroStrategy Identi ty Server Settings dialog i f you areinstal l ing MicroStrategy Identi ty Server. This page al lows you to set up atrust relationship for the Agent Gateway using the Publ ic Key Infrastructure(PKI).

The Agent Gateway is a component on MicroStrategy Identi ty Server that isused to synchronize your users from Microsoft Active Directory. The AgentGateway:

l Establ ishes a trusted relationship between MicroStrategy Identi ty Serverand the MicroStrategy Identi ty Agent for Microsoft Active Directory, whichis the appl ication that communicates between your Active Directoryserver and the MicroStrategy Identi ty Server.

l Manages communication between the MicroStrategy Identi ty Agent andMicroStrategy Identi ty Server.

l Communicates the MicroStrategy Identi ty Agent's status to MicroStrategyIdenti ty Server.

Provide the Agent Gateway (one-way SSL) Authentication Only Port (thedefaul t is 9501 ).



Linux Install Wizard - MicroStrategy Identity Manager Settings

Speci fy the location of the Apache Directory. The Instal l Wizard val idatesthat the directory exists and contains the conf and conf.d folders, andalso that you can wri te to the conf.d subfolder.

Speci fy a val id Apache User to use to access the Apache directory.

MicroStrategy Identi ty Manager instal ls a database to manage useridenti ties. You can choose to use the same database connection asMicroStrategy Identi ty Server, or define the database connection using thefol lowing settings:

l Server: The IP address for the machine that hosts the database.

l Port: The port number to use to connect to the MicroStrategy Identi tyManager machine. The defaul t port is 3306.

l User Name: The account name for the database user that administers thedatabase.

l Password : The password for the database user speci fied above.

l Database Instance: The name of the database instance.

l Enable SSL Certi ficate: Selecting this checkbox al lows you tocommunicate via SSL by defaul t.

To test the database connection, cl ick the Test button.

MicroStrategy Identi ty Manager is configured as an HTTP connection bydefaul t. It is strongly recommended that you configure your connection asan HTTPS connection for securi ty reasons. See your thi rd-party Apachedocumentation for steps.

Linux Install Wizard - MicroStrategy Library Web and Mobile

Provide the instal lation directory for Apache Tomcat to deployMicroStrategy Library Web and Mobi le.



Linux Install Wizard - MicroStrategy Messaging Services ClusterConfiguration

If Intel l igence Server or Platform Analytics are chosen for instal lation, theoption to configure a Messaging Services cluster is presented.

If no cluster needs to be configured, cl ick Next.

To configure a cluster:

1. Select the I need to create a Messaging Services cluster forPlatform Analytics check box.

2. Local Node: Provide the address for the local node.

3. Remote Nodes: Provide a comma separated l ist of hostnames forremote nodes in the cluster. The node ID is determined by alphabeticalorder in node l ist.

See, MicroStrategy Messaging Servicesfor detai led configurationinformation.

Linux Install Wizard - Topology Configuration










l Monitoring Agents




On environments where three or more machines host MicroStrategyServices, i t is recommended that you choose at least threecommunication agents to provide redundancy and improved rel iabi l i ty, incase one communication agent becomes unavai lable. The machineschosen to act as communication agents must be machines that hostMicroStrategy Services, such as Intel l igence Server or MicroStrategyLibrary. If you decide to use only one communication agent, i t isrecommended that you choose the machine that houses MicroStrategyLibrary (i f deployed through the MicroStrategy instal lation), since Librarycommunicates directly wi th Workstation.






2. If your environment contains multiple machines, determine whichmachines in your environment you want to act as communicationagents. Among al l the machines in your environment that wi l l hostMicroStrategy Services, select at least one of them (three arerecommended for mul tiple machine environments) to act as acommunication agent. Enter each machine in the text field, separatedby semicolons. You must input the exact same l ist on al l machines,using the Topology Configuration dialog of the Instal lation wizard,including the moni toring and communication agent machines.













Examples:
















After instal l ing the topology feature, see Instal l ing and ConfiguringTopology for addi tional instructions on configuring this feature to work inyour environment.

Linux Install Wizard - Register as a Service

To enable MicroStrategy processes to start automatical ly after system startup, you can choose to register the processes as a service.

l Register as a service is not supported on SUSE OS.

l A non-root user and group must be used. If a user is not specified, theinstaller will create and use the mstr user and mstrgroup.



Linux Install Wizard - CPU License Information

This dialog appears i f the Intel l igence Server l icense has a CPU numberl imi tation. Speci fy the number of CPUs that Intel l igence Server is l icensedto use.

Linux Install Wizard - Software Activation

If you have instal led one or more MicroStrategy server products, you canrequest an activation code for your MicroStrategy server products uponcompletion of the instal lation process. The next few dialogs of theinstal lation process assist you in providing the information needed torequest an activation code. MicroStrategy server products include:


l MicroStrategy Web




This dialog includes a welcome statement for the software activationprocess. Read the welcome statement and cl ick Next to proceed.

Server Information

Speci fy information about your MicroStrategy server instal lation. Enter thefol lowing characteristics:

l Name: Distinguishes the name of this MicroStrategy server productinstal lation from any other MicroStrategy server product instal lations inyour company.

l Location : Physical location of the machine on which MicroStrategy serverproducts are instal led.

l Use: Description of how the server is used.


Instal ler Information

Speci fy contact information of the person instal l ing the software. After yourinstal lation is complete an emai l containing the Activation Code is sent tothe emai l address you confi rm in this software activation step. Enter thefol lowing instal ler information:

l Speci fy whether you are an employee of the l icensed company orinstal l ing on behal f of the l icensed company.

l Enter the necessary data into al l text fields. Make sure the emai l addressyou enter is correct. This emai l address is the recipient of the ActivationCode.

l Select the check box at the bottom of the page to receive noti ficationsabout product updates, events, and special offers from MicroStrategy.




Contact Information

You see this page i f you indicated that you are not an employee of thecompany l icensed to use this software, and are instal l ing the software onbehal f of that company.

Speci fy contact information for the employee l icense to use the software.Enter the necessary data into al l text fields. Make sure the emai l addressyou enter is correct. After your instal lation is complete an emai l containingthe Activation Code is sent to the emai l address you confi rm in this softwareactivation step.

Select the check box at the bottom of the page to receive noti fications aboutproduct updates, events, and special offers from MicroStrategy.

Cl ick Privacy Statement to view the MicroStrategy Privacy Statement.

Request Activation Code

This page includes options to request an Activation Code now or at a latertime. This page provides the fol lowing options:

l Select Yes, I want to request an Activation Code and cl ick Next torequest an Activation Code. The Activation Code is sent to the emai laddresses suppl ied in the Instal ler Information and Contact Informationpages.

l Select No, I will request the Activation Code at a later time and cl ickNext to request an Activation Code at a later time.

If you choose to request an Activation Code at a later time, a message isdisplayed that instructs you how to request an Activation Code after theinstal lation procedure is completed. For more instructions on requestingan Activation Code at a later time, see Request an Activation Code,page 356 in Chapter 5, Activating Your Instal lation.

You have a grace period of 30 calendar days to activate your instal lation. Ifyou do not complete the activation before the grace period expires, your



MicroStrategy product stops functioning unti l you activate i t. If you wai t toactivate your instal lation, you receive periodic reminders.

Once you request an Activation Code, an emai l is sent to the emai laddresses you speci fy in the Instal ler Information and Contact Informationpages of the software activation procedure. The emai l provides instructionson how to use the requested Activation Code to activate your software. Toactivate your instal lation, you can also use the steps given in Activate YourInstal lation, page 358 in Chapter 5, Activating Your Instal lation.

Linux Install Wizard - Start Installer Operation

This dialog provides a description of what configurations are to becompleted. If you chose to instal l , repair, or upgrade MicroStrategycomponents, this includes l isting locations in which the products wi l l beinstal led (target di rectories), the location of the instal lation log fi le, andl icense detai ls. If you chose to uninstal l MicroStrategy components, thisincludes a l isting of the components to be uninstal led.

When you proceed from this step, the instal lation process begins, whichcan take several minutes depending on your computer's hardwareconfiguration.

Linux Install Wizard - MicroStrategy Install Wizard Complete

When the MicroStrategy instal lation has completed, you can select thefol lowing:

l Run MicroStrategy Identi ty Configuration, which is avai lable i f theMicroStrategy Identi ty Manager has been instal led.

l View the Readme for the latest updates.

l Run the MicroStrategy Configuration Wizard, which al lows you toconfigure your MicroStrategy production environment. For moreinformation, see Chapter 6, Configuring and Connecting Intel l igenceServer.




Click Finish to complete the instal lation.

Default Passwords for Configuration

During the configuration process, the MicroStrategy Instal ler randomlygenerates a password for the MicroStrategy Web Administration page,MicroStrategy Mobi le Administration page, MicroStrategy Reposi tory,Tomcat (i f instal led), and MySQL (i f instal led). The username and passwordfor al l three are the same.

l Username: mstr


/<install_path>/Repository/Default_Accounts.txt



Unique Post-Installation ConfigurationsMicroStrategy supports many di fferent Linux environments wi th varioussystem configurations. There are a few cases in which you must performsome manual configurations to support the use of MicroStrategy on yoursystem.

Create Links for Intelligence Server Startup in SUSE Linux

If you are instal l ing Intel l igence Server on a SUSE Linux environment, youmust manual ly create l inks for some system fi les. If you do not create thesel inks, Intel l igence Server cannot start correctly.





You need root permissions to access the files and create the necessary linksdescribed in this section.

1. In a console window, browse to the system folder usr/lib64 .

2. In a console window, create the l ink of libssl.so.4 tolibssl.so.0.9.7 with the fol lowing command:

ln libssl.so.0.9.7 libssl.so.4

3. In a console window, create the l ink of libcrypto.so.4 tolibcrypto.so.0.9.7 with the fol lowing command:

ln libcrypto.so.0.9.7 libcrypto.so.4

Supporting fonts for documents, exported reports, and graphs

When Intel l igence Server is running on a Linux platform, al l fonts areconverted to the Courier New font for:

l Reports exported to PDF format

l Report Services documents

l Graphs contained in HTML documents

l Graphs displayed in MicroStrategy Web

This occurs because the fonts required by the PDF component are missingfrom Linux machines running Intel l igence Server.

MicroStrategy cannot package these fonts with Intelligence Server due tolicensing restric tions.

For steps to support fonts such as Microsoft True Type fonts for theMicroStrategy features l isted above, see Setup for Executing ReportServices Documents, page 554.



Starting and Stopping Intelligence Server Kafka service

For Linux users, the Kafka Consumer wi l l be instal led and automatical lyrunning after instal lation or upgrade. You wi l l find KafkaConsumner.sh ,LogConsumer.properties , and KafkaConsumer.jar under<install_path>/IntelligenceServer/KafkaConsumer . You canuse the fol lowing commands to control the Kafka Consumer logging activi ty:

l Start service: <path_to>/KafkaConsumer.sh start

l Stop service: <path_to>/KafkaConsumer.sh stop

l Restart service: <path_to>/KafkaConsumer.sh restart

l Check service status: <path_to>/KafkaConsumer.sh status

Starting and Stopping the PDF Exporter Service

For Linux users the PDF Exporter Service wi l l not be started when OS isrestarted. To start this service manual ly, run the pdfexporter.sh scriptfound under the pathinstall/IntelligenceServer/PDFExportService . Commands forthis script include:

l <path_to>/pdfexporter.sh start to start the PDF ExporterService.

l <path_to>/pdfexporter.sh stop to stop the PDF Exporter Service.

l <path_to>/pdfexporter.sh restart to restart the PDF ExporterService.

l <path_to>/pdfexporter.sh status to check the status the PDFExporter Service.

For other configuration settings, see Export Engine Configuration.



Verifying InstallationDuring instal lation, the MicroStrategy Instal lation Wizard gathers andrecords information about your system and your instal lation selections. Youcan veri fy the setup information through the instal lation log fi le(install.log ).

By defaul t, the log fi le is located in INSTALL_PATH where, INSTALL_PATH is the directory you speci fied as the instal l di rectory in theMicroStrategy Instal lation Wizard.

The log fi le includes information about the fol lowing:

l Instal lation date

l Target di rectory

l Operating system identi fication

l Selected instal lation options

l Selected l icensing detai ls

This log file can be helpful if you encounter errors during the installationprocess. The log file records the reasons for errors occurring.

Directory StructureThe fol lowing table l ists the directories in which MicroStrategy fi les areinstal led:

PATH/Directory Contents

HOME_PATH Conf igurat ion f i les that can be modif ied af ter installat ion.

HOME_PATH/env

Scripts to set up the proper environment for theMicroStrategy applicat ions. I f addit ional products areinstalled on the same machine at a later t ime, backups ofthe original scripts are saved here.




HOME_PATH/bin Scripts to launch the MicroStrategy applicat ions.

INSTALL_PATHFiles that are not supposed to change af ter the installat ionis complete.

INSTALL_

PATH/CommandManager

MicroStrategy Command Manager f i les. This is the defaultdirectory for Command Manager but another locat ion can beselected during installat ion.

INSTALL_PATH/Help Documentat ion and Help for MicroStrategy products.

INSTALL_

PATH/GISConnectors

MicroStrategy Port let f i les. This is the default directory forthe Port lets but another locat ion can be selected duringinstallat ion.

INSTALL_PATH/IntelligenceServer/bin

Intell igence Server-specif ic binary f i les.

INSTALL_PATH/MobileMicroStrategy Mobile and Mobile Server JSP f i les. This isthe default directory for Mobile but another locat ion can beselected during installat ion.

INSTALL_

PATH/PDFGeneratorFilesSupport f i les (fonts) for the PDF generat ion feature ofIntell igence Server.

INSTALL_

PATH/ReleaseNotesMicroStrategy Readme for this release of MicroStrategyproducts.

INSTALL_PATH/PortletsMicroStrategy Port let f i les. This is the default directory forthe Port lets but another locat ion can be selected duringinstallat ion.

INSTALL_

PATH/SystemManager

MicroStrategy System Manager f i les. This is the defaultdirectory for System Manager but another locat ion can beselected during installat ion.

INSTALL_PATH/Usher MicroStrategy Ident ity f i les.

INSTALL_

PATH/WebServicesJ2EE MicroStrategy Web Services deployment path.

INSTALL_ MicroStrategy Web deployment path.




PATH/WebUniversal

INSTALL_PATH/_jvm

The Java Runt ime Environment (JRE) to be used by theJava applicat ions. I t provides the requirements forexecut ing a Java applicat ion, a Java Virtual Machine, coreclasses, and support ing f i les.

INSTALL_PATH/_uninst Launch f i les for uninstall ing MicroStrategy.

INSTALL_PATH/bin 64-bit binary f i les.

INSTALL_PATH/bin32 32-bit binary f i les.

INSTALL_PATH/help Online help f i les.

INSTALL_PATH/jar Java libraries.

INSTALL_PATH/lib 64-bit binary libraries.

INSTALL_PATH/lib32 32-bit binary libraries.

INSTALL_PATH/locale ODBC support messages.

LOG_PATHMicroStrategy applicat ion log f i les, which includesIntell igence Server log f i les.


After completing the steps to instal l MicroStrategy products, you can set upand configure your instal lation. To help guide the rest of your instal lationand configuration steps, refer to the section Instal l ing and ConfiguringMicroStrategy on Linux, page 137 in Chapter 1, Planning Your Instal lation,for an instal lation and configuration checkl ist.

To configure MicroStrategy Identi ty components, refer to the MicroStrategyIdenti ty Help guide.


https://microstrategyhelp.atlassian.net/wiki/display/USHER/

https://microstrategyhelp.atlassian.net/wiki/display/USHER/


Instal l ing and ConfiguringMicroStrategy Library

The MicroStrategy Library instal lation includes the MicroStrategy RESTServer as wel l as the MicroStrategy Col laboration Server, which enable thefol lowing functional i ties:

l Browse shared content: Users have access to their own l ibrary whereshared dossiers and documents are avai lable to be consumed.

l Search for dossiers: Users can easi ly search for dossiers wi th matchingcri teria such as dossier name, chapter/page name, etc.

l Manipulate the data view with visualizations and filters: Users canconsume the data in a dossier wi th visual ization and fi l ter manipulations.Every action is recorded in the metadata so that a user can resume fromthe last stopping point for the next login.

l Share dossier to other users: Users can share their dossier view toother users. Al l of the manipulations wi l l be carried over so that theyconsume the data based on same context.

l Interact with other users via comments and notifications(Collaboration Server): User can leave commentary, tag other users, andembed fi l ters to col laborate wi th other users wi thin any dossier.

The Col laboration Server also supports the fol lowing advancedfunctional i ties:

l Realtime monitoring of connected users: Every user that connects tothe Library Web or Mobi le appl ication is tracked by this service.

l Realtime monitoring of user comments: Users can create commentsassociated with each individual page. Users wi l l receive new commentsas they arrive without the need for refreshing. Persistence of comments.Comments persist for retrieval at a later time.



l Comments can contain "embedded objects" : Users can store fi l tersettings with a comment for another user to apply.

l User mention and notification : Users can send noti fication to anotheruser via user mention. In addi tion to " in-app" noti fication, users can alsobe noti fied by APNS (device noti fication) and emai l noti fication.

MicroStrategy Library ArchitectureThe fol lowing terminology wi l l help you to understand what is behind theCol laboration Server.

l Web Socket is a protocol providing ful l -duplex communication channelsover a single TCP connection. Web Socket is supported with al l majorbrowsers and can be used in mobi le appl ications. For Web Socket to workin an appl ication, an appl ication server (web server) needs to support i tas wel l .

If the Library cannot establish a Web Socket connection due to a blockedprotocol in an environment that contains load balancers, it attempts an HTTPconnection and uses a technique called "long polling" to simulate a real timemessage exchange.

l Node.js is an open-source, cross-platform runtime environment fordeveloping server-side Web appl ications. Node.js is the runtimeenvironment for hosting the MicroStrategy Col laboration Server.

The fol lowing diagram shows the Library archi tecture, including theCol laboration Server, shown in blue.

Messages flow in both directions of a Web Socket connection. TheMicroStrategy Col laboration Server manages which messages go to whichcl ients based on a publ ish-subscribe model . A cl ient appl ication maypubl ish a comment to a topic, and al l cl ients subscribed to the topic wi l l benoti fied.



MicroStrategy Library System Requirements

System RequirementsFor al l certi fied systems, see the Platform Certi fications dossier located inthe Readme.




Collaboration Serverl Node.js: Version 10.15.0 - 11.0

Library Administration Control Panel

You can access the Library Control Panel by navigating to<FQDN>:<port>/MicroStrategyLibrary/admin . The control panelal lows you to examine and configure settings for Library Server andCol laboration Server. Addi tional ly you can view the settings related tocommunication with the Intel l igence Server and configurations inMicroStrategy Library such as the Intel l igence Server cluster i t is connectedto.

Overview PanelThe Library Admin Overview panel provides the abi l i ty to examine themachine name, port, state, and Intel l igence and Col laboration Servers. Thetop right corner of each component displays i ts current status. Cl ick Edit tochange settings for Intel l igence Server and Col laboration Server. You canalso choose to expose or hide the Col laboration Service feature to users.



Configure Collaboration Server

To add a Col laboration Server, only the machine name (hostname) and portare required.

The Collaboration Server uses 3000 as the default port. If the administratoruses 0 as the port number when configuring the Collaboration Server, it will bereplaced with 3000.

Configure Intelligence Server

To add an Intel l igence Server, the administrator needs to speci fy themachine name (hostname), port, and TLS status.

The Intelligence Server uses 34952 as the default port. If the administratoruses 0 as the port number, the Library Server will try to connect to anIntelligence Server under port 34952.

Error / Warning Messages / Troubleshooting

Existing configuration issues wi l l be displayed as ei ther an error icon or awarning icon in the Overview page:

l Error icons in red : The system is not running as expected. Cl ick to viewa more detai led message.

l Warning icons in yellow: There are some minor issues that should beaddressed.

When you cl ick an error or warning icon, a pop up window wi l l display adetai led error message and provide some actions/l inks regarding how theissue happened and how to resolve that particular issue.



Timeout Settings

If you receive a Timeout Error in the Control Panel , modi fy the timeoutsettings in the Library Server configuration fi leconfigOverride.properties to a larger value. For example:

http.connectTimeout=5000

http.requestTimeout=10000

Library Server TabThe Library Server tab al lows an administrator to view their deployment'sLibrary URL, Web Server URL, configure authentication modes, securi tysettings, and access the Mobi le configuration l ink.



MicroStrategy Web

This provides a connection URL to MicroStrategy Web, which enables theWeb options in Library.

Authentication Modes

The Authentication Modes section gives an administrator to dictate whichauthentication modes they want to al low. When the authentication mode isupdated and saved, the server typical ly requires a restart.

Trusted authentication mode cannot be used in combination with any other login mode.

Security Settings

The fi rst securi ty settings section al lows administrators to al low Libraryembedding in other si tes. In other words, this section enables Cross-OriginResource Sharing (CORS) A mechanism that uses addi tional HTTPheaders to tel l a browser to let a web appl ication running at one origin(domain) have permission to access selected resources from a server at adi fferent origin. settings. You must enable your CORS settings to use



MicroStrategy products l ike HyperIntel l igence or MicroStrategy for Office orto embed a dossier in a websi te.

To enable CORS, select All. When this securi ty setting is updated andsaved, restart the Library appl ication.

Addi tional ly, the securi ty settings section al lows administrator to enter anoptional secret key which is used to al low sharing sessions betweenMicroStrategy Web and MicroStrategy Library.

Mobile Configuration

The mobi le configuration l ink provides with the mobi le server l ink whichcan copied and can be accessed.

Intelligence Server TabThe Intel l igence Server tab al lows the administrator to manage theIntel l igence Server Machine information.

It includes the fol lowing sections:



l Intelligence Server Machine Information

This section al lows for the input of Machine name and Port Number forthe Intel l igence Server.

l Intelligence Server Connection Settings

The Intel l igence Server Connection Settings tab al lows the administratorto configure the fol lowing parameters:

l Ini tial Pool Size

l Maximum Pool Size

l Request Timeout (socket connection request timeout is in mi l l isecondsfor the Intel l igence Server)

l Working Set Size (indicates the number of recent reports or documentsin memory for manipulation)

l Search Working Set Size (Indicates the maximum number of concurrentsearches which stay in memory)

Collaboration Server PanelThis panel displays the server URL and that state of the Col laborationServer machine. It also al lows the administrator to update the fol lowingsettings for the Col laboration Server that is currently connected:

l Enable logging

l Enable TLS

l Trusted Certi ficate Setting

In order to access this section, the communication between the Library Serverand the Collaboration Server needs to be established first: no errors orwarnings from the Library Server to the Collaboration Server on the overviewpage.



Collaboration Server Settings

Enable Logging

This setting can enable / disable diagnostic logging functional i ty in theCol laboration Server.

Enable TLS

Selecting this setting requires a keystore path and a passphrase.

Any changes to this section require the administrator to restart theCollaboration Server manually. Related warnings will be displayed on this pageuntil the restart is performed.

Trusted Certificate Setting

This section is only visible when the Col laboration Server targets a TLSenabled Library Server.

Installing MicroStrategy Library on Windows

Perform the fol lowing steps to instal l MicroStrategy Library on a Windowsserver.

1. Run the MicroStrategy instal ler by cl icking the setup.exe appl icationfrom the extracted zip fi le.

2. To instal l the MicroStrategy Library components, select the fol lowingfeatures when prompted.


l MicroStrategy Library Web & Mobi le




3. Cl ick Next

If the install does not complete successfully , review the install.log file forerrors. The log file is located in the MicroStrategy Common Files directoryC:\Program Files (x86)\Common

Files\MicroStrategy\install.log .

Deployment ScenariosAfter the instal lation of the MicroStrategy Library, appl icable defaul tdeployment wi l l be performed automatical ly. You may need to furtherconfigure the MicroStrategy Library Web/Mobi le Server and MicroStrategyCol laboration Server, depending on your environment and requirements.The fol lowing sections describe di fferent deployment scenarios:

Diagrams in the fol lowing sections include the fol lowing MicroStrategycomponents:



l Library Web application

A single page appl ication (SPA) that runs inside a web browser. It ispopulated by an ini tial connection to the MicroStrategy Library Server.

l Library Mobile application

A native mobi le appl ication that interacts wi th the same MicroStrategyLibrary Server.

l MicroStrategy Library Server

A Java-based HTTP web service that handles request for data from theMicroStrategy Library Web, MicroStrategy Mobi le, and Workstationappl ications.

l MicroStrategy Collaboration Server

A Node.js appl ication that establ ishes a persistent Web Socketconnection with the MicroStrategy Library Web/Mobi le appl ication. Itinteracts wi th a Col laboration Server reposi tory to persist col laborationdata and with the MicroStrategy Library Server as wel l .

l MicroStrategy Intelligence Server

A native OS appl ication that handles al l requests the metadata reposi toryand Data Warehouse transactions.

Default Windows Deployment

Default Product Folders

l C:\Program Files (x86)\MicroStrategy\Library

l C:\Program Files (x86)\MicroStrategy\Collaboration

Server



8.5.30\webapps\MicroStrategyLibrary



Default Registered Windows Services

l Library Server: Apache Tomcat 8.5 Tomcat8

l Collaboration Server: MicroStrategy Col laboration Server

MicroStrategy Library Server Configuration File

The MicroStrategy Library Server reads configuration settings from the fi leconfigOverride.properties . It also provides defaul t values for theconfiguration in the fi le configDefaults.properties . The fi leconfigDefaults.properties contains a key-value pair ofconfiguration options. To speci fy a configuration option, the desired key canbe copied from the configDefaults.properties and saved intoconfigOverride.properties with a value. For defaul t deployment, thetwo fi les are located in:



8.5.30\webapps\MicroStrategyLibrary\WEB-

INF\classes\config\configDefault.properties




INF\classes\config\configOverride.properties

If MicroStrategy Library is instal led separately from the Intel l igence Server,you need to manual ly configure the connection information by modi fying thefi le configOverride.properties . These are also the minimum valueswhich should be speci fied in configOverride.properties :

l iserver.default.hostname= <host or IP address of

Intelligence Server>

l iserver.default.port= <Intelligence Server Port>



If the MicroStrategy Col laboration Server is configured, and the fi leconfigOverride.properties is being manual ly set, the fol lowingconfiguration properties need to be speci fied:

l services.collaboration.enabled=true

l services.collaboration.baseURL= <

{PROTOCOL://HOSTNAME:PORT} The URL path to the

Collaboration Server>

l identityToken.secretKey= <Secret Key phrase (spaces

allowed) for Signing web token>

The configDefaults.properties should never be altered because itmay cause issues when migrating or upgrading an environment.

If the MicroStrategy Col laboration Server is instal led separately from theMicroStrategy Library, you need to manual ly configure the connectioninformation for Col laboration Server as wel l , by modi fying configurationproperty fi le located in: C:\Program Files

(x86)\MicroStrategy\Collaboration

Server\MicroStrategy\Collaboration Server\config.json .

The property needs to be speci fied: authorizationServerUrl:http://<FQDN>:<PORT>/MicroStrategyLibrary/api

All parameters in the config.json file are case sensitive.

The communication port must be available for Collaboration Server to bestarted.

The fol lowing diagram shows the defaul t deployment:



The communication between components is HTTP, not HTTPS. Thisdeployment is useful for initial testing in a lab environment, but notrecommended for production. For a production environment, where security isa priority , it is recommended to implement a secure deployment.

Windows Secure Deployment

A secure deployment is strongly recommended. In a secure deploymentscenario, you add HTTPS/TLS support to the Library appl ication. Theserver processes wi l l remain on the same machine, but wi l l communicatewith each other through a secure channel .

The fol lowing diagram shows the secure deployment:



Perform the fol lowing procedure to enable secure communication betweenthe Library appl ications and services on a Windows server. Theseinstructions assume that a defaul t deployment has already been completed,and Intel l igence Server has already been TLS enabled.

Prepare Files for Secure Deployment

Contact your system administrator to obtain the fol lowing fi les andinformation:

l A “key store” fi le in PKCS12 or PFX format which contains the private keyand the publ ic certi ficate for this machine. In the example this fi le issaved as keystore.pfx

Use this same fi le for both Col laboration Server and Tomcat.



The Col laboration Server only supports PKCS12 or PFX format.

l The passphrase used to create the key store fi le.

The passphrase is needed to read the contents of the key store. In theexample, the passphrase is "keystore_password".

l If the server certi ficate is not signed by a publ ic certi ficate authori ty, thencol lect the Root CA certi ficate in the chain. The 'certi ficate' fi le al lowsCol laboration Server to open a secure connection to the Library Server.

l A “trust store” fi le (that can be created from the certi ficates) and thepassphrase used.

The trust store fi le is used by the Library Server to open a secureconnection to the Col laboration Server.

This is only required if the certificate is not s igned by a public certificateauthority.

In the example, the fi le is saved as truststore.pfx and thepassphrase is "truststore_password".

Copy the fi les obtained in step 1 into the fol lowing directory:

C:\Program Files (x86)\MicroStrategy\Collaboration

Server

Set Up Secure JEE App Server

Configure Tomcat to use HTTPS to configure Tomcat to be a secureendpoint:

1. Open the fol lowing directory:


Files\MicroStrategy\Tomcat\apache-tomcat-9.0.12\conf

2. Open the server.xml fi le wi th a text edi tor.



3. Look for the Connector element whose port is 8443. Ensure i t is notcommented out. If Connector doesn't exist, add i t.

4. Edi t the 'keystoreFi le' and 'keystorePass' attributes of this element.

<Connector

protocol="org.apache.coyote.http11.Http11NioProtoco

l" port="8443" maxThreads="200" scheme="https"

secure="true" SSLEnabled="true"

keystoreFile="C:\Program Files

(x86)\MicroStrategy\Collaboration

Server\keystore.pfx" keystorePass="<keystore_

passphrase>" clientAuth="false" sslProtocol="TLS"/>

5. Save and close the fi le.

You can refer to more detai led instruction from Tomcat documentation.

Set Up Secure MicroStrategy Library Server

Modify the MicroStrategy Library Server settings to open a secureconnection to the Col laboration Server:

1. Navigate to the fol lowing directory:




INF\classes\config

2. Edi t configOverride.properties fi le:

services.collaboration.baseURL=https://<FQDN>:3000

// set tlsEnabled to true only when the certificateis not assigned by a public certificate authority

services.collaboration.tlsEnabled=true


https://tomcat.apache.org/tomcat-8.0-doc/ssl-howto.html


trustStore.path=\WEB-INF\truststore.pfx

trustStore.passphrase=<truststore_password>

All parameters are case sensitive. Read the instructions MicroStrategyLibrary Server Configuration Properties for more information.


4. Restart Tomcat Server.

5. Veri fy that the MicroStrategy Library Server is running:

l Open a web browser and enterhttps://FQDN:8443/MicroStrategyLibrary

l If you see login page, then MicroStrategy Library Server is working.

Set Up Secure Collaboration Server

Modify the Col laboration Server settings:

1. Edi t the config.json fi le located in:


Server

2. Insert the fol lowing l ines into the fi le. These reference the securi tyarti facts we created earl ier.

"enableTls": true,

"keystoreFile": "C:/Program Files(x86)/MicroStrategy/CollaborationServer/keystore.pfx",

"passphrase": "<keystore_passphrase>",



"trustedCerts": [ "C:/Program Files(x86)/MicroStrategy/CollaborationServer/certificate.pem" ]

All parameters are case sensitive. Read the instructions CollaborationServer Configuration Properties for more information.

3. Modi fy the authorizationServerUrl field in the config.json

fi le to speci fy “https” , the HTTPS port (8443) and replace “localhost”wi th the ful ly qual i fied domain name (FQDN) for this machine.

It should look l ike the fol lowing:

authorizationServerUrl:

https://<FQDN>:8443/MicroStrategyLibrary/api

4. Make sure the fi le is sti l l val id JSON. Copy the text into an InternetJSON val idator to veri fy.

5. Save the fi le.

6. Restart the Col laboration Server.

7. Veri fy that the Col laboration Server is running:

l Open a web browser and enter https://FQDN:3000/status

l If you see a web page (wi th no errors), then Col laboration Server isworking.

Note the following:

l JEE App Server – key store

This is used to establish the identity of the JEE App Server, which housesthe MicroStrategy Library Server. This is changed in a system configurationfile. For example, the server.xml file in a Tomcat installation.

l MicroStrategy Library Server – trust store


http://jsonlint.com/


Used to verify identity of the Collaboration Server and/or Intelligence Serverfor outgoing HTTPS/TLS calls when the Server certificate is not s igned by apublic certificate authority. The trust store is configured in theconfigOverride.properties file.

l MicroStrategy Collaboration Server – key store / certificate

The key store is used for trusted communication between the LibraryWeb/Mobile Client and the Collaboration Server. The certificate is used toverify the identity of the Library Server. The key store and certificates areconfigured in the config.json file.

Manually Deploy Library on a Windows Server

Collaboration Server Setup

If MicroStrategy Library Web is going to uti l ize col laborating features,perform the fol lowing steps to manual ly configure the Col laboration Server.

1. Browse to the Col laboration Server instal lation directory and open theconfig.json fi le.


Server

2. Edi t the config.json fi le in the fol lowing format:

{

"port": <COLLAB_SERVER_PORT>

"authorizationServerUrl": "{PROTOCOL}://{LIBRARY_HOSTNAME}:{LIBRARY_

PORT}/MicroStrategyLibrary/api",

"secretKey": "SOME SECRET KEY"

}

You may need to configure more settings in the config.json file. SeeConfiguring Col laboration Server for more information.



3. Restart Col laboration Server, and access {PROTOCOL}://{COLLAB_

SERVER_HOSTNAME}:{COLLAB_SERVER_PORT}/status to veri fy.

Deploy Library Web App

The following steps assume Tomcat service has been started.

1. Open <TOMCAT_INSTALLATION_DIRECTORY>\webapps , and pastethe copied MicroStrategyLibrary.war fi le.

2. Once the MicroStrategyLibrary folder is created, access LibraryAdministration Control Panel :

{PROTOCOL}://<FQDN>:<port>/MicroStrategyLibrary/admi

n with Tomcat administrator credentials.

3. In the Library Server Panel , under Securi ty Settings, create a 'secretkey'.

4. Configure Library Server, Intel l igence Server, and Col laborationServer connections.

5. Restart Tomcat service, and access{PROTOCOL}://<FQDN>:<port>/MicroStrategyLibrary toveri fy.

Configure Logging for Windows DeploymentFor defaul t deployment, log fi les are located in the fol lowing defaul tlocations:

l Instal l log: C:\Program Files (x86)\Common

Files\MicroStrategy\install.log

l Library Server log: C:\Program Files (x86)\Common

Files\MicroStrategy\Log\MicroStrategyLibrary-

MicroStrategyLibrary.log



l Col laboration Server log: C:\Program Files (x86)\Common

Files\MicroStrategy\Log\collabsrvr_nodejs.log

Collaboration Server Advanced Logging

To enable Col laboration Server advanced logging for troubleshootingpurposes:

1. Set the logging field to true in the config.json fi le in C:\Program

Files (x86)\MicroStrategy\Collaboration Server

2. Restart the service using the Services appl ication in the Control Panel .

Be sure to turn off the advanced logging after troubleshooting.

Installing MicroStrategy Library on Linux

1. Run the MicroStrategy instal ler:

Choose the setup.sh appl ication from the extracted zip fi le.

2. Fol low the instruction in the instal lation wizard:

To instal l the MicroStrategy Library components, select the fol lowingfeatures when prompted:


l MicroStrategy Library Web & Mobi le




3. Cl ick Next.

4. After selecting components to instal l , speci fy the Apache TomcatDirectory, for example:



If the install does not complete successfully , review the install.log file forerrors. The log file is located in <HOME_PATH>/log/install.log .

Deployment ScenariosAfter the instal lation of the MicroStrategy Library, appl icable defaul tdeployment wi l l be performed automatical ly. You may need to furtherconfigure the MicroStrategy Library Web/Mobi le Server and MicroStrategyCol laboration Server, depending on your environment and requirements.The fol lowing sections describe di fferent deployment scenarios:

Diagrams in the fol lowing sections include the fol lowing MicroStrategycomponents:

l Library Web application

A single page appl ication (SPA) that runs inside a web browser. It ispopulated by an ini tial connection to the MicroStrategy Library Server.



l Library Mobile application

A native mobi le appl ication that interacts wi th the same MicroStrategyLibrary Server.

l MicroStrategy Library Server

A Java-based HTTP web service that handles request for data from theMicroStrategy Library Web, MicroStrategy Mobi le, and Workstationappl ications.

l MicroStrategy Collaboration Server

A Node.js appl ication that establ ishes a persistent Web Socketconnection with the MicroStrategy Library Web/Mobi le appl ication. Itinteracts wi th a Col laboration Server reposi tory to persist col laborationdata and with the MicroStrategy Library Server as wel l .

l MicroStrategy Intelligence Server

A native OS appl ication that handles al l requests the metadata reposi toryand Data Warehouse transactions.

Default Linux Deployment

Default Product Folders

l <INSTALL_PATH>/LibraryWebMobile

l <INSTALL_PATH>/CollaborationServer

l <TOMCAT_INSTALL_

DIRECTORY>/webapps/MicroStrategyLibrary

Default URLS

l MicroStrategy Library Web application :http://<FQDN>:8080/MicroStrategyLibrary



l MicroStrategy Collaboration Server: http://<FQDN>:3000

l View the status of Collaboration Server: http://<FQDN>:3000/status

MicroStrategy Library Server Configuration Files

The MicroStrategy Library Server reads configuration settings from the fi leconfigOverride.properties . It also provides defaul t values for theconfiguration in the fi le configDefaults.properties . The fi leconfigDefaults.properties contains a key-value pair ofconfiguration options. To speci fy a configuration option, the desired key canbe copied from the configDefaults.properties and saved intoconfigOverride.properties with a value. For defaul t deployment, thetwo fi les are located in:

l <TOMCAT_INSTALL_

DIRECTORY>/webapps/MicroStrategyLibrary/WEB-

INF/classes/config/configDefault.properties

l <TOMCAT_INSTALL_


INF/classes/config/configOverride.properties

If MicroStrategy Library is instal led separately from the Intel l igence Server,you need to manual ly configure the connection information by modi fying thefi le configOverride.properties . These are also the minimum valueswhich should be speci fied in configOverride.properties :

l iserver.default.hostname= <host or IP address of

Intelligence Server>

l iserver.default.port= <Intelligence Server Port>

If the MicroStrategy Col laboration Server is configured, and theconfigOverride.properties is being manual ly set, the fol lowingconfiguration properties need to be speci fied:



l services.collaboration.enabled=true

l services.collaboration.baseURL= <

{PROTOCOL://HOSTNAME:PORT} The URL path to the

Collaboration Server>

l identityToken.secretKey= <Secret Key phrase (spaces

allowed) for Signing web token>

The configDefaults.properties should never be altered becauseit may cause issues when migrating or upgrading an environment.

If the MicroStrategy Col laboration Server is instal led separately from theMicroStrategy Library, you need to manual ly configure the connectioninformation by modi fying configuration property fi le located in <INSTALL_

PATH>/CollaborationServer/config.json .

The property needs to be speci fied: authorizationServerUrl:http://<FQDN>:<PORT>/MicroStrategyLibrary/api .



The fol lowing diagram shows the defaul t deployment:




Linux Secure Deployment

A secure deployment is strongly recommended. In a secure deploymentscenario, you add HTTPS/TLS support to the Library appl ication. Theserver processes wi l l remain on the same machine, but wi l l communicatewith each other through a secure channel .



Perform the fol lowing procedure to enable secure communication betweenthe Library appl ications and services on a Windows server. Theseinstructions assume that a defaul t deployment has already been completed,and Intel l igence Server has already been TLS enabled.

Prepare Files for Secure Deployment

Contact your system administrator to obtain the fol lowing fi les andinformation:

l A “key store” fi le in PKCS12 or PFX format which contains the private keyand the publ ic certi ficate for this machine. In the example this fi le issaved as keystore.pfx

Use this same fi le for both Col laboration Server and Tomcat.



The Col laboration Server only supports PKCS12 or PFX format.

l The passphrase used to create the key store fi le.

The passphrase is needed to read the contents of the key store. In theexample, the passphrase is "keystore_password".

l If the server/leaf certi ficate is not ul timately signed by a publ ic certi ficateauthori ty then col lect al l of the certi ficates in PEM format. This shouldinclude al l certi ficates in the chain. The 'certi ficate' fi le al lowsCol laboration Server to open a secure connection to the Library Server.

l A “trust store” fi le (that can be created from the certi ficates) and thepassphrase used.

The trust store fi le is used by the Library Server to open a secureconnection to the Col laboration Server.

This is only required if the certificate is not s igned by a public certificateauthority.

In the example, the fi le is saved as truststore.pfx and thepassphrase is "truststore_password".

Copy the fi les obtained in step 1 into the fol lowing directory:

<INSTALL_PATH>/CollaborationServer

Set Up Secure JEE App Server

Configure Tomcat to use HTTPS to configure Tomcat to be a secureendpoint:

1. Open the fol lowing directory:

<TOMCAT_INSTALL_DIRECTORY>/conf

2. Open the server.xml fi le wi th a text edi tor.

3. Look for the Connector element whose port is 8443. Ensure i t is not



commented out. If Connector doesn't exist, add i t.

4. Edi t the 'keystoreFi le' and 'keystorePass' attributes of this element.

<Connector

protocol="org.apache.coyote.http11.Http11NioProtoco

l" port="8443" maxThreads="200" scheme="https"

secure="true" SSLEnabled="true"

keystoreFile="<INSTALL_

PATH>/CollaborationServer/keystore.pfx"

keystorePass="<keystore_passphrase>"

clientAuth="false" sslProtocol="TLS"/>


You can refer to more detai led instruction from Tomcat documentation.

Set Up Secure MicroStrategy Library Server

Modify the MicroStrategy Library Server settings to open a secureconnection to the Col laboration Server:

1. Navigate to the fol lowing directory:

<TOMCAT_INSTALL_


INF/classes/config

2. Edi t configOverride.properties fi le:

services.collaboration.baseURL=https://<FQDN>:3000

// set tlsEnabled to true only when the certificateis not assigned by a public certificate authority

services.collaboration.tlsEnabled=true

trustStore.path=/WEB-INF/truststore.pfx

trustStore.passphrase=<truststore_password>


https://tomcat.apache.org/tomcat-8.0-doc/ssl-howto.html


All parameters are case sensitive. Read the instructions MicroStrategyLibrary Server Configuration Properties for more information.


4. Restart Tomcat Server.

5. Veri fy that the MicroStrategy Library Server is running:

l Open a web browser and enterhttps://FQDN:8443/MicroStrategyLibrary

l If you see login page, then MicroStrategy Library Server is working.

Set Up Secure Collaboration Server

Modify the Col laboration Server settings:

1. Edi t the config.json fi le located in:

<INSTALL_PATH>/CollaborationServer

2. Insert the fol lowing l ines into the fi le. These reference the securi tyarti facts we created earl ier.

"enableTls": true,

"keystoreFile": "<INSTALL_PATH>/CollaborationServer/keystore.pfx",

"passphrase": "<keystore_passphrase>",

"trustedCerts": [ "<INSTALL_PATH>/CollaborationServer/certificate.pem" ]

All parameters are case sensitive. Read the instructions CollaborationServer Configuration Properties for more information.

3. Modi fy the authorizationServerUrl field in the config.json



fi le to speci fy “https” , the HTTPS port (8443) and replace “localhost”wi th the ful ly qual i fied domain name (FQDN) for this machine.

It should look l ike the fol lowing:

authorizationServerUrl:

https://<FQDN>:8443/MicroStrategyLibrary/api

4. Make sure the fi le is sti l l val id JSON. Copy the text into an InternetJSON val idator to veri fy.

5. Save the fi le.


7. Veri fy that the Col laboration Server is running:

l Open a web browser and enter https://FQDN:3000/status

l If you see a web page (wi th no errors), then Col laboration Server isworking.

Note the following:

l JEE App Server – key store

This is used to establish the identity of the JEE App Server, which housesthe MicroStrategy Library Server. This is changed in a system configurationfile. For example, the server.xml file in a Tomcat installation.

l MicroStrategy Library Server – trust store

Used to verify identity of the Collaboration Server and/or Intelligence Serverfor outgoing HTTPS/TLS calls when the Server certificate is not s igned by apublic certificate authority. The trust store is configured in theconfigOverride.properties file.

l MicroStrategy Collaboration Server – key store / certificate

The key store is used for trusted communication between the LibraryWeb/Mobile Client and the Collaboration Server. The certificate is used to


http://jsonlint.com/


verify the identity of the Library Server. The key store and certificates areconfigured in the config.json file.

Manually Deploy Library on a Linux Server

Collaboration Server Setup

If MicroStrategy Library Web is going to uti l ize col laborating features,perform the fol lowing steps to manual ly configure the Col laboration Server.

1. Browse to the Col laboration Server instal lation directory and open theconfig.json fi le.

{INSTALL_PATH}/CollaborationServer

2. Edi t the config.json fi le in the fol lowing format:

{

"port": <COLLAB_SERVER_PORT>

"authorizationServerUrl": "{PROTOCOL}://{LIBRARY_HOSTNAME}:{LIBRARY_

PORT}/MicroStrategyLibrary/api",

"secretKey": "SOME SECRET KEY"

}

You may need to configure more settings in the config.json file. SeeConfiguring Col laboration Server for more information.

3. Restart Col laboration Server, and access {PROTOCOL}://{COLLAB_

SERVER_HOSTNAME}:{COLLAB_SERVER_PORT}/status to veri fy.

Deploy Library Web App

The following steps assume Tomcat service has been started.

1. Open <TOMCAT_INSTALLATION_DIRECTORY>/webapps , and pastethe copied MicroStrategyLibrary.war fi le.



2. Once the MicroStrategyLibrary folder is created, access LibraryAdministration Control Panel :

{PROTOCOL}://<FQDN>:<port>/MicroStrategyLibrary/admi

n with Tomcat administrator credentials.

3. In the Library Server Panel , under Securi ty Settings, create a 'secretkey'.

4. Configure Library Server, Intel l igence Server, and Col laborationServer connections.

5. Restart Tomcat service, and access{PROTOCOL}://<FQDN>:<port>/MicroStrategyLibrary toveri fy.

Configure Logging for Linux DeploymentLog fi les are located in the fol lowing defaul t locations:

l Instal l log: <HOME_PATH>/log/install.log

l Library Server log: <HOME_PATH>/log/MicroStrategyLibrary-MicroStrategyLibrary.log

l Col laboration Server log: <HOME_PATH>/log/collabsvr_nodejs.log

Collaboration Server Advanced Logging

To enable Col laboration Server advanced logging for troubleshootingpurposes:

1. Set the logging field to true in the config.json fi le in <INSTALL_

PATH>/CollaborationServer/config.json .

2. Restart the service using collaborationServer.sh restart .

Be sure to turn off the advanced logging after troubleshooting.



MicroStrategy Library Server ConfigurationProperties

The configOverride.properties is located in:

Windows: C:\Program Files (x86)\Common



INF\classes\config\configOverride.properties

Linux: <TOMCAT_INSTALL_DIRECTORY>/webapps/MicroStrategyLibrary/WEB-

INF/classes/config/configOverride.properties

This fi le includes the fol lowing properties related to authentication modes:

Property Specif ies

Authentication Mode Settings

auth.modes.available

The number of dif ferent authent icat ion modes exposedthrough the UI. Use commas to separate mult iplevalues.

l 1: I -Server standard authent icat ion

l 8: I - Server Guest Authent icat ion

l 16: I -Server LDAP authent icat ion

l 64: I - Server Security Plugin Authent icat ion(Trusted)

l 128: Kerberos Authent icat ion

l 1048576: SAML Authent icat ion

auth.modes.defaultWhich of the "available" modes (l isted above) is shownf irst (default ).

auth. t rusted.provider When Trusted authent icat ion is selected as available



Property Specif ies

or default authent icat ion mode, a provider of thisauthent icat ion must be chosen.

l 1: Tivoli

l 2: SiteMinder

l 3: Custom

l 4: OracleAccessManager

l 6: Ping

Intel l igence Server Configuration

iserver.default .hostnameThe hostname of the Intell igence Server to connect to.

Default : NONE (must provide value)

iserver.default .portThe port of the Intell igence Server to use.


iserver. init ialPoolSizeThe init ial pool size of HTTP(S) connect ion threads

Default : 10

iserver.maxPoolSize

The pool size of maximum allowed HTTP(S)connect ion threads

Default : 100

iserver. requestTimeout

Socket connect ion t imeout in mil l iseconds for I -Serverrequest

Default : 120000

iserver. t lsEnabled

Set to t rue if Intell igence Server is TLS enabled butwith a private Root CA cert if icate or a self -signedcert if icate. In this case, a trustStore f i le and itspassword must be provided For Intell igence Serverthat is TLS enabled with a public Root CA cert if icate,set to false.

Default : false



Property Specif ies

Collaboration Server Configuration

services.collaborat ion.enabledWhether the Collaborat ion Server is enabled

Default : false

services.collaborat ion.baseURLThe URL path to the Collaborat ion Server

Default : NONE

services.collaborat ion. t lsEnabled

Set to t rue if Collaborat ion Server is TLS enabled butwith a private Root CA cert if icate or a self -signedcert if icate. In this case, a trustStore f i le and itspassword must be provided For Collaborat ion Serverthat is TLS enabled with a public Root CA cert if icate,set to false.

Default : false

IdentityToken Configuration

ident ityToken.secretKey

Allow services such as Collaborat ion Server to validateuser session.

Secret key phrase (spaces allowed) for signing webtoken.


ident ityToken.algorithmToken Algorithm

Default : HS512

ident ityToken. t imeToLiveSecondsTime to live for token in seconds.

Default : 300

SSL/TLS Configuration

t rustStore.path

I f Intell igence Server and/or Collaborat ion Server isTLS enabled but with a private Root CA cert if icate or aself -signed cert if icate, a t rust store f i le is required.

The relat ive path (inside the WAR file) to the Trust



Property Specif ies

Store f i le.

Also, supports Opt ional pref ix classpath: (for aclass path resource) or file: (for an absolute path):

l Example (Relat ive path):trustStore.path=/WEB-

INF/truststore.pfx

l Example (absolute path - windows):trustStore.path=file:c:/tmp/truststor

e.pfx

l Example (absolute path - unix):trustStore.path=file:/tmp/truststore.

pfx

l Example (class path):trustStore.path=classpath:config/trus

tstore.pfx

Default : NONE

trustStore.passphrase

The passphrase used in the construct ion of the TrustStore f i le

Default : NONE

Server Configuration

session.workingSet

The number of recent reports/documents kept inmemory for manipulat ion. Wil l apply to all users whoconnect to the server

Default : 10

session.searchWorkingSet

The maximum number of concurrent searches whichstay in memory. Wil l apply to all users who connect tothe server

Default : 3

Web/Mobile Server Properties



Property Specif ies

mobile.conf igurat ion. folder

The relat ive path to Mobile resources (inside the WARfile)

Default : NONE

customCss.excludePluginsExclude the list of custom plugin folder to not load thecustom css f i les. This property wil l take a list ofcomma-separated customizat ion plugin names.

security.al lowAllOrigins

Specif ies valid parents domain origin that may beusing dossier embedded analyt ics. I f set to t rue, allthe origin wil l be allowed. This is not recommended.

security.al lowedOrigins = ht tps: / /www.google.com/ ,ht tps: / /www.google. f r/

security.al lowedOrigins

Specif ies valid parents domain origin that may beusing dossier embedded analyt ics. The list of allowedorigins wil l be appended to Content-Security-Policy=frame-ancestors. The request URLs af fected bythese constraints are def ined in the GlobalHeadersf i l ter of the web.xml

security.al lowedOrigins=ht tps: / /www.google.com/ ,ht tps: / /www.google. f r/

security.userInput .al lowHtmlOnPromptDesc

Conf igures whether or not to allow HTML on theprompt t i le and descript ion.

security.userInput .al lowHtmlOnPromptDesc=false

auth.kerberos.conf igThe conf igurat ion f i le locat ion.

auth.kerberos.conf ig=/opt / tomcat /krb5.conf

auth.kerberos.keytabThe host keytab locat ion.

auth.kerberos.keytab=/opt / tomcat / f i le.keytab

auth.kerberos.principal

Host Service Principal Name (SPN)

auth.kerberos.principal=HTTP/ l ive.demo.microst rategy.com



Property Specif ies

auth.kerberos. islnit iator{True/ false] miscellaneous opt ions

auth.kerberos. isInit iator=false

security.error.overridelserverErrorMessage

Conf igures whether to override the unhandled iservererror message with the customErrorMessage.

security.error.oerridelserverErrorMessage=false

Configuring Collaboration Server

Collaboration Server Configuration PropertiesSettings for the Col laboration Server can be changed by edi ting theconfig.json fi le. Al l parameters are case sensi tive and must be enteredcorrectly for changes to take effect.

The config.json can be found in:

Windows: <INSTALL_PATH>\MicroStrategy\CollaborationServer

Linux: <INSTALL_PATH>/CollaborationServer

This fi le includes the fol lowing properties:

Property Specif ies

Port and URL Properties

port The communicat ion port number

authorizat ionServerUrlThe URL endpoint of the MicroStrategy Library Server. I t shouldend with " /api" .

TLS Support Properties



Property Specif ies

enableTls

Whether TLS support is enabled

I f t rue, TLS support is enabled, assuming that either of thefollowing pairs of f ields are specif ied:

l privateKeyFile and publicCertFile

l keystoreFile and passphrase

The keystoreFile and passphrase propert ies have a higherpriority than the privateKeyFile and publicCertFile f ields.

I f omit ted or false, then TLS support is disabled.

privateKeyFile The path to the private key.

publicCertFile The path to the public cert if icate.

keystoreFile The path to the PKCS12 or PFX keystore f i le.

passphrase The passphrase used in the Cert if icate Signing Request (CSR)

trustedCerts

An array of paths (relat ive to the current directory) of t rustedcert if icate f i les.

This is only needed when Library Server is in HTTPS but with aprivate Root CA cert if icate or a self -signed cert if icate.

We do not need all cert if icates in the chain, but only the Root CAcert if icate.

Each Root CA cert if icate needs to be in its own PEM file.

Clustering Properties

scalingThe type of scaling to use. Values include "horizontal" , "vert ical" ,and "none". I f omit ted scaling defaults to "vert ical" , i f "cpus" isgreater than 1. Otherwise, it defaults to "none".

redisServerUrlThe URL of the Collaborat ion Cluster Cache (only supported withRedis Server). Only required if scaling is horizontal.

cpus The maximum number of worker processes to create on this



Property Specif ies

machine. A number greater than 0 specif ies the number of workerprocesses to create. A value of -1 indicates to create one workerprocess for each core on the machine. Defaults to 1.

User and Group Cache Properties

resetCacheIntervalA non-negat ive integer which specif ies the interval (in minutes) toreset the users and groups informat ion cache. Using a value of 0applies the default t ime of 1440 minutes(24 hours).

General Configuration Properties

logging Whether diagnost ic logging is enabled for the Collaborat ion Server.

socket loAn object which holds socket . io set t ings. Can set pingInterval andpingTimeout . { "pingInterval" : 25000, "pingTimeout" : 30000 }

Library Administration Support Properties

secretKey

To establish trusted communicat ion between Library Server andCollaborat ion Server, the value should be the same as that ofident ityToken.secretKey in the Library Server conf igurat ion f i le.

This t rusted communicat ion is required for conf iguring theCollaborat ion Server f rom Library Administ rat ion.

If the MicroStrategy Col laboration Server is instal led separately from theMicroStrategy Library, you need to manual ly configure the connectioninformation by modi fying configuration property fi le config.json . See the

appropriate Windows or Linux section for more information.

By defaul t, the Library is accessed using the fol lowing URL andcommunication port:

http://localhost:8080/MicroStrategyLibrary

By defaul t, the Col laboration Server is accessed using the fol lowing URLand communication port:



http://localhost:3000

To check the status of the Col laboration Server, you can visi t this URL:

http://localhost:3000/status

This only works from the machine where the MicroStrategy CollaborationServer is installed. To access it from another machine, replace "localhost" withthe fully qualified domain name (FQDN) of the machine.



Collaboration Server Command Line Administration ToolMicroStrategy Col laboration Server ships with i ts own command l ineadministration tool cal led admintool.js . This administration tool al lowsusers to search, view, and delete information in the Col laboration Serverreposi tory.

To invoke the Col laboration Server admin tool , you need to run the Node.jsexecutable and supply the fi le path for the admin tool and the Col laborationServer configuration fi le.

The Node.js executable (node.exe ) can be found here:

l Windows: <INSTALL_PATH>\CommonFiles\MicroStrategy\nodejs\node.exe

l Linux: <INSTALL_PATH>/NodeJS/<NODEJS_LINUX_VERSION>/bin/node

The admintool.js fi le can be found here:



l Windows: <INSTALL_PATH>\MicroStrategy\CollaborationServer\node_modules\mstr-collab-svc\admintool.js

l Linux: <INSTALL_PATH>/CollaborationServer/node_modules/mstr-collab-svc/admintool.js

The Col laboration Server configuration fi le (config.json ) can be foundhere:

l Windows: <INSTALL_PATH>\MicroStrategy\CollaborationServer\config.json

l Linux: <INSTALL_PATH>/CollaborationServer/config.json

Starting the Administration Tool

1. Open a terminal appl ication.

2. Enter the three fi le locations in the fol lowing format:

$ "<PATH_TO_NODE>" "<PATH_TO_ADMIN_TOOL_FILE>"

"<PATH_TO_CONFIG_FILE>"

You can add the Node.js executable to your PATH variable andchange to the Col laboration Server directory. If so, you can enter:$ node node_modules/mstr-collab-svc/admintool.js

config.json

The welcome page is shown in console after the tool starts.

Welcome to the Collaboration Server AdministrationTool (v10.xx.x.xxx)

Type "help" to list the available commands.

cmd>

Command List

The Admin Tool recognizes the fol lowing commands:



Command Result

help Shows help page.

quit Exits the tool.

exit Exits the tool.

migrate

Migrates exist ingCollaborat ion topics,invitat ions,not if icat ions, sessions,comments, bookmarks,and act ivity to theMicroStrategyRepository.

show

show summaryShows a summary ofthe database.

show topic <ID>

Shows informat ionabout topic with aspecif ic ID. This IDuniquely ident if ies thetopic. You can f ind theID by using the list ing ofa topic using one of theother commands.

show topics allShows informat ionabout all topics.

show topics empty

Shows informat ionabout topics that haveno commentsassociated with them.

show topics non-empty

Shows informat ionabout topics that havecomments associatedwith them.



Command Result

show comments for-topic <ID>Shows comments for aspecif ic topic.

show comments for-user <ID>

Shows comments madeby specif ic user. The IDrefers to theMicroStrategy UserDSS ID stored inMicroStrategymetadata.

show comments for-dossier <ID>

Shows commentsassociated with aspecif ic dossier (basedocument) ID stored inMicroStrategymetadata.

show comments older-than-date <ISO_

DATE>

Shows commentscreated before thespecif ied ISO 8601date. YYYY-MM-DDThh:mm:ssTZ.

drop

drop topics empty

Drops all the topics thathave no commentsassociated with them.

drop comments all Drops all comments.

drop comments for-topic <ID>Drops comments for aspecif ic topic.

drop comments for-user <ID>Drops comments for aspecif ic user.

drop comments for-dossier <ID>

Drops commentsassociated with aspecif ic dossier (base



Command Result

document).

drop comments older-than-date <ISO_

DATE>

Drops commentscreated before thespecif ied ISO 8601 date

The stored comments are organized into separate topics for eachdossier page. Use the for-topic <ID> commands work with pagesand the for-dossier <ID> commands to work on the enti redocument.

You can combine the condi tions for show comments and drop

comments . When multiple condi tions are used, all conditions must betrue to select the correct comments.

For example, drop comments for-user <UID> for-topic T

older-than-date 2018-01-01 wil l only drop comments that meetal l the three condi tions.

There is no confi rmation message for the drop command. Always showthe comments wi th the condi tion speci fied before you drop them toavoid errors.

Customizing Collaboration Server NotificationTo customize Col laboration Server noti fications, the Administrator needsthe fol lowing fi les:

l config.json

This config.json is not the Application-level configuration file.

l email-Invite.template

l email-Mention.template

By defaul t, they are located in these folders:



l Windows: <INSTALL_PATH>\MicroStrategy\CollaborationServer\node_modules\mstr-collab-

svc\pluginConfig\dossier

l Linux: <INSTALL_PATH>/Collaboration Server/node_

modules/mstr-collab-svc/pluginConfig/dossier

Out-of-the-Box Email Templates

Two Out-of-box templates are provided for User Invi te (email-Invite.template ) and User Mention (email-Mention.template )emai ls. They are wri tten in HTML and CSS. The Administrator can modi fyany i tem in the template or develop their own template based on these.

Configure Notifications – config.json

The config.json fi le is where Administrator can customize Col laborationServer Noti fications. Administrator can enable or disable noti fications,speci fy what emai l templates to use, modi fy the emai l subject and thedevice type for push noti fication.

config.json

{

"enabled": true,

"notification": {

"fromMention": {

"email": {

"enabled": true,

"templateFile": "email-Mention.template",

"subject": "You have been mentioned in a comment"

},

"push": {

"enabled": true,

"title": "You have been mentioned in a comment",

"deviceType": "MOBILE"

}



},

"fromInvite": {

"email": {

"enabled": true,

"templateFile": "email-Invite.template",

"subject": "You have been invited to view {{TEXT_DOSSIER_TITLE}} in

Library"

},

"push": {

"enabled": true,

"title": "You have been invited to view {{TEXT_DOSSIER_TITLE}} in

Library",

"deviceType": "MOBILE"

}

}

}

}

Changing a Communication PortFol low the instructions below to change a communication port:

l Collaboration Server: To change the communication port for theCol laboration Server, change the port property in the config.json fi leand restart the Col laboration Server.


The config.json fi le can be found in the fol lowing directory:

l Windows: <INSTALL_PATH>\MicroStrategy\CollaborationServer

l Linux: <INSTALL_PATH>/CollaborationServer/config.json

Be sure to open the Collaboration Server port in the firewall if you areemploying a firewall.



Cluster the MicroStrategy Collaboration ServerTo efficiently increase the number of concurrent users that col laborate inthe MicroStrategy Library appl ication, you can cluster the Col laborationServer. The MicroStrategy Col laboration Service can be clustered bothvertical ly and horizontal ly, depending on your needs.

Vertical Collaboration Server Cluster

In a Vertical Cluster, a single machine with multiple cores hosts a singleCol laboration Server which, in turn, spawns multiple processes to distributethe load in the server.

To cluster the collaboration vertically , you must have a machine with theMicroStrategy Library and the MicroStrategy Collaboration Server installed.



How to Cluster the Collaboration Server Vertically

1. Open the Library Administration Control Panel to veri fy your serversare running.

2. From the Control Panel , select Collaboration Server.

3. Under Scal ing Settings, select Vertical as the scal ing type.

4. From the Number of workers drop-down, select the number of CPUcores al located to the server.

5. Cl ick Save.


Horizontal Collaboration Server Cluster

In an Horizontal Cluster of Col laboration Servers, mul tiple servers arehosted on multiple nodes. You can create a functional horizontal clusterconfiguration in several ways. One way to configure horizontal ly is byrepl icating a single working node into multiple nodes under a loadbalancer.



In the diagram above, Node 1 and Node 2 represent machines in a networkthat host the horizontal cluster of Col laboration Servers.

Node 1 is obtained by performing a fresh instal lation of the MicroStrategyPlatform, so i t contains the MicroStrategy Library appl ication, theCol laboration Server, and the Intel l igence Server.

Node 2 can also be obtained by performing an instal lation of theMicroStrategy Platform, but i t is configured so the MicroStrategy Libraryappl ication points to the Intel l igence Server in Node 1 and theCol laboration Server points to the Col laborations Stores in Node 1. BothNodes operate wi th the same data.

Lastly, both nodes are configured under a load balancer to provide cl ientswi th a single entry point to the cluster.

How to Cluster the Collaboration Server Horizontally

1. Instal l the MicroStrategy Platform on a single machine. This becomesNode 1.

2. In the Library Administration Control Panel , a warning appears afterinstal l ing the MicroStrategy Platform indicating the Col laborationServer is not configured to the Library Server. Cl ick the warning

icon and select Yes.



3. Configure the load balancer on top of Node 1. This provides externalcl ients wi th a single entry point to the configuration.

4. From the Control Panel navigation, select Collaboration Server.

5. Under Col laboration Store Settings, modi fy the Machine Information toal low the Col laboration Server to uti l ize the Col laboration ClusterStore.

6. Under Scal ing Settings, select Horizontal as the scal ing type andenter your Cluster Cache.

7. Cl ick Save.


9. Instal l the MicroStrategy Platform on a new machine to introduceaddi tional nodes in the cluster. This becomes Node 2.

10. In Node 1, open WEB-INF/classes/config/configOverride.propertiesand copy the values in the fi le. Paste the values in theconfigOverride.properi tes fi le in Node 2. Cl ick Save.



11. In Node 1, open MicroStrategy/Collaboration

Server/config.json and copy the values in the fi le. Paste thevalues in the config.json fi le in Node 2.

Add a new property “host” under “dataSource”, set the value to be thehostname or IP of Node 1. Cl ick Save.

Copy the MicroStrategy/Collaboration Server/mstr_

collab_aes.key fi le from Node 1 to Node 2 and replace the one inNode 2.


13. In the load balancer's configuration fi le, add the Col laboration Serverand Library Server of Node 2. The load balancer now redirects cl ientrequests between Node 1 and Node 2.

To add more nodes to the configuration, repeat steps 9 through 13.



14. Cl ick Save.

See Troubleshooting Your MicroStrategy Library Instal lation i f needed.

Migrating Notifications

MicroStrategy Col laboration has been enhanced to use a central datareposi tory instal led as part of the MicroStrategy Platform. Starting inMicroStrategy 2020 the Col laboration Server constructs the connectionstring to the MicroStrategy Data Reposi tory during runtime. Afterperforming the upgrade, Col laboration Server wi l l only supportconnections to the MicroStrategy Data Reposi tory.

After upgrading Col laboration Server, the previous data reposi toryremains unchanged but i t wi l l not be used by the new version ofCol laboration Server. Any comments stored in the previous datareposi tory wi l l need to be moved to the new reposi tory to be accessible.

Migrating Comments to the MicroStrategy Data Repository

The Col laboration Server Administration Tool provides a way for systemadministrators to migrate comments from the previous data reposi tory to



the new data reposi tory. The Col laboration Administration Page wi l ldisplay a warning message when i t detects that a previous datareposi tory was used by the Col laboration Server before the upgrade.

The Col laboration Server Administration Tool is a console appl icationand wi l l connect to the data reposi tory using the same configuration asthe Col laboration Server so no user input is required to connect. Thetool wi l l provide feedback as data is being migrated and wi l l show amessage when the migration is complete.

In order to recover col laboration messages that were stored in theprevious version of the MicroStrategy Platform please fol low thesesteps:

1. Cl ick Start > Windows Administrative Tools > Services.

2. Stop the service MicroStrategy Col laboration/Real time Service.

3. Start the service Mongo DB.

4. Run the Data Migration Command:

l Enter the three fi le locations in the fol lowing format:



"C:\Program Files\MicroStrategy\Common

Files\MicroStrategy\nodejs\node.exe" "C:\Program

Files\MicroStrategy\Collaboration Server\node_modules\mstr-collab-

svc\admintool.js" "C:\Program Files\MicroStrategy\Collaboration

Server\config.json"

l Use the migrate command to run the data migration:

cmd> migrate



l Enter quit to close the Col laboration Server AdministrationTool .

5. Stop the service Mongo DB.

6. Start the service MicroStrategy Col laboration/Real time Service.

The Col laboration Admin Page wi l l stop displaying the warningmessage at this point.

MicroStrategy Col laboration has been enhanced to use a central datareposi tory instal led as part of the MicroStrategy Platform. Starting inMicroStrategy 2020 the Col laboration Server constructs the connectionstring to the MicroStrategy Data Reposi tory during runtime. Afterperforming the upgrade, Col laboration Server wi l l only supportconnections to the MicroStrategy Data Reposi tory.

After upgrading Col laboration Server, the previous data reposi toryremains unchanged but i t wi l l not be used by the new version ofCol laboration Server. Any comments stored in the previous datareposi tory wi l l need to be moved to the new reposi tory to be accessible.

Migrating Comments to the MicroStrategy Data Repository

The Col laboration Server Administration Tool provides a way for systemadministrators to migrate comments from the previous data reposi tory tothe new data reposi tory. The Col laboration Administration Page wi l ldisplay a warning message when i t detects that a previous datareposi tory was used by the Col laboration Server before the upgrade.

The Col laboration Server Administration Tool is a console appl icationand wi l l connect to the data reposi tory using the same configuration asthe Col laboration Server so no user input is required to connect. The



tool wi l l provide feedback as data is being migrated and wi l l show amessage when the migration is complete.

In order to recover col laboration messages that were stored in theprevious version of the MicroStrategy Platform please fol low thesesteps:

1. Stop the Col laboration service:

cd/opt/mstr/MicroStrategy/install/CollaborationServer/

./collaborationServer.sh stop

2. Start the previous data reposi tory:

cd/opt/mstr/MicroStrategy/install/CollaborationServer/MongoDB/

./mongod.sh start

3. Run the Data Migration Command:

l Enter the three fi le locations in the fol lowing format:



/opt/mstr/MicroStrategy/install/NodeJS/bin/node

/opt/mstr/MicroStrategy/install/CollaborationServer/node_

modules/mstr-collab-svc/admintool.js

/opt/mstr/MicroStrategy/install/CollaborationServer/config.json

l Use the migrate command to run the data migration:

cmd> migrate



l Enter quit to close the Col laboration Server AdministrationTool .

4. Stop the service Mongo DB.

5. Start the service MicroStrategy Col laboration/Real time Service.

The Col laboration Admin Page wi l l stop displaying the warningmessage at this point.

How to Set Up Application Servers

The sections below provide instructions for setting up di fferent appl icationservers to deploy MicroStrategy Library.

Deploy MicroStrategy Library on WebSphereThe steps below apply to WebSphere version 9.

Disable WebSphere's built-in JAX-RS.

1. In the IBM WebSphere Appl ication Server, expand Servers > ServerTypes > WebSphere Application Servers.

2. Under Appl ication servers, select <server name> .

3. Under Server Infrastructure, expand Java and Process Management.Choose Process definition > Java Virtual Machine > Customproperties.

4. Add a new property.

l Name:com.ibm.websphere.jaxrs.server.DisableIBMJAXRSEngi

ne

l Value: true



Add Properties to the Web Container Settings

1. Choose Servers > Server Types > WebSphere application serversfrom the WebSphere main configuration page.

2. Cl ick [YOUR SERVER].

3. Under Configuration , choose Container Settings > Web ContainerSettings > Web Container.

4. Choose Additional Properties > Custom properties.

5. Cl ick New.

6. Add the fol lowing fields and cl ick OK .

l Name: com.ibm.ws.webcontainer.emptyServletMappings

l Value: true

7. Cl ick OK .

8. Cl ick Save to the master configuration .

Add a Specific Web Container Custom Property

1. Choose Servers > Server Types > Application Servers.

2. Select the server used for Library.

3. Choose Web Container Settings > Web Container.

4. Cl ick Custom properties.

5. Cl ick New.

6. Enter the property values l isted in the fol lowing table.



Property Value

Name com.ibm.ws.webcontainer. invokeFlushAfterService

Value false

Descript ion See the corresponding IBM support page

7. Cl ick OK .

8. Cl ick Save.

9. Restart your appl ication server.

Install and Configure the War File

1. In the Select installation options screen of the WebSphereinstal lation process, make sure to enter the correct path in theDirectory to install application textbox and then cl ick Next.

2. On the Map virtual hosts for Web modules screen , select thecheckbox next to MicroStrategy Library and cl ick Next.

3. On the Map modules to servers screen , select the checkbox next toyour MicroStrategy Library instal lation and cl ick Next.

4. On the Map context roots for Web modules page, enter/MicroStrategyLibrary as the Context Root then cl ick Next.

5. Select the metadata-complete attribute checkbox next to yourMicroStrategy Library instal lation on the metadata for modules pageand cl ick Next.

6. Cl ick Finish and make sure to Save directly to the masterconfiguration.

7. Cl ick the Manage Applications link

or


http://www.ibm.com/support/docview.wss?uid=swg1PM50111


Choose Applications > WebSphere Enterprise Applications.

8. Cl ick Library War.

9. In the Detai l Properties section, cl ick Class loading and updatedetection .

10. Under Class Loader Order, select Classes loaded with local classloader first (parent last).

11. Cl ick OK .

12. In the Modules section, cl ick Manage Modules.

13. Cl ick Library Module.

14. In the Class Loader Order pane, select Classes loaded with localclass loader first (parent last).

15. Cl ick OK twice.

16. Cl ick Save.

17. Choose Select check box for MicroStrategyLibrary_war.

18. Cl ick Start.

Review the Server Class Loader Policy

1. Choose Server > Server Types > Application Servers > Your servername.

2. Ensure the Server-speci fic Appl ication Settings are in one of thefol lowing orders:

l Class loader pol icy is set to Multiple.

l Class loader pol icy is set to Single and the class loading mode isset to parent-last.


l Class loader pol icy is set to Multiple and the class loading mode ofal l appl ications, other than Library appl ications, is set to parent-first.

Deploy MicroStrategy Library on JBoss

Before Deploying the MicroStrategyLibrary.war Fi le:

Open /jboss-eap-

7.0/standalone/configuration/standalone.xml and search for" jaxrs" and disable fol lowing l ines:





Deploy by Exploded Folder:

1. Unzip MicroStrategyLibrary.war fi le as a folder, the folder nameis MicroStrategyLibrary.war .

2. Put the MicroStrategyLibrary.war folder under ./jboss-eap-7.0/standalone/deployments/ .

3. Download modules_config.zip and extract i t under the jboss-

eap-7.0/modules folder .

4. Download jboss-deployment-structure.xml and put i t underjboss-eap-

7.0/standalone/deployments/MicroStrategyLibrary.war/

WEB-INF/ .

5. In the ./jboss-eap-7.0/standalone/deployments/ foldercreate a marker fi le namedMicroStrategyLibrary.war.dodeploy .

6. After deploying the marker fi le would be updated toMicroStrategyLibrary.war.deployed , i f we want to redeploythe folder, just rename it as before.


7. Open MicroStrategyLibrary/admin page to configure connectionto Intel l igence Server and Col laboration Server.

Deploy MicroStrategy Library on Wildfly

Before Deploying the MicroStrategyLibrary.war Fi le:

1. Change directories to the folder where you want to unzip the WAR fi le.

2. Run ' jar xvf xxxxx.war ' to unzip the WAR fi le.

3. Modi fy the configOverride.properties fi le wi th Intel l igenceServer and Col laboration Server information.

4. Use 'jar -cvf xxxxx.war * ' to make the WAR fi le.

5. Place the new WAR fi le inside the folder.

Deploy the War Fi le:

1. Stop Wildfly.

2. Put the MicroStrategyLibrary.war fi le under ..\wildfly-10.1.0.Final\standalone\deployments folder.

3. Restart Wi ldfly.

Deploy MicroStrategy Library on Jetty

Please be aware that Jetty 9 is compatible on Java 8, not compatible on Java 9

Before deploying the .war fi le securi ty configuration of Jetty is necessary:

1. In the fi le [jetty_path]/etc/jetty.xml , between <Configure>

markers the fi le should have <Call name="addBean"> markerswhich should read:

<Call name="addBean"> <Arg> <New

class="org.eclipse.jetty.security.HashLoginService">

<Set name="name">Administrator Authentication



Area</Set> <Set name="config"><SystemProperty

name="jetty.home"

default="."/>/etc/realm.properties</Set> </New>

</Arg> </Call>

2. In the same /etc folder add a fi le realm.properties containingthe l ine:

admin: admin,server-administrator,content-

administrator,admin

This wi l l define a user, password, and a set of roles.

To deploy the MicroStrategyLibrary.war fi le:

1. Place the fi le into [jetty]/demo-base/webapps

2. Execute the fol lowing command:

java -jar ../start.jar --add-to-start=jmx

3. Go to the demo-base folder and execute the fol lowing command:

java -jar ../start.jar

Deploy MicroStrategy Library on WebLogic

WebLogic server level configuration

1. Change WebLogic startup mode to Production Mode for disabl ingWebLogic servlet reload check.

2. From the admin console web page, go to Domain Structure > base_domain and check Production Mode.

or

Set the PRODUCTION_MODE variable to true in the setDomainEnv

script in the directory DOMAIN_NAME/bin .

3. Restart the WebLogic server.



War fi le deployment

1. On a browser, open the WebLogic console.

2. Go to Deployments > Install.

3. Upload MicroStrategyLibrary.war .

4. Select the Install this deployment as an application option.

5. Leave al l other settings on the defaul t value and cl ick Finish .

6. From the deployed folder, change the necessary properties (Intel igeceServer hostname, Intel l igence Server port, etc.)

Sample deployment folder:

C:\Oracle\Middleware\Oracle_Home\user_

projects\domains\base_

domain\servers\AdminServer\tmp\.appmergegen_

1500564917141_dossier7391.war\WEB-

INF\classes\authConfig.properties

7. Restart the web server.

Deployment with War fi le exploded

1. On the machine where WebLogic is instal led, manual ly unzip theMicroStrategyLibrary.war fi le to a speci fic folder.

2. On a browser, open the WebLogic console.

3. Go to Deployments > Install.

4. Add the folder where the war is unzipped to the Path field.

5. Select the radio button next to <folder name> (open directory).

6. Select option Install as an application .

7. Select the setting to I will make the deployment accessible at



extracted folder.

8. Keep other defaul t deployment values and and cl ick Finish .

9. After the deployment is successful i t should appear as active andheal thy.

Sample deployment resul t:

http://localhost:7001/MicroStrategyLibrary

To access the URL, you may need to turn off firewall on the corp/labsenvironment

Linking MicroStrategy Library to MicroStrategy Web

After instal lation you can l ink MicroStrategy Library to MicroStrategy Web.

Ensure you have the Use Library priv ilege for all projects, so you can accessdossiers within all projects. See Privi leges in Library Web for more information.

1. In MicroStrategy Web, navigate to the General Project Defaul ts page.See the General Project Defaul ts topic in the MicroStrategy WebAdministrator Help for more information.

2. Enter the MicroStrategy Library URL into Link to MicroStrategyLibrary field, formatted as fol lows:

http://HOST_NAME:PORT/MicroStrategyLibrary/

This URL should be the externally facing URL that takes intoconsideration any networking infrastructure such as load balancers.


https://www2.microstrategy.com/producthelp/2020/WebAdmin/WebHelp/Lang_1033/Content/Welcome.htm

https://www2.microstrategy.com/producthelp/2020/WebAdmin/WebHelp/Lang_1033/Content/Welcome.htm


3. Save and apply this change to al l projects on the Intel l igence Server.

How to Enable Seamless Login Between Web, Library,and Workstation

Enabl ing seamless login al lows you to navigate between MicroStrategyWeb, Library, and Workstation without having to re-authenticate regardlessof your configured authentication mode. It uses an encrypted (secret) key tosecurely share the session among the appl ications.

For new instal lations of MicroStrategy 2020 seamless login wi l l beconfigured and active i f the prerequisi te components are instal led on thesame machine. Distributed environments and customers upgrading toversion 2020 need to configure the secret key by fol lowing the steps below.

Important ConsiderationsThe fol lowing are some points to keep in mind whi le configuring seamlesslogin between Web, Library, and Workstation.

l For Web and Library configuration, use the same Intel l igence Server.

l Once you configure seamless login between Web and Library, i t wi l l alsowork in Workstation.

l For col laboration to work properly, use the same secret key inconfig.json .

Cloud Environments

To Configure Web and Library Applications for Seamless Login

1. Launch MicroStrategy Web.

2. Go to Preferences.



3. Under Project Defaults > MicroStrategy Library configuration ,enter your Library URL.

<FQDN>:<port>/MicroStrategyLibrary/

4. Cl ick Apply.

5. In your cloud environment's homepage, hover over MicroStrategyWeb and cl ick Configure.

6. Cl ick Security.

7. Enter a new secret key into MicroStrategy Library configuration .A secret key should be between 5 and 30 characters long.

Keep the key for later.

8. Cl ick Save.

9. In your cloud environment's homepage, hover over Library, andcl ick Configure.

10. In the Library Server tab, in the MicroStrategy Web > Link field,enter the MicroStrategy Web l ink.

11. In the Security Settings > Secret Key field enter the secret keyfrom step 7.

12. Cl ick Save.

On-Premises Environments

To Configure the Secret Key Between Web and Library

If the secret key is not avai lable in theconfigOverride.properties fi le, you can add any phrase or



passcode to the parameter to be used as the secret key. A secret keyshould be between 5 and 30 characters long.

1. Open the Library configOverride.properties with a textedi tor.

2. Copy the token value from the identityToken.secretKey

parameter.

3. Open the Web Administration Page(<FQDN>:<port>/MicroStrategy/servlet/mstrWebAdmin ).

4. Select Security from the left-side navigation.

5. Under MicroStrategy Library configuration, enter your secret key.

6. Cl ick Save.

7. Restart your MicroStrategy Web server to apply the changes.

To Configure Web and Library Applications for Seamless Login

1. In MicroStrategy Web open Preferences > Project Defaults.

2. Enter your MicroStrategy Library URL(<FQDN>:<port>/MicroStrategyLibrary ) in the Link toMicroStrategy Library field.

3. Open the Library Administration Control Panel(<FQDN>:<port>/MicroStrategyLibrary/admin ).

4. Open the Library Server tab.

5. Enter your MicroStrategy Web URL into the Link field underMicroStrategy Web


http://www2.microstrategy.com/producthelp/Current/WebAdmin/WebHelp/Lang_1033/Content/Web_Admin_page.htm


(<FQDN>:<port>/MicroStrategy/servlet/mstrWeb ).

6. Cl ick Save.

Ensuring Images in MicroStrategy Web Work WithContent in the Library

The MicroStrategy Library and MicroStrategy Web are di fferent webappl ications that do not share a common images directory. As a resul t,documents and dossiers in MicroStrategy Web with images in them mayappear incorrectly in MicroStrategy Library i f the images are stored asrelative paths. To ensure that any documents or dossiers that you makeavai lable in MicroStrategy Library appear as expected with images, werecommend the fol lowing:

1. When creating documents and dossiers, i t is possible to embed imagesinto the content. When you do this, you insert an image into the contentvia upload and the image is referenced on disk via the MicroStrategymetadata. This is the recommended way of including images in yourcontent since i t ensures that both MicroStrategy Web and Library areable to commonly access the image. For images embedded in yourcontent in this method, the images wi l l work in both Web and Libraryand no further action is required.

2. The second way to include images in content is via an absolute pathreference. An absolute path reference typical ly looks l ike this,"https://www.microstrategy.com/getmedia/3534c22d-a593-4ecc-bbec-c8c6ac3deab5/logo.jpg" . Images referencedvia absolute paths wi l l also work in both Web and Library and nofurther action is required.

3. The thi rd way to include images in content is via a relative path.Whenever possible, we recommend you ei ther embed images in yourcontent, or use absolute path references. A relative path typical ly



looks l ike this, /images/logo.jpg . Relative paths point to locationsthat are relative to the appl ication that they were original ly created for.As a resul t, a relative path defined for MicroStrategy Web wi l l not workwi th MicroStrategy Library. This means that documents and dossiersdeployed on MicroStrategy Web with relative paths wi l l appear wi thbroken images. There are two ways to fix this:

l Replace al l of the relative paths with embedded images or absolutepaths. This is recommended when there are only a few impacteddocuments. However, i f you have many documents and dossiers inMicroStrategy Web with many relative path images, you should usethe next option.

l Copy or synchronize the /images directory from MicroStrategy Web tothe /images directory in MicroStrategy Library. This wi l l al low theLibrary to access the images required to render the documentscorrectly.

MicroStrategy Library Web Internationalization

There are 5 key aspects of international ization which are control led by twodi fferent settings in MicroStrategy Library Web:

Web Browser Language Setting

l Library Web Interface Language: This refers to the general interface ofthe Library Web appl ication.

l Number and Date Format: This refers to the data; speci fical ly to the datadefined as Date type or Numerical type.

l Intelligence Server Message Language: This refers to the Intel l igenceServer messages that are displayed in the Library Web appl ication.

MicroStrategy User Preferences



l Metadata Language: This refers to the translations of the variousmetadata objects. These translations are saved in the metadata database.

l Data Language: This refers to the translations of the actual datadisplayed in dossiers and documents. These translations are saved in thedata warehouse.

MicroStrategy User Preferences - LanguageFrom Developer, the administrator can set metadata and data languages foral l users at a speci fic project level : Project Configuration > Language >User Preferences.

From Developer, the administrator can also set metadata and datalanguages for a speci fic user at a speci fic project level : ProjectConfiguration > Language > User Preferences > User LanguagePreferences Manager > Modify.



From Platform Web, the administrator can set al l international izationsettings for a speci fic user at a speci fic project level : Web Preferences >User Preferences > General > Language.

Platform Web vs. Library Web Internationalization SettingsPlatform Web international ization settings are control led by MicroStrategyWeb User Preferences only. The Web browser language setting wi l l not



affect the international ization setting of Platform Web unless the metadatasetting is 'Defaul t'.

Load Balancer and Clustering Considerations forLibrary & Collaboration Server

When deploying MicroStrategy Library in a load balanced environment,there are several important points to consider:

1. In 2020, the MicroStrategy Col laboration Service can be clustered bothhorizontal ly and vertical ly. See Cluster the MicroStrategyCol laboration Server for instructions.

It can be deployed behind a load balancer, but i t rel ies on a RedisServer instance to ensure proper message distribution across al l of thevarious instances. The load balancer must uti l ize "sticky sessions" toensure that cl ients are directed to the instance which establ ished theini tial session. It should also support the Web Socket protocol (wss:),which rel ies on the HTTP 1.1 Upgrade protocol .

More detai ls on the Redis configuration are contained below.

2. The MicroStrategy Web and Library Server appl ications can beclustered behind a load balancer wi th any number of instances,however, the load balancer must uti l ize "sticky sessions" to ensurethat cl ients are directed to the instance which establ ished the ini tialsession.

3. When deploying a cluster of MicroStrategy Library Servers theCol laboration Servers should be configured to point to the Web loadbalancer, rather than a speci fic instance, to ful ly uti l ize the cluster.

4. To ful ly uti l ize a cluster of MicroStrategy Col laboration Servers, theMicroStrategy Library Server should be configured to point to the Webload balancer rather than a speci fic instance.



5. Since both web browsers and mobi le apps wi l l connect to i t di rectly,the MicroStrategy Col laboration Server port (defaul t :3000 ) must beaccessible and open through the load balancer.

The Collaboration Server port can be changed from the default value byspecify ing it in the config.json file.

6. Since both web browsers and mobi le apps wi l l connect to i t di rectly,the MicroStrategy Library Server (defaul t :8443 ) must be accessibleand open through the load balancer.

Deployment Topology

In the diagram, there is a single load balancer wi th an external facing DNSname, loadbalancer.acme.com which is used for both Library Serverand Col laboration Server configuration:



l The Library Server configOverrides.properties fi le uses thisname in the services.collaboration.baseURL property, as in:https://loadbalancer.acme.com:3000 .

l The Col laboration Server config.json fi le uses this name in theauthorizationServerUrl property, as in:https://loadbalancer.acme.com:8443/MicroStrategyLibrar

y/api .

In this configuration, the Col laboration Server speci fies horizontal scal ingby setting two properties in the config.json fi le:

l "scaling": "horizontal"

l "redisServerUrl":

"redis://sharedmachine.acme.com:6379"

In the diagram, there is a shared machine used by each of the instancesbehind the load balancer. On this machine, there are two essentialservices:

l MicroStrategy Reposi tory

l Redis Server - version 4.0.0 or higher.

In this environment, the shared service - Redis Server - may be repl icated.In this case, you must speci fy the correct URL in the config.json fi leproperties:

l "redisServerUrl" : "<Redis URL>"

Using the Collaboration Server Outside of a Load BalancedEnvironmentThe Col laboration Server can be run outside of a load balancedenvironment, on a single machine. To configure the Col laboration Server torun without any form of scal ing, set "scaling": "none" .

The Col laboration Server can also run multiple processes on the samemachine with vertical scal ing by setting the fol lowing config.json fields:



l "scaling": "vertical"

l "cpus": "<number of worker processes to launch>"

Load Balancer and Clustering for Library: Example SetupWorkflow

Install and Configure Redis Server

1. Download a proper Redis version and instal l , fol lowing instructionsfrom Redis Labs Ebook - Chapter Appendix.

2. Run Redis Server.

3. Check i f Redis is working properly by sending a 'PING' command inredis-cli .

A 'PONG' wi l l be responded i f Redis Server is good.

127.0.0.1:6379> ping

PONG

127.0.0.1:6379>

Col laboration Servers require a URL to connect to the running RedisServer for horizontal clustering purpose.

Example: redis://redis_host_machine:6379

Modify the Redis configuration fi le so i t can accept external traffic.

l In Redis configuration fi le (redis.conf or redis.windows-service.conf ), add/change the bind entry to bind 0.0.0.0

l Save modi fication and restart Redis Server


https://redislabs.com/ebook/appendix-a/


Configure Collaboration Server

1. For al l the Col laboration Servers instal led in di fferent machines, setRedis Server URL, web load balancer URL, clustering mode in theconfiguration fi les:

{

"port": 3000,

"logging": true,

"authorizationServerUrl":"<web_load_balancer_url>/api",

"scaling": "horizontal",

"redisServerUrl": "<redis_server_url>",

.......

}

2. Save configuration fi les and restart Col laboration Servers.

3. Make sure al l the Col laboration Servers are running properly byvisi ting their individual /status URL. It wi l l tel l the actual state of theCol laboration Server Instance. For example, the Col laboration Serverbelow is actual ly paused due to an unreachable Redis Server.

{

"version":"11.0.0.720",

"enableTls":false,

"scaling":"horizontal",

"logging":true,

"state":"paused",



"reason":"The following dependent services areunavailable: Redis Server",

"main":

{

"cpu":{"current":0,"max":17},

"memory":{"current":62758912,"max":85626880},

"connections":{"total":12,"current":4,"max":11},

"messages":{"processed":5},

"restCalls":{"received":3},

"up_since":"2018-4-18 02:12:42","pid":900

}

}

Configure Web Load Balancer Server

The load balancer must uti l ize "sticky sessions" to ensure that cl ients aredirected to the instance which establ ished the ini tial session. It should alsosupport the Web Socket protocol (wss:), which rel ies on the HTTP 1.1Upgrade protocol .

For example, fol lowing is the configuration for Horizontal ly clusteredCol laboration Servers, when using NGINX as web load balancer.

......

http {

......

upstream collabServer {

ip_hash; # this is a must, ensures that we are sticky to the IP to enable

a correct socket.io handshake



server collabServer1:3000; # provide the list of the Collaboration Servers

from here

server collabServer2:3000;

server collabServer3:3000;

}

location /socket.io/ { # API Pattern for socket.io handshake

proxy_http_version 1.1; # Required for proper HTTP upgrade protocol

proxy_set_header Upgrade $http_upgrade; # This is a Hop-by-Hop header–must

pass through manually

proxy_set_header Connection "upgrade"; # Another hop-by-hop header

proxy_pass http://collabServer/socket.io/; # Directs the request to a

server in upstream "collabServer"

}

location /status { # forward the /status API to one server from the

CollabServer list

proxy_pass http://collabServer/status;

}

......

}

......

Command Line Tools to Create Security Artifacts

There are several command l ine tools that assist in the creation of securi tyarti facts, most notably, openssl and keytool . Here is how we are usingthese tools to construct our own securi ty arti facts.

Creating a Key Store File Using Openssl> openssl pkcs12 –export –out KS_FILE –inkey PRIV_FILE –

in CER_FILE \ –passout file:PASS_FILE

Where:



l KS_FILE is the name of the key store fi le to create.

l PRIV_FILE is the path to the private key fi le.

l CER_FILE is the path to the publ ic certi ficate fi le.

l PASS_FILE is the path to the fi le that contains the passphrase to use.

Creating a Trust Store File Using Keytool> keytool –import –trustcacerts –alias collab-service \

–file CER_FILE –keystore TS_FILE –storepass PASS_PHRASE

–noprompt

Where:

l CER_FILE is the path to the publ ic certi ficate fi le.

l TS_FILE is the path of the trust store fi le to import into (or create).

l PASS_PHRASE is the actual pass phrase to use with the trust store.

You can create other securi ty arti facts, such as private key, Cl ient SigningRequest (CSR) and sel f-signed certi ficate using openssl .

Troubleshooting Your MicroStrategy LibraryInstallation

Issue: My Library is Empty1. Open the Library Administration Control Panel and check that

Intel l igence Server is configured and running.

2. No content has been added to your Library.

3. Monitor REST API error



When the Library Web appl ication behaves unexpectedly wi thout anyerror message, moni tor the error messages being returned from theMicroStrategy REST API using the web browser debugging tool .

1. From Chrome, open Developer Tools.

2. Open the Network tab.

3. Perform the steps to reproduce.

4. Check that al l of the requests are captured.

5. Cl ick a network request that you are interested in.

6. Within the request info window, open the Preview tab. This wi l ldisplay the response in JSON format.

7. Look for any network requests that are red, as this indicates thatthe REST API request may have fai led. If you are looking for APIerrors only, cl ick the XHR option so that the network tab displaysal l http(s) cal ls including the APIs.

4. Review the MicroStrategyLibrary error logs and look for any consoleerrors in the browser debugging tool .

5. Ensure you have the Use Library privi lege for al l projects (seePrivi leges in Library Web), so you can access dossiers wi thin al lprojects.

Issue: Collaboration Server is Unavailable1. If the Noti fication Icon is not avai lable:

l Go to the Library Administration Control Panel and configure theCol laboration Server.

l Ensure you have the Use Col laboration Services privi lege (seePrivi leges in Library Web).



2. If the Noti fication Icon is avai lable but disabled, the Col laborationServer is not connected. Cl ick the icon and use the error messagedialog to contact your administrator.

3. Monitor Web Socket error

When Col laboration Server features within the Library fai l wi thout adetai led error message, moni tor the error message directly from WebSocket messages using the web browser debugging tool .

1. From Chrome, open Developer Tools.

2. Open network tab.

3. Perform the steps to reproduce.

4. Fi l ter the request type by "WS" (WebSockets).

5. Cl ick on a network request.

6. Within the request info window, open the Frames tab. This wi l ldisplay the requests and responses in JSON format.

l If you don't see any request, refresh the page. It is possible that thebrowser debugging tool started capturing network calls after the WebSocket connection is established.

l If you don't see any requests even after refreshing, the communicationbetween the Library Web and Collaboration Server in your environmentis through HTTP polling instead of a Web Socket due to an environmentlimitation.

Common Configuration Errorsl The Col laboration Server is in a "paused" state because a dependentservice is down or unreachable. You can see this by inspecting the statuspage (for example, http://localhost:3000/status) and looking at the state(value is "paused") and reason fields. The reason wi l l explain the detai ls,for example:



l The fol lowing dependent services are unavai lable: AuthenticationServer

l The fol lowing dependent services are unavai lable: AuthenticationServer, MongoDB Server

l The fol lowing dependent services are unavai lable: MongoDB Server

l The "Authentication Server" refers to the "authorizationServerUrl"property in the Col laboration Server config.json fi le. Can you enterthis URL into a browser and see a JSON response?

l If the Tomcat service is not running, then i t needs to be started. For theCol laboration Server, the "authorizationServerUrl" refers to theMicroStrategy Library Server.

l The "MongoDB" service is defined in the config.json fi le by thedburl field. Are the machine and port correct? Are the user name andpassword values correct?

l Error indicating that the connection is refused, such as:

l Unable to invoke Authentication Server Method. Error: connectECONNREFUSED 127.0.0.1:8443 (code=ECONNREFUSED) Unable toconnect to the Authentication Server.

l Veri fy that the "authorizationServerUrl" uses the same machine nameas the "Common Name" associated with your certi ficate. In short, youcannot open a secure connection to a machine i f you don't have thecerti ficate for that same machine and the certi ficate is not signed by atrusted certi ficate authori ty.

l Error indicating a problem with the certi ficate, such as:

l Unable to invoke Authentication Server method. Error: unable to veri fythe fi rst certi ficate <code=UNABLE_TO_VERIFY_LEAF_SIGNATURE>.Unable to connect to the Authentication Server.



l Veri fy that the certi ficates speci fied in the Col laboration Serverconfig.json fi le are the same used to create the keystore fi le usedwith Tomcat.

Diagnose Collaboration Server Connection IssuesMicroStrategy instal lations provide a command l ine diagnostic tool fortroubleshooting Col laboration Server connection issues.

To invoke diagnostic tool :

Windows:

Change the current working directory to <MicroStrategy_install_

path>\node.js

Run the command: node "<MicroStrategy_installed_

path>\Collaboration Server\node_modules\mstr-collab-

svc\diagnose.js" "<MicroStrategy_installed_

path>\Collaboration Server\config.json" .

Linux:

Run the fol lowing command from the/opt/mstr/MicroStrategy/install/CollaborationServer

directory to launch the Col laboration Server's diagnostic tool :

./collaborationServer.sh diagnose

Invoking the diagnostic tool on a running system wi l l return the fol lowing:

l Both dependent servers wi l l show as Connected

l Col laboration server shows as Started and in a running state.

Collaboration Server Diagnostics

Dependencies:

√ Authorization Server: Connected



√ MongoDB Server: Connected

Collaboration Server: Started on port 3000(state=running)

l A l ist of trusted certi ficates with the name and expiration date (only i ftrusted certi ficates are set in config.json fi le)


Dependencies:



Collaboration Server: Started on port 3000(state=running)

Trusted CA Certificate Files: [1]

#1: mstrRootCA.cer: Success: 1 Certificate

+ 'MicroStrategy Root CA' is valid from: 4-Dec-2008 => 4-Dec-2018

Common Errors from the Diagnostic Tool

Collaboration Server Shows as Stopped


Dependencies:



Collaboration Server: Stopped

This means the Col laboration Server is not running. You need to start theCol laboration Server and re-run the diagnostic tool .



Collaboration Server State Shows as Paused: Authorization ServerNot Connected

Authorization Server hostname is found but hostname:port is notaccessible. Check that port number is correct.


Dependencies:

√ Authorization Server: Not Connected Unable toinvoke Auth Server: Unreachable: Either themachine/process is down or the port is inaccessible.

! MongoDB Server: Connected

server: [localhost:27017] on first connect[MongoError: connect ECONNREFUSED 127.0.0.1:27017]

Collaboration Server: Started on port 3000(state=paused)

Authorization Server hostname is found but hostname:port is notaccessible. Check that port number is correct.


Dependencies:

√ Authorization Server: Not Connected Unable toinvoke Auth Server: Call failed (statusCode=404)




Authorization Server hostname:port is accessible however i t's not a LibraryWeb server. The URL being used may be incorrect, even the hostname andport number is correct.




Dependencies:

√ Authorization Server: Not Connected Unable toinvoke Auth Server: getaddrinfo ENOTFOUND fakeurlfakeurl:80[code=ENOTFOUND]




Authorization Server hostname is not a val id domain/ip address. You needto veri fy the URL being used for Authorization Server.


Dependencies:

√ Authorization Server: Not Connected Unable toinvoke Auth Server: getaddrinfo ENOTFOUND fakeurlfakeurl:80[code=ENOTFOUND]




Missing proper certi ficate for the Authorization Server which is running withTLS enabled using some private root CA signed certi fates. You need to setproper values for the trusted certi ficate paths. See Col laboration ServerConfiguration Properties.


Dependencies:



√ Authorization Server: Not Connected Unable toinvoke Auth Server: unable to verify the firstcertificate [code=UNABLE_TO_VERIFY_LEAF_SIGNATURE]




Collaboration Server State Shows as Paused: MongoDB Server NotConnected

The hostname or port is not correct.


Dependencies:


! MongoDB Server: Not Connected Unable to connect toMongoDB server: failed to connect to server[fakedurl: 28017] on first connect

[mondoNetworkError: getaddrinfo ENOTFOUND fakedurlfakedurl: 28017]


Username or password is wrong: Authentication fai l


Dependencies:


! MongoDB Server: Not Connected Unable to connect toMongoDB server: authentication fail





You are using repl ica set for MongoDB but the setName does not match.


Dependencies:


! MongoDB Server: Not Connected Unable to connect toMongoDB server: setName from ismaster does not matchprovided connection setName [rs1] != [rss1]



Trusted CA Certificate Files

The diagonistic tool wi l l try to read each fi le path configured inconfig.json fi le as a trustedCert. There may be multiple certi ficates in asingle fi le. Here are the possible resul ts:

l Success

l Un-supported format

l Warning: Contains an expired certi ficate

l Inval id PEM block

l Success: 2 certi ficates

l Warning: Contains an expired certi ficate (There are 2 certi ficates insidethis fi le. One is val id and one is expired)



Troubleshooting through Collaboration Server LoggingIf Col laboration Server logging is enabled, the logs created byCol laboration Server wi l l provide more detai led information including:

l Running warnings and errors

l Request activi ties

l Noti fication records

See Configure Logging for MicroStrategy Library and Col laboration Serverfor more information.

Collaboration Service and MongoDB Server Shell ScriptsThe ./collaborationServer.sh and ./mongod.sh scripts can beused to resolve issued displayed by the diagnostic tool . Both scripts acceptthe fol lowing commands:

l start : Start the Col laboration or MongoDB server.

l stop : Stop the Col laboration or MongoDB server.

l status : Return the status of the Col laboration or MongoDB server.

l restart : Stop then start the Col laboration or MongoDB server.

Library Server to Collaboration Server Errors and Warnings

Warning: Secret Keys Do Not Match

Library Server and Col laboration Server need to be set up with the samesecret key (a string with a minimum of 5 characters) in order to veri fy theother server's identi ty. If the secret keys do not match, the Library Servercannot talk to the Col laboration Server. Functional i ty such as updating theCol laboration Server configuration in Administration Control Panel wi l l fai l .The Library Server i tsel f is okay to use.



Warning: Truststore is missing in Library Server

If the Col laboration Server is running with TLS enabled and is using aprivate root CA signed certi ficate, the Library Server is required to presentthe corresponding certi ficate in order to establ ish a secure communication.The administrator can configure a truststore fi le in the Library Server (seeMicroStrategy Library Server Configuration Properties). Fai lure to referencethe required certi ficate in the truststore wi l l lead to this warning. With thiswarning active, the Library Server cannot communicate with theCol laboration Server. Functional i ty such as updating the Col laborationServer configuration in Administration Control Panel wi l l fai l . The LibraryServer i tsel f is okay to use.

Warning: Cannot establish socket connection from browser to CollaborationServer

In some cases, the Library Server can talk to the Col laboration Server butend users (browsers) may fai l to establ ish communication to theCol laboration Server (fai lure to establ ish a socket connection). There arethree possible causes:



l The Library Server is running with TLS enabled (URL starting with 'https')whi le the Col laboration Server is running with TLS disabled (URL startingwith 'http'). Some browsers wi l l block any request to 'http' i f the currentwebsi te is using 'https'.

l The Col laboration Server is running with TLS enabled but using a privateroot CA signed certi ficate. Some browsers wi l l consider such private rootCAs as untrusted and block requests to those servers. The administratormay need to add those private root CAs into the trust l ist.

l The administrator may use a hostname l ike 'localhost' as the machinename for the Col laboration Server in the Library Server. That hostname isonly recognized by the Library Server and not accessible from other users(cl ient machine/browsers).



There may be two causes:

l Cannot find IP address for that hostname: end user can update thehosts fi le in system which can help system to resolve domain names toan IP address

l The IP address is not visible to end user: It may be a local ip addressor the port is not exposed to publ ic.

Collaboration Server to Library Server Errors and Warnings

Warning: The Collaboration Server is Not Targeted at the Current LibraryServer.

This is only a warning: the Col laboration Server is talking to a di fferentLibrary Server. The current Library Server is okay to use. Potential issuesmay occur when the two Library Servers provide di fferent data.



Error: The Collaboration Server is Not Targeted at the Current LibraryServer and the Target Library Server is Not Reachable.

For this case, the col laboration-related features in Library are not usablesince the Col laboration Server is paused due to this error. Theadministrator may choose to use the current Library Server as the targetLibrary Server for this Col laboration Server.

Error: Target Library Server is Not Reachable and Cannot be Set Up throughAdministration Control Panel

There are two cases when Admin UI can display issues about the currentCol laboration Server but cannot provide any solutions for the problem:

l Secret keys do not match between the Library Server and theCol laboration Server.

l The Col laboration Server is TLS enabled using a private root CA signedcerti ficate whi le the Library Server is missing the truststore for thatcerti ficate.

Both causes wi l l lead to the Library Server being unable to communicatewith the Col laboration Server and thus unable to control /updateCol laboration Server settings.



Error: The Collaboration Store is Not Reachable

The current Administration Control Panel does not expose an interface toupdate the Col laboration Store. The administrator can manual ly update i tthrough the Col laboration Server configuration.

Library Server to Intelligence Server Errors and Warnings

Error: Intelligence Server is Not Reachable

The administrator wi l l see this error message when the Library Server isunable to connect to the current Intel l igence Server.



The administrator wi l l see this error message when the Library Server isunable to connect to the current Intel l igence Server and Admin UI hassucceeded in a connection test using the hostname and port of the currentIntel l igence Server. This is most l ikely caused by using an incorrect TLSsetting.

Error: Minimum Version Requirement

If the Library Server has set a minimum Intel l igence Server versionrequirement and the current Intel l igence Server doesn't meet thatrequirement, this error message wi l l be displayed.



Certificate Store Integration with MicroStrategyLibrary

Certi ficate Store primari ly serves as a data source exposed via a RESTAPI. This data source provides the data for display within the Certi ficatespanel of Workstation.

Integration with MicroStrategy LibraryTo integrate Certi ficate Store with MicroStrategy Library, you can selectCerti ficate Store when instal l ing Library. This wi l l ensure that theCerti ficate Store REST API appears to be a part of the enti re MicroStrategyREST API sui te.

So whi le i t looks as i f the Certi ficate Store REST API(/api/serviceCertificates ) is served from the same web endpoint asthe other APIs, in real i ty requests made to the/api/serviceCertificates endpoint are actual ly redirected to theCerti ficate Store Server. This redirection is accompl ished by a proxy servletconfigured in the Library web.xml fi le.

The servlet is configured by the instal ler and takes al l URLs that match theurl -pattern property, and redirects them to the URL speci fied in thetargetUri property. If you are al tering these settings to add or removeSSL support, you must update the targetUri property so that i t speci fiesei ther "http" or "https".

If self-s igned certificates are used then the trustAllCertificates anddisableHostnameVerification properties must be set to true . If a user switchesfrom self-s igned to CA-assigned certificates, they should set both certificatesto false to receive the benefits of the CA-assigned cert.

<servlet>

<servlet-name>CertificateManagerService</servlet-name>


<servlet-class>org.mitre.dsmiley.httpproxy.ProxyServlet</servlet-class>

<init-param>

<param-name>targetUri</param-name>

<param-value>http://localhost:5050/api/serviceCertificates</param-value>

</init-param>

<init-param>

<param-name>log</param-name>

<param-value>true</param-value>

</init-param>



<init-param>

<param-name>truststorePath</param-name>

<param-value>{PATH_TO_TRUSTSTORE}</param-value>

</init-param>

<init-param>

<param-name>truststoreType</param-name>

<param-value>PKCS12</param-value>

</init-param>

<init-param>

<param-name>truststorePassword</param-name>

<param-value>{TRUSTSTORE_PASSWORD_OR_BLANK_IF_NONE}</param-value>

</init-param>

<init-param>

<param-name>keyPassword</param-name>

<param-value>{KEY_PASSWORD_OR_BLANK_IF_NONE}</param-value>

</init-param>



<init-param>

<param-name>trustAllCertificates</param-name>

<param-value>false</param-value>

</init-param>

<init-param>

<param-name>disableHostnameVerification</param-name>

<param-value>false</param-value>

</init-param>





</servlet>

<servlet-mapping>

<servlet-name>CertificateManagerService</servlet-name>

<url-pattern>/api/serviceCertificates/*</url-pattern>

</servlet-mapping>

Where:


l truststorePath is used to load the truststore which is handled byServletContext.getResourceAsStream() .

The path rules for this method can be found in the Oracle documentation.The path must begin wi th a slash (/ ) and is interpreted as relative to thecurrent context root or relative to the /META-INF/resources directoryof a JAR fi le inside the web appl ication's /WEB-INF/lib directory. Thepath separator is a slash (/ ) on both Unix and Windows.

l truststoreType accepts a variety of keystore/truststore types, for aful l l ist, see the Java SE Documentation. MicroStrategy supports JKS andPKCS12.

Certificate Store Configuration PropertiesSettings for the Certi ficate Store can be changed by edi ting theapplication.properties fi le. Al l parameters are case sensi tive andmust be entered correctly for changes to take effect.

The application.properties can be found in:

l Windows: <INSTALL_PATH>\MicroStrategy\CertificateManager

l Linux: <INSTALL_PATH>/Certificate Manager

This fi le includes the fol lowing properties:

Property Details Notes

server.address

IP address Cert if icateStore wil l use to listen forincoming REST APIrequests. By default thisis set to 127.0.0.1 torestrict access toprocesses on the samemachine.

I f you modify any of thesethree set t ings, be sure tomake the correspondingchange to the targetUri

property of the proxy servletdescribed above.


https://docs.oracle.com/javaee/7/api/javax/servlet/ServletContext.html#getResource-java.lang.String-

https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html



To listen on all IPaddresses, specify 0.0.0.0as the address.

server.port

IP port Cert if icate Storewil l use to listen forincoming REST APIrequests.

server.servlet.contex

t-path

Path to the Cert if icateStore endpoint .

server.ssl.key-store

The path to the PKCS12or PFX keystore f i le,

e.g.classpath:/opt/mstr

/MicroStrategy/inst

all/

your-cert.crt

These set t ings are relevantonly if Cert if icate Store'sREST API is running overHTTPS.

server.ssl.key-store-

password

Passphrase for thekeystore f i le

server.ssl.key-password

Passphrase for the keycontained within thekeystore

server.ssl.keyStoreTyp

e

Type of keystore, defaultis PKCS12

server.ssl.key-alias

Alias of key in keystore,used if keystore containsmult iple keys

max.certificate.retrie

val.time.seconds

Maximum amount of t imeto allow for ret rieval of allcert i f icates from def inedservices. Default is 30




seconds which should bemore than enough t imefor the services def ined in11.1.

consul.hostIP address of Consulagent These set t ings control which

Consul agent is contacted forthe list of def ined servicesand how often the agent iscontacted to refresh that l ist .The default set t ings shouldbe suf f icient for most installsand users should not need tochange them.

consul.port IP port of Consul agent

consul.initialDelay.mil

liseconds

Delay (in mil l iseconds)before init ial connect ionto Consul

consul.fixedRate.milli

seconds

Interval (in mil l iseconds)between each connect ionto Cosul

wss.server.host Socket . io IP address

These two set t ings controlthe Socket.io endpointthat GUIs can connect to toreceive async. updatesregarding the exist ingservices and the state of theircert if icates. Note that thef irewall must allowWebSocket access to thisendpoint (similar to theSocket.io connect ion inCollaborat ion Server)

wss.server.port Socket . io IP port




spring.mail.host Mail server IP address

These set t ings conf igure howCert if icate Storecommunicates to an emailhost . The default is to useSMTP but user must providethe IP address, etc. Bydefault this is not conf iguredby the installer and must bemanually enabled by theuser.

spring.mail.port Mail server IP port

spring.mail.protocolMail server protocol(SMTP)

spring.mail.properties

.mail.smtp.connectiont

imeout

Time out for connect ing tomail host

spring.mail.properties.

mail.smtp.timeout

spring.mail.properties

.mail.smtp.writetimeou

t

Time out sending data tomail host

spring.mail.default-

encoding

Encoding used to senddata to mail host

expiry.notification.da

ys

Cert if icate Store periodicallyscans the cert if icates it f indsto look for those that haveexpired or wil l expire withinthe next {expiry.notification.d

ays} days.

These set t ings control thiscert if icate scanning processand def ines which emailaddress wil l receive thenot if icat ions.

Mult iple email addressesmay be specif ied by comma-separated list , e.g.

expiry.not if icat [email protected] ,user2@doma




in.net

No not if icat ions are sent ifthe expiry.not if icat ion.emailis empty.

expiry.not if icat ion.email. f rom must be specif ied foremails to be sentsuccessfully.

expiration.check.initia

lDelay.milliseconds

Delay (in mil l iseconds)before cert if icates arescanned for expiredcert if icates.

expiration.check.fixed

Rate.milliseconds

Interval between eachscan for expired/expiringcert if icates.

expiry.notification.ema

il

expiry.notification.em

ail.from

profile.name

A Spring frameworkset t ing used to select aprof i le within theapplicat ion.

A prof i le collects dif ferentconf igurat ion propert iestogether in one f i le so theycan be applied together. I t 'snot recommended to changethe prof i le to anything otherthan prod.

Considerations in Clustered EnvironmentsThe Certi ficate Store process normal ly l istens for REST API requests onlocalhost:5050. The server is bound to the loopback interface so that onlyprocesses on the same machine may make API requests.

In a clustered environment, there is a Certi ficate Store process on eachnode. Because Certi ficate Store bui lds i ts data from the services registeredwith Consul , and Consul contains entries for al l nodes, Certi ficate Storewi l l contain entries for al l services in the cluster and not those services onthe current node. However, because some services are bound to theloopback address, some certi ficates wi l l not be retrievable from other nodesin the cluster.



Other Library ConsiderationsIf your Library instal lation does not have Certi ficate Store the proxy servletmay sti l l be configured, however the targetUri wil l not point to a val idendpoint. Users wi th this configuration wi l l receive a 502 Bad Gatewayerror (or other 5xx level HTTP errors). To resolve these errors, you caninstal l Certi ficate Store or remove the proxy servlet configuration from theLibrary web.xml fi le.



INSTALLING ANDCONFIGURINGM ICROSTRATEGYIDENTITY



MicroStrategy Identi ty includes the fol lowing MicroStrategy products:

l MicroStrategy Identi ty Securi ty Platform (which includes MicroStrategyIdenti ty Manager and MicroStrategy Identi ty Server)


l Platform Analytics

You can instal l MicroStrategy Identi ty as part of the enti re MicroStrategySecure Enterprise, or by i tsel f. If you choose to instal l i t alone, be awarethat certain MicroStrategy components are required for Platform Analyticsand MicroStrategy Communicator to operate properly; these componentsare instal led in the background.

If you are upgrading an existing MicroStrategy Identi ty instal l , see theUpgrade Guide.

Overview of Install

The high-level steps to instal l and configure MicroStrategy Identi ty are:

l Pre-Instal lation - Veri fy that you have the required information, and thatyour server is configured with the necessary software.

l Instal lation - Perform the instal lation.

l Post-Instal lation - Configure MicroStrategy Identi ty for your enterpriseenvironment.

For assistance with common issues, see Troubleshooting Information. If yourequire addi tional assistance, please contact Technical Support.

MicroStrategy Identity Pre-Installation Instructions

To prepare for instal lation, veri fy that you have the required information andthat your server is configured with the necessary software for MicroStrategy



https://www.microstrategy.com/us/services/support/contact


Identi ty. Review the l ist of common prerequisi tes and the prerequisi tes foryour speci fic environment (Windows or Linux) before instal lation:

Windows and Linux:

l You have an instal lation key.

l Setup the server wi th a ful ly qual i fied domain name (FQDN).

l Obtain the necessary SSL fi les.

l Open the required ports in the fi rewal l . See Defaul t Communication Ports.

l If SMTP requires SSL connection, obtain SMTP fi le server information:hostname, port, and user credentials for designated User Serveradministrator.

l You have veri fied that the instal l environment includes the necessarysoftware. See the "System Requirements" section of the Readme. Toveri fy the instal lation of your operating system.

l Linux: Run the fol lowing command: cat /etc/*-release .

l Windows: Run fol lowing command in a Command Prompt window:winver class="Note">

Windows PrerequisitesMySQL Open Source Components: Instal lation rel ies on MySQL opensource components that are not provided in the MicroStrategy instal ler, butcan be downloaded during instal lation. Please note that i f the server doesnot have Internet access you must manual ly copy the fol lowing fi les to theuser's Downloads folder:

l MySQL :

http://dev.mysql .com/get/Downloads/MySQL-5.6/mysql-5.6.28-winx64.zip

l MySQL Connector/ODBC 5.3.4:



http://dev.mysql.com/get/Downloads/MySQL-5.6/mysql-5.6.28-winx64.zip


https://dev.mysql .com/get/Downloads/Connector-ODBC/8.0.12/mysql-connector-odbc-8.0.12-winx64.msi

l MySQL Connector/Java 5.1.22:

http://dev.mysql .com/get/Downloads/Connector-J/mysql-connector-java-8.0.12.zip

l MySQL Connector/Python 2.1.3:

http://dev.mysql .com/get/Downloads/Connector-Python/mysql-connector-python-2.1.3-py2.7-winx64.msi

l MySQL time zone description tables:.

http://downloads.mysql .com/general /timezone_2015g_posix.zip

Linux Prerequisitesl You have Linux root user permission to complete the pre-instal lationsteps.

l If you are configuring Platform Analytics and MicroStrategy Communicatorafter instal l ing MicroStrategy Identi ty, you wi l l need to instal l Python 2.7.

l Do not save fi les in the /root/ folder path. Doing so wi l l prevent asuccessful instal lation.

Pre-installation Steps

Disable SELinux

1. Disable SELinux by navigating to:

/SELinuxinstallpath/selinux/config

2. In the configuration fi le, change:

SELINUX=enforcing to SELINUX=disabled


https://dev.mysql.com/get/Downloads/Connector-ODBC/8.0.12/mysql-connector-odbc-8.0.12-winx64.msi

https://dev.mysql.com/get/Downloads/Connector-ODBC/8.0.12/mysql-connector-odbc-8.0.12-winx64.msi

http://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.12.zip

http://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.12.zip

http://dev.mysql.com/get/Downloads/Connector-Python/mysql-connector-python-2.1.3-py2.7-winx64.msi

http://dev.mysql.com/get/Downloads/Connector-Python/mysql-connector-python-2.1.3-py2.7-winx64.msi

http://downloads.mysql.com/general/timezone_2015g_posix.zip


3. Reboot the machine. The change wi l l not be reflected unti l themachine is rebooted.

4. Veri fy that SELinux has been disabled:

sestatus

5. Restart the server to make the changes permanent.

Set Up Apache HTTP Server

To veri fy the version of the Apache HTTP server, enter the fol lowingcommand: > httpd -v

If you do not have the Apache HTTP server instal led, enter yum install

httpd , then enter the fol lowing command to start the service:

> service httpd start

Download and Set Up Java Runtime Environment

1. Veri fy whether the JRE is already instal led. Run the fol lowingcommand:

update-alternatives --config java

Server-JRE 8.x is recommended for this procedure.

2. Create a directory on your local computer where you want to instal l theJRE.

3. Choose ei ther the .tar.gz or .rpm fi le.

If using the .tar.gz fi le, the update-al ternatives tool wi l l need to beused to reconfigure the l inks to java tools. The command for this is asfol lows:

update-alternatives --install /usr/bin/java java



/usr/java/jdk1.8.0_172/jre/bin/java 10 \

--slave /usr/bin/jjs jjs /usr/java/jdk1.8.0_172/jre/bin/jjs \

--slave /usr/bin/keytool keytool/usr/java/jdk1.8.0_172/jre/bin/keytool \

--slave /usr/bin/orbd orbd /usr/java/jdk1.8.0_172/jre/bin/orbd \

--slave /usr/bin/pack200 pack200/usr/java/jdk1.8.0_172/jre/bin/pack200 \

--slave /usr/bin/rmid rmid /usr/java/jdk1.8.0_172/jre/bin/rmid \

--slave /usr/bin/rmiregistry rmiregistry/usr/java/jdk1.8.0_172/jre/bin/rmiregistry \

--slave /usr/bin/servertool servertool/usr/java/jdk1.8.0_172/jre/bin/servertool \

--slave /usr/bin/tnameserv tnameserv/usr/java/jdk1.8.0_172/jre/bin/tnameserv \

--slave /usr/bin/unpack200 unpack200/usr/java/jdk1.8.0_172/jre/bin/unpack200

4. To veri fy that the JRE was successful ly instal led, enter the fol lowingcommands:

> which java

> java -version

Download and Set Up Apache Tomcat

1. Navigate to http://tomcat.apache.org/download-80.cgi ,and under Core in Binary Distributions, download the .tar.gz fi le.



2. Create the directory /opt/bin , untar the .tar.gz fi le in /opt/bin tocreate apache-tomcat-8.x.x ; create a symbol ic l ink to thisdirectory cal led apache-tomcat-8 . To do this:

mkdir -p /opt/bin ; cd /opt/bin ; tar -zxvf

~/apache-tomcat-8.0.52.tar.gz ; ln -s

/opt/bin/apache-tomcat-8.0.52 /opt/bin/apache-

tomcat-8

3. Instal l thi rd-party l ibraries into the Tomcat directory, and note thelocation of the l ibraries.

a. Open each of the fol lowing websi tes, download the speci fied JARfi les, and instal l them in the Tomcat l ibrary:

l http://central .maven.org/maven2/com/io7m/xom/xom/1.2.10/xom-1.2.10.jar

l http://central .maven.org/maven2/jci fs/jci fs/1.3.17/jci fs-1.3.17.jar

l http://central .maven.org/maven2/wsdl4j /wsdl4j /1.6.2/wsdl4j -1.6.2.jar

l http://central .maven.org/maven2/mysql /mysql-connector-java/8.0.12/mysql-connector-java-8.0.12.jar

b. Compi le and instal l tomcat-native l ibraries:

l Instal l apr-devel , openssl-devel , and gcc . To do so:

yum install apr-devel, openssl-devel, and gcc

l Untar the tomcat native source. To do so:

cd /opt/bin/apache-tomcat-8/ ; tar -zxvf

bin/tomcat-native.tar.gz


http://central.maven.org/maven2/com/io7m/xom/xom/1.2.10/xom-1.2.10.jar

http://central.maven.org/maven2/com/io7m/xom/xom/1.2.10/xom-1.2.10.jar

http://central.maven.org/maven2/jcifs/jcifs/1.3.17/jcifs-1.3.17.jar

http://central.maven.org/maven2/wsdl4j/wsdl4j/1.6.2/wsdl4j-1.6.2.jar

http://central.maven.org/maven2/wsdl4j/wsdl4j/1.6.2/wsdl4j-1.6.2.jar

http://central.maven.org/maven2/mysql/mysql-connector-java/8.0.12/mysql-connector-java-8.0.12.jar

http://central.maven.org/maven2/mysql/mysql-connector-java/8.0.12/mysql-connector-java-8.0.12.jar


l Configure and compi le the tomcat native l ibraries. To do so:

cd tomcat-native-x.x.x-src/native ; ./configure

–with-java-home=/usr/java/jdk1.8.0_181/ ; make

; make install

l Copy the l ibraries to the tomcat l ibrary directory and/usr/lib64 . To do so:

cp /usr/local/apr/lib/libtcnative-1.*

/opt/bin/apache-tomcat-8/lib/cp

/usr/local/apr/lib/libtcnative-1.* /usr/lib64

4. Start Tomcat: > cd /(tomcat8)/bin .

5. Display the Tomcat browser: > ./startup.sh .

6. In a web browser, navigate to http://localhost:8080 .

7. Instal l Apache Tomcat Native Library. See Tomcat officialdocumentation for detai led information.

Set Up the Timezone on Linux

Set the system timezone to UTC localtime .

Enter the fol lowing commands:

> cd /etc

> rm localtime

> ln -s /usr/share/zoneinfo/UTC localtime

Set up the Fully Qualif ied Domain Name

The fol lowing procedure requires you to work with your IT department tochange the hostname. Addi tional ly, you must obtain a trusted vendor CA-signed certi ficate, as wel l as generate a sel f-signed certi ficate. Refer toyour company's IT pol icies for this section:


https://tomcat.apache.org/tomcat-8.0-doc/apr.html

https://tomcat.apache.org/tomcat-8.0-doc/apr.html


1. Contact your IT department for information about your company pol icyon Ful ly Qual i fied Domain Names (FQDN).

2. Change the Linux hostname to a FQDN, per your company's pol icy.Then have the new FQDN and IP address mapped.

3. Fol low the instruction of your IT department to obtain a CA-signedMicroStrategy Identi ty Server SSL/HTTPS certi ficate from a trustedvendor.

If you are asked for a certi ficate request that contains your companyinformation, perform the fol lowing steps:

1. Create and submit a certi ficate request (*.csr ) and private key(*.key ) to the vendor in the form requested.

2. Provide your company information to the certi ficate vendor. Thisinformation is incorporated into your certi ficate request.

4. Upon receiving your MicroStrategy Identi ty Server SSL/HTTPSCerti ficate and one or more Certi ficate Authori ty Certi ficates from thethi rd-party vendor, create a Certi ficate Authori ty Chain (*.pem) fi le bycombining these certi ficates (*crt) fi les. Enter the fol lowing command:

> cat <PathToCertFolder>/rootCA.crt

<PathToCertFolder>/intermediateCA.crt

<PathToCertFolder>/HTTPSServerCertificate.crt >

<PathToCertFolder>/UsherCAChain.pem

5. Create a sel f-signed signing CA certi ficate and append i t to the CAchain. See MicroStrategy Identi ty Administration

Install memcached

Optional ly, you can instal l memcached, which wi l l increase the speed oftransactions. After instal l ing memcached, you must configure the modulesfor MicroStrategy Identi ty.



1. Instal l memcached by using ei ther of the fol lowing methods:

l For yum, use the fol lowing command: > yum install

memcached php-pecl-memcache .

l For rpm, use the fol lowing command: > rpm -i memcached-

x.x.x-x.el6.x86_64 .

2. Configure memcached by changing the fol lowing in the memcachedfi le:

vi /etc/sysconfig/memcached

PORT="11211"

USER="memcached"

MAXCONN="1024"

CACHESIZE="64"

OPTIONS=""

3. Restart memcached by entering systemctl start memcached forRHEL 7.0+.

4. Veri fy that the server is running by veri fying the status:

For RHEL 6.8 and earl ier: service memcached status

For RHEL 7.0 and later: systemctl status memcached

Install and set up MySQL

Create a MySQL user and grant access to each MicroStrategy product.MicroStrategy supports MySQL Community Server version 5.6.23 andabove. If MySQL is already instal led, continue by instal l ing the MySQL YumReposi tory.

To check the version of MySQL, connect to the MySQL command cl ient andrun the fol lowing command:



SHOW VARIABLES LIKE "%version%";

1. In a web browser, navigate tohttps://dev.mysql.com/downloads/mysql . From the drop-down l ist, select the correct platform of MySQL Community Server foryour system. Find your operating system version, and download theRPM fi le.

2. Navigate to http://dev.mysql.com/downloads/repo/yum/ ,and download the correct RPM package for your system.

3. Open a command window and begin the instal lation by entering thefol lowing commands:

l For MySQL yum reposi tory, enter: > yum localinstall mysql-

community-release-el6-5.noarch.rpm

l For MySQL Community Server, enter: > yum install mysql-

community-server

l For MySQL JDBC connector, enter: > yum install mysql-

connector-java

l After instal lation, you must set the classpath for the JDBC connector,which depends on the type of shel l you are running:

n For bourne-compatible shel ls, enter: > export

CLASSPATH=/home/user/mysql-connector-java-5.1.34-

bin.jar:$CLASSPATH

n For C shel l , enter: > setenv CLASSPATH

/home/user/mysql-connector-java-5.1.34-

bin.jar:$CLASSPATH

l For MySQL ODBC connector, enter: > yum install mysql-

connector-odbc

l For MySQL python l ibrary, enter: > yum install mysql-python



l For MysQL PDO extension, enter: > yum install with-pdo-

mysql

4. Enter: > mysql_tzinfo_to_sql /usr/share/zoneinfo |

mysql -h127.0.0.1 -P3306 -uroot -p mysql to instal l theconvert_tz functions.

If an error message displays indicating that the function is unable to load,verify that the function has been properly installed. To do this, enter thefollowing command: > select convert_tz (current_

timestamp, 'utc','est) . If the file is timestamped, then it isinstalled.

5. To complete the instal lation process, restart MySQL.Enter:

service mysqld start

6. Set the root password for MySQL.

l Enter the fol lowing command: > mysql_secure_installation

l Enter: > mysql -u root -p , fol lowed by a password of yourchoice. Be sure to note the password, as i t is needed in later steps.

7. Create the MySQL user account that you wi l l use to grant privi leges tothe MicroStrategy products that you want to instal l :

l To create the mstr user, enter: > create user

'username'@'localhost' identified by 'password';

l To grant the mstr user access, enter: > grant all on *.* to

'username'@'localhost' with grant option;

8. If you intend to use MicroStrategy Identi ty wi th MySQL 5.7.4 andabove, the fol lowing l ine needs to be added or modi fied in the MySQLmy.cnf fi le:



sql-mode="STRICT_TRANS_TABLES,NO_AUTO_CREATE_

USER,NO_ENGINE_SUBSTITUTION" .

9. If you intend to implement MicroStrategy Identi ty Analytics, instal lcrontab for MySQL:

l Veri fy that this directory exists: > /usr/bin/mysql_tzinfo_to_

sql /usr/share/zoneinfo | /usr/bin/mysql -

h127.0.0.1 -P3306 -umstr -p mysql

l Begin the instal lation by entering: > yum install crontab*

l After the instal lation is complete, restart crontab by entering:service crond start

MicroStrategy Identity Installation Instructions

After completing the pre-instal lation steps, you are ready to begin theinstal lation.

For instal lation instructions, see the fol lowing:

l Windows: Instal l ing MicroStrategy on Windows

l Linux: Instal l ing MicroStrategy on Linux

Be sure to perform all prerequis ites and note MicroStrategy Identity-specificinformation in the installation instructions.

After completing the instal lation, you must perform the MicroStrategyIdenti ty Post-Instal lation Instructions.

MicroStrategy Identity Post-Installation Instructions

After you have instal led MicroStrategy Identi ty, you must deploy andcomplete the configuration of the MicroStrategy Identi ty Server and Identi tyManager.



To deploy your MicroStrategy Identity Server (Linux)

1. In a command window, navigate to the instal lation location of theMicroStrategy Identi ty Server:

> cd

/

installationpath

/Usher/UsherServer/usherApps/shardIDM/bin

2. Start Tomcat by entering the fol lowing command:

> ./tomcat.sh start

After starting Tomcat, the ROOT.war folder should be extractedautomatical ly under:

<

serverpath

>/Usher/UsherServer/usherApps/shardIDM/webapps

If Tomcat does not start, see the catalina.out log located at<

serverpath

>/Usher/UsherServer/usherApps/shardIDM/logs to viewdetails of the problem.

3. Copy the logback classic 1.1.2 JAR fi le from the Tomcat directory toyour MicroStrategy Identi ty Server root. To do this, enter the fol lowingcommand:

> cp /<localdirectory>/apache-tomcat-

8.0.26/lib/logback-classic-1.1.2.jar /<serverpath

>/Usher/UsherServer/usherApps/shardIDM/webapps/ROOT/

WEB-INF/lib



4. Restart the MicroStrategy Identi ty Server to make the changespermanent. Enter the fol lowing commands:

l > cd

/<

serverpath

>/Usher/UsherServer/usherApps/shardIDM/bin

l > ./tomcat.sh restart

5. Veri fy that the MicroStrategy Identi ty Server has restarted. In a webbrowser, navigate to:

https://<FQDN>:<1-way port>

where

<FQDN> is your domain name

<1-way port> is your SSL one-way port number (1443 is thedefaul t one-way port)

6. After the server is deployed, navigate back to the MicroStrategyIdenti ty Configuration tool . Fi l l out the required fields wi th yourcompany information to receive the activation key for your server.

To enable HTTPS for MicroStrategy Identity Manager (Linux)

Enabl ing HTTPS for MicroStrategy Identi ty Manager is optional . If you electto enable HTTPS, then you must also enable SELinux.

To enable HTTPS

1. Instal l ssl_module by entering the fol lowing command:

> yum install mod_ssl

2. Veri fy that the module was enabled during instal lation:

> httpd -M | grep ssl_module



3. Using Vim or any other fi le edi tor, open the Identi ty Managerconfiguration located at/etc/httpd/conf.d/manager.usher.com.conf and update thenecessary fi le parameters.

The fi le should look simi lar to the fol lowing:

Listen 443 # Verify both ports are the Identity

Manager port

<VirtualHost *:443>

SSLEngine on

SSLCertificateFile

<PathToCertFolder>/HTTPSServerCertificate.crt #

Verify this path is valid

SSLCertificateKeyFile

<PathToCertFolder>/HTTPSServerCertificate.key #

Verify this path is valid

SSLCACertificateFile

<PathToCertFolder>/UsherCAChain.pem # Add this path

if not already present

SetEnvIf Usher-Agent ".*MSIE.*" nokeepalive ssl-

unclean-shutdown

Alias /networkmanager

/usher/MicroStrategy/install/Usher/UsherNetworkMgr/n

etworkmanager

# Verify this path is valid

<Directory

/usher/MicroStrategy/install/Usher/UsherNetworkMgr/n

etworkmanager> # Verify this path is valid

AllowOverride All

Require all granted

</Directory>

</VirtualHost>




To enable SELinux

1. Open the SELinux config fi le:

vi /etc/selinux/config

2. Replace disabled:

SELINUX=disabled -> SELINUX=enforcing ,

3. Restart SELinux to make the changes.

How to complete Configuration (Windows and Linux)

Before you begin:

l SSL port numbers from your MicroStrategy instal lation steps

l MicroStrategy Identi ty Server SSL/HTTPS Certi ficate (.crt) and PrivateKey (.key) fi les

l Signing Certi ficate (.crt) and Private Key (.key) fi les

l SMTP server

l Google Maps API key (i f you plan to use MicroStrategy Identi ty Managerand Google Maps)

1. Open the MicroStrategy Identi ty Manager page by entering thefol lowing in a web browser:

http<s>://<FQDN>:<port>/networkmanager/managesystem

2. Enter your MicroStrategy Identi ty Server URL and one-way port,making sure you use your FQDN (for example,https://<FQDN>:1443 ), and cl ick Enter.

If you enter an IP Address instead of your FQDN, you will not be able toproceed.



3. In the License Key field, provide your instal lation key (universal orMicroStrategy Identi ty), and cl ick Log In .

4. Fi l l out the fol lowing fields wi th your company information:

l Identity Server Host: Your auto-populated FQDN and one-way portnumber. This value cannot be edi ted.

l System Name: A description of the MicroStrategy Identi ty Serverinstance as i t wi l l appear in MicroStrategy Badge.

l Identity File Directory: Keep the defaul t value.

l SSL Certificate Authority Certificate: Your sel f-signed .crtcerti ficate that was generated using OpenSSL.

l SSL Certificate Authority Key: Your sel f-signed *key that wasgenerated using OpenSSL.

l SSL Certificate Authority Key Password : If you have a passwordfor your key, select the Required check box, and then enter yourpassword. If you did not assign a password, leave this field blank.

l AES Key: Your encryption key generated during the MicroStrategyIdenti ty Server instal lation. Keep the defaul t value.

l SAML Certificate: Your trusted vendor CA-signed .crt.

l SAML Key: The key for the trusted vendor CA-signed certi ficate.

l SMTP Server: Your company's SMTP server.

If you do not set the SMTP server and port, MicroStrategy IdentityServer cannot send emails.

l Port: Your company's SMTP server port.



l SMTP Authentication : If your server is password protected, selectthe Required check box. Enter your username and password in thecorresponding fields.

l SMTP Configuration : Leave this field blank.

l Email Sender Address:The emai l address that you are using tosend the badge invi tations for the MicroStrategy Identi ty network.

l Identity Server Host: Keep the defaul t URL and enter theMicroStrategy Identi ty Server two-way SSL Port value (defaul t valueis 2443). For example, <FQDN>:2443 . For the Identi ty Server Host,https:// is not needed.

l Gateway Host: Keep the defaul t URL and enter your Agent Gatewayport value (defaul t value is 9501). For the Gateway Host, https://is not needed.

l Gateway Load Balancer: Keep the defaul t URL and enter yourAgent Gateway port value to match the values for Gateway Host.

l Google Maps API Key: If you are using Google Maps for yourMicroStrategy Identi ty Network, enter the thi rd-party key.

l Memcached : No node is required for the MicroStrategy Identi tyconfiguration.

l iPad Configuration Link: If you have already set up MicroStrategyCommunicator, enter your iPad URL l ink. This l ink comes from theMicroStrategy Mobi le configuration.

l iPhone Configuration Link: If you have already set upMicroStrategy Communicator, enter your iPhone URL l ink. This l inkcomes from the MicroStrategy Mobi le configuration.



l Support Email: The emai l address that wi l l be displayed inMicroStrategy Badge and used as the defaul t address to sendsupport emai ls.

l Support Phone Label: The label for the support number that wi l l bedisplayed in MicroStrategy Badge. The defaul t is "Phone Number".

l Support Phone: The support number that wi l l be displayed inMicroStrategy Badge.

l Push Notification-based Capabilities: This service is not requiredto configure MicroStrategy Identi ty.

5. Cl ick Next.

6. Fi l l in the fol lowing fields:

l Identity Manager Host: Your FQDN URL. Keep the defaul t value.

l Identity Manager Path : Keep the defaul t value.

l Identity Server Host: Your Identi ty Server address.

l Certificate Path : Leave this field blank.

l Network Creation : If you do not want users to create their ownnetwork on your Identi ty Server, select the Require Authenticationcheck box.

l MicroStrategy Managed Instance: If your system is housed inAmazon Web Services, select the Restrict LDAP Configurationcheck box.

l Help Page Base URL : Leave the defaul t value.

l Plugin Host Server: Keep the defaul t value.

l Google Client ID : If you have a business Google Drive account,enter your Google ID number.



l Google Client Secret: If you want to import users from your GoogleDrive account, enter their information.

l Salesforce Client ID : If you have an executive Salesforce accountfor your company, enter your Salesforce ID Number.

l Salesforce Client Secret: If you want to import users from yourSalesforce account, enter their information.

7. To save your changes and complete the configuration, cl ick Done.

8. Restart the service:

Windows: From the Start button, choose Administrative Tools >Services. Right-cl ick on the Apache Tomcat 8.0 shardIDM serviceand select Restart.

Linux:

> cd

/<

serverpath>/Usher/UsherServer/usherApps/shardIDM/bin

> ./tomcat.sh restart

9. Cl ick Create an Admin . If you need to return to this step later, type thefol lowing into the browser:http<s>://<

FQDN>:<port>/networkmanager/firstUA/create .

10. To upload a photo for the Admin account, cl ick to select a fi le.Supported image formats are .png, .jpeg, and .jpg.

11. Enter your fi rst and last name.

12. In the Email Address field, type the emai l address you want to usewith your Admin account.



13. Cl ick Create.

You wi l l receive an emai l invi tation to obtain your badge.

14. Open the emai l in your smartphone, then cl ick Get My Badge.

15. In a web browser, navigate to the MicroStrategy Identi ty Manager homepage http<s>://<FQDN>:<port>/networkmanager , and scanthe QR code displayed.

After you log in, you can create securi ty networks and add users.

To create addi tional administrators, see MicroStrategy Identi tyAdministration.

To synchronize Identi ty wi th an existing IDM, see Synchronizing users fromMicrosoft Active Directory.

To set up your MicroStrategy Identity Gateway (Windows and Linux)

After you have configured the MicroStrategy Identi ty Server and NetworkManager, deploy the Gateway.

For Linux:

1. In a command window, navigate to the MicroStrategy Identi ty ServerGateway using the fol lowing:

cd

/<installpath>/Usher/UsherServer/usherApps/shardGate

way/bin

2. Start Tomcat:

> ./tomcat.sh start

This deploys the gateway.war fi le.

For Windows and Linux:


https://www2.microstrategy.com/producthelp/Usher/latest/Content/USHER/synchronizing-users-microsoft-active-directory_9405091.htm

https://www2.microstrategy.com/producthelp/Usher/latest/Content/USHER/synchronizing-users-microsoft-active-directory_9405091.htm


1. Check to confi rm that the gateway was deployed successful ly. In abrowser window, type the fol lowing command:

https://<FQDN>:<port>/gateway/test/

2. You can conduct a message push test to veri fy that the gateway hasstarted. Type a phrase in the Message field, and cl ick Send to test.

To set up an active directory wi th your MicroStrategy Identi ty Network,configure your MicroStrategy Mobi le Server, or for any other MicroStrategyIdenti ty Manager Help, see the MicroStrategy Identi ty Help guide.

Troubleshooting Information

For MicroStrategy Identi ty administration processes, see MicroStrategyIdenti ty Administration.

Installation Error CodesFor an explanation of the error codes (0 - 24) displayed by the Linuxinstal ler, see TN300224.

Default Communication PortsWhen using MicroStrategy Identi ty, you need to ensure that certain portsare avai lable. The defaul t ports are:

l 3443 - the port used by MicroStrategy Identi ty Manager

l 443 - an SSL-enabled port used for cl ient-server communication with theMicroStrategy Identi ty Server

l 2443 - an SSL-enabled port for two-way (mutual) authentication with theMicroStrategy Identi ty Server

l 9501 - an SSL-enabled port used for communication with theMicroStrategy Identi ty Gateway


https://www2.microstrategy.com/producthelp/Usher/latest/Content/USHER/usher-help_491573.htm

https://community.microstrategy.com/s/article/ka1440000009E4dAAE/KB300224-What-do-the-different-error-codes-mean-in-the


SSL Certificate VerificationYou can veri fy your SSL certi ficates using the fol lowing command:

openssl veri fy -CAfi le file [path_to_your_pem ] [path_to_your_cert ]

For detai ls, see the OpenSSL documentation.

LogsMicroStrategy Identi ty components log information about their operations.When troubleshooting issues, you can review the logs for each component.

Database logs

Before the database is created, error messages related to MicroStrategyIdenti ty Manager may be found in usher_network_manager.log .

When instal led, the MySQL instance includes a schema usher_server_logwhich includes logs for activi ties performed through the MicroStrategyIdenti ty Server. The logs for MicroStrategy Identi ty Manager are located in adi fferent schema and table: usher_network_manager.usher_network_log .

Server-side logs

The fol lowing is a l ist of server-side logs and their defaul t locations. IfMicroStrategy Identi ty is not instal led in the defaul t location, use the folderdescriptions to determine where to look.

MicroStrategy Identi ty automatical ly archives many of i ts server logs on adai ly basis. Older logs are located in the same folder, but the name wi l linclude the date.


https://www.openssl.org/docs/manmaster/man1/verify.html


l MicroStrategy Identity Server Tomcat log

n Location : MicroStrategy Identi ty Server Tomcat logs folder

l Windows: C:\Program Fi les (x86)\MicroStrategy\Usher\MicroStrategyIdenti ty Server\usherApps\shardIDM\logs\catal ina.out

l Linux:/opt/MicroStrategy/Usher/UsherServer/usherApps/shardIDM/logs/catalina.out

l MicroStrategy Identity Server API log

n Location : MicroStrategy Identi ty Server Tomcat logs folder

l Windows: C:\Program Fi les (x86)\MicroStrategy\Usher\MicroStrategyIdenti ty Server\usherApps\shardIDM\logs\info.log

l Linux:/opt/MicroStrategy/Usher/UsherServer/usherApps/shardIDM/logs/info.log

l MicroStrategy Identity Gateway Tomcat log

n Location : MicroStrategy Identi ty Gateway Tomcat logs folder

l Windows: C:\Program Fi les (x86)\MicroStrategy\Usher\MicroStrategyIdenti ty Server\usherApps\shardGateway\logs\catal ina.out

l Linux:/opt/MicroStrategy/Usher/UsherServer/usherApps/shardGateway/logs/catal ina.out

l MicroStrategy Identity Gateway API log

n Location : Root Tomcat logs folder (Windows) or MicroStrategy Identi tyGateway Tomcat logs folder (Linux)

l Windows: C:\Program Fi les (x86)\CommonFi les\MicroStrategy\Tomcat\apache-tomcat-8.0.30\logs\gateway.log



l Linux:/opt/MicroStrategy/Usher/UsherServer/usherApps/shardGateway/logs/gateway.log

MicroStrategy Badge logs

When an error appears in MicroStrategy Badge, you can trigger the app tocreate an emai l wi th the log fi le as an attachment.

How to report an issue with a MicroStrategy Badge log

1. Open the Settings tab in MicroStrategy Badge.

2. Scrol l down to the Contact Us section and tap Report a Problem.

3. From the pop-up menu, tap the most relevant category.

4. In the Let us know what happened field, describe the issue.

5. Cl ick Send .

Your smartphone's emai l cl ient wi l l automatical ly launch a draft emai laddressed to the support contact for your issue. The subject and body arepre-populated, and the app log is included as an attachment.

Once the emai l is sent, recipients can open the log fi le in a text edi tor toview the contents.

PHP DownloadDownload and set up PHP

You may encounter problems while setting up PHP. To troubleshoot errormessages, see your IT department and third-party reference material.



1. Use your subscription manager to enable SCL:

subscription-manager repos --enable rhel-server-

rhscl-6-eus-rpms

2. Enter the fol lowing yum instal lation commands to instal l php 7.2 andmodules:

yum install php72 php72-php php72-php-gd php72-php-

mbstring

3. Instal l the updates database module for MySQL:

yum install php54-php-mysqlnd

4. Disable the loading of php 2.3 Apache:

mv /etc/httpd/conf.d/php.conf

/etc/httpd/conf.d/php.conf.old

5. Restart Apache to make the changes:

service httpd restart

6. After the instal lation is complete, enable mod_rewri te. To do this, enter/InstallPath/etc/httpd/conf/httpd.conf to modi fy the fi le.The parameters are as fol lows:

<Directory "/var/www/html">

Options FollowSymLinks

AllowOverride All

</Directory>

7. Veri fy that the required PHP modules have been instal led correctly.



8. Enter the fol lowing commands:

l php -v to check the version of PHP.

l php -m to check the modules instal led:

l curl

l zlib

l openssl

l gd

l mbstring

l mysql

l pdo-mysql

l zip

l PDO

l exit

l php -r 'print_r(gd_info());' to veri fy the GD version andJPEG support.

9. Execute the fol lowing command to add/etc/httpd/conf/httpd.conf :

LoadModule php5_module modules/libphp5.so

AddType application/x-httpd-php .php

10. Enter the fol lowing command s to create test.php in/var/www/html :

<?php

phpinfo();



?>

11. Restart the service to complete the changes.

12. In a web browser, navigate to http://localhost/test.php . Youshould see the PHP landing page, which signals that the veri fication issuccessful .



ACTIVATING YOURINSTALLATION



After your MicroStrategy instal lation is complete, you have 30 days toactivate your instal lation. Before you activate your instal lation you mustrequest an Activation Code from MicroStrategy. You can complete thisrequest when you instal l MicroStrategy with the MicroStrategy Instal lationWizard or after the instal lation using MicroStrategy License Manager.

This section describes the fol lowing procedures:

l Request an Activation Code, page 356

l Activate Your Instal lation, page 358

For answers to commonly asked questions about server activation, seeServer Activation FAQ, page 360.

Request an Activation Code

You can request an Activation Code by supplying MicroStrategy withimportant information related to your instal lation. The information youprovide helps MicroStrategy understand how you plan to use MicroStrategysoftware. With this information MicroStrategy can provide better informationand technical support for your software configuration.

On Windows, MicroStrategy products can be activated only in graphics userinterface (GUI) mode, using License Manager.

MicroStrategy products can be activated on Linux, ei ther in GUI mode or incommand l ine mode, using License Manager. In both cases, LicenseManager runs and requests the same information. The main di fferences arein how you provide the information and navigate through the ActivationCode request steps.

Request an Activation Code with License Manager

If you requested an Activation Code during instal lation you can skip thisprocedure and activate your instal lation by fol lowing the instructions in thenext procedure, Activate your software instal lation, page 358.



1. Open MicroStrategy License Manager:

l Windows: Go to Start > Programs > MicroStrategy Tools >License Manager. License Manager opens.

l Linux: License Manager can be run in GUI mode or command l inemode.

n GUI: In a Linux console window, browse to HOME_PATH whereHOME_PATH is the speci fied home directory during instal lation.Browse to the folder bin and type ./mstrlicmgr , then cl ickEnter. The MicroStrategy License Manager opens in GUI mode.

n Command line: In a Linux console window, browse to HOME_PATH

where HOME_PATH is the speci fied home directory duringinstal lation.Browse to the folder bin and type ./mstrlicmgr -

console , then cl ick Enter. The MicroStrategy License Manageropens in command l ine mode.

The steps to request an Activation Code in command line mode ofLicense Manager vary from the steps below. Refer to the LicenseManager command line prompts to guide you through the steps torequest an Activation Code. For more information specific torequesting an Activation Code for your installation in command linemode, refer to MicroStrategy Tech Note TN13550.

2. Select the License Administration tab. Under Server Activation selectthe Activate Server Installation option and cl ick Next.

3. Select the Generate Activation File and Request Activation Codeoption and cl ick Next .

4. Enter the characteristics of your server instal lation and cl ick Next .

5. Enter the contact information for the person who instal led the software.Make sure to correctly select whether you are an employee of thel icensed company or instal l ing the software on the l icensed company's



behal f.

l If you select that you are an employee of the l icensed company, cl ickNext. Once you complete the fol lowing step, the Activation Code issent to the emai l address given; therefore i t is important that theemai l address is val id and entered correctly.

l If you select that you are not an employee of the l icensed company,a contact information page is displayed after you cl ick Next. Enterthe contact information for the l icensed company. Cl ick Next. Onceyou complete the fol lowing step, the Activation Code is sent to theemai l address given; therefore i t is important that the emai l addressis val id and entered correctly.

6. Select Yes, I want to request an Activation Code now and cl ickNext.

An emai l containing the Activation Code is sent to the emai l address oraddresses you confi rmed in the steps above.

Activate Your Installation

After you have requested an Activation Code, MicroStrategy sends an emai lto the addresses provided in the request. This emai l contains the ActivationCode that is necessary to complete the activation of your instal lation.

Activate your software installationThis procedure assumes that you have requested an Activation Code andreceived an emai l from MicroStrategy containing the Activation Code:

Windows

1. Open MicroStrategy License Manager from Start menu > Programs >MicroStrategy Tools > License Manager.



2. Go to the License Administration tab > Activate Server Installationand cl ick Next .

3. Select the Server Activation using Activation Code option and enteryour Activation Code in the text field. Cl ick Next .

4. Cl ick OK .

Linux

1. License Manager can be run in GUI mode or command l ine mode:

l GUI: In a Linux console window, browse to HOME_PATH whereHOME_PATH is the speci fied home directory during instal lation.Browse to the folder bin and type ./mstrlicmgr , then cl ick Enter.The MicroStrategy License Manager opens in GUI mode.

l Command line: In a Linux console window, browse to HOME_PATH

where HOME_PATH is the speci fied home directory duringinstal lation. Browse to the folder bin and type ./mstrlicmgr -

console , then cl ick Enter. The MicroStrategy License Manageropens in command l ine mode.

The steps to activate your installation in command line mode of LicenseManager vary from the steps below.

2. Go to the License Administration tab > Activate Server Installationand cl ick Next .

The step above is not necessary for License Manager in command linemode.

3. Select the Server Activationusing Activation Code option and enteryour Activation Code in the text field. Cl ick Next .

4. Cl ick OK when the veri fication message appears.



You must restart your Intel l igence Server for the activation status to update.You must also restart your Web server for the activation status to update inMicroStrategy Web.


After completing the steps to activate your instal lation, you can continueyour setup and configuration. To help guide the rest of your instal lation andconfiguration steps, refer to the section Instal lation and ConfigurationCheckl ists, page 135 in Chapter 1, Planning Your Instal lation, forinstal lation and configuration checkl ists.

Server Activation FAQ

What is MicroStrategy Server Activation?MicroStrategy Server Activation is a l icensing technology that ensures thatinstal lations of MicroStrategy server products are authentic and have beenlegi timately l icensed. Server Activation registers each Server Instal lationwith MicroStrategy and locks the instal lation to a speci fic machine.

Why is Server Activation necessary?Server Activation provides benefi ts to both MicroStrategy and i ts customers:

l It ensures that the software products being used are authentic.

l It helps customers in identi fying software instal lations to prevent over-instal lation.

l It improves customer service by maintaining a register of the hardwareconfigurations used by our customers.



Does MicroStrategy adhere to Software Activation commonpractices?Yes. Extensive research was performed on software activation and i t wasfound that the Business Software Al l iance (www.bsa.org) provides the mostcomprehensive information. MicroStrategy has closely fol lowed these bestpractices.

Which products require activation?Al l MicroStrategy modular and non-modular server products require serveractivation, including:

l Intel l igence Server, Intel l igence Server Module, Clustering Option, ReportServices, Report Services Option, OLAP Services, OLAP Services Option,Distribution Services, Mul tiSource Option

l Web, Web Reporter Module, Web Analyst Option, Web ProfessionalOption

l Mobi le Server

l Narrowcast Server Del ivery Engine

If more than one server product is installed on the samemachine, does each server product need to be activated anddeactivated separately?No. Al l MicroStrategy server products instal led on a single machine aregrouped as a Server Instal lation and wi l l be activated and deactivated as agroup.

Which customers are required to activate MicroStrategyserver products?Al l customers who instal l MicroStrategy server products wi l l need toactivate their Server Instal lations.


http://www.bsa.org/


Is a new CD Key needed to install products on differentmachines?No, Server Activation has no impact on CD Keys. The latest CD Key sent byMicroStrategy can be used to instal l products on many machines just asbefore. The only di fference now, is that each instal lation on a di fferentmachine wi l l need a di fferent Activation Code to activate the instal lation.Server Activation is independent of the CD Keys.

Is Server Activation required for both Named-user and CPUbased licenses?Yes. Server Activation is required for both Named-user and CPU basedl icenses. Server Activation is designed to track software instal lationsregardless of l icensing model . Server Activation does not manage or l imi tthe number of servers on which server software is instal led.

Does Server Activation aggregate the total number oflicenses installed and prevent over-installation of products?No. Server Activation and the l icensing models are independent. However,using Server Activation information avai lable athttps://licensing.microstrategy.com , organizations can moni torthe number of instal lations. Deactivating Server Instal lations that are notbeing used wi l l ensure this information is up-to-date.

Does Server Activation apply to Evaluation Editions?Yes. The Evaluation Edi tion must be activated within 7 days of instal lation.

What is the procedure for activating Server Installations?Instal l ing, modi fying or upgrading MicroStrategy Server Instal lations wi l lautomatical ly generate an Activation XML fi le that contains informationabout the instal lation. This XML fi le, cal led the "Activation Fi le" is uploadedto MicroStrategy ei ther automatical ly by the instal lation routine or throughLicense Manager; or by manual ly uploading the Activation Fi le through aweb browser via a secure web si te,


https://licensing.microstrategy.com/


https://licensing.microstrategy.com . MicroStrategy then createsa machine-speci fic Activation Code which is emai led to the instal ler and tothe MicroStrategy Tech Support l iaisons. The Activation Code must bemanual ly entered into License Manager on the target Server Instal lation.

Can the Server Installation be automatically activated afterautomatically requesting an activation code?No, the Activation Code is sent to the instal ler and to the MicroStrategyTech Support contacts by emai l . Upon receiving the activation code, theServer Instal lation needs to be manual ly activated by entering theactivation code using License Manager. For manual activations, theActivation Code can be copied from the Activation websi te, and pasted intoLicense Manager.

What information is sent to MicroStrategy in the ActivationXML File?The fol lowing information is sent to the Activation XML Fi le:

l Instal lation Information:

n Instal lation timestamp

n Activation ID (i f the instal lation has previously been activated)

n Contract information

n CD Key used in instal lation

n Instal ler contact detai ls – name, address, emai l

n Company contact detai ls – name, address, emai l

n Server Instal lation information – name, location, use

l Hardware information:

n Unique Hardware Identi fier

n CPU Information – type, bi t-size, clock speed, total quanti ty




n Physical Memory instal led

l Operating System information:

n Type, version, bi t-size, page/swap size

n Locale

n Addi tional information – 4GT mode and hyperthreading in Windows

l MicroStrategy information:

n Instal l Type – new/modi fy/upgrade

n Products and version instal led

n Number of CPUs al located for CPU l icenses

l Database information:

n Metadata database and ODBC driver

n Data warehouse database and ODBC driver

Is the information sent to MicroStrategy secure?Yes. The Activation XML fi le is sent to MicroStrategy in the fol lowing ways:

l Automatical ly during instal lation or through License Manager. Thisinformation is encrypted using a RIPEMD-160 algori thm before being sentto MicroStrategy.

l Manual ly in the https://licensing.microstrategy.com websi te.Communication with this websi te is conducted through Secure SocketLayer once the user has been authenticated.

Can I change the information in the Activation XML file?The content of this fi le is secured with a digi tal signature. ContactMicroStrategy Technical Support i f the content is incorrect.




What is used to lock the server to a machine?A unique hardware identi fier for each machine is used to lock aninstal lation to that machine. Any changes to these identi fiers wi l l requirereactivation of the Server Instal lation:

l Windows: An identi fier generated from a one-way hash of the networkinterface card MAC address

l Linux: An identi fier generated from a one-way hash of the networkinterface card MAC address

Is there a grace period from the time server products areinstalled to when it can be activated?Yes. There is a 30 calendar day grace period from instal lation (7 days forEvaluation Edi tion) before a server instal lation must be activated.

What happens if the Server Installations are not activated?If a server instal lation has not been activated within 30 calendar days (7days for Evaluation Edi tion), the server products wi l l not be able to berestarted.

Should the installations be automatically or manuallyactivated and deactivated?It is preferable to automatical ly send the activation information toMicroStrategy, ei ther during instal lation or using License Manager. This isan easy process that should take less than one minute to complete, andensures that the correct information is sent to MicroStrategy.

What should be done if requesting an Activation Code failsduring installation?Firstly, al low the instal lation to complete. The Activation Code requestshould then be attempted using License Manager. If this does not work,activate the Server Instal lation manual ly by visi ting the Activation websi teat https://licensing.microstrategy.com .




What should be done if automatic request for an ActivationCode does not work at all?The Server Instal lation should be manual ly activated using LicenseManager on a machine that has access to the Web. The Activation XML fi leshould be copied from the Server Instal lation that requires activation to thiscomputer. If this does not work, contact MicroStrategy Technical Support.

Can the Activation Code be used on a different machine?No. The Activation Code contains the unique identi fier for a speci ficmachine and can only be used on that machine. The server products wi l lnot be activated i f the incorrect Activation Code is used.

What if the Server installation has to be moved to anothermachine?If the Server Instal lation needs to be moved to another machine, uninstal lthe MicroStrategy products or deactivate the Server Instal lation fromLicense Manager. Noti fy MicroStrategy that Server Instal lation has beendeactivated. This keeps your active server inventory up to date as shown toyou on https://licensing.microstrategy.com .

What if the server machine has a catastrophic failure andcannot be deactivated automatically or manually?If a machine has a catastrophic fai lure and the server products cannot beuninstal led or deactivated, contact MicroStrategy Technical Support toupdate the status of this Server.

If there is more than one server product installed on amachine and one is removed, does the Server Installationneed to be deactivated?Upon removal of a server product, al l remaining server products areautomatical ly deactivated. The remaining server product(s) need to bereactivated to reflect the new product configuration on that machine. Forexample, i f a machine contains MicroStrategy Narrowcast Server and




MicroStrategy Web, and MicroStrategy Narrowcast Server is removed,MicroStrategy Web wi l l be automatical ly deactivated. MicroStrategy Webwi l l need to be reactivated.

What information can be monitored on the website?When registered Technical Support l iaisons log into the MicroStrategyActivation websi te, they can display a l ist of al l Server Instal lations. Thisreport l ists each Server Instal lation along with the fol lowing information forreference:

l Instal lation ID

l Activation Status

l Contract ID

l Operating System

l Machine CPUs

l Last Update Type

l Last Updated by

l Last Update Date

l Products instal led

l Activation and deactivation history

The Instal lation ID is a unique identi fier for Server Instal lations. This ID isprovided along with the Activation Code in the emai l received whenrequesting activation.

Does Server Activation apply to MicroStrategy Suite?Yes. The MicroStrategy Sui te must be activated within 30 days ofinstal lation.



CONFIGURING ANDCONNECTINGINTELLIGENCE SERVER



After instal l ing MicroStrategy, you must complete a few configuration tasks.This chapter addresses the processes used to configure the databases youintend to use in your business intel l igence system, as wel l as an instal ledMicroStrategy sui te of products.

The MicroStrategy platform includes a Tutorial project, which is a sample datawarehouse and a demonstration project you can use to learn about the variousfeatures that MicroStrategy offers. It is ready to be used and requires noadditional configuration tasks. If you want to set up a new system using yourown data, you must read this chapter and perform the tasks it describes.

This chapter includes the fol lowing information:

If you are configuring MicroStrategy on a Linux machine that does not havea GUI, you can perform configuration tasks with command l ine tools. Forsteps to perform configuration tasks using command l ine tools in Linux, seeChapter 12, Configuring MicroStrategy Using Command Line Tools.

Communicating with Databases

Establ ishing communication between MicroStrategy and your databases orother data sources is an essential fi rst step in configuring MicroStrategyproducts for reporting and analyzing data. This section explains howMicroStrategy communicates with various data sources and the stepsrequired to set up this communication.

ODBC (Open Database Connectivi ty) is a standard database accessmethod. ODBC enables a single appl ication to access database data,regardless of the database management system (DBMS) that stores thedata. A DBMS is a col lection of programs that enables you to store, modi fy,and extract information from a database.

MicroStrategy Intel l igence Server, when used in a three- or four-tierconfiguration, is the appl ication that uses ODBC to access a DBMS. ODBCdrivers translate MicroStrategy Intel l igence Server requests into commands



that the DBMS understands. MicroStrategy Intel l igence Server connects toseveral databases (at a minimum, the data warehouse and the metadatareposi tory) to do i ts work.

Users of MicroStrategy Web can also connect to data sources usingdatabase connections. A database connection supports connecting to datasources through the use of DSNs, as wel l as through DSNless connections,to import and integrate data into MicroStrategy. For steps to createdatabase connections in MicroStrategy Web, see Creating DatabaseConnections in Web, page 785.

This section describes the ODBC standard for connecting to databases andcreating data source names (DSNs) for the ODBC drivers that are bundledwith the MicroStrategy appl ications.

The diagram below i l lustrates the three-tier metadata and data warehouseconnectivi ty used in the MicroStrategy system.



The diagram shown above i l lustrates projects that connect to only one datasource. However, MicroStrategy al lows connection to multiple data sourcesin the fol lowing ways:

l With MicroStrategy MultiSource Option, a MicroStrategy project canconnect to multiple relational data sources. For information onMultiSource Option, see the Project Design Guide.

l You can integrate MDX cube sources such as SAP BW, MicrosoftAnalysis Services, and Hyperion Essbase with your MicroStrategyprojects. For information on integrating these MDX cubes sources intoMicroStrategy, see the MDX Cube Reporting Guide.

This section provides information and instructions on the fol lowing tasks:





Setting up ODBCThe fol lowing information assists you in setting up ODBC betweenIntel l igence Server and your metadata database and data warehouse.

ODBC is a standard method of communicating with database servers.Intel l igence Server uses ODBC to connect to and communicate with al ldatabase servers in the system. Speci fical ly, ODBC connects to andtransfers data to and from data sources within relational databases.

ODBC permits maximum interoperabi l i ty—an appl ication can access data indiverse DBMSs through a single framework. A cl ient appl ication uses adatabase driver and a driver manager to make a connection to the datasource. A data source, identi fied by a data source name, is the database orfi le accessed by a driver. Data source is another term for a logical databasewithin a database server. A database server can contain multiple logicaldatabases or data sources.

When setting up your MicroStrategy environment, you must create aseparate connection to the data warehouse and metadata reposi tory. Thisrequirement is true even i f both databases are accessed through the sameDBMS. Further description of these two requirements is below:

l A data warehouse stores the data that users of the system must analyzeto track and respond to business trends, and to faci l i tate forecasting andplanning efforts.

l Metadata is a reposi tory whose data associates the tables and columns ofa data warehouse with user-defined attributes and facts to enable themapping of business views, terms, and needs to the underlying databasestructure. Metadata can reside on the same server as the data warehouseor on a di fferent server. It can be stored in di fferent relational DBMSs.

A successful ODBC connection requires the fol lowing information:

l A data source name (DSN) is the name for a pointer used by a cl ientappl ication to find and connect to a data source. A data source is the



database accessed by a driver. The information obtained through a DSNgeneral ly includes the host computer name or IP address, instance name,and database name. However, the exact information varies depending onthe type of database server.

l An ODBC driver is a type of software that translates information betweenthe cl ient appl ication (Intel l igence Server) and the database server API.For more information on ODBC drivers and how they work withMicroStrategy, see ODBC drivers, page 373.

l A connection string stores the information required to connect to adatabase server. A connection string usual ly includes a DSN, as wel l asthe user ID and password required to log in to the database server. Thisinformation varies depending on the particular database server. ForMicroStrategy environments, a connection string is commonly provided bya database instance (see Creating a database instance, page 443).

ODBC drivers

ODBC drivers are DBMS-speci fic and must be instal led on MicroStrategyIntel l igence Server prior to creating the ODBC connection to the warehouseand metadata databases. MicroStrategy embeds and brands Progress andMagni tude ODBC drivers in the MicroStrategy platform. These drivers arecerti fied to work with MicroStrategy products.

The purpose of an ODBC driver is to translate MicroStrategy Intel l igenceServer requests into commands that the DBMS understands. Users of theMicroStrategy platform can employ the MicroStrategy-branded ODBCdrivers to connect MicroStrategy products to various DBMSs. For a l ist ofthe avai lable ODBC drivers for Windows and Linux that are certi fied forIntel l igence Server and di fferent DBMS types, see Certi fied ODBC Driversfor MicroStrategy Intel l igence Server, page 123.

Although it is possible to use a non-certified driver, it is strongly recommendedthat 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. TheMicroStrategy Readme lis ts these MicroStrategy ODBC drivers.

Default location for ODBC and driver files for Windows

MicroStrategy components require 64-bi t drivers to achieve ODBCconnectivi ty.

The ODBC driver manager and support l ibraries are commonly instal led inthe C:\WINDOWS\SYSTEM or C:\WINDOWS\SYSTEM32 directories. Referto your thi rd-party documentation for the locations of ODBC support anddriver fi les.

The database-speci fic ODBC drivers are instal led in the locations speci fiedduring the instal lation of the drivers. MicroStrategy-branded drivers areinstal led in C:\Program Files (x86)\Common

Files\MicroStrategy on a 64-bi t Windows environment.

Default location for ODBC and driver files for Linux

MicroStrategy components require 64-bi t drivers to achieve ODBCconnectivi ty.

The ODBC driver manager and support l ibraries are usual ly instal led inINSTALL_PATH/lib

The database-speci fic ODBC drivers are instal led in the locations speci fiedduring the instal lation of the drivers. MicroStrategy-branded ODBC driversare instal led in INSTALL_PATH/lib , where INSTALL_PATH is thedirectory you speci fied as the Instal l Directory in the Instal l Wizard.

The MicroStrategy Connectiv ity Wizard lis ts only the MicroStrategy-brandedODBC drivers. However, this guide also provides information on how to installdrivers from other vendors with MicroStrategy. For more information, seeCreating DSNs for Speci fic Data Sources, page 747 .



Defining DSNsAfter you instal l an ODBC driver, you can define one or more data sourcesfor i t. The DSN should provide a unique description of the data, forexample, Payroll_Project_Metadata or Payroll_Warehouse .

The DSN is the name for a pointer used by a cl ient appl ication (in this caseMicroStrategy) to find and connect to a data source. Mul tiple DSNs canpoint to the same data source and one DSN can be used by di fferentappl ications.

You can define a data source connection with a DSN by using:

l The MicroStrategy Connectivi ty Wizard—configures connectivi ty to datasources by creating a DSN that uses a MicroStrategy-branded ODBCdriver (see Creating a DSN for a data source, page 375).

l The Microsoft ODBC Data Source Administrator—creates a DSN for anODBC driver that is not MicroStrategy-branded (see Managing ODBC anddata sources with Microsoft ODBC Data Source Administrator, page 378).

l Edit the odbc.ini on Linux. For more information, please see ConfiguringODBC Parameters wi th odbc.ini .

It is strongly recommended you use the MicroStrategy Connectiv ity Wizardwhen creating a new DSN for a MicroStrategy-branded ODBC driver. Use theMicrosoft ODBC Data Source Administrator only if you intend to use a driverthat is not MicroStrategy-branded.

If you create DSNs using the Microsoft ODBC Data Source Administrator, youmust create system DSNs. Otherwise, MicroStrategy interfaces will notrecognize them.

Creating a DSN for a data source

If a DSN does not al ready exist in your empty metadata reposi tory or thereposi tory instal led with MicroStrategy, you can add or create a new one.



The MicroStrategy Connectivi ty Wizard is a tool designed speci fical ly toconfigure connectivi ty to data sources by creating a DSN that uses aMicroStrategy-branded ODBC driver.

To create a DSN

1. On Windows, log in to the system as an administrator.

2. From the Start menu, go to Programs > MicroStrategyTools >Connectivity Wizard .

On Linux:

l Using the Connectivi ty Wizard interface, perform the fol lowing steps:

l In a Linux console window, browse to HOME_PATH where HOME_

PATH is the speci fied home directory during instal lation.

l Browse to the folder bin and type ./mstrconnectwiz , and thenpress ENTER.

l From the command l ine, perform the fol lowing steps:

l In a Linux console window, browse to HOME_PATH where HOME_

PATH is the speci fied home directory during instal lation.

l Browse to the folder bin and type ./mstrconnectwiz -h , andthen press ENTER.

l This command displays command l ine operation syntax andexamples for di fferent database platforms. Create your commandbased on the syntax and examples displayed. Once you performyour command, the DSN is created and no further action isrequired. For detai led steps on how to use the command l ineversion of this tool , see Creating a DSN for a Data Source, page689 in Chapter 12, Configuring MicroStrategy Using CommandLine Tools.

3. Cl ick Next.



4. Select a database driver wi th which to create a DSN and cl ick Next.

Only a few databases can contain metadata repositories. For details ,refer to the MicroStrategy Readme . Only DSNs created to connect tothese databases can be used to connect to metadata repositories.

5. Enter the information in the appropriate fields for connecting with theselected database driver. The information to enter varies depending onthe database platform that you selected. For more information, seeCreating DSNs for Speci fic Data Sources, page 747.

6. Cl ick Test.

7. Enter the User Name and Password to connect to the database.

8. Cl ick Connect. If the test is performed successful ly, the connectionwith the database is establ ished. If the test fai ls, veri fy the correctconnection information with your database administrator and make anyrequired changes to the information you provided in the previoussteps.

9. Cl ick Close, and then Finish .

If you already have an existing DSN with the same name as the one youprovided, 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.

Repeat the above steps to create as many DSNs as you require. At aminimum, create one for your metadata and one for your warehouse.



Managing ODBC and data sources with Microsoft ODBC DataSource Administrator

The Microsoft ODBC Data Source Administrator manages database driversand data sources on Windows. The Microsoft ODBC Data SourceAdministrator uti l i ty creates a log with which to trace cal ls to data sourcesand to view, create, and edi t DSNs. The uti l i ty is avai lable from Microsoftand is usual ly included with the purchase of an ODBC driver.

l It is strongly recommended that you use the Connectivi ty Wizard whencreating a new DSN for a MicroStrategy-branded ODBC Driver. Use theMicrosoft ODBC Data Source Administrator only i f you intend to use anon-MicroStrategy driver.

l If you choose to create DSNs using the Microsoft ODBC Data SourceAdministrator, they must be system DSNs. Otherwise, MicroStrategyinterfaces cannot recognize them.

To create a DSN using the Microsoft ODBC Data Source Administrator

1. Log in to the machine as an administrator. This gives you the abi l i ty tocreate a system-wide DSN, rather than a user-speci fic DSN.

2. In most Windows systems you can access the ODBC Data SourceAdministrator from the Control Panel . Refer to your thi rd-partyMicrosoft documentation for steps to access the ODBC Data SourceAdministrator tool .

3. Cl ick the System DSN tab.

To view all the installed ODBC drivers, c lick the Drivers tab.

4. Cl ick Add .



5. Select the desired driver and cl ick Finish .

We recommended that you select a MicroStrategy ODBC driver. Thesedrivers, whose names start with MicroStrategy, were installed when youinstalled the MicroStrategy application on the computer.

6. Enter the information in the appropriate fields to create a data sourcefor the selected database driver.

The information to enter varies depending on the database platformthat you selected, which is discussed in Creating DSNs for Speci ficData Sources, page 747.

7. Cl ick OK .

Testing ODBC connectivityODBC connectivi ty is one of two layers of connectivi ty that are l isted in thenext table, along with the associated connectivi ty testing programs.Connectivi ty should be tested from the bottom up—the network layer fi rstand then the ODBC layer.

Layer Test with

ODBC driverTest ODBC

mstrtestodbc or mstrtodbcx

Network

TCP/IP

Simple Network Layer Test ing Tool

Ping, PING.EXE, for TCP/IP

The test method described above reflects the situation when the ODBC driverand the database network software are bundled. If they are not bundled, theymust be configured and tested separately, using database-specific tools.



Using the DB Query Tool

The MicroStrategy DB Query Tool is avai lable in Windows, and LinuxIntel l igence Server instal lations. It is used to test and troubleshootconnectivi ty to databases, create and execute SQL commands throughODBC, and run scripts.

Before you use the DB Query Tool, test the network layer with the network layerutility , PING.EXE . Consult your operating system or network systemdocumentation for details .

To use the DB Query Tool

1. To use the DB Query Tool :

l On Windows using the DB Query Tool interface, perform thefol lowing step:

From the Windows Start menu, go to Programs > MicroStrategyTools > DB Query Tool.

l On Windows from the command l ine, perform the fol lowing steps:

1. From the Windows Start menu, select Run .

2. In the Open drop-down l ist, type cmd and cl ick OK . A commandprompt opens.

3. Type todbcx.exe and cl ick Enter. Prompts guide you throughtesting your ODBC connection from the command l ine andshould be used in place of the steps below. For detai led stepson how to use the command l ine version of this tool , seeTesting ODBC connectivi ty in Chapter 12, ConfiguringMicroStrategy Using Command Line Tools.

l On Linux using the DB Query Tool interface, perform the fol lowingsteps:



1. In a Linux console window, browse to HOME_PATH , whereHOME_PATH is the directory that you speci fied as the homedirectory during instal lation.

2. Browse to the folder bin and type ./mstrdbquerytool , thencl ick Enter.

l On Linux from the command l ine, perform the fol lowing steps:


2. Browse to the folder bin and type ./mstrtodbcx , then cl ickEnter. Prompts guide you through testing your ODBCconnection from the command l ine and should be used in placeof the steps below. For detai led steps on how to use thecommand l ine version of this tool , see Testing ODBCconnectivi ty in Chapter 12, Configuring MicroStrategy UsingCommand Line Tools.

2. From the Session menu, select Open Connection , or cl ick theConnect icon on the toolbar. The Connect dialog box opens. Theconnection interface varies depending on the destination database.

3. Select the DSN for a data source.

4. Enter the appropriate user name and password.

5. Cl ick Connect. After your connection is opened, the connection stringis displayed in the MicroStrategy DB Query Tool at the bottom. Yourcursor is inserted automatical ly 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 forMicrosoft SQL Server or a MicroStrategy-created table such asDSSMDSYSPROP in the MicroStrategy metadata.

7. From the Queries menu, select Execute Query. A table of data fromthe database is displayed in the Query Resul t window.

8. From the Session menu, select Close Connection to close thedatabase connection.

9. From the File menu, select Exit.

Init ial MicroStrategy configuration

The MicroStrategy Configuration Wizard automates much of theconfiguration process, prompting you only when information is required.With this tool , you can configure the metadata reposi tory, statistics tablesand Enterprise Manager reposi tory, History List tables, MicroStrategyIntel l igence Server, and multiple project sources.

If you are configuring MicroStrategy using the Windows operating system,you must have administrative privi leges on the computer on which theIntel l igence Server is instal led, so that you can define the parametersnecessary to start the Intel l igence Server and to invoke server-defini tionobjects.

You can also configure your MicroStrategy instal lation using theConfiguration Wizard in si lent or unattended mode. This al lows you to loadan existing setup routine to configure your MicroStrategy instal lation. Forinformation on running the Configuration Wizard with a response fi le, seeConfiguring MicroStrategy with a Response Fi le, page 415.

You can also use the Configuration Wizard to create an Enterprise Managerproject, which provides insights about governing and tuning al l areas ofyour MicroStrategy environment. For steps on how to create an EnterpriseManager project, see the Enterprise Manager Guide.


https://www2.microstrategy.com/producthelp/2020/EnterpriseManager/WebHelp/Lang_1033/index.htm


Configuration Wizard PrerequisitesBefore you begin using the Configuration Wizard you should review andcomplete the fol lowing requirements:

l Instal l the necessary MicroStrategy products. You should have at leastMicroStrategy Developer and MicroStrategy Intel l igence Server instal led.For information on how to instal l MicroStrategy on Windows, see Chapter2, Instal l ing MicroStrategy on Windows. For information on how to instal lMicroStrategy on other operating systems, see Chapter 3, Instal l ingMicroStrategy on Linux.

l Have access to an empty database location certi fied to house themetadata. This includes creating DSNs for your databases (seeCommunicating with Databases, page 369). For a l ist of certi fiedmetadata platforms, see the MicroStrategy Readme.

l In a Linux environment, the Configuration Wizard must be able tocommunicate with Intel l igence Server over TCP/IP network protocol . Toachieve this, the hosts fi le in the /etc directory must include one entryidenti fying the local host in the form:

IP-address local-machine-name

For example, 123.4.5.6 FakeISmachine . Modi fying the hosts fi lemay require an account wi th root privi leges.

l MicroStrategy products must be configured on the machine on which theyare instal led. You cannot configure them remotely.

Configuring MicroStrategy SoftwareThe MicroStrategy Configuration Wizard opens automatical ly after youinstal l MicroStrategy products and restart your machine.

You can configure a MicroStrategy Web and Intel l igence Server (four-tier),Intel l igence Server (three-tier), or di rect (two-tier) setup for MicroStrategy.



The fol lowing figure describes how to configure MicroStrategy to sui t anIntel l igence Server (three-tier) environment. It also shows how the variouscomponents of the MicroStrategy Configuration Wizard, the metadatareposi tory, Intel l igence Server, and the project source interact wi th eachother.

A MicroStrategy Web (four-tier) setup involves configuring a web server tocommunicate between Intel l igence Server and MicroStrategy Web. For moreinformation on deploying MicroStrategy Web, see Chapter 7, DeployingMicroStrategy Web and Mobi le Server.

The figure below describes how to configure MicroStrategy to sui t a direct(two-tier) environment. It also shows how the various components of theMicroStrategy Configuration Wizard, the metadata reposi tory and theproject source interact wi th each other:



It is not recommended to use a direct setup for the production environment.

The procedure below provides the high-level steps to configureMicroStrategy software through the Configuration Wizard.

To configure MicroStrategy through the Configuration Wizard

If you are configuring MicroStrategy on:

l Windows, go to Start > Programs > MicroStrategy Tools >Configuration Wizard . Continue to the steps provided in To select aconfiguration task, page 386.

l Windows from the command l ine, then perform the fol lowing steps:

l From the Windows Start menu, select Run .

l In the Open drop-down l ist, type cmd and cl ick OK . A command promptopens.

l Type macfgwiz and cl ick Enter.

This command displays the command l ine version of the ConfigurationWizard. You can configure the connection of a data source toIntel l igence Server by creating a response fi le or using an existingresponse fi le. The command l ine prompts guide you through configuringthe connection of a data source to Intel l igence Server by creating a



response fi le or using an existing response fi le and should be used inplace of the steps below. For information on using a response fi le toconfigure MicroStrategy, see Configuring MicroStrategy with aResponse Fi le, page 415.

l Linux using the Configuration Wizard interface, then perform the fol lowingsteps:

l From a Linux console window, browse to HOME_PATH , where HOME_

PATH is the directory that you speci fied as the home directory duringinstal lation.

l Browse to the folder bin and type ./mstrcfgwiz , then cl ick Enter.The Configuration Wizard opens.

l Linux from the command l ine, then perform the fol lowing steps:

l From a Linux console window, browse to HOME_PATH , where HOME_


l Browse to the folder bin and type ./mstrcfgwiz-editor , thencl ick Enter.

This command displays the command l ine version of the ConfigurationWizard. You can configure the connection of a data source toIntel l igence Server by creating a response fi le or using an existingresponse fi le. The command l ine prompts guide you through configuringthe connection of a data source to Intel l igence Server by creating aresponse fi le or using an existing response fi le and should be used inplace of the steps below. For information on using a response fi le toconfigure MicroStrategy, see Configuring MicroStrategy in CommandLine Mode, page 671.

To select a configuration task

Choose from the fol lowing configuration tasks and then cl ick Next to beginthe selected task:



l Create Metadata, History List and Enterprise Manager Repositories:Runs the SQL scripts necessary to create and ini tial ize the metadatareposi tory, History List tables, and Enterprise Manager statistics tablesand reposi tories in the database location that you select. For steps tocomplete these configuration tasks, see Creating Metadata, History List,and Statistics Reposi tories, page 388.

l Configure Intelligence Server: Creates a new server defini tion object inthe metadata reposi tory that you select. This setup provides Intel l igenceServer (three-tier) access to al l projects that are stored in the reposi tory.This option also al lows you to use or delete an existing server defini tion.For steps to complete these configuration tasks, see Setting upMicroStrategy Intel l igence Server, page 401.

l Create Enterprise Manager project: The Enterprise Manager projectprovides insights about governing and tuning al l areas of yourMicroStrategy environment. For steps on how to create an EnterpriseManager project, see the Enterprise Manager Guide.

l Create Platform Analytics project: The Platform Analytics projectprovides insights about governing and tuning al l areas of yourMicroStrategy environment.

l Create a Project Source: A project source contains the configurationinformation that each cl ient system requires to access an existing project.It stores the location of the metadata reposi tory and Intel l igence Serverthat is used to run the project. A project source determines howMicroStrategy Developer, Web, and other cl ient appl ications access themetadata. For steps to complete these configuration tasks, see CreatingProject Sources, page 408.

l Upgrade existing environment to MicroStrategy Intelligent Enterprise:You can use the Configuration Wizard to upgrade your MicroStrategyenvironment and migrate various features to the new version. For al lavai lable upgrade and migration options, see the Upgrade Guide.

The remainder of this section describes each configuration option in detai l .





After completing these steps, an empty metadata reposi tory is created. Tolearn how to add projects to your metadata reposi tory, see the ProjectDesign Guide.

Creating Metadata, History List, and Statistics RepositoriesYou can create metadata, History List, and statistics and EnterpriseManager reposi tories using the MicroStrategy Configuration Wizard.Reposi tories for your metadata, History List, and statistics tables arecreated in the data source speci fied by the DSN(s) you connect to.

It is recommended that you create the metadata, History List, and statisticsrepository tables in different databases to ensure enhanced performance.

As you complete the configuration process, messages may be displayed.For detai ls on system messages displayed during the configurationprocess, see Configuration messages, page 400.

You can choose to create metadata, History List, and statistics reposi toriesusing a response fi le wi th the Configuration Wizard. This lets you provideusers wi th a configuration fi le to complete the configuration tasks ratherthan requiring users to step through the Configuration Wizard. Creating andusing a response fi le can be done using the Configuration Wizard interfaceor a command l ine tool avai lable for Linux.

Required database permissions to create metadata, History List,and statistics repositories

To create metadata, History List, and statistics reposi tories in a database,you need a database user account to associate wi th the tables created forthe reposi tories. MicroStrategy recommends that the database user accountused to create these reposi tories is granted ful l permissions for thedatabase.

If the database user account cannot be granted ful l permissions to thedatabase, be aware that this account requires Select, Insert, Update,Create, Drop, and Delete permissions. These permissions are required for





various database objects depending on the database type you are using.For example, the fol lowing database object permissions are required whereappl icable for your database type:

Database Object Type of Permissions Required

Tables Select , Insert , Update, Create, Drop, Delete

Indexes Create, Drop

Triggers Create, Drop

Funct ions Create, Execute

Packages Create

Procedures Create, Execute

While creating metadata, History List, and statistics repositories, theConfiguration Wizard provides an option to preview the SQL statements thatwill be executed. You can review this SQL preview to have a betterunderstanding of the tasks that will be required as part of creating metadata,History List, and statistics repositories.

Refer to your thi rd-party database documentation for speci fic names anddetai ls on database permissions and database objects.

Creating a metadata repository

The metadata reposi tory is a col lection of tables that contain the defini tionsfor nearly al l MicroStrategy objects including database logins, serverdefini tions, database instances and connections, reports, metrics, facts, andso on. It is mandatory to have a metadata reposi tory to which Intel l igenceServer can connect.

You can create the metadata reposi tory in the database location of yourchoice. Addi tional ly, a defaul t configuration is created in the metadatatables. This populates the tables with the basic data required for the



MicroStrategy metadata, such as the defaul t project folder structure andsome basic connection information.

If the Intelligence Server is not installed on the same machine as ConfigurationWizard, you can only create a metadata repository using the 32-bitConfiguration Wizard.

If you are upgrading your metadata from a previous version of MicroStrategyrather than creating a brand new metadata, see the Upgrade Guide .

l Before you create a metadata repository, you should ensure that you are storingit on a certified database, ODBC driver, and operating system combination. Fora lis t of certified metadata repository environments, see the MicroStrategyReadme .

l A database user account to associate with the metadata tables. MicroStrategyrecommends that the database user account used to create a metadatarepository is granted full permissions for the database. If the database useraccount cannot be granted full permissions to the database, refer to Requireddatabase permissions to create metadata, History List, and statisticsreposi tories, page 388 for additional details on the database permissionsrequired for this configuration.

l While metadata creation errors are rare in general, you can review a list ofpotential errors in Metadata and Other Reposi tory Creation Errors, page900 to prepare for or avoid specific scenarios that can cause errors.

To create a metadata repository

1. Open the MicroStrategy Configuration Wizard.

2. Select Metadata, History List and Statistics Repository Tables andcl ick Next.

3. Select the Metadata Tables check box and cl ick Next. The Reposi toryConfiguration: Metadata tables page opens.




You can also select to create a History List and a statistics reposi toryimmediately after creating a metadata reposi tory. If you create aHistory List or statistics reposi tory as part of the same configurationroutine as creating a new metadata reposi tory, and the configuration isbeing done on a Windows environment, database instances areautomatical ly created for the History List and statistics reposi tories.

4. From the DSN drop-down l ist, select the DSN for your metadatareposi tory.

If a DSN for your metadata reposi tory does not exist, you can cl ickNew to open the Connectivi ty Wizard and create a new DSN. Thesteps to create a new DSN with the Connectivi ty Wizard are describedin Creating a DSN for a data source, page 375.

Although it is possible to use the Microsoft Access database for themetadata repository, it is not a suitable metadata repository for aproduction project. You should not use Microsoft Access for anythingother than a proof-of-concept or demonstration type of application.

5. Type a User Name and Password that can connect to the data source.

The database user that you provide becomes the owner of al l metadatatables and objects. The database user is required to have the Select,Insert, and Update permissions. Intermediate tables are created in themetadata for recursive search queries, which requires Create and Droppermissions as wel l . Updating the schema requires the Deletepermission.

6. After providing a val id user name and password, you can cl ick SQLPreview to open the SQL Preview dialog box. This dialog box providesthe SQL statements that wi l l be executed on your data source to createthe metadata tables. Cl ick Close.



If you use the advanced options to change the SQL script, you cancl ick SQL Preview after selecting the new script to see an updatedl isting of the SQL statements that wi l l be executed.

7. Cl ick Advanced .

8. In the Table Prefix field, you can speci fy a prefix to be used whenmetadata tables are created in the database you select. This is anoptional configuration. However, you must use di fferent prefixes foryour metadata tables and your History List tables i f you store them inthe same database.

Most databases use a prefix of two characters. However, you cansupply as many letters, numbers, underscores (_ ), and periods (. ) asrequired to support your database prefixes. To determine characterl imi ts for a prefix, refer to your thi rd-party database vendordocumentation.

9. In the Script field, a SQL script to create metadata tables optimized foryour database is selected. If you want to select a di fferent script, cl ick... to browse to and select a customized script.

10. Cl ick Next. The next configuration page that opens depends on yourconfiguration scenario:

l If your metadata reposi tory does not need to be upgraded and youdid not select to create History List or statistics tables, the Summarypage opens. You can complete your configuration as described inCreating Metadata, History List, and Statistics Reposi tories, page388 below.

l If your metadata reposi tory does not need to be upgraded and youselected to configure History List or statistics tables, you areprompted to configure these options as described in Creating aHistory List reposi tory, page 393 and Creating statistics and



Enterprise Manager reposi tories to maintain and moni tor systemactivi ty, page 397.

l If your metadata reposi tory needs to be upgraded, cancel thismetadata creation process. If you continue with this process ofcreating metadata tables, your current metadata wi l l be overwri ttenwith a brand new metadata. For information on upgrading yourmetadata and sui te of MicroStrategy projects, refer to the UpgradeGuide.

11. Review the summary information.

You can cl ick Save to save the configuration as a response (.ini ) fi le toconfigure metadata reposi tories on other systems or to run si lentconfigurations at a later time.

12. Cl ick Finish .

Creating a History List repository

A History List reposi tory stores users' report and document resul ts for futureuse. History Lists can be stored on fi le systems of a server machine. TheHistory List tables provide an al ternative option to store History Listinformation in a central ized database.

If you create a History List reposi tory as part of the same configurationroutine to create a metadata reposi tory, and the configuration is being doneon a Windows environment, a database instance is automatical ly createdfor the History List reposi tory. If you create the History List reposi toryseparately, you create i t for an existing metadata reposi tory, or you create i ton a Linux environment, you must create a database instance for theHistory List reposi tory. For information on creating a database instance, seeCreating a database instance, page 443.

If you are upgrading your History List repository from a previous version ofMicroStrategy rather than creating a brand new History List repository, see theUpgrade Guide .






l Before you create a History List repository, you should ensure that you arestoring it on a certified database, ODBC driver, and operating systemcombination. For a lis t of certified History List repository environments, see theMicroStrategy Readme .

l A database user account to associate with the History List tables.MicroStrategy recommends that the database user account used to createHistory List Tables is granted full permissions for the database. If the databaseuser account cannot be granted full permissions to the database, refer toRequired database permissions to create metadata, History List, andstatistics reposi tories, page 388 for additional details on the databasepermissions required for this configuration.

l The steps below are specific to creating a History List repository. If you alsoselect to create a metadata repository, you must first complete the stepsdescribed in Creating a metadata reposi tory, page 389 .

l While History List creation errors are rare in general, you can review a list ofpotential errors in Metadata and Other Reposi tory Creation Errors, page900 to prepare for or avoid specific scenarios that may cause errors.

To create a History List repository



3. Select the History List Tables check box and cl ick Next.

4. From the DSN drop-down l ist, select the DSN for your History Listreposi tory.

If a DSN for your History List reposi tory does not exist, you can selectNew to open the Connectivi ty Wizard and create a new DSN. Thesteps to create a new DSN with the Connectivi ty Wizard are describedin Creating a DSN for a data source, page 375.




The database user you provide becomes the owner of al l History Listtables and objects. The database user is required to have the Select,Create, Insert, and Drop permissions.

6. After providing a val id user name and password, you can cl ick SQLPreview to open the SQL Preview dialog box. This dialog box providesthe SQL statements that wi l l be executed on your data source to createthe History List tables. Cl ick Close once you are done reviewing theSQL statements to return to the Configuration Wizard.



8. In the Table Prefix field, you can speci fy a prefix to be used whenHistory List tables are created in the database you select. This is anoptional configuration. However, you must use di fferent prefixes foryour metadata tables and your History List tables i f you store them inthe same database.

Most databases use a prefix of two characters. However, you cansupply as many letters, numbers, underscores (_), and periods (.) asrequired to support your database prefixes. To determine characterl imi ts for a prefix, refer to your thi rd-party database vendordocumentation.

If you use a table prefix for your History List tables, you must alsodefine this table prefix when you create a database instance toconnect to the History List tables. For information on creating adatabase instance, see Creating a database instance, page 443.

9. In the Script field, a SQL script to create History List tables optimizedfor your database is selected. If you want to speci fy a di fferent script,



cl ick ... to browse to and select a customized script. For moreinformation on the defaul t SQL scripts, see SQL scripts, page 400.

10. Cl ick Next. The next configuration page that opens depends on yourconfiguration scenario:

l If you did not select to create statistics tables, the Summary pageopens.

l If you selected to configure statistics tables, you are prompted toconfigure these options as described in Creating statistics andEnterprise Manager reposi tories to maintain and moni tor systemactivi ty, page 397.


You can cl ick Save to save the configuration as a response (.ini ) fi le toconfigure History List reposi tories on other systems or to run si lentconfigurations at a later time. For information on running theConfiguration Wizard with a response fi le, see ConfiguringMicroStrategy with a Response Fi le, page 415.

12. Cl ick Finish to apply the configuration and create the History Listreposi tory.

Once you are finished configuring Intel l igence Server and your projectsources, a database instance to connect a project to a History Listreposi tory must be created. If you created the History List reposi tory aspart of the same configuration routine to create a metadata reposi toryand the configuration is being done on a Windows environment, adatabase instance is automatical ly created for the History Listreposi tory. For information on creating a database instance, seeCreating a database instance, page 443.



Creating statistics and Enterprise Manager repositories to maintainand monitor system activity

The statistics and Enterprise Manager reposi tories are col lections ofdatabase tables used to maintain and moni tor system activi ty andperformance. You can run MicroStrategy Enterprise Manager against thestatistical information to analyze and interpret the statistics.

For a detai led description of the statistics tables used in the EnterpriseManager Statistics database, the fields that each table contains, and thedata types associated with each field for MicroStrategy Intel l igence Server,refer to the Enterprise Manager Data Model and Object Defini tions chapterin the System Administration Guide.

For detai ls on how to configure projects to log statistics, refer to theMonitoring System Usage chapter in the System Administration Guide.

If you create statistics and Enterprise Manager reposi tories as part of thesame configuration routine to create a metadata reposi tory, and theconfiguration is being done on a Windows environment, a databaseinstance is automatical ly created for the statistics reposi tory. If you createthe statistics reposi tory separately, you create i t for an existing metadatareposi tory, or you create i t on a Linux environment, you must create adatabase instance for the statistics reposi tory. For information on creating adatabase instance, see Creating a database instance, page 443.

If you are upgrading your statis tics and Enterprise Manager repositories froma previous version of MicroStrategy rather than creating a brand new statisticsrepository, see the Upgrade Guide .

l Before you create statistics and Enterprise Manager repositories, you shouldensure that you are storing them on a certified database, ODBC driver, andoperating system combination. For a lis t of certified environments, see theMicroStrategy Readme .






l A database user account to associate with the repositories. MicroStrategyrecommends that the database user account used to create the tables isgranted full permissions for the database. If the database user account cannotbe granted full permissions to the database, refer to Required databasepermissions to create metadata, History List, and statistics reposi tories,page 388 for additional details on the database permissions required for thisconfiguration.

l The steps below are specific to creating statistics and Enterprise Managerrepositories. If you also select to create a metadata repository or History Listrepository, you must first complete the steps described in Creating ametadata reposi tory, page 389 or Creating a History List reposi tory, page393 , respectively.

l While statis tics creation errors are rare in general, you can review a list ofpotential errors in Metadata and Other Reposi tory Creation Errors, page900 to prepare for or avoid specific scenarios that may cause errors.

To create statistics and Enterprise Manager repositories



3. Select the Statistics & Enterprise Manager Repository check boxand cl ick Next.

4. From the DSN drop-down l ist, select the DSN for your statistics andEnterprise Manager reposi tories.

If an appl icable DSN does not exist, you can select New to open theConnectivi ty Wizard and create a new DSN. The steps to create a newDSN with the Connectivi ty Wizard are described in the sectionCreating a DSN for a data source, page 375.




The database user you provide becomes the owner of al l tables andobjects. The database user is required to have the Select, Create,Insert, and Drop permissions.

6. After providing a val id user name and password, you can cl ick SQLPreview to open the SQL Preview dialog box. This dialog box providesthe SQL statements that wi l l be executed on your data source to createthe statistics and Enterprise Manager tables. Cl ick Close.



8. In the Script field, a SQL script to create statistics and EnterpriseManager reposi tories optimized for your database is selected. If youwant to speci fy a di fferent script, cl ick ... (the browse button) to browseto and select a customized script. For more information on the defaul tSQL scripts, see SQL scripts, page 400.

9. Cl ick Next.


You can cl ick Save to save the configuration as a response (.ini ) fi le toconfigure statistics reposi tories on other systems or to run si lentconfigurations at a later time. For information on running theConfiguration Wizard with a response fi le, see ConfiguringMicroStrategy with a Response Fi le, page 415.

11. Cl ick Finish . The summary information is updated as theconfigurations are completed, providing a way to track the progress ofthe configurations.

Once you are finished configuring Intel l igence Server and your projectsources, a database instance to connect a project to a statistics reposi tory



must be created. If you created the statistics reposi tory as part of the sameconfiguration routine to create a metadata reposi tory and the configurationis being done on a Windows environment, a database instance isautomatical ly created for the statistics reposi tory. For information oncreating a database instance, see Creating a database instance, page 443.

SQL scripts

MicroStrategy has database-speci fic SQL scripts for creating metadata,History List, and statistics tables. The scripts for each certi fied databaseplatform are shipped with the product. The MicroStrategy ConfigurationWizard automatical ly selects a defaul t script based on your ODBC driver'sdatabase platform.

By defaul t, al l the scripts reside in the directory where you instal ledMicroStrategy and are identi fied by the .sql extension. It is highlyrecommended that no edi ts be performed on these scripts, except on rareoccasions and only by ski l led database personnel .

Configuration messages

Depending on the selected ODBC database, di fferent messages might bedisplayed prompting you to complete the configuration successful ly. Twoexamples are described below:

l 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 metadatarepository in the database location you specified.

If you continue, all information in the existingmetadata repository is overwritten.

l No Metadata Tables were found at this location, do you wish

to create them now?



This message is displayed i f there is no existing metadata reposi toryand you have not chosen to create one.

Setting up MicroStrategy Intelligence ServerYou use the Configuration Wizard to create and configure a serverdefini tion for your MicroStrategy Intel l igence Server. A server defini tion isstored in the metadata reposi tory, and i t contains information about theconfiguration of Intel l igence Server such as governing settings, whichprojects should be loaded, which communication protocols should be used,and so on. This defini tion is a required step of configuring your Intel l igenceServer.

Multiple server definitions can be available, but you can install only oneIntelligence Server on one server machine and Intelligence Server uses onlyone server definition at a time.

You can choose to configure the server defini tion, project source names,and the metadata and statistics reposi tories using a response fi le wi th theConfiguration Wizard. This lets you provide users wi th a configuration fi leto complete the configuration tasks rather than requiring users to stepthrough the Configuration Wizard. Creating and using a response fi le canbe done using the Configuration Wizard interface or a command l ine toolavai lable for Linux.

You must run the Configuration Wizard locally on the Intelligence Server machine.You cannot create, use, or delete server definitions remotely.

To set up MicroStrategy Intelligence Server


2. Select Configure Intelligence Server, and cl ick Next.

3. From the DSN drop-down l ist, select the DSN used to connect to themetadata reposi tory. Enter the User Name and Password for the



database. Al though i t is possible to use the Microsoft Access databasefor the metadata reposi tory, i t is not a sui table metadata reposi tory fora production project. You should not use Microsoft Access for anythingother than a proof-of-concept or demonstration type of appl ication.

4. Cl ick Next. If a message is displayed that your metadata is not up todate with the most recent version of MicroStrategy, you must upgradeyour metadata to take advantage of the new features avai lable in themost recent version of MicroStrategy. You can upgrade yourMicroStrategy metadata as described in the Upgrade Guide.

5. On the MicroStrategy Authentication page, speci fy the MicroStrategyadministrator's User Name and Password . By defaul t, the user nameis Administrator and i t has no password. If you are setting upIntel l igence Server for the fi rst time, use the defaul t user name andpassword.

For security reasons, you should change the Administrator user nameand password as soon as possible after you initially configure thesystem. For details about passwords and other user managementinformation, see the System Administration Guide

6. Cl ick Next.

7. You can create a new server defini tion, use an existing serverdefini tion, or delete a current server defini tion. You can perform one ofthe fol lowing tasks:

l To create a server defini tion, select Create New Server Definition .When you create a new server defini tion in the metadata reposi toryof your choice, al l i ts parameters use the defaul t settings. You canmodi fy these defaul t settings using the MicroStrategy Intel l igenceServer Configuration Edi tor. For information about the Intel l igenceServer Configuration Edi tor, see the System Administration Guide.






1. In the Name field, type a name to identi fy the server defini tion.

2. Select the Use as the active server definition check box todefine Intel l igence Server to use the new server defini tion whenIntel l igence Server starts.

3. Cl ick Next. The Server Configuration: Settings page opens,described in Setting up MicroStrategy Intel l igence Server, page401 below.

l To use an existing server defini tion, select Use the selected ServerDefinition as active. When you use an existing server defini tiondi fferent from the current server defini tion, you are changing themachine's configuration information, which can be in an enti relydi fferent metadata with di fferent defaul t settings.

1. From the Existing Server Defini tions pane, select a serverdefini tion to use.

2. Cl ick Next. The Server Configuration: Settings page opens,described in Setting up MicroStrategy Intel l igence Server, page401 below.

l To delete an existing server defini tion, select Delete SelectedServer Definition . When you delete a server defini tion, you aredeleting the server defini tion object from the metadata reposi tory, butnot from the Intel l igence Server software that you instal led.

1. From the Existing Server Defini tions pane, select a serverdefini tion to delete.

2. Cl ick Next. The Summary page opens, described in Setting upMicroStrategy Intel l igence Server, page 401 below.

Select the server defini tion to use from the Existing ServerDefinitions pane. Cl ick Next.



Define the Intelligence Server port number and other settings

1. If you select to create a server defini tion or use an existing serverdefini tion, you can define the Intel l igence Server port number andother settings, as described below:

l Port number: You can use the defaul t port number (34952) orspeci fy another port number. The port number is how a serverprocess identi fies i tsel f on the machine on which i t is running. If theport number is used by another process, such as in a sharedenvironment, speci fy an avai lable port number. For instructions onhow to find an avai lable port number, see Port Number is in Use,page 899.

l REST port number: You can use the defaul t port number (34962) orspeci fy another port number for the REST API Server insideIntel l igence Server. This port number should not be same with theIntel l igence Server port number.

You can configure REST API Server logging with the Diagnostics andPerformance Logging Tool. Select the Performance Configurationtab, and find the dispatcher REST Trace under component NetworkClasses . For more information, see the Configuring What is Loggedsection in the System Administration Guide .

l Register Intelligence Server as a Service: This option is onlyavai lable i f you are configuring Intel l igence Server on a Linuxmachine, and you have root access and permissions to the Linuxmachine that Intel l igence Server is instal led on.In Windows,Intel l igence Server is automatical ly registered as a service uponcompletion of the configuration process.Running the ConfigurationWizard again and clearing this check box does not unregisterIntel l igence Server as a service. To unregister Intel l igence Server onLinux, you must stop the service, and then use the mstrctl

command l ine tool . The syntax is mstrctl -s




IntelligenceServer us , where IntelligenceServer is thename of a server defini tion. For information about starting, stopping,and registering Intel l igence Server as a service, see the SystemAdministration Guide.

l Projects to load at startup : This pane displays al l the projects thatare in the metadata reposi tory. You can select projects to use withthe server defini tion that you have chosen. The projects that youselect are loaded on the server at startup.

l Start Intelligence Server when finished : Select this check box tohave Intel l igence Server start once you complete this configuration.Ifyou use Windows NT authentication with SQL Server, you must typethe Windows NT account user name and password in the ServiceManager to successful ly start Intel l igence Server. For information onhow to access and use the Service Manager, see the SystemAdministration Guide.

l Identify missing DSNs: Select this check box to veri fy that al lDSNs, which are used for database instances created inMicroStrategy, are local ly avai lable. This helps to ensure that yourdatabase instances in MicroStrategy can connect successful ly totheir associated data sources.

By defaul t, this check box is cleared, which means the avai labi l i ty ofal l local DSNs used in database instances is not veri fied. Whi le thismay mean that al l DSNs used in database instances are notavai lable, i t can save system resources required for the Intel l igenceServer configuration process.

2. Cl ick Next.

3. You can enable or disable secure socket layer (SSL) protocol toencrypt the communication between Intel l igence Server andDeveloper:







Configure SSL : This option speci fies whether to enable Intel l igenceServer and Developer to communicate using the SSL protocol . Clearthis check box to disable the use of the SSL protocol for Intel l igenceServer and Developer communications. This option also appl ies SSLprotocol to the REST port number.

When you select to enable the SSL protocol , you must provide thefol lowing information:

l Certificate: The SSL certi ficate fi le you created for Intel l igenceServer. Cl ick the browse button to navigate to and select thecerti ficate fi le.

l Key: The private key fi le you created whi le requesting the certi ficatefor Intel l igence Server. Cl ick the browse button to navigate to andselect the private key fi le.

l Password : The password that you used whi le creating the privatekey for the SSL certi ficate.

l SSL Port: The port number to use for SSL access. By defaul t, theport is 39321.

To enable SSL protocol communication in Developer, you must use theProject Source Editor. For steps to complete the other tasks required toenable SSL protocol communications, refer to the SystemAdministration Guide .

Configuring port requires Client Certificate: If selected, the SSLcommunications with cl ient certi ficate veri fication wi l l be configured inthe Intel l igence Server, but does not apply to REST port number.Provide the fol lowing information:

l SSL Port: The port number the Intel l igence Server wi l l use for SSLcommunications with cl ient certi ficate veri fication.





l Truststore: The location to the cl ient certi ficate truststore.

4. Cl ick Next.

5. You can speci fy the defaul t statistics reposi tory to use for the localIntel l igence Server, including the data source name, user name, andpassword, and an option to create a new data source name. Thefol lowing options appear:

l Keep the existing statistics settings: Select this check box to keepthe existing statistics settings for al l projects. This option is selectedby defaul t.

l Enable Statistics Database Instance for the Intelligence Servermetadata: Select this check box to enable basic statistics logging forprojects.

You can alter the settings of this option in the Project ConfigurationEditor in MicroStrategy Developer. For steps, see the SystemAdministration Guide .

When defining the defaul t statistics reposi tory, you must provide thefol lowing configuration detai ls:

n DSN : Select the data source name for your statistics reposi tory.

If a DSN for your statistics reposi tory does not exist, you can cl ickNew to open the MicroStrategy Connectivi ty Wizard and create anew DSN. Unsupported DSNs are grayed out.

n User Name: Enter the database user name for the user that canconnect to the statistics data source.

n Password : Enter the password for the user that can connect to thestatistics data source.





l Disable statistics for the local Intelligence Server metadata:Select this check box to disable statistics settings for al l projects inthe local Intel l igence Server metadata.

6. Cl ick Next.

7. You can ei ther enable or disable Messaging Services for Intel l igenceServer and configure the Messaging Services host and port settings.

Messaging Services Host(s)/Port(s): Provide host name or IPaddress of Messaging Services. Format for this setting should be:server1.acme.com:9092 , server2.acme.com:9093 ,server3.acme.com:9093

8. Cl ick Next.

9. Review the summary information and cl ick Save.

For information on running the Configuration Wizard with a responsefi le, see Configuring MicroStrategy with a Response Fi le, page 415.

10. Cl ick Finish.

If you created a new server defini tion, i t is displayed in the l ist ofexisting server defini tions for that metadata.

If you assigned an existing server defini tion to Intel l igence Server andthe existing project source uses this Intel l igence Server, a relatedmessage is displayed.

Starting, stopping, and restarting the server

With a server defini tion defined for your Intel l igence Server, you can useService Manager to start or stop your Intel l igence Server. For steps to useService Manager, see the System Administration Guide.

Creating Project SourcesProject sources represent a connection to a metadata database or aMicroStrategy Intel l igence Server. The project source stores the location of




the metadata reposi tory or the MicroStrategy Intel l igence Server defini tionthat is used to run the project. Through a project source you can create,manipulate, and administer MicroStrategy projects.

When you create a metadata reposi tory, by defaul t i t creates a server(three-tier) project source. You can use the Project Sources option in theMicroStrategy Configuration Wizard i f you need to create multiple projectsources or a direct (two-tier) project source. The steps to create thedi fferent types of project sources are:

l Creating a direct (two-tier) project source, page 409: Direct projectsources that connect di rectly to the metadata through ODBC. You cannotcreate a direct project source on Linux.

l Creating a server (three-tier) project source, page 410: Server projectsources that connect to the metadata through an Intel l igence Server.

You can choose to create project sources using a response fi le wi th theConfiguration Wizard. This lets you provide users wi th a configuration fi leto complete the configuration tasks rather than requiring users to stepthrough the Configuration Wizard. Creating and using a response fi le canbe done using the Configuration Wizard interface or a command l ine toolavai lable for Linux.

Creating a direct (two-tier) project source

A direct project source is used to connect di rectly to the metadatareposi tory using ODBC. A direct project source connection does not al lowyou to access MicroStrategy Web, run Report Services documents, or useany of the other MicroStrategy features that are provided throughIntel l igence Server.

You cannot create a direct project source on Linux.

For Windows, the Project Source option is available only if the Developer productis installed on the machine.



To create to a direct project source


2. Select Project Sources and cl ick Next.

3. In the Project Source Name field, type a name for the project source.

4. Go to Connection Type > Direct (2-tier), and cl ick Next.

5. From the DSN drop-down l ist, select a DSN for the data source thatstores the metadata and speci fy a User Name and Password .

6. You can also cl ick New to create a new DSN (see Creating a DSN fora data source, page 375) and cl ick Advanced to speci fy a metadatatable prefix i f necessary.

7. Cl ick Next.

8. Select the authentication mode for the project source. For informationon the avai lable authentication modes, see the Authentication modes,page 412.

9. Cl ick Next.


You can cl ick Save to save the configuration as a response (.ini ) fi le toconfigure a direct project source on other systems or to run si lentconfigurations at a later time. For information on running theConfiguration Wizard with a response fi le, see ConfiguringMicroStrategy with a Response Fi le, page 415.

11. Cl ick Finish .

Creating a server (three-tier) project source

A server (three-tier) project source is used to connect to the metadata usingthe MicroStrategy Intel l igence Server. A server project source connection



al lows you to access MicroStrategy Web, run Report Services documents,and use al l of the other MicroStrategy features that are provided throughIntel l igence Server.

When you create a metadata repository, by default it creates a server (three-tier) project source.

For Windows, the Project Source option is available only if the Developer productis installed on the machine.

To create a MicroStrategy Intelligence Server (three-tier) project

source


2. Select Project Sources and cl ick Next.

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 cl ick Next.

5. In the MicroStrategy Intelligence Server Machine Name drop-downl ist, select the Intel l igence Server to connect to.

6. In the Port Number used by MicroStrategy Intelligence Server field,type the port number for the Intel l igence Server to connect to.

The port number is how the Intel l igence Server process identi fies i tsel fon the server on which i t is running. The defaul t port number forIntel l igence Server is 34952. If you use a non-defaul t port number, thisnumber must be provided whi le connecting through MicroStrategyDeveloper.

If you set up a fi rewal l between Intel l igence Server and yourMicroStrategy Web server, refer to the System Administration Guide for




steps to ensure the required ports are open to al low communicationbetween your MicroStrategy systems.

7. Select the Connection times out after (mins) check box to defineand enforce a connection time out for inactive users connected to aproject source. In the field below, type a numerical value (in minutes)for the amount of inactivi ty that is al lowed before a user isautomatical ly disconnected from a project source. If this check box iscleared, users are not disconnected from project sources due toinactivi ty.

8. Cl ick Next.

9. Select the authentication mode for the project source. For informationon the avai lable authentication modes, see the Authentication modes,page 412.

10. Cl ick Next.


You can cl ick Save to save the configuration as a response (.ini ) fi le toconfigure a server project source on other systems or to run si lentconfigurations at a later time. For information on running theConfiguration Wizard with a response fi le, see ConfiguringMicroStrategy with a Response Fi le, page 415.

12. Cl ick Finish .

Authentication modes

Authentication is the process through which the system identi fies the user.Several authentication modes are supported for MicroStrategy projectsources. They vary primari ly by the system that veri fies and accepts thelogin/password credentials provided by the user.



Some authentication modes require a server project source (three-tier).Therefore, i f you are creating a direct project source (two-tier) some of theauthentication options l isted below cannot be used.

For information on the benefi ts of the various authentication modes andother authentication topics, see the System Administration Guide

Network login ID: Windows authentication

To use Windows authentication, you must create users in the MicroStrategyenvironment and then l ink them to Windows users. If you use Windows asyour network operation system and your users are already defined in theWindows directory, your users can access the MicroStrategy appl icationwithout having to enter a login ID and password.

Login ID and password entered by the user: Standard authentication

When using standard authentication, the MicroStrategy Intel l igence Serveris the authentication authori ty. Intel l igence Server veri fies and accepts thelogin and password provided by the user. This information is stored in themetadata reposi tory. When a project source is configured to use standardauthentication, users must enter a val id login ID and password combinationbefore they can access the project source. Each user has a uniquelogin/password and can be identi fied in the MicroStrategy appl icationuniquely. By defaul t, al l users connect to the data warehouse using oneRDBMS login ID, al though you can change this using connection mapping.For information on configuring connection mapping, see the SystemAdministration Guide.

Guest account: Anonymous authentication

When using anonymous authentication, users log in as Guest and do notneed to provide a password. By defaul t, guest users can access the project,browse objects, run and manipulate reports, but they cannot create theirown objects or schedule report executions. However, you determine what






the Guest user can and cannot do by modi fying the Publ ic user group.Guest users inheri t their privi leges from the Publ ic group; they are not partof the Everyone group.

LDAP authentication

Lightweight Directory Access Protocol (LDAP) authentication identi fiesusers wi thin a reposi tory of users stored in an LDAP server (such as Novel lDirectory Services). If you use an LDAP directory to central ly manage usersin your environment, you may want to use LDAP authentication. Groupmembership can be maintained in the LDAP directory wi thout having to alsobe defined in the MicroStrategy Intel l igence Server. When using LDAPauthentication, LDAP users or groups are l inked to users or groups in theMicroStrategy environment.

Login ID and password entered by the user for the warehouse: Databaseauthentication

This mode of database authentication identi fies users using a login ID andpassword stored in the data warehouse database. Under this mode ofauthentication, a warehouse database is associated with each project.When users log in to a project source, they are logging in to the Intel l igenceServer. Use database authentication i f you want the data warehouseRDBMS to be the authori ty for identi fying users and you do not want tomaintain user credentials in the Intel l igence Server as wel l as the RDBMS.

Integrated authentication

Integrated authentication enables a Windows user to log in once to theirWindows machine. The user does not need to log in again separately toMicroStrategy Developer or MicroStrategy Web. This type of authenticationuses Kerberos to val idate a user's credentials.



Configuring MicroStrategy with a Response FileThe Configuration Wizard walks you through the process of setting up theenvironment for the MicroStrategy products instal led in your system. Youcan also configure server defini tions, project source names, an EnterpriseManager project, and the metadata, History List, and statistics reposi toriesusing a response fi le wi th the Configuration Wizard. This enables you toprovide a configuration fi le to users to complete the configuration tasks,rather than requiring users to step through the Configuration Wizard. Thiscan be done to configure a MicroStrategy instal lation on Windows andLinux.

The Configuration Wizard can also be used to perform MicroStrategyupgrades and create an Enterprise Manager project. These tasks can alsobe accompl ished by using a response fi le:

l For steps to upgrade MicroStrategy using a response fi le, see theUpgrade Guide.

l For steps to create an Enterprise Manager project wi th a response fi le,see the Enterprise Manager Guide.

Creating a response file

It is recommended that you always create the response fi le through thegraphical interface of the Configuration Wizard, as described in theprocedure To create a response fi le, page 416 in this section. This ensuresthat al l appl icable options are included in the response fi le wi th val idvalues.

However, you can also create and use a response fi le wi th theConfiguration Wizard in command l ine mode on Linux machines. For stepsto create and use a response fi le as wel l as perform other configurationsusing command l ine tools in Linux, see the Configuring MicroStrategy witha response.ini fi le, page 693 section in Chapter 12, ConfiguringMicroStrategy Using Command Line Tools.





To create a response file

1. Open the MicroStrategy Configuration Wizard. To do this, see Toconfigure MicroStrategy through the Configuration Wizard, page 385.

2. Any configuration tasks you complete wi th the Configuration Wizardcan be saved to a response fi le. For steps to complete variousconfigurations tasks with the Configuration Wizard, see the sectionsl isted below:

l Creating Metadata, History List, and Statistics Reposi tories, page388

l Setting up MicroStrategy Intel l igence Server, page 401

l Creating Project Sources, page 408

3. Once you reach the Summary page for a configuration, cl ick Save. TheSave dialog box opens.

4. Speci fy a name and location to save the response fi le, and cl ick Save.You are returned to the Summary page.

5. To also perform the configuration task, cl ick Finish . The summaryinformation is updated as the configurations are completed, providinga way to track the progress of the configurations.

Steps to use a response fi le to configure MicroStrategy are covered inUsing a response fi le to configure MicroStrategy instal lations, page 417below.

You can modi fy a response fi le wi th a text edi tor to make configurationchanges such as entering di fferent user login and password information.For information on the parameters and options avai lable in response fi les,see Response configuration parameters and options, page 418.



Using a response file to configure MicroStrategy installations

Rather than stepping through each page of the Configuration Wizard, youcan configure MicroStrategy using a response fi le. You have the fol lowingoptions to use a response fi le to configure MicroStrategy:

l To use a response fi le wi th the Configuration Wizard, page 417: Thiscovers the standard procedure of running a response fi le wi th theConfiguration Wizard interface.

l To use a response fi le through the Windows command l ine, page 418:This covers the procedure of running a response fi le from the Windowscommand l ine. This enables users to run the fi le wi thout using anygraphical user interfaces.

If you are configuring a MicroStrategy instal lation on Linux, you can use acommand l ine version of the Configuration Wizard to create and use aresponse fi le. For steps to create and use a response fi le as wel l asperform other configurations using command l ine tools in Linux, see theConfiguring MicroStrategy with a response.ini fi le, page 693 section inChapter 12, Configuring MicroStrategy Using Command Line Tools.

l Configuring MicroStrategy components wi th System Manager: You canuse a Configuration Wizard response fi le as part of an System Managerworkflow. System Manager lets you define multiple configurations for yourMicroStrategy environment that can be executed in a single workflow. Forinformation on using MicroStrategy System Manager to configure anddeploy your MicroStrategy environments, see the System AdministrationGuide.

To use a response file with the Configuration Wizard

1. Open the MicroStrategy Configuration Wizard. To do this, see Toconfigure MicroStrategy through the Configuration Wizard, page 385.

2. Cl ick Load . The Open dialog box displays.





3. Browse to the path where the response fi le is saved and cl ick Open .The Summary page opens.

4. An overview of al l of the configuration tasks performed by the responsefi le is displayed. Review the configuration tasks and cl ick Finish toperform the configuration. The summary information is updated as theconfigurations are completed, providing a way to track the progress ofthe configurations.

To use a response file through the Windows command line

The steps below are speci fic to configuring MicroStrategy instal led onWindows. For steps to create and use a response fi le as wel l as performother configurations using command l ine tools in Linux, see Chapter 12,Configuring MicroStrategy Using Command Line Tools.

1. Type the fol lowing command in the Windows command l ine:macfgwiz.exe -r "Path\response.ini"

Where Path\ is the ful ly qual i fied path to the response fi le. Forexample, the common location of a response fi le is:

C:\Program Files\Common

Files\MicroStrategy\RESPONSE.INI

2. If an error message is displayed, check the path and name yousuppl ied for the response fi le and make any required changes. Repeatthe previous step to execute the configuration.

Response configuration parameters and options

It is recommended that you always create the response fi le through the GUImode of the Configuration Wizard. However, you can also modi fy aresponse fi le wi th a text edi tor to make minor changes such as enteringdi fferent user login and password information.

The file must be saved with ANSI encoding.



The response fi le for configuring MicroStrategy is divided into three areasof configuration, which are described in the sections below:

l Creating metadata, History List, and statistics reposi tories, page 419

l Setting up MicroStrategy Intel l igence Server, page 422

l Creating and configuring project sources, page 426

l Creating and Configuring the Enterprise Manager Project

l Creating and Configuring the Platform Analytics Project

Creating metadata, History List, and statistics repositories

The response fi le parameters wi thin the [Repository] section definehow metadata, History List, and statistics and Enterprise Managerreposi tories are created. The table below l ists the avai lable parameters andthe functional i ty of avai lable options for each parameter.

Options Description

[Repository]This sect ion conf igures the metadata repository and stat ist ics tables. Youcan have more than one [Repository] sect ion. Addit ional repositorysect ions can be included as [Repository1], [Repository2], and so on.

Repository=

Def ines whether a metadata, History List , and stat ist ics repositories areconf igured, as determined by the following values:

• 1: Conf igures metadata, History List , and stat ist ics repositories.

• 0: Does not conf igure metadata, History List , and stat ist ics repositories.

CreateMDTables=

Def ines whether metadata tables are created in a metadata repository, asdescribed below:

• 1: Creates metadata tables in the metadata repository and creates adefault conf igurat ion

• 0: Does not create metadata tables in a metadata repository

CreateHistLi Def ines whether a History List repository is created, as determined by the



Options Description

stTables=

following values:

• 1: Creates a History List repository.

• 0: Does not create a History List repository.

CreateStatTables=

Def ines whether stat ist ics and Enterprise Manager repositories are created,as determined by the following values:

• 1: Creates stat ist ics and Enterprise Manager repositories.

• 0: Does not create stat ist ics and Enterprise Manager repositories.

MetadataPath=

Locates the SQL scripts for creat ing the metadata tables. Example paths toSQL scripts in dif ferent environments are listed below:

• 64-bit Windows environment: C:\Program Files (x86)\CommonFiles\MicroStrategy\MD8SQL8.sql.

• Linux: /INTELLIGENCE_SERVER_INSTALL_PATH/mdsql.sql.

HistoryListPath=

Locates the SQL scripts for creat ing the History List repository. Examplepaths to SQL scripts in dif ferent environments are listed below:

• 64-bit Windows environment: C:\Program Files (x86)\Common

Files\MicroStrategy\content_server_db_Oracle.sql.

• Linux: /INTELLIGENCE_SERVER_INSTALL_PATH/content_server_db_Oracle.sql.

Stat ist icsPath=

Locates the SQL scripts for creat ing the stat ist ics and Enterprise Managerrepositories. Example paths to SQL scripts in dif ferent environments arelisted below:

• 64-bit Windows environment: C:\Program Files (x86)\CommonFiles\MicroStrategy\StatisticsEnterpriseManagerScripts\DDLScripts\CreateTablesScript.sql

• Linux: /INTELLIGENCE_SERVER_INSTALL_PATH/statistics_DB2.sql.

DSNName=Def ines the Data Source Name for conf iguring a metadata repository in theODBC database.

UserName= Def ines the user name to log in to the database containing the metadata



Options Description

repository.

UserPwd=Def ines the password to log in to the database containing the metadatarepository.

DSNNameHist=

Def ines the Data Source Name for conf iguring the History List repository inthe ODBC database.

UserNameHist=

Def ines the user name to log in to the database for conf iguring the HistoryList repository.

UserPwdHist=

Def ines the password to log in to the database for conf iguring the History Listrepository.

DSNNameStats=

Def ines the Data Source Name for conf iguring the stat ist ics and EnterpriseManager repositories in the ODBC database.

UserNameStats=

Def ines the user name to log in to the database for conf iguring the stat ist icsand Enterprise Manager repositories.

UserPwdStats=

Def ines the password to log in to the database for conf iguring the stat ist icsand Enterprise Manager repositories.

EncryptPassword=

Def ines whether the password is encrypted in the response f i le, asdetermined by the following values:

• 0: The password is not encrypted in the response f i le, which enables youto modify the password in the response f i le later using a text editor. Youcan then dist ribute the response f i le to mult iple users with various loginand password credent ials. However, be aware that this can compromiseyour database security if you do not remove the password from theresponse f i le before dist ribut ing it .

• 1: Encrypts the password in the response f i le, which ensures that yourpassword is secure. This is the default behavior.

DBName=Def ines the database name to create tables in DB2 z/OS. This opt ion shouldonly be used when connect ing to a DB2 z/OS database.

TBName=Def ines the tablespace name to be created in the database.This opt ionshould only be used when connect ing to a DB2 z/OS database.



Setting up MicroStrategy Intelligence Server

The response fi le parameters wi thin the [Server] section configures anIntel l igence Server defini tion. The table below l ists the avai lableparameters and the functional i ty of avai lable options for each parameter.

Options Description

[Server]

In this sect ion you can conf igure the Intell igence Serverdef init ion. You can have more than one [Server]

sect ion. Addit ional server sect ions can be included as[Server1], [Server2], and so on.

Server=

Def ines whether MicroStrategy Intell igence Server isconf igured, as determined by the following values:

• 1: Conf igures MicroStrategy Intell igence Server

• 0: Does not conf igure MicroStrategy Intell igenceServer

Act ion=

Def ines whether a server def init ion is created, used, ordeleted, as determined by the following values:

• 1: Creates a new server def init ion

• 2: Uses an exist ing server def init ion

• 3: Deletes an exist ing server def init ion

• 4: Creates a new server def init ion and uses it as thedefault

InstanceName=

Def ines the name of the Intell igence Server instance.

I f you select to delete Intell igence Server instances, youcan delete mult iple instances by list ing mult iple instancenames, separat ing each name with the \ character. Forexample,InstanceName=ServerInstance1\ServerInstan

ce2.

ProjectsToRegister=Def ines projects to be loaded when Intell igence Server isstarted. You can select to load mult iple projects,



Options Description

separat ing projects by the \character. For example,ProjectsToRegister=Project1\Project2 .

ProjectsToUnRegister=

Def ines projects to not be loaded when Intell igenceServer is started. You can select to not load mult ipleprojects, separat ing projects by the \ character. Forexample,ProjectsToUnRegister=Project1\Project2 .

DSName=Def ines the data source name for conf iguring theMicroStrategy Intell igence Server. This is the datasource that stores the metadata.

DSNUser=Def ines the user name to log in to the metadatadatabase.

DSNPwd= Def ines the password to log in to the metadata database.

EncryptPassword=

Def ines whether the password is encrypted in theresponse f i le, as determined by the following values:

• 0: The password is not encrypted in the response f i le,which enables you to modify the password in theresponse f i le later using a text editor. You can thendist ribute the response f i le to mult iple users withvarious login and password credent ials. However, beaware that this can compromise your databasesecurity if you do not remove the password from theresponse f i le before dist ribut ing it .

• 1: Encrypts the password in the response f i le, whichensures that your password is secure. This is thedefault behavior.

DSSUser=Def ines the MicroStrategy user name to log in to theproject .

DSSPwd=Def ines the password for the MicroStrategy user name tolog in to the project .



Options Description

MDPref ix=Def ines a pref ix for metadata repository tables used bythe server def init ion.

UseAsDefault=

Def ines whether the Intell igence Server def init ion is setas the default server def init ion to use for Intell igenceServer, as determined by the following values:

• True: Def ines the Intell igence Server def init ion asthe default server def init ion

• False: Does not def ine the Intell igence Serverdef init ion as the default server def init ion

Port=Def ines the port used by the Intell igence Server.Bydefault , the port is 34952.

RestPort=Def ines the port used by the REST API Server. Bydefault , the port is 34962.

RegisterAsService=

This opt ion is only available on Intell igence Serversrunning on Linux operat ing systems.

Def ines whether Intell igence Server is registered as aservice. Registering Intell igence Server as a service isdetermined by the following values:

• 1: Registers Intell igence Server as a service.Performing this task requires a Linux login with rootlevel access and privi leges.

• 0: Does not register Intell igence Server as a service.

StartServerAf ter Conf ig=

Def ines whether Intell igence Server is started af terapplying the conf igurat ion, as determined by thefollowing values:

• 1: Intell igence Server is started af ter successfullyapplying the conf igurat ion.

• 0: Intell igence Server is not started af ter applying theconf igurat ion.



Options Description

Conf igureSSL=

Def ines whether to enable Intell igence Server andDeveloper to communicate using the SSL protocol, asdetermined by the following values:

• 1: Enables the use of the SSL protocol forIntell igence Server and Developer communicat ions.

• 0: Disables the use of the SSL protocol forIntell igence Server and Developer communicat ions.

SSLPort=Def ines the port to use for SSL access. By default , theport is 39321.

Cert if icatePath=Locates the SSL cert if icate f i le you created forIntell igence Server. Type the full path to the SSLcert if icate f i le.

KeyPath=Locates private key f i le you created while request ing thecert if icate for Intell igence Server. Type the full path tothe private key f i le.

KeyPassword=Def ines the password that you used while creat ing theprivate key for the SSL cert if icate.

DefaultStat ist icsRep

Specif ies whether you can create a default stat ist icsdatabase instance for the all of the projects of the localIntell igence Server metadata, as determined by thefollowing values:

• 1: You can create a default stat ist ics databaseinstance, using the stat ist ics parameters listed in thistable below.

• 0: A default stat ist ics database instance is notcreated.

DefaultDSNNameDefaultStat ist ics

Specif ies the data source name for your stat ist icsrepository.

UserNameDefaultStat ist icsSpecif ies the database user name for the user that canconnect to the stat ist ics data source.



Options Description

UserPwdDefaultStat ist icsSpecif ies the password for the user that can connect tothe stat ist ics data source.

EncryptUserPwdDefaultStat ist ics

Def ines whether the stat ist ics user password is encryptedin the response f i le, as determined by the followingvalues:

• 0: The password is not encrypted in the response f i le,which enables you to modify the password in theresponse f i le later using a text editor. You can thendist ribute the response f i le to mult iple users withvarious login and password credent ials. However, beaware that this can compromise your databasesecurity if you do not remove the password from theresponse f i le before dist ribut ing it .

• 1: Encrypts the password in the response f i le, whichensures that your password is secure. This is thedefault behavior.

DefaultStat ist icsPref ixDef ines a pref ix for stat ist ics repository tables used bythe server def init ion.

kafkaHost(s)=Provide host name or IP addressee of MessagingServices. Format for this set t ing should be:server1.acme.com:9092, server2.acme.com:9093, . . .

Conf igMessagingService=Enable or disable Messaging Services for Intell igenceServer and conf igure Messaging Services host and portset t ings.

Creating and configuring project sources

The response fi le parameters wi thin the [Client] section create andconfigure project sources. The table below l ists the avai lable parametersand the functional i ty of avai lable options for each parameter.



Options Description

[Client ]In this sect ion you can conf igure the project source name. You canhave more than one [Client] sect ion. Addit ional cl ient sect ions canbe included as [Client1], [Client2], and so on.

Client=

Def ines whether project sources are conf igured, as determined by thefollowing values:

• 1: Conf igures project sources

• 0: Does not conf igure project sources

EncryptPassword=

Def ines whether the password is encrypted in the response f i le, asdetermined by the following values:

• 0: The password is not encrypted in the response f i le, whichenables you to modify the password in the response f i le later using atext editor. You can then dist ribute the response f i le to mult ipleusers with various login and password credent ials. However, beaware that this can compromise your database security if you do notremove the password from the response f i le before dist ribut ing it .

• 1: Encrypts the password in the response f i le, which ensures thatyour password is secure. This is the default behavior.

DataSource= Def ines the name of the new project source to create.

ConnType=

Def ines the database connect ion type for a project source. Thefollowing connect ion types are supported:

• 2: Connects a project source to the metadata using an ODBC DSN(Windows only).

• 3: Connects a project source to the metadata through aMicroStrategy Intell igence Server (three-t ier).

DSN=If using connect ion type 2 (ConnType=2), def ines the name of theODBC database.

UserName=If using connect ion type 2 (ConnType=2), def ines the user name toconnect to the ODBC database.

UserPwd= If using connect ion type 2 (ConnType=2), def ines the password to log



Options Description

in to the database.

ServerName=If using connect ion type 3 (ConnType=3), def ines the name of theMicroStrategy Intell igence Server to connect to.

Port=

I f using connect ion type 3 (ConnType=3), def ines the port number forthe Intell igence Server when creat ing a server (three-t ier) projectsource. The default port number for MicroStrategy Intell igence Serveris 34952.

Authent icat ion=

The following authent icat ion modes are supported:

• 1: Standard or login ID and password entered by the user

• 2: Network login ID (Windows authent icat ion)

• 8: Guest account (Anonymous authent icat ion)

• 16: LDAP authent icat ion

• 32: Database login ID and password (database authent icat ion)

• 128: Integrated authent icat ion

For informat ion on the available authent icat ion modes, see theAuthent icat ion modes, page 412.

MDPref ix=I f using connect ion type 2 (ConnType=2), def ines a pref ix formetadata repository tables.

Timeout=

Def ines and enforce a connect ion t ime out for inact ive users connectedto a project source. The following values are supported:

• 0: Def ines that users are not disconnected from project sources dueto inact ivity.

• Numerical value greater than 0: A numerical value (in minutes)greater than 0 def ines the amount of inact ivity that is allowed beforea user is automat ically disconnected from a project source.

Creating and Configuring the Enterprise Manager Project

The parameters in the [EMProjectHeader] portion of the response fi lecreate the Enterprise Manager project on this machine and configure the



connection to the Statistics and Enterprise Manager reposi tory. The tablebelow l ists the avai lable parameters and the functional i ty of avai lableoptions for each parameter. For detai led information about each parameter,see the Configuration Wizard Help.

Options Description

[EMProjectHeader]Opt ions in this port ion refer to creat ing the EnterpriseManager project on this machine.

EMProject=

Def ines whether to create the Enterprise Manager project , asdetermined by the following values:

• 1: Create Enterprise Manager project on this machine.

• 0: Do not create the Enterprise Manager project .

EMProjectEncryptPwd=

Def ines whether the passwords are encrypted in the responsef i le, as determined by the following values:

• 0: The passwords are not encrypted in the response f i le,which enables you to modify the passwords in theresponse f i le using a text editor. You can then dist ributethe response f i le to mult iple users with various login andpassword credent ials. However, be aware that this cancompromise your database security if you do not removethe passwords from the response f i le before dist ribut ing it .

• 1: Encrypts the passwords in the response f i le, whichensures that your passwords are secure. This is thedefault behavior.

EMProjectDSSUser= The user name to log in to the Enterprise Manager project .

EMProjectDSSPwd=

The password for the user name above. This may beencrypted, depending on the EMProjectEncryptPwd=

set t ing.

EMProjectPkgFile=

The full path and f i le name of the MicroStrategy EnterpriseManager project package f i le used to create the project . OnWindows, by default this is C:\Program Files

(x86)\Common Files\MicroStrategy\OOTB-EM.mmp.



Options Description

EMProjectDSNName=The Data Source Name for the database that contains yourStat ist ics and Enterprise Manager repository.

EMProjectDSNUserName=The user name to connect to the Stat ist ics and EnterpriseManager repository database.

EMProjectDSNUserPwd=

The password for the user name above for the Stat ist ics andEnterprise Manager repository database. This may beencrypted, depending on the EMProjectEncryptPwd=

set t ing.

Creating and Configuring the Platform Analytics Project

The parameters in the [PAProjectHeader] portion of the response fi lecreate the Platform Analytics project on this machine and configure theconnection to the Platform Analytics reposi tory. The table below l ists theavai lable parameters and the functional i ty of avai lable options for eachparameter. For detai led information about each parameter, see theConfiguration Wizard Help.

Options Description

[PAProjectHeader]Opt ions in this port ion refer to creat ing the Plat form Analyt icsproject on this machine.

PAProject=

Def ines whether to create the Plat form Analyt ics project , asdetermined by the following values:

l 1: Create Plat form Analyt ics project on this machine.

l 0: Do not create the Plat form Analyt ics project .

PAProjectEncryptPwd

=

Def ines whether the passwords are encrypted in the responsef i le, as determined by the following values:

l 0: The passwords are not encrypted in the response f i le,which enables you to modify the passwords in the response



Options Description

f i le using a text editor. You can then dist ribute the responsef i le to mult iple users with various login and passwordcredent ials. However, be aware that this can compromiseyour database security if you do not remove the passwordsfrom the response f i le before dist ribut ing it .

l 1: Encrypts the passwords in the response f i le, whichensures that your passwords are secure. This is the defaultbehavior.

PAProjectDSSUser=The user name to log in to the Plat form Analyt ics project .

PAProjectDSSPwd=

The password for the user name above. This may beencrypted, depending on the PAProjectEncryptPwd=

set t ing.

PAProjectPkgFile=

Beginning with MicroStrategy 2020, this f i le wil l be removedand the default project package wil l be used.

The full path and f i le name of the MicroStrategy Plat formAnalyt ics project package f i le used to create the project .

On Windows, by default this is C: \Program Files(x86)\CommonFiles\MicroStrategy\Plat formAnalyt icsProjectObjects.mmp

PAConfigurePkgFile=

Beginning with MicroStrategy 2020, this f i le wil l be removedand the default project package wil l be used.

The full path and f i le name of the MicroStrategy Plat formAnalyt ics project conf igurat ion package f i le used to create theproject .

On Windows, by default this is C: \Program Files(x86)\CommonFiles\MicroStrategy\Plat formAnalyt icsConf igurat ionObjects.mmp.

PAProjectDSNName=The Data Source Name for the database that contains yourPlat form Analyt ics repository.



Options Description

PAProjectDSNUserNam

e=

The user name to connect to the Plat form Analyt ics repositorydatabase.

PAProjectDSNUserPwd=The password for the user name above for the Plat formAnalyt ics repository database. This may be encrypted,depending on the PAProjectEncryptPwd= set t ing.

PAProjectDSNPrefix= The pref ix for the Plat form Analyt ics repository tables.

Encryption Key ManagerEncryption Key Manager (EKM) creates and manages unique encryptionkeys for every MicroStrategy environment. The EKM features includecreating, importing, and exporting of these unique keys throughConfiguration Wizard. These keys encrypt potential ly sensi tive informationstored in the metadata, cube, cache, history l ist, and session recovery fi les.

Terms and Definitions

l Master Key: The master key encrypts the key store and is saved in themaster key fi le. MicroStrategy Intel l igence Server wi l l look for the path tothe master key in the registry upon start up.

l Key Store: Contains keys used to encrypt the metadata and fi le caches.These keys are encrypted by the master key.

l Secure Bundle: A password protected fi le that enables administrators tosecurely deploy encryption keys between clustered Intel l igence Serversor servers sharing the same metadata.

l Secure Bundle Code: The password used to protect the Secure Bundlefi le.



High Level Steps to Use the Encryption Key Manager

1. Enable the Encryption Key Manager Feature and restart Intel l igenceServer.

2. Using Configuration Wizard:

l Update the metadata to apply the new encryption keys.

l Export the Secure Bundle.

3. To configure addi tional nodes in a clustered environment:

l Enable the Encryption Key Manager Feature and restart Intel l igenceServer.

l Import the Secure Bundle to each node using Configuration Wizard.

Enable the Encryption Key Manager Feature

The Encryption Key Manager is disabled by default.

Windows

To enable the Encryption Key Manager:

1. Open the Registry Edi tor

2. Navigate to HKEY_LOCAL_MACHINE > SOFTWARE >Wow6432Node > MicroStrategy > Feature Flags.

3. Double cl ick KE/EncryptionKeyManager.

4. Change the Value Data field from 0 to 1.

5. Cl ick OK .

6. Restart Intel l igence Server.

If Configuration Wizard is open it must be restarted as well.



Linux

To enable the Encryption Key Manager:

1. Locate the MSIReg.reg fi le in your MicroStrategy root instal l di rectory.

2. Modi fy the fol lowing in a text edi tor:

Change

[HKEY_LOCAL_MACHINE\SOFTWARE\MicroStrategy\Feature

Flags]

"KE/EncryptionKeyManager"=dword:00000000

to

[HKEY_LOCAL_MACHINE\SOFTWARE\MicroStrategy\Feature

Flags]

"KE/EncryptionKeyManager"=dword:00000001

3. Save and close.


If Configuration Wizard is open it must be restarted as well.

Updating the Metadata with Encryption Key Manager

Once Encryption Key Manager is enabled the metadata must be updated tobecome encrypted. The encryption keys and master key are automatical lygenerated and stored local ly during the metadata upgrade. See the Updatethe Metadata chapter in the Upgrade Guide for steps to complete thisprocess.

Managing Encryption Key Configuration Options

The import and export features of EKM al low you to securely share andtransmit encryption keys using a secure bundle.




Importing and Exporting Encryption Keys to a Secure Bundle

Clustered Intel l igence Servers or servers sharing the same metadata mustuse the same set for encryption keys. This is accompl ished by exporting thesecure bundle from the fi rst configured Intel l igence Server and thenimporting the secure bundle to the other servers.

For recovery purposes you should export and store a secure bundle outs ide ofyour MicroStrategy environment, even if you are only using a singleIntelligence Server instance. You will not be able to recover the informationstored in your metadata without the secure bundle and secure bundle code.

Exporting to a Secure Bundle

1. Open Configuration Wizard.

2. Select Manage Encryption Keys.

3. Cl ick Next.

4. Select Export encryption keys to a Secure Bundle.

5. Cl ick Next.

6. Enter your Administrator user name and password.

7. Cl ick Next.

8. Accept the auto-generated Secure Bundle Code or cl ick the refreshbutton to regenerate the code.

Record the generated code value. It wi l l be needed for the importingprocess.

9. Cl ick Next.

10. Cl ick Finish to export the Secure Bundle.

11. Review the message on the warning dialog box and cl ick OK .



Importing a Secure Bundle

You can use this option to configure addi tional nodes in a clusteredenvironment. Ensure that you have updated the metadata associated withthe Intel l igence Server before importing the Secure Bundle.

1. Copy the exported Secure Bundle to the target Intel l igence Server.



4. Cl ick Next.

5. Select Import encryption keys from a Secure Bundle

6. Cl ick Next.


8. Cl ick Next.

9. Cl ick the browse button and navigate to the Secure Bundle location.

10. Cl ick Open to select the fi le.

11. Enter the Secure Bundle Code from the export process.

12. Cl ick Next.

13. Cl ick Finish to import the Secure Bundle.

14. Review the message on the warning dialog box and cl ick OK

Generating a New Master Key




4. Cl ick Next.



5. Select Generate New Master Key.

6. Cl ick Next.


8. Cl ick Next.

9. The location of the current Master Key and the destination for the newMaster Key are displayed.

10. Cl ick Next.

11. Cl ick Finish to generate the new Master Key.

Changing the Master Key Location

To modi fy the location where the Intel l igence Server looks for the MasterKey fi le:




4. Cl ick Next.

5. Select Change Master Key Location .

6. Cl ick Next.


8. Cl ick Next.

9. Cl ick the browse button and navigate to the new location for the MasterKey.

10. Speci fy a name for the Master Key fi le and cl ick Save.



11. Cl ick Finish to change the Masker Key location.

12. Review the message on the warning dialog box and cl ick OK .

Connecting to a Data Warehouse and OtherRepositories

For MicroStrategy users to be able to browse attribute elements andexecute reports, a connection to a data warehouse must be created. Aconnection to other data sources can also support History Lists, statistics,and including data from multiple data sources into your MicroStrategyproject.

You can perform data source connection tasks from the ProjectConfiguration Edi tor, which can be accessed by right-cl icking a project andselecting Project Configuration .

The tasks described in this section require MicroStrategy Administratorpriv ileges.

Specifying Warehouse Connection InformationA database instance is a MicroStrategy object, created in MicroStrategyDeveloper by an administrator, that represents a connection to a datasource. A database instance speci fies connection information, such as thedata source name, Login ID and password, and other data source speci ficinformation.

The steps to create the required components of a database instance areprovided in the following sections: Creating a database instance, page443 , Creating a database connection, page 447 , and Creating adatabase login, page 453 .

When a project archi tect creates a project, the archi tect assigns a databaseinstance to that project. A project speci fies only one warehouse database



instance at a time, but a database instance can be assigned to multipleprojects. Since only one data source can be included in the project'srelational schema, al l reports and documents return information from asingle data source.

If you have a l icense for the MultiSource Option feature, you can connect aproject to mul tiple warehouse database instances. There can be multipledata sources that connect to the Warehouse Catalog for the project. Sincethese data source can be integrated as part of the project's relationalschema, al l reports and documents can return information from multipledata sources. For information on accessing multiple data sources in aproject, see the Project Design Guide.

Regardless of whether you have a l icense for the MultiSource Option, youcan also extend a project's access to multiple data sources through otherMicroStrategy features. Freeform SQL, Query Bui lder, and supportingaccess through MicroStrategy to other MDX cube sources such as SAP BW,Oracle Essbase, and Microsoft Analysis Services al lows non-projectdatabase instances to be included and used in a project along with thewarehouse database instances. For information on Freeform SQL andQuery Bui lder, see the Advanced Reporting Guide. For information on MDXcube sources, see the MDX Cube Reporting Guide

These non-project database instances can al low a project to connect to thedata sources for the various features and addi tional data sourcesmentioned above, instead of accessing the data from the project's relationalschema. For more information on the Warehouse Catalog, see the ProjectDesign Guide.

SQL data warehouses database instances

A SQL data warehouse database instance is any database instance thatconnects to a database or other data source through SQL queries. Morespeci fical ly, this covers database instances used for standardMicroStrategy reporting, Freeform SQL, Query Bui lder, data marts, and any








other relational data source. You can also connect to History List andstatistics tables through SQL data warehouse database instances. The SQLdata warehouse database instances are avai lable in the ProjectConfiguration Edi tor, as shown below.

Selecting a database instance check box makes that database instanceavai lable in the project for standard MicroStrategy reporting, data marts,Query Bui lder, and Freeform SQL. If you have a l icense for the MultiSourceOption, selecting a check box for a database instance also makes thedatabase instance avai lable from the Warehouse Catalog to be part of theproject's relational schema.

Database instances can be created as part of the Import Data feature. Adatabase instance used for the Import Data feature is displayed with the

icon. These database instances are created with security permissions for theuser that created them while using the Import Data feature. If you select one ofthese database instances to be included as an available database instance inthe project, it is recommended that you change the security permissions to aMicroStrategy user with administrative priv ileges. This includes takingownership of the database instance and defining an appropriate access control



lis t. This ensures that no changes are made to the database instance by otherusers, which could cause a loss of connectiv ity to the data source. Forinformation on the Import Data feature, refer to the MicroStrategy Web onlinehelp.

The shading and color of a database instance in the l ist of relationaldatabase instances reflects how the database instance is being used in theproject:

l Blue text: This is the warehouse database instance, as selected from thewarehouse database instance drop-down l ist. There can only be onewarehouse database instance for a project, because this databaseinstance's data is populated in the Warehouse Catalog to define theproject's relational schema. You cannot choose to disable the warehousedatabase instance for the project wi thout fi rst selecting a di fferentwarehouse database instance.

If you have a l icense for the MultiSource Option, the primary databaseinstance acts as the main source of data for a project and is used as thedefaul t database instance for tables added to the project.

For information on the Warehouse Catalog as wel l as accessing multipledata sources with the MultiSource Option, see the Project Design Guide.

l Bold text: The project contains objects that are dependent on thedatabase instance. You cannot choose to disable a database instancethat has dependent objects for the project.

l Normal text: The database instance is not being used in the project.

Clearing the check box of a database instance removes the databaseinstance from the project and deletes any unused Freeform SQL or QueryBui lder schemas. You can clear a database instance from a project only i fthere are no dependent objects in the project for the database instance. Formore information on removing a database instance and related FreeformSQL and Query Bui lder schemas from a project, refer to the SystemAdministration Guide.






MDX cube database instances

An MDX cube database instance is any database instance that connects toan MDX cube source, such as SAP BW, Oracle Essbase, or MicrosoftAnalysis Services. For information on connecting to and reporting on theseMDX cube sources, refer to the MDX Cube Reporting Guide. The MDX cubedatabase instances are avai lable in the Project Configuration Edi tor, asshown below.

A database instance that has an MDX cube schema is represented withbold text. The shading and color of a database instance in the l ist ofrelational database instances reflects how the database instance is beingused in the project:

l Bold : The project contains objects that are dependent on the databaseinstance. You cannot choose to disable a database instance that hasdependent objects for the project.

l Normal: The database instance is not being used in the project.




If you remove an MDX cube database instance from a project, you candelete any unused MDX cube schema objects. You can remove databaseinstance from a project only i f there are no dependent objects in the projectfor the database instance. For more information on removing a databaseinstance and related MDX cube managed objects from a project, refer to theSystem Administration Guide.

For addi tional information on configuring MDX cube database instances,refer to the MDX Cube Reporting Guide.

MDX schema loading and maintenance

You can cl ick Schema Maintenance to perform various tasks for an MDXcube schema that is part of your project, as described below:

l You can choose when an MDX cube schema associated with a databaseinstance is loaded for a project. By defaul t, MDX cube schemas areloaded as needed when MDX cube reports are executed. You can alsochoose to load MDX cube schemas when Intel l igence Server starts. Forinformation on defining when MDX cube schemas should be loaded, referto the MDX Cube Reporting Guide.

l When you integrate MDX cube sources into MicroStrategy, the data isintegrated as an MDX cube schema. Once you integrate an MDX cubesource into MicroStrategy, you can exchange the database instance usedto connect to the MDX cube schema for a di fferent database instance.This al lows you to use di fferent database instances with di fferent loginand connection information to access an MDX cube schema. Forinformation on exchanging the database instance used to connect to theMDX cube schema, refer to the MDX Cube Reporting Guide.

Creating a database instance

Database instances are created and modi fied in the Database InstanceManager, which can be found by expanding Administration for a project







source, then expanding Configuration Managers. When you choose tocreate a new database instance, the Database Instances Edi tor opens.

You can also create a new database instance using the Database InstanceWizard that is available in the Database Instance Manager shortcut menu.

The Database Instances Edi tor has the fol lowing tabs:

l General—speci fies the database instance name, connection type (datasource platform or appl icable data source), and defaul t databaseconnection.

The database connection type you choose should match your data sourceand determines whether the database instance is a relational or an MDXcube database instance.

l Advanced—speci fies the database name for intermediate table storage i fa database other than the warehouse is used to store intermediate tables,as wel l as other options.



The Advanced tab is not avai lable for MDX cube database instances.

l Job Priori tization—speci fies the job priori tization scheme for the instanceand the number of priori tized connections.

To create a database instance

1. In MicroStrategy Developer, log in to a project source withadministrative privi leges.

2. Go to Administration > Configuration Managers > DatabaseInstances.

3. From the File menu, go to New > Database Instance. The DatabaseInstances Edi tor opens.

4. On the General tab, in the Database instance name field, type thename of the database instance.

5. In the Database connection type drop-down l ist, select the datasource connection type according to the data source hosting yourdatabase.

If you have upgraded from a previous version of MicroStrategy, you canclick Upgrade to retrieve any database connection types that have beenincluded since the previous version of MicroStrategy that you used.

6. On the Advanced tab, you can configure various options for thedatabase instance, including:

l Intermediate table storage: You can speci fy the database name andtable name space to use when intermediate tables are created.Intermediate tables are created to support various queries.

l Database gateway support: You can support backwardscompatibi l i ty for database gateway support from MicroStrategyversion 6.x.



To enable database gateway support, select the Primary databaseinstance check box, and then select a primary database instancefrom the drop-down l ist. The primary database instance is thedatabase instance that should be used for element browsing againstthe selected table and for queries that do not require joins to othertables. For information on database gateway support, see the ProjectDesign Guide.

l Data mart optimization : You can support data mart optimization i fthe data source for the database instance is in the same data sourcethat contains data marts.

To enable data mart optimization, select the This database instanceis located in the same warehouse as check box, and then select adatabase instance from the drop-down l ist.

l Table prefix: If the tables in your data source use a table prefix, youcan include the table prefix to identi fy the proper col lection of tables.Cl ick Select to select a table prefix or define a new table prefix.

l ODBC Version : You can define which ODBC version to use for thedatabase instance, as described below:

n Use 2.0 ODBC Calls: ODBC 2.0 was used in pre-9.0 versions ofMicroStrategy. You can use this option for backward compatibi l i tyi f your database management system does not support ODBC 3.x.This also al lows you to use extended fetch to retrieve blocks ofdata from the database into memory, instead of row by row, whichis included in the steps Speci fying Warehouse ConnectionInformation, page 438.

n Use 3.x ODBC Calls: The support of ODBC 3.x is introduced inMicroStrategy 9.0. This value is chosen by defaul t for DatabaseInstances in MicroStrategy 9.x and higher.You should use thisoption i f your database management system supports ODBC 3.x.





ODBC 3.x wi l l always use extended fetch (SQLFetchScrol l ) toretrieve blocks of data from the database into memory rather thanrow-by-row retrieval .

7. On the Job Prioritization tab, you can configure how jobs arepriori tized for the database instance. For information on configuringjob priori tization, see the System Administration Guide.

8. On the General tab, in the Database connection (default) pane,select the defaul t data source connection and cl ick OK.

If the necessary database connection does not exist, you can createone by cl icking New. For steps to create a database connection,see Creating a database connection, page 447 below.

Creating a database connection

A database connection speci fies the DSN and database login used toaccess the data source. A database instance designates one databaseconnection as the defaul t connection for MicroStrategy users; however,users and groups can be mapped to other database connections usingconnection mapping. For more detai ls on connection mapping, see Userconnection mapping, page 455.

You create database connections in the Database Instances Edi tor bycl icking New on the General tab. Any database connection created withinthe Database Instances Edi tor is avai lable for use across al l databaseinstances in the project source. For more information on creating adatabase connection for MDX cube sources, refer to the MDX CubeReporting Guide.

When you choose to create a new database connection, the DatabaseConnections dialog box opens:






The Database Connections dialog box has di fferent options depending onthe database instance type:

l SQL data warehouse database instances

n General : Speci fies the database connection name, the warehouse DSN,and the defaul t database login.

n Advanced: Speci fies the database driver mode, driver execution mode,and other miscel laneous warehouse connection settings.

l MDX cube database instances

n General : Speci fies the database connection name, the defaul t databaselogin, and addi tional connection information that you must provide. Formore information on creating a database connection for MDX cubesources, see the MDX Cube Reporting Guide.

n Advanced: Speci fies the connection settings, addi tional connectionstring parameters, and connection caching settings.




To create a database connection

Before moving forward, ensure that a database instance has been created asdescribed in Creating a database instance, page 443 .

1. On the General tab, in the Database connection name box, type aname to identi fy the database connection.

2. In the Local system ODBC data sources pane, select the data sourcename for the data source.

3. On the Advanced tab, you can define various options per yourrequirements and the requirements of the database you are connectingto, including:

l Database driver mode: Select one of the fol lowing database drivermodes:

l Multi-process: Each connection to the warehouse database isspawned as a separate process, identi fied in Windows TaskManager as M8DBMPE.exe . If one process fai ls, such as when adatabase access thread hangs or is lost, other processes are notaffected.

l Multi-threaded : Al l connections to the warehouse database aremaintained inside the Intel l igence Server process MSTRSVR.exe .Al l connections, SQL submissions, and data retrievals from thedatabase are handled within this process.

MicroStrategy recommends setting al l database drivers to multi -process mode. The robustness and stabi l i ty which come with multi -process mode greatly overshadow any increased efficiency thatmay come with multi -threaded mode. Problems that appear randomand sporadic in mul ti -threaded operation can often be resolved byswitching to multi -process mode.



l Driver execution mode: Define the driver execution modedepending on the ODBC driver being used:

l Asynchronous Connection : Al l statements al located within theconnection should be able to run SQL asynchronously.

l Asynchronous Statement: For each statement, the asynchronousmode is expl ici tly set.

l Synchronous: Only one statement executes at a time. This is thedefaul t value.

Many newer ODBC drivers do not support asynchronous modebecause the driver is capable of opening a new thread and executing anew query while simultaneously running an earlier query. TheMicroStrategy Readme gives recommendations for the driverexecution mode options that can be used for different ODBC drivers.

l Use extended fetch : Select this check box to enable Intel l igenceServer to fetch blocks of data from the database into memory,instead of row-by-row. Be aware that this check box is only avai lablei f the database instance is defined to use 2.0 ODBC cal ls, which isincluded in the steps Speci fying Warehouse Connection Information,page 438. When 3.0 ODBC cal ls are enabled, extended fetch isalready enabled and this option is grayed out.

l Use parameterized queries: Select this check box to enableIntel l igence Server to pass data to the database in blocks instead ofrow-by-row. For information on how parameterized queries canimprove performance in MicroStrategy, see the Project DesignGuide.

l Maximum cancel attempt time (sec): Defines the maximum amountof time the MicroStrategy Query Engine wai ts for a successful





attempt before i t cancels a query. Values of 0 and -1 indicate nol imi t.

l Maximum query execution time (sec): Defines the maximumamount of time a single pass of SQL can execute on the database.Values of 0 and -1 indicate no l imi t.

l Maximum connection attempt time (sec): Defines the maximumamount of time Intel l igence Server wai ts to connect to the database.Values of 0 and -1 indicate no l imi t.

l Additional connection string parameters: Enables you to passaddi tional ODBC connection parameters to the database as part ofthe connection string. This is useful i f you need to change ODBCdefaul ts. Cl ick Preview to see the enti re connection string.

l Table prefix: Defines a table prefix that speci fies the schemacontaining the tables to access.

l Character set encoding for Windows drivers: The options l istedbelow are only relevant when Intel l igence Server is running on aWindows machine:

n Non UTF-8 (defaul t): Select this option i f the ODBC driver returnsinformation in a character encoding other than UTF-8.

n UTF-8: Select this option i f the ODBC driver returns information inUTF-8 character encoding. Drivers for Teradata databases mayrequire UTF-8 encoding.

l Character set encoding for UNIX drivers: The options l isted beloware only relevant when Intel l igence Server is running on a UNIXmachine:

n Non UTF-8: Select this option i f the ODBC driver returnsinformation in a character encoding other than UTF-8.



n UTF-8 (defaul t): Select this option i f the ODBC driver returnsinformation in UTF-8 character encoding. Drivers for Teradatadatabases may require UTF-8 encoding.

l Connection Caching : Speci fy the caching of the databaseconnection using the fol lowing options:

n Connection idle timeout (sec): Defines the amount of time aninactive connection to the database remains cached unti l i t isterminated. You must also set the Connection l i fetime, describedabove, to a value greater than zero for database connections to beused by more than a single job.

Enforcement of the connection idle timeout can cause a databaseconnection to be removed before i t reaches i ts connection l i fetime.You can use this connection idle timeout to ensure that databaseconnections do not remain in Intel l igence Server memory in an idlestate for an extended amount of time.



If you type a value of 0, when the job associated with a databaseconnection is completed, the database connection is deleted andnot put into a cache. If you type a value of -1, a database



connection can remain idle and considered for new jobs unti l thedatabase connection l i fetime is reached.

4. On the General tab, in the Default database login name pane, selectthe defaul t database login and cl ick OK .

If the necessary database login does not exist, you can create one bycl icking New. For steps to create a database connection, see Creatinga database login, page 453 below.

Creating a database login

A database login speci fies the user ID and password used to access thedata source. The database login overwri tes any login information stored inthe DSN. A database connection designates one database login as thedefaul t login for MicroStrategy users, however users and groups can bemapped to other database logins using connection mapping.

Connection mapping is explained in User connection mapping, page 455 .

You create database logins in the Database Connections dialog box bycl icking New on the General tab. Any database login created within theDatabase Connections dialog box is avai lable for use across al l databaseconnections in the project source.

MicroStrategy reporting and analysis features require a general set ofdatabase login permissions that can connect to and modi fy the data sourceand metadata, as described below:

l For the metadata, the Select, Insert, and Update permissions arerequired. Intermediate tables are created in the metadata for recursivesearch queries, which requires Create and Drop permissions as wel l .Updating the schema requires the Delete permission.

l For the data warehouse, the Select, Create, Insert, and Drop permissionsare required.



When you choose to create a new database login, the Database loginsdialog box opens:

To create a database login

Before moving forward, ensure that the following is complete:

l A database instance has been created, as described in Creating a databaseinstance, page 443 .

l A database connection has been created, as described in Creating adatabase connection, page 447 .

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 fol lowing methods:

l Type the user ID in the Login ID field, and type the password for thatuser ID in the Password field.

l Select the Use network login ID check box to connect to the datasource using the network user credentials which are also used to runIntel l igence Server. If Intel l igence Server is running as a service,this is the user that is running the mstrsvr.exe process. Todetermine this user, in MicroStrategy Service Manager, selectMicroStrategy Intelligence Server and cl ick Options. The user isl isted on the Service Startup tab, in the Login field. If the Service



Account Name is defined as System Account, the Windows usercredentials are used to access the data source.

3. Cl ick OK.

Database logins are passed to the data source any time a user executes areport or browses attribute elements. Therefore, all database logins created inMicroStrategy Developer must be also be created as valid logins in the datasource.

User connection mapping

User connection mapping is the process of mapping MicroStrategy users todatabase connections and database logins. For MicroStrategy users toexecute reports, they must be mapped to a database connection anddatabase login.

MicroStrategy users l ink to database connections and logins using:

l The defaul t database connection (and, therefore, defaul t database login)

l Special ized maps to a database connection and/or database login(di fferent than the defaul t connection and login) for ei ther a user or usergroup

You can map users to connections and logins in the Project ConfigurationEdi tor or Command Manager. For information about how connection mapsare used, see the System Administration Guide.

MicroStrategy reporting and analysis features require a general set ofdatabase login permissions to connect to and modi fy the data warehouseand metadata, as described below:

l For the metadata, the Select, Insert, and Update permissions arerequired. Intermediate tables are created in the metadata for recursivesearch queries, which requires Create and Drop permissions as wel l .Updating the schema requires the Delete permission.




l For the data warehouse, the Select, Create, Insert, and Drop permissionsare required.

To create a connection map

Before moving forward, ensure that the following is complete:

l A database instance has been created, as described in Creating a databaseinstance, page 443 .

l A database connection has been created, as described in Creating adatabase connection, page 447 .

l A database login has been created, as described in Creating a databaselogin, page 453 .

1. In Developer, log in to a project.

2. Right-cl ick the project and select Project Configuration . The ProjectConfiguration Edi tor opens.

3. In the Categories l ist, expand the Database Instances category, andthen select Connection mapping .

4. Right-cl ick in the Database instances - Connection mapping pane,and select New. A new connection mapping is added.

5. You can define the connection mapping by speci fying the informationdescribed below:

l Database Instance: The database instance which connects to thedata source required for the connection mapping.

l User: The user or user group to apply the connection mapping to.

l Language: The language of the data accessed by the connectionmapping. You can use connection mappings to support datainternational ization. For information on supporting data



international ization with connection mappings, see the ProjectDesign Guide.

l Database connection : The data source to connect to.

l Database Login : The database login for the connection mapping.

6. Cl ick OK .

Related

If the table information is not updated, al though you have performed correctsteps, see KB483323: Unable to update table structure in MicroStrategyDeveloper Warehouse Catalog.

Creating a Project

Now you have configured Intel l igence Server and are ready to create aproject. There are various ways to create a project to get your MicroStrategyproject started. The di fferent methods to create a project are described inthe Project Design Guide.

The MicroStrategy platform provides a Tutorial project, which is a sample datawarehouse and demonstration project you can use to learn about the variousfeatures that MicroStrategy offers. It is ready to be used and requires noadditional configuration tasks. To use the MicroStrategy Tutorial, refer to theBasic Reporting Guide for more information. To create a new project usingyour own data, see the Project Design Guide .

How to Connect the Intelligence Server to a specificExport Engine

By defaul t, the Intel l igence Server connects to the NEE on the samemachine as i t through port number 20100. Based on this connection NEE




https://community.microstrategy.com/s/article/Unable-to-update-table-structure-in-MicroStrategy-Developer-Warehouse-Catalog

https://community.microstrategy.com/s/article/Unable-to-update-table-structure-in-MicroStrategy-Developer-Warehouse-Catalog


https://www2.microstrategy.com/producthelp/2020/BasicReporting/WebHelp/Lang_1033/index.htm



services wi l l start on port 20100, and the Intel l igence Server wi l l accesslocalhost's port 20100 for export.

However, you can configure the NEE and Intel l igence Server defaul tsettings to connect to a speci fic export engine.

Configuring the Intelligence Server1. Open the registry fi le.

2. Edi t the NEE's application.properties fi le to set the host to thelocation of the NEE service, and the port value of server.port property.

3. On Linux, edi t the host and port on MicroStrategy/MSIReg.reg:

HKEY_LOCAL_MACHINE\SOFTWARE\MicroStrategy\DSS

Server\PDFExporter

l host: localhost

l port: dword:00004e84

4. On Windows, open regedit to change the host and port under HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\MicroStrategy\DSS

Server\PDFExporter .

5. Restart the Intel l igence Server.

6. Open the registry fi le.

Configuring NEE to Use a Specific Port Number1. Edi t the PDFExportService/application.properties fi le.

2. Change the server.port property to match your selected port.

3. Restart the PDFExporterService.

Once you change the port number, you must also update the value in theIntelligence Server's registry to ensure that the server can access the updatedNEE service.




To help guide the rest of your instal lation and configuration steps, refer tothe section Instal l ing and Configuring MicroStrategy on Windows, page 135in Chapter 1, Planning Your Instal lation, for an instal lation andconfiguration checkl ist.

Data Import with Proxy

Introduction to Data Import with ProxyThis section provides an overview of al l of the capabi l i ties to get datathrough proxy. You wi l l learn how to best leverage these capabi l i ties toimport data and create or update your datasets.

Background

Many enterprise customers cannot import data from URL sources, as theyare in a proxy environment. This considerably inhibi ts their abi l i ty to ingestdata from external sources, and l imi ts MicroStrategy's abi l i ty to analyze thedata. Supporting proxy considerably increases their abi l i ty to analyze anythi rd-party data that is currently avai lable via import from URL. There arealso customers in a proxy environment who cannot access Facebook,Twitter, or other OAuth sources. In short, supporting proxy configuration isneeded for customers in some l imi ted network environment, which is typicalin enterprise deployments.

Currently, we do not support the proxy feature on data from URL. There ispartial support in some OAuth sources, such as Twitter or Facebook, butconfigurations are not uni fied on di fferent platforms, which may causeconfusion. Furthermore, we do not support PAC (Proxy Auto-Config) toconfigure the proxy.

See also How to Configure a Proxy.



How to Configure a Proxy

How to Configure a Proxy in Intelligence Server for Windows

1. Find the configuration fi le.

After you instal l or update Workstation for Windows to 10.11 or later,the defaul t configuration fi le, proxy.json , is instal led automatical ly.

The fi le proxy.json is located in C:\Program Files

(x86)\Common Files\MicroStrategy for Intelligence

Server by defaul t.

2. Configure the proxy.json fi le.

Open proxy.json with a text edi tor. The fol lowing is the defaul tconfiguration:

{

"ENABLE_FLAG": "FALSE",

"USE_PROXY_PAC": "FALSE",

"PAC_URL": "",

"USE_PROXY_STATIC": "FALSE",

"PROXY_HOST": "",

"PROXY_PORT": "",

"PROXY_AUTHENTICATION": "FALSE",

"USER_NAME": "",

"PASSWORD": ""

}

You want to access data through the following authenticated proxy:

l Host: 10.0.0.1

l Port: 8080



l Username: mstr

l Password: 123456

Configure proxy.json as follows:

{

"ENABLE_FLAG": "TRUE",


"PAC_URL": "",

"USE_PROXY_STATIC": "TRUE",

"PROXY_HOST": "10.0.0.1",

"PROXY_PORT": "8080",

"PROXY_AUTHENTICATION": "TRUE",

"USER_NAME": "mstr",

"PASSWORD": "123456"

}

If the proxy server is not authenticated, then just set PROXY_AUTHENTICATION to FALSE. Configure it like this:

{



"PAC_URL": "",

"USE_PROXY_STATIC": "TRUE",

"PROXY_HOST": "10.0.0.1",

"PROXY_PORT": "8080",

"PROXY_AUTHENTICATION": "FALSE",

"USER_NAME": "",

"PASSWORD": ""

}

If you use a PAC file to configure your proxy, the PAC file location isC:/Config . Configure your proxy.json as follows:



{


"USE_PROXY_PAC": "TRUE",

"PAC_URL": "c:/config/example.pac",

"USE_PROXY_STATIC": "FALSE",

"PROXY_HOST": "",

"PROXY_PORT": "",

"PROXY_AUTHENTICATION": "",

"USER_NAME": "",

"PASSWORD": ""

}

You must configure the proxy correctly for it to take effect. Data accessissues occur if the format is correct, but the proxy server is inaccessible.


4. Veri fy your data.

If you veri fy data from a URL, you can import data from a source thatwas previously inaccessible.

You should always restart the Intelligence Server after changing theproxy configuration or the PAC file.

To verify that the proxy is taking effect, retrieve a proxy log by enablingthe RESTWrapper Info log in the MicroStrategy Diagnostics andPerformance Logging Tool.

How to Configure a Proxy in Workstation (Windows or Mac) and theIntelligence Server (Linux)

The steps for other platforms are simi lar to configuring the Intel l igenceServer for Windows. The di fference is the proxy.json fi le location andthe method to restart the server.

On Windows, proxy.json is located in C:\Program

Files\MicroStrategy\Workstation .



On Linux, proxy.json is located in <InstallPath>/install

directory. <InstallPath> is chosen by the user.

On MacOS , proxy.json is located in /Applications/MicroStrategy

Workstation.app/Contents/Frameworks/OneTierDashboardwin

dow.framework/Resources by defaul t.

Configuration Field Descriptions

Item Description

ENABLE_FLAG

Enable or disable the proxy. If the flag is false, theproxy does not take effect, regardless of the valuesin other fields.

USE_PROXY_PACSet USE_PROXY_PAC or USE_PROXY_STATIC toTRUE to turn on the PAC mode or static mode.

PAC_URL

Specify the path of the PAC file. Both local andonline files are supported, such asZ:/BIN/X64/demo.pac orhttp://test/demo.pac .

USE_PROXY_STATICI f this flag is set to TRUE , PROXY_HOST andPROXY_PORT are set as the static proxy server.

PROXY_HOST The static proxy host name or IP address

PROXY_PORT The static proxy host port (numbers only)

PROXY_AUTHENTICATION

Static proxy authentication flag. If this flag is true,use specif ied USER_NAME and PASSWORD toaccess the static proxy server. This is supportedonly in static mode, PAC mode is currently notsupported.

USER_NAME User name to access the static proxy server

PASSWORD Password to access the static proxy server



The ENABLE_FLAG is set to FALSE by defaul t. This means any proxyconfigured in this fi le takes effect when you configure the system proxy. Ifyou want to use proxy, turn on the proxy feature by setting ENABLE_FLAG

to TRUE .

To verify that the proxy is taking effect, retrieve a proxy log by enabling theRESTWrapper Info log in the MicroStrategy Diagnostics and PerformanceLogging Tool.

Priority

There are two levels of proxy settings in MicroStrategy.

l The higher priori ty level is the server-level configuration, which isconfigured in proxy.json .

l The lower priori ty level is the system configuration, which is anenvironment variable in Linux or MacOS, and internet properties inWindows.

Limitation

The proxy setting is global . MicroStrategy uses the same proxy, even i f adi fferent user logs in.



DEPLOYINGM ICROSTRATEGY WEBAND MOBILE SERVER



This chapter describes the procedure to deploy a project to your usercommunity using MicroStrategy Web and Mobi le Server. The process ofdeploying the .NET version of MicroStrategy Web or MicroStrategy Mobi leServer on Windows with Microsoft Internet Information Services (IIS) isexplained in detai l .

Steps to deploy MicroStrategy Web (JSP) and MicroStrategy Mobi le Server(JSP) in a Linux and Windows environment wi th various Web andappl ication servers are also explained in detai l . MicroStrategy Web (JSP)and Mobi le Server (JSP) are platform-independent and can be deployedusing di fferent combinations of operating systems, Web servers, andappl ication servers.

Web application servers are not MicroStrategy products, so detailed stepscannot be provided for every combination of application server and operatingsystem. This chapter supplies instructions for a few of the most commoncombinations. The procedures for different operating systems are similar, butyou should refer to the vendor-provided information and documentation fordetails specific to your configuration, or contact MicroStrategy TechnicalSupport.

MicroStrategy Web simpl i fies the job of deploying to large user groupsbecause end users' machines only need a supported browser.MicroStrategy Web can be accessed from any supported browser becauseno code must be downloaded. Working as a thin cl ient, MicroStrategy Webprovides the functional i ty that end users and power users require to takeful l advantage of the MicroStrategy product sui te.

Deploying with IIS (Windows)

Microsoft IIS can be used to deploy MicroStrategy Web and MicroStrategyMobi le Server:



Deploying MicroStrategy WebsThe ASP.NET version of MicroStrategy Web can be deployed with IIS onlyon Windows.

l For information on supporting IIS 7.x, see and Supporting IIS 7.0.x or IIS7.5.x as a web server for MicroStrategy Web or Mobi le Server, page 110 .

l You must have administrative priv ileges to deploy MicroStrategy Web for yourproject. If this is the first time you are logging in and you have not changed thedefault MicroStrategy administrative login, you can use Administrator as thelogin with no password. After the first time, the user name and password shouldbe changed for security purposes.

l The Microsoft Windows' Users group must have read and execute permissionsto all of the files within the MicroStrategy common files folder. This ensures thatInternet Information Services has the required permissions to hostMicroStrategy Web. By default, this folder is stored in the following directorylocation:

64-bit Windows environments:

l C:\Program Files (x86)\Common Files\MicroStrategy

l C:\Program Files (x86)\MicroStrategy

To connect MicroStrategy Web to your Intelligence Server

1. On the Windows Start menu, point to Programs, then toMicroStrategy Tools, and then choose Web Administrator. TheMicroStrategy Web Administrator page opens. This is the page whereyou connect MicroStrategy Web to the Intel l igence Server.

2. Type the name of your Intel l igence Server in the Add a servermanually box on the MicroStrategy Web Administrator page.



3. Cl ick Connect. Al l projects loaded on the Intel l igence Server are nowavai lable from MicroStrategy Web. Cl ick the Home icon to see the l istof projects loaded on the Intel l igence Server you speci fied.

4. Send your users the URL:

http://webservername/MicroStrategy/asp/

where webservername is the name of the computer hosting your Webserver. For example, i f the name of your Web server machine is Web_

Srv1 , then the URL your users would use to access MicroStrategyWeb would be

http://Web_Srv1/MicroStrategy/asp

You have manual ly connected MicroStrategy Web to the Intel l igenceServer.

You can also connect automatical ly whenever MicroStrategy Web Server orIntel l igence Server starts.

To make MicroStrategy Web connect to the Intelligence Server

automatically

1. On the MicroStrategy Web Administrator page, cl ick Modify in theProperties column of the Intel l igence Server.

2. Select the Automatically connect to Intelligence Server when WebServer or Intelligence Server is restarted option and cl ick Save.

Deploying Mobile ServerThe ASP.NET version of MicroStrategy Mobi le Server can only be deployedwith IIS only on Windows.

For information on supporting IIS 7.x, see Supporting IIS 7.0.x or IIS 7.5.xas a web server for MicroStrategy Web or Mobi le Server, page 110.



You must have administrative privi leges to deploy MicroStrategy Mobi leServer for your project. If this is the fi rst time you are logging in and youhave not changed the defaul t MicroStrategy administrative login, you canuse Administrator as the login wi th no password. After the fi rst time, theuser name and password should be changed for securi ty purposes.

The Users group for Microsoft Windows must have read and executepermissions to al l of the fi les wi thin the MicroStrategy common fi les folder.This ensures that IIS has the required permissions to host MicroStrategyMobi le Server. By defaul t, this folder is stored in the fol lowing directorylocation:

64-bi t Windows environments: C:\Program Files\Common

Files\MicroStrategy

64-bi t Windows environments: C:\Program Files (x86)\Common

Files\MicroStrategy

To connect MicroStrategy Mobile Server to your Intelligence Server

1. In Windows, go to Start > Programs > MicroStrategy Tools > MobileAdministrator.

2. Type the name of your Intel l igence Server in the Add a servermanually box on the MicroStrategy Mobi le Server Administrator page.

3. Cl ick Connect.

4. Cl ick Mobile Configuration to configure your MicroStrategy Mobi leappl ications to communicate with Mobi le Server and Intel l igenceServer. For steps on how to define this configuration, see theMicroStrategy Mobi le Administration Guide.

You have manual ly connected MicroStrategy Mobi le Server to theIntel l igence Server.

You can also connect automatical ly whenever MicroStrategy Mobi le Serveror Intel l igence Server starts.




To make MicroStrategy Mobile Server connect to the Intelligence

Server automatically

1. On the MicroStrategy Mobi le Server Administrator page, cl ick Modifyin the Properties column of the Intel l igence Server.

2. Select the Automatically connect to Intelligence Server whenMobile Server or Intelligence Server is restarted option.

3. Cl ick Save.

General Steps to Deploy MicroStrategy JSPApplications

After you have instal led MicroStrategy Web (JSP), Mobi le Server (JSP) youcan deploy and configure i t for your speci fic environment. The configurationand deployment steps are provided in the Web server and appl icationserver sections in this chapter. The table below l ists the general steps foral l environments.

MicroStrategy Web JSP1. Log on to the appl ication server by using the proper user name and

password.

2. Locate the MicroStrategy.war fi le in the MicroStrategy Web (JSP)Deployment Directory you speci fied during instal lation.

3. To increase the performance of the appl ication before proceeding withthe deployment, see the Performance-based setup information section,i f avai lable, for your environment and configure as necessary. Also,after deploying MicroStrategy Web (JSP) on your machine, there maybe a few performance-based setup steps that you should complete.



4. Choose the desired deployment method and fol low the deploymentprocedure.

5. Log on to the MicroStrategy Web Administrator Page.

6. Launch MicroStrategy Web.

7. Start working with the appl ication.

You must perform extra configuration steps to allow graphs to support non-Western European fonts on MicroStrategy Web (JSP) for a Linux system. Formore information, see Graph and Document Support of Non-WesternEuropean Fonts, page 898 of Appendix B, Troubleshooting .

MicroStrategy Mobile Server (JSP)1. Log on to the appl ication server by using the proper user name and

password.

2. Locate the MicroStrategyMobile.war fi le in the MicroStrategy Mobi leServer (JSP) Deployment Directory you speci fied during instal lation.

3. To increase the performance of the appl ication before proceeding withthe deployment, see the Performance-based setup information section,i f avai lable, for your environment and configure as necessary. Also,after deploying MicroStrategy Mobi le Server (JSP) on your machine,there may be a few performance-based setup steps that you shouldcomplete.

4. Choose the desired deployment method and fol low the deploymentprocedure.

5. Log on to the MicroStrategy Mobi le Server Administrator Page.

6. From the MicroStrategy Mobi le Server Administrator Page, configureyour MicroStrategy Mobi le appl ications to communicate with Mobi leServer and Intel l igence Server. For steps on how to define thisconfiguration, as wel l as steps to deploy and configure a certi ficate



server for Mobi le Server, see the MicroStrategy Mobi le AdministrationGuide.

7. Start working with the appl ication.

Locating the WAR FileThe MicroStrategy JSP appl ications are packaged within single fi les foreach appl ication, cal led a WAR (Web ARchive) fi le, fol lowing J2EEspeci fications. You must deploy the WAR fi le to run the JSP appl ications inyour appl ication server environment.

The WAR fi les are placed in the folder you speci fied when instal l ingMicroStrategy JSP appl ications. The defaul t locations are as fol lows:

Component and WAR File Name Default WAR File Location

MicroStrategy Web (JSP)

MicroStrategy.war

• 32-bit Windows environments: C:\ProgramFiles\MicroStrategy\WebJSP

• 64-bit Windows environments: C:\Program Files

(x86)\MicroStrategy\WebJSP

• Linux environments: INSTALL_PATH/WebUniversal

Where INSTALL_PATH is the directory you specified as theMicroStrategy install directory dur ing installation.

MicroStrategy Mobile Server(JSP)

MicroStrategyMobile.war

• 32-bit Windows environments: C:\ProgramFiles\MicroStrategy\Mobile Server JSP

• 64-bit Windows environments: C:\Program Files

(x86)\MicroStrategy\Mobile Server JSP

• Linux environments: INSTALL_PATH/Mobile

Where INSTALL_PATH is the directory you specified as theMicroStrategy install directory dur ing installation.

To deploy the appl ication, you must fol low a set of steps that are speci fic tothe appl ication server you are using. For more detai ls, see the appl icationserver vendor documentation or fol low the instructions within this guide.





After deploying a WAR fi le, you can view the WEB-INF folder, whichcontains a subfolder named log . The log folder retains al l the log fi les.For more information on the directory structure after deploying the WAR fi le,see Directory Structure After Deploying the WAR Fi le, page 474.

Locating the Configuration FilesIf you have configured your appl ication server to deploy exploded WARfi les, the sys_defaults and sys_definitions XML configuration fi lesare located in /WEB-INF/xml in the exploded directory. In Tomcat, theseexploded directories are located in the webapps/ subdirectory of the Tomcatinstal lation.

l When deploying MicroStrategy Web (JSP), the exploded directory isnamed MicroStrategy by defaul t.

l When deploying MicroStrategy Mobi le Server (JSP), the explodeddirectory is named MicroStrategyMobile by defaul t.

If you have configured your appl ication server to deploy an unexplodedWAR fi le, the configuration fi les are created in the system's defaul ttemporary fi le di rectory. For Windows systems, the temporary fi le di rectoryis usual ly C:\Users\[Username]\AppData\Local \Temp\[Number]\microstrategy\web-[Version]J\. For example,C:\Users\Administrator\AppData\Local \Temp\1\microstrategy\web-10.4.0800.0156J\. For Linux systems, the temporary fi le di rectory is usual ly/tmp/ or /var/tmp/ .

l When deploying MicroStrategy Web (JSP), a /microstrategy/web-

Version/ folder is created in the temporary fi le di rectory, whereVersion is the version number for the MicroStrategy Web (JSP) product.Within this folder location, various configuration fi les can be found withinthe WEB-INF folder and i ts subfolders.

l When deploying MicroStrategy Mobi le Server (JSP), a/microstrategy/mobile-Version/ folder is created in thetemporary fi le di rectory, where Version is the version number for the



MicroStrategy Mobi le Server (JSP) product. Within this folder location,various configuration fi les can be found within the WEB-INF folder and i tssubfolders.

Directory Structure After Deploying the WAR FileThe fol lowing tables show the defaul t di rectory structure after deployingMicroStrategy WAR fi les in your appl ication server.

MicroStrategy Web

Directory Contents






\META-INF Conf igurat ion f i les






\WEB-INFConf igurat ion informat ion for MicroStrategyWeb



MicroStrategy Mobile Server

Directory Contents






\META-INF Conf igurat ion f i les





\WEB-INFConf igurat ion informat ion for MicroStrategyMobile Server

Deploying with WebLogic and Apache (Solaris)

This section provides information used to deploy and configureMicroStrategy JSP appl ications on the Oracle Solaris operating system,using Apache as the Web server and Oracle WebLogic Server as theappl ication server. It provides information for WebLogic 12.2.1.3. You canalso the steps below to deploy MicroStrategy Web (JSP) and MicroStrategyMobi le Server (JSP).

This section includes the fol lowing information:

l WebLogic Paths and Folder Locations, page 476: Defaul t folder structurefor each version of WebLogic



l Preconfiguration Information, page 477: Configuration that must occurbefore you begin deploying MicroStrategy Web (JSP) and Mobi le Server(JSP).

l Deploying MicroStrategy Web and Mobi le Server, page 478: Instructionsfor deploying the appl ication

l Re-deploy the Appl ication, page 488: Instructions for re-deploying theappl ication

l Performance-Based Setup Information, page 488: Optional configurationsettings to increase the appl ication's performance.

The additional configuration steps are not required for MicroStrategy Web(JSP) to run, but these settings can increase its performance. Review theperformance-based setup information prior to deploying the system to see ifthese changes are of interest to you.

WebLogic Paths and Folder LocationsThis section presents the defaul t folder structure for each version ofWebLogic, and provides the variable used throughout the rest of thischapter to represent the WebLogic mydomain folder path.

Each version of WebLogic is instal led with a di fferent defaul t path to theWebLogic mydomain folder. When deploying MicroStrategy Web (JSP), youmust make some changes within the WebLogic folders. Thus, i t is importantto understand the WebLogic folder structure for the version of WebLogicyou are using. The fol lowing path reflects the defaul t folder structure forWebLogic 12.2.1.3: WEBLOGIC_HOME/user_projects/domains/mydomain/

l WEBLOGIC_HOME is the WebLogic Server home path.

l The folder structures are configurable and your organization may havechanged the default names or path.



Throughout this chapter, the WebLogic mydomain folder is referred to asWEBLOGIC_MYDOMAIN_FOLDER . This variable refers to the WebLogicmydomain folder in whatever location i t resides on your system. Thelocation of this variable is based on the version of WebLogic and whetheryour organization has changed the version's defaul t name or path.

Preconfiguration InformationThis section provides the preconfiguration information necessary to deployyour MicroStrategy JSP appl ications on your machine.

This section supports the configuration outl ined in the fol lowing table.Whi le your setup may vary sl ightly, for example, you may have di fferentversions of these appl ications, the overal l process remains the same.

Requirement Recommended

Operat ing system Oracle Solaris 10.x or 11.x (on SPARC)

Web server Apache 2.x

Applicat ion server WebLogic 12.2.1.3

JDKOracle JDK 1.6.0 or 1.7.0

You can download the JDK here.

For information on the version numbers supported or certified byMicroStrategy, see the MicroStrategy Readme .

For information on installing these products, seehttp://www.oracle.com/technology/products/weblogic/i

ntegration/index.html

Before you start the deployment process, locate the machine name and IPaddress.


http://www.oracle.com/technetwork/java/index.html

http://www.oracle.com/technology/products/weblogic/integration/index.html

http://www.oracle.com/technology/products/weblogic/integration/index.html


Setting up Apache Web Server to Proxy Requests to WebLogic

You can have the Apache Web server and WebLogic Server runningindependently on the same machine, but to configure Apache to proxy thedesired requests to the WebLogic Server, you must instal l a plug-inprovided by WebLogic. Complete the instructions at the fol lowing URLs toinstal l and configure the plug-in.

For WebLogic 12.2.1.3, the URL is:

http://e-docs.bea.com/wls/docs100/plugins/apache.html

Instal l the plug-in wi th the WebLogic instal lation in the fol lowing location:

WEBLOGIC_HOME/wlserver_10.3/server/plugin/solaris/sparc/

where WEBLOGIC_HOME is the path to the WebLogic Server.

To increase the performance of MicroStrategy Web (JSP), you can completeadditional setup configurations before the deployment. For more information,see Performance-Based Setup Information, page 488 .

Deploying MicroStrategy Web and Mobile ServerWhen your machine has been configured with the necessary settings, youcan deploy the JSP version of MicroStrategy Web and Mobi le Server wi thApache and WebLogic.

The Performance-Based Setup Information, page 488 section providesinformation on additional settings to increase application performance. Theseadditional settings are not required but can increase the performance ofMicroStrategy Web (JSP). Review this information prior to deployment to seeif these options are of interest to you.

You can deploy MicroStrategy Web and Mobi le Server using one of thefol lowing deployment methods:


http://e-docs.bea.com/wls/docs100/plugins/apache.html


l The automatic deployment feature is the easiest and fastest way. SeeDeploying automatical ly (development mode), page 479. Choose thedevelopment mode in the /WEBLOGIC_MYDOMAIN_FOLDER/bin/startWebLogic.sh fi le, wi thin the WebLogic Serverfolder structure.

l The manual deployment feature can be used for environments where theserver is running in production mode and the automatic deployment isturned OFF. For more information, see Deploying manual ly (productionmode), page 482.

Deploying automatically (development mode)

When automatic deployment is set to ON, as soon as you place a WAR fi lein the /WEBLOGIC_MYDOMAIN_FOLDER/autodeploy folder, theappl ication is automatical ly deployed.

With this method you can deploy from:

l A dupl icate WAR fi le. When you deploy from a dupl icate WAR fi le, youare required to manual ly configure the web.xml fi le wi thin the WAR fi leto al low access to certain folders. Once this configuration is complete andthe WAR fi le is recompi led, the JSP appl ication can be deployed usingthe single WAR fi le.

l An exploded directory where al l the fi les contained in the WAR fi le wereextracted. When you deploy from an exploded directory, al l of the fi lesand folders wi thin the WAR fi le are exposed to WebLogic. This al lowsWebLogic access to the required folders so that i t can make anynecessary configuration changes to fi les in the exploded directory.



To automatically deploy MicroStrategy JSP applications from a

duplicate WAR file

1. Locate the WAR fi le for your MicroStrategy JSP appl ication, asdescribed in Locating the WAR Fi le, page 472.

2. [Optional ] Rename the WAR fi le to a name you can easi ly identi fy andremember. This name is the context_name used in the uni formresource locator (URL) to access the fi le.

If you do not change the name of the file, remember to replace context_name with MicroStrategy when accessing the application from the URL.

To modify the web.xml fi le for multiple MicroStrategy deployments

If you are deploying more than one MicroStrategy environments on thesame WebLogic appl ication server, prior to deployment, you must modi fythe web.xml fi le as described below.

1. Unzip the WAR fi le by using the fol lowing command:

jar -xvf FileName.war

Where FileName is the name of the WAR fi le for your MicroStrategyJSP appl ication.

2. Open the web.xml fi le located in the /WEB-INF directory.

3. Modi fy the contextPath parameter. By defaul t, this parameter doesnot have a value. Type a unique string for the value of thecontextPath parameter. For example, type WebDep2 .

4. Save the web.xml fi le.

5. Zip the WAR fi le by using the fol lowing command:

jar -cvf FileName.war *



Where FileName is the name of the WAR fi le for your MicroStrategyJSP appl ication

To deploy the WAR fi le

1. Transfer the WAR fi le to the fol lowing directory:

/WEBLOGIC_MYDOMAIN_FOLDER/autodeploy

2. The appl ication is automatical ly deployed. To add and connect to anIntel l igence Server, see Configuring administrative access toMicroStrategy JSP appl ications, page 485.

To increase the performance of MicroStrategy Web JSP, you canconfigure additional settings after deployment. For more information, seePerformance-Based Setup Information, page 488 .

To automatically deploy MicroStrategy JSP applications from an

exploded directory

The WAR file must be uncompressed by the same user who started theapplication.


2. Create the fol lowing new folder:/home/username/context_folder

where username is your account name used to access the Web servermachine, and context_folder is the name of the new folder.

You can create the new folder anywhere except in the following location:

/WEBLOGIC_MYDOMAIN_FOLDER/autodeploy

3. Copy the WAR fi le to the new folder.



4. To explode the WAR fi le inside the folder you created, run thefol lowing command:

# jar -xvf FileName.war


5. Delete the WAR fi le by using the fol lowing command:

# rm FileName.war


6. Move the folder to the autodeploy folder wi th the fol lowingcommands:

# cd..

# mv context_folder /WEBLOGIC_MYDOMAIN_

FOLDER/autodeploy

The appl ication is automatical ly deployed. To add and connect to anIntel l igence Server, see Configuring administrative access to MicroStrategyJSP appl ications, page 485.

To increase the performance of MicroStrategy Web (JSP), you can configureadditional settings after deployment. For more information, see Performance-Based Setup Information, page 488 .

Deploying manually (production mode)

With manual deployment you can deploy MicroStrategy JSP appl icationsfrom:

l A dupl icate WAR fi le. When you deploy from a dupl icate WAR fi le, youare required to manual ly configure the web.xml fi le wi thin the WAR fi leto al low access to certain folders. Once this configuration is complete and



the WAR fi le is recompi led, the JSP appl ication can be deployed usingthe single WAR fi le.

l An exploded directory where al l the fi les contained in the WAR fi le wereextracted. When you deploy from an exploded directory, al l of the fi lesand folders wi thin the WAR fi le are exposed to WebLogic. This al lowsWebLogic to access the required folders to perform any necessaryconfigurations to fi les in the exploded directory.

Perform the deployment in the /WEBLOGIC_MYDOMAIN_

FOLDER/autodeploy directory.

To manually deploy MicroStrategy JSP applications from a duplicate

WAR file


If you are deploying more than one MicroStrategy environment on thesame WebLogic appl ication server, prior to deployment, you mustmodi fy the web.xml fi le

2. Unzip the WAR fi le by using the fol lowing command:#jar -xvf FileName.war

Where FileName i s the name of the WAR fi le for your MicroStrategy JSP application.

3. Open the web.xml fi le located in the /WEB-INF directory.

4. Modi fy the contextPath parameter. By defaul t, this parameter doesnot have a value. Type a unique string for the value of thecontextPath parameter. For example, type WebDep2 .

5. Save the web.xml fi le.

6. Zip the WAR fi le by using the fol lowing command:#jar -cvf FileName.war *




7. Transfer the WAR fi le to the /WEBLOGIC_MYDOMAIN_

FOLDER/autodeploy directory.

8. Open the WebLogic Server Administration Console (WLS AdminConsole) by typing the fol lowing address:

http://IP address:port/console/

where IP address is the IP address of the machine on which youinstal led the WebLogic appl ication server and port is the port numberfor the WebLogic appl ication server.

9. Type a val id user ID and password at the prompt. The user ID andpassword are the ones you speci fied when instal l ing the WebLogicServer on your machine.

10. To complete this operation, see Configuring from the WebLogic ServerAdministration Console , page 485.

To manually deploy MicroStrategy JSP applications from the exploded

directory

1. Locate the WAR fi le for your MicroStrategy JSP appl ication.

2. Create a folder in the /WEBLOGIC_MYDOMAIN_FOLDER/autodeploy

directory and transfer the WAR fi le to this directory.

3. Unzip the WAR fi le using the fol lowing command:

#jar -xvf FileName.war

Where FileName is the name of the WAR fi le for yourMicroStrategy JSP appl ication.

4. Open the WebLogic Server Administration Console by accessing thefol lowing address:



http://IP address:Port/console/

where IP address is the IP address of the machine on which you installedthe WebLogic application server and Port is the port number for the WebLogicapplication server.

5. Type a val id user ID and password at the prompt. The user ID andpassword are the ones you speci fied when instal l ing the WebLogicServer on your machine.

Configuring from the WebLogic Server Administration Console

To configure from the WebLogic Server Administration Console, refer toyour WebLogic Server Administration Console documentation on steps toinstal l a web appl ication.

Once you have instal led the JSP version of MicroStrategy Web and Mobi leServer as a WebLogic Server Administration Console web appl ication, youhave completed the steps required to deploy the appl ication.

To launch the administrative page for MicroStrategy Web (JSP), Mobi leServer (JSP) (JSP), see Configuring administrative access to MicroStrategyJSP appl ications, page 485.

To increase the performance of MicroStrategy Web (JSP), you can configureadditional settings after deployment. For more information, see Performance-Based Setup Information, page 488 .

Configuring administrative access to MicroStrategy JSPapplications

Before you start MicroStrategy Web (JSP), Mobi le Server (JSP) (JSP), youmust configure their administrator pages.



To configure access to the MicroStrategy JSP applications

1. The fol lowing table l ists the URL to access MicroStrategy WebAdministrator and MicroStrategy Mobi le Server Administrator, for eachdeployment method.

The servlet names are case-sensi tive. Make sure to use the correctcase when typing the mstrWebAdmin name.

If the appl ication server is enabled with securi ty, a dialog box relatedto the administrator authentication opens.

DeploymentMethod

Address

Automat icdeployment

Access the Administ rator page from a web browser using this URL:

• For Web (JSP): http://IPaddress:7001/context_folder_Web/servlet/mstrWebAdmin

In the URL listed above, context_folder_Web is the name of the folderwhere the Web (JSP) application was exploded and IPaddress is the IP address ofyour 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 thefolder where the Mobile Server application was exploded and IPaddress is the IPaddress of your machine.

Manualdeployment

Access the Administ rator page from a browser using this address:

• For Web (JSP): http://IPaddress:7001/Web_name/servlet/mstrWebAdmin

In the URL listed above, IPaddress is the IP address of your machine. Replacethe Web_name var iable with the name you specified in the deployed name fieldwhen configur ing Web (JSP) from WebLogic Server Administration Console, forexample, MyWebApp .

• For Mobile Server (JSP): http://IPaddress:7001/Mobile_name/servlet/mstrWebAdmin



DeploymentMethod

Address

In the URL listed above, IPaddress is the IP address of your machine. Replacethe Mobile_name var iable with the name you specified in the deployed namefield when configur ing Mobile Server from WebLogic Server Administration Console,for example, MyMobileApp .

2. Type the same user ID and password that was used to start theWebLogic Server on your machine.

In WebLogic, the deployment of a MicroStrategy JSP appl icationautomatical ly associates the WebLogic administrative user wi th theMicroStrategy JSP appl ication administrator. The WebLogicadministrative user is the user who has permissions to start theWebLogic Server on a given machine.

3. If you are deploying MicroStrategy Web (JSP), the MicroStrategy WebAdministrator page appears. Add and connect to an Intel l igenceServer.

4. If you are deploying MicroStrategy Mobi le Server (JSP), theMicroStrategy Mobi le Server Administrator page appears. Add andconnect to an Intel l igence Server. Once connected, cl ick MobileConfiguration to configure your MicroStrategy Mobi le appl ications tocommunicate with Mobi le Server and Intel l igence Server. For steps onhow to define this configuration, see the MicroStrategy Mobi leAdministration Guide. Creating a configuration completes the stepsrequired to deploy Mobi le Server (JSP).

Launching the project

The address to launch MicroStrategy Web (JSP) is di fferent for eachdeployment method. The table below l ists the URL you can use to accessMicroStrategy Web (JSP).





DeploymentMethod

Address

Automat icdeployment

Access MicroStrategy Web (JSP) 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 applicat ion wasexploded and IPaddress is the IP address of your machine.

Manualdeployment

Access MicroStrategy Web (JSP) 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 specif ied in the deployed name f ield whenconf iguring from WebLogic Server Administ rat ion Console, for example,MyWebApp.

Re-deploy the ApplicationIf you have already deployed MicroStrategy Web (JSP) with WebLogic andyou change any parameters in the web.xml fi le, you must re-deploy theappl ication using the WebLogic Server Administration Console. This al lowsthe changes to take effect in the deployed appl ication. To re-deployMicroStrategy Web (JSP), refer to your WebLogic Server AdministrationConsole documentation on steps to re-deploy (update) a web appl ication.

Performance-Based Setup InformationThe performance of MicroStrategy Web (JSP) can be increased byconfiguring i t on various component levels. These addi tional setup settingsare not required, but i f you want to increase the performance ofMicroStrategy Web (JSP), some changes must be done before or after thedeployment procedure. This section provides the fol lowing configurations:

Setting the Java Heap Size

The Java heap size for the WebLogic Server can be increased by modi fyingthe MEM_ARGS variable in the startWebLogic.sh script:



1. Open the startWebLogic.sh script from /WEBLOGIC_MYDOMAIN_

FOLDER/bin/startWebLogic.sh .

2. Define the fol lowing l ine in the script:MEM_ARGS="-Xms512m -Xmx1024m"

This l ine reflects an ini tial Java heap size of 512 MB. MicroStrategyrecommends the ini tial java heap size be set at a minimum of 512 MB,assuming the machine has enough memory space. This value mayneed to be modi fied to reflect the requirements of your speci ficenvironment. Refer to your thi rd-party appl ication serverdocumentation for information on how to determine a satisfactory Javaheap size for your environment.

3. Stop and start the appl ication server.

Precompiling JSP Files

To avoid the time taken to load the Web pages in the appl ication serverwhen you access i t for the fi rst time, you must precompi le the Java ServerPages (JSP) fi les before deploying the appl ication. Do this by setting theappl ication server to load al l the pages in the appl ication beforedeployment. Thus, when you connect for the fi rst time, the pages arealready loaded and the performance is better.

1. Open the weblogic.xml fi le located in the /WEB-INF directory.

2. In the jsp-descriptor section, set the keepgenerated and theprecompile parameters to TRUE, as fol lows:

<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 fi le.

Disable/Relax Auto-Reload Parameters

To disable/relax auto-reload parameters, complete the fol lowing steps.

Set the pageCheckSeconds Parameter

The pageCheckSeconds parameter sets the interval , in seconds, at whichthe WebLogic Server checks to see i f JSP fi les have changed and needrecompi l ing. Dependencies are also checked and recursively reloaded i fchanged.

You can set the fol lowing values:

Value Description

0 Pages are checked on every request .

-1The page is not checked unt i l the server is restarted. Any classes usedby the JSP page that l ive in the servlet classpath are also reloaded.

n

Interval (in seconds) in which WebLogic Server checks if JSP f i leshave changed. For example, if this is set to 1, WebLogic checks thepages every second to see if the JSP has changed and needsrecompil ing.

To Set the pageCheckSeconds Parameter


2. In the jsp-descriptor section, set the pageCheckSeconds



parameter value. For example, the fol lowing 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 fi le.

Set the WebLogic Reload Period Parameter

In WebLogic, the Reload Period parameter sets how often WebLogic checkswhether a servlet has been modi fied. If the servlet has been modi fied,WebLogic reloads i t. As the MicroStrategy Web (JSP) servlets do notchange after they have been deployed, MicroStrategy recommends that youdisable the reload period by setting i t to -1. A value of -1 means neverreload, and a value of 0 means always reload.

Use the appropriate procedure below, depending on whether you haveMicroStrategy Web (JSP) deployed as a dupl icate WAR fi le.

To Set the WebLogic Reload Period


2. In the container-descriptor section, set the servlet-reload-

check-secs parameter value. For example, the fol lowing code setsthe value to -1:<container-descriptor>

<servlet-reload-check-secs>-1</servlet-reload-check-

secs>



</container-descriptor>

3. Save the fi le.

Configuring Apache Web Server to Serve Static Files

Because Web servers are tuned to effectively serve static fi les, theperceived performance of MicroStrategy Web (JSP) is signi ficantlyenhanced i f image, style sheet, and JavaScript fi les are served via theApache Web server, and the WebLogic Server handles only the servletrequests. Do this by edi ting two main parameters, Alias andMatchExpression , in the Apache configuration fi le httpd.conf .

l The Alias parameter is used to create a virtual di rectory in the ApacheWeb server. The virtual di rectory is needed to serve static fi les such asimages, style sheets, and JavaScript.

l The MatchExpression parameter is used to configure the Apache plug-in so that the WebLogic Server handles only the servlet requests.

To Configure the Apache Web Server to Serve Static Files

1. To change the Alias parameter, add the fol lowing l ines in thehttpd.conf fi le: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>



These code excerpts assume the application name isMicroStrategy . See Deploying with WebLogic and Apache(Solaris), page 475 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 namewhere the JavaScript and style sheet fi les 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 commandsapachectl start and apachectl stop .

The Web server now serves image (GIF), style sheet (CSS), JavaScript, andal l other static fi les, thus reducing the load on the appl ication server andincreasing the appl ication's performance.

Deploying with WebSphere and IBM HTTP Server (AIX)

This section provides information used to deploy and configureMicroStrategy JSP appl ications on an AIX machine using the WebSphereServer and the IBM HTTP Web Server. You can use the steps below todeploy MicroStrategy Web (JSP) and MicroStrategy Mobi le Server (JSP).

This section includes the fol lowing information:

Deploying MicroStrategy Web and Mobile ServerOnce your machine has the necessary settings configured, you can deployMicroStrategy Web (JSP), Mobi le Server (JSP) (JSP) on the WebSpheremachine.



The Performance-Based Setup Information, page 501 section providesinformation on additional settings to increase application performance. Theseadditional settings are not required, but can increase the performance ofMicroStrategy Web (JSP).

Launching the WebSphere Administrative Console

The WebSphere Administrative Console can be accessed only i f theWebSphere server is started on the machine.

To start the Websphere Application Server

1. Execute the startServer script as fol lows:

cd WAS_HOME/bin

# ./startServer.sh SERVER_NAME

Typically, server1 is the default server name in WebSphere.

2. Ensure that the Administrative Server has started successful ly.Execute the fol lowing commands:

cd WAS_HOME/bin

# ./serverStatus.sh -all

To launch the WebSphere Administrative Console

In a browser, type the URL for the administrative console. The URL is of thefol lowing form:

http://IP Address:Port/ibm/console

where IP Address is the IP address of the computer on which youinstal led the WebSphere appl ication server and Port is the port number forthe WebSphere Administrative Console. Refer to your thi rd-partyWebSphere documentation to confi rm the defaul t port number for theadministrative console.



Starting the WebSphere default application server

After you launch the WebSphere Administrative Console, you can deployMicroStrategy Web (JSP) by starting the defaul t appl ication server.

This is applicable for WebSphere Network Deployment Edition or WebSphereEnterprise Edition. For WebSphere Express or WebSphere Base Editions,there is no distinction between an administrative server and a default server.The StartServer.sh command starts the default application serverautomatically .

To start the default application server

When the WebSphere Administrative Console opens, a tree view isdisplayed.

1. Expand the Servers node, or cl ick the l ink to expand the view.

2. Cl ick the Applications Servers l ink.

3. Select the box next to the appl ication server to start.

4. Cl ick Start.

Installing the Enterprise Application

To install the Enterprise Application

1. Expand Applications, and then Enterprise Applications to display al ist of instal led appl ications.

2. Cl ick Install.

Preparing for the application installation

The fol lowing steps describe the settings that must be speci fied for theinstal lation.



Copy the WAR file (see Locating the WAR Fi le, page 472) for theMicroStrategy JSP placation to the WAS_HOME/installableApps directory,where WAS_HOME is the WebSphere application server home path.

To specify settings for the installation

1. To begin the instal lation for IBM WebSphere, go to Applications >Application Types > WebSphere enterprise applications.

2. Cl ick Install.

3. You must speci fy the path to the WAR fi le by selecting ei ther the localfi le system or remote fi le system option. For local fi le systems, you cancl ick browse to navigate to the location of the WAR fi le. For remote fi lesystems, type in the ful l path for the location of the WAR fi le.

4. Cl ick Next.

5. Select to perform ei ther a Fast Path or Detailed instal lation. Ei thertype of instal lation can support the deployment of MicroStrategy JSPappl ications.

6. Select the Generate Default Binding check box, and ensure that theOverride existing bindings check box is cleared.

7. Cl ick Next.

8. Select the Precompile Java Server Pages files check box.

9. Speci fy the value for the Directory to Install Application as ${APP_

INSTALL_ROOT}/DefaultNode

10. Speci fy an Application Name of your choice.

11. Ensure that the Override class reloading settings for Web and EJBmodules check box is cleared.

12. Cl ick Next.

13. Select the Web Tier check box and cl ick Next.



14. Type a sui table name for ContextRoot , which is case-sensi tive. Donot include .war in the name for ContextRoot as this can causeerrors when attempting to start the appl ication.

The URLs to access MicroStrategy JSP applications containContextRoot , which should be replaced by the name of your choice.For example, MicroStrategy Web JSP uses the URLhttp://machine-name/ContextRoot/servlet/mstrWeb

and you can use the default name of the WAR file, which isMicroStrategy .

15. Cl ick Next.

16. Review the summary and cl ick Finish .

17. To grant access to these resources, map the admin role to the usersor groups that wi l l be given the administrator privi leges for yourMicroStrategy JSP appl ication. To access these options inWebSphere, expand the Security options, and then cl ick GlobalSecurity.

Security must be enabled for the WebSphere Server for this feature towork.

Regenerating plugin-cfg.xml

1. Expand Environment, and then cl ick Update global WebServer Plug-in configuration .

2. Cl ick OK , and then cl ick Save to master configuration .

Restarting the application server

This section explains how to stop and start the appl ication server.Performing these steps stops and starts al l the appl ications running on theappl ication server. To stop and start only the appl ication in which you areworking, see To start the Web module, page 498.



To restart the application server

The option to stop and start the application server through the administrativeconsole is available only for the Websphere Network Deployment andWebsphere Enterprise Editions. To stop and start the application server inWebsphere Express and Websphere Base editions, see below.

1. Expand Servers, and then cl ick the WebSphere Application Serversl ink.

2. Select the box next to the appl ication server you want to stop, andcl ick Stop .

3. Select the appl ication server you want to start and cl ick Start.

To stop and start the appl ication server in Websphere Express andWebsphere Base edi tions, use the fol lowing commands:

l stopServer.sh server1 to stop the appl ication server

l startServer.sh server1 to start the appl ication server.

Starting a single JSP application

This process starts only a single JSP appl ication, rather than al l theappl ications running on the appl ication server. To stop and start al lappl ications, see Restarting the appl ication server, above.

To start the Web module

1. Expand Applications, then expand Application Types, and thenselect WebSphere enterprise applications.

2. Select the box next to the appl ication to start and cl ick Start.




The administrative pages for your MicroStrategy JSP appl ications areaccessible only to users wi th an admin role. To create the set of users andpasswords that are authorized for this access, you must create thenecessary role mapping between these users and the admin role for theMicroStrategy JSP appl ication. The steps to perform this setup are givenabove in the section Preparing for the appl ication instal lation, page 495.For more information, refer to your IBM documentation.

To configure administrative access to MicroStrategy JSP applications

1. Access the servlet by typing the fol lowing URL in a web browser:

l For Web (JSP):http://

IPAddress/ContextRootWeb/servlet/mstrWebAdmin

In the URL l isted above, ContextRootWeb is the name youprovided for the ContextRoot for Web Module box in the sectionPreparing for the appl ication instal lation, page 495. For example, thedefaul t name of the WAR fi le, which is MicroStrategy .

l For Mobi le Server (JSP):http://

IPAddress/ContextRootMobile/servlet/mstrWebAdmin

In the URL l isted above, ContextRootMobile is the name youprovided for the ContextRoot for Web Module box in the sectionPreparing for the appl ication instal lation, page 495. For example, thedefaul t name of the WAR fi le, which is MicroStrategyMobile .

The servlet names are case-sensitive. Use the correct case whentyping the mstrWebAdmin name. If the application server is enabled



with security, a dialog box related to the administrator authenticationopens.

2. Type the user ID and password assigned with the admin role.

3. After you are authenticated, add and connect to an Intel l igence Server.


5. If you are deploying MicroStrategy Web (JSP), proceed to launch theproject.


After configuring the MicroStrategy Web Administrator page, you mustfol low the steps described in this section to launch your project.

To launch the project

1. Start the Apache Web server by using the fol lowing command:

# /usr/HTTPServer/bin/apachectl start

For example, i f the IBM HTTP server is instal led in the defaul t location/usr/IBMIHS , then use the fol lowing command:

/usr/IBMIHS/bin/apachect1

2. In a Web browser, speci fy the fol lowing URL:

http://MachineName/ContextRoot/servlet/mstrWeb





Alternatively, you can use the IP address of your machine for remoteaccess, as shown below:

http://IPAddress/ContextRoot/servlet/mstrWeb

In these addresses, ContextRoot is the name you provided for thecontext root for Web Module box on Preparing for the applicationinstallation page. For example, the default name of the WAR file, which isMicroStrategy . For more information, refer to Preparing for theappl ication instal lation, page 495 .

You can now access the MicroStrategy Web (JSP) appl ication.

Uninstalling MicroStrategy JSP applications

You can uninstal l the MicroStrategy JSP appl ications through theWebSphere Administrative console.

1. Go to Applications > Application Types > WebSphere enterpriseapplications.

2. Select the desired MicroStrategy JSP appl ication.

3. Cl ick Uninstall.

4. Save the configuration in the master reposi tory.

Performance-Based Setup InformationThe performance of MicroStrategy Web (JSP) can be increased byconfiguring i t on various component levels. These addi tional settings arenot necessary, but can increase the performance of MicroStrategy Web(JSP).


You can increase the Java heap size for a given appl ication server byconfiguring the WebSphere Administrative Console:



1. Access the Administrative Console.

2. Expand the Servers node.

3. Cl ick the Application Servers l ink to view the l ist of appl icationservers.

4. Cl ick the appl ication server name, scrol l to Addi tional Properties andcl ick Process Definition .

5. Cl ick JVM Settings to set the Java heap size settings. MicroStrategyrecommends that you ini tial ly set the Java heap size to a minimum of500 MB, assuming the machine has enough memory space.

This value may need to be modi fied to reflect the requirements of yourspeci fic environment. Refer to your thi rd-party appl ication serverdocumentation for information on how to determine a satisfactory Javaheap size for your environment.

6. Cl ick Apply.

7. Stop and start the appl ication server.

Precompiling JSP Files

To avoid the time taken to load the Web pages in the appl ication serverwhen you access i t for the fi rst time, you must precompi le the Java ServerPages (JSP) fi les. Precompi lation can be done during deployment byselecting the Enable pre-compile of JSPs setting. Otherwise, i t can bedone after deploying the appl ication.

To precompi le the JSPs after deployment, set the appl ication server to loadal l the pages in the appl ication. Then when you connect for the fi rst time,the pages are already loaded and performance is improved.

Before you precompi le the JSP fi les, make sure that:



l The MicroStrategy Web (JSP) appl ication is deployed in the WebSphereenvironment.

l You know the defined appl ication name and the Web Module's name. Youcan retrieve these names from the Administrative Console. Locate theappl ication name under the Enterprise Appl ications node. Locate the WebModule name by expanding the appl ication and cl icking Web Modules.The defaul t name is Web Tier .

To precompile the JSP files

1. Change the directory to WAS_ROOT/bin .

2. Run the fol lowing 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 securi ty enabled mode, you areprompted for the user ID and password to connect to the Admin server.

username userID

password password

For each JSP fi le compi led without error, the fol lowing message appears:Code generation successful .

Configuring the IBM HTTP Server to Serve Static Files

The IBM HTTP Server (Web server) is tuned to effectively serve static fi les.As a resul t, perceived performance is greatly enhanced i f you configure theIBM HTTP Server to serve image, style sheet, and JavaScript fi les. Thisalso reduces the load on the WebSphere Server so that i t can handle onlydynamic fi les whi le IBM HTTP Server handles static fi les. This requires thatyou do the fol lowing:



l Configure the appl ication server level to serve the Java Server Pages(JSPs) and servlets, which are dynamic fi les and handled by WebSphere.

l Configure the Web server level to serve the images, JavaScripts, andstyle sheets, which are static fi les and handled by the IBM HTTP Server.

For more information, see the IBM WebSphere Appl ication Server redbookcovering System Management and Configuration. This book discussesseparating static content from dynamic content.

Deploying with Oracle Glassfish Server (Solaris)

This section provides information used to deploy and configureMicroStrategy JSP appl ications on an Oracle Glassfish Server 3.1.x in aLinux environment. You can use the steps below to deploy MicroStrategyWeb (JSP) and MicroStrategy Mobi le Server (JSP).

l Locating the WAR Fi le, page 472.

l Deploying MicroStrategy Web and Mobi le Server, page 504: Instructionsfor deploying MicroStrategy Web (JSP), Mobi le Server (JSP).

l Undeploying MicroStrategy JSP Appl ications, page 514: Instructions forundeploying MicroStrategy JSP appl ications.

Deploying MicroStrategy Web and Mobile ServerOnce your machine has been configured, you can deploy MicroStrategyWeb (JSP, Mobi le Server (JSP) (JSP) with Oracle Glassfish Server 3.1.x.

The administration and deployment tools in Oracle Glassfish Server have thesame interface regardless of the operating system on which they run.Therefore, the deployment process is the same for all operating systems, andis described below. There are some minor changes in the Windowsenvironment, which are highlighted where necessary.



Launching the Oracle Glassfish Server Administration Console

This procedure describes the steps to launch the Oracle Glassfish Server.

The Oracle Glassfish Server is installed. This installation should also include adefault domain, commonly named domain1 . If you plan to use a differentdomain, refer to your third-party Oracle documentation for creating a domain.

Copy the WAR file (see Locating the WAR Fi le, page 472) for yourMicroStrategy JSP application to the same machine as the Oracle GlassfishServer, or to a location that is accessible to the Oracle Glassfish Server machine.

To launch the Oracle Glassfish Server Administration Console

1. Navigate to the fol lowing directory in the command prompt:InstallDir/bin

where InstallDir is the directory where you instal led OracleGlassfish Server.

2. Type the fol lowing command to start the domain:

asadmin start-domain --domaindir

DomainDirectoryDomainName

where:

l DomainDirectory is the path you defined when creating thedomain. You can remove the --domaindir option i f the domainuses the defaul t di rectory.

l DomainName is the name of the domain you created in the previoussteps.

For example, to start domain1, which is the defaul t domain, type thefol lowing command:

asadmin start-domain domain1



3. Access the Oracle Glassfish Server Administration Console by typingthe fol lowing URL:http://MachineName:PortNumber

where:

l MachineName is the IP address or the name of the machine whereyou instal led Oracle Glassfish Server.

l PortNumber is the port number you provided when creating thedomain. The defaul t port number is 4848.

4. If prompted, type the user name and password that you provided whencreating the domain.

Deploying your MicroStrategy JSP application

After launching the Oracle Glassfish Server Administration Console, fol lowthe steps below to deploy MicroStrategy JSP appl ications as a WAR fi le.

Save the WAR file (see Locating the WAR Fi le, page 472) to the samemachine as the Oracle Glassfish Server, or to a location that is accessible to theOracle Glassfish Server machine.

Access to the administrative pages for MicroStrategy Web (JSP) and MobileServer (JSP) can be granted by using the admin security role and the associatedmstradmin group. Granting this access to users can be done within the OracleGlassfish Server Administration Console after deploying the WAR file. While thisdefault behavior supports most deployment requirements, if you have specificsecurity requirements for your system, you must modify the security role detailsprior to deploying the WAR file, as described in Deploying MicroStrategy Weband Mobi le Server, page 504 .



To deploy MicroStrategy JSP applications as a WAR file

1. Access the Administration Console by typing the fol lowing URL:

http://MachineName:PortNumber

where:

l MachineName is the IP address or the name of the machine whereyou instal led Oracle Glassfish Server.

l PortNumber is the port number you provided when creating thedomain. The defaul t port number is 4848.

2. If prompted, type the user name and password that you used to createthe domain.

3. Expand theTree pane on the left side of the Administration Console.

4. Cl ick Applications.

5. Cl ick Deploy.

6. Select Local Packaged File or Directory That Is Accessible fromGlassFish Server, and then cl ick Browse Files.

Selecting the WAR file in this manner is recommended as the PackagedFile 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 JSPappl ication WAR fi le.

8. Once you select the appropriate WAR fi le, cl ick Choose File.

9. From the Type drop-down l ist, select Web Application .

10. In the Context Root field, type the context root for the appl ication,which is included in various URLs for the appl ication:



l The URL to access MicroStrategy Web (JSP)(http://

IPAddress:PortNumber/ContextRoot/servlet/mstrWeb)

includes the appl ications context root, which should be replaced byany name of your choice. For example, you can use the defaul t nameof the WAR fi le, which is MicroStrategy .

l The URL to access the MicroStrategy Mobi le Server AdministratorPage(http://

IPAddress:PortNumber

/ContextRoot/servlet/mstrWebAdmin) includes theappl ications context root, which should be replaced by any name ofyour choice. For example, you can use the defaul t name of the WARfi le, which is MicroStrategyMobile .

11. In the Application Name field, type a descriptive name to distinguishthe appl ication from within the Administration Console.

12. In the Virtual Servers l ist, select the appropriate server.

13. Select or clear the addi tional deployment option check boxesaccording to your requirements.

It is recommended you select the Precompile JSPs check box to quicklyload the Web pages in the application server when you access it for thefirst time.

14. Cl ick OK .


For securi ty purposes, you must only assign certain users theadministrative authorization to access the MicroStrategy Web Administrator,



Mobi le Server Administrator. To do this, users need to be assigned to themstradmin group, which is part of the admin securi ty role.

Oracle Glassfish Server supports the fol lowing authentication realms out-of-the-box:

l Fi le realm

l Administration realm

l Certi ficate realm

A realm, also called a security policy domain or security domain, is a scopeover which a common security policy is defined and enforced by the securityadministrator of the security service. For more information, see the followingresource:

http://docs.oracle.com/cd/E18930_01/html/821-2435/ggkuk.html#gkbiy

In Oracle Glassfish Server, the fi le realm is the defaul t realm. Forcontrol l ing access to the Administration pages, you can create users anduser groups and assign the mstradmin group to users in your securi tyrealm.

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, cl ickserver (Admin Server). Ensure that the server is running or cl ick Startto start the server.

2. From the Tree pane on the left, go to Configuration > server-config >Security > Realms and select file..

3. Cl ick Manage Users.

4. Cl ick New.


http://docs.oracle.com/cd/E18930_01/html/821-2435/ggkuk.html#gkbiy


5. Type the fol lowing information for the new user:

l User ID : The ID that the user provides when authenticating with thesystem.

l Group List: The groups that the user is a member of. Typemstradmin to provide the user administrative access toMicroStrategy Web Administrator and MicroStrategy Mobi le ServerAdministrator.

l New Password : The password used to authenticate a user.

l Confirm New Password : A confi rmation of the password, requiredwhen creating a new user.

6. Cl ick OK .

7. In the Administration Console, from the Tree pane on the left, selectserver (Admin Server).

8. Cl ick Restart.

Managing the admin security role for specialized group authenticationrequirements

MicroStrategy provides a descriptor fi le, glassfish-web.xml , whichenables Oracle Glassfish Server to map the existing users or groups tosecuri ty roles. This fi le is located within the MicroStrategy JSP appl icationWAR fi les, and after deployment can be found in theWebApplicationRootDir/WEB-INF folder.

By defaul t, the admin securi ty role and i ts mstradmin group defined inthis glassfish-web.xml fi le can be used to grant administrative accessto the MicroStrategy Web Administrator and Mobi le Server Administrator.This provides administrative access without having to make anymodi fications to glassfish-web.xml . In these scenarios, you can usethe steps provided in Deploying your MicroStrategy JSP appl ication, page506 and Configuring administrative access to MicroStrategy JSP



appl ications, page 508 to complete the deployment and authenticationrequirements.

Whi le this defaul t behavior supports most deployment requirements, youcan modi fy this glassfish-web.xml fi le i f you have special ized groupauthentication requirements to use a group other than the defaul tmstradmin group defined for the admin securi ty role. Any groups that areused must be included as part of the admin securi ty role.

Any changes made to the glassfish-web.xml file must be done prior todeploying the MicroStrategy JSP application.

The contents of this fi le are as fol lows, which may di ffer depending on yourinstal lation 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 fi le, you must deploy the appl ication(see Deploying your MicroStrategy JSP appl ication, page 506) and assignthe securi ty role to the necessary user accounts (see Configuringadministrative access to MicroStrategy JSP appl ications, page 508).

Accessing the MicroStrategy JSP application administrative page

You can use the steps below to access the administrative page for yourMicroStrategy JSP appl ication.



To access the MicroStrategy JSP application administrative page

1. Access the servlet by typing the fol lowing URL in a Web browser:


IPAddress

:PortNumber/ContextRootWeb/servlet/mstrWebAdmin

In the URL l isted above, ContextRootWeb is the name youprovided for the ContextRoot for Web Module box in the sectionDeploying your MicroStrategy JSP appl ication, page 506. Forexample, you can use the defaul t name of the WAR fi le, which isMicroStrategy . The defaul t port number is 8080.


IPAddress

:PortNumber/ContextRootMobile/servlet/mstrWebAdmin

In the URL l isted above, ContextRootMobile is the name youprovided for the ContextRoot for Web Module box in the sectionDeploying your MicroStrategy JSP appl ication, page 506. Forexample, you can use the defaul t name of the WAR fi le, which isMicroStrategyMobile . The defaul t port number is 8080.

The servlet names are case-sensitive. Use the correct case when typingthe mstrWebAdmin name. If the application server is enabled withsecurity, a dialog box related to the administrator authentication opens.

2. Type the user ID and password for a user who is a member of themstradmin group, as described in Configuring administrative access toMicroStrategy JSP appl ications, page 508.



3. After you are authenticated:

l If you are deploying MicroStrategy Web (JSP), the MicroStrategyWeb Administrator page appears. Add and connect to an Intel l igenceServer.

l If you are deploying MicroStrategy Mobi le Server (JSP), theMicroStrategy Mobi le Server Administrator page appears. Add andconnect to an Intel l igence Server. Once connected, cl ick MobileConfiguration to configure your MicroStrategy Mobi le appl icationsto communicate with Mobi le Server and Intel l igence Server. Forsteps on how to define this configuration, see the MicroStrategyMobi le Administration Guide. Creating a configuration completes thesteps required to deploy Mobi le Server (JSP).

4. If you are deploying MicroStrategy Web (JSP), proceed to launch theMicroStrategy project. For more information, see Connecting to theWeb (JSP) project page, page 513 immediately below.

Connecting to the Web (JSP) project page

After restarting the appl ication server, fol low the steps described here toconnect to the project page.

To connect to the Web (JSP) project page

In a Web browser, type the fol lowing URL:

http://MachineName:PortNumber/ContextRoot

If you have used al l the defaul t values, you can access the fol lowing URLs:

http://localhost:8080/MicroStrategy/

or

http://localhost:8080/MicroStrategy/servlet/mstrWeb





Undeploying MicroStrategy JSP ApplicationsOracle recommends undeploying an appl ication before deploying a newerversion. The steps below show you how to undeploy an existingMicroStrategy JSP appl ication, using the Oracle Glassfish ServerAdministration Console.

To undeploy MicroStrategy JSP applications

1. In the Administration Console, from the Tree pane on the left, cl ickApplications. The Appl ications page is displayed.

2. Select the check box for the MicroStrategy JSP appl ication.

3. Cl ick Undeploy.

4. After the undeployment is finished, stop and restart the appl icationserver for the changes to take effect.

Deploying with Tomcat (Windows)

This section provides information used to deploy and configureMicroStrategy JSP appl ications in a Tomcat-only environment. Forinformation on how to configure Tomcat to work with IIS, seeiishowto.html (Tomcat 6.0) in the Tomcat documentation. You can usethe steps below to deploy MicroStrategy Web (JSP) and MicroStrategyMobi le Server (JSP):

l Preconfiguration Information, page 515: Configuration that must occurbefore you begin deploying MicroStrategy Web (JSP), Mobi le Server(JSP) (JSP).

l Deploying MicroStrategy Web and Mobi le Server, page 517: Instructionsfor deploying, including step-by-step procedures.



Preconfiguration InformationThis section provides the preconfiguration information necessary to deployMicroStrategy JSP appl ications on Tomcat on your machine.

Installing the JDK

If you have not instal led the Oracle JDK yet, download the fi le from thewebsi te. Be sure to instal l the JDK and not the JRE software options.

To configure the JDK, a system variable must point to the folder where youinstall 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.

Configuring the JDK

The third-party products discussed below are manufactured by vendorsindependent of MicroStrategy, and the steps to configure these products issubject to change. Refer to the appropriate Microsoft documentation for stepsto access and modify the environment variables.

1. From the Start menu, go to Computer > System properties >Advanced system settings > Environment Variables > SystemVariables.

2. Under , cl ick New to create a system variable.

3. In the Variable Name field, type JAVA_HOME .

4. In the Variable Value field, type the path of the folder where youinstal led the JDK and cl ick OK .

For example, i f the ful ly qual i fied path to your JDK executable isC:\jdk1.6.0\bin\java.exe , the value of your JAVA_HOME variableis C:\jdk1.6.0 .




If you have installed JDK under the Program Files folder, typeProgra~1 when specify ing the folder name in the Variable Value box;otherwise the system does not recognize the folder. For example, typeC:\Progra~1\jdk1.6.0 in the Variable Value box.

Configuring Tomcat

This procedure assumes that you have downloaded and instal led Tomcaton your machine. You can download Tomcat from the Apache websi te;depending on the version you want to download, you may need to locatethe appropriate fi le in Apache's Archive area. Instructions for downloadingand instal l ing Tomcat are also avai lable on the Apache websi te.

To configure Tomcat, a system variable must point to the folder where youinstal l Tomcat. Instal l ing Tomcat to a simple folder path such asC:\Tomcat makes i t easier to define the system variable.

The third-party products discussed below are manufactured by vendorsindependent of MicroStrategy, and the steps to configure these products issubject to change. Refer to the appropriate Microsoft documentation for stepsto access and modify the environment variables.

1. From the Start menu, go to Computer > System properties >Advanced system settings > Environment Variables > SystemVariables.

2. Cl ick New to create a system variable.

3. In the Variable Name field, type CATALINA_HOME .

4. In the Variable Value field, speci fy the path of the folder where youinstal led Tomcat and cl ick OK . For example, i f you instal led Tomcatdirectly to the C drive, the destination folder is C:\Tomcat .

If you installed Tomcat under the Program Files folder, type Progra~1when specify ing the folder in the Variable Value box. Otherwise, the system



does not recognize the folder. For example, type C:\Progra~1\Tomcat inthe Variable Value box.

Setting the Java heap size

The Java heap size for the Tomcat can be modi fied by defining the JAVA_

OPTS parameter in the catalina.bat fi le. For example, you can definethis parameter as fol lows:

JAVA_OPTS = "-Xms1024m -Xmx2048m"

This value may need to be modi fied to reflect the requirements of yourspeci fic environment. Refer to your thi rd-party appl ication serverdocumentation for information on how to determine a satisfactory Java heapsize for your environment.

Deploying MicroStrategy Web and Mobile ServerAssuming you have made al l the necessary configurations described above,you can begin deploying MicroStrategy Web (JSP), Mobi le Server (JSP)(JSP) wi th Tomcat.

Deploying using Tomcat as a stand-alone Web container

To deploy MicroStrategy JSP applications using Tomcat as a stand-

alone Web container


2. Copy the WAR fi le to the Tomcat\webapps folder.

3. From the Start menu, select Run .

4. Type cmd in the Open drop-down l ist and cl ick OK .

5. Browse to the Tomcat\bin folder, where Tomcat is the folder in



which you instal led Tomcat. For example, in the command prompt, type

cd C:\Tomcat\bin

6. Cl ick Enter. C:\Tomcat\bin> is displayed at the command prompt.

7. Type the required commands to start and stop Tomcat, which dependson your version of Tomcat. For example, for Tomcat 7, type Tomcat7

start to start Tomcat and type Tomcat7 stop to stop Tomcat. Referto your thi rd-party Apache documentation for information on thecommands to start and stop Tomcat.

If you installed Tomcat under the Program Files folder, type Progra~1when you change folders in the command prompt. Otherwise, the system doesnot recognize the folder. For example, type C:\Progra~1\Tomcat\bin inthe command prompt.

Your MicroStrategy JSP appl ication is deployed automatical ly, based onthe fol lowing:

l If you have configured Tomcat to deploy an exploded WAR fi le, which isoften the defaul t behavior, a folder is created within theTomcat\webapps folder:

l When deploying MicroStrategy Web (JSP), the folder is namedMicroStrategy by defaul t.

l When deploying MicroStrategy Mobi le Server (JSP), the folder is namedMicroStrategyMobile by defaul t.

l If you have configured Tomcat to deploy an unexploded WAR fi le, theconfiguration fi les are created within the system's defaul t temporary fi ledi rectory. For Windows systems, the temporary fi le di rectory is commonlydefined by the TMP environment variable:


Version/ folder is created within the temporary fi le di rectory, whereVersion is the version number for the MicroStrategy Web (JSP)product. Within this folder location, various configuration fi les can be



found within the WEB-INF folder and i ts subfolders.

l When deploying MicroStrategy Mobi le Server (JSP), a/microstrategy/mobile-Version/ folder is created within thetemporary fi le di rectory, where Version is the version number for theMicroStrategy Mobi le Server (JSP) product. Within this folder location,various configuration fi les can be found within the WEB-INF folder andi ts subfolders.

Configuring administrative access your MicroStrategy JSPapplications

To al low users authorized to access MicroStrategy Web Administrator,MicroStrategy Mobi le Server Administrator, you must create the users andassign them the role of admin under the Tomcat user configuration fi le. Thesteps to configure this access are below.

To configure administrative access to your MicroStrategy JSP

applications

1. In the Tomcat\conf folder, open the tomcat-users.xml fi le in aprogram that al lows you to edi t the fi le, such as Notepad.

2. Add the fol lowing tag and save the fi le:

<user name="administrator" password="administrator"

roles="admin"/>

You can specify any value in the user name and password fields.

3. Stop and start Tomcat from the command l ine.







localhost:8080/MicroStrategy/servlet/mstrWebAdmin


localhost

:8080/MicroStrategyMobile/servlet/mstrWebAdmin

The servlet names at the end of the URL are case-sensi tive. Make sureto use the correct case when typing the servlet name. If the appl icationserver is enabled with securi ty, a dialog box related to theadministrator authentication opens.

If you are using Tomcat integrated with IIS, you do not need to speci fythe port number in the URL. However, when using Tomcat as a stand-alone Web container, you must speci fy the port number. The defaul tport for Tomcat is 8080.

2. When prompted for a user name and password, use the same valuesyou speci fied in the tomcat-users.xml fi le.

3. If you are deploying MicroStrategy Web (JSP), the MicroStrategy WebAdministrator page appears. Add and connect to an Intel l igenceServer.







In a Web browser, access MicroStrategy Web (JSP) using this URL:


Deploying with Tomcat (Linux)

This section provides information on how to deploy and configureMicroStrategy JSP appl ications with Tomcat in a Linux environment. Youcan use the steps below to deploy MicroStrategy Web (JSP) andMicroStrategy Mobi le Server (JSP):

l Preconfiguration Information, page 521: Configuration that must occurbefore you begin deploying MicroStrategy Web (JSP), Mobi le Server(JSP) (JSP).

l Deploying MicroStrategy Web and Mobi le Server, page 523: Instructionsfor deploying, including detai led steps.

Preconfiguration InformationThis section provides the preconfiguration information necessary to deployMicroStrategy JSP appl ications with Tomcat on your Linux machine.

Installing the JDK

If you have not instal led Oracle JDK yet, download the shel l fi le here. Besure to instal l the JDK and not the JRE software options.

To configure the JDK, a system variable must point to the folder where youinstall 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.

From the location in which to instal l the JDK, run the fi le you downloaded:

jdk-Version-linux-i586.bin

For example, to instal l version 1.6.0, type the fol lowing:




jdk-1_6_0-linux-i586.bin

Configuring the JDK

1. Open the /etc/profile fi le using a program that al lows you to edi tthe fi le.

2. Add the fol lowing l ine:

export JAVA_HOME=/PathName/jdkVersion;

where PathName is the destination folder where you instal led the JDKand Version is the version, such as 1_6_0, of the JDK.

Installing Tomcat

This procedure assumes that you have downloaded and instal led Tomcat ina directory named Tomcat on your machine. If you have not instal ledTomcat yet, check the Certi fication Dossier to see which version of Tomcatyou should download.

Contact your System Administrator or v is it the Apache website for instructionson downloading and installing Tomcat.

Configuring Tomcat

After you instal l Tomcat, you must configure Tomcat. The Tomcatconfiguration includes creating the environment variable CATALINA_HOME

and defining this environment variable to point to the Tomcat directory.

1. Open the etc/profile fi le in a program that al lows you to edi t thefi le.

2. Type the fol lowing:

export CATALINA_HOME = /PathName

where PathName is the directory where you have instal led Tomcat.


https://www2.microstrategy.com/producthelp/current/Readme/en-us/content/certified_configurations.htm


For example,

export CATALINA_HOME = /Tomcat


The Java heap size for the Tomcat can be modi fied by defining the JAVA_

OPTS parameter in the catalina.sh fi le. For example, you can define thisparameter as fol lows:

JAVA_OPTS = "-Xms1024m -Xmx2048m"

This value may need to be modi fied to reflect the requirements of yourspeci fic environment. Refer to your thi rd-party appl ication serverdocumentation for information on how to determine a satisfactory Java heapsize for your environment.

Deploying MicroStrategy Web and Mobile ServerAfter you have performed the configurations described above, you canbegin deploying MicroStrategy JSP appl ications with Tomcat.

Deploying using Tomcat as a standalone Web container

To deploy MicroStrategy JSP applications using Tomcat as a

standalone Web container


2. Copy the WAR fi le to the Tomcat/webapps directory.

To start and stop Tomcat from the command l ine

Type # $CATALINA_HOME/bin/startup.sh and cl ick Enter to startTomcat, which deploys your MicroStrategy JSP appl ications automatical ly,based on the fol lowing:



l If you have configured Tomcat to deploy an exploded WAR fi le, which isoften the defaul t behavior, a folder is created within theTomcat/webapps folder:



l If you have configured Tomcat to deploy an unexploded WAR fi le, theconfiguration fi les are created within the system's defaul t temporary fi ledi rectory. For Linux systems, the temporary fi le di rectory is usual ly /tmp/

or /var/tmp/ :


Version/ folder is created within the temporary fi le di rectory, whereVersion is the version number for the MicroStrategy Web (JSP)product. Within this folder location, various configuration fi les can befound within the WEB-INF folder and i ts subfolders.



To al low users authorized to access MicroStrategy Web Administrator,MicroStrategy Mobi le Server Administrator, you must create the users andassign them the role of admin under the Tomcat user configuration fi le. Thesteps to configure this access are below.



1. In the Tomcat/conf directory, open the tomcat-users.xml fi leusing a program that al lows you to edi t the fi le.

2. Add the fol lowing tags and save the fi le:

<role rolename="admin"/>

<user username="admin" password="admin"

roles="admin"/>

You can specify any value in the user name and password fields.These are used to log in to the MicroStrategy Web Administrator andMobile Server Administrator pages. The roles field must be admin .

3. Stop and restart Tomcat.

Now you can access and configure your MicroStrategy JSP appl ication, asdescribed in Accessing the MicroStrategy JSP appl ication administrativepage, page 525.







localhost


The servlet names at the end of the URL are case-sensi tive. Makesure to use the correct case when typing the servlet name. If the



appl ication server is enabled with securi ty, a dialog box related tothe administrator authentication opens.

2. When prompted for a user name and password, use the same valuesyou speci fied in the tomcat-users.xml fi le.



l If you are deploying MicroStrategy Mobi le Server (JSP), theMicroStrategy Mobi le Server Administrator page appears. Add andconnect to an Intel l igence Server. Once connected, cl ick MobileConfiguration to configure your MicroStrategy Mobi le appl icationsto communicate with Mobi le Server and Intel l igence Server. Forsteps on how to define this configuration, see the MicroStrategyMobi le Administration Guide. Creating a configuration completes thesteps required to deploy Mobi le Server (JSP).

4. If you are deploying MicroStrategy Web (JSP), proceed to launch theMicroStrategy project. In a Web browser, access MicroStrategy Web(JSP) using the fol lowing URL:

http://

localhost:8080/MicroStrategy/servlet/mstrWeb

Deploying with SAP NetWeaver (Windows)

This section provides information used to deploy and configureMicroStrategy JSP appl ications on a Windows machine using the SAPappl ication server. You can use the procedure below to deployMicroStrategy Web (JSP) and MicroStrategy Mobi le Server (JSP):

For detai led deployment instructions, please see: Deploying MicroStrategyWeb and Mobi le Server, page 527





Deploying MicroStrategy Web and Mobile ServerOnce your machine has the necessary settings configured, you can deployMicroStrategy Web (JSP), Mobi le Server (JSP) (JSP) on the SAP-Windowsmachine.

Deploying MicroStrategy JSP applications with the SAP NetWeaverApplication Server

Fol low the steps provided in this section to deploy MicroStrategy JSPappl ications as a WAR fi le.

To deploy MicroStrategy JSP applications as a WAR file


2. Copy the WAR fi le to the Windows machine hosting your appl icationserver. The location in which you store the fi le is used later andreferred to as path_to_war_file .


4. In the Open drop-down l ist, type cmd , and cl ick OK .

5. Using the command prompt, browse to the fol lowing directory wi thinthe SAP Appl ication Server instal lation directory:

/usr/sap/SID/Instance_Number/j2ee/deployment/scripts/

The SIDand Instance_Number parameters are defined duringinstal lation and configuration of the SAP Appl ication Server. The portnumber above refers to the P4 port number. The defaul t port number is50004.

6. Type the fol lowing command and press Enter to deploy the WAR fi le:Deploy.bat

user_name:password@localhost:port_number path_to_war_file



The user name and password must have administrative access. Theport number above refers to the P4 port number. The defaul t portnumber is 50004.

7. Access NetWeaver web admin console using the fol lowing URL:

http://localhost:PortNumber/nwa

The PortNumber above refers to the J2EE engine port number. Thedefaul t port number is 50000.

8. Log in as an administrative user.

9. Go to Operation Management > Systems > Start & Stop .

10. Select Java EE Applications.

11. Select the MicroStrategy JSP appl ication just deployed from the l ist.

12. Go to Application Details > Status > Start.

13. Select On all instances and Set "Started" as Initial State.


To al low users authorized to access MicroStrategy Web Administrator,MicroStrategy Mobi le Server Administrator, you must map users or groupsto the admin securi ty role. This securi ty role is defined in the MicroStrategyJSP appl ication deployment, wi thin the web-j2ee-engine.xml fi le. Youcan modi fy this fi le to map users or groups to this admin securi ty role, orinclude users in the administrators user group.

Accessing the MicroStrategy JSP applications




You must have administrative priv ileges to access the MicroStrategy WebAdministrator or Mobile Server Administrator page. For more information, seeConfiguring administrative access to MicroStrategy JSP appl ications,page 528 .

To access the MicroStrategy Web Administrator or Mobile Server

Administrator page



MachineName

:PortNumber/MicroStrategy/servlet/mstrWebAdmin


MachineName

:

PortNumber

/MicroStrategyMobile/servlet/mstrWebAdmin

The servlet names at the end of the URLs listed above are case-sensitive. Use the correct case when typing the servlet name.

The login dialog box opens.

2. Speci fy a user name and password.



l If you are deploying MicroStrategy Mobi le Server (JSP), theMicroStrategy Mobi le Server Administrator page appears. Add and



connect to an Intel l igence Server. Once connected, cl ick MobileConfiguration to configure your MicroStrategy Mobi le appl icationsto communicate with Mobi le Server and Intel l igence Server. Forsteps on how to define this configuration, see the MicroStrategyMobi le Administration Guide. Creating a configuration completes thesteps required to deploy Mobi le Server (JSP).

4. If you are deploying MicroStrategy Web (JSP), access theMicroStrategy Web Appl ication on SAP Web Server by speci fying thefol lowing URL in the Web browser:

http://

MachineName:PortNumber/MicroStrategy/servlet/mstrWeb

Deploying with Oracle 10g (Windows)

This chapter provides information used to deploy and configureMicroStrategy JSP appl ications with Apache as the Web server and OracleAppl ication Server 10g R3 as the appl ication server. You can use theprocedure below to deploy MicroStrategy Web (JSP) and MicroStrategyMobi le Server (JSP): For detai led deployment instructions, please see

For detai led deployment instructions, please see: Deploying MicroStrategyWeb and Mobi le Server, page 530

Deploying MicroStrategy Web and Mobile ServerAfter your machine is configured, you can start the deployment of yourMicroStrategy JSP appl ication with Oracle Appl ication Server 10g R3.

Deploying using the Oracle Enterprise Manager

You can access Oracle Enterprise Manager from the fol lowing URL:

http://MachineName:PortNumber/em





Where MachineName is the machine name or IP address of the Oraclemachine, and PortNumber is the port number of Oracle EnterpriseManager.

1. Start the Apache Web Server. From the Start menu, go to OracleAS10g - DEFAULT_HOME1 > StartApplicationServerName.MachineName.domain .

2. To veri fy that the Apache Web Server has started, open OracleEnterprise Manager, select HTTP Server, and then cl ick Start.

3. Select the OC4J instance where you want to deploy your MicroStrategyJSP appl ication. This procedure assumes you are using the defaul tinstance name home. Cl ick home. The OC4J: home page opens.

4. Select the Applications tab.

5. Cl ick Deploy.

6. In the Archive area, select Archive is present on local host.

7. Cl ick Browse to navigate to and select the WAR fi le for yourMicroStrategy JSP appl ication. For more information on locating theWAR fi le, see Locating the WAR Fi le, page 472.

8. In the Deployment Plan area, select Automatically create a newdeployment plan and cl ick Next.

9. Enter the Application Name and Context Root. This section ondeploying MicroStrategy Web (JSP) with Oracle 10g usesMicroStrategy as the Appl ication Name and /MicroStrategy as theContext Root. For Mobi le Server (JSP), this section usesMicroStrategyMobile as the Appl ication Name and/MicroStrategyMobile as the Context Root.

10. Cl ick Next.



To map a user to the admin securi ty role

To al low users authorized to access MicroStrategy Web Administrator,MicroStrategy Mobi le Server Administrator, you must assign users thesecuri ty role of admin . In Oracle 10g, the securi ty users and groups aredefined in the Oracle Enterprise Manager.

1. In the Map Security Roles task name, cl ick the Go To Task (penci l )icon.

2. For the admin securi ty role, select the Map Role (penci l ) icon.

3. Select Map selected users and groups to this role.

4. In the Map Role to Users area, in the User field, type the user name tomap to the admin securi ty role and cl ick Add .

Repeat this step to add al l users for whom you want to grantpermission to work in the MicroStrategy Web Administrator and Mobi leServer Administrator pages.

5. Cl ick Continue, and then cl ick OK .

6. Cl ick Deploy .

7. Stop and restart the Apache Web Server.

Now you can access and configure your MicroStrategy JSP appl ication, asdescribed in Accessing the MicroStrategy JSP administrative pages, page532.

Accessing the MicroStrategy JSP administrative pages




To access the MicroStrategy JSP administrative pages

1. In a Web browser, access the administrative page by speci fying thefol lowing URL:



/MicroStrategy/servlet/mstrWebAdmin



/MicroStrategyMobile/servlet/mstrWebAdmin

Where IPAddress is the IP address of the Oracle machine andPortNumber is the port number used by the Oracle Appl icationServer. The servlet name at the end of the URLs l isted above are case-sensi tive, so be sure to use the correct case when typing the servletname.

2. When prompted for a user name and password, speci fy the values youused earl ier when creating the user mapped to the admin securi ty role(see Deploying using the Oracle Enterprise Manager, page 530above).



l If you are deploying MicroStrategy Mobi le Server (JSP), theMicroStrategy Mobi le Server Administrator page appears. Add andconnect to an Intel l igence Server. Once connected, cl ick MobileConfiguration to configure your MicroStrategy Mobi le appl ications



to communicate with Mobi le Server and Intel l igence Server. Forsteps on how to define this configuration, see the MicroStrategyMobi le Administration Guide. Creating a configuration completes thesteps required to deploy Mobi le Server (JSP).

4. If you are deploying MicroStrategy Web (JSP), you can now launch theMicroStrategy project. In a Web browser, access MicroStrategy Web(JSP) using this URL:

http://

IPAddress:PortNumber/MicroStrategy/servlet/mstrWeb

Where IPAddress is the IP address of the Oracle machine andPortNumber is the port number used by the Oracle Appl icationServer.

Deploying with JBoss (Windows)

This chapter provides information used to deploy and configureMicroStrategy JSP appl ications in a JBoss environment. You can use thesteps below to deploy MicroStrategy Web (JSP) and MicroStrategy Mobi leServer (JSP):

l Preconfiguration Information, page 534: configuration that must occurbefore you begin deploying MicroStrategy Web (JSP), Mobi le Server(JSP) (JSP).

l Deploying MicroStrategy Web and Mobi le Server, page 536: instructionsfor deploying, including step-by step procedures.

Preconfiguration InformationThis section provides the preconfiguration information necessary to deployMicroStrategy JSP appl ications on JBoss on your machine.





Installing the JDK

If you have not instal led Oracle JDK yet, download i t here. Be sure to instal lthe JDK and not the JRE software options.

To configure the JDK, a system variable must point to the folder where youinstall the JDK. If you install the JDK to a simple folder path such as C:\ thensetting the system variable is easier and more likely to be correct.

Configuring the JDK

1. On your Windows machine, go to Start > Computer > Systemproperties > Advanced system settings > Environment Variables.

The third-party products discussed below are manufactured by vendorsindependent of MicroStrategy, and the steps to configure these productsis subject to change. Refer to the appropriate Microsoft documentationfor steps to access and modify the environment variables.

2. Under System Variables, cl ick New to create a system variable. TheNew System Variable dialog box opens.

3. In the Variable Name box, type JAVA_HOME .

4. In the Variable Value box, speci fy the destination folder where youinstal led the JDK and cl ick OK .

For example, if the fully qualified path to your JDK executable isC:\jsdk1.8.0\bin\java.exe , the value of your JAVA_HOMEvariable is C:\jsdk1.8.0 .

If you have installed JDK under the Program Files folder, typeProgra~1 in the destination folder; otherwise the system does not recognizethe folder. For example, C:\Progra~1\jsdk1.8.0 .

Installing JBoss

You can download and instal l JBoss here.



http://www.jboss.org/jbossas/downloads


Keep track of the location in which you instal l JBoss, as this location isused later (referred to as JBOSS_HOME ) to configure JBoss with aMicroStrategy JSP appl ication deployment.

Deploying MicroStrategy Web and Mobile ServerAssuming you have made al l the necessary configurations described above,you can begin deploying MicroStrategy Web (JSP), Mobi le Server (JSP)(JSP) wi th JBoss.

Deploying using JBoss as a stand-alone Web container

To deploy MicroStrategy JSP applications using JBoss as a stand-alone

Web container


2. Copy the WAR fi le to the JBOSS_HOME\server\default\deploy

directory.

3. To start JBoss, browse to JBOSS_HOME\bin . Then run the fol lowingcommand:run.bat -b 0.0.0.0

Your MicroStrategy JSP appl ication is deployed automatical ly, based onthe fol lowing:

l If you have configured JBoss to deploy an exploded WAR fi le, which isoften the defaul t behavior, a folder is created within the JBOSS_

HOME\server\default\deploy directory:





l If you have configured JBoss to deploy an unexploded WAR fi le, theconfiguration fi les are created within the system's defaul t temporary fi ledi rectory. For Windows systems, the temporary fi le di rectory is commonlydefined by the TMP environment variable:


Version/ folder is created within the temporary fi le di rectory, whereVersion is the version number for the MicroStrategy Web (JSP)product. Within this folder location, various configuration fi les can befound within the WEB-INF folder and i ts subfolders.



To al low users authorized to access MicroStrategy Web Administrator,MicroStrategy Mobi le Server Administrator, you must create the users andassign them the role of admin under the JBoss user configuration fi les. Thesteps to configure this access are below.

To configure administrative access to MicroStrategy JSP applications

1. Browse to the directory JBOSS_HOME\server\default\conf ,where JBOSS_HOME is the location in which you instal led JBoss.

2. Create the fol lowing two fi les wi thin this directory:

l users.properties

l roles.properties



3. Open the users.properties fi le in a text edi tor.

4. Include one l ine for each user to grant administrative access to theWeb Administrator and Mobi le Server Administrator, using thefol lowing syntax:user_id=user_password

For example, you create UserA and UserB with passwords 1234 and5678 respectively using the fol lowing syntax:

UserA=1234

UserB=5678

5. Save your changes and close the users.properties fi le.

6. Open the roles.properties fi le in a text edi tor.

7. Include one l ine for each user you included in theusers.properties fi le and grant them administrative access, usingthe fol lowing syntax:user_id=admin

For example, you define UserA and UserB to have administrativeaccess using the fol lowing syntax:

l UserA=admin

l UserB=admin

8. Save your changes and close the roles.properties fi le.

9. To start JBoss, browse to JBOSS_HOME\bin . Then run the fol lowingcommand:run.bat -b 0.0.0.0

Now you can access and configure your MicroStrategy JSP appl ication, asdescribed in Accessing the MicroStrategy JSP appl ication administrativepage, page 539.





To access the MicroStrategy JSP application administrative page

1. In a Web browser, access the administrative page by speci fying thefol lowing URL:




localhost


The servlet names at the end of the URLs l isted above are case-sensi tive. Make sure to use the correct case when typing the servletname. If the appl ication server is enabled with securi ty, a dialog boxrelated to the administrator authentication opens.

2. When prompted for a user name and password, type the user name forthe administrator user you created in the roles.properties fi le andthe login information in the users.properties fi le.



l If you are deploying MicroStrategy Mobi le Server (JSP), theMicroStrategy Mobi le Server Administrator page appears. Add andconnect to an Intel l igence Server. Once connected, cl ick Mobile



Configuration to configure your MicroStrategy Mobi le appl icationsto communicate with Mobi le Server and Intel l igence Server. Forsteps on how to define this configuration, see the MicroStrategyMobi le Administration Guide. Creating a configuration completes thesteps required to deploy Mobi le Server (JSP).

4. If you are deploying MicroStrategy Web (JSP), proceed to launch theMicroStrategy Web project page. In a Web browser, accessMicroStrategy Web project using this URL:


Administering Your MicroStrategy Web Deployment

You can configure and manage MicroStrategy Web connections toIntel l igence Servers in the MicroStrategy Web Administrator page.

Enabling Users to Install MicroStrategy Office from Web

This information applies to MicroStrategy Office, the add-in for MicrosoftOffice applications which is no longer actively developed.

It was substituted with a new add-in, MicroStrategy for Office, which supportsOffice 365 applications. The initial version does not yet have all thefunctionalities of the previous add-in.

For more information, see the MicroStrategy for Office page in the 2019Update 1 Readme and the MicroStrategy for Office Onl ine Help .

From the MicroStrategy Web Administrator page, you can designate theinstal lation directory path to MicroStrategy Office, and also determinewhether a l ink to Office instal lation information appears in theMicroStrategy Web interface.

You must install and deploy MicroStrategy Web Services to allow the installationof MicroStrategy Office from MicroStrategy Web. For information about deployingMicroStrategy Web Services, see the MicroStrategy for Office Onl ine Help .




https://www2.microstrategy.com/producthelp/2019/Readme/content/mstr_office.htm


http://www2.microstrategy.com/producthelp/Current/Office/en-us/Content/home.htm



To specify the path to MicroStrategy Office and determine whetherusers can install MicroStrategy Office from Web

1. In Windows, go to Start > Programs > MicroStrategy Tools > ;WebAdministrator.

2. Cl ick Connect.

3. Underneath Web Server on the left, cl ick MicroStrategy Office. TheMicroStrategy Office settings page opens.

4. In the Path to MicroStrategy Office Installation field, type the baseURL of your MicroStrategy Web Services machine, for example:http://server:port/Web_Services_virtual_directory/Office

MicroStrategy Web automatically attaches /Lang_xxxx/officeinstall.htm to the end of the URL, where Lang_xxxx refers to the currently defined language in MicroStrategy Web. Forexample, if the language in MicroStrategy Web is set to English, acompleted URL may appear as follows:

http://localhost/MicroStrategyWS/office/Lang_

1033/officeinstall.htm

5. Test the URL path by cl icking Go .

6. Cl ick your browser's Back button to return to the Web Administration -MicroStrategy Office settings page.

7. To ensure that an Install MicroStrategy Office l ink isdisplayed at the top of users' project selection and login pages inMicroStrategy Web, select the Show link to installation page for allusers on the Projects and Login pages check box. When users cl ickthe 'Instal l MicroStrategy Office' l ink, a page opens with instructions onhow to instal l MicroStrategy Office on their machine.

8. Cl ick Save.



Using Absolute Paths to Share Configuration Files

By defaul t, absolute paths are not used for the configuration fi les of yourMicroStrategy Web Mobi le deployments. You can modi fy themicrostrategy.xml fi le to reference configuration fi les using absolutepaths. By using absolute paths, you can al low the same configuration fi lesto be accessed by multiple systems. For example, absolute paths can beused in a clustered environment in which you want al l instances of the webserver to access the same MicroStrategy Web or Mobi le configuration fi les.

Below is an example of some relative paths that are included in themicrostrategy.xml fi le by defaul t:

<parameter name="serverConfigFilesDefaultLocation" value="/WEB-INF/xml/" />

<parameter name="serverLogFilesDefaultLocation" value="/WEB-INF/log/" />

You can modi fy these to use absolute paths, as shown in the examplesbelow:

<parameter name="serverConfigFilesDefaultLocation"

value="ABSOLUTE:/usr/User1/MicroStrategy/xml/" />

<parameter name="serverLogFilesDefaultLocation"

value="ABSOLUTE:/usr/User1/MicroStrategy/xml/log/" />

Configuring Third-Party Data Sources for ImportingData

You can use MicroStrategy Web to import data from different data sources,such as an Excel fi le, a table in a database, the resul ts of a Freeform SQLquery, or other data sources, into MicroStrategy metadata, wi th minimumproject design requirements.

To import data from the fol lowing data sources, configure a secureconnection between your thi rd-party data source and MicroStrategy Web:

l Dropbox

l Google Analytics



l Google BigQuery

l Google Drive

l Salesforce.com

l Twitter

How to Configure a Connection Between a Third-Party DataSource and MicroStrategy Web for Data Import

Before you begin, ensure you've done the following:

l Your third-party data source environment contains the data you plan to integratein MicroStrategy Web. You also need the proper credentials to perform some ofthe steps below. For example, you need a Salesforce.com login with developercredentials to perform some of the steps below.

l You have deployed MicroStrategy Web so that it uses secure, encryptedcommunications. For steps to enable secure communications for yourMicroStrategy Web deployment, refer to the System Administration Guide .

l If you are connecting to Salesforce.com, to ensure proper numeric valueintegration and formatting when using Data Import, your Salesforce.com reportsmust use the English locale. If you use a different locale for yourSalesforce.com reports, you can still integrate this data into MicroStrategyusing Data Import if you connect to Salesforce.com using the MicroStrategyODBC Driver for Salesforce. For steps to configure this type of a connection toSalesforce.com, see MicroStrategy ODBC Driver for Salesforce, page 763 .

1. Access the administrative options for your thi rd-party data source.

For example, i f you are integrating data from Salesforce.com, log in toSalesforce.com by accessing https://login.salesforce.com/ .

2. Configure MicroStrategy Web as a remote access appl ication for thethi rd-party data source. For the steps to define remote accessappl ications in your thi rd-party data source, refer to your thi rd-party




documentation.

When configuring MicroStrategy Web as a remote access appl ication,you must define the cal lback URL as the URL to access MicroStrategyWeb, including the event 3172 . Depending on how you deployedMicroStrategy Web, the syntax for this URL can take one of thefol lowing forms:

The Twitter connector does not allow you to add query parameters in theTwitter app setting. Beginning MicroStrategy 2019 Update 1, you do notneed to add the event in the URL to use the Twitter connector.

If you are using a version of MicroStrategy prior to 2019 Update 1, youcannot connect to Twitter without query parameters. Upgrade toMicroStrategy 2019 Update 1 or later to use the Twitter connector.

l For MicroStrategy Web (ASP.NET) deployments:

https://WebServer/WebApplicationName/asp/Main.aspx

?evt=3172&src=Main.aspx.3172

l For MicroStrategy Web (JSP) deployments:

https://WebServer:PortNumber/WebApplicationName/se

rvlet/mstrWeb?evt=3172&src=mstrWeb.3172

In the example URLs above:

WebServer is the ful l domain name of your web server that ishosting MicroStrategy Web. Ensure that you use the ful l domainname rather than using an IP address, as using an IP address canrequire re-authentication when making the connection.

PortNumber is the port number of your web server.



WebApplicationName is the name of the MicroStrategy Webappl ication. The defaul t name for the MicroStrategy Web appl icationis MicroStrategy .

3. Save MicroStrategy Web as a remote access appl ication. Your thi rd-party data source provides a Cl ient ID and a Cl ient Secret. Save thesetwo values as they are required later to configure the connection.

4. Restart the web server that hosts MicroStrategy Web. The next timeyou log in to Web and use Data Import, the data source is now anavai lable option.

5. When connecting to your data source using Data Import inMicroStrategy Web, enter the Cl ient ID and Cl ient Secret provided bythe data source.

Addi tional ly, the cal lback URL is the MicroStrategy Web URL you usedabove to configure MicroStrategy Web as a remote access appl icationfor your data source. The Cl ient ID, Cl ient Secret, and Cal lback URLare al l defined as OAuth parameters of the connection to your datasource using Data Import.

For the Twitter connector, add the event 3172 to the callback URL inMicroStrategy Web. For an example of connecting the Twitter connector,see KB440974 .


After completing the steps to deploy MicroStrategy Web and Mobi le Server,you can continue your setup and configuration. To help guide the rest ofyour instal lation and configuration steps, refer to the section Instal lationand Configuration Checkl ists, page 135 in Chapter 1, Planning YourInstal lation, for instal lation and configuration checkl ists.


https://community.microstrategy.com/s/article/KB440974-How-to-configure-Twitter-connector-for-Data-Import-in-MicroStrategy-Analytics-Enterprise-Platform-10


SETTING UPDOCUMENTS AND HTMLDOCUMENTS



This section explains the setup required for Intel l igence Server to executeHTML documents and Report Services documents on Linux platforms.

Prerequisi tes 547

Executing Documents and HTML Documents in Linux 548


Prerequisites

This section assumes the fol lowing:

l You are fami l iar wi th MicroStrategy Developer and MicroStrategyIntel l igence Server.

l You are fami l iar wi th MicroStrategy HTML documents and ReportServices documents.

l You have a Report Services product l icense i f you are using ReportServices documents. HTML documents do not require a Report Servicesproduct l icense.

l You have instal led MicroStrategy Developer on a Windows machine.

l You have instal led MicroStrategy Intel l igence Server on a Linux machine.

Some of the steps described in this document may require root accesspermissions.

You must perform extra configuration steps to allow Report Servicesdocuments to support non-Western European fonts on a UNIX system. Formore information, see Graph and Document Support of Non-WesternEuropean Fonts, page 898 of Appendix B, Troubleshooting .



Executing Documents and HTML Documents in Linux

A MicroStrategy Report Services document contains objects representingdata coming from one or more reports, as wel l as posi tioning and formattinginformation. Report Services documents help format data from multiplereports in a single display and can be used for presentations. When youcreate a document, you can speci fy the data that appears, control thelayout, formatting, grouping, and subtotal ing of data and speci fy theposi tion of page breaks. In addi tion, you can insert pictures and drawborders in the document.

In this section, the term document signifies a Report Services document. Foradditional information on Report Services documents, refer to the DocumentCreation Guide .

An HTML document is a container for formatting, displaying, anddistributing multiple reports on the same page, or at the same time within aproject. You can create dossiers and scorecards to display a group ofreports wi thin the MicroStrategy platform.

HTML documents are created using MicroStrategy Developer. Beforecreating or executing HTML documents, you must speci fy the HTMLdocument directory using the Project Configuration dialog box inMicroStrategy Developer. The HTML document directory stores HTMLtemplates that are required by the MicroStrategy Intel l igence Server forexecuting HTML documents. You can store the HTML document directory ona Linux platform, but you must share the directory wi th the Windowsplatform that includes MicroStrategy Developer. For more information onsetting up the HTML document directory on a Linux platform, see Setup forCreating and Executing HTML Documents, page 549.

For additional information on HTML documents, see the HTML Documentschapter in the Advanced Reporting Guide .






Setup for Creating and Executing HTML DocumentsHTML documents can only be created with MicroStrategy Developer on aWindows platform, but they can be stored and executed from a directorywi thin a Linux platform. The directory that stores the HTML documents mustbe accessible on the computer wi th Intel l igence Server and the Windowscomputer wi th Developer.

Using the Project Configuration dialog box in MicroStrategy Developer, youmust speci fy the location of the HTML document directory as an absolutepath. This document directory can be on a local machine or on a remotemachine. Users require appropriate read and wri te permissions to accessthis directory. When MicroStrategy Intel l igence Server executes HTMLdocuments, i t requires read permission to the HTML document directory toaccess the HTML fi les.

For the procedure of setting up an HTML document directory betweenWindows and Linux computers below, the fol lowing assumptions are made:

l You have instal led MicroStrategy Developer on a Windows computer andinstal led MicroStrategy Intel l igence Server on a Linux computer.

Developer can only be installed on a Windows computer.

l MicroStrategy Developer users have at least read permissions to theHTML document directory for executing existing HTML documents. Wri tepermissions to the directory are required for MicroStrategy Developerusers to create new HTML documents.

l For the fi le paths described in the procedure below, machine-name isused to represent the name of the machine you store the HTML documentdirectory on. For example, i f you store the directory on a machine namedUNIX1, machine-name should be replaced with UNIX1. This machinemust have Samba instal led to provide access to the folder on a Windowscomputer.



l You must have root permissions on any Linux computer used to set up theHTML document directory. This includes the computer that stores theHTML document directory as wel l as any computer that must be setup toaccess the directory.

To set up the HTML document directory

1. Create a directory to hold the HTML document directory on the desiredLinux computer. This procedure assumes that the path of the HTMLdocument directory is machine-name:/share/htmldocuments .This is the machine that is referenced as machine-name in the stepsbelow. To create this directory, enter the commands below:

# cd /

# mkdir share

# cd share

# mkdir htmldocuments

2. Instal l Samba software on the Linux computer that you created theHTML documents directory in the step above. With this software, theHTML documents directory is accessible to the Windows computer wi thMicroStrategy Developer instal led. You can get the latest version ofSamba at http://www.samba.org .

Notice that Samba uses the .org extension and not the more common.com extension. Using the .com extension takes you to an incorrectwebsite.

3. Share the directory machine-name:/share across the networkthrough NFS. For example, you must share UNIX1:/share . Makesure read and wri te permissions are set for the share. This step al lowsother Linux computers to access the directory.




4. Create a Samba share, named "share", wi th read and wri tepermissions that points to the directory machine-name:/share . Forexample, you must share UNIX1:/share .This step al lows Windowscomputers to access the directory.

The Samba share is created in the Samba smb.conf fi le. For speci ficinstructions on how to setup a Samba share, refer to the Sambawebsi te athttp://www.samba.org .

5. Restart Samba.

6. Mount the HTML document directory on the computer that has theIntel l igence Server instal led on i t. Root privi leges are required for this.

On the computer wi th Intel l igence Server, type the command su andthe root password at the command prompt to log in as a superuser, orlog in as root. The command prompt changes to the pound sign (#).Perform the commands below:

In the commands below, machine-name refers to the machine name ofthe computer where you stored the HTML documents directory andcreated an NFS and Samba share. This may be a different name than thecomputer that you are mounting the directory on. The final mountcommand contains a space between /htmldocuments and/machine-name .

cd /

mkdir machine-name

cd machine-name

mkdir share

cd share

mkdir htmldocuments




cd /

mount machine-name:/share/htmldocuments /machine-

name/share/htmldocuments

7. You can cache the connection to the Linux HTML documents directoryfrom the Windows computer so that you are not prompted forauthentication each time the directory is accessed:

a. From the Windows computer that has MicroStrategy Developerinstal led, cl ick Start, and select Run . The Run dialog box opens.

b. Type \\machine-name\share\htmldocuments ,and cl ick OKto open the top-level shared HTML documents directory. Forexample, type \\UNIX1\share\htmldocuments .

This must be performed every time you restart the computer.

8. Using the Project Configuration dialog box in MicroStrategyDeveloper, set the HTML document directory as an absolute path byfol lowing the steps below:

a. In Developer, right-cl ick the project associated with the HTMLdocuments and select Project Configuration . The ProjectConfiguration dialog box opens.

b. Expand Project definition and cl ick Advanced . The ProjectConfiguration - Advanced options are displayed.

c. In the HTML document directory box, type the absolute path\\machine-name\share\htmldocuments . For example, type\\UNIX1\share\htmldocuments .

d. Cl ick OK to accept the changes.

9. Create a directory named xsls under the HTML document directory andcopy the XSL fi les you require for creating HTML documents to thexsls directory, /machine-name/share/htmldocuments/xsls . If



you stored XSL fi les in a di fferent di rectory or did not copy them fromtheir original defaul t di rectory, you must copy them into the new xslsdirectory. For example, the defaul t HTML document directory for theTutorial project is Program Files\MicroStrategy\Tutorial

Reporting .

10. If you want to insert images into the HTML document, create adirectory named images under the HTML document directory, and copythe 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 documentdirectory, otherwise, Intel l igence Server cannot execute the HTMLdocuments correctly.

Setup for Executing Existing HTML DocumentsIf you have created HTML documents prior to establ ishing a connectionbetween the HTML document directory on the Linux machine withMicroStrategy Intel l igence Server and the Windows machine withMicroStrategy Developer, you must make sure that al l the fi les used for anHTML document are copied to the shared HTML document directory. Afterthe connection is establ ished, you should always create the HTMLdocuments in the shared HTML document directory. Once the existing fi lesare copied, you can execute the HTML documents using Intel l igenceServer.

In the procedure of setting up existing HTML documents, the fol lowingassumptions are made:

l You have completed al l the steps l isted in the section Setup for Creatingand Executing HTML Documents, page 549.

l The location of the HTML document directory is /machine-

name/share/htmldocuments . For the fi le paths described in theprocedure below, machine-name is used to represent the name of the



machine on which you store the HTML document directory. For example,i f you store the directory on a machine named UNIX1, machine-nameshould be replaced with UNIX1.

To set up existing HTML documents for execution

1. Copy the HTML fi le for any existing HTML document to /machine-

name/share/htmldocuments .

2. View the source code of each HTML fi le and copy the XSL fi le used byeach HTML document in an appropriate directory under /machine-name/share/htmldocuments .

For example, i f the location of the XSL fi le in the source code isxsl="\xsls\myxsl.xsl , then copy myxsl.xsl to /machine-

name/share/htmldocuments/xsls . If the location of the XSL fi lein 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 inan appropriate directory under /machine-name/share/htmldocuments .

For example, i f the location of the image fi le in the source code is\images\myimage.gif , then copy myimage.gif to /machine-

name/share/htmldocuments/images . If the location of the XSLfi le 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.

Setup for Executing Report Services DocumentsA MicroStrategy Report Services document is used to format data frommultiple reports. These documents can be exported to PDF format. Toexecute documents and export them to PDF format using MicroStrategy



Intel l igence Server in a Linux environment, you must perform someaddi tional setup tasks.

When Intel l igence Server is running on a Linux platform, al l fonts areconverted to the Courier New font for:

l Reports exported to PDF format

l Report Services documents

l Graphs contained in HTML documents

l Graphs displayed in MicroStrategy Web

This occurs because the fonts required by the PDF component are missingfrom Linux machines running Intel l igence Server. The missing fonts mayinclude Microsoft True Type fonts.

MicroStrategy does not distribute or license Microsoft fonts, and thereforecannot package Microsoft fonts with Intelligence Server.

To resolve this issue, you must instal l the font fi les in thePDFGeneratorFiles folder wi thin the MicroStrategy instal lation path onthe Linux machine, as described below.

To copy fonts to your Linux machine

1. Log in to your Linux machine that hosts Intel l igence Server.

2. Instal l the Microsoft True Type fonts. Refer to the fol lowing resourcesfor information on l icensing requirements for and instal l ing MicrosoftTrue Type fonts:

l http://www.microsoft.com/typography/RedistributionFAQ.mspx

l http://www.ascendercorp.com/msfonts/msfonts_main.html

l http://corefonts.sourceforge.net/


http://www.microsoft.com/typography/RedistributionFAQ.mspx

http://www.ascendercorp.com/msfonts/msfonts_main.html

http://corefonts.sourceforge.net/


3. Copy the font fi les into the INSTALL_PATH/PDFGeneratorFiles

directory, where INSTALL_PATH is the directory you speci fied as theMicroStrategy instal l di rectory during instal lation.

4. To update the l ist of fonts avai lable, you must restart the Intel l igenceServer.


After completing the steps to set up documents and HTML documents forLinux, you can continue your setup and configuration. To help guide therest of your instal lation and configuration steps, refer to the sectionInstal lation and Configuration Checkl ists, page 135 in Chapter 1, PlanningYour Instal lation, for instal lation and configuration checkl ists.



AUTOMATEDINSTALLATION ONW INDOWS



This section explains the various possibi l i ties for performing ful lyautomated and unattended instal lations within the MicroStrategy platform.This includes customizations to the instal lation routines avai lable wi th theproduct. It explains the di fferent resources you can use to deployMicroStrategy products through various scenarios including:

l Deploying the MicroStrategy platform across the network through theMicrosoft System Management Server (SMS) or i ts equivalent (forexample, IBM Tivol i )

l Embedding the MicroStrategy platform within thi rd party customappl ications and other instal lation routines

l Customizing the MicroStrategy instal lation to meet the variousenvironment-speci fic requirements for a given si te

This section provides the fol lowing information:

Instal lation Log Fi le 558



Automated and silent installations require advanced techniques such ascreating and running response.ini files. Therefore, automated and silentinstallations should be handled by system administrators with full knowledgeof the environment and the desired MicroStrategy installation.

Before instal l ing MicroStrategy products, you should refer to Chapter 1,Planning Your Instal lation for important pre-instal lation information.

Installation Log File

Before you begin to learn about automated instal lation options, i t isimportant to know about the instal lation log fi le. The setup programgenerates a log fi le in text format. This log fi le contains records of al lactions performed by the setup program and by other executable fi les



related to instal lation. The instal lation log fi le can be particularly helpful i fyou encounter errors during the instal lation process. For example, the logcan tel l you i f a registry key or path was not added or i f a cri tical fi le wasnot registered successful ly. The setup.exe fi le wri tes to this log fi le.

The log fi le data includes:

l Update dates

l Machine speci fications

l User selections

l List of fi les to be registered

l List of fi les that do not require registration

l List of registry entries

l Identi fication of fi les that fai l during registration

l Instal lation activi ty such as performance counter loading and DSNcreation

l Reboot time fi le registration resul ts

The defaul t location for the install.log fi le is:

l 32-bi t Windows environments: Program Files\Common

Files\MicroStrategy

l 64-bi t Windows environments: Program Files (x86)\Common

Files\MicroStrategy

Both the location and the name can be changed. You can speci fy the logfi le name and location in the fol lowing places:

l Command l ine, reading the parameter LogFile . For example:

setup.exe --LogFile="C:\install.log"



l Response fi le in [LogFile] . See Configuring a response.ini Fi le toInstal l MicroStrategy, page 560 for more information.

Methods of Installation

The instal lation methods discussed in this section are:

Installing and Configuring with a response.ini FileThe response.ini fi le can faci l i tate the instal lation and setup ofMicroStrategy products by al lowing you to progress through the instal lationand project creation processes with a single keystroke. A response.ini

fi le is an ini tial ization fi le that is used to send parameters or selections tothe MicroStrategy Instal lation Wizard. This al lows you to run i t si lently asal l the options are pre-selected in that fi le. This section describes how tocreate and use response.ini for the fol lowing tasks:

Configuring a response.ini File to Install MicroStrategy

The response.ini fi le for instal lation al lows you to automate certainaspects of the instal lation by modi fying a Windows ini -l ike response fi le.

This option is typical ly implemented by the fol lowing:

l OEM appl ications that embed MicroStrategy instal lations within otherproducts

l IT departments who want to have more control over desktop instal lations

The response.ini fi le speci fies al l the selections you want to makeduring the instal lation in the MicroStrategy Instal lation Wizard. You canei ther run i t wi th al l the MicroStrategy Instal lation Wizard options that arepre-selected or run i t wi thout having to use the wizard at al l .

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 thesetup, response.ini overrides setup.iss . For details on thesetup.iss file, see Si lent Instal lation, page 612 .

Component Dependencies

When you use a response.ini fi le to instal l MicroStrategy products,there are some key dependencies among separate components you shouldbe aware of.

The products l isted below require ei ther pre-instal led software or certainMicroStrategy components to be selected to successful ly instal l theproducts wi th a response.ini fi le:

l MicroStrategy Enterprise Manager requires MicroStrategy CommandManager to be included in the instal lation.

l MicroStrategy Del ivery Engine, MicroStrategy Subscription Portal ,MicroStrategy Tutorial – Del ivery Instal lation and MicroStrategy Tutorial –Del ivery Configuration require MicroStrategy Narrowcast Administratorand SequeLink ODBC Socket Server to be included in the instal lation.

l MicroStrategy Narrowcast Server Administrator requires SequeLinkODBC Socket Server to be included in the instal lation.

l MicroStrategy Narrowcast Server Subscription Portal requires SequeLinkODBC Socket Server to be included in the instal lation.

l MicroStrategy Function Plug-in Wizard requires Microsoft Visual C++ tobe instal led before running your response.ini fi le.

l MicroStrategy Analytic Modules requires MicroStrategy Developer or acombination of MicroStrategy Analyst and MicroStrategy Archi tect to beincluded in the instal lation.

l To use MicroStrategy Identi ty Server and MicroStrategy Identi ty Manager,they are required to be included in the instal lation.



l MicroStrategy Communicator requires MicroStrategy Identi ty Server,MicroStrategy Identi ty Manager, and Platform Analytics to be included inthe instal lation.

l Platform Analytics requires MicroStrategy Intel l igence Server,MicroStrategy Telemetry, and Command Manager to be included in theinstal lation.

Creating a response.ini File

Create the fi le in any text edi tor and save i t as response.ini in thedesired folder.

You must save the file with ANSI encoding.

The fol lowing tables describe the parameters and options for the al l thesections, such as Instal ler, Paths, and so on in the response.ini fi le. Itis fol lowed by sample response.ini fi les for your reference.

The options are case-sensitive, therefore they must be entered as indicated inthe tables below.

Instal ler

Options Description

[Installer] Sect ion that begins the installat ion.

ExpressModeTRUE or False. Indicates whether the installat ion usesExpress Install or Custom Install.

PropertiesFilesOver

write

TRUE or FALSE. Set to TRUE to create new propert ies f i les.These f i les are related to the Tutorial Delivery component .The default is FALSE, which uses the current version of thepropert ies f i les. The default is FALSE.

EnableTracingTRUE or FALSE. Set this opt ion to trace the setup process in alog f i le that is saved in the Temp folder. The log f i le records



Options Description

errors that are encountered during the installat ion. The defaultis FALSE.

HideAllDialogs

TRUE or FALSE. Indicates whether the installat ion uses alldefault values. FALSE displays all the dialog boxes and youmust browse using the Next but tons. The default is FALSE.

ForceRebootTRUE or FALSE. TRUE reboots the machine af ter theinstallat ion is done. The default is FALSE.

PreventReboot

TRUE or FALSE. TRUE prevents the machine from reboot ingaf ter installat ion is done. Note the following condit ions:

• I f both ForceReboot = TRUE and PreventReboot =

TRUE, then PreventReboot applies f irst .

• I f both ForceReboot and PreventReboot are FALSE

and HideDialog for [Finish] is set to TRUE, then themachine reboots only if i t is required.

The default is FALSE.

CheckTCPI

TRUE or FALSE. Set to TRUE to check that the TCP/IPnetwork protocol is act ive. I f set to FALSE, the setup doesn'tcheck for it . The default is TRUE.

CheckIITRUE or FALSE. Set to TRUE to check for Internet Informat ionServices. The default is TRUE.

CreateShortcutsTRUE or FALSE. TRUE creates the shortcuts for MicroStrategyproducts, tools, and documentat ion. The default is TRUE.

CheckRenameOperatio

ns

TRUE or FALSE. In some instances, as a result of a previousinstallat ion or an uninstall, certain f i les may be missing orirreplaceable during installat ion. Therefore, you are promptedto do one of the following:

• Reboot at the beginning of installat ion to replace this f i le.I t is recommended that you select this opt ion.

• Cont inue with the installat ion at the risk of the sof tware notfunct ioning properly.



Options Description

I f you enter FALSE, the prompt does not display. The defaultis TRUE.

AnalyticsOverwriteTRUE or FALSE. This opt ion overwrites the Analyt ics Modulesfrom a previous install. The default is FALSE.

TutDeliveryOverwriteTRUE or FALSE. Set this opt ion to overwrite the DeliveryTutorial f rom a previous installat ion. The default is FALSE.

BackupFiles

TRUE or FALSE. I f you set the value to TRUE, i t creates abackup of the following f i les:

• *.pds

• *.xsl

• *.asp

• *.css

• *.js

• *.sql


RunConfigWizard

TRUE or FALSE. When using silent install, set to FALSE toprevent the Conf igurat ion Wizard from coming up af terreboot .The default is TRUE.

StopAllServices

TRUE or FALSE. Set to TRUE to stop all services required tobe stopped to complete a MicroStrategy installat ion. I f set toFALSE, the user is prompted if services need to be stopped.The default is TRUE.

StopIISTRUE or FALSE. Set this opt ion to stop Internet Informat ionServices (I IS) during installat ion. The default is FALSE.

EnableASPServices

TRUE or FALSE. Set this opt ion to enable the ASPMicroStrategy Web Services extensions that I IS Adminrequires. The default is FALSE.

EnableASPNETServices TRUE or FALSE. Set this opt ion to enable the ASP.NET



Options Description

MicroStrategy Web Services extensions that I IS Adminrequires. The default is FALSE.

ShowWelcomeScreen

TRUE or FALSE. Set to TRUE to display the Welcome screenaf ter reboot . The Welcome screen is displayed only once af terreboot . The default is TRUE.

EnterpriseManagerOv

erwrite

TRUE or FALSE. I f you select FALSE, the warehouse andmetadata f i les are not updated but the rest of the f i les forEnterprise Manager are updated. This prompt only impacts thef i les in the Microsof t Access database. The default is FALSE.

ConfigWizardResponse

File

Specify the name of the response f i le for the Conf igurat ionWizard; otherwise, it takes the default name ofresponse.ini.

For more details on conf iguring the response.ini f i le forthe Conf igurat ion Wizard, see Configuring your Installat ionwith a response. ini File, page 609.

LogFile

Locat ion where the install.log f i le is generated. I f lef tempty, it takes the default locat ion and f i le 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.lo

g.

Welcome Dialog

Options Description

[Welcome] Sect ion for conf iguring the Welcome dialog box.

HideDialog TRUE or FALSE. FALSE displays the dialog box. The default is FALSE.



Options Description

RemoveAll

TRUE or FALSE. This opt ion is for the uninstall process only. Set t ing itto TRUE removes all MicroStrategy products during the uninstall process.The default is FALSE.

For an example of a response f i le used to uninstall al l MicroStrategyproducts, see Uninstall ing with a response. ini File, page 610.

Customer Information Dialog

Options Description

[UserRegistration] Sect ion for specifying the customer informat ion.

HideDialogTRUE or FALSE. FALSE displays the dialog box. The default isFALSE.

UserFirstName

Indicates the user name of the current ly logged user or a userwho is already registered. I f no informat ion is provided, youcannot proceed to the next page. I f you are install ingMicroStrategy Ident ity Server, this is the f irst name of theAdminist rator.

UserLastName

Indicates the user name of the current ly logged user or a userwho is already registered. I f no informat ion is provided, youcannot proceed to the next page. I f you are install ingMicroStrategy Ident ity Server, this is the last name of theAdminist rator.

UserEmail

Indicates the email of the current ly logged user, or a user who isalready registered. This email address is also used receive thebadge invitat ion for your MicroStrategy Ident ity Badge network.I f no informat ion is provided, you cannot proceed.

CompanyName

The name of the company for which the sof tware is registered.The default is the company name in the regist ry. This is also thedefault company name when your MicroStrategy Ident ity Badgenetwork is created.



Options Description

LicenseKey

Specify the license key for the sof tware. I f you do not specify thelicense key, the MicroStrategy Installat ion Wizard wil l ask for itwhen it reaches that step. By default , i t is blank for a freshinstall or displays the license key from a previous install.

License Detai l

Options Description

[LicenseDetail] Sect ion that displays license details.

HideDialogTRUE or False. FALSE displays the dialog box. The default isFALSE.

Setup Express Instal l

Options Description

[SetupExpress] Sect ion that begins the installat ion.

HideDialogTRUE or False. Indicates whether the installat ion uses ExpressInstall or Custom Install.

Choose Destination Location Dialog

Options Description

[SuiteTarget]Sect ion specifying the name of the target directory f rom where youcan run the MicroStrategy products.


TargetDirectoryLocat ion of the root directory for the Program Files. The default isset to:



Options Description

• 32-bit Windows environment:C:\Program Files\MicroStrategy

• 64-bit Windows environment: C:\Program Files (x86)\MicroStrategy

Paths

Options Description

[InitialPaths]Sect ion for specifying the path for the products that you select toinstall.

COMMONFILES

Locat ion where the common f i les like response.ini,install.log, and so on wil l be installed. I f lef t empty, it takes thedefault locat ion of :

• 32-bit Windows environments:C:\Program Files\Common Files\MicroStrategy

• 64-bit Windows environments: C:\Program Files (x86)\Common Files\MicroStrategy

Developer

Locat ion where Developer wil l be installed. I f lef t empty, it takes thedefault locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\Desktop

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Desktop

ObjectManager

Locat ion where Object Manager wil l be installed. I f lef t empty, ittakes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\Object Manager

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Object Manager



Options Description

CommandManager

Locat ion where Command Manager wil l be installed. I f lef t empty, ittakes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\Command Manager

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Command Manager

EnterpriseManag

er

Locat ion where Enterprise Manager wil l be installed. I f lef t empty, ittakes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\Enterprise Manag

er

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Enterprise Manager

Server

Locat ion where the MicroStrategy Intell igence Server wil l beinstalled. I f lef t empty, it takes the default locat ion of :

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Intelligence Server

Web

Locat ion where MicroStrategy Web wil l be installed. I f lef t empty, ittakes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\Web ASPx

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Web ASPx

WebUniversal

Locat ion where MicroStrategy Web wil l be installed. I f lef t empty, ittakes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\Web JSP

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Web JSP



Options Description

WebServices

Locat ion where MicroStrategy Web Services wil l be installed. I f lef tempty, it takes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\Web Services

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Web Services

WebServicesUniv

ersal

Locat ion where MicroStrategy Web Services wil l be installed. I f lef tempty, it takes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\Web Services JSP

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Web Services JSP

Office

Locat ion where MicroStrategy Off ice wil l be installed. I f lef t empty, ittakes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\Office

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Office

TutorialReporti

ng

Locat ion where MicroStrategy Tutorial - Report ing wil l be installed.I f lef t empty, it takes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\Tutorial Reporti

ng

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Tutorial Reporting

AnalyticsModule

s

Locat ion where the Analyt ics Modules wil l be installed. I f lef t empty,it takes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\Analytics Module

s



Options Description

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Analytics Modules

NCSAdminDeliver

yEngine

Locat ion where the Narrowcast Server Delivery Engine wil l beinstalled. I f lef t empty, it takes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\Narrowcast Serve

r\Delivery Engine

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Narrowcast Server\Delivery

Engine

SubscriptionPor

tal

Locat ion where the Subscript ion Portal wil l be installed. I f lef tempty, it takes the default locat ion of :


r\Subscription Portal

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Narrowcast Server\Subscript

ion Portal

TutorialDeliver

y

Locat ion where MicroStrategy Tutorial - Delivery wil l be installed. I flef t empty, it takes the default locat ion of :


r\Tutorial

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Narrowcast Server\Tutorial

IntegrityManage

r

Locat ion where MicroStrategy Integrity Manager wil l be installed. I flef t empty, it takes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\Integrity Manage

r



Options Description

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Integrity Manager

Mobile

Locat ion where MicroStrategy Mobile wil l be installed. I f lef t empty,it takes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\Mobile Clients

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Mobile Clients

MobileASPPath

Locat ion where MicroStrategy Mobile Server ASP.NET wil l beinstalled. I f lef t empty, it takes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\Mobile Server AS

Px

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Mobile Server ASPx

MobileJSPPath

Locat ion where MicroStrategy Mobile Server JSP wil l be installed. I flef t empty, it takes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\Mobile Server JS

P

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Mobile Server JSP

Portlets

Locat ion where MicroStrategy Port lets wil l be installed. I f lef t empty,it takes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\Portlets

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\Portlets

MDXCubeProvider Locat ion where the MicroStrategy MDX Cube Provider wil l be



Options Description

installed. I f lef t empty, it takes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\MDX Cube Provide

r

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\MDX Cube Provider

GISConnectors

Locat ion where the MicroStrategy GIS Connectors wil l be installed. I flef t empty, it takes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\GISConnectors

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\GISConnectors

SystemManager

Locat ion where the MicroStrategy System Manager wil l be installed.I f lef t empty, it takes the default locat ion of :

• 32-bit Windows environments:C:\Program Files\MicroStrategy\SystemManager

• 64-bit Windows environments: C:\Program Files (x86)\MicroStrategy\SystemManager

Select Components Dialog - Product Visibi l i ty State

In the MicroStrategy Instal lation Wizard, the Select Components dialog boxcontains checkboxes to select or clear for products to be instal led. The[ComponentSelection] options speci fy whether you want the fol lowingproducts to be visible to the user. In addi tion, you can set the defaul tselection for each product.

Options Description

[ComponentSelection] Equivalent to the Select



Options Description

Components dialog box that you seeduring installat ion. For theVisible opt ion, you can eitherenter TRUE to show a product orFALSE to hide it . I f you do notspecify a TRUE or FALSE value foreach product , TRUE is used for allproducts. For the Select opt ion,you can enter TRUE to select thecheckbox next to a product . I f youenter FALSE, the checkbox next tothe product is not selected.

HideDialogTRUE or FALSE. FALSE displays thedialog box. The default is FALSE.

AnalyticsModulesVisible MicroStrategy Analyt ics Modules

ArchitectVisible MicroStrategy Architect

CommandManagerVisible MicroStrategy Command Manager

DeliveryEngineVisible MicroStrategy Delivery Engine

DeveloperVisible MicroStrategy Developer

AnalystVisible MicroStrategy Analyst

EnterpriseManagerVisible MicroStrategy Enterprise Manager

FunctionPluginVisibleMicroStrategy Funct ion Plug-InWizard

GISConnectorsVisible MicroStrategy GIS Connectors

IntegrityManagerVisible MicroStrategy Integrity Manager

IntelligenceDistributionServicesVisible MicroStrategy Dist ribut ion Services

IntelligenceOLAPServicesVisible MicroStrategy OLAP Services



Options Description

IntelligenceReportServicesVisible MicroStrategy Report Services

IntelligenceTransactionServicesVisible MicroStrategy Transact ion Services

IntelligenceVisible MicroStrategy Intell igence Server

MobileServerASPVisibleMicroStrategy Mobile Server(ASP.NET)

MobileServerJSPVisible MicroStrategy Mobile Server (JSP)

MobileVisible MicroStrategy Mobile

MobileClientVisible MicroStrategy Mobile Client

NCSAdminVisibleMicroStrategy NarrowcastAdminist rator

ObjectManagerVisible MicroStrategy Object Manager

OfficeVisible MicroStrategy Off ice

PortletsVisible MicroStrategy Port lets

SequeLinkVisible SequeLink ODBC Socket Server

ServerAdminVisible MicroStrategy Server Administ rator

SubscriptionPortalVisible MicroStrategy Subscript ion Portal

SystemManagerVisible MicroStrategy System Manager

MDXCubeProviderVisible MicroStrategy MDX Cube Provider

TutorialDeliveryConfigureVisibleMicroStrategy Tutorial - DeliveryConf igurat ion

TutorialDeliveryInstallVisibleMicroStrategy Tutorial - DeliveryInstallat ion

WebAnalystVisible MicroStrategy Web Analyst

WebProfessionalVisible MicroStrategy Web Professional



Options Description

WebReporterVisible MicroStrategy Web Reporter

WebServerASPNETVisibleMicroStrategy Web Server(ASP.NET)

WebServerJSPVisible MicroStrategy Web Server (JSP)

WebServicesASPNETVisibleMicroStrategy Web Services(ASP.NET)

WebServicesJSPVisible MicroStrategy Web Services (JSP)

IdentityServerVisible MicroStrategy Ident ity Server

IdentityManagerVisible MicroStrategy Ident ity Manager

UsherProfessionalVisible MicroStrategy Communicator

TelemetryServerVisible MicroStrategy Telemetry

TomcatVisible Apache Tomcat

MySQLVisible MySQL

LibraryWebMobileVisibleMicroStrategy Library Web andMobile

CollaborationVisible Collaborat ion Server

DataServerVisible Data Server

CommunityConnectorsVisible Community Connectors

PlatformAnalyticsVisible Plat form Analyt ics

CertificateStoreVisible Cert if icate Store

Select Components Dialog - Product Selection State

During the instal lation process in the MicroStrategy Instal lation Wizard, theSelect Components dialog box contains checkboxes to select or clear forproducts to be instal led. You can ei ther speci fy TRUE to instal l a product orFALSE to uninstal l i t. If you do not speci fy a TRUE or FALSE value for each



product, the instal lation always uses the most recent selection from aprevious instal l .

This means that if you have a product installed and you do not specify a TRUEor FALSE value, the product is upgraded.

If you speci fy TRUE , the product checkbox is selected. The[ComponentSelection] options speci fy whether the checkbox for eachproduct wi l l be selected or cleared.

Options Description

AnalyticsModulesSelect MicroStrategy Analyt ics Modules

ArchitectSelect MicroStrategy Architect

CommandManagerSelect MicroStrategy Command Manager

DeliveryEngineSelect MicroStrategy Delivery Engine

DeveloperSelect MicroStrategy Developer

AnalystSelect MicroStrategy Analyst

EnterpriseManagerSelect MicroStrategy Enterprise Manager

FunctionPluginSelectMicroStrategy Funct ion Plug-InWizard

GISConnectorsSelect MicroStrategy GIS Connectors

IntegrityManagerSelect MicroStrategy Integrity Manager

IntelligenceDistributionServicesSelect MicroStrategy Dist ribut ion Services

IntelligenceOLAPServicesSelect MicroStrategy OLAP Services

IntelligenceReportServicesSelect MicroStrategy Report Services

IntelligenceSelect MicroStrategy Intell igence Server

IntelligenceTransactionServicesSelect MicroStrategy Transact ion Services



Options Description

MobileClientSelect MicroStrategy Mobile Client

MobileSelect MicroStrategy Mobile

MobileServerASPSelectMicroStrategy Mobile Server(ASP.NET)

MobileServerJSPSelect MicroStrategy Mobile Server (JSP)

NCSAdminSelectMicroStrategy NarrowcastAdminist rator

ObjectManagerSelect MicroStrategy Object Manager

OfficeSelect MicroStrategy Off ice

PortletsSelect MicroStrategy Port lets

SequeLinkSelect SequeLink ODBC Socket Server

ServerAdminSelect MicroStrategy Server Administ rator

SubscriptionPortalSelect MicroStrategy Subscript ion Portal

SystemManagerSelect MicroStrategy System Manager

MDXCubeProviderSelect MicroStrategy MDX Cube Provider

TutorialDeliveryConfigureSelectMicroStrategy Tutorial - DeliveryConf igurat ion

TutorialDeliveryInstallSelectMicroStrategy Tutorial - DeliveryInstallat ion

WebAnalystSelect MicroStrategy Web Analyst

WebProfessionalSelect MicroStrategy Web Professional

WebReporterSelect MicroStrategy Web Reporter

WebServerASPNETSelectMicroStrategy Web Server(ASP.NET)



Options Description

WebServerJSPSelect MicroStrategy Web Server JSP

WebServicesASPNETSelectMicroStrategy Web Services(ASP.NET)

WebServicesJSPSelect MicroStrategy Web Services (JSP)

IdentityServerSelect MicroStrategy Ident ity Server

IdentityManagerSelect MicroStrategy Ident ity Manager

UsherProfessionalSelect MicroStrategy Communicator

TelemetryServerSelect MicroStrategy Telemetry

TomcatSelect Apache Tomcat

LibraryWebMobileSelectMicroStrategy Library Web andMobile

CollaborationSelect Collaborat ion Server

DataServerSelect Data Server

CommunityConnectorsSelect Community Connectors

PlatformAnalyticsSelect Plat form Analyt ics

CertificateStoreSelect Cert if icate Store

Instal lation Fi les

Options Description

[IODSourceLocation]

Sect ion specifying the locat ion of the f i les required to installthe MicroStrategy components you have selected forinstallat ion. Specifying the locat ion of the installat ion f i les isonly required if you have downloaded only a subset of theMicroStrategy installat ion f i les and stored some of the f i les inanother locat ion. For steps to determine the f i les required foryour installat ion, see Creat ing Custom Installat ion Packages,



Options Description

page 131.

Style

Determines whether the required installat ion f i les are providedin a folder or at a URL. You must def ine this parameter with oneof the following values:

• FILESERVER: Type this value if the required installat ionf i les are stored in a folder on the local machine or a servermachine. You must also provide the locat ion of the f i lesusing the SourceLocation parameter.

• HTTP: Type this value if the required installat ion f i les arestored at an unsecured URL. You must also provide thelocat ion of the f i les using the URL parameter.

• HTTPS: Type this value if the required installat ion f i les arestored at a secured URL. You must also provide the locat ionof the f i les using the URL parameter, as well as the username and password to access the URL using the UserName

and Password parameters.

SourceLocation

Locat ion of the folder that stores any required installat ion f i les.Type the locat ion of the local f i le path. I f you store the f i les in alocal folder, do not provide a locat ion in the URL parameter.

URL

Locat ion of the URL for the HTTP or HTTPS locat ion that storesany required installat ion f i les. Type the URL for the locat ionthat stores any required installat ion f i les. I f you store the f i lesat an HTTP or HTTPS locat ion, do not provide a locat ion in theSourceLocation parameter.

UserName

I f you retrieve the installat ion f i les f rom a URL locat ion, type auser name that has access to the URL locat ion. I f there is nologin required to the URL or you retrieve the installat ion f i lesf rom a local folder, you can leave this f ield blank.

Password

I f you retrieve the installat ion f i les f rom a URL locat ion, type apassword for the user name. I f there is no login required to theURL or you retrieve the installat ion f i les f rom a local folder, youcan leave this f ield blank.




Options Description

[ServicesRegConfig] Sect ion that specif ies the services regist rat ion conf igurat ion.


MultipleMachine

Environment

TRUE or FALSE. FALSE sets this machine as a server node inthe environment. Otherwise, specify the server nodes in theServersInCluster opt ion.

ServersInCluster

Provide the services regist rat ion server hostnames, separatedby semicolons. The input must to be ident ical for all conf iguredmachines in this environment. I t is recommended to conf igurean odd number of servers in a cluster. Example:server1.domain.com; server2.domain.com;

server3.domain.com.

Platform Analytics Configuration

Options Description

[PlatformAnalyticsConfig]Sect ion that specif ies the conf igurat ion forPlat form Analyt ics.

HideDialogTRUE or FALSE. FALSE displays the dialog box.The default is FALSE.

PlatformAnalyticsUseCustomDB

TRUE or FALSE. For non-upgrades,TRUE specif ies a custom MySQL database to storePlat form Analyt ics data. For upgrades, TRUEspecif ies a new MySQL database locat ion.

PlatformAnalyticsDBHost The hostname for the MySQL database.

PlatformAnalyticsDBPort The port for the MySQL database.

PlatformAnalyticsDBUser The username for accessing the MySQL database.

PlatformAnalyticsDBPasswordThe user's password for accessing the MySQLdatabase.



MicroStrategy Telemetry Cluster Configuration

Options Description

TelemetryServerConfig Sect ion that conf igures MicroStrategy Telemetry.

HideDialogTRUE or FALSE. FALSE displays the dialog box. Thedefault is FALSE.

TelemetryServerClusterTRUE or FALSE.TRUE enables MicroStrategyTelemetry. The default is FALSE.

TelemetryServerLocalNode Enter the local node's hostname.

TelemetryServerRemoteNodesEnter a semicolon separated list of the remote node'shostnames.

MicroStrategy Identi ty Configuration

Options Description

[IdentityConfig]Sect ion that conf igures MicroStrategyIdent ity Services.

HideDialogTRUE or FALSE. FALSE displays the dialogbox. The default is FALSE.

ExpressSkipIdentityConfig

TRUE or FALSE when ExpressMode=

TRUE. TRUE to skip MicroStrategy Ident ityconf igurat ion in Express Installat ion. Set toFALSE when ExpressMode= FALSE.

CACertificateChain

Complete cert if icate chain for your SSLServer Cert if icate that you obtained from youIT Administ rator. The path must be specif iedin an absolute format suchasC:\folder\example.pem.

ServerCertificate

The SSL Server Cert if icate (.crt ) f i le for yourWindows server. The path must be specif iedin an absolute format such as



Options Description

C:\folder\example.crt.

ServerCertificateKey

The key f i le for your SSL Server Cert if icate(.crt ). The path must be specif ied in anabsolute format suchC:\folder\example.key.

ServerCertificateKeyPasswordFile

I f your CA-signed cert if icate has a password,create a text f i le containing this password andenter the text f i le locat ion.

SMTPServerSMTP Server used for MicroStrategy Ident ityBadge email service.

SMTPServerPort SMTP Server Port .

SMTPUserI f your server is password protected, enter theusername for the server. This is opt ional.

SMTPUserPasswordI f your server is password protected, enter thepassword for the server. This is opt ional.

SMTPEmail

The email address that is authorized to sendemails f rom your SMTP server. This emailaddress is used to send badge invitat ions foryour MicroStrategy Ident ity Badge Network.

FQDNThe Fully Qualif ied Domain Name of yourWindows server.

Open Source Software Agreement Dialog

Intel l igence Server Defini tion Setting

Options Description

[ServerDefinitionSetting]Sect ion specifying whether MicroStrategy Intell igenceServer wil l use the server def init ion included with the



Options Description

Tutorial.


OverwriteServerDefinition

TRUE or FALSE. This opt ion relates to the Tutorial. Setthis opt ion to overwrite exist ing MicroStrategyIntell igence Server def init ions from a previous install.The default is FALSE.

Analytics Module

Options Description

[AnalyticsSetting]Sect ion that specif ies the DSN used to connect to theMicroStrategy Analyt ics Modules.


OverwriteDSN

TRUE or FALSE. Set this opt ion to overwrite an exist ing DSNwith the same name. The data source names are as follows:

• Analytics_Metadata

• CAM_WH_AC

• FRAM_WH_AC

• HRAM_WH_AC

• MicroStrategy_Tutorial_Data

• SAM_WH_AC

• SDAM_WH_AC




MicroStrategy Web Virtual Directory

Options Description

[WebVirtualDirectory]Sect ion that specif ies the virtual directory to be used for theMicroStrategy Web applicat ion.

HideDialogTRUE or FALSE. FALSE displays the dialog box. The defaultis FALSE.

VirtualDirectoryEnter a name for the virtual directory. The default isMicroStrategy.

RemoveVD

YES or NO. This opt ion is for the uninstall only. Set thisopt ion to remove an exist ing MicroStrategy Web virtualdirectory f rom a previous installat ion. The default is NO.

MicroStrategy Mobi le Server Virtual Directory

Options Description

[MobileVirtualDirectory]Sect ion that specif ies the virtual directory to be usedfor the MicroStrategy Mobile Server applicat ions.


VirtualDirectoryEnter a name for the virtual directory. The default isMicroStrategyMobile.

ReconfigureVirtualDirectory

TRUE or False. This opt ion is relevant to upgradingMicroStrategy from a pre-9.0.1m version. TRUEreplaces the virtual directory used to supportMicroStrategy Mobile for BlackBerry with the newvirtual directory specif ied for MicroStrategy MobileServer. For more informat ion on upgradeinstallat ions, see the Upgrade Guide.

RemoveVD

YES or NO. This opt ion is for the uninstall only. Setthis opt ion to remove an exist ing MicroStrategyMobile Server virtual directory f rom a previousinstallat ion. The default is NO.




MicroStrategy MDX Cube Provider Virtual Directory

Options Description

[MDXCubeProviderVirtualDirectory]

Sect ion that specif ies the virtual directory tobe used for the MicroStrategy MDX CubeProvider.

HideDialogTRUE or FALSE. FALSE displays the dialogbox. The default is FALSE.

VirtualDirectoryEnter a name for the virtual directory. Thedefault is MicroStrategyMDX.

ReconfigureVirtualDirectory

TRUE or FALSE. Set this opt ion to TRUE i fthe virtual directory for the MicroStrategyMDX Cube Provider should be reconf iguredto support a new virtual directory.

RemoveVD

YES or NO. This opt ion is for the uninstallonly. Set this opt ion to remove an exist ingMicroStrategy MDX Cube Provider virtualdirectory f rom a previous installat ion. Thedefault is NO.

Subscription Portal Virtual Directory

Options Description

[PortalVirtualDirectory]Sect ion that specif ies the virtual directory to be used forMicroStrategy Subscript ion Portal.


VirtualDirectoryEnter a name for the virtual directory. The default isNarrowcastServer.

RemoveVD

YES or NO. This opt ion is for the uninstall only. Set thisopt ion to remove an exist ing MicroStrategy Subscript ionPortal virtual directory f rom a previous installat ion. Thedefault is NO.



MicroStrategy Web Services Virtual Directory

Options Description

[WebServicesDirectory]Sect ion that specif ies the virtual directory to be used forMicroStrategy Web Services.


VirtualDirectoryEnter a name for the virtual directory. The default isMicroStrategyWS.

RemoveVD

YES or NO. This opt ion is for the uninstall only. Set thisopt ion to remove an exist ing MicroStrategy Subscript ionPortal virtual directory f rom a previous installat ion. Thedefault is NO.

MicroStrategy Office Web Services URL




Options Description

[OfficeWebServicesUR

L]

Sect ion specifying the URL for MicroStrategy Web Servicesand Web Services.


AllowBlankURL TRUE or FALSE. Specify whether to allow a blank URL.






Options Description

The installat ion rout ine validates the provided URL. I f noURL is provided, the user is informed that it has been lef tblank and needs to be conf igured with the MicroStrategyOff ice Conf igurat ion Tool. I f this is set to TRUE, the usermessage is not displayed if the URL is lef t blank. Thedefault is FALSE.

URL

Enter a URL point ing to a valid MicroStrategy Web Servicesinstallat ion, for example,http://localhost/MicroStrategyWS/MSTRWS.asm

x

MicroStrategy Office Setting




Options Description

[MSOfficeLoadOptions]

Sect ion specifying the opt ions that determine if theMicroStrategy Off ice toolbar is loaded in the installedMicrosof t Of f ice applicat ions.


ConfigureExcel

TRUE or FALSE. Specify to load the MicroStrategy Off icetoolbar by default when the Microsof t Excel applicat ion runs.This applies only if Excel is installed in the target machine.






Options Description

The default is TRUE.

ConfigureWord

TRUE or FALSE. Specify to load the MicroStrategy Off icetoolbar by default when the Microsof t Word applicat ion runs.This applies only if Word is installed on the target machine.The default is TRUE.

ConfigurePowerpoint

TRUE or FALSE. Specify to load the MicroStrategy Off icetoolbar by default when the Microsof t PowerPoint applicat ionruns. This applies only if PowerPoint is installed on thetarget machine. The default is TRUE.

Intel l igence Server Service Account

Options Description

[IntelligenceServiceAccount]

Sect ion specifying the Windows account for theMicroStrategy Intell igence Server service. Youhave two opt ions:

• bypass entering the account informat ion

• enter the account informat ion

HideDialogTRUE or FALSE. FALSE displays the dialog box.The default is FALSE.

SkipAccountSetting

TRUE or FALSE. Set TRUE to bypass the serviceaccount set t ing in the MicroStrategy Intell igenceServer Set t ing dialog box. I f you bypass it , thenthe service runs with the local system account thatis install ing the products. The default is FALSE.

Domain Enter the domain where the account is located.

Login Enter the user name of the account to use.

Password Enter the password for the account .

ServiceStartup AUTO or MANUAL. Select to set the Intell igence



Options Description

Server service startup to be automat ic or manual.The default is AUTO.

Narrowcast Server Service Account

Options Description

[NarrowcastServiceAccount]Sect ion specifying the Windows account f rom whichthe MicroStrategy Narrowcast Server service wil l run.


SkipAccountSetting

TRUE or FALSE.

I f you specify this value as FALSE, the serviceaccount set t ings are not skipped and theMicroStrategy Narrowcast Server set t ing dialog box isdisplayed. Specify the details of the Windows accountthat the MicroStrategy Narrowcast Server services wil luse to log on and click Next to proceed with theinstallat ion process.

Domain Enter the domain where the account is located.

Login Enter the user name of the account to use.

Password Enter the password for the account .

Start Copying Fi les Dialog

Options Description

[Summary]Sect ion that specif ies the installat ion summary in the Start Copying Filesdialog box.




MicroStrategy Instal lation Wizard Complete Dialog

Options Description

[Finish]Sect ion that specif ies the MicroStrategy Installat ion Wizard Completedialog box.


Example of a response.ini File for Custom Installation to Install AllComponents

Starting from 10.4, you can find the sample_custom.ini in the samelocation as the installation setup.exe . Replace any text between the angledbrackets <> with your own specific information.

Your license key determines which MicroStrategy components will beavailable for your installation. For example, if your license key does notinclude MicroStrategy OLAP Services, then you cannot useIntelligenceOLAPServicesSelect=TRUE andIntelligenceOLAPServicesVisible=TRUE to install thesecomponents.

Click here to see an example response.ini fi le for custom instal lation toinstal l al l components.

######################################

## MicroStrategy 11.1 Response File ##

######################################

#

# This file contains entries targeted to Custom Mode, which will install and

configure the full platform on one machine.

#

# For more information on Silent Install please refer to the section on

"Installing and configuring with a response.ini file" in the Installation and

Configuration guide available at

http://www2.microstrategy.com/producthelp/manuals/en/InstallationConfig.pdf.

#



# We are working to improve our Silent and Automated installation use-cases.

Feedback on Silent or Automated installations is welcomed via the

MicroStrategy Community (Platform Services > Platform > Secure Enterprise -

Windows) or via Technical Support to the Deployment Team.

# Here is a direct link (as of Jun 2017) to the Community sub-section on

platform deployment:

https://success.microstrategy.com/s/topic/0TO44000000FlkJGAS/Secure%20Enterpr

ise%20-%20Windows%20-%20U092?tabset-215d6=1

#

######################################

## Usage ##

######################################

#

# In an Administrator Command Line window (Windows Button > CMD, Right Click

and Run As Administrator)

#

# Silent Install Usage: #PathToSetupExe# --responseFile="#PathToResponseIni#"

-s -f1#PathToSetupIss# -f2#PathToLogFile#

#

# Example: C:\Setup.exe --responseFile="C:\response_custom.ini" -s -

f1C:\Setup.iss -f2C:\Setup.log

#

# This assumes the following:

#

# Setup.exe is located at: C:\Setup.exe

# MicroStrategy Response File is located at: C:\response_custom.ini

# Installer Setup.iss is located at: C:\Setup.iss

# Output Log file should be written to: C\Setup.log

#

#

# Response entries start here, replace any text between angled brackets (<>)

with your own text

[Installer]

ExpressMode=FALSE

PropertiesFilesOverwrite=FALSE

EnableTracing=FALSE

HideAllDialogs=TRUE



# After initial installation is finished, choose whether to automatically

reboot the machine.

# A reboot is required.

# TRUE - Indicates the machine will automatically reboot (recommended)

# FALSE - Indicates that no automatic reboot will be performed. Task Manager

(setup.exe) or the Install.log may be used to determine once the installation

is finished as no other indication will be provided.

ForceReboot=TRUE

PreventReboot=FALSE

CheckTCPIP=TRUE

CheckIIS=TRUE

CreateShortcuts=TRUE

CheckRenameOperations=TRUE

AnalyticsOverwrite=True

TutDeliveryOverwrite=True

BackupFiles=FALSE

RunConfigWizard=FALSE

StopAllServices=TRUE

StopIIS=TRUE

EnableASPServices=TRUE

EnableASPNETServices=TRUE

ShowWelcomeScreen=FALSE

EnterpriseManagerOverwrite=TRUE

###ConfigWizardResponseFile=Response.ini

# Path and File Name for the Installation Log file.

# If no value is specified, the default location will be used: C:\Program

Files (x86)\Common Files\MicroStrategy\install.log

LogFile=

[Welcome]

HideDialog=TRUE

RemoveAll=FALSE

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# Customer Information

#

# Please specify your first name, last name, email address, the name of the



company

# for which you work and the license key.

#

# If MicroStrategy Identity is installed, this information is used to create

the initial MicroStrategy Identity Network and user badge.

[UserRegistration]

HideDialog=TRUE

# First name of user

UserFirstName=<value>

# Last name of user

UserLastName=<value>

# Email address of user

UserEmail=<value>

# Company

CompanyName=<value>

# License key

LicenseKey=<value>

[LicenseDetail]

HideDialog=TRUE

[SetupExpress]

HideDialog=TRUE

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# Product Install Location.

# Use the following values to specify the install location for MicroStrategy

products.

# The default path of TargetDirectory is C:\Program Files (x86)\MicroStrategy

# The default path of COMMONFILES is C:\Program Files (x86)\Common

Files\MicroStrategy



[SuiteTarget]

HideDialog=TRUE

TargetDirectory=

[InitialPaths]

COMMONFILES =

[ComponentSelection]

HideDialog=TRUE

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Product Visibility State

#

# For GUI based installations, this section provides a visibility state

setting for every MicroStrategy product.

# Legal values are:

#

# TRUE - Indicates that the product is visible for selection or

deselection

# FALSE - Indicates that the product is not visible for selection or

deselection

#

# The default value for visibility state settings is "true".

#

# For example, to make "MicroStrategy Intelligence" visible

# for selection or deselection

#

# IntelligenceVisible=TRUE

#

# All licensed products are visible by default, so in case you want to

prevent

# them from being visible, make sure they are set to false.

DeveloperVisible=TRUE

AnalystVisible=TRUE

ArchitectVisible=TRUE



ServerAdminVisible=TRUE

FunctionPluginVisible=FALSE

CommandManagerVisible=TRUE

EnterpriseManagerVisible=TRUE

ObjectManagerVisible=TRUE

IntegrityManagerVisible=TRUE

IntelligenceVisible=TRUE

IntelligenceOLAPServicesVisible=TRUE

IntelligenceReportServicesVisible=TRUE

IntelligenceDistributionServicesVisible=TRUE

IntelligenceTransactionServicesVisible=TRUE

WebAnalystVisible=TRUE

WebProfessionalVisible=TRUE

WebReporterVisible=TRUE

WebServerASPNETVisible=TRUE

WebServerJSPVisible=TRUE

WebServicesASPNETVisible=TRUE

WebServicesJSPVisible=TRUE

OfficeVisible=TRUE

MobileVisible=TRUE

MobileClientVisible=TRUE

MobileServerASPVisible=TRUE

MobileServerJSPVisible=TRUE

AnalyticsModulesVisible=TRUE

NCSAdminVisible=TRUE

DeliveryEngineVisible=TRUE

SubscriptionPortalVisible=TRUE

TutorialDeliveryInstallVisible=TRUE

TutorialDeliveryConfigureVisible=TRUE

SequeLinkVisible=TRUE

PortletsVisible=TRUE

MDXCubeProviderVisible=TRUE

GISConnectorsVisible=TRUE

SystemManagerVisible=TRUE

# New in 10.3

IdentityServerVisible=TRUE

IdentityManagerVisible=TRUE

UsherProfessionalVisible=TRUE

# New in 10.5



TelemetryServerVisible=TRUE

TomcatVisible=TRUE

# New in 10.9

LibraryWebMobileVisible=TRUE

CollaborationVisible=TRUE

# New in 11.0

DataServerVisible=TRUE

CommunityConnectorsVisible=TRUE

PlatformAnalyticsVisible=TRUE

CertificateStoreVisible=TRUE

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Product Selection State

#

# Determines which products are installed (GUI and Silent). A selection

state setting is available for every MicroStrategy product.

# Legal values are:

#

# TRUE - Indicates that the product is selected for installation

# FALSE - Indicates that the product is not selected for installation

#

# The default value for Selection state settings is "true".

#

# For example, to select "MicroStrategy Intelligence"

# for installation use

#

# IntelligenceSelect=TRUE

#

# Most licensed products are selected by default, so in case you want to

prevent

# them from being installed make sure they are unselected too.

DeveloperSelect=TRUE

AnalystSelect=TRUE

ArchitectSelect=TRUE

ServerAdminSelect=TRUE

FunctionPluginSelect=FALSE



CommandManagerSelect=TRUE

EnterpriseManagerSelect=TRUE

ObjectManagerSelect=TRUE

IntegrityManagerSelect=TRUE

IntelligenceSelect=TRUE

IntelligenceOLAPServicesSelect=TRUE

IntelligenceReportServicesSelect=TRUE

IntelligenceDistributionServicesSelect=TRUE

IntelligenceTransactionServicesSelect=TRUE

WebAnalystSelect=TRUE

WebProfessionalSelect=TRUE

WebReporterSelect=TRUE

WebServerASPNETSelect=TRUE

WebServerJSPSelect=TRUE

WebServicesASPNETSelect=TRUE

WebServicesJSPSelect=TRUE

OfficeSelect=TRUE

MobileSelect=TRUE

MobileClientSelect=TRUE

MobileServerASPSelect=TRUE

MobileServerJSPSelect=TRUE

AnalyticsModulesSelect=TRUE

NCSAdminSelect=TRUE

DeliveryEngineSelect=TRUE

SubscriptionPortalSelect=TRUE

TutorialDeliveryInstallSelect=TRUE

TutorialDeliveryConfigureSelect=TRUE

SequeLinkSelect=TRUE

PortletsSelect=TRUE

MDXCubeProviderSelect=TRUE

GISConnectorsSelect=TRUE

SystemManagerSelect=TRUE

# New in 10.3

IdentityServerSelect=TRUE

IdentityManagerSelect=TRUE

UsherProfessionalSelect=TRUE

# New in 10.5

TelemetryServerSelect=TRUE

TomcatSelect=TRUE



# New in 10.9

LibraryWebMobileSelect=TRUE

CollaborationSelect=TRUE

# New in 11.0

DataServerSelect=TRUE

CommunityConnectorsSelect=TRUE

PlatformAnalyticsSelect=TRUE

CertificateStoreSelect=TRUE

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

# Topology Configuration

# The Workstation Topology helps administrators to monitor and manage

services

# in a MicroStrategy environment. Choose your configuration below.

[ServicesRegConfig]

HideDialog=TRUE

# If MultipleMachineEnvironment=FALSE, this machine will be set as a server

node in the environment.

# Otherwise, please specify server nodes in ServersInCluster option.

MultipleMachineEnvironment=FALSE

# The input below will be entered identically for all configured machines in

this environment.

# Example: servername1.acme.com; servername2.acme.com; servername3.acme.com

# It is recommended to configure an odd number of servers in a cluster

ServersInCluster=

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

# Platform Analytics Configuration

[PlatformAnalyticsConfig]

HideDialog=TRUE

# For non-upgrade, specify custom MySQL database to store Platform Analytics

data

# For upgrade, specify a new MySQL database location

PlatformAnalyticsUseCustomDB=FALSE



PlatformAnalyticsDBHost=

PlatformAnalyticsDBPort=

PlatformAnalyticsDBUser=

PlatformAnalyticsDBPassword=

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

# Telemetry Server Cluster Configuration

[TelemetryServerConfig]

HideDialog=TRUE

TelemetryServerCluster=FALSE

# Please provide local node's hostname

TelemetryServerLocalNode=

# Please provide a semicolon separated list of remote nodes' hostname

TelemetryServerRemoteNodes=

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

# MicroStrategy Identity Product Configuration

# The parameters in [IdentityConfig] section only apply when MicroStrategy

Identity Products are selected.

[IdentityConfig]

HideDialog=TRUE

# For Custom install, ExpressSkipIdentityConfig has to be FALSE for

installation to proceed

# For Express install, if ExpressSkipIdentityConfig=TRUE, the rest of the

values in this section will be ignored and MicroStrategy Identity will NOT be

configured

ExpressSkipIdentityConfig=FALSE

# Path and File Name for the Certificate Bundle (Chain), typically .pem. e.g.

C:\certs\labs.pem

CACertificateChain=<value>

# Path and File Name for the Server Certificate. e.g. C:\certs\labs.crt

ServerCertificate=<value>

# Path and File Name for the Server Certificate Key file. e.g.



C:\certs\labs.key

ServerCertificateKey=<value>

# Optional: Path and File Name to the file which contains the password to the

Server Certificate Key (.key) file.

ServerCertificateKeyPasswordFile=

# SMTP Server name

SMTPServer=<value>

# SMTP Server port number

SMTPServerPort=<value>

# Optional: SMTP Server Using SSL

SMTPUseSSL=FALSE

# Optional: SMTP User name

SMTPUser=

# Optional: SMTP user password

SMTPUserPassword=

# SMTP email

SMTPEmail=<value>

# Fully Qualified Domain Name

FQDN=<value>

[ServerDefinitionSetting]

HideDialog=TRUE

OverwriteServerDefinition=FALSE

[AnalyticsSetting]

HideDialog=TRUE

OverwriteDSN=FALSE

[WebVirtualDirectory]

HideDialog=TRUE



VirtualDirectory=MicroStrategy

ReconfigureVirtualDirectory=TRUE

[MobileVirtualDirectory]

HideDialog=TRUE

VirtualDirectory=MicroStrategyMobile


[PortalVirtualDirectory]

HideDialog=TRUE

VirtualDirectory=NarrowcastServer


[WebServicesVirtualDirectory]

HideDialog=TRUE

VirtualDirectory=MicroStrategyWS


[OfficeWebServicesURL]

HideDialog=TRUE

AllowBlankURL=FALSE

URL=http://localhost/MicroStrategyWS/mstrws.asmx

[MSOfficeLoadOptions]

HideDialog=TRUE

ConfigureExcel=TRUE

ConfigurePowerpoint=TRUE

ConfigureWord=TRUE

[IntelligenceServiceAccount]

HideDialog=TRUE

SkipAccountSetting=TRUE

Login=<NT_UserLoginHere>

Password=<UserPasswordHere>

Domain=<DomainHere>

ServiceStartUp=AUTO

[NarrowcastServiceAccount]

HideDialog=TRUE



SkipAccountSetting=True

Login=<NT_UserLoginHere>

Password=<UserPasswordHere>

Domain=<DomainHere>

[Summary]

HideDialog=TRUE

[Finish]

HideDialog=TRUE

Example of a response.ini File for Express Installation

Starting from 10.4 you can find the sample_express.ini in the samelocation as the installation setup.exe . Replace any text between angledbrackets <> with your own specific information.

Click here to see an example response.ini fi le for express instal lation.

######################################

## MicroStrategy 11.1 Response File ##

######################################

#

# This file contains a subset of entries required for Express Mode, which

will install and configure the full platform on one machine.

# For more information on Express Mode please refer to the section on

"Performing a MicroStrategy Express Installation" in the Installation and

Configuration guide available at

http://www2.microstrategy.com/producthelp/manuals/en/InstallationConfig.pdf.

# Additional entries are not included in this file and may be optionally

included for greater flexibility. For a full list, please refer to the

"Installing and configuring with a response.ini file" section in the

Installation and Configuration guide.

#


Feedback on Silent or Automated installations is welcomed via the

MicroStrategy Community (Platform Services > Platform > Secure Enterprise -

Windows) or via Technical Support to the Deployment Team.

# Here is a direct link (as of Jun 2017) to the Community sub-section on




https://success.microstrategy.com/s/topic/0TO44000000FlkJGAS/Secure%20Enterpr

ise%20-%20Windows%20-%20U092?tabset-215d6=1

#

######################################

## Usage ##

######################################

#

# In an Administrator Command Line window (Windows Button > CMD, Right Click

and Run As Administrator)

#

# Silent Install Usage: #PathToSetupExe --responseFile="#PathToResponseIni#"

-s -f1#PathToSetupIss# -f2#PathToLogFile#

#

# Example: C:\Setup.exe --responseFile="C:\response_express.ini" -s -

f1C:\Setup.iss -f2C:\Setup.log

#

# The above example assumes the following:

#

# Setup.exe is located at: C:\Setup.exe

# MicroStrategy Response File is located at: C:\response_express.ini

# Installer Setup.iss is located at: C:\Setup.iss

# Output Log file should be written to: C\Setup.log

#

# Response entries start here, replace any text between angled brackets (<>)

with your own text

[Installer]

ExpressMode=TRUE

HideAllDialogs=TRUE

# After initial installation is finished, choose whether to automatically

reboot the machine.

# A reboot is required.

# TRUE - Indicates the machine will automatically reboot (recommended)

# FALSE - Indicates that no automatic reboot will be performed. Task Manager

(setup.exe) or the Install.log may be used to determine once the installation

is finished as no other indication will be provided.

ForceReboot=TRUE



CheckIIS=TRUE



StopIIS=TRUE

ShowWelcomeScreen=FALSE

# Path and File Name for the Installation Log file.

# If no value is specified, the default location will be used: C:\Program

Files (x86)\Common Files\MicroStrategy\install.log

LogFile=

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#


# Use the following values to specify the install location for MicroStrategy

products.

# The default path of TargetDirectory is C:\Program Files (x86)\MicroStrategy

# The default path of COMMONFILES is C:\Program Files (x86)\Common

Files\MicroStrategy

[SuiteTarget]

HideDialog = TRUE

TargetDirectory =

[InitialPaths]

COMMONFILES =

[Welcome]

HideDialog=TRUE

RemoveAll=FALSE

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#


#

# Please specify your first name, last name, email address, the name of the

company for which you work and the license key.



#

# For Express Installation, this information is used to create the initial

MicroStrategy Identity Network and user badge.

[UserRegistration]

HideDialog=TRUE

# First name of user

UserFirstName=<value>

# Last name of user

UserLastName=<value>

# Email address of user

UserEmail=<value>

# Company

CompanyName=<value>

# License key

LicenseKey=<value>

[LicenseDetail]

HideDialog=TRUE

[SetupExpress]

HideDialog=TRUE

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Identity configuration

#

# MicroStrategy Identity requires SSL Certificates and a SMTP server to send

badge invitations.

[IdentityConfig]

HideDialog=TRUE



# For Express install, select whether MicroStrategy Identity will be

configured.

# TRUE - All other values in this [IdentityConfig] section will be ignored,

MicroStrategy Identity will be installed, but will NOT be configured.

# FALSE - Values in this section are required and will be used to install and

configure MicroStrategy Identity.

ExpressSkipIdentityConfig=<value>

# Path and File Name for the Certificate Bundle (Chain), typically .pem. e.g.

C:\certs\labs.pem

CACertificateChain=<value>

# Path and File Name for the Server Certificate, typically .crt. e.g.

C:\certs\labs.crt

ServerCertificate=<value>

# Path and File Name for the Server Certificate Key file, typically .key.

e.g. C:\certs\labs.key

ServerCertificateKey=<value>

# Optional: Path and File Name to the file which contains the password to the

Server Certificate Key (.key) file.

ServerCertificateKeyPasswordFile=

# SMTP Server name

SMTPServer=<value>

# SMTP Server port number

SMTPServerPort=<value>

# Optional: SMTP Server Using SSL

SMTPUseSSL=FALSE

# Optional: SMTP User name

SMTPUser=

# Optional: SMTP user password

SMTPUserPassword=



# SMTP Sender email address

SMTPEmail=<value>

# Fully Qualified Domain Name

FQDN=<value>

[Summary]

HideDialog=TRUE

[Finish]

HideDialog=TRUE

Using the response.ini File

The setup program supports several command-l ine parameters. Thefol lowing appl ies to this function:

l Parameters using double dashes, such as --auto , are defined byMicroStrategy. For example, you can use the --auto parameter asfol lows:

Path\setup.exe --Auto=TRUE --LogFile="C:\install.log"

l The command l ine is not case-sensi tive.

The fol lowing parameters are supported by the setup program:

l Auto : instructs the setup program to use the response fi le and defaul tvalues to enable a one-cl ick instal lation. If a component, such as serialkey or disk space has an inval id value, the setup program automatical lyreverts to multiple-cl ick mode, and al l dialog boxes are displayed.

l ResponseFile : contains responses to instal lation questions andredefines defaul t parameters. The path and fi le name must be in doublequotes (" "). If you use this parameter, do not use any other parameters.

l ConfigFile : used by the Configuration Wizard to set up a reposi tory, aserver, or a cl ient. The path and fi le name must be in double quotes (" ").



l LogFile : used to speci fy an al ternative location and/or name (other thaninstall.log ) for the log fi le in the Common Files directory. If only thefi le name is entered, the defaul t location remains the Common Fi lesdirectory. Once speci fied, the al ternative fi le becomes the defaul t.

To Use the response.ini File to Install MicroStrategy Components

1. Save your response.ini file to the directory C:\ . You can saveto a di fferent di rectory, but the example command provided in thesesteps assumes the response fi le is saved to the directory location C:\ .

2. From the Windows Start menu, select Programs, then selectAccessories, and then right-cl ick Command Prompt and select Runas Administrator. The User Account Control dialog box opens.

The steps to open a Windows command prompt with administratorpriv ileges may be different depending on your version of Windows.

3. Cl ick Yes to open the command prompt wi th administrator privi leges.The command prompt is displayed.

4. Type the fol lowing command in the Windows command l ine:

<Path>\setup.exe --ResponseFile="C:\response.ini"

Where <Path> is the directory where the setup.exe fi le is stored.

5. Cl ick Enter.

Configuring your Installation with a response.ini File

The Configuration Wizard walks you through the process of setting up theenvironment for the MicroStrategy products instal led in your system. It ispossible to configure server defini tion, project source names, and themetadata reposi tory using a response.ini fi le. The steps required tocreate a response.ini fi le to configure MicroStrategy are provided inConfiguring MicroStrategy with a Response Fi le, page 415.



Uninstalling with a response.ini File

You can uninstal l al l MicroStrategy products at once using aresponse.ini fi le. You must create a response fi le wi th the RemoveAll

parameter set to TRUE in the Welcome section. This is also known as asi lent uninstal lation.

You must save the file as ANSI encoding.

Before uninstal lation begins, the MicroStrategy appl ication:

l Checks for user privi leges. If they are not val id, uninstal lation stops.

l Checks for running components. If one is found, uninstal lation stops.

l Stops and deletes the MicroStrategy Intel l igence Server service.

l Deletes appl ication created fi les.

Example of a response.ini file to uninstall MicroStrategy

You can use the fol lowing response fi le to remove al l MicroStrategyproducts:

[Installer]

PropertiesFilesOverwrite=FALSE

EnableTracing=FALSE

HideAllDialogs=TRUE

ForceReboot=TRUE

PreventReboot=FALSE

CheckTCPIP=TRUE

CheckIIS=TRUE

CheckSP=TRUE

CreateShortcuts=TRUE

CheckRenameOperations=TRUE

AnalyticsOverwrite=FALSE

TutDeliveryOverwrite=FALSE

BackupFiles=FALSE



StopIIS=TRUE

EnableASPServices=FALSE

ConfigWizardResponseFile=



RegistrySizeReq=

LogFile=

[Welcome]

HideDialog=TRUE

RemoveAll=TRUE

[WebVirtualDirectory]

HideDialog=TRUE

VirtualDirectory=MicroStrategy

RemoveVD=YES

[MobileVirtualDirectory]

HideDialog=TRUE

VirtualDirectory=MicroStrategyMobile

RemoveVD=YES

[OperationsManagerVirtualDirectory]

HideDialog=TRUE

VirtualDirectory=MicroStrategyOM

RemoveVD=YES

[PortalVirtualDirectory]

HideDialog=TRUE

VirtualDirectory=NarrowcastServer

RemoveVD=YES

[WebServicesDirectory]

HideDialog=TRUE

VirtualDirectory=MicroStrategyWS

RemoveVD=YES

[Finish]

HideDialog=TRUE

For detai ls on creating a response.ini fi le, see Creating a response.iniFi le, page 562.

After you have created a response.ini fi le, open a Windows commandprompt to uninstal l al l MicroStrategy products. From the Windows Startmenu, select Programs, then select Accessories, and then right-cl ickCommand Prompt and select Run as Administrator. The User AccountControl dialog box opens.

The steps to open a Windows command prompt with administrator priv ilegesmay be different depending on your version of Windows.



Click Yes to open the command prompt wi th administrator privi leges. Thecommand prompt is displayed. Type the fol lowing script at the commandprompt to uninstal l al l MicroStrategy products:

Path1\setup.exe --ResponseFile= "Path2\response.ini"

Where the Path1 for setup.exe must be the path to the originalsetup.exe used to instal l MicroStrategy products. The Path2 for theresponse fi le is the path where you saved your response.ini fi le.

Silent InstallationA si lent, or unattended, instal lation is one that presents no user interface.Si lent instal lations are useful for system administrators who do not wantusers to interfere with the instal lation. They are typical ly implemented by ITdepartments that perform package-based instal lations across the network.

You can use si lent instal lation to easi ly embed MicroStrategy products wi thother appl ications. This can be done to develop an OEM appl ication thatincludes MicroStrategy functional i ty. For information on deploying a si lentinstal lation for OEM appl ications, see OEM Silent Instal lations, page 678.

Silent Installation Output

The system veri fies compl iance with instal lation prerequisi tes and placesrelated messages in a fi le created for that purpose. The fol lowing appl ies tothe generation and storage of output messages during si lent instal lation:

l The MSTRInst.log fi le is created and placed in the Temp folder.

l The MSTRInst.log fi le is maintained during the enti re setup.

l Al l system-generated messages, including messages containing reasonsfor pre-instal lation termination, are stored in the MSTRInst.log fi le.

If there are installation termination messages in subsequent installationinstances that use the same dialog flow, they are also stored in theMSTRInst.log .



The table below identi fies the information that the MSTRInst.log fi leincludes:

Line Description

Funct ion[F]

Ident if ies the funct ion calls in the setup script .

Informat ion[I]

Logs informat ion about the setup that is running.

Warning[W]

Includes feedback that you must verify related to the setup. For example, innormal mode, when MicroStrategy applicat ions are running on a machinewhere the setup is being run, you are prompted to close all MicroStrategyapplicat ions before proceeding. In silent mode, you are not prompted, andinstead the setup terminates.

Severe[S]

Includes fatal problems that prevent the setup from proceeding. For example,the Intell igence Server Service cannot be created and setup fails as a result .

A typical l ine in the MSTRInst.log fi le includes source fi le name, functionname, source l ine number, and time. It appears as fol lows:

[Z:\InstallMaster\Setup\Script Files\MALicense.rul][UseDLL]

[l: 28][1318179ms][W] Le file C:\WINDOWS\TEMP\{84D0D5E2-

719A-11D7-847C-000C293B5019}\{B339F3B3-E78C-45E8-B4D2-

3C46C1C13663}\MAInst.dll couldn't be loaded in memory.

When reviewing warning messages in the MSTRInst.log file, look for [W]and [S] to find related problems.

Activating a Silent Installation

After the si lent instal lation is complete, you must activate the MicroStrategyinstal lation within 30 days. To activate the instal lation you can fol low theinstructions provided in Chapter 5, Activating Your Instal lation.



Troubleshooting Silent Installations

Si lent instal lation may not work i f you are instal l ing in a di fferentenvironment than the one you recorded. This is the case because anydialog box that was not recorded previously is not recognized, such as aprompt to stop your Intel l igence Server or your IIS Web server. If thishappens, veri fy:

l The version of Intel l igence Server to ensure that you have the right onefor the products you are instal l ing

l You do not have any MicroStrategy appl ications running

l The setup.log fi le to see i f the ResultCode=0

l The install.log for any recorded errors during instal lation and theMSTRInst.log fi le for any possible errors. The most common errors are:

n -8, which is an inval id path to the MicroStrategy Instal lation Wizardsi lent response .iss fi le.

n -12, which is dialog boxes out of order. This occurs because anunrecorded screen opened when running the si lent instal l .

It is recommended that you create a si lent instal l that can be used with aresponse.ini fi le. For more information, see OEM Silent Instal lations,page 678. This way you can change the settings in the response.ini fi lewi thout having to generate a new .iss fi le.

Silent Installation of an Update

An update is a fi le or a col lection of fi les that you can apply toMicroStrategy products instal led on your computer to correct a speci ficproblem. Updates are packaged in a sel f-instal l ing .exe fi le. When youinstal l an update, fi les are backed up automatical ly so that you can removethe update later.



You can apply an update to MicroStrategy products using si lent instal lation.For information on instal l ing the update of MicroStrategy Office, see Si lentInstal lation of MicroStrategy Office, page 616.

You must obtain and unzip the MicroStrategy update files. These files includeresponse.ini and setup.iss . The rest of this procedure assumes youhave saved these files to the file path C:\ . If you save it to another location,replace C:\ with the file path to the response.ini and setup.iss .

Note that s ince MicroStrategy 2019 Update 2 installing an update requires thatyou obtain a new license key, different from your license key for MicroStrategy2019. Both keys can be retrieved using the "Generate Keys" tile on theMicroStrategy download page .

To Perform a Silent Installation of an Update

If you are installing an update of MicroStrategy Office, see Si lent Instal lationof MicroStrategy Office, page 616 .

1. From the Windows Start menu, go to Programs > Accessories, andthen right-cl ick Command Prompt > Run as Administrator. The UserAccount Control dialog box opens.


2. Cl ick Yes to open the command prompt wi th administrator privi leges.

3. Access the disk drive through the command prompt.

4. Run the si lent instal lation with the fol lowing command:

<InstallPath>\setup.exe -L<LanguageValue> --

ResponseFile="C:\response.ini" -s -f1"C:\setup.iss" -f2"C:\setup.log"

In the command l isted above, you must supply the fol lowinginformation:


https://community.microstrategy.com/s/products


l <InstallPath>: The location in which to install the MicroStrategy update.

l <LanguageValue> : Determines the language for the instal lation.

Refer to Language Settings for Si lent Instal lations, page 682, for anexplanation of the LanguageValue parameter.

For example, to select Engl ish, the command is as fol lows:

<InstallPath>\setup.exe -L0009 --ResponseFile="C:\response.ini" -s -

f1"C:\setup.iss" -f2"C:\setup.log"

You can check the status of the si lent instal lation in Windows TaskManager. After applying the update, you can view i t in the Add or RemovePrograms window.

Silent Installation of MicroStrategy Office




You can also instal l MicroStrategy Office as i ts own stand-aloneinstal lation, which lets you instal l only MicroStrategy Office. The stand-alone instal lation of MicroStrategy Office can also be used to instal lupdates of the MicroStrategy Office product.

To perform a si lent instal lation of MicroStrategy Office as a stand-aloneinstal lation, refer to the procedure below.

You can also perform an installation of MicroStrategy Office as its own stand-alone installation, but with the assistance of a MicroStrategy Office installation






wizard. The steps to use the MicroStrategy Office installation wizard areprovided in the MicroStrategy for Office Onl ine Help .

l You must have Microsoft .NET Framework and Microsoft Web ServicesEnhancement Runtime to install and support MicroStrategy Office. For therequired versions of these components, see the MicroStrategy Readme .

l You must have Microsoft Windows Installer 4.5 to install MicroStrategy Office.

l Microsoft Office must already be installed on the machine.

To perform a silent installation of MicroStrategy Office

1. Download the MicroStrategy Office stand-alone instal lation fi les. Youcan retrieve these from the MicroStrategy instal lation disk, or from theMicroStrategy download si te. The MicroStrategy Office stand-aloneinstal lation fi les include fi les named MicroStrategyOffice.msi

and MicroStrategyOffice64.msi . These .msi fi les are forinstal l ing MicroStrategy Office on 32-bi t and 64-bi t versions ofMicrosoft Office, respectively.

2. From the Windows Start menu, go to Programs > Accessories, andthen right-cl ick Command Prompt and select Run as Administrator.The User Account Control dialog box opens.



4. From a command prompt, navigate to the MicroStrategy Office updateinstal lation folder.

5. To view information on the options to run the si lent instal l command,enter the fol lowing command:msiexec.msi /?





This includes information on options to log the instal lation detai ls to alog fi le.

6. To run the si lent instal lation using instal lation options defined by thecurrent MicroStrategy Office configuration, enter one of the fol lowingcommands:

l To instal l on 32-bi t versions of Microsoft Office:

msiexec.exe /i MicroStrategyOffice.msi /qn

l To instal l on 64-bi t versions of Microsoft Office:

msiexec.exe /i MicroStrategyOffice64.msi /qn

You can also use additional parameters as part of the silent installationcommand, including the following:

l INSTALLDIR : Defines the directory in which MicroStrategy Officewi l l be instal led. For example, you can define this parameter asINSTALLDIR="C:\Program Files\MicroStrategy\Office" .

l WSURL : Defines the URL for MicroStrategy Web Services. Forexample, you can define this parameter asWSURL="http://localhost/MicroStrategyWS/MSTRWS.asm

x" .

l LW : Speci fy whether to load the MicroStrategy Office toolbar bydefaul t when the Microsoft Word appl ication runs. This appl ies onlyi f Word is instal led in the target machine. The defaul t is 3, whichloads the toolbar. You can set this option to 2 to not load the toolbarfor Microsoft Word.

l LE : Speci fy whether to load the MicroStrategy Office toolbar bydefaul t when the Microsoft Excel appl ication runs. This appl ies onlyi f Excel is instal led in the target machine. The defaul t is 3, which



loads the toolbar. You can set this option to 2 to not load the toolbarfor Microsoft Excel .

l LP : Speci fy whether to load the MicroStrategy Office toolbar bydefaul t when the Microsoft PowerPoint appl ication runs. This appl iesonly i f PowerPoint is instal led in the target machine. The defaul t is 3,which loads the toolbar. You can set this option to 2 to not load thetoolbar for Microsoft PowerPoint.

l OFFICECREATESHORTCUTS : Speci fy whether to create a shortcut forMicroStrategy Office in the Windows Start menu. The defaul t is 1,which creates the shortcut. You can set this option to 0 to excludethe creation of this shortcut.


After completing the steps to instal l Intel l igence Server, you can continuethe set up and configuration of your instal lation. To help guide the rest ofyour instal lation and configuration steps, refer to the section Instal lationand Configuration Checkl ists, page 135 in Chapter 1, Planning YourInstal lation, for instal lation and configuration checkl ists.



AUTOMATEDINSTALLATION ON L INUX



This section explains the various methods of performing a ful ly automatedand unattended instal lation within the MicroStrategy platform when you donot have access to a Linux graphical user interface (GUI).

Intelligence Server configurations possible through the command line on Linuxare covered in Chapter 12, Configuring MicroStrategy Using CommandLine Tools.

Before instal l ing MicroStrategy products, see Chapter 1, Planning YourInstal lation for important preinstal lation information.

Silent Installation

A si lent or unattended instal lation is one that presents no graphical userinterface (GUI). Si lent instal lations al low you to automate the instal lation,so i t can be cal led from a script and executed without user interaction.Si lent instal lations are useful for system administrators who do not wantusers to run the instal lation themselves. The si lent instal lation can be doneon one or more computers.

SSH is required to start and stop services in the Workstation Topology view.

Completing a Silent InstallationTo run si lent instal lation, you must create an options fi le and then run i twi th the MicroStrategy Instal lation Wizard. Save the options fi le asoptions.txt . An example of an options.txt fi le is provided inExample of an Options Fi le, page 622 below. You can use the example as atemplate and replace i tal icized text wi th your own information.

This options fi le or response fi le is used with the command l ine argument -options to modi fy the wizard settings. The settings that can be speci fiedfor the wizard are l isted in the next section, Parameters for a Si lentInstal lation, page 645.



1. Log on to the computer where you are instal l ing one or moreMicroStrategy products.

2. You can access the instal lation fi les by asking your systemadministrator to share the fi les in a network location.

3. Browse to theMicroStrategyInstallation/QueryReportingAnalysis_

Linux directory.

4. Open options.txt in a text edi tor.

5. Speci fy a value for a setting by replacing the character's Value . Fordetai led information on the parameters and values that can besuppl ied with the options.txt fi le for a si lent instal lation, seeParameters for a Si lent Instal lation, page 645.

6. Save the changes to the options.txt fi le.

7. To use the options fi le on a si lent instal lation, speci fy -silent -

options <FileName> as a command l ine argument to the wizard,where <FileName> is the name of this options fi le, for example,options.txt .

For example, type the command:

./setup.sh -silent -options <path of theoptions.txt file>

Example of an Options File

Copy and paste this example to create an options.txt fi le. Make sureyou check for correct spaces and new l ines in al l fi le paths.

For descriptions of each of the options l isted in this example, seeParameters for a Si lent Instal lation, page 645.

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 ofthe .tzp files that are required for the MicroStrategy installation, you mustdefine where these files are stored, using the parameters described in Instal lon Demand Options, page 668 .

Click here to see an example options.txt fi le.

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# Options File Template

#

# This file is an options file (i.e., response file) for the MicroStrategy

# Installer. The options file is loaded by default if it is named

"options.txt"

# and it is located in the same directory as setup.sh.

# An alternative options file can be specified by using "-options" on

# the command line.

#

# The settings that can be specified for the wizard are listed below. To use

# this template, follow these steps:

#

# 1. Enable a setting below by removing leading '###' characters from the

# line (search for '###' to find settings you can change).

#

# 2. Specify a value for a setting by replacing the character's '<value>'.

# Read each setting's documentation for information on how to specify its

# value.

#

# 3. Save the changes to the file.

#

# 4. Launch the installation using the setup.sh script

#

#


Feedback on

# Silent or Automated installations is welcomed via the MicroStrategy

Community (Platform

# Services > Platform > Secure Enterprise - Linux) or via Technical Support

to the Deployment Team.



#

# Here is a direct link (as of June 2017) to the Community sub-section on


#

https://success.microstrategy.com/s/topic/0TO44000000FlkIGAS/Secure%20Enterpr

ise%20-%20Linux%20-%20U092?tabset-215d6=1

#

#

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# Silent Installation.

#

# The options file is required for silent installations, specify -silent

# -options <file-name> as a command line arguments to the wizard, where

# <file-name> is the name of this options file.

#

# For example:

#

# setup.sh -silent -options options.txt

#

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# System Requirements Warnings

#

# The silent installation will install MicroStrategy even if some system

# requirements are not completely meet.

# Please read the release notes file and configure your system so it meets

the

# requirements before running this setup and check the installation log

after

# the installation is complete.

#



## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# Installation Properties

#

# Please specify general installation properties.

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy License Agreement Default Selection

#

# In the MicroStrategy Installation Wizard, it is legally required to accept

the

# MicroStrategy License Agreement in order to proceed with the desired

installation

# operation.

# Use this option to specify the default selected option selected for the

License

# Agreement Dialog. Legal values are:

#

# true - Accept the License Agreement

# false - Do not accept the License Agreement

#

# If no option is provided, 'reject' is used as default.

### licenseAgreement.accept=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#


#

# Please specify your name, the name of the company for which you work and

the

# license key.



# User

### userRegistration.user=<value>

# Company

### userRegistration.company=<value>

# License Key

### userRegistration.cdKey=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Installation Selection

#

# For a new Installation, use "new" (i.e. install.Instance=new)

#

# For an existing Installation, specify its home path.

# Home path is a directory that identifies an installation and stores

# configuration files and application launchers (suite.homeDirectory in

# MicroStrategy Install Locations section). You may refer to <home> tag under

# <suite>MstrSuite</suite> in mstrinstall.xml.

#

# For example

#

# install.Instance=/home/user/MicroStrategy

#

### install.Instance=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Operation to perform on instance

#

# For a new Installation, Legal values are:

# FRESH_INSTALL - Indicates a new installation will be performed

#

# For an existing Installation, Legal values are:



# MODIFY - Indicates the installation will be modified.

# REPAIR - Indicates the installation will be repaired.

# UNINSTALL - Indicates the installation will be uninstalled.

# UPGRADE - Indicates the installation will be upgraded

# HOTFIX_UNINSTALL - Indicates a hotfix package will be removed

#

# For example

#

# install.Operation=MODIFY

#

### install.Operation=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Install Locations

#

# The install locations of the product. Specify a valid directories into

which

# the product should be installed.

# It is recommended to specify a different directory for each one of the

install

# locations:

#

# Home - This directory will store configuration files and application

launchers

# Install - This directory will store all the binaries and other static

files

# Log - Application logs will be created here.

#

# NOTE: Special characters (!,%,$,^,\,?,#) and space characters are not

valid. All

# special characters will be ignored.

### suite.homeDirectory=<value>

### suite.installDirectory=<value>



### suite.logDirectory=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Product Selection State

#

# A selection state setting is available for every MicroStrategy product.

# Legal values are:

#

# true - Indicates that the product is selected for installation

# false - Indicates that the product is not selected for installation

#


#

# For example, to select "MicroStrategy Intelligence Universal Edition"

# for installation use

#

# Intelligence.active=true

#

# All licensed products are selected by default, so in case you want to

prevent

# them from being installed make sure they are unselected too.

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Intelligence Universal Edition

#

# MicroStrategy Intelligence Universal Edition will be automatically

# selected for installation if any of the following products are selected

for

# installation:

# "MicroStrategy Report Services Universal",

# "MicroStrategy OLAP Services Universal"

# "MicroStrategy Distribution Services"

# "MicroStrategy Transaction Services"




### Intelligence.active=<value>

# MicroStrategy Report Services Universal

### ReportServices.active=<value>

# MicroStrategy OLAP Services Universal

### OLAPServices.active=<value>

# MicroStrategy Distribution Services

### DistributionServices.active=<value>

# MicroStrategy Transaction Services

### TransactionServices.active=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

# MicroStrategy Web Universal

#

# MicroStrategy Web Universal Reporter will be automatically selected for

# installation if MicroStrategy Web Universal Analyst is selected.

#

# MicroStrategy Web Universal Reporter & Analyst will be automatically

selected

# for installation if MicroStrategy Web Universal Professional is selected.

# MicroStrategy Web Universal Reporter

### WebReporter.active=<value>

# MicroStrategy Web Universal Analyst

### WebAnalyst.active=<value>

# MicroStrategy Web Universal Professional

### WebProfessional.active=<value>



# MicroStrategy Portlets

### Portlets.active=<value>

# MicroStrategy GIS Connectors

### GISConnectors.active=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Web Services J2EE

### WebServices.active=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Mobile Server JSP

### MobileServer.active=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Community Connectors

#

### CommunityConnectors.active=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Command Manager

### CommandManager.active=<value>



## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy System Manager

### SystemManager.active=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Platform Analytics

### PlatformAnalytics.active=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Enterprise Manager

### EnterpriseManager.active=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Integrity Manager

### IntegrityManager.active=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

# MicroStrategy Identity

#

# MicroStrategy Identity Server



### IdentityServer.active=<value>

# MicroStrategy Identity Manager

### IdentityManager.active=<value>

# MicroStrategy Identity Mobile

### IdentityMobile.active=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Telemetry Server

### TelemetryServer.active=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# New in 10.9

# MicroStrategy Library Web & Mobile

### LibraryWebMobile.active=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# New in 10.9

# MicroStrategy Collaboration

### Collaboration.active=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# New in 11.0



# MicroStrategy Certificate Store

### CertificateStore.active=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#


# Use the following values to specify the install location for individual

products.

#

# Warning: Special (!,%,$,^,\,?,#) and space characters are not valid. All

special

# characters will be ignored.

# Web Universal

### WebUniversal.deployDirectory=<value>


### Portlets.installDirectory=<value>


### GISConnectors.installDirectory=<value>

# MicroStrategy Community Data Connectors

### CommunityConnectors.installDirectory=<value>


### WebServices.installDirectory=<value>


### MobileServer.installDirectory=<value>


### CommandManager.installDirectory=<value>

# MicroStrategy System Manager Install Location

### SystemManager.installDirectory=<value>



# MicroStrategy Platform Analytics Install Location

### PlatformAnalytics.installDirectory=<value>


### IdentityServer.installDirectory=<value>


### IdentityManager.installDirectory=<value>


### IdentityMobile.installDirectory=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# CPU License Information

#

# This value should be specified when the license being used for

MicroStrategy

# Intelligence Universal Edition is based on CPUs. Legal values are integers

# between 1 and either the number of CPUs allowed by the license or the

number of

# CPUs in the machine, whichever is lower.

#

# For example to set the number of CPUs to 2, use:

#

# cpuCount.number=2

#

# To set this options to the maximum value allowed, use:

#

# cpuCount.number=maximum

#

# The default value for this setting is "maximum"

### cpuCount.number=<value>



## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Platform Analytics Configuration

#

# Provide the connection parameters for the MySQL database where you

previously

# created the Platform Analytics database. If you have not created this

# database, review the Platform Analytics prerequisites in the online help.

### PlatformAnalytics.DBHost=<value>

### PlatformAnalytics.DBPort=<value>

### PlatformAnalytics.DBUser=<value>

### PlatformAnalytics.DBPassword=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Telemetry Server Configuration

#

# This step allows you to cluster the Telemetry Servers that will be used to

send usage data to

# Platform Analytics.

#

# If you plan to install three or more Telemetry Servers in your environment,

you must check the

# box below during the installation of each Telemetry Server. Failing to do

so will result in

# manual configuration to create the cluster after the installation.

#

# For more information refer to the online help.

#

# Please note that Telemetry Server is installed by default when you install

and Intelligence

# or Platform Analytics.

# Create a cluster of three or more Telemetry Servers

# true - Creates a Telemetry Server cluster



# false - Configures Telemetry Server as a single node.

# The default value is false.

### TelemetryServer.cluster.enable=<value>

# Provide the Fully Qualified Domain Name of the local Telemetry Server (do

not use "localhost"

# or the loopback IP address "127.0.0.1")

### TelemetryServer.cluster.localnode=<value>

# Provide the Fully Qualified Domain Name of all the remote Telemetry Servers

that you have

# installed or will install. Separate the Fully Qualified Name using

semicolons.

# For example: node.mydomain.com; othernode.mydomain.com

### TelemetryServer.cluster.remotenodes=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Identity Server Information

#

# Please specify the information required for the MicroStrategy Identity

Server

# configuration.

# Tomcat directory location for MicroStrategy Identity Server

### IdentityServer.tomcatDir=<value>

# MicroStrategy Identity Server installs a database which is a system of

record for

# individual Usher identities. Please provide the configuration parameters

for

# the MicroStrategy Identity Server to communicate with the database with

MySQL

# Community Edition 5.0 or higher.

### IdentityServer.serverDBHost=<value>

### IdentityServer.serverDBPort=<value>

### IdentityServer.serverDBUser=<value>



### IdentityServer.serverDBPassword=<value>

### IdentityServer.serverDBInstance=<value>

### IdentityServer.serverLogDBInstance=<value>

# For new installations use this option to indicate if any existing schema

should be

# dropped or preserved.

# true - Drop the schema and create a fresh configuration.

# false - Preserve the schema and upgrade it if necessary.


### IdentityServer.overwriteDb=<value>

# Please specify the information required for setting up a trust-relationship

for

# MicroStrategy Identity Server using the Public-key Infrastructure (PKI).

# Server (one-way SSL) authentication only - Port

### IdentityServer.serverPortOne=<value>

# Client and Server (two-way SSL) mutual authentication - Port

### IdentityServer.serverPortTwo=<value>

# Public key SSL certificate file (.crt)

### IdentityServer.serverSslCert=<value>

# Private key file (.key)

### IdentityServer.serverSslKey=<value>

# Certification Authority's (CA) certificate file (.pem)

### IdentityServer.serverCaCert=<value>

# Please specify the information required for setting up a trust-relationship

for

# Agent Gateway using the Public-key Infrastructure (PKI).

# Agent Gateway (one-way SSL) authentication only - Port

### IdentityServer.gatewayPort=<value>

# Use this option to specify if you want to use the same SSL certificate as

MicroStrategy

# Identity Server.



# true - Use the same SSL certificates

# false - Do not use the same SSL certificates

### IdentityServer.gatewayUseSameCert=<value>

# Public key SSL certificate file (.crt)

### IdentityServer.gatewaySslCert=<value>

# Private key file (.key)

### IdentityServer.gatewaySslKey=<value>

# Certification Authority's (CA) certificate file (.pem)

### IdentityServer.gatewayCaCert=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Identity Manager Information

#

# Please specify the information required for the MicroStrategy Identity

Manager

# configuration.

# Apache directory location and user credentials for MicroStrategy Identity

Manager

### IdentityManager.apacheDir=<value>

### IdentityManager.apacheUser=<value>

### IdentityManager.apacheGroup=<value>

# MicroStrategy Identity Manager installs a database to manage Usher

identities. Please

# provide the configuration parameters for the MicroStrategy Identity Manager

to

# communicate with the database.

#

# Use this option to specify if you want to use the same connection

information

# as MicroStrategy Identity Server.



# true - Use the same connection

# false - Do not use the same connection

### IdentityManager.useSameDBSetting=<value>

#

### IdentityManager.DBHost=<value>

### IdentityManager.DBPort=<value>

### IdentityManager.DBUser=<value>

### IdentityManager.DBPassword=<value>

# Please provide a Database instance name for MicroStrategy Identity Manager.

### IdentityManager.DBInstance=<value>

# For new installations use this option to indicate if any existing database

instance

# should be dropped or preserved.

# true - Drop the schema and create a fresh configuration.

# false - Preserve the schema and upgrade it if necessary.


### IdentityManager.overwriteDb=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# Topology Configuration

#

# The Workstation Topology helps administrators to monitor and manage

services

# in a MicroStrategy environment.

# Indicate cluster environment.

# SINGLE - Choose this option if this is the only machine where the

MicroStrategy

# services including Intelligence, Web Universal, Library,

Mobile, Telemetry

# Server, Platform Analytics, Certificate Store, Identity, and

MySQL will be

# installed for this environment. No other machines will have

any of these



# services installed.

# MULTIPLE - Choose this option if the MicroStrategy services listed

above will

# be installed on multiple machines in this environment.

#

# The default value for this setting is "SINGLE"

### ServicesRegistration.machine.environment=<value>

# Enter the fully qualified domain name for one Intelligence machine below.

# To setup a fault tolerant configuration during this installation or later,

# review the online help.

#

https://www2.microstrategy.com/producthelp/current/InstallConfig/WebHelp/Lan

g_1033/Content/topology_install.htm

#

# Note: This machine must be able to communicate with other machines in this

# environment on ports 8300 & 8301.

#

# Important: During the installation of a multiple machine environment, the

value

# above needs to be entered exactly the same for each machine in the

environment.

### ServicesRegistration.serverHosts=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

# Registering as a service

#

# Register MicroStrategy processes as a service so that processes

automatically

# start up after system startup.

# Legal values are:

# true

# false

# Note: Only root users may register processes as a service.

### RegisterServices=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##



##

#

# Hide Select Components dialog box

#

# Use this option to completely hide the product selection dialog during the

# execution of the MicroStrategy Installation Wizard. This option can be used

# in combination with individual product visibility/state options to have

better

# control on the products to be installed/removed. If the dialog is not

visible,

# and no specific visibility/state options have been specified, default

values

# will be used.

# Legal values for this option are:

#

# true - Indicates that the Select Components dialog box will be visible

# false - Indicates that the Select Components dialog box will be hidden

#

# The default value for this setting is "true".

# SelectComponents.visible=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# MicroStrategy Product Visibility

#

# In the MicroStrategy Installation Wizard, the Select Components dialog box

# contains check boxes to select or clear for products to be installed. You

# can specify whether you want the following products to be visible to the

user.

# Legal values are:

#

# true - Indicates that the product is selected for installation

# false - Indicates that the product is not selected for installation

#


#

# If a product is not visible, it will not be installed,



# independently of the value specified for its selection state (see the

# Product Selection State section).

#


### Intelligence.visible=<value>

# MicroStrategy Report Services Universal

### ReportServices.visible=<value>

# MicroStrategy OLAP Services Universal

### OLAPServices.visible=<value>

# MicroStrategy Distribution Services

### DistributionServices.visible=<value>

# MicroStrategy Transaction Services

### TransactionServices.visible=<value>

# MicroStrategy Web Universal Reporter

### WebReporter.visible=<value>

# MicroStrategy Web Universal Analyst

### WebAnalyst.visible=<value>

# MicroStrategy Web Universal Professional

### WebProfessional.visible=<value>


### Portlets.visible=<value>


### GISConnectors.visible=<value>


### WebServices.visible=<value>


### MobileServer.visible=<value>



# MicroStrategy Community Data Connectors

### CommunityConnectors.visible=<value>


### CommandManager.visible=<value>

# MicroStrategy Integrity Manager

### IntegrityManager.visible=<value>

# MicroStrategy System Manager

### SystemManager.visible=<value>

# MicroStrategy Platform Analytics

#### PlatformAnalytics.visible=<value>

# MicroStrategy Enterprise Manager

### EnterpriseManager.visible=<value>


### IdentityServer.visible=<value>


### IdentityManager.visible=<value>


### IdentityMobile.visible=<value>

# MicroStrategy Telemetry Server

### TelemetryServer.visible=<value>

# New in 10.9

# MicroStrategy Library Web & Mobile

### LibraryWebMobile.visible=<value>

# New in 10.9

# MicroStrategy Collaboration

### Collaboration.visible=<value>



# New in 11.0

# MicroStrategy Certificate Store

### CertificateStore.visible=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

#

# Install On Demand Options

#

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

##

# The kind of remote location. The valid values are "FileSystem", "HTTP" or

"HTTPS"

### InstallOnDemand.style=<value>

# The path to the remote location. Set this value if InstallOnDemand.style is

set to "FileSystem"

### InstallOnDemand.sourceLocation=<value>

# The URL for HTTP or HTTPS styles. Set this value if InstallOnDemand.style

is set to HTTP or HTTPS

### InstallOnDemand.url=<value>

# Use this setting to skip the certificate checking when using HTTPS. Valid

values are "true" or "false"

### InstallOnDemand.bypassCertificateChecking=<value>

# The user name for HTTP or HTTPS styles. Set this value if

InstallOnDemand.style is set to HTTP or HTTPS

# and the connection requires user name and password

### InstallOnDemand.user=<value>

# The password for HTTP or HTTPS styles. Set this value if

InstallOnDemand.style is set to HTTP or HTTPS

# and the connection requires user name and password

### InstallOnDemand.password=<value>



Parameters for a Silent InstallationThe fol lowing parameters define how a si lent instal lation is performed.

The settings fol low their descriptions, in the format:

settingname=<Value>

License Agreement

Define whether the l icense agreement is accepted by defaul t:

licenseAgreement.accept=<Value>

You can define this parameter wi th one of the fol lowing values:

l true : The MicroStrategy l icense agreement is accepted by defaul t. If youperform the instal lation as a si lent instal lation that does not display theMicroStrategy Instal lation Wizard, you must use this value to instal lMicroStrategy successful ly.

l false : The MicroStrategy l icense agreement is not accepted by defaul t.The user that instal ls MicroStrategy must select to accept the l icenseagreement to continue with the MicroStrategy instal lation.

Customer Information

Your name, the name of the company for which you work, and the l icensekey:

l User:

userRegistration.user=<Value>

l Company:

userRegistration.company=<Value>



l License key:

userRegistration.cdKey=<Value>

MicroStrategy Installation Instance

You can ei ther instal l a new instance of MicroStrategy, or modi fy anexisting MicroStrategy instal lation:

l To instal l a new instance of MicroStrategy:

install.Instance=new

l To modi fy an existing MicroStrategy instal lation:

install.Instance=InstallPath

MicroStrategy Operations

In addi tion to instal l ing MicroStrategy, you can also modi fy, repair,uninstal l , and upgrade existing MicroStrategy instal lations:

l To instal l a new instance of MicroStrategy:

install.Operation=FRESH_INSTALL

l To modi fy an existing MicroStrategy instal lation:

install.Operation=MODIFY

l To repair an existing MicroStrategy instal lation by performing theprevious instal lation attempt:

install.Operation=REPAIR

l To uninstal l an existing MicroStrategy instal lation:

install.Operation=UNINSTALL



l To upgrade an existing MicroStrategy instal lation:

install.Operation=UPGRADE

l To instal l a MicroStrategy Update instal lation:

install.Operation=HOTFIX_INSTALL

l To uninstal l an existing MicroStrategy Update instal lation:

install.Operation=HOTFIX_UNINSTALL

MicroStrategy Install Locations

The instal l locations of the product. Speci fy val id directories where theproduct should be instal led. For addi tional requirements when choosingdirectories, see Instal l ing with the MicroStrategy Instal lation Wizard forLinux, page 185.

l Home directory: The location where the MicroStrategy configuration fi lesand appl ication launchers are to be instal led.

suite.homeDirectory=<Path>

l Instal l di rectory: The location where the MicroStrategy products are to beinstal led.

suite.installDirectory=<Path>

l Log directory: The location where the MicroStrategy appl ication logs areto be created.

silent.logDirectory=<Path>

Product Features

When you instal l products using an options fi le, the fol lowing two valuesmay be speci fied for each product:



l A visible option, which can use one of the fol lowing values:

l true : Indicates that the feature is displayed in the MicroStrategyInstal lation Wizard as avai lable for instal lation.

l false : Indicates that the feature is not displayed in the MicroStrategyInstal lation Wizard as avai lable for instal lation. If you define a product'svisible option as false, i t cannot be instal led.

If no value is specified, the default is true for all products. You can alsodefine the vis ible option for all products using the parameterSelectComponents.visible . You can exclude these vis ible optionsfor each product if you are using the options file as part of a completely silentinstallation where no user interface is displayed to the user.

l An active option, which can use one of the fol lowing values:

l true : Indicates that the feature is selected for instal lation.

l false : Indicates that the feature is not selected for instal lation, or theproduct is to be uninstal led as part of an instal lation that modi fies oruninstal ls previously instal led MicroStrategy software.

To review a description of each MicroStrategy project, see Hover over theicons below to see the information related to instal l ing each part of theIntel l igence Platform archi tecture. , page 11.

MicroStrategy Intelligence

l The state of whether MicroStrategy Intel l igence is displayed in theMicroStrategy Instal lation Wizard:

Intelligence.visible=<Value>

l The selection state of MicroStrategy Intel l igence.

Intelligence.active=<Value>



To select MicroStrategy Intelligence Server for installation, use:

l Intelligence.visible=true

l Intelligence.active=true

MicroStrategy Intel l igence Server is instal led i f you choose to instal l any ofthe fol lowing MicroStrategy products:

l MicroStrategy Report Services, page 649

l MicroStrategy OLAP Services, page 649

l MicroStrategy Distribution Services, page 650

l MicroStrategy Transaction Services, page 650

MicroStrategy Report Services

l The state of whether MicroStrategy Report Services is displayed in theMicroStrategy Instal lation Wizard:

ReportServices.visible=<Value>

l The selection state of MicroStrategy Report Services.

ReportServices.active=<Value>

l For example, to select MicroStrategy Report Services for instal lation, use:

ReportServices.visible=true

ReportServices.active=true

MicroStrategy OLAP Services

l The state of whether MicroStrategy OLAP Services is displayed in theMicroStrategy Instal lation Wizard:



OLAPServices.visible=<Value>

l The selection state of MicroStrategy OLAP Services.

OLAPServices.active=<Value>

l For example, to select MicroStrategy OLAP Services for instal lation, use:

OLAPServices.visible=true

OLAPServices.active=true

MicroStrategy Distribution Services

l The state of whether MicroStrategy Distribution Services is displayed inthe MicroStrategy Instal lation Wizard:

DistributionServices.visible=<Value>

l The selection state of MicroStrategy Distribution Services.

DistributionServices.active=<Value>

l For example, to select MicroStrategy Distribution Services for instal lation,use:

DistributionServices.visible=true

DistributionServices.active=true

MicroStrategy Transaction Services

l The state of whether MicroStrategy Transaction Services is displayed inthe MicroStrategy Instal lation Wizard:

TransactionServices.visible=<Value>

l The selection state of MicroStrategy Transaction Services.



TransactionServices.active=<Value>

l For example, to select MicroStrategy Transaction Services forinstal lation, use:

TransactionServices.visible=true

TransactionServices.active=true

MicroStrategy Web Reporter

l The state of whether MicroStrategy Web Reporter is displayed in theMicroStrategy Instal lation Wizard:

WebReporter.visible=<Value>

l The selection state of MicroStrategy Web Reporter.

WebReporter.active=<Value>

l For example, to select MicroStrategy Web Reporter for instal lation, use:

WebReporter.visible=true

WebReporter.active=true

MicroStrategy Web Analyst

l The state of whether MicroStrategy Web Analyst is displayed in theMicroStrategy Instal lation Wizard:

WebAnalyst.visible=<Value>

l The selection state of MicroStrategy Web Analyst.

WebAnalyst.active=<Value>



l For example, to select MicroStrategy Web Analyst for instal lation, use:

WebAnalyst.visible=true

WebAnalyst.active=true

MicroStrategy Web Professional

l The state of whether MicroStrategy Web Professional is displayed in theMicroStrategy Instal lation Wizard:

WebProfessional.visible=<Value>

l The selection state of MicroStrategy Web Professional .

WebProfessional.active=<Value>

l For example, to select MicroStrategy Web Professional for instal lation,use:

WebProfessional.visible=true

WebProfessional.active=true

MicroStrategy Portlets

l The state of whether MicroStrategy Portlets is displayed in theMicroStrategy Instal lation Wizard:

Portlets.visible=<Value>

l The selection state of MicroStrategy Portlets.

Portlets.active=<Value>

l For example, to select MicroStrategy Portlets for instal lation, use:

Portlets.visible=true



Portlets.active=true

MicroStrategy GIS Connectors

l The state of whether MicroStrategy GIS Connectors is displayed in theMicroStrategy Instal lation Wizard:

GISConnectors.visible=<Value>

l The selection state of MicroStrategy GIS Connectors.

GISConnectors.active=<Value>

l For example, to select MicroStrategy GIS Connectors for instal lation, use:

GISConnectors.visible=true

GISConnectors.active=true

MicroStrategy Web Services J2EE

l The state of whether MicroStrategy Web Services J2EE is displayed inthe MicroStrategy Instal lation Wizard:

WebServices.visible=<Value>

l The selection state of MicroStrategy Web Services J2EE.

WebServices.active=<Value>

l For example, to select MicroStrategy Web Services J2EE for instal lation,use:

WebServices.visible=true

WebServices.active=true



MicroStrategy Mobile Server JSP

l The state of whether MicroStrategy Mobi le Server JSP is displayed in theMicroStrategy Instal lation Wizard:

MobileServer.visible=<Value>

l The selection state of Mobi le Server JSP.

MobileServer.active=<Value>

l For example, to select MicroStrategy Mobi le Server JSP for instal lation,use:

MobileServer.visible=true

MobileServer.active=true

MicroStrategy Community Connectors

l The state of whether MicroStrategy Community Connectors is displayed inthe MicroStrategy Instal lation Wizard:

CommunityConnectors.active=<Value>

l For example, to select MicroStrategy Community Connectors forinstal lation, use:

CommunityConnectors.visible=true

CommunityConnectors.active=true

MicroStrategy Command Manager

l The state of whether MicroStrategy Command Manager is displayed in theMicroStrategy Instal lation Wizard:



CommandManager.visible=<Value>

l The selection state of MicroStrategy Command Manager.

CommandManager.active=<Value>

l For example, to select MicroStrategy Command Manager for instal lation,use:

CommandManager.visible=true

CommandManager.active=true

MicroStrategy System Manager

l The state of whether MicroStrategy System Manager is displayed in theMicroStrategy Instal lation Wizard:

SystemManager.visible=<Value>

l The selection state of MicroStrategy System Manager.

SystemManager.active=<Value>

l For example, to select MicroStrategy System Manager for instal lation,use:

SystemManager.visible=true

SystemManager.active=true

MicroStrategy Platform Analytics

l The state of whether MicroStrategy System Manager is displayed in theMicroStrategy Instal lation Wizard:

PlatformAnalytics.visible=<Value>



l The selection state of MicroStrategy System Manager.

PlatformAnalytics.active=<Value>

l For example, to select MicroStrategy System Manager for instal lation,use:

PlatformAnalytics.visible=true

PlatformAnalytics.active=true

MicroStrategy Enterprise Manager

l The state of whether MicroStrategy Enterprise Manager is displayed inthe MicroStrategy Instal lation Wizard:

EnterpriseManager.visible=<Value>

l The selection state of MicroStrategy Enterprise Manager.

EnterpriseManager.active=<Value>

l For example, to select MicroStrategy Enterprise Manager for instal lation,use:

EnterpriseManager.visible=true

EnterpriseManager.active=true

MicroStrategy Integrity Manager

l The state of whether MicroStrategy Integri ty Manager is displayed in theMicroStrategy Instal lation Wizard:

IntegrityManager.visible=<Value>



l The selection state of MicroStrategy Integri ty Manager.

IntegrityManager.active=<Value>

l For example, to select MicroStrategy Integri ty Manager for instal lation,use:

IntegrityManager.visible=true

IntegrityManager.active=true

MicroStrategy Identity Server

l The state of whether MicroStrategy Identi ty Server is displayed in theMicroStrategy Instal lation Wizard:

IdentityServer.visible=<Value>

l The selection state of MicroStrategy Identi ty Server.

IdentityServer.active=<Value>

l For example, to select MicroStrategy Identi ty Server for instal lation, use:

IdentityServer.visible=true

IdentityServer.active=true

MicroStrategy Identity Manager

l The state of whether MicroStrategy Identi ty Manager is displayed in theMicroStrategy Instal lation Wizard:

IdentityManager.visible=<Value>

l The selection state of MicroStrategy Identi ty Manager.

IdentityManager.active=<Value>



l For example, to select MicroStrategy Identi ty Manager for instal lation,use:

IdentityManager.visible=true

IdentityManager.active=true

MicroStrategy Communicator

l The state of whether MicroStrategy Communicator is displayed in theMicroStrategy Instal lation Wizard:

IdentityMobile.visible=<Value>

l The selection state of MicroStrategy Communicator.

IdentityMobile.active=<Value>

l For example, to select MicroStrategy Communicator for instal lation, use:

IdentityMobile.visible=true

IdentityMobile.active=true

MicroStrategy Telemetry Server

l The state of whether MicroStrategy Telemetry Server is displayed in theMicroStrategy Instal lation Wizard:

TelemetryServer.visible=<Value>

l The selection state of MicroStrategy Telemetry Server.

TelemetryServer.active=<Value>

l For example, to select MicroStrategy Telemetry Server for instal lation,use:



TelemetryServer.visible=true

TelemetryServer.active=true

MicroStrategy Library (Web and Mobile)

l The state of whether MicroStrategy Library is displayed in theMicroStrategy Instal lation Wizard:

LibraryWebMobile.visible=<Value>

l The selection state of MicroStrategy Library.

LibraryWebMobile.active=<Value>

l For example, to select MicroStrategy Library for instal lation, use:

LibraryWebMobile.visible=true

LibraryWebMobile.active=true

MicroStrategy Collaboration

l The state of whether MicroStrategy Col laboration is displayed in theMicroStrategy Instal lation Wizard:

Collaboration.visible=<Value>

l The selection state of MicroStrategy Col laboration.

Collaboration.active=<Value>

l For example, to select MicroStrategy Col laboration for instal lation, use:

Collaboration.visible=true

Collaboration.active=true



MicroStrategy Certificate Store

l The selection state of MicroStrategy Certi ficate Store.

CertificateStore.active=<Value>

l For example, to select MicroStrategy Certi ficate Store for instal lation,use:

CertificateStore.visible=true

CertificateStore.active=true

MicroStrategy Product and Component Installation Locations

You can define the instal lation locations for the fol lowing products andcomponents:

l MicroStrategy Web Universal Instal l Location:

WebUniversal.deployDirectory=<Value>

l MicroStrategy Portlets Instal l Location:

Portlets.installDirectory=<Value>

l MicroStrategy GIS Connectors Instal l Location:

GISConnectors.installDirectory=<Value>

l MicroStrategy Community Data Connectors

CommunityConnectors.installDirectory=<Value>

l MicroStrategy Web Services J2EE Instal l Location:

WebServices.installDirectory=<Value>



l MicroStrategy Mobi le Server JSP Instal l Location:

MobileServer.installDirectory=<Value>

l MicroStrategy Command Manager Instal l Location:

CommandManager.installDirectory=<Value>

l MicroStrategy System Manager Instal l Location:

SystemManager.installDirectory=<Value>

l Platform Analytics Instal l Location:

PlatformAnalytics.installDirectory=<Value>

l MicroStrategy Identi ty Server Instal l Location:

IdentityServer.installDirectory=<Value>

l MicroStrategy Identi ty Manager Instal l Location:

IdentityManager.installDirectory=<Value>

l MicroStrategy Communicator Instal l Location:

IdentityMobile.installDirectory=<Value>

CPU License Information

This value should be speci fied when the l icense being used forMicroStrategy Intel l igence Server is based on CPUs. Legal values areintegers between 1 and ei ther the number of CPUs al lowed by the l icenseor the number of CPUs in the machine, whichever is lower.

cpuCount.number=<Value>

By defaul t, the maximum number of CPUs is al lowed. This is representedwith the fol lowing value for this parameter:



cpuCount.number=maximum

MicroStrategy Platform Analytics Configuration

Enter your connection parameters for the MySQL database where thePlatform Analytics database was created. You must have a MySQLwarehouse to use Platform Analytics. For more information on prerequisi tesfor using Platform Analytics, see Prerequisi tes.

Enter the fol lowing information:

l Database hostname:

PlatformAnalytics.DBHost=<Value>

l Database port:

PlatformAnalytics.DBPort=<Value>

l Database username:

PlatformAnalytics.DBUser=<Value>

l Database user password:

PlatformAnalytics.DBPassword=<Value>

MicroStrategy Telemetry Server Configuration

This increases the rel iabi l i ty, scalabi l i ty and performance of PlatformAnalytics. To cluster the Telemetry Server, set the propertyTelemetryServer.cluster.enable to True and provide thehostname of at least 3 Telemetry Server nodes. One in theTelemetryServer.cluster.localnode property and the rest in acomma separated l ist in TelemetryServer.cluster.remotenodes .

TelemetryServer.cluster.enable=<Value>


http://www2.microstrategy.com/producthelp/2019/PlatformAnalytics/en-us/Content/platform_analytics_prerequisites.htm


TelemetryServer.cluster.localnode=<Value>

TelemetryServer.cluster.remotenodes=<Value>, Value

MicroStrategy Identity Server Configuration: Tomcat Database

MicroStrategy Identi ty Server instal ls a database that is a system of recordfor individual identi ties. You can configure MicroStrategy Identi ty Server tocommunicate with the database, as part of the si lent instal lation:

l The location of the Tomcat directory used by MicroStrategy Identi tyServer:

IdentityServer.tomcatDir=<Path>

Provide a val id folder path that contains the correct version of Tomcat.You must be able to wri te to the webapps subfolder.

l The IP address for the machine that hosts the database:

IdentityServer.serverDBHost=IP_Address

l The port number for the database connection:

IdentityServer.serverDBPort=Port

l The account name for the database user that administers the database:

IdentityServer.serverDBUser=UserName

l The password for the database user speci fied above:

IdentityServer.serverDBPassword=UserPassword

l The name of the MicroStrategy Identi ty Server database:

IdentityServer.serverDBInstance=DatabaseInstance



l The name of the database that stores log information for theMicroStrategy Identi ty Server:

IdentityServer.serverLogDBInstance=DatabaseInstance

MicroStrategy Identity Server Configuration: Ports and Certificates

Set up a trust relationship for MicroStrategy Identi ty Server using the Publ icKey Infrastructure (PKI), as part of the si lent instal lation:

l The port used by MicroStrategy Identi ty Server for server (one-way SSL)authentication:

IdentityServer.serverPortOne=Port

l The port used by MicroStrategy Identi ty Server for cl ient and server (two-way SSL) mutual authentication:

IdentityServer.serverPortTwo=Port

l The location of the publ ic key SSL certi ficate fi le:

IdentityServer.serverSslCert=<Path>

l The location of the private key fi le:

IdentityServer.serverSslKey=<Path>

l The location of the SSL certi ficate chain:

IdentityServer.serverCaCert=<Path>

MicroStrategy Identity Server Configuration: Gateways

Set up a trust relationship for the Agent Gateway using the Publ ic KeyInfrastructure (PKI), as part of the si lent instal lation:



l The port used by MicroStrategy Identi ty Server for the Agent Gateway(one-way SSL) authentication:

IdentityServer.gatewayPort=Port

l The location of the publ ic key SSL certi ficate fi le:

IdentityServer.gatewaySslCert=<Path>

l The location of the private key fi le:

IdentityServer.gatewaySslKey=<Path>

l The location of the SSL certi ficate chain:

IdentityServer.gatewayCaCert=<Path>

MicroStrategy Identity Manager Configuration

You can configure MicroStrategy Identi ty Manager as part of the si lentinstal lation:

l The location of the Apache directory used by MicroStrategy Identi tyManager:

IdentityManager.apacheDir=<Path>

Provide a val id folder path that contains the conf and conf.d folders.

You must be able to wri te to the conf.d subfolder.

l The Apache user name:

IdentityManager.apacheUser=UserName

l The Apache group name:

IdentityManager.apacheGroup=GroupName



l Speci fy whether to use the same database connection as MicroStrategyIdenti ty Server:

IdentityManager.useSameDBSetting=false

By defaul t, the same database connection is not used (set to false ). Iffalse is speci fied, you must define the database connection using thesettings l isted below.

l The IP address for the machine that hosts the database:

IdentityManager.DBHost=IP_Address

l The port number for the database connection:

IdentityManager.DBPort=Port

l The account name for the database user that administers the database:

IdentityManager.DBUser=UserName

l The password for the database user speci fied above:

IdentityManager.DBPassword=UserPassword

l The name of the MicroStrategy Identi ty Manager database:

IdentityManager.DBInstance=DatabaseInstance

l Speci fy whether any existing database instance should be dropped orpreserved for new instal lations. This is set to false by defaul t andpreserves the schema and upgrades i t i f necessary. If this is set to true ,drop the schema and create a fresh configuration.

IdentityManager.overwriteDb=<Value>



MicroStrategy Platform Analytics

Connection Parameters to configure the database instal led to store systemtelemetry:

l PlatformAnalytics.DBHost=<Value>

l PlatformAnalytics.DBPort=<Value>

l PlatformAnalytics.DBUser=<Value>

l PlatformAnalytics.DBPassword=<Value>


Workstation Topology helps administrators moni tor and manage services ina MicroStrategy environment.

l Indicate a cluster environment. Define this parameter as SINGLE orMULTIPLE to indicate a single or mul tiple machine environment. Thedefaul t value for this setting is SINGLE .

ServicesRegistration.machine.environment=<Value>

l Provide al l Services Registration server host names, separated bysemicolon

ServicesRegistration.serverHosts=<Value>;<Value>

l Load balancer addresses:

Example: http://localhost/MicroStrategyMobile

WebServer.loadBalancer=<Value>

MobileServer.loadBalancer=<Value>

LibraryWebMobile.loadBalancer=<Value>



CollaborationServer.loadBalancer=<Value>

IdentityServer.loadBalancer=<Value>

IdentityManager.loadBalancer=<Value>

Registering MicroStrategy Processes as a Service

This setting registers MicroStrategy processes as a service to enableautomatic start after system startup.

Only root users may register processes as a service

RegisterServices=<Value>

Hide Select Components Dialog Box

Use this option to completely hide the product selection dialog during theexecution of the MicroStrategy Instal lation Wizard. This option can be usedin combination with individual product visibi l i ty/state options to have bettercontrol on the products to be instal led/removed. If the dialog is not visible,and no speci fic visibi l i ty/state options have been speci fied, defaul t valueswi l l be used.

SelectComponents.visible=<Value>

Install on Demand Options

You can reduce the amount of data that has to be downloaded for theinstal lation by excluding some of the .tzp fi les, located in the DataFiles

folder, from the download. You can use this technique to download only thefi les required to complete your MicroStrategy instal lation, which can thenalso be used to reduce the amount of data packaged and downloaded forother MicroStrategy instal lations.



If you are performing a MicroStrategy installation, you must include all of thefiles provided as part of the Update installation in their default location. Thismeans that you cannot use the options below to point to the location of theUpdate installation files.

To reduce the amount of data required for MicroStrategy instal lations, youfi rst need to determine the fi les required to support your instal lation ofMicroStrategy, as described in Creating Custom Instal lation Packages,page 131. Once you determine and col lect the .tzp fi les required to supportyour MicroStrategy instal lation, you can speci fy the location of these fi lesusing the fol lowing parameters:

l InstallOnDemand.style=<Value>

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:

l FileSystem: Type this value if the required installation files are stored in a folderon the local machine or a server machine. You must also provide the location of thefiles using the InstallOnDemand.sourceLocation parameter.

l HTTP: Type this value if the required installation files are stored at an unsecuredURL. You must also provide the location of the files using theInstallOnDemand.url parameter.

l 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.urlparameter, as well as the user name and password to access the URL using theInstallOnDemand.username and InstallOnDemand.passwordparameters.

l InstallOnDemand.sourceLocation=<Value>Location of the folder that storesany required installation files. Type the location of the local file path. If you store thefiles in a local folder, do not provide a location for the InstallOnDemand.urlparameter.



l InstallOnDemand.url=<Value>Location of the URL for the HTTP or HTTPSlocation that stores any required installation files. Type the URL for the location thatstores any required installation files. If you store the files at an HTTP or HTTPSlocation, do not provide a location for the InstallOnDemand.sourceLocationparameter.

l InstallOnDemand.bypassCertificateChecking=<Value>If you retrievethe installation files from a URL location using HTTPS, you can use this setting to skipany certificate checking by defining this option to true. To maintain certificatechecking, define this option as false.

l InstallOnDemand.username=<Value>If you retrieve the installation files from aURL location, type a user name that has access to the URL location. If there is nologin required to the URL or you retrieve the installation files from a local folder, youdo not need to define a value for this parameter.

l InstallOnDemand.password=<Value>If you retrieve the installation files from aURL location, type a password for the user name. If there is no login required to theURL or you retrieve the installation files from a local folder, you do not need to define avalue for this parameter.

Unique Post-Installation ConfigurationsMicroStrategy supports many di fferent Linux environments wi th varioussystem configurations. There are a few cases in which you must performsome manual configurations to support the use of MicroStrategy on yoursystem. For more information, see Unique Post-Instal lation Configurations,page 211 in Chapter 3, Instal l ing MicroStrategy on Linux.

Silent Installation OutputThe instal lation returns 0 i f the instal lation is successful , and any othervalue i f i t is not. The install.log fi le in the Instal lPath directoryprovides more information on possible errors. For more information on theinstall.log fi le, see Instal lation Log Fi le, page 558 in Chapter 2,Instal l ing MicroStrategy on Windows.



If the installation fails on any of the steps before it starts copying the files, itdoes not give any feedback other than the return value different from 0 .

Activating a Silent InstallationAfter the si lent instal lation is complete, you must activate the MicroStrategyinstal lation within 30 days. To activate the instal lation you can fol low theinstructions provided in Chapter 5, Activating Your Instal lation.

Configuring MicroStrategy in Command Line Mode

The MicroStrategy Configuration Wizard is provided in command l ine modeso that you can use the Configuration Wizard through the operating systemconsole i f you do not have access to the GUI. Running the ConfigurationWizard in command l ine mode to configure MicroStrategy on Linuxmachines is covered in the Configuring MicroStrategy with a response.inifi le, page 693 section in Chapter 12, Configuring MicroStrategy UsingCommand Line Tools.


After completing the steps to instal l MicroStrategy products, you can set upand configure your instal lation. To help guide the rest of your instal lationand configuration steps, see Instal l ing and Configuring MicroStrategy onLinux, page 137 in Chapter 1, Planning Your Instal lation, for an instal lationand configuration checkl ist.



DEPLOYING OEMAPPLICATIONS



This chapter explains the common workflow for deploying the MicroStrategyplatform as an Original Equipment Manufacturer (OEM) appl ication.

The MicroStrategy platform can be deployed as an OEM appl ication invarious ways:

l MicroStrategy can be deployed as a software as a service model throughthe use of MicroStrategy Web. In this scenario MicroStrategy is instal ledand configured at a central ized location using the standard process, andthe customized appl ication is deployed as an OEM appl ication usingMicroStrategy Web. For information on deploying MicroStrategy Web, seeChapter 7, Deploying MicroStrategy Web and Mobi le Server. Forinformation on customizing MicroStrategy Web, see CustomizingMicroStrategy Web, page 677.

l MicroStrategy can be deployed as part of an OEM software bundledirectly to a customer environment. This chapter focuses on thedevelopment and deployment of this type of OEM appl ication.

The fol lowing is a l ist of best practices on how to deploy MicroStrategy asan OEM appl ication. Addi tional ly, you can use MicroStrategy SystemManager. System Manager al lows you to define multiple configurations foryour 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.

l Instal l MicroStrategy on an OEM environment. For instal lationinformation, see:

l Chapter 2, Instal l ing MicroStrategy on Windows

l Chapter 3, Instal l ing MicroStrategy on Linux

l Create data source connections using the Connectivi ty Wizard, asdescribed in Creating DSNs for OEM Environments, page 674.

l Configure MicroStrategy Intel l igence Server using the ConfigurationWizard. This tool al lows you to save configurations as response fi les that




can be used to automate the configuration for the OEM deployment. Thisal lows you to re-use al l the configurations performed when developing anembedded appl ication for the deployment process as wel l , as describedin Configuring a MicroStrategy Instal lation, page 676.

l Design projects and a reporting environment. You can use the variousMicroStrategy products and relevant documentation to create the requiredMicroStrategy environment. For addi tional best practices when designinga reporting environment, see Designing a Project and ReportingEnvironment, page 676.

l Customize MicroStrategy Web through the use of the MicroStrategy SDK,as described in Customizing MicroStrategy Web, page 677.

l Deploy a MicroStrategy OEM appl ication on an OEM's customerenvironment, as described in Deploying a MicroStrategy OEMAppl ication, page 678.

l Create data source connections on your customer environment asnecessary, as described in Creating DSNs for OEM Environments, page674.

l Configure and tune an embedded deployment through the use of variousMicroStrategy tools, as described in Tuning an OEM Deployment, page684.

l If you are modi fying a project that has already been deployed as an OEMappl ication, see Updating OEM Appl ications, page 686 for best practiceson how to incorporate any custom reports or objects that may have beencreated for the deployed appl ication.

Creating DSNs for OEM Environments

Establ ishing communication between MicroStrategy and your databases orother data sources is an essential fi rst step in configuring MicroStrategyproducts for reporting and analysis of your data. These data sources are



used to store the data warehouse and the MicroStrategy metadata, whichare both required to support a MicroStrategy reporting environment.

To create a connection to these data sources you need an ODBC driver aswel l as a data source name (DSN). MicroStrategy comes packaged withODBC drivers to support connecting to various data sources. For moreinformation on ODBC drivers, see Communicating with Databases, page369.

When setting up your OEM environment, you must create a separate DSN toconnect to the main data source and the metadata reposi tory. Thisrequirement is true even i f the data source and metadata reposi tory arestored in the same database or other data source. The main data sourceand the metadata are described below:

l A data source stores the data that users of the system can analyzethrough BI capabi l i ties offered by MicroStrategy products.

l Metadata is a reposi tory whose data associates the tables and columns ofa data warehouse with user-defined attributes and facts to enable themapping of business views, terms, and needs to the underlying databasestructure. Metadata can reside on the same server as the data warehouseor on a di fferent server. It can be also be stored in a di fferent relationaldatabase than your data warehouse. A metadata can be created using theConfiguration Wizard, as described in Configuring a MicroStrategyInstal lation, page 676.

A DSN can be created using the MicroStrategy Connectivi ty Wizard, asdescribed in Defining DSNs, page 375.

Creating DSNs as Part of an OEM DeploymentAs part of the deployment of an OEM appl ication, the Connectivi ty Wizardcan run unattended to create DSNs on Linux environments. This al lows youto perform this configuration automatical ly using scripts. For information oncreating ODBC DSNs using the command l ine version of the Connectivi tyWizard, see Creating a DSN for a Data Source, page 689.



For OEM deployments on Windows machines, use the Connectivi ty Wizardinterface to create ODBC DSNs, as described in Defining DSNs, page 375.

Configuring a MicroStrategy Installation

After instal l ing MicroStrategy, you can use the MicroStrategy ConfigurationWizard to configure the metadata reposi tory, statistics tables, History Listtables, MicroStrategy Intel l igence Server, and multiple project sources.

The Configuration Wizard interface guides you through each of theseconfigurations, as described in Ini tial MicroStrategy configuration, page382.

In addi tion, al l configurations that are performed using the ConfigurationWizard can be saved as response fi les. These fi les can then be used laterto automate much of the ini tial configuration of MicroStrategy whendeploying i t as an OEM appl ication. This al lows you to re-use al l theconfigurations performed when developing an OEM appl ication. Forinformation on configuring MicroStrategy using a response fi le, seeConfiguring MicroStrategy with a Response Fi le, page 415.

Designing a Project and Reporting Environment

You can use the various MicroStrategy products and relevantdocumentation to create the required MicroStrategy reporting environmentfor your OEM appl ication. The fol lowing best practices can be helpful whencreating this reporting environment:

l It is common to define objects such as reports, documents, attributes,metrics, and fi l ters that are created for the OEM appl ication so that theycannot be modi fied once i t is deployed. You can modi fy the objectsecuri ty of each object so that i t does not al low wri te access. Thisensures that the reports provided out of the box with the OEM appl icationare not modi fied and overwri tten. Users can sti l l use Save As to save



their own personal copies of any objects to make any required changes.

l You can modi fy the folder permissions in MicroStrategy to determinewhere reports and objects can be created. Limi ting the folders that al lowwri te access can require users to create reports in their My Reportsfolder.

l If you are modi fying a project that has already been deployed as an OEMappl ication, see Updating OEM Appl ications, page 686 for best practiceson how to incorporate any custom reports or objects that may have beencreated for the deployed appl ication.

Customizing MicroStrategy Web

MicroStrategy Web provides users wi th a highly interactive environmentand a low-maintenance interface for reporting and analysis. Using theMicroStrategy Web interface, users can access, analyze, and sharecorporate data through any web browser on any operating system.

With the MicroStrategy SDK, you can customize, embed, or extendMicroStrategy Web into your appl ication, or modi fy the standard interface orfunctional i ty. Common customizations for OEM deployments include:

l Customizing the look and feel of the MicroStrategy Web interface. Thiscan include changing the color scheme, adding or removing content,using customized logos, and many other customizations.

l Integrating MicroStrategy Web with thi rd-party appl ications such as:

l Portals

l External securi ty and user management systems

l Advanced data visual izations

l Extending functional i ty to support composi te appl ications includes suchthings as wri teback capabi l i ties and other custom features.



To customize MicroStrategy Web using the MicroStrategy SDK, refer to theMicroStrategy Developer Library (MSDL). The MSDL contains detai ls aboutthe archi tecture, object models, customization scenarios, code samples,and so on that are useful for bui lding a sophisticated and highly functional ,customized appl ication.

The MicroStrategy SDK and MicroStrategy Developer Library (MSDL) arenot included in the MicroStrategy instal lation. You can download theMicroStrategy SDK from the MicroStrategy support si tehttps://resource.microstrategy.com/msdz/defaul t.asp. Al ternately, you canaccess the MicroStrategy Developer Library from the MicroStrategy supportsi te.

Deploying a MicroStrategy OEM Application

After an OEM appl ication is developed, i t then must be deployed to thecustomer's environment. Steps to deploy an embedded instal lation include:

1. Instal l ing the required MicroStrategy products on the customer'senvironment. This can be automated using si lent instal lationtechniques, as described in OEM Silent Instal lations, page 678. To usethe Instal lation Wizard to instal l MicroStrategy products, see:

l Chapter 2, Instal l ing MicroStrategy on Windows

l Chapter 3, Instal l ing MicroStrategy on Linux

2. Addi tional configurations are required, as described in Configuring anOEM deployment instal lation, page 684.

OEM Silent InstallationsYou can use si lent instal lation to easi ly embed MicroStrategy products wi thother appl ications. The steps below show you how to use a si lentinstal lation to deploy an OEM appl ication on a Windows environment. Foraddi tional information on si lent instal lations, see Chapter 9, AutomatedInstal lation on Windows.


https://resource.microstrategy.com/msdz/default.asp


You can fol low the steps below to perform a si lent instal lation on aWindows environment. To perform a si lent instal lation on a Linuxenvironment, see Si lent Instal lation, page 621.

Ensure that the MicroStrategy installation files are accessible on the machine inwhich the installation is being performed. If a required installation file is notaccessible, the installation can fail, often providing a warning about missingrequirements.

To Perform an OEM Silent Installation

When MicroStrategy products are instal led as software bundled withanother product, the fol lowing procedure is strongly recommended:

1. Create an instal lation response fi le (response.ini ) for theMicroStrategy products to instal l . The table that fol lows shows whichsections of the fi le are mandatory and which are optional .

For detai led information regarding the contents of the response.ini

fi le, see Configuring a response.ini Fi le to Instal l MicroStrategy, page560.

Response File Section Selection

[Installer] Required

HideAllDialogs = Required

PreventReboot = Opt ional

StopAllServices = Opt ional

StopIIS = Opt ional

CheckRenameOperations = Opt ional

[UserRegistration] Required



Response File Section Selection

[ComponentSelection] Required

EnterpriseManagerSelect = Required

[InitialPaths] Required

EnterpriseManager = Required

Setting HideAllDialogs = TRUE causes the script for theresponse file to:

l Use default values as specified in the response.ini file.

l Not require user input.

l Keep the dialog flow consistent from one instance to the next.Consistency in the response file script from one instance to the next isnecessary; 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 modi fications pertinent to si lent instal lation arespeci fic to fi le location. Therefore, the only portion of theresponse.ini that may need to be modi fied is the[InitialPaths] section.

The rest of this procedure assumes you have saved theresponse.ini fi le to the fi le path C:\ . If you save i t to another fi lepath, replace C:\response.ini with the fi le path of yourresponse.ini fi le.

You must save the response.ini fi le as ANSI encoding.

2. Create the setup.iss fi le to use in conjunction with theresponse.ini fi le for the si lent instal lation. Use a text edi tor tocreate the setup.iss fi le wi th the fol lowing 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 MicroStrategy platform

Company=MicroStrategy

Lang=LanguageValue

[{8CCF3F6C-55B7-4A27-8C68-ADF21D0585A2}-DlgOrder]

Count=0

You must save the setup.iss fi le as ANSI encoding.

The version in the setup.iss file must match the MicroStrategyversion you are installing exactly. For example, if you are installingversion 10.7.0 you must enter Version=10.7.0 . Entering a versionas Version=10 or Version=10.7.x causes an error when try ing toperform a silent installation of version 9.3.0.

For an explanation of the LanguageValue parameter within the lineLang=LanguageValue , see Language Settings for Si lentInstal lations, page 682 .

3. From the Windows Start menu, select Programs, then selectAccessories, and then right-cl ick Command Prompt and select Runas Administrator. The User Account Control dialog box opens.



5. Run the si lent instal l wi th the response.ini fi le in conjunction withthe setup.iss fi le as fol lows:



For an explanation of the LanguageValue parameter, see LanguageSettings for Si lent Instal lations, page 682

INSTALL_PATH\setup.exe -LLanguageValue --

ResponseFile="C:\response.ini" -s -f1"c:\setup.iss"

-f2"c:\setup.log"

In the syntax shown above, the -s parameter indicates that theinstal lation is to be completely si lent. If the -s parameter is notincluded in the command, then an interface is displayed during theinstal lation that shows the progress of the instal lation.

If the setup program encounters an invalid value for an installationrequirement, 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 instal lation is complete, a restart of themachine is automatical ly triggered. Power the machine back on toal low for the completion of any configurations that are required afterthe restart of the machine.

7. After the instal lation is complete, you can check the resul t of theinstal lation process. If the si lent instal lation is successful , the resul tingcode value is zero (ResultCode=0 ) in the setup.log fi le. This isthe only indication of the instal lation being completed i f the instal lationis completely si lent and a restart of the machine is not required.

Language Settings for Silent Installations

In the final steps of the procedure to run an OEM si lent instal lation:

l You can set MicroStrategy Developer language settings by setting thelanguage value in the setup.iss fi le.

l You can bypass the language prompt by running setup.exe with thecommand l ine option for the language.



The fol lowing table l ists the values for the di fferent languages thatMicroStrategy supports:

Language Value

Danish 0006

Dutch 0019

English 0009

French 0012

German 0007

Italian 0016

Japanese 0017

Korean 0018

Portuguese 0022

Simplified Chinese 2052

Spanish 0010

Swedish 0029

Traditional Chinese 1028

For example, to select Engl ish as the language:

l For the setup.iss file, change Lang=LanguageValue to:

Lang=0009

l To run the silent install, use the command l ine option as fol lows:

Path\setup.exe -L0009

For the command line option, you must type -L in front of the language code tosignify that you are entering a language.



Configuring an OEM deployment installationOnce MicroStrategy has been instal led on the customer's environment, thefol lowing addi tional steps must be taken to prepare the ini tial configurationof MicroStrategy software:

l Provide the MicroStrategy metadata that was developed for the managedappl ication.

l Create separate DSNs to connect to the data warehouse and themetadata, as described in Creating DSNs for OEM Environments, page674.

l Use the Configuration Wizard to configure metadata, Intel l igence Server,and project sources. If you saved your configurations as response fi les,these configurations can be re-used for automated configuration. Forinformation on using the Configuration Wizard, see Configuring aMicroStrategy Instal lation, page 676.

l Configure and tune an OEM deployment through the use of variousMicroStrategy tools, as described in Tuning an OEM Deployment, page684.

Tuning an OEM Deployment

A MicroStrategy OEM deployment requires addi tional tuning andconfiguration, both during deployment and throughout the l i fe cycle of theOEM appl ication. Various ways to perform these configurations aredescribed below:

Tuning with Command ManagerMicroStrategy Command Manager lets you perform various administrativeand appl ication development tasks by using text commands that can besaved as scripts. You can manage configuration settings within theMicroStrategy platform, for ei ther project sources or Narrowcast Server



metadatas. With Command Manager, you can change multiple configurationsettings al l at once, wi thout using the MicroStrategy Developer orNarrowcast Administrator interface.

Developers of OEM appl ications that use embedded MicroStrategy projectsmay find that they need flexibi l i ty in configuring their environment.Command Manager Runtime is a sl immed-down version of the CommandManager command-l ine executable for use with these OEM appl ications.For information about obtaining Command Manager Runtime, contact yourMicroStrategy sales representative.

OEM appl ication deployments typical ly required on-premises configurationof environment-speci fic settings such as database user and password,governing options, caching options, and other tuning requirements.Command Manager Runtime scripts enable OEMs to automate a number ofsuch configuration settings.

Command Manager Runtime uses a subset of the commands avai lable forthe ful l version of Command Manager. If you try to execute a script wi thstatements that are not avai lable in Command Manager Runtime, the scriptfai ls wi th the message "You are not l icensed to run this command." For al ist of the commands avai lable in Command Manager Runtime, wi th syntaxand examples for each command, refer to the [System AdministrationGuide].

Configuring MicroStrategy in Command Line ModeThe MicroStrategy Configuration Wizard is provided in command l ine modeso that you can use the Configuration Wizard through the operating systemconsole i f you do not have access to the GUI. Running the ConfigurationWizard in command l ine mode to configure MicroStrategy on Linuxmachines is covered in Configuring MicroStrategy with a response.ini fi le,page 693.





Updating OEM Applications

The l i fecycle of an OEM appl ication often requires the OEM appl ication tobe updated with new reports and other enhancements. Theseenhancements can be developed within the OEM appl ication and then thecustomer's existing appl ication can be updated.

For more information on updating OEM appl ications, see:

Modifying Deployed OEM ApplicationsIf you are modi fying a project that has already been deployed as an OEMappl ication, you must update the appl ication in a way that does not disruptany current customer development, as described below:

l Retrieve the customer's metadata so that custom reports or other objectsthat have been created can also be included in the OEM appl icationupdate.

l Any new objects deployed as part of the OEM appl ication update shouldbe tested to ensure that they do not negatively affect the objects providedwith the previous deployment of the OEM appl ication. MicroStrategyIntegri ty Manager can be used to automate the testing of including newobjects in an OEM appl ication. For information on Integri ty Manager, referto the System Administration Guide.

Deploying an OEM Application UpdateOnce updates for an OEM appl ication are complete, the appl icationchanges must then be deployed. There are two ways in which the updatecan be deployed, as described below.

Replacing the entire MicroStrategy project in the existing system

Once updates for an OEM appl ication are complete, the project can bereplaced in an OEM appl ication. This is commonly done by dupl icating the




updated OEM project, and then merging that project into the productionOEM appl ication.

These tasks can be achieved using the MicroStrategy Project Dupl icationWizard and Project Merge Wizard. Both of these tools can perform theirtasks from the command l ine, which can al low the project dupl ication andreplacement process to be automated. The steps to use these tools todupl icate and replace a project are provided in the System AdministrationGuide.

Merging modified objects into a project in an OEM application

Once updates for an OEM appl ication are complete, the updates to theproject can be deployed through the use of update packages. An updatepackage is a fi le containing a set of object defini tions and confl ictresolution rules. When you create an update package, you fi rst add objects,and then speci fy how any confl icts involving the objects are resolved.

These update packages can be developed using Object Manager. Once thepackage is ready for deployment, i t can be deployed using the graphicalinterface with Object Manager or using the unattended execution withCommand Manager Runtime. For information on creating and deploying anupdate package with Object Manager, refer to the information on managingprojects provided in the System Administration Guide. For information onCommand Manager Runtime, refer to the System Administration Guide.







CONFIGURINGM ICROSTRATEGY USINGCOMMAND L INE TOOLS



MicroStrategy tools are provided in command l ine mode on Linux so thatyou can perform various configuration tasks through the operating systemconsole. This enables you to perform your required configurations even i fyou do not have access to the MicroStrategy interface.

On a Windows machine, i t is recommended to use the appropriateMicroStrategy interfaces to perform the configurations described in thischapter.

When you perform MicroStrategy configuration tasks through a Linuxoperating system console, you must make sure reserved words andcharacters are not mistakenly included in your commands. To avoid issuescaused by reserved words and characters, see Supporting Reserved Wordsand Characters, page 721 .

This section covers the configurations l isted below:

Creating a DSN for a Data Source

After you instal l an ODBC driver (see Appendix A, Connecting to Databasesand Data Sources), you can define one or more data sources for i t. TheDSN 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 cl ient appl ication (in this caseMicroStrategy) to find and connect to a data source. Mul tiple DSNs canpoint to the same data source and one DSN can be used by di fferentappl ications.

MicroStrategy provides a one-l ine command l ine version of theMicroStrategy Connectivi ty Wizard to create DSNs on Linux.

You can create DSNs using the MicroStrategy Connectiv ity Wizard onWindows and Linux machines, as described in Communicating withDatabases, page 369 .



To create a DSN on Linux from the command line

1. From a Linux console window, browse to HOME_PATH , where HOME_


2. Browse to the folder bin .

3. Type mstrconnectwiz -h , and then cl ick Enter to display commandl ine syntax and examples for di fferent database platforms.

4. Create your command based on the syntax and examples displayed.For example, the command below creates a DSN for an Oracledatabase and tests login credentials:

mstrconnectwiz ORCLW MyOracleDSN 12.34.56.78 orcl 1521 -u:OracleUser -

p:OracleUserPasword

Testing ODBC connectivity

ODBC connectivi ty is one of two layers of connectivi ty that are l isted in thenext table, along with the associated connectivi ty testing programs.Connectivi ty should be tested from the bottom up—the network layer fi rstand then the ODBC layer.

Layer Test with

ODBC driverTest ODBC

mstrtestodbc or mstrtodbcx

Network

TCP/IP

Simple Network Layer Test ing Tool

Ping, PING.EXE, for TCP/IP



The test method described above reflects the situation when the ODBC driverand the database network software are bundled. If they are not bundled, theymust be configured and tested separately, using database-specific tools.

Using the DB Query ToolThe MicroStrategy DB Query Tool is avai lable in Windows, and LinuxIntel l igence Server instal lations. It is used to test and troubleshootconnectivi ty to databases, create and execute SQL commands throughODBC, and run scripts.

Before you use the DB Query Tool, test the network layer with the network layerutility , PING.EXE . Consult your operating system or network systemdocumentation for details .

To use the DB Query Tool

1. To use the DB Query Tool :

l On Windows using the DB Query Tool interface, perform thefol lowing step:

From the Windows Start menu, go to Programs > MicroStrategyTools > DB Query Tool.

l On Windows from the command l ine, perform the fol lowing steps:


2. In the Open drop-down l ist, type cmd and cl ick OK . A commandprompt opens.

3. Type todbcx.exe and cl ick Enter. Prompts guide you throughtesting your ODBC connection from the command l ine andshould be used in place of the steps below. For detai led stepson how to use the command l ine version of this tool , see



Testing ODBC connectivi ty in Chapter 12, ConfiguringMicroStrategy Using Command Line Tools.

l On Linux using the DB Query Tool interface, perform the fol lowingsteps:


2. Browse to the folder bin and type ./mstrdbquerytool , thencl ick Enter.

l On Linux from the command l ine, perform the fol lowing steps:


2. Browse to the folder bin and type ./mstrtodbcx , then cl ickEnter. Prompts guide you through testing your ODBCconnection from the command l ine and should be used in placeof the steps below. For detai led steps on how to use thecommand l ine version of this tool , see Testing ODBCconnectivi ty in Chapter 12, Configuring MicroStrategy UsingCommand Line Tools.

2. From the Session menu, select Open Connection , or cl ick theConnect icon on the toolbar. The Connect dialog box opens. Theconnection interface varies depending on the destination database.

3. Select the DSN for a data source.

4. Enter the appropriate user name and password.

5. Cl ick Connect. After your connection is opened, the connection stringis displayed in the MicroStrategy DB Query Tool at the bottom. Yourcursor is inserted automatical ly 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 forMicrosoft SQL Server or a MicroStrategy-created table such asDSSMDSYSPROP in the MicroStrategy metadata.

7. From the Queries menu, select Execute Query. A table of data fromthe database is displayed in the Query Resul t window.

8. From the Session menu, select Close Connection to close thedatabase connection.

9. From the File menu, select Exit.

Configuring MicroStrategy with a response.ini file

The MicroStrategy Configuration Wizard is provided in command l ine modeso that you can use the Configuration Wizard even i f you do not haveaccess to a GUI. You can perform the fol lowing configurations with theConfiguration Wizard in command l ine mode:

l Create metadata, statistics, and History List tables

l Create new MicroStrategy Intel l igence Server defini tions in the metadata,assign an existing server defini tion for Intel l igence Server, and deleteexisting server defini tions

l Create MicroStrategy project sources in a server (three-tier) mode

Direct (two-tier) data sources are available only on the Windows operatingsystem.

Using the Configuration Wizard in command l ine mode creates aresponse.ini fi le. This fi le can then be used from the command l ine toconfigure MicroStrategy without stepping through the pages of theConfiguration Wizard. You can also distribute a response.ini fi le to



other users and machines to perform multiple configurations withoutstepping through the Configuration Wizard for each configuration.

This section covers the fol lowing procedures and information related toconfiguring MicroStrategy from the command l ine on a Linux machine usinga response.ini fi le:

l Creating a response.ini Fi le, page 694

l Using the response.ini fi le to Configure MicroStrategy, page 716

l Parameters and Options in the response.ini Fi le, page 716

You can also configure MicroStrategy using the Configuration Wizard incommand line mode on a Windows machine. However, on a Windows machine,it is recommended to use the Configuration Wizard graphical user interface tocreate and use a response file, which is described in ConfiguringMicroStrategy with a Response Fi le, page 415 .

Before you can configure MicroStrategy with the Configuration Wizard incommand l ine mode, you must ensure that you meet the prerequisi tes l istedin Configuration Wizard Prerequisi tes, page 383.

Creating a response.ini FileThis section describes how to configure MicroStrategy using the commandl ine mode. Performing the steps in this section creates a response.ini

fi le that can be used to configure MicroStrategy instal lations on Linuxmachines.

To Configure MicroStrategy Using the Command Line Mode

1. In a Linux console window, browse to HOME_PATH where HOME_PATH

is the speci fied home directory during instal lation.

2. Browse to the bin directory.



3. At the command prompt, type mstrcfgwiz-editor , then cl ick Enter.The Configuration Wizard opens in command l ine mode.

The sections or pages of the wizard displayed depend on yourselections.

4. Cl ick Enter.

5. You can select to use a response.ini fi le to configureMicroStrategy, or create a new response.ini fi le to support a newconfiguration, as described below:

l Type 1 , and then cl ick Enter to use a response.ini fi le toconfigure MicroStrategy. For steps to use a response.ini fi le incommand l ine mode, see Using the response.ini fi le to ConfigureMicroStrategy, page 716.

l Type 2 , and then cl ick Enter to create a new response.ini fi le.

6. You can support the configuration tasks described in the sectionsl isted below:

l Type 1 and cl ick Enter to create metadata, History List, andstatistics tables. Refer to Creating Metadata, History List, andStatistics Tables, page 696 for steps to create metadata tables,History List tables, and statistics tables.

l Type 2 and cl ick Enter to configure a MicroStrategy Intel l igenceServer defini tion. Refer to To Set Up the MicroStrategy Intel l igenceServer, page 705 for steps to configure an Intel l igence Serverdefini tion.

l Enter 3 and cl ick Enter to create a Platform Analytics project. Referto Creating a Platform Analytics Project for steps to create a PlatformAnalytics project.

l Type 4 and cl ick Enter to create project sources. Refer to Creating aProject Source, page 714 for steps to create project sources.



l Type 5 and cl ick Enter to upgrade your existing environment toMicroStrategy Analytics Enterprise. View your Intel l igence Servercomponents, Statistics & Enterprise Manager reposi tory, or yourHistory List reposi tory. You can also upgrade your EnterpriseManager project or Platform Analytics project. Refer to To Update aPlatform Analytics Project for instructions to update your project.

Creating Metadata, History List, and Statistics Tables

Creating Metadata, History List, and Statistics tables

If you selected option 1 in Creating a response.ini Fi le, page 694, you cancreate metadata tables, History List tables, and statistics tables.

Creating Metadata Tables

If metadata tables already exist in the location you plan to store your metadatatables in and you do not want to overwrite the current metadata tables, youshould use the option described below.

This procedure assumes you have already opened the Configuration Wizard incommand line mode and selected to create metadata and statistics tables, asdescribed in Creating a response.ini Fi le .

To Create Metadata Tables

1. In the prompt asking whether to create metadata tables, type Y andcl ick Enter. You are then prompted for ODBC data source information.

2. Type the number corresponding to the ODBC DSN for the database tostore your metadata tables and cl ick Enter.

If you do not have a DSN defined on your Linux machine, see Creating aDSN for a Data Source, page 689 .



3. If the Configuration Wizard detects an existing metadata reposi tory inthe database location you speci fied, a message is displayed onwhether to re-create the metadata tables. If you type Y and press Enter,al l information in the existing metadata reposi tory is overwri tten whenthe response fi le is executed at a later time.

4. Enter a login and password to your DSN and cl ick Enter.

5. Enter characters to use as a prefix for the names of your metadatatables or use no prefix and cl ick Enter.

The next steps depend on your ODBC data source detai ls.

To Configure DB2 MVS Database Options

6. Enter the database name to use or use the defaul t name and cl ickEnter.

7. Enter characters to use as a table space name for your metadatatables or use the defaul t table space name and cl ick Enter.

To Select a Metadata Script

8. Select the script used to create the metadata tables or use the defaul tscript and cl ick Enter

9. Type Y and cl ick Enter to create History List tables.

10. Type N and cl ick Enter to skip History List table creation.

11. Type Y and cl ick Enter to create statistics tables.

12. Type N and cl ick Enter to skip statistics tables creation.

13. By defaul t, the configuration is saved as Response.ini in the/HOME_PATH/ directory, where HOME_PATH is the directory youspeci fied as the Home Directory during instal lation. You can leave thefield blank to use the defaul t name or type a di fferent name, and then



cl ick Enter. The response.ini fi le is generated, and you areprompted whether to run the configuration immediately.

14. Type Y and cl ick Enter.

15. Type N and cl ick Enter to qui t wi thout running the configuration.

Creating History List Tables

This procedure assumes you have already opened the Configuration Wizard incommand line mode and selected to create metadata, History List, and statisticstables, as described in Creating a response.ini Fi le, page 694 .

1. After you create metadata tables (see To Create Metadata Tables,page 696) or skip the creation of metadata tables, you are prompted tocreate History List tables.

To create History List tables, type Y and cl ick Enter.

2. You can supply ODBC DSN information in various ways describedbelow, which depend on whether you previously created metadatatables as part of the configuration process:

l If you did not create metadata tables as part of the configurationprocess, you are prompted to enter ODBC DSN information. Thesteps to enter this information is described in the To Provide ODBCDSN Information, page 699 section within this procedure.

l If you created metadata tables as part of the configuration process,you are prompted whether to use the same metadata table ODBCDSN information for your History List tables. You have the fol lowingoptions:

l Type Y and cl ick Enter to create History List tables with the sameODBC DSN information entered for your metadata tables. You arethen prompted to select a History List script to create the HistoryList tables, which is described in the To Select a History ListScript, page 700 section within this procedure.



l Type N and cl ick Enter to provide di fferent ODBC DSN information,which is described in the To Provide ODBC DSN Information, page699 section within this procedure.

To Provide ODBC DSN Information

1. Type the number corresponding to the ODBC DSN for a database tocreate your History List tables in, and then cl ick Enter.

If you do not have a DSN defined on your Linux machine, see Creating aDSN for a Data Source, page 689 .

2. Depending on your database type, you may be prompted to provide alogin and password to your DSN:

l Type a login name for your database to create your History Listtables in and cl ick Enter.

l Type a password for the login name provided and cl ick Enter.

3. The next configuration displayed depends on your ODBC data sourcedetai ls:

l If the data source points to a DB2 MVS database, steps to configurea DB2 MVS database are displayed. These are described in the ToConfigure DB2 MVS Database Options, page 699 section within thisprocedure.

l If the data source does not point to a DB2 MVS database, the step toselect a statistics script to create statistics tables is displayed. Thisstep is described in the To Select a History List Script, page 700section within this procedure.


1. You can enter the database name to use or use the defaul t name, asdescribed below:



l Type the database name to use and cl ick Enter.

l Leave the prompt blank and cl ick Enter to use the defaul t database.

You are then prompted to provide the MVS table space name.

2. You can enter characters to use as a table space name for yourmetadata tables or use the defaul t table space name, as describedbelow:

l Type the required table space name characters and cl ick Enter.

l Leave the prompt blank and cl ick Enter to use the defaul t tablespace name.

You are then prompted to select a statistics script to create statisticstables.

To Select a History List Script

You can select the script used to create the History List tables or use thedefaul t script, as described below:

l Enter a val id path to a script fi le and cl ick Enter.

l Leave the field blank and cl ick Enter to use the defaul t script for yourdatabase type.

To Create Statistics Tables

l Type Y and cl ick Enter to create statistics tables. Creating statisticstables is described in Creating Statistics Tables, page 701.

l Type N and cl ick Enter to skip statistics tables creation. You are thenprompted to provide a name for the response.ini fi le, as described in theTo Generate a response.ini Fi le, page 701 section within this procedure.



To Generate a response.ini Fi le

1. By defaul t, the configuration is saved as Response.ini in the/HOME_PATH/ directory, where HOME_PATH is the directory youspeci fied as the Home Directory during instal lation. You can leave thefield blank to use the defaul t name or type a di fferent name and cl ickEnter. The response.ini fi le is generated, and you are promptedwhether to run the configuration immediately.

2. You can choose to run the configuration you just completed or to runthe configuration using the response.ini fi le at a di fferent time, asdescribed below:

l Type Y and cl ick Enter to run the configuration.

l You can also use the response.ini fi le created for futureconfigurations, as described in Using the response.ini fi le toConfigure MicroStrategy, page 716.

l Type N and cl ick Enter to qui t wi thout running the configuration. Youcan use the response.ini fi le created for future configurations, asdescribed in Using the response.ini fi le to Configure MicroStrategy,page 716.

Creating Statistics Tables

This procedure assumes you have already opened the Configuration Wizard incommand line mode and selected to create metadata, History List, and statisticstables, as described in Creating a response.ini Fi le, page 694 .

To Create Statistics Tables

1. After you create metadata tables (see To Create Metadata Tables,page 696), create History List tables (Creating History List Tables,page 698), or skip both of these procedures, you are prompted tocreate statistics tables.



To create statistics tables, type Y and cl ick Enter.

2. You can supply ODBC DSN information in various ways describedbelow, which depend on whether you previously created metadatatables as part of the configuration process:

l If you did not create metadata tables as part of the configurationprocess, you are prompted to enter ODBC DSN information. Thesteps to enter this information is described in the To Provide ODBCDSN Information, page 702 section within this procedure.

l If you created metadata tables as part of the configuration process,you are prompted whether to use the same metadata table ODBCDSN information for your statistics tables. You have the fol lowingoptions:

l Type Y and cl ick Enter to create statistics tables with the sameODBC DSN information entered for your metadata tables. You arethen prompted to select a statistics script to create the statisticstables, which is described in the To Select a Statistics Script, page704 section within this procedure.

l Type N and cl ick Enter to provide di fferent ODBC DSN information,which is described in the To Provide ODBC DSN Information, page702 section within this procedure.

To Provide ODBC DSN Information

1. Type a val id ODBC DSN for a database to create your statistics tablesin and cl ick Enter. You are then prompted to provide a login to yourDSN.

2. Type a login name for your database to create your statistics tables inand cl ick Enter. You are then prompted to provide a password for thelogin name.



3. Type a password for the login name provided and cl ick Enter.

The next configuration displayed depends on your ODBC data sourcedetai ls:

l If the data source points to a DB2 MVS database, steps to configurea DB2 MVS database are displayed. These are described in the ToConfigure DB2 MVS Database Options, page 703 section within thisprocedure.

l If the data source does not point to a DB2 MVS database, the step toselect a statistics script to create statistics tables is displayed. Thisstep is described in the To Select a Statistics Script, page 704section within this procedure.


1. You can enter the database name to use or use the defaul t name, asdescribed below:

l Type the database name to use and cl ick Enter.

l Leave the prompt blank and cl ick Enter to use the defaul t database.

You are then prompted to provide the MVS table space name.

2. You can enter characters to use as a table space name for yourmetadata tables or use the defaul t table space name, as describedbelow:

l Type the required table space name characters and cl ick Enter.

l Leave the prompt blank and cl ick Enter to use the defaul t tablespace name.

You are then prompted to select a statistics script to create statisticstables.



To Select a Statistics Script

You can select the script used to create the statistics tables or use thedefaul t script, as described below:

l Enter a val id path to a script fi le and cl ick Enter.

l Leave the field blank and cl ick Enter to use the defaul t script for yourdatabase type.

You are then prompted to provide a name for the response.ini fi le.





l You can also use the response.ini fi le created for futureconfigurations, as described in Using the response.ini fi le toConfigure MicroStrategy, page 716.




Setting Up the MicroStrategy Intelligence Server

If you selected option 2 in Creating a response.ini Fi le, page 694, you canset up MicroStrategy Intel l igence Server to create, use, or delete serverdefini tions. To begin setting up your server defini tion, you must enterinformation about your ODBC DSN and MicroStrategy connections.

To Set Up the MicroStrategy Intelligence Server

1. Type the corresponding number for the ODBC DSN for a database toconnect Intel l igence Server to. This should be the data source thatstores your metadata. Cl ick Enter. You are then prompted to provide alogin to your DSN.

2. Type a login name for your database to create your statistics tables inand cl ick Enter. You are then prompted to provide a password for thelogin name.

3. Type a password for the login name provided and cl ick Enter. You arethen prompted to provide a metadata prefix.

4. You can enter characters to use as a prefix for the names of yourmetadata tables or use no prefix, as described below:

l Type the required prefix characters and cl ick Enter.

l Leave the prompt blank and cl ick Enter to provide no metadataprefix.

You are then prompted to provide a temp table prefix.

5. You can enter characters to use as a prefix for the names of temptables or use no prefix, as described below:

l Type the required prefix characters and cl ick Enter.

l Leave the prompt blank and cl ick Enter to provide no temp tableprefix.



You are then prompted to provide a MicroStrategy user login.

6. Type a val id MicroStrategy user login that has administrator privi legesand cl ick Enter.You are then prompted to provide a password for thelogin name.

The default administrator account is Administrator with a blankpassword. This should be changed after you initial configuration.

7. Type a password for the MicroStrategy user login provided and cl ickEnter. You are then prompted to choose the type of Intel l igence Serverconfiguration to complete.

8. You can perform one of the Intel l igence Server configuration tasks,which are described in the sections below:

l Type 1 and cl ick Enter to create a new server defini tion. Refer toCreating and Using a Server Defini tion, page 706 for steps to createa new server defini tion.

l Type 2 and cl ick Enter to use an exi ting server defini tion. Thisconfiguration fol lows the same steps for creating a new serverdefini tion, which are described in Creating and Using a ServerDefini tion, page 706.

l Type 3 and cl ick Enter to delete a server defini tion. Refer toDeleting a Server Defini tion, page 709 for steps to delete a serverdefini tion.

l Type 4 and cl ick Enter to create a new server defini tion and use i tas the defaul t server defini tion. This configuration fol lows the samesteps for creating a new server defini tion, which are described inCreating and Using a Server Defini tion, page 706.

Creating and Using a Server Defini tion

You perform the same steps to complete the fol lowing actions:



l Create a new server defini tion

l Create a new server defini tion and use i t as the defaul t server defini tion

l Use an existing server defini tion.

The action taken depends on what action you selected to complete in theprocedure Setting Up the MicroStrategy Intel l igence Server, page 705.

This procedure assumes you have already opened the Configuration Wizard incommand line mode and entered configuration information for your IntelligenceServer, as described in To Set Up the MicroStrategy Intel l igence Server,page 705 .

To Create and Use a Server Definit ion

1. In the prompt that asks for a server defini tion name, type the name thatdistinguishes the server defini tion and cl ick Enter. You can cl ick Enterwithout entering any information to use the defaul t server defini tion.You are then prompted to choose the projects to load for the serverdefini tion.

2. Type the names of projects to load when the server defini tion startsand cl ick Enter. Separate the project names with the \ character. Youare then prompted to choose projects to not load for the serverdefini tion.

3. Type the names of projects to not load when the server defini tion startsand cl ick Enter. Separate the project names with the \ character. Youare then prompted to provide a TCP port to use for Intel l igence Server.

4. You can use the defaul t port number or enter a di fferent port numberfor Intel l igence Server, as described below:

l Leave the prompt blank and cl ick Enter to use the defaul t portnumber.



l Type a port number and cl ick Enter.

You are then prompted whether to register Intel l igence Server as aservice.

5. You can choose whether to register Intel l igence Server as a service,as described below:

l Type Y and cl ick Enter to register Intel l igence Server as a service.To perform this configuration, you must be logged into your Linuxmachine with an account that has root level access and permissions.

l Type N and cl ick Enter to not register Intel l igence Server as aservice.

You are then prompted whether to start Intel l igence Server whenfinished

6. Type Y and cl ick Enter to start Intel l igence Server after the responsefi le is executed. You are then prompted to provide a name for theresponse.ini fi le.

To Generate a Response.ini Fi le

1. By defaul t, the configuration is saved as Response.ini in the/HOME_PATH/ directory, where HOME_PATH is the directory youspeci fied as the Home Directory during instal lation. You can leave thefield blank to use the defaul t name or type a di fferent name, and thencl ick Enter. The response.ini fi le is generated, and you areprompted whether to run the configuration immediately.





You can also use the response.ini fi le created for futureconfigurations, as described in Using the response.ini fi le toConfigure MicroStrategy, page 716.


Deleting a Server Defini tion

This procedure assumes you have already opened the Configuration Wizard incommand line mode and entered configuration information for your IntelligenceServer, as described in To Set Up the MicroStrategy Intel l igence Server,page 705 .

In the prompt that asks for server defini tions to be removed, type the namethat distinguishes the server defini tion and cl ick Enter. You can l istmul tiple server defini tions to be deleted, separating server defini tion nameswith the \ character. You are then prompted to provide a name for theresponse.ini fi le.

1. Type the name that distinguishes the server defini tion in the promptthat asks for server defini tions to be removed. Cl ick Enter.

You can list multiple server definitions to be deleted, separating serverdefinition names with the \ character.

2. Name the response.ini fi le.


1. By defaul t, the configuration is saved as Response.ini in the/HOME_PATH/ directory, where HOME_PATH is the directory youspeci fied as the Home Directory during instal lation. You can leave the



field blank to use the defaul t name or type a di fferent name and cl ickEnter. The response.ini fi le is generated, and you are promptedwhether to run the configuration immediately.




l Type N and cl ick Enter to qui t wi thout running the configuration.

You can use the response.ini fi le created for futureconfigurations, as described in Using the response.ini fi le toConfigure MicroStrategy, page 716.

Creating a Platform Analytics Project

If you selected option 3 in Creating a response.ini Fi le, you can Create aPlatform Analytics Project.

If you choose Create a Platform Analytics Project when a project alreadyexists, a message appears indicating the project exists and asks if you'd liketo upgrade your Platform Analytics project. Enter y to continue or enter n toexit. If you choose Upgrade existing environment to MicroStrategyAnalytics Enterprise when a project does not exist, a message appearsindicating the project does not exists and asks if you want to create a newPlatform Analytics project. Enter y to continue or n to exit.

This procedure assumes you have already opened the Configuration Wizard incommand line mode and selected to create a Platform Analytics project, asdescribed in Creating a response.ini Fi le, page 694 .



To create a Platform Analytics project

1. Enter your MicroStrategy username and password to connect to theIntel l igence Server. You must have administrative privi leges.

2. If the Configuration Wizard detects an existing Platform AnalyticsProject in the metadata, a message is displayed on whether to updatethe Platform Analytics project tables. If you type Y and press Enter, al linformation in the existing Platform Analytics project tables isoverwri tten when the response fi le is executed at a later time.

3. Select the location of the Project Analytics project packages.

4. Select the location of the Project Analytics configuration packages.

5. Type the number corresponding to the Mysql ODBC DSN/PostgreSQLODBC DSN for the database to store your Platform Analytics Projecttables and cl ick Enter.

If you do not have a DSN defined on your Linux machine, see Creatinga DSN for a Data Source.

6. Enter the login and password to your DSN and cl ick Enter.


The Configuration Wizard automatical ly appl ies the fol lowingconfiguration fi les:

l PlatformAnalyticsConfigurationNew.scp

l PlatformAnalyticsConfigurationNew_PostgreSQL.scp

l PlatformAnalyticsConfigurationUpgrade.scp

l PlatformAnalyticsConfigurationUpgrade_PostgreSQL.scp

8. If an error appears about being unable to automatical ly apply projectsettings to Platform Anal tyics, you must manual ly update the projectsettings. For instructions, see Configure the Platform Analytics Project.


http://www2.microstrategy.com/producthelp/current/PlatformAnalytics/en-us/Content/tuning_platform_analytics_project.htm









To Update a Platform Analytics Project

1. Type 5 in Creating a response.ini Fi le and choose Upgrade PlatformAnalytics Project.

2. Enter your MicroStrategy username and password to connect to theIntel l igence Server. You must have administrative privi leges.

3. If the Configuration Wizard detects an existing Platform AnalyticsProject in the metadata, a message is displayed on whether to updatethe Platform Analytics project tables. If you type Y and press Enter, al linformation in the existing Platform Analytics project tables isoverwri tten when the response fi le is executed at a later time.



4. Select the location of the Project Analytics project packages.

5. Select the location of the Project Analytics configuration packages.

6. Type the number corresponding to the Mysql ODBC DSN/PostgreSQLODBC DSN for the database to store your Platform Analytics Projecttables and cl ick Enter.

If you do not have a DSN defined on your Linux machine, see Creatinga DSN for a Data Source.

7. Enter the login and password to your DSN and cl ick Enter.


The Configuration Wizard automatical ly appl ies the fol lowingconfiguration fi les:

l PlatformAnalyticsConfigurationNew.scp

l PlatformAnalyticsConfigurationNew_PostgreSQL.scp

l PlatformAnalyticsConfigurationUpgrade.scp

l PlatformAnalyticsConfigurationUpgrade_PostgreSQL.scp

9. If an error appears about being unable to automatical ly apply projectsettings to Platform Anal tyics, you must manual ly update the projectsettings. For instructions, see Configure the Platform Analytics Project.


1. By defaul t, the configuration is saved as Response.ini in the/HOME_PATH/ directory, where HOME_PATH is the directory youspeci fied as the Home Directory during instal lation. You can leave thefield blank to use the defaul t name or type a di fferent name, and thencl ick Enter. The response.ini fi le is generated, and you areprompted whether to run the configuration immediately.


http://www2.microstrategy.com/producthelp/current/PlatformAnalytics/en-us/Content/tuning_platform_analytics_project.htm







Creating a Project Source

If you selected option 4 in Creating a response.ini Fi le, page 694, you cancreate project sources, as described in the procedure below.

To Create a Project Source

1. In the prompt that asks for a project source name, type the name for theproject source to be created and cl ick Enter. You are then prompted toprovide the Intel l igence Server name.

2. Type the Intel l igence Server name and cl ick Enter. You can also cl ickEnter without typing any information to accept the defaul t Intel l igenceServer. You are then prompted to provide a TCP port to use forIntel l igence Server.

3. You can use the defaul t port number or enter a di fferent port numberfor Intel l igence Server, as described below:

l Leave the prompt blank and cl ick Enter to use the defaul t portnumber.



l Type a port number and cl ick Enter.

You are then prompted to define a time interval for a project sourceconnection time out.

4. Type a numerical value (in minutes) for the amount of inactivi ty that isal lowed before a user is automatical ly disconnected from a projectsource. This enforces a connection time out for inactive usersconnected to a project source. Type 0 to define that users are notdisconnected from project sources due to inactivi ty. Cl ick Enter.

You are then prompted to select an authentication type for the projectsource.

5. You can type the corresponding number to select one of theauthentication types l isted in the command l ine. For information oneach authentication type, see Modes of Authentication in the SystemAdmin Guide.

You are then prompted to provide a name for the response.ini fi le.






https://www2.microstrategy.com/producthelp/Current/SystemAdmin/WebHelp/Lang_1033/Content/Modes_of_authentication.htm





Using the response.ini file to Configure MicroStrategyThis section describes how to use the response.ini fi le through theMicroStrategy Configuration Wizard. For information on how to configurethrough the MicroStrategy Configuration Wizard, see Creating aresponse.ini Fi le, page 694.

1. In a Linux console window, browse to HOME_PATH , where HOME_PATH



3. Type mstrcfgwiz-editor -r ResponseFile , whereResponseFile is the ful l qual i fied path to the response.ini fi le.For example:

mstrcfgwiz-editor -r /home/username/MicroStrategy/RESPONSE.INI

4. Cl ick Enter.

If the path and the response fi le are val id, the configuration is performedand a successful configuration message appears. If an error occurs beforeor during the process, an error message displays the error that occurredwhen executing the response fi le.

Parameters and Options in the response.ini FileFor a l ist of al l parameters and options avai lable for a response.ini fi le, seeResponse configuration parameters and options, page 418.



Configuring and Controlling Intelligence Server

MicroStrategy provides various command l ine tools to configure and controlIntel l igence Servers running on Linux. Each command l ine tool providesdescriptive prompts and help information to guide you on how you can usethe tool . This section gives a general overview of each tools functional i ty,and how to access more detai led information on how to use the tools.

On a Windows machine, these configurations can be completed withMicroStrategy Developer, Service Manager, and other MicroStrategy tools.For information on performing various administrative tasks, see the SystemAdministration Guide .

Starting, Configuring, and Monitoring Intelligence Server withmstrsvrIf your Intel l igence Server is instal led on a Linux machine, you can start,configure, and moni tor your Intel l igence Server from the command l ine withmstrsvr . This tool starts Intel l igence Server from the command l ine anddisplays the fol lowing information about your Intel l igence Serverconnection:

l Intel l igence Server version number

l Intel l igence Server instance name

l Metadata DSN

l Metadata login

l Intel l igence Server defini tion name

l Port number

You can then perform various configuration and moni toring tasks for yourrunning Intel l igence Server, which includes but is not l imi ted to:





l Display database connection information

l Open, idle, and resume projects

l Check and close jobs

l Monitor users

l Define server clustering options

l Monitor memory usage information

l Stop the server

l Monitor lock contentions

To start, configure, and monitor Intelligence Server with mstrsvr

l From a Linux console window, browse to HOME_PATH , where HOME_PATH

is the directory that you speci fied as the home directory duringinstal lation.

l Browse to the folder bin .

l Type mstrsvr , and then cl ick Enter.

l Once Intel l igence Server is started, general configuration information isdisplayed along with al l avai lable configuration and moni toring options.Perform any configuration and moni toring tasks you require.

l To qui t the tool and stop Intel l igence Server, type S , and then cl ick Enter.

Configuring the Default Server Instance with mstrsvr-configureYou can configure the defaul t server instance for Intel l igence Server usingmstrsvr-configure , which is a wizard-style command l ine tool thatprompts you for the required information.






3. Type mstrsvr-configure , and then cl ick Enter.

4. Type a port number, and then cl ick Enter.

5. Type a DSN, and then cl ick Enter.

6. Type a val id login for the DSN, and then cl ick Enter.

7. Type a val id password for the DSN login, and then cl ick Enter.

8. Type a server defini tion name, and then cl ick Enter.

Creating and Configuring Intelligence Server Instances withmstrctlYou can create and configure Intel l igence Server instances with themstrctl tool . Intel l igence Servers running with a particular serverdefini tion are referred to as server instances.




3. Enter mstrctl -h and cl ick Enter.

4. Review the help information and run any required configuration tasks.

There are some commands that can output information to a fi le, or require along defini tion that can be retrieved from a fi le. For information on usingfi les to store output from and provide input to mstrctl commands, seeUsing fi les to store output and provide input, page 720.



You do not need to enter any command to qui t the mstrctl tool because i tis a one-l ine command l ine tool .

Using files to store output and provide input

With the mstrctl command l ine tool , you can perform the fol lowing tasks:

l Display and modi fy a server configuration

l Display and modi fy a service configuration

l Display and modi fy a server instance configuration

The commands that display the configurations l isted above output long XMLdefini tions to the command l ine. The commands that modi fy theconfigurations l isted above require a long XML defini tion as input.

Rather than displaying and inputting long XML defini tions from thecommand l ine, you can use fi les to store and provide input for long XMLdefini tions.

Configuring Intelligence Server with XML files requires extensive knowledge ofthe various parameters and values used to define Intelligence Serverconfigurations. Providing an incorrect XML definition to configure IntelligenceServer can cause errors and unexpected functionality .

Prior to using commands to display and modify service configurations (gsvcand ssvc) you must register Intelligence Server as a service. You can performthis task by using the rs command for mstrctl . To register an IntelligenceServer as a service on a Linux machine, you must be logged in with an accountthat has root user priv ileges and permissions.

The fol lowing commands can have their output sent to a fi le:

l gsc : Displays a server configuration

l gsvc : Displays a service configuration

l gsic : Displays a server instance configuration



For example, you can run the fol lowing command to output the serverinstance configuration to an XML fi le:

mstrctl -s IntelligenceServer gsic > ServerInstance.xml

A ServerInstance.xml fi le is saved in the current di rectory.

The fol lowing commands can read input from a fi le:

l ssc : Modi fies a server configuration

l ssvc : Modi fies a service configuration

l ssic : Modi fies a server instance configuration

For example, you can run the fol lowing command to modi fy the serverinstance configuration by reading input from an XML fi le:

mstrctl -s IntelligenceServer ssic < ServerInstance.xml

The XML defini tion in ServerInstance.xml is used to define the serverinstance configuration.

It would be di fficul t and time consuming to type a complete server, service,or server instance configuration from the command l ine. An easier way toprovide this type of configuration is to output the current configuration to afi le, modi fy the fi le wi th a text edi tor, and then use the fi le as input to acommand to modi fy the configuration.

Supporting Reserved Words and Characters

When you perform MicroStrategy configuration tasks through the Linuxoperating system console, you must make sure reserved words andcharacters are not mistakenly included in your commands.

Linux operating system consoles use reserved words and characters toperform various actions. For example, the $ character may perform anaction when included as part of a command executed through the operating



system console. If this character is included in a command to configure, i tcan cause the command to fai l .

For example, you use the fol lowing command to create a DSN to an Oracledatabase:

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 areserved character, the command fai ls to execute properly.

To avoid this problem, you can place single quotes ('' ) around anycharacter strings that may include reserved words or characters. Thisprevents the operating system console from interpreting the characters asan operating system action, and instead includes them as part of thecharacter string. For example, the same command as above to create aDSN can be rewri tten as fol lows:

mstrconnectwiz ORCLW '$MyOracleDSN' 12.34.56.78 orcl 1521 -

u:OracleUser -p:OracleUserPasword

This time, the name of the DSN $MyOracleDSN is enclosed by singlequotes, which al lows al l of the characters to be interpreted as a string ofcharacters.


To help guide the rest of your instal lation and configuration steps, refer tothe section Instal l ing and Configuring MicroStrategy on Linux, page 137 inChapter 1, Planning Your Instal lation, for an instal lation and configurationcheckl ist.



ADDING OR REMOVINGM ICROSTRATEGYCOMPONENTS



This section describes how to add or remove MicroStrategy components ondi fferent operating systems and includes the fol lowing:

Adding or Removing MicroStrategy Components on Windows 724

Re-instal l ing MicroStrategy components on Windows 725

Uninstal l ing MicroStrategy Components on Windows 727

Uninstal l ing MicroStrategy Components on Linux 730

Adding or Removing MicroStrategy Components onWindows

If you instal led the MicroStrategy components using a disk, you wi l l needyour original instal lation disk to add or remove MicroStrategy components.

To add or remove MicroStrategy components1. Close al l MicroStrategy products.

2. Open the Microsoft Control Panel and navigate to the options to add orremove programs. See the Microsoft documentation for steps to accessthese options.

3. Within the l ist of instal led programs, select MicroStrategy and cl ickChange. The MicroStrategy Setup Maintenance program opens.

4. Select Modify and cl ick Next.

5. Select to accept the l icense agreement and cl ick Next.

6. Veri fy your customer information and cl ick Next.

7. Select the components to add by cl icking their check boxes. Clear thecheck boxes for the components you want to uninstal l and cl ick Next.

The components that are currently installed are displayed with theircheck boxes selected. These components are not re-installed during the



modification process. If you clear any of the check boxes, that particularcomponent is uninstalled during the modification process. You areadvised not to clear the check boxes of the components that are alreadyinstalled, unless you want to remove the component.

8. If prompted to stop your Web server, cl ick Yes.

9. Veri fy the settings and cl ick Next.

10. After the modi fication routine is complete, cl ick Finish . To ful ly removeMicroStrategy Office, see Uninstal l ing MicroStrategy Office, page 729.

For more detai ls on each page of the MicroStrategy Instal lation Wizard, seeChapter 2, Instal l ing MicroStrategy on Windows.

Re-installing MicroStrategy components on Windows

You can re-instal l MicroStrategy components i f there are problems withpreviously instal led components. During re-instal lation the l ist ofcomponents previously instal led are displayed and these components arere-instal led. If you instal led the MicroStrategy components using a disk, youneed your original instal lation disk to repair the instal lation.

The re-installation of MicroStrategy Office must be performed separately. Theprocedure for re-installing MicroStrategy Office is explained in the followingsection.

To re-install MicroStrategy components1. Close al l MicroStrategy products.

2. Open the Microsoft Control Panel and navigate to the options to add orremove programs. Refer to the appropriate Microsoft documentation forsteps to access these options.




4. Select Repair and cl ick Next.

5. Accept the l icense agreement and cl ick Next.

6. You are prompted to select Yes to continue with the re-instal lationprocedure and overwri te the components. If you do not want tooverwri te the components, select No .

7. If prompted to stop your Web server, cl ick Yes to stop i t and continuewith the re-instal lation.

8. After the re-instal lation routine is complete, cl ick Finish .

For detai ls on each page of the MicroStrategy Instal lation Wizard, seeChapter 2, Instal l ing MicroStrategy on Windows.

Re-installing MicroStrategy Office




This section describes the re-instal lation procedure for MicroStrategy Officeon Windows 7, 8.1, and 10.

To re-install MicroStrategy Office

1. Close al l MicroStrategy products.

2. Navigate to the add/remove menus for Windows:






l For Windows 7 or 8.1 users, open the Microsoft Control Panel ornavigate to the options to add or remove programs. See theappropriate Microsoft documentation for steps to access theseoptions.

l For Microsoft Windows 10 users, select Settings under the StartMenu and navigate to the Apps.

3. In MicroStrategy Office, fol low the below instructions for your Windowsversion to begin re-instal l ing:

l For Windows 7 or 8.1 users, select MicroStrategy Office and cl ickChange. The MicroStrategy Office Setup Maintenance programopens.

l For Windows 10 users, select MicroStrategy Office and cl ick Re-instal l . The MicroStrategy Office Setup Maintenance program opens.

4. Select Repair and cl ick Next.

5. Accept the l icense agreement and cl ick Next.

6. You are prompted to select Yes to continue with the re-instal lationprocedure and overwri te the components. If you do not want tooverwri te components, select No .

7. If prompted to stop your Web server, cl ick Yes to stop i t and continuewith the re-instal lation.

8. After the re-instal lation routine is complete, cl ick Finish .

For detai ls on each page of the MicroStrategy Instal lation Wizard, seeChapter 2, Instal l ing MicroStrategy on Windows.

Uninstalling MicroStrategy Components on Windows

The uninstal lation procedure performs the fol lowing functions:



l Unregisters and removes selected fi les, registry entries, and shortcutslogged in the Uninst.isu log fi le.

l Cal ls a custom DLL to handle unlogged i tems, such as registry entriesand fi les.

Before uninstal lation begins, the DLL fi le performs the fol lowing functions:

l Checks for user privi leges. If they are not val id, uninstal lation stops.

l Checks for running components. If a component is found running,uninstal lation stops.

l Stops and deletes the MicroStrategy Intel l igence Server service. Thisoccurs only when the Intel l igence Server is being uninstal led.

l Deletes fi les created by the appl ication, such as *.log , *.gid , *.ldband *.tb.

The uninstallation of MicroStrategy Office must be performed separately. Theprocedure for uninstalling MicroStrategy Office is explained in the followingsections.


2. Open the Microsoft Control Panel and navigate to the options to add orremove programs. See the appropriate Microsoft documentation forsteps to access these options.


4. Select Remove and cl ick Next.

5. Cl ick Yes to any prompts that appear.

6. If prompted to stop your Web server, cl ick Yes.

7. After the uninstal l is complete, select Yes to restart your computer, or



No to restart i t later.

8. Cl ick Finish .

You should restart the computer for a clean uninstall.

Uninstalling MicroStrategy Office




This section describes the steps to uninstal l MicroStrategy Office forWindows 7, 8.1, and 10.


2. Navigate to the add/remove menus for Windows:

l For Windows 7 or 8.1 users, open the Microsoft Control Panel ornavigate to the options to add or remove programs. See theappropriate Microsoft documentation for steps to access theseoptions.

l For Microsoft Windows 10 users, select Settings under the StartMenu and navigate to the Apps.

3. In MicroStrategy Office, fol low the below instructions for your Windowsversion to begin uninstal l ing:

l For Windows 7 or 8.1 users, select MicroStrategy Office and cl ickChange.






l For Windows 10 users, select MicroStrategy Office and cl ickUninstal l .

4. Select Remove and cl ick Next.

5. When prompted, select Yes.

6. Cl ick Finish .

Uninstalling MicroStrategy Components on Linux

This section discusses how to uninstal l MicroStrategy Intel l igence Serverand other MicroStrategy products on a Linux platform.

This does not apply to Platform Analytics. The Platform Analytics project mustbe manually deleted using any of the supported delete methods.

To uninstall MicroStrategy products on Linux

1. In a Linux console window, browse to INSTALL_PATH , whereINSTALL_PATH is the directory you speci fied as the instal l di rectoryduring instal lation.

2. Browse to the /_uninst folder.

3. You can uninstal l MicroStrategy products using the MicroStrategyInstal lation Wizard or through the command l ine as described in theoptions below:

l To uninstal l using the MicroStrategy Instal lation Wizard, type./setup.sh and cl ick Enter.

l To uninstal l through the command l ine, type ./setup.sh -

console and cl ick Enter. Fol low the command l ine prompts tocomplete the uninstal lation process.



4. A dialog box prompts for a language. Speci fy the language to be usedfor the MicroStrategy uninstal lation and cl ick OK to proceed to the nextstep.

5. The MicroStrategy Instal lation Wizard opens with the Welcome pagedisplayed. Cl ick Next. The MicroStrategy Instal lation Selection pageopens.

6. Select Use an existing installation , and then select the instal lationfrom the drop-down l ist.

7. From the Selected Operation area, select one of the fol lowinguninstal lation options:

l Modify: Select this option to uninstal l only some of the MicroStrategyproducts instal led on the machine. Cl ick Next.

l Uninstall: Select this option to uninstal l al l MicroStrategy productsinstal led on the machine. Cl ick Next.

8. The License Agreement page opens. Review the l icense agreementand select I accept the terms of the license agreement, and thencl ick Next. The Customer Information page opens.

9. Type your user name, company name, and l icense key for yourinstal lation and cl ick Next. The Select Components page opens.

10. Clear the check box for al l MicroStrategy products that are to beuninstal led, and then cl ick Next.

You can also install products as part of the uninstallation by selecting thecheck box for any MicroStrategy product not previously installed.

11. On the Product Uninstal lation page, select the products to uninstal l .Cl ick Next.

12. On the Start instal ler operation page, veri fy the information and cl ickStart.



13. After uninstal lation is complete, a message is displayed. Cl ick Finish .



EXPORT ENGINECONFIGURATION



The fol lowing sections include steps for further configuration of the ExportEngine:

Installation of Export Engine

In versions of MicroStrategy prior to 2020, the Export Engine service isinstal led automatical ly by the MicroStrategy instal ler when selecting toinstal l the Intel l igence Server. The service wi l l use port 20100 by defaul t. InMicroStrategy 2020, you now have the option to instal l the Export Engineservice independently of the Intel l igence Server.

Windows InstallationsFor Windows instal lations prior to MicroStrategy 2020, the Export Engineservice wi l l begin automatical ly after the Intel l igence Server is started orafter instal lation; however, i f the server is restarted, the service must bestarted manual ly. Find and control this service through Windows TaskManager or Windows services panel , l isted as MSTR_PDFExporter.

For Windows instal lations on MicroStrategy 2020 or later, select theMicroStrategy Export checkbox to instal l the Export Engine. This al lows youto instal l the Export Engine on a stand-alone machine with al l otherfeatures unchecked.



Linux InstallationsFor Linux instal lations prior to MicroStrategy 2020, the Export EngineService wi l l begin automatical ly after the Intel l igence Server is started orafter instal lation; however, i f the server is restarted, the service must bestarted manual ly. For Linux instal lations on MicroStrategy 2020 or later, youcan instal l the Export Engine Service separately from the Intel l igenceServer.

The script to start the PDF Exporter service can be found under the pathinstall/Export/ . The commands for executing this script are:

l pdfexporter.sh start to start the PDF Exporter Service.

l pdfexporter.sh stop to stop the PDF Exporter Service.

l pdfexporter.sh restart to restart the PDF Exporter Service.



l pdfexporter.sh status to check the status the PDF ExporterService.

Connecting the Intelligence Server to an Export Engine on aDifferent MachineYou can configure the Intel l igence Server to use an export engine that isinstal led on a di fferent machine. You may want to do this i f you are using adedicated machine for the export engine or i f you are using RHEL 6.x foryour Intel l igence Server, which does not support the instal lation of theexport engine. The export engine is supported by Windows, RHEL 7.x, andSUSE 12 and 15.

To connect the Intel l igence Server to an export engine on a di fferentmachine, update the registry on the Intel l igence Server machine. Nochanges need to be made on the machine that has the export engineinstal led.

1. Open the registry.

On Windows, open up the Registry Edi tor.

On Linux, navigate to the <HOME_PATH> and open the fi leMSIReg.reg .

2. Navigate to the fol lowing location and update the registry key "host"

to the Ful ly Qual i fied Name or IP Address of the machine where theexport engine is located:

"[HKEY_LOCAL_MACHINE\SOFTWARE\MicroStrategy\DSS

Server\PDFExporter]":

"host"="localhost"

3. In the same location, update the registry key "port" to the portnumber that is running the export engine service.



During instal lation, the defaul t value for the service is 20100 . Tocalculate the port number, use "dword:" and the hexidecimal valueof the decimal to be used.

For example, 00004E84 converted from hexidecimal to decimal is20100 , which gives you the full value of "dword:00004E84" as shownin the example below:

"[HKEY_LOCAL_MACHINE\SOFTWARE\MicroStrategy\DSS

Server\PDFExporter]":

"port"=dword:00004E84


Export Engine: Puppeteer Integration

The Export Engine for MicroStrategy 2020 uses the headless browserPuppeteer to export dossiers to PDF. Al l other formatting requests forreports and Report Services Documents are performed by the Intel l igenceServer.

Puppeteer requires one of the following operating systems:

Windows :

l Server 2016

l Server 2012 R2

l Server 2012

l Server 2008 R2 SP1

Linux :

l RHEL 7 or above

l SUSE 12 or above

l Amazon Linux (based on RHEL 7)



Dependencies for Linux Operating SystemsWhen instal l ing MicroStrategy, the instal ler wi l l run a check to ensure thatal l necessary packages are instal led on your machine. You wi l l be noti fiedby the instal ler of any missing requirements that are needed.

Chrome Dependencies

The Puppeteer module contains Chrome binary which has certaindependencies depending on your operating system. Ensure that thefol lowing packages are instal led to ensure Chrome binary functionsproperly.

Chrome DependencyRHEL 7package

SUSE 12Package

Notes

l ibpthread.so.0

libdl.so.2

librt .so.1

libm.so.6

libc.so.6

ld-l inux-x86-64.so.2

glibc glibc

libX11.so.6 libX11 libX11-6

libX11-xcb.so.1 libX11 libX11-xcb1

libxcb.so.1 libxcb libxcb1

libXcomposite.so.1 libXcomposite l ibXcomposite1

libXcursor.so.1 libXcursor l ibXcursor1

libXdamage.so.1 libXdamage libXdamage1

libXext .so.6 libXext l ibXext6

libXf ixes.so.3 libXf ixes libXf ixes3




SUSE 12Package

Notes

l ibXi.so.6 libXi l ibXi6

libXrender.so.1 libXrender l ibXrender1

libXtst .so.6 libXtst l ibXtst6

libgobject-2.0.so.0 glib2 libgobject-2_0-0

libglib-2.0.so.0 glib2 libglib-2_0-0

libnss3.so nss mozil la-nssNSS >= 3.26required

libnssut i l3.so nss-ut i l mozil la-nss

libsmime3.so nss mozil la-nss

libnspr4.so nspr mozil la-nspr

l ibcups.so.2 cups-l ibs cups-l ibs

libdbus-1.so.3 dbus-l ibs libdbus-1-3

libexpat .so.1 expat l ibexpat1

libXss.so.1 libXScrnSaver l ibXss1

libXrandr.so.2 libXrandr l ibXrandr2

libgio-2.0.so.0 glib2 libgio-2_0-0

libasound.so.2 alsa-l ib l ibasound2

libpangocairo-1.0.so.0

libpango-1.0.so.0pango libpango-1_0-0

libcairo.so.2 cairo libcairo2

libatk-bridge-2.0.so.0 at-spi2-atk l ibatk-bridge-2_0-0

libgtk-3.so.0 libgdk-3.so.0

gtk3 libgtk-3-0




SUSE 12Package

Notes

l ibgdk_pixbuf-2.0.so.0 gdk-pixbuf2 libgdk_pixbuf-2_0-0

libgcc_s.so.1 libgcc libgcc_s1

Additional Packages for Amazon Linux

Amazon Linux is based on RHEL 7 and the dependency l ist of RHEL 7mentioned above can be appl ied to Amazon Linux. However, Amazon Linuxdoes not contain any graphical l ibrary packages (GTK3) in the Yumreposi tory. These packages must be instal led from the CentOS/Fedora Yumreposi tory.

Missing Package External Resource

atk atk-2.22.0-3.el7.x86_64.rpm

at-spi2-atk at-spi2-atk-2.22.0-2.el7.x86_64.rpm

at-spi2-core at-spi2-core-2.22.0-1.el7.x86_64.rpm

GConf2 GConf2-3.2.6-7. fc20.x86_64.rpm

libXScrnSaver l ibXScrnSaver-1.2.2-6. fc20.x86_64.rpm

libxkbcommon l ibxkbcommon-0.3.1-1. fc20.x86_64.rpm

libwayland-client l ibwayland-client-1.2.0-3. fc20.x86_64.rpm

libwayland-cursor l ibwayland-cursor-1.2.0-3. fc20.x86_64.rpm

gtk3 gtk3-3.10.4-1. fc20.x86_64.rpm

gdk-pixbuf2 gdk-pixbuf2-2.24.0-1. fc16.x86_64.rpm



Export Engine Configuration Properties

The configuration of the Export Engine service is handled through theapplication.properties fi le. The defaul t location is:

l Windows: C:\Program Files (x86)\MicroStrategy\Export

l Linux: /opt/mstr/MicroStrategy/install/Export

Application Core PropertiesYou must restart the PDF Exporter service i f these properties are changed.

Changing any of the below properties will require you to restart NEE, not justthe core properties.

Property Default Value Comments

server.host localhost

Used to generate the baseUrl used by therenderer.

Do not change this value.

server.port 20100 Port number of the service URL.

server.context-

path/PDFExporterService Context path of the service URL.

jvm.heapsize 1024Maximum memory usage by the serviceprocess in MB.

Subprocess Properties

PropertyDefaultValue

Comments

exporter.renderer.type Puppeteer




Comments

exporter.renderer.process.max

1/4 of thenumber ofCPU cores.(Min 2)

Maximum number of rendererprocesses.

exporter.renderer.path

Default isthe systempath.

The absolute path of therenderer.

exporter.renderer.file.folder

Systemtemporaryf i ledirectory.

Locat ion of temporary f i les wil l besaved.

exporter.script.path.puppeteerThe full path of puppeteer. js f i le.Set by install script .

nodejs.exec

The full path of node executablef i le. Set by install script . I f notset , NEE wil l use the globalinstalled node.

Renderer Properties


Comments

exporter.renderer.executionTi

meout300

Time limit in seconds before kil l ingphantomjs execut ion. I f you changethis value you must restart the service.

exporter.renderer.rendering.ti

meout60

Maximum wait t ime before complet ingrendering in seconds.

exporter.renderer.resource.ti 60 Maximum wait t ime for each resource




Comments

meout request in seconds.

exporter.resource.idletime 500Maximum wait t ime between tworesource requests in mil l iseconds.

exporter.internal.web.resourc

efalse

Whether to retrieve the web resourcesrequired during export ing from theexport engine.

This property has a higher priority thanexporter.web.url. forced,exporter.web.url, andexporter. l ibrary.url. I f this propertyvalue is set to t rue, exporter.web.urland exporter. l ibrary.url are not beused.

exporter.web.url.forced falseWhether exporter.web.url shouldalways be used instead of that f romIntell igence Server.

exporter.web.url

The URL of the web server which hasMap and D3 plug-ins installed. This isused to support scheduled export (DS)of Map and D3 content .

JSP web server format: ht tp(s): / /<hostorIP>:<port>/<webAppName>/servlet /mstrWeb

ASP web server format: ht tp(s):/ /<host orIP>:<port>/<webAppName>/asp/Main.aspx

exporter.library.urlLibrary server format: ht tp(s): / /<host orIP>:<port>/MicroStrategyLibrary/app/




Comments

logging.renderer.kafka t rueWhether to save the renderer log toKafka.

Logging Properties


logging.kafka.server 127.0.0.1Kafka server IP. I f you changethis value you must restart theservice.

logging.kafka.port 9092Kafka server port . I f you changethis value you must restart theservice.

logging.level.kafka info

Level of log to write to Kafka.The value of the property shouldbe error, t race, or info. I f youchange this value you mustrestart the service.

logging.kafka.filename NewExportEngine. logKafka log f i le name. I f youchange this value you mustrestart the service.

logging.file.filename NewExportEngine. logThe f i le name created by f i lelogger. (Fallback logging ifkafka is unavailable. )

logging.file.size 2 MBSize of log f i le for f i le logger.(The fall back logger when kafkais not available)



Miscellaneous Properties


exporter.pages.limit 1000Value to limit the number of pagesgenerated by the Export Engine. (-1indicates no limit ).

exporter.content.limit 200Maximum JSON length requestallowed in MB. The maximum valueof this property is 2048.

Spring Properties


spring.aop.auto t rueWhether to enable Spring AOP autoconf igurat ion. Changing this value isnot recommended.

spring.jmx.enabled t rueWhether to enable Spring Boot JMX.Changing this value is notrecommended.

logging.file.filename NewExportEngine. log

Enable Local Resource Loading for the Export Engine

Starting in 2019 Update 2, the export engine supports redirecting webresource requests to the export engine side. By defaul t, this feature isdisabled. To enable this feature, fol low the steps below.

1. Open the application.properties fi le and setexporter.internal.web.resource to true. See Export EngineConfiguration Properties for more information about this setting.



The configuration of the Export Engine service is handled through theapplication.properties fi le. The defaul t location is:

l Windows: C:\Program Files

(x86)\MicroStrategy\Export

l Linux: /opt/mstr/MicroStrategy/install/Export

2. Copy al l plugins instal led in Web to<PDFExportServiceRootFolder>/resources/plugins .

3. Copy al l plugins instal led in Library to<PDFExportServiceRootFolder>/resources/plugins .

4. Check to see i f any map keys are configured in<Web/LibraryRootFolder>/WEB-

INF/xml/config/mapConfig.xml . If they are, copymapConfig.xml into<PDFExportServiceRootFolder>/resources/WEB-

INF/xml/config/mapConfig.xml .

5. If there any images in <WebFolder>/images or<WebFolder>/VisFramework , you must copy them intoresources/images and resources/VisFramework in the rootfolder of the PDF Export Service.

6. Restart the PDF Export Service.

See knowledge base article 483235 to troubleshoot issues with the exportengine.

When you install new plugin widgets, you must copy them toresources/plugins in the Web, Library, and PDF Export Service rootfolders.

When you configure map keys for ESRI, Google, or Geospatial Services, youmust copy mapConfig.xml to WEB-INF/xml/config in the Web,Library, and PDF Export Service root folders.


https://community.microstrategy.com/s/article/Troubleshooting-the-New-Export-Engine-in-2019-Update-2


Connecting to Databases andData Sources

This appendix describes the configuration parameters required to connectMicroStrategy to various databases and data sources. Data Source Names(DSN) can be created using the MicroStrategy Connectivi ty Wizard, and inLinux, you can also configure parameters wi th the odbc.ini fi le. Thisappendix discusses the fol lowing topics:

l Creating DSNs for Speci fic Data Sources, page 747: Configurationinformation required to create a DSN for data sources avai lable throughthe Connectivi ty Wizard.

l Creating Database Connections in Web, page 785: Steps to define a newdatabase connection directly from Web for users to import data from adata source into MicroStrategy.

l Configuring ODBC Parameters wi th ODBC.ini , page 788: Configurationinformation required to configure data sources using the odbc.ini fi le ina Linux environment.

Creating DSNs for Specific Data Sources

You can create a DSN for data sources avai lable through the Connectivi tyWizard. The fol lowing table l ists the information required for each type ofdata source when you create a new DSN using the Connectivi ty Wizard. Forinformation on what operating systems each ODBC driver is certi fied for,see Certi fied ODBC Drivers for MicroStrategy Intel l igence Server, page123.



l For ODBC-speci fic driver detai ls, refer to the di fferent ODBC driversections below the table.

l You can create a DSN from the command l ine version of the Connectivi tyWizard in Linux. Browse to HOME_PATH/bin , where HOME_PATH is thedirectory you speci fied as the home directory during instal lation. In theconsole window, type ./mstrconnectwiz -h , then press Enter. Thiscommand displays command l ine syntax and examples for di fferentdatabase platforms. Create your command based on the syntax andexamples displayed. Once you run your command, a DSN is created inthe odbc.ini fi le.

Driver Details

MicroStrategy ODBC Driverfor DB2 Wire Protocol forWindows and Linux, page751

• Data source name

• Host name

• Database name

• Port number

MicroStrategy ODBC Driverfor DB2 Wire Protocol forIBM Db2 for i for Windowsand Linux, page 751


• IP address

• Collect ion

• Locat ion

• Isolat ion level

• Package owner

• TCP port (446 in most cases)

MicroStrategy ODBC Driverfor IBM Db2 for z/OS forWindows and Linux, page752


• IP address

• Collect ion

• Locat ion

• Package collect ion



Driver Details

• Package owner

• TCP port (446 in most cases)

MicroStrategy ODBC Driverfor Microsoft SQL Server forWindows and Linux, page753


• Host name

• Port number

• Database name

• Use Windows NT Authent icat ion for login ID

• Enable SQL Database (Azure) support

MicroStrategy ODBC Driverfor MongoDB for Windowsand Linux, page 756


• Host name

• Port number

• Database name

MicroStrategy ODBC Driverfor Oracle Wire Protocol forWindows and Linux, page756

Data source name and either:

Standard connect ion:

• Host name

• Port number (in most cases, 1521)

• SID (MicroStrategy default is ORCL)

• Service name

• Alternate servers

TNSNames connect ion:

• Server name

• TNSNames f i le

MicroStrategy ODBC Driverfor SAP Sybase ASE WireProtocol for Windows andLinux


• Network address

• Database name



Driver Details

• Enable unicode support

MicroStrategy ODBC Driverfor SequeLink, page 758

The MicroStrategy ODBC Driver for SequeLink allows you toaccess Microsof t Access databases or Microsof t Excel f i lesstored on a Windows machine from an Intell igence Serverhosted on a Linux machine.

MicroStrategy ODBC Driverfor Salesforce, page 763

The MicroStrategy ODBC Driver for Salesforce allows you toaccess resources on Salesforce.com, from an Intell igenceServer hosted on a Linux machine.

This section also provides information on how to instal l and configuredrivers from other vendors wi th MicroStrategy:

l ODBC Driver for Sybase Adaptive Server IQ for Linux

l ODBC Driver for Teradata for Linux, page 764

l ODBC Driver for Informix 8 for Linux, page 765

l ODBC Driver for Netezza for Linux, page 768

l ODBC Driver for MySQL for Linux, page 769

l ODBC Driver for Aster Database for Linux, page 772

l ODBC Driver for DataDirect Cloud for Linux, page 774

l ODBC Driver for Vertica for Linux, page 776

l ODBC Driver for SAP HANA for Windows and Linux, page 778

l Other Data Sources and Relational Databases for Windows, page 783

MicroStrategy ODBC Driver for Amazon Redshift WireProtocol for Windows and LinuxThe fol lowing information is required for setting up the driver connection forthe MicroStrategy ODBC Driver for Amazon Redshi ft Wire Protocol :



l Data Source Name: A name to identi fy the Amazon Redshi ft data sourceconfiguration in MicroStrategy. For example, Finance or Redshift-1can serve to identi fy the connection.

l Host Name: The server name or IP address of the machine on which theAmazon Redshi ft data source resides. Contact your system administratorfor the server name or IP address.

l Port Number: The port number for the connection. In most cases, thedefaul t port number is 5439, but you should check with your databaseadministrator for the correct number.

l Database Name: The name of the database to connect to by defaul t. Thedatabase administrator assigns the database name.

MicroStrategy ODBC Driver for DB2 Wire Protocol forWindows and LinuxThe fol lowing information is required for setting up the driver connection forMicroStrategy ODBC Driver for DB2 when running against IBM Db2:

l Data Source Name: A name to identi fy the Db2 data source configurationin MicroStrategy. For example, Finance or Db2-Serv1 can serve toidenti fy the connection.

l Host Name: The name of the machine that runs the Db2 server.

l Database Name: The name of the database to connect to by defaul t,which is assigned by the database administrator.

l Port Number: The Db2 server l istener's port number. In most cases, thedefaul t port number is 50000, but check with your database administratorfor the correct number.

MicroStrategy ODBC Driver for DB2 Wire Protocol for IBMDb2 for i for Windows and LinuxThe fol lowing information is required for setting up the driver connection forMicroStrategy ODBC Driver for DB2 Wire Protocol for IBM Db2 for i :



l Data Source Name: A name to identi fy the Db2 data source configurationin MicroStrategy. For example, Finance or Db2-1 can serve to identi fy theconnection.

l IP Address: The IP Address of the machine where the catalog tables arestored. This can be ei ther a numeric address such as 123.456.789.98 ,or a host name. If you use a host name, i t must be located in the HOSTS

fi le of the machine or a DNS server.

l Collection : The name that identi fies a logical group of database objects.

l Location : The Db2 location name, which is defined during the local Db2instal lation.

l Isolation Level: The method by which locks are acquired and released bythe system.

l Package Owner: The package's AuthID i f you want to speci fy a fixed userto create and modi fy the packages on the database. The AuthID musthave authori ty to execute al l the SQL in the package.

l TCP Port: The Db2 DRDA l istener process's port number on the serverhost machine provided by your database administrator. The defaul t portnumber is usual ly 446.

MicroStrategy ODBC Driver for IBM Db2 for z/OS for Windowsand LinuxThe fol lowing information is required for setting up the driver connection forMicroStrategy ODBC Driver for IBM Db2 for z/OS.

l Data Source Name: A name to identi fy the Db2 z/OS data sourceconfiguration in MicroStrategy. For example, Finance or Db2z/OS-1 canserve to identi fy the connection.

l IP Address: The IP Address of the machine where the catalog tables arestored. This can be ei ther a numeric address such as 123.456.789.98 ,



or a host name. If you use a host name, i t must be located in the HOSTS

fi le of the machine or a DNS server.

l Collection : The name that identi fies a logical group of database objects,which is also the current schema. On Db2 z/OS, the user ID should beused as the Col lection.

l Location : The Db2 z/OS location name, which is defined during the localDb2 z/OS instal lation. To determine the Db2 location, you can run thecommand DISPLAY DDF .

l Package Collection : The col lection or location name where bindpackages are created and stored for searching purposes.

l Package Owner (Optional): The package's AuthID i f you want to speci fya fixed user to create and modi fy the packages on the database. TheAuthID must have authori ty to execute al l the SQL in the package.

l TCP Port: The Db2 DRDA l istener process's port number on the serverhost machine provided by your database administrator. The defaul t portnumber is usual ly 446.

MicroStrategy ODBC Driver for Microsoft SQL Server forWindows and LinuxThe fol lowing information is required for setting up the driver connection forthe MicroStrategy-branded version of the Microsoft SQL Server driver:

l Data Source Name: A name to identi fy the Microsoft SQL Server datasource configuration in MicroStrategy. For example, Personnel orSQLServer-1 can serve to identi fy the connection.

l Host Name: Enter the name of a SQL Server on your network. Forexample, i f your network supports named servers, you can speci fy anaddress such as SQLServer-1 . You can also speci fy the IP addresssuch as 123.45.678.998 . Contact your system administrator for theserver name or IP address.



Addi tional ly, i f you use named instances to distinguish SQL Serverdatabases, you can include the named instance along with ei ther theserver name or IP address using the formatServerName\NamedInstance or IPAddress\NamedInstance . Thefol lowing are examples of providing the server name for your SQL Serverdatabase:

l SQLServer-1\Instance1

l 123.45.678.998\Instance1

l Port Number: The port number for the connection. The defaul t portnumber for SQL Server is usual ly 1433. Check with your databaseadministrator for the correct number.


l Use Windows NT Authentication for login ID : This option is avai lable i fyou are configuring your connection on Windows. Select this check box touse Windows NT authentication to pass a user's credentials on theWindows machine to execute against a SQL Server database.

If you use Windows NT authentication with SQL Server, you must enterthe Windows NT account user name and password in the ServiceManager. For information on the Service Manager, see the SystemAdministration Guide.

Inserting date data into SQL Server 2000 tables can cause errors if thesystem's Regional Settings are not set properly. Ensure that the date formatis defined to be in an English format.

l Enable Azure: Defines whether the DSN is created to support SQL Azure.Select this checkbox i f the DSN is used to access a SQL Azure datasource. See KB483835 for more information on this setting.




https://community.microstrategy.com/s/article/As-of-MicroStrategy-2019-Update-3-the-latest-SQL-Server-ODBC-driver-allows-you-to-uncheck-the-Enable-Azure-setting-to-connect-to-an-Azure-SQL-Data-Warehouse


l Enable SSL encryption :

l Windows: Open the DSN in the ODBC Administrator and edi t theSecuri ty tab so that Encryption Method is set to 'SSL' and the ValidateServer Certificate is unchecked as shown below:

l Linux: Edi t the odbc.ini fi le and set the fol lowing values in the DSN:

l EncryptionMethod=1

l ValidateServerCertificate=0



MicroStrategy ODBC Driver for MongoDB for Windows andLinuxThe fol lowing information is required for setting up the driver connection forthe MicroStrategy ODBC Driver for MongoDB:

l Data Source Name: A name to identi fy the MongoDB data sourceconfiguration in MicroStrategy. For example, Finance or MongoDB-1can serve to identi fy the connection.

l Host Name: The server name or IP address of the machine on which theMongoDB data source resides. Contact your system administrator for theserver name or IP address.

l Port Number: The port number for the connection. Check with yourdatabase administrator for the correct number.


l Schema Definition Path : The path where configuration fi les that definethe relational map of native data are stored. These configuration fi les arecreated in this location when fi rst connecting to the data source and thenused for subsequent connections.

MicroStrategy ODBC Driver for Oracle Wire Protocol forWindows and LinuxThe fol lowing information is required for setting up the driver connection forMicroStrategy ODBC driver for Oracle Wire Protocol :

l Data Source Name: Enter a name to identi fy the Oracle data sourceconfiguration in MicroStrategy. For example, Finance or Oracle-1 canserve to identi fy the connection. A DSN is required for any Oracle WireProtocol connection. Depending on whether you want to use a standardconnection or a TNSNames connection, refer to one of the fol lowing l istsof options below:



l Standard Connection : A standard connection is configured throughOracle Wire Protocol wi th the fol lowing connection parameters:

l Host Name: The name of the Oracle server to be accessed. Forexample, the server could be named Oracle-1 or an IP address such as123.456.789.98 .

l Port Number: The Oracle l istener port number provided by yourdatabase administrator. The defaul t port number is usual ly 1521.

l One of the fol lowing parameters; which one you choose is up to yourpersonal preference:

l SID : The Oracle System Identi fier for the instance of Oracle runningon the server. The defaul t SID is usual ly ORCL .

l Service Name: The global database name, which includes thedatabase name and the domain name. For example, i f your databasename is finance and i ts domain is business.com the servicename is finance.business.com .

l Alternate Servers: A l ist of al ternate database servers to enableconnection fai lover for the driver. If the primary database server enteredas the SID or service name is unavai lable, a connection to the serversin this l ist is attempted unti l a connection can be establ ished. You canl ist the servers in SID or service name format, as shown in the fol lowingexamples:

l Using an SID: (HostName=DB_server_name:PortNumber=1526:SID=ORCL)

l Using a Service Name: (HostName=DB_server_name:PortNumber=1526:ServiceName=service.name.com)

l TNSNames Connection : A TNSNames connection uses aTNSNAMES.ORA fi le to retrieve host, port number, and SID informationfrom a server (al ias or Oracle net service name) l isted in theTNSNAMES.ORA fi le. A TNSNames connection requires the fol lowing



parameters:

l Server Name: A server name, which is included in a TNSNAMES.ORA

fi le included in the TNSNames Fi le text box below.

l TNSNames File: The location of your TNSNAMES.ORA fi le. Make sureto enter the enti re path to the TNSNAMES.ORA fi le, including the fi lename itsel f. You can speci fy mul tiple TNSNAMES.ORA fi les.

When connecting to an installation of Oracle as metadata, it is imperative thatthe ODBC driver is configured to use the character set parameters as theOracle metadata installation. This is controlled through the IANAAppCodePageoption in the odbc.ini file.

Follow these steps to determine the character set of your Oracle metadatainstallation and adjust the odbc.ini files:

1. Open the MicroStrategy ODBC Test Tool and connect to your database.

2. Run the following query select * from NLS_DATABASE_

PARAMETERS .

3. Note the value returned for the NLS_CHARACTERSET parameter.

4. Find the NLS_CHARACTERSET value in the IANA Registry found athttp://www.iana.org/assignments/character-sets/character-sets.xhtml .

5. Open the odbc.ini file and set the IANAAppCodePage value to theassigned MIBenum value from the IANA registry.

MicroStrategy ODBC Driver for SequeLinkThe MicroStrategy ODBC Driver for SequeLink al lows you to accessMicrosoft Access databases or Microsoft Excel fi les stored on a Windowsmachine from an Intel l igence Server hosted on a Linux machine. The stepsbelow show you how to perform the necessary configurations on the variousmachines to support this type of configuration.


http://www.iana.org/assignments/character-sets/character-sets.xhtml

http://www.iana.org/assignments/character-sets/character-sets.xhtml


Preparing the Microsoft Access Database from an IntelligenceServer Hosted on Linux

You must complete the steps below to access an Access database storedon a Windows machine from an Intel l igence Server hosted on a Linuxmachine.

On the Windows machine where the Access database is stored, you must createa DSN to connect to the Access database. For instructions on creating a DSN,see Creating a DSN for a data source, page 375 .

1. On the Windows machine that stores the Access database to connectto, instal l the SequeLink ODBC Socket Server. This can be instal ledas part of a MicroStrategy instal lation, and is included in the Othercomponents options of the MicroStrategy Product Sui te (see SelectFeatures, page 146).

The SequeLink ODBC Socket Server that is provided with aMicroStrategy installation is for exclusive use with the MicroStrategyProduct Suite. You are not licensed to use this product with anyapplication other than MicroStrategy products.

2. On the Windows machine where you instal led the SequeLink ODBCSocket Server, go to the SequeLink Management Console Snap-in.

3. Under Console Root, go to SequeLink 6.0 Manager > Connected toSLAgent55 > SequeLink Services > SLSocket55 > Configuration >Data Source Settings.

4. From the Action menu, go to New > Data Source.

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-cl ick DataSourceSOCODBCConnStr and select Properties.The DataSourceSOCODBCConnStr Properties dialog box opens.



8. In the Value field, type DSN=AccessDSN , where AccessDSN is theDSN you created to connect to your Access database. This is di fferentfrom the data source you created as part of the steps to configure theSequeLink ODBC Socket Server.

9. Cl ick OK .

10. Within the same data source, select User Security.

11. Right cl ick DataSourceLogonMethod and select Properties.

12. From the Value drop-down l ist, select Anonymous.

13. Cl ick OK .

14. Right-cl ick the data source, point to All Tasks, and select Saveconfiguration .

15. On the Linux machine that hosts your Intel l igence Server, you mustconfigure the MicroStrategy ODBC driver for SequeLink to connect tothe Access database. For instructions on how to perform thisconfiguration, see Configuring the MicroStrategy ODBC Driver forSequeLink, page 762.

Preparing the Microsoft Excel File from an Intelligence ServerHosted on Linux

You must complete the steps below to access Excel fi les stored on aWindows machine from an Intel l igence server hosted on a Linux machine

On the Windows machine where the Excel file is stored, you must prepare theExcel file as a valid data source. For instructions to prepare an Excel file, seePrepare an Excel fi le as a val id data source, page 784 .

On the Windows machine where the Excel file is stored, you must create a DSN toconnect to the Excel file. For instructions to create a DSN for an Excel file, seeUse your Excel fi le as a data source, page 785 .



1. On the Windows machine that stores the Excel fi les to connect to,instal l the SequeLink ODBC Socket Server. This can be instal led aspart of a MicroStrategy instal lation, and is included in the Othercomponents options of the MicroStrategy Product Sui te (see SelectFeatures, page 146).

2. On the Windows machine where you instal led the SequeLink ODBCSocket Server, go to the SequeLink Management Console Snap-In.

3. Under Console Root, expand SequeLink 6.0 Manager, expandConnected to SLAgent55, expand SequeLink Services, expandSLSocket55, expand Configuration , and then select Data SourceSettings.

4. From the Action menu, point to New, and select Data Source. A newdata 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-cl ick DataSourceSOCODBCConnStr and select Properties.The DataSourceSOCODBCConnStr Properties dialog box opens.

8. In the Value field, type DSN=ExcelDSN , where ExcelDSN is the DSNyou created to connect to your Excel fi le. This is di fferent from thatdata source you created as part of the steps to configure theSequeLink ODBC Socket Server.

9. Cl ick OK .

10. Within the same data source, select User Security.

11. Right cl ick DataSourceLogonMethod and select Properties. TheDataSourceLogonMethod Properties dialog box opens.



12. From the Value drop-down l ist, select Anonymous. This al lowsconnection to the Excel fi le wi thout using a user name and password.

13. Cl ick OK .

14. Right-cl ick the data source, point to All Tasks, and select Saveconfiguration .

15. On the Linux machine that hosts your Intel l igence Server, you mustconfigure the MicroStrategy ODBC driver for SequeLink to connect tothe Excel fi les. For instructions on how to perform this configuration,see Configuring the MicroStrategy ODBC Driver for SequeLink, page762.

Configuring the MicroStrategy ODBC Driver for SequeLink

The steps below show you how to configure the MicroStrategy ODBC driverfor SequeLink to access ei ther Microsoft Access databases or Excel fi lesstored on a Windows machine:

1. On the Linux machine that hosts Intel l igence Server, browse to HOME_

PATH where HOME_PATH is the directory you speci fied as the HomeDirectory during instal lation.

2. Open the odbc.ini.example fi le and find the section that starts wi th[SequeLinkODBC] . Copy this section into the odbc.ini fi le. Forinformation on the parameters, refer to DataDirect's documentation athttp://media.datadirect.com/download/docs/odbc/al lodbc/help.html .

3. Edi t the parameters l isted below:

l Host: Type the IP address of the Windows machine that stores theAccess database or Excel fi les.

l ServerDataSource: Type the name of the data source for the Accessdatabase or Excel fi le to connect to as a data source. This is thename of the data source that you defined whi le configuring theSequeLink ODBC Socket Server, as shown in the example image


http://media.datadirect.com/download/docs/odbc/allodbc/help.html


below:

4. Save the odbc.ini fi le.


MicroStrategy ODBC Driver for SalesforceThe MicroStrategy ODBC Driver for Salesforce al lows you to accessresources on Salesforce.com, from an Intel l igence Server hosted on aWindows or Linux machine.

You can also use MicroStrategy Web and Import Data to integrateSalesforce.com data into MicroStrategy. For steps to configure a connectionto Salesforce.com to support this type of integration, see Configuring Third-Party Data Sources for Importing Data, page 542 .

The fol lowing information is required for setting up the driver connection forthe MicroStrategy ODBC driver for Salesforce:

l Data Source Name: A name to identi fy the Salesforce data sourceconfiguration in MicroStrategy. For example, Finance or Salesforce-1 canserve to identi fy the connection.

l Host Name: The URL used to log in to the Salesforce.com system. Youcan keep the defaul t of login.salesforce.com to connect to the production



instance. However, you can also connect to other systems such astest.salesforce.com if you are connecting to testing environments.

If you attempt to test the connection to your Salesforce.com system, thepassword syntax is PasswordSecuritytoken , where Password is thepassword for the user account and Securitytoken is the addi tionalsecuri ty token required to access Salesforce.com. Do not use any spaces orother characters to separate the password and securi ty token. As part ofconfiguring a connection to your Salesforce.com system, you can includethe password and securi ty token as part of the database login, which is acomponent of a database instance used to access the DSN inMicroStrategy. For steps to create a database login, which you can use toprovide the Salesforce.com password and securi ty token, see Creating adatabase login.

ODBC Driver for Teradata for LinuxODBC driver for Teradata is not a MicroStrategy-branded driver. Thefol lowing steps show how to configure the ODBC driver for Teradata.

For information on setting up an ODBC driver for Teradata through theConnectivi ty Wizard on Windows, see Other Data Sources and RelationalDatabases for Windows, page 783.

To Configure the ODBC Driver for Teradata

Instal l the ODBC Driver for Teradata for the correct operating system. Forinformation on instal lation, refer to the product documentation provideddirectly by the database vendor.

The directory where the ODBC driver for Teradata is installed should alwaysbe accessible to MicroStrategy Intelligence Server.

You can enable Teradata Parallel Transporter for your connections toTeradata. This can improve performance when retrieving large amounts ofdata, typically 0.5 Gigabytes and larger, which can occur most commonly in



MicroStrategy when publishing Intelligent Cubes. For steps to configure thissupport, refer to the MicroStrategy Web Help .

To Configure a DSN



2. Open the odbc.ini.example fi le and find the section that starts wi th[TERADATA_SERVER] . Copy that section into the odbc.ini fi le inthe [ODBC Data Sources] section.

3. Edi t the DSN parameters DBCName, Database, and Defaul tDatabase,and modi fy the value of MSTR_TERADATA_PATH with the location ofthe directory where the ODBC Driver for Teradata is instal led.

You can also edi t the parameters in the odbc.ini fi le to reflect yourenvironment. To support parameterized queries, define theEnableExtendedStmtInfo parameter asEnableExtendedStmtInfo=Yes . For information on the otheravai lable parameters, refer to your thi rd-party Teradata driverdocumentation. This can often be found along with the driverinstal lation.


ODBC Driver for Informix 8 for LinuxThe MicroStrategy ODBC Driver for Informix 8 is already instal led in theINSTALL_PATH/lib directory.

The ODBC Driver for Informix 8 for Linux is a MicroStrategy-branded ODBCdriver, but it is not accessible through the Connectiv ity Wizard.

However, the Informix Cl ient Software Developer's Ki t (CSDK) must beinstal led before you create a DSN. This software is not included in theMicroStrategy product sui te instal lation and must be obtained through the


https://www2.microstrategy.com/producthelp/2020/MSTRWeb/WebHelp/Lang_1033/index.htm


database vendor or a thi rd party. For information on instal lation, refer to theproduct documentation provided directly by the database vendor.

The fol lowing steps show how to configure the MicroStrategy ODBC driverfor Informix 8.

To configure ODBC Driver for Informix 8

Begin by instal l ing the Informix CSDK.

The directory where CSDK is installed should always be accessible toIntelligence Server.

The fol lowing set of instructions are divided into two sections: how toconfigure the environment and how to configure a DSN.

To Configure the Environment


is the speci fied home directory during instal lation.Browse to the folderenv .

2. Add Wri te privi leges to the ODBC.sh fi le by entering the fol lowingcommand:chmod u+w ODBC.sh

3. Edi t the ODBC.sh fi le and make the fol lowing changes:

l Provide the location of the directory where the Informix Cl ientSoftware Developer's Ki t (CSDK) is instal led. The fol lowingdefini tion is included:

INFORMIXDIR='<INFORMIXDIR>'

Replace this <INFORMIXDIR> placeholder wi th the directory path.Do not modi fy any other occurrences of <INFORMIXDIR> withinodbc.sh .



l Provide the name of the Informix Server. The fol lowing defini tion isincluded:

INFORMIXSERVER='<INFORMIXSERVER>'

Replace this <INFORMIXSERVER> placeholder wi th the directorypath.

This value is chosen from the list in<INFORMIXDIR>/etc/sqlhosts .

Do not modi fy any other occurrences of <INFORMIXSERVER> withinodbc.sh .

4. Save the ODBC.sh fi le and remove Wri te privi leges from the fi le byentering the fol lowing command:chmod a-w ODBC.sh

To Configure a DSN



2. Open the odbc.ini.example fi le and search for the section thatstarts wi th [IBM INFORMIX] . Copy the section into the odbc.ini

fi le.

3. Edi t the DSN parameters Database, Servername, and Service. Forinformation on the avai lable parameters, refer to your thi rd-partyTeradata driver documentation. This can often be found along with thedriver instal lation.


For detai ls on these DSN parameters, refer to the product documentationprovided directly by the database vendor.



ODBC Driver for Netezza for LinuxODBC driver for Netezza is not a MicroStrategy-branded driver. Thefol lowing steps show how to configure ODBC driver for Netezza.

You must modi fy odbcinst.ini fi le and odbc.ini fi le to create the DSNfor Netezza.

To Configure ODBC Driver for Netezza

Begin by instal l ing the ODBC Driver for Netezza for the correct operatingsystem. For information on instal lation, refer to the product documentationprovided directly by the database vendor.

The directory where Netezza is installed should always be accessible toMicroStrategy Intelligence Server.

The fol lowing set of instructions are divided into two sections: how tomodi fy the odbcinst.ini fi le and how to modi fy the odbc.ini fi le.

To Modify the odbcinst.ini File


is the directory you speci fied as the home directory during instal lation.

2. Edi t the odbcinst.ini fi le and replace al l instances of <NETEZZA_ODBC_DIR> with the location of the directory where the NetezzaODBC Driver is instal led. An example of this is as fol lows:

If the original path is:

Driver = /<NETEZZA_ODBC_DIR>/lib64/libnzodbc.so

Then the modi fied path wi l l be:

Driver = /usr/odbc/netezzahome/lib64/libnzodbc.so

3. Save the odbcinst.ini fi le.



To Modify the odbc.ini File

1. Open the odbc.ini.example fi le and search for the section thatstarts wi th [IBM NETEZZA] .

2. Open the MicroStrategy odbc.ini fi le.

3. Copy and paste the contents from the odbc.ini.example fi le foryour Netezza ODBC driver. You should paste the contents of the DSNexactly as they appear in the example fi le.

4. Make the fol lowing changes to the copied sample fi le:

l Modify the driver location to match the location of the instal ledNetezza ODBC Driver.

l Change the database, server name, user name, and password, andany other relevant parameters to match the information for yourdatabase. For information on the avai lable parameters, refer to yourthi rd-party Netezza driver documentation. This can often be foundalong with the driver instal lation.


For detai ls on these DSN parameters, refer to the product documentationprovided by the database vendor.

ODBC Driver for MySQL for LinuxThe ODBC driver for MySQL is not a MicroStrategy-branded driver. Thefol lowing steps show how to configure the ODBC driver for MySQL, which iscerti fied for the Linux operating system.

You must modi fy the odbc.ini fi le to create the DSN for MySQL.

The third-party product(s) discussed in the procedure below is manufacturedby vendors independent of MicroStrategy. MicroStrategy makes no warranty,express, implied or otherwise, regarding this product, including itsperformance or reliability .



To configure ODBC driver for MySQL

Begin by instal l ing the 64-bi t ODBC Driver for MySQL for the Linuxoperating system, found at the hyperl inkhttp://dev.mysql .com/downloads/connector/odbc/. This si te is val id as of therelease of this manual . For information on instal lation, refer to the productdocumentation provided by the database vendor.

l Ensure that the driver fi les are instal led to the /usr/lib directory.

l For exact version numbers of MySQL drivers certi fied with MicroStrategy,refer to the MicroStrategy General Information Readme.

The fol lowing set of instructions are divided into two sections: how todefine the location of driver fi les and how to modi fy the odbc.ini fi le.

To Define the Location of the Driver Files


is the directory you speci fied as the Home Directory duringinstal lation. Browse to the folder env .


3. Edi t the ODBC.sh fi le and provide the location of the directory wherethe MySQL driver is instal led. Within the ODBC.sh fi le, the fol lowingdefini tion is included:

MYSQL_PATH='<MYSQL_PATH>'

Replace this <MYSQL_PATH> placeholder wi th the location of wherethe MySQL driver is instal led. Do not modi fy any other occurrences of<MYSQL_PATH> within odbc.sh .

4. Save the ODBC.sh fi le and remove Wri te privi leges from the fi le byentering the fol lowing command:

chmod a-w ODBC.sh


http://dev.mysql.com/downloads/connector/odbc/





2. Open the odbc.ini.example fi le and search for the section thatstarts wi th [MySQL] .


4. Copy and paste the contents from the odbc.ini.example fi le foryour MySQL ODBC driver. You should paste the contents of the DSNexactly as they appear in the example fi le.


l Modify the <MYSQL_ODBC_DIR> placeholder in the driver location tomatch the location of the instal led MySQL ODBC Driver.

l Change the database, server name, user name, password, and anyother relevant parameters to match the information for your database.For information on the avai lable parameters, refer to your thi rd-partyMySQL driver documentation. This can often be found along with thedriver instal lation.

Ensure that there is no white space between the equals sign (=) whichseparates the parameter and its value.


You can test a connection to your MySQL database with the MicroStrategy DBQuery Tool.

This completes the steps to create a DSN and configure an ODBC driver forMySQL. To create a database instance and database connection, seeCreating a database instance, page 443 and Creating a databaseconnection, page 447.



ODBC Driver for Aster Database for LinuxThe ODBC driver for Aster Database is not a MicroStrategy-branded driver.The fol lowing steps show how to configure the ODBC driver for AsterDatabase for Linux.

You must modi fy the odbc.ini fi le to create the DSN for Aster.


To Configure ODBC Driver for Aster Database

Begin by instal l ing the Aster ODBC Driver for the Linux operating system.For information on instal lation, refer to the product documentation providedby the database vendor.

l The path to the instal lation location you choose for the ODBC driver isused later in this procedure as the value for the Driver parameter in theodbc.ini fi le.

l For exact version numbers of Aster drivers certi fied with MicroStrategy,refer to the MicroStrategy General Information Readme.

The fol lowing set of instructions are divided into two sections: how toconfigure the environment and how to modi fy the odbc.ini fi le.



is the speci fied home directory during instal lation. Browse to the folderenv .




3. Edi t the ODBC.sh fi le and provide the location of the Aster l ibraryinstal lation. Within the ODBC.sh fi le, the fol lowing defini tion isincluded:

ASTER_PATH='<ASTER_PATH>'

Replace this <ASTER_PATH> placeholder wi th the location of theAster l ibrary instal lation. Do not modi fy any other occurrences of<ASTER_PATH> within odbc.sh .





2. Open the odbc.ini.example fi le and search for the section thatstarts wi th [Aster Database] .


4. Copy and paste the contents from the odbc.ini.example fi le foryour Aster ODBC driver. You should paste the contents of the DSNexactly as they appear in the example fi le.


l Modify the driver location to match the location of the instal led AsterODBC Driver.

l Change the database, server name, user name, password, and anyother relevant parameters to match the information for your database.For information on the avai lable parameters, refer to your thi rd-partyAster Database driver documentation. This can often be found alongwith the driver instal lation.





This completes the steps to create a DSN and configure an ODBC driver forAster Database.

ODBC Driver for DataDirect Cloud for LinuxThe ODBC driver for DataDirect Cloud is not a MicroStrategy-brandeddriver. The fol lowing steps show how to configure the ODBC driver forDataDirect Cloud for Linux.


To Configure ODBC Driver for DataDirect Cloud

Begin by instal l ing the DataDirect Cloud ODBC Driver for the Linuxoperating system. For information on instal lation, refer to the productdocumentation provided by the database vendor.

l The path to the instal lation location you choose for the ODBC driver isused later in this procedure as the value for the Driver parameter in theodbc.ini fi le.

l For exact version numbers of DataDirect Cloud drivers certi fied withMicroStrategy, refer to the MicroStrategy General Information Readme.








3. Edi t the ODBC.sh fi le and provide the location of the DataDirect CloudODBC driver fi les. Within the ODBC.sh fi le, the fol lowing defini tion isincluded:

DataDirectCloud_PATH='<DataDirectCloud_PATH>'

Replace this <DataDirectCloud_PATH> placeholder wi th thelocation of the DataDirect Cloud ODBC driver fi les. Do not modi fy anyother occurrences of <DataDirectCloud_PATH> within odbc.sh .


chmod a-w ODBC.sh




2. Open the odbc.ini.example fi le and search for the section thatstarts wi th [DataDirect Cloud] .


4. Copy and paste the contents from the odbc.ini.example fi le foryour DataDirect Cloud ODBC driver. You should paste the contents ofthe DSN exactly as they appear in the example fi le.




l Modify the driver location to match the location of the instal ledDataDirect Cloud ODBC Driver.

l Change the database, server name, user name, password, and anyother relevant parameters to match the information for your database.For information on the avai lable parameters, refer to your thi rd-partyDataDirect Cloud driver documentation. This can often be foundalong with the driver instal lation.



This completes the steps to create a DSN and configure an ODBC driver forDataDirect Cloud.

ODBC Driver for Vertica for LinuxThe ODBC driver for Vertica is not a MicroStrategy-branded driver. Thefol lowing steps show how to configure the ODBC driver for Vertica forLinux.

You must modi fy the odbc.ini fi le to create the DSN for Vertica.


To Configure ODBC Driver for Vertica

Begin by instal l ing the ODBC Driver for Vertica for the Linux operatingsystem. For information on instal lation, refer to the product documentationprovided by the database vendor.



The path to the installation location you choose for the ODBC driver is usedlater in this procedure as the value for the Driver parameter in the odbc.inifile.




is the speci fied home directory during instal lation. Browse to the folderenv .


3. Edi t the ODBC.sh fi le and provide the location of the vertica.ini

fi le. Within the ODBC.sh fi le, the fol lowing defini tion is included:

VERTICAINI='<VERTICAINI_PATH>'

Replace this <VERTICAINI_PATH> placeholder wi th the location ofthe vertica.ini fi le. Do not modi fy any other occurrences of<VERTICAINI_PATH> within odbc.sh .


chmod a-w ODBC.sh




2. Open the odbc.ini.example fi le and search for the section thatstarts wi th [HP VERTICA] .




4. Copy and paste the contents from the odbc.ini.example fi le foryour Vertica ODBC driver. You should paste the contents of the DSNexactly as they appear in the example fi le.


l Modify the driver location to match the location of the instal ledVertica ODBC Driver.

l Change the database, server name, user name, password, and anyother relevant parameters to match the information for your database.For information on the avai lable parameters, refer to your thi rd-partyVertica driver documentation. This can often be found along with thedriver instal lation.



This completes the steps to create a DSN and configure an ODBC driver forVertica.

ODBC Driver for SAP HANA for Windows and LinuxThe ODBC driver for SAP HANA is not a MicroStrategy-branded driver. Thefol lowing steps show how to configure ODBC driver for SAP HANA.

MicroStrategy recommends that the SAP HANA user account used to create thedatabase is granted full permissions for the database. If the database useraccount cannot be granted full permissions to the database, you can use therecommendations lis ted in Required database permissions to createmetadata, History List, and statistics reposi tories, page 388 to determine therequired permissions for the SAP HANA database user account. In addition,ensure the following permissions are defined for your SAP HANA user account:



l Insert permission for the _SYS_BIC schema.

l Select permission for the _SYS_REPO schema.

l Select permission for the _SYS_BI schema.

To be able to execute reports that create temporary tables, you need theCREATEANY permission.

To Configure an ODBC Driver for SAP HANA on Windows

1. Instal l the SAP HANA ODBC driver fi les on the Windows system thatwi l l host the MicroStrategy Intel l igence Server. For speci fic instal lationsteps, refer to your thi rd-party SAP documentation.

2. Using the Microsoft ODBC Data Source Administrator, create a datasource name to connect to your SAP HANA data source.

For best practices on using the Microsoft ODBC Data SourceAdministrator to create data source names that are to be used inMicroStrategy, see Managing ODBC and data sources withMicrosoft ODBC Data Source Administrator, page 378 .

3. You can use the MicroStrategy DB Query Tool to test whether data canbe retrieved data from your SAP HANA data source. For information onhow to use the MicroStrategy DB Query Tool , see Using the DB QueryTool , page 691.

4. To use an SAP HANA as a data source, you must create a databaseinstance in MicroStrategy. For information on creating a databaseinstance, see Creating a database instance, page 443.

When creating a database connection, which is part of a databaseinstance, ensure that you select Non UTF-8 as the character setencoding for Windows drivers.

This completes the steps for the ini tial connection to SAP HANA inMicroStrategy for Windows environments. For addi tional configuration



requirements, see Addi tional Requirements to Support SAP HANA, page783.

To Configure an ODBC Driver for SAP HANA on Linux

Begin by instal l ing the SAP HANA ODBC driver fi les on the Linux systemthat wi l l host the MicroStrategy Intel l igence Server. For speci fic instal lationsteps, refer to your thi rd-party SAP documentation.

The fol lowing set of instructions are divided into two sections: how toconfigure your environment and how to configure a DSN.





3. Edi t the odbc.sh fi le and provide the location where you instal led theSAP HANA ODBC driver fi les. Within the ODBC.sh fi le, the fol lowingdefini tion is included:

SAPHANA_PATH='<SAPHANA_PATH>'

Replace this <SAPHANA_PATH> placeholder wi th the location of theSAP HANA ODBC driver fi les. Do not modi fy any other occurrences of<SAPHANA_PATH> within odbc.sh .




To Configure a DSN



2. Open the odbc.ini.example fi le and find the section that starts wi th[SAP HANA] . Copy the section into the odbc.ini fi le.

3. Edi t the fol lowing information from the syntax that you copied toodbc.ini :

l Driver=<SAPHANA_PATH>/libodbcHDB.so

Replace <SAPHANA_PATH> with the location where you instal led theSAP HANA ODBC driver fi les.

l Servernode=ip_address:port

Replace ip_address with the IP address for the machine that hoststhe SAP HANA database.

Replace port with the port number for the connection to the SAPHANA database. Contact your SAP HANA database administrator forthe required port number.

l USER=uid

Replace uid with a val id SAP HANA user account.

l PASSWORD=pwd

Replace pwd with the password for the SAP HANA user accountdescribed above.

For information on the available parameters, refer to your third-party SAPHANA driver documentation. This can often be found along with the driverinstallation.




5. You can use the MicroStrategy DB Query Tool to test whether data canbe retrieved data from your SAP HANA data source. For information onhow to use the MicroStrategy DB Query Tool , see Using the DB QueryTool , page 691.

6. To use an SAP HANA as a data source, you must create a databaseinstance in MicroStrategy. For information on creating a databaseinstance, see Creating a database instance, page 443.

When creating a database connection, which is part of a databaseinstance, for SAP HANA, ensure that you select Non UTF-8 as thecharacter set encoding for Linux drivers.

This completes the steps for the ini tial connection to SAP HANA inMicroStrategy for Windows environments. For addi tional configurationrequirements, see Addi tional Requirements to Support SAP HANA, page783 below.

To Configure a DSN-less Connection

To configure the ODBC driver for DSN-less connection, an addi tional stepis required along with the steps in the To Configure a DSN section above.

1. Open the odbcinst.ini fi le and find this section:

[HDBODBC]

Driver=<SAP_HANA_ODBC_DIR>/libodbcHDB.so

Description=HANA Driver

Setup=<SAP_HANA_ODBC_DIR>/libodbcHDB.so

CPTimeout=0

2. Replace the <SAP_HANA_ODBC_DIR> placeholder wi th the locationwhere you instal led the SAP HANA ODBC driver fi les. The path is thesame as speci fied in the odbc.ini fi le.




Additional Requirements to Support SAP HANA

Review the fol lowing addi tional requirements to ensure a successfulintegration of SAP HANA in MicroStrategy:

l Be aware that once you import tables from SAP HANA into MicroStrategy,you must manual ly import any prefix information as wel l . Using theWarehouse Catalog, you can select al l tables imported from SAP HANAand select Import Prefix to import the prefix information. For addi tionalsteps to access and use the Warehouse Catalog, see the Project DesignGuide.

l If the tables in SAP HANA include input parameters, these are supportedin MicroStrategy using prompts. Using the Table Edi tor avai lable inMicroStrategy Developer, you can create and modi fy prompts to supportinput parameters. For steps to access and use the Table Edi tor, refer tothe Project Design Help.

Other Data Sources and Relational Databases for WindowsIf you use other databases or data sources, refer to the database-speci ficdocumentation for information on required settings. Standard settings aresupported by MicroStrategy for most relational databases.

Microsoft Excel

A Microsoft Excel fi le can be used as a data source in MicroStrategy. Theinformation below explains how to prepare an Excel fi le for use withMicroStrategy and how to connect to the Excel fi le.

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 toolssuch as Archi tect, as described in the Project Design Guide. You can alsouse Freeform SQL and Query Bui lder to access your Excel data, asdescribed in the Advanced Reporting Guide.







Prepare an Excel file as a valid data source

To use an Excel fi le as a data source, you must create and store the data inthe Excel fi le so that i t can be recognized in MicroStrategy as a set oftables that contain val id data. Fol low the below instructions to create atable wi th val id data in an Excel fi le:

1. Prepare the Excel fi le as fol lows:

l Ensure that al l column headers are of a val id format:

l No spaces in the header name (for example, Category_ID insteadof Category ID) .

l Alphanumeric, and beginning with a letter.

l Ensure that al l cel ls for the ID column have a value in them.

2. In the Excel fi le, create a table by performing the fol lowing:

a. Highl ight the speci fic rows and columns with the data to use tocreate a report wi th, including the column headers, such asCategory_ID and Category_DESC.

Do not use the column headings at the top of the Excel spreadsheet,marked as A, B, C, and so on to select the whole column. Doing somay include numerous empty cells with NULL values.

b. In the Name Box, type a name for the highl ighted cel ls, and thenpress ENTER. The name you type in is used in MicroStrategy as atable name.

The Name Box is the drop-down list on the left-hand side below thetoolbars.

You can create multiple tables in one Excel fi le by highl ightingdi fferent parts of the fi le and assigning them different names.



3. Save the Excel fi le.

Ensure that the file is not password-protected.

Use your Excel file as a data source

To use an Excel fi le as a data source, you can create a data source name(DSN) for the Excel fi le. This DSN can be used by a database instance inMicroStrategy to connect to the Excel fi le. For information on creating adatabase instance, see Creating a database instance, page 443.

As an al ternative, you can use Data Import to quickly include Excel data inyour MicroStrategy project. Steps to use Data Import to import data andbegin your analysis is included in the MicroStrategy Web Help.

Text files

A text fi le can be used as a data source in MicroStrategy. You can use DataImport to quickly include data from text fi les in your MicroStrategy project.Steps to use Data Import to import data and begin your analysis is includedin the MicroStrategy Web Help.

Creating Database Connections in Web

In MicroStrategy Web, users can import data from different data sources,such as a database or the resul ts of a Freeform query, then create reports,documents, and dossiers to report on their imported data. You can define anew database connection directly from Web for users to import data from, oredi t, delete, rename, or dupl icate an existing connection.

You must have the Create and Edit Database Instances and Connections andCreate and Edit Database Logins priv ileges to define a new database connection.

If you plan to connect to a data source using a DSN, the DSN must be created andavailable. If a DSN is not available, you can use the DSNLess Connection optionto connect to your data source.



To Create a New Database Connection

1. In MicroStrategy Web, navigate to any folder page, such as SharedReports or My Reports.

2. From the navigation bar on the left, go to Create > Access ExternalData > Database. The Select Import Options dialog box opens.

3. Select Pick Tables to select single or mul tiple tables to import datafrom.

l If you want to use a graphical interface to bui ld the SQL query to useto import your data, select Build a Query.

l If you want to manual ly type or paste a query to import your data,select Type a Query.

4. Cl ick OK .

5. From the Data Sources panel , cl ick Add .

6. Select the type of connection to your database, as fol lows:

l To connect to a data source using a DSN, select DSN Connections.Select the DSN of the database that you want to connect to from theDSN drop-down l ist, then select the appropriate databasemanagement system (DBMS) from the DBMS drop-down l ist.

l To connect di rectly to a data source, select DSNless Connections.

l If you clear the Show databases whose drivers were not foundcheck box, only databases that have an instal led and configureddriver are avai lable for selection. These databases can beconnected to by selecting the required Database and Version fromthe drop-down l ists, and supplying the required connectioninformation. For a detai led l ist of the information required for eachdatabase type, see Creating DSNs for Speci fic Data Sources, page



747.

l If you select the Show databases whose drivers were not foundcheck box, addi tional databases that do not have a configureddriver are avai lable for selection. These databases can beconnected to by selecting the required Database and Version fromthe drop-down l ists, and then configuring a connection to thedatabase by completing the fol lowing steps:

1. Cl ick Show connection string .

2. Type the value for each configuration requirement l isted.Depending on the database you are connecting to, thisincludes the server name, port number, and database name.For a detai led l ist of the information required for eachdatabase type, see Creating DSNs for Speci fic Data Sources,page 747.

3. Select the Edit connection string check box.

4. Modi fy the Driver={DriverName} part of the connectionstring, where DriverName is the defaul t name used for thedriver. Replace the defaul t DriverName with the name of thedriver that your administrator instal led for the database.

5. If there were any optional configuration parameters that youchose not to define, modi fy the connection string to removethe parameters completely from the string. These parametersare l isted with an equal sign (= ) fol lowed immediately by asemicolon (; ), indicating no value is provided. For example, i fthe connection string includes AlternateServers=;

remove this text from the connection string.

7. Type a user name and password with access to the database in theUser and Password fields.



8. Type a name for the database connection in the Data Source Namefield.

9. Do one of the fol lowing:

l To al low other users to import data using the database connection,select the Share this connection with everybody check box.

l To deny other users the abi l i ty to import data using the databaseconnection, clear the Share this connection with everybody checkbox.

10. Cl ick OK .

Configuring ODBC Parameters with ODBC.ini

The odbc.ini fi le is the configuration fi le that stores the defini tions for al lthe ODBC DSNs in a Linux environment. Therefore this section is notrelevant to ODBC and DSN connections on Windows.

For information on what drivers to use with MicroStrategy, see the Driversand Connectors page.

These ODBC DSNs are defined by speci fying values for certain DSNparameters. This fi le is activated by the environment variable ODBCINI, andis required by al l ODBC appl ications. By defaul t, the odbc.ini fi le isinstal led in HOME_PATH , where HOME_PATH is the directory you speci fiedas the home directory during instal lation on Linux. It contains thedefini tions for al l the MicroStrategy-branded ODBC drivers.

MicroStrategy supports ODBC drivers from other vendors that you can installseparately. This involves manually defining the DSN parameters in theodbc.ini file.

Modification of the odbc.ini fi le is necessary to configure the ful l l ist ofODBC driver settings or for ODBC drivers that are not accessible throughthe MicroStrategy Connectivi ty Wizard. However, caution should be taken


https://www.microstrategy.com/us/services/technical-support/drivers-and-connectors

https://www.microstrategy.com/us/services/technical-support/drivers-and-connectors


when modi fying the odbc.ini fi le as incorrect modi fications can causeunintended functional i ty and errors.

Refer to the odbc.ini.example fi le instal led in HOME_PATH , whereHOME_PATH is the directory you speci fied as the home directory duringinstal lation on Linux. It is recommended to copy the examples in theodbc.ini.example fi le to odbc.ini , to act as a basis for yourconfigurations. This example fi le provides commonly used settings for thedriver parameters.

If you require addi tional information on the purpose of and avai lable optionsfor each parameter, refer to the vendor documentation.



MicroStrategy Hadoop GatewaySimplified Instal lation

Introduction to the MicroStrategy Hadoop Gateway 790

Environment Considerations 792

Using the MicroStrategy Hadoop Gateway 798

Troubleshooting 807

Known Issues 816

Frequently Asked Questions 818

Introduction to the MicroStrategy Hadoop Gateway

Assumptionsl This document is only el igible for MicroStrategy MicroStrategy HadoopGateway 10.11 and later versions. Previous versions are not ful lycovered.

l The Intel l igence Server and MicroStrategy Hadoop Gateway versionnumbers must be identical . Otherwise, data fi les may not be importedsuccessful ly.

l See the Certi fication Dossier for a l ist of certi fied gateways.

l Starting with MicroStrategy 10.11, MicroStrategy Hadoop Gateway wi l l belaunched with spark-submit.

The appl ication detects Hadoop and Java dependencies and resolvesthem automatical ly. MicroStrategy also provides automatic deploymentvia MicroStrategy Hadoop Gateway Manager. Refer to MicroStrategyCommunity for more detai ls.


https://www2.microstrategy.com/producthelp/current/Readme/en-us/content/certified_configurations.htm

https://community.microstrategy.com/s/

https://community.microstrategy.com/s/


IntroductionMicroStrategy Hadoop Gateway is a new data processing engine,introduced in MicroStrategy 10.6, that can be instal led in a Sparkenvironment. This native connector al lows analysis of data in Hadoop andprovides high-speed paral lel data transfer between the Hadoop DistributedFi le System (HDFS) and the MicroStrategy Intel l igence Server.

MicroStrategy Hadoop Gateway is a native connector which was bui l t basedon Spark 1.6.x. You can choose one or more data fi les from Hadoop HDFSand load them into MicroStrategy Intel l igence Server. Data fi les can bepubl ished as ei ther an In-Memory Cube or a Live Connect Cube.

MicroStrategy Hadoop Gateway supports three operation modes:

l YARN cl ient

l Standalone (HDP cluster does not support Standalone)

l Local

In YARN cl ient mode, the driver runs in the cl ient process, and theappl ication master is only used for requesting resources from YARN.Running in this mode requires YARN service to be enabled on your Hadoopcluster.

In Standalone mode, MicroStrategy Hadoop Gateway uses Spark Master tocoordinate data processing.

In Local mode, no appl ication is deployed in the Spark nodes. Al l dataprocessing is executed in the MicroStrategy Hadoop Gateway host. Thismodal i ty is intended for testing and troubleshooting.

Related Topics

Environment Considerations

How to Deploy the MicroStrategy Hadoop Gateway

How to Start the MicroStrategy Hadoop Gateway



How to Register the MicroStrategy Hadoop Gateway

Troubleshooting

Known Issues

Frequently Asked Questions


Security on Data Access (Authentication)Accessing your Cluster services may be control led by a compl iant Kerberosimplementation (Kerberos MIT, Active Directory). In a Kerberosenvironment, the MicroStrategy Hadoop Gateway can identi fy i tsel f as aKerberos principal and have access to the required services: HDFS, SparkManager.

Hadoop as an Edge or Proxy Mode of the ClusterWe recommend the MicroStrategy Hadoop Gateway host to be part of theHadoop cluster for securi ty, administration and performance benefi t. AnEdge or Proxy node is physical ly or logical ly located within the cluster, andcontains the same set of l ibraries.

From an administration point of view, any upgrade on the cluster l ibraryversion wi l l include the Edge or Proxy node. It benefi ts performance, as thedata transfer speed should be higher. It improves securi ty, as the nodecould be constrained to the same rules and authentication.

High Availability Mode in HDFS and YARN Cluster ServicesFol lowing best practices, the cluster may have implemented HighAvai labi l i ty (HA) mode on the services. A server node can be set as Activeand enabled whi le an addi tional can be set to Standby to replace the Activeat any time. An HA environment would use a di fferent set of propertieswhen referring to these services. Review your environment and make sure i truns in HA mode.



System Requirements and Supported ConfigurationsThe system requirements for a MicroStrategy Hadoop Gateway are thesame as for a Spark cluster. The supported Spark version is 1.6.x.Supported distribution version for MicroStrategy Hadoop Gateway isCloudera Data Hub 5.10 or above, and Hortonworks 2.4 or above.

For Cluster environments wi th a standard authentication mechanism, theMicroStrategy Hadoop Gateway can be operated in Local , YARN cl ient andSpark Standalone mode. For environments wi th Kerberos authenticationenabled, the MicroStrategy Hadoop Gateway can only be operated in YARNcl ient mode.

The fol lowing are needed on a Hadoop cluster:

l You should have a Hadoop environment instal led on Unix/Linux servers.

The Hadoop Cluster must have at least the HDFS service instal led. Otherservices that can be instal led include Hive, Hue, Oozie, and ZooKeeper.

l MicroStrategy Hadoop Gateway supports the High Avai labi l i ty mode ofNameNode and YARN Resource Manager.

To enable NameNode High Avai labi l i ty, see How to Browse the HadoopDistributed Fi le System and Preview Fi les. No extra configuration isrequired for YARN Resource Manager High Avai labi l i ty. It is handledautomatical ly.

l If you are using the MicroStrategy Hadoop Gateway in YARN cl ient mode,the Hadoop Cluster should have YARN and Spark services instal led.

l If you are using MicroStrategy Hadoop Gateway on Spark Standalonemode, the Hadoop cluster should have Spark (Standalone) serviceinstal led.

l Connectivi ty parameters to the Spark master (for examplespark://SparkMasterNode:7077 )



l Cloudera Manager does not al low this service to be instal led i f thecluster has Kerberos enabled.

l For troubleshooting purposes:

l Access to Spark Standalone websi tehttp://SparkMasterNode:18080

l Access to Spark History Server websi tehttp://SparkHistoryServerNode:18088

l Access to YARN resource moni tor websi tehttp://YARNResourceManagerNode:8088

l Make sure Spark service is instal led and configured properly.MicroStrategy Hadoop Gateway 10.11 and later wi l l be launched withspark-submit methodology to avoid issues with cluster environmentcompl iance and compatibi l i ty.

Ports Used by MicroStrategy Hadoop Gateway

FromTo: ServiceDefaultPort

Explanation

Intell igenceServer

MicroStrategy HadoopGatewayHost Port30004

Sending commands from the Intell igence Server toMicroStrategy Hadoop Gateway to fetch data. The portnumber is conf igurable in MicroStrategy Hadoop Gatewayconf igurat ion f i le: /conf/hgos-spark.properties.

Intell igenceServer

MicroStrategy HadoopGatewayHost Port4020

Port used by Intell igence Server to browse HDFS viaMicroStrategy Hadoop Gateway RESTful service.

The port number is conf igurable in MicroStrategy HadoopGateway conf igurat ion f i le: /conf/hgos-spark.properties.

MicroStrategy Hadoop

HDFSNameNode

Default port number is: 8020. Please contact your clusteradminist rators for specif ic port number.



FromTo: ServiceDefaultPort

Explanation

Gateway Port 8020

HDFS (allnodes ofclusterHadoop)

Intell igenceServer Port30241

Used to send query result set f rom MicroStrategy HadoopGateway Spark applicat ion worker nodes to Intell igenceServer. The port number is conf igurable in the OS regist rywhere the Intell igence Server is installed.

Regist ry key: HKEY_LOCAL_MACHINE/SOFTWARE/Wow6432Node/MicroStrategy/D

SS Server/Castor/DSPort

Regist ry f i le in Linux: MSIReg.reg

MicroStrategy HadoopGateway

YARNResourceManagerPort 8032

YARN connect ivity


Spark Port4040

Spark connect ivity


KerberosKDC Port 88

To authent icate MicroStrategy Hadoop Gateway to accessother services (such as HDFS).

If Kerberos Authentication Has Been Enabled

To learn about Kerberos instal lation, see: How to Instal l the KerberosAuthentication Service.

Please refer to fol lowing l inks about how to enable Kerberos authenticationin Cloudera CDH and Hortonworks HDP cluster.

You wi l l need a Kerberos principal (or SPN in Active Directory) toauthenticate your MicroStrategy Hadoop Gateway process.


https://www.cloudera.com/documentation/enterprise/5-11-x/topics/cm_sg_intro_kerb.html

https://docs.hortonworks.com/HDPDocuments/HDP2/HDP-2.6.2/bk_security/content/configuring_amb_hdp_for_kerberos.html


The Kerberos authentication happens in at least two events:

l Browsing the HDFS file directory to select files to import. MicroStrategyHadoop Gateway directly connects NameNode.

l Starting the MicroStrategy Hadoop Gateway on YARN-client mode:MicroStrategy Hadoop Gateway will deploy Spark applications across YARNand requires a Kerberos ticket for this.

MicroStrategy Hadoop Gateway should be executed with a val id Linux useraccount l inked to a Kerberos principal . It could have any name, but forconvention we wi l l refer to i t ashgos/<HadoopGatewayHostFQDN>@REALM_NAME . As any other Clusteraccount, this account should be able to log into al l machines of the cluster.

This account should be al lowed to log into HDFS with wri te privi leges in i tshome directory (for example hdfs://NameNode:8020/user/hgos ).

Cluster nodes should have required l ibraries to work as a Kerberos cl ient(these could be the packages krb5-workstation , openldap-client ).

If High Availability Mode Has Been Enabled

Identi fy the nameservice of the HDFS service.

The fol lowing are needed on a MicroStrategy Hadoop Gateway drivermachine:

l Host OS: Linux (recommended: CentOS-7).

l The host to be part of the CDH cluster as a proxy node or worker node.

l Java Runtime Environment version 1.7 or 1.8 (latest subversionavai lable) instal led.

l Linux account must have wri te and execute privi leges in the instal lationfolder.



l The OS account should have an assigned user folder in HDFS andread/wri te privi leges (for examplehdfs://<HDFSNameNode:8020>/user/<Principal name>/ ) (atemp directory .sparkStaging wil l be created).

l Connectivi ty parameters, IP address and the port to connect fromIntel l igence Server.

l For detai led logs, replace the log4j.properties fi le wi th the richerversion avai lable in the troubleshooting section.


l The host should have instal led Kerberos cl ient l ibraries (l ike krb5-

workstation ) and al low Kerberos commands l ike kinit or klist .

l The Java Runtime Environment should have the Java CryptographyExtension l ibraries to support aes-256 encryption. There l ibraries areavai lable at Oracle's websi te. The Java JCE package contains two JARl ibraries. Use these and replace them in the directory <JRE_

HOME>/lib/security (If JDK is instal led instead of JRE, i t should be<JDK_Home>/jre/lib/security . Keep a backup of your originall ibraries).

For the Intelligence Server host, update firewall and network rules to allowconnectiv ity into port 30241 from cluster worker nodes.

Related Topics





Troubleshooting


http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html


Known Issues


Using the MicroStrategy Hadoop Gateway

Using MicroStrategy Hadoop Gateway requires you to complete three steps:deploying, starting, and registering data.

l How to Deploy the MicroStrategy Hadoop Gateway

Deploying the MicroStrategy Hadoop Gateway on the host machinerequires transferring, extracting, and configuring the MicroStrategyHadoop Gateway.

l How to Start the MicroStrategy Hadoop Gateway

Starting the MicroStrategy Hadoop Gateway wi l l start the MicroStrategyHadoop Gateway service and wi l l be ready to accept commands from theIntel l igence Server (through speci fied TCP port).

l How to Register the MicroStrategy Hadoop Gateway

Registering the MicroStrategy Hadoop Gateway stores the configurationof the MicroStrategy Hadoop Gateway in the Intel l igence Serverenvironment. In this stage, you define the operation mode andconnectivi ty parameters.

How to Deploy the MicroStrategy Hadoop GatewayDeploying the MicroStrategy Hadoop Gateway on a host machine requiresto transfer, extract and configure MicroStrategy Hadoop Gateway.

Obtain MicroStrategy Hadoop Gateway

You wi l l need a copy of the MicroStrategy Hadoop Gateway package. It canbe obtained from MicroStrategy download websi te or from Intel l igenceServer directory.




Download the MicroStrategy Hadoop Gateway

1. Go to MicroStrategy download websi te.

2. Cl ick on Feature Releases and select your version (for example 10.x).

3. Cl ick on MicroStrategy 10.x Add-Ons and Tools.

4. Cl ick to download Hadoop Gateway.

5. Cl ick OK

6. Save the fi le 10.x.00xx.00xx_10.x_GA_HadoopGateway.zip .

7. Copy the fi le onto your MicroStrategy Hadoop Gateway machine.

Copy the MicroStrategy Hadoop Gateway From the Intelligence Server

1. Go to the Intel l igence Server directory.

2. Open the "hgos-manager" di rectory.

3. Copy the fi le hgos-dist.tar.gz onto your MicroStrategy HadoopGateway machine.

Install the MicroStrategy Hadoop Gateway

1. Log in to the MicroStrategy Hadoop Gateway host machine via SSH.

2. Locate the MicroStrategy Hadoop Gateway tarbal l hgos-dist.tar.gz .

3. Unzip i t in your selected directory (for example, by running: tar -

xvzf hgos-dist.tar.gz ).

Configure MicroStrategy Hadoop Gateway

MicroStrategy Hadoop Gateway wi l l be configured with minimuminfrastructure after instal lation.




To customize the instal lation to speci fic requirements, modi fy theMicroStrategy Hadoop Gateway configuration fi le <Installation

path>/conf/hgos-spark.properties .


Modify MicroStrategy Hadoop Gateway configuration fi le<MicroStrategy Hadoop Gateway installation

path>/conf/hgos-spark.properties and uncomment the fol lowingsection:

spark.yarn.token.renewal.interval=50000

spark.yarn.security.tokens.hdfs.enabled=true

spark.yarn.principal=<Kerberos Principal>

spark.yarn.keytab=<Path of principal keytab file>

Keep at hand the MicroStrategy Hadoop Gateway host IP, host name, andconnectiv ity parameters.

Related Topics





Troubleshooting

Known Issues




How to Start the MicroStrategy Hadoop GatewayStarting MicroStrategy Hadoop Gateway wi l l start the MicroStrategy HadoopGateway service and wi l l be ready to accept commands from theIntel l igence Server (through speci fied TCP port).

Launch MicroStrategy Hadoop Gateway Service

1. Run the fi le /<MicroStrategy Hadoop Gateway installation

path>/sbin/start-hgos.sh .

2. Once the MicroStrategy Hadoop Gateway is started successful ly, theresul t should look l ike below:

SPARK_HOME is ''

[PASS] jdk version 1.8 is OK

[PASS] Hadoop 2.6 is OK

[PASS] cdh 5.13 is OK

[PASS] Spark version is 1.6

[FAIL] WARN: No kerberos config found.If kerberos is not enabled, please just

ignore this message, otherwise HGOS will fail to start

#############################################################################

####

HGOS use spark setting from hgos-spark.properties, spark master is yarn-

client

HGOS will run using yarn-client mode, according to your hgos-

spark.properties.

==================================Starting

HGOS==================================

pid: 9089, starting, and more detail is in the log file

/home/MSTR/hgos/log/hgos.out

.........................

Start success!

Related Topics







Troubleshooting

Known Issues


How to Register the MicroStrategy Hadoop GatewayRegistering MicroStrategy Hadoop Gateway stores the configuration of theMicroStrategy Hadoop Gateway in the Intel l igence Server environment. Inthis stage, you define the operation mode and connectivi ty parameters.

How to Browse the Hadoop Distributed File System and PreviewFiles

1. Log into MicroStrategy Web.

2. Cl ick Create > Add External Data.

3. In the Connect your Data dialog, cl ick Hadoop .

4. Select Browse Hadoop Files using MicroStrategy Big Data Enginewhen "Select Import Options" form appears.



5. Cl ick Next. The "Connect to Hadoop" form appears with the HDFS fi lebrowser.

6. In Hadoop Fi le Browser entry, cl ick Change Connection on top ofscreen.



7. Select Edit connection string to enable connection stringmodi fication.



8. Make sure you configure appropriate Hadoop NameNode IP/Host andport in the connection string.

Hadoop NameNode IP address is: 10.242.109.2 , and HDFS port numberis by default: 8020 . The MicroStrategy Hadoop Gateway is deployed onhost IP: 10.242.109.10 with port: 30005 (port can be configured inMicroStrategy Hadoop Gateway configuration file). The connection string forthe above data should look like this:



hadoopName=10.242.109.2;hdfsPort=8020;BDEIP=10.242.109.10;BDEPORT=3000

5;

If Hadoop NameNode High Availability Has Been Enabled

1. Ask your Hadoop cluster administrators about the HDFS nameservice.

2. Replace the attribute hadoopName with hadoopNameService in theconnection string, and remove the attribute hdfsPort .

Here, the HDFS nameservice is "nameservice1" in the cluster. Theconnection string should look like this:

hadoopNameService=nameservice1;BDEIP=10.242.109.10;BDEPORT=30005;

All of attributes in the connection string are case sensitive.

3. Cl ick OK to save connectivi ty parameters and finish MicroStrategyHadoop Gateway registration. HDFS folders and fi les wi l l appear i feverything has been configured properly.

Once the MicroStrategy Hadoop Gateway is running, the Import Datafeature can be used to import data as an Intel l igent Cube for dataconsumption.

Related Topics





Troubleshooting

Known Issues




Troubleshooting

How to Get Additional Log Messages to Troubleshoot theMicroStrategy Hadoop Gateway1. Connect to the MicroStrategy Hadoop Gateway host. Edi t the

configuration fi le log4.properties in the MicroStrategy HadoopGateway instal lation path.

2. Update i ts contents to match the l ines below:

log4j.rootLogger=DEBUG,console

# To enable logging for all classes of package com.microstrategy and its

# subpackages, specify the logger as shown. Or you can specify any name

for

# the logger.

# For example, you can name your logger MICROLOG as shown in the

following

#statement: log4j.logger.com.microstrategy=INFO, MICROLOG

log4j.logger.com.microstrategy=INFO

# To enable logging for all classes of package org and its subpackages,

# specify the logger as shown in the following statement:

log4j.logger.org=WARN



How to Get YARN Log Messages to Troubleshoot theMicroStrategy Hadoop Gateway

If You Are Using the Cloudera CDH Cluster

1. Log into Cloudera Manager, the cluster administration portal .

2. Cl ick YARN service.

3. Cl ick Web UI.

4. Select the active ResourceManager WebUI i f YARN ResourceManager is configured as High Avai labi l i ty. You wi l l be redirected to



the Hadoop Resource Manager page.



If You Are Using the Hortonworks Cluster

1. Log into Ambari , the cluster administration portal .

2. Cl ick YARN service.

3. Cl ick Quick Links.



4. Select ResourceManager UI. You wi l l be redirected to the HadoopResource Manager page.

5. Find Hadoop Gateway in the appl ication l ist, and cl ick the appl icationID.

You wi l l find appl ication detai ls and logs in YARN.



What to Do if You Get an Error in the MicroStrategy HadoopGateway Connection Page and You Are Unable to BrowseHDFS

Fol low the steps below to diagnose the issue.



1. Make sure MicroStrategy Hadoop Gateway service has been startedsuccessful ly and port number 4020 is open on MicroStrategy HadoopGateway host machine. In MicroStrategy2020, the port 4020 isconfigurable in Hadoop. You can change the value (port number) ofparameter hgos.restful.port in <MicroStrategy Hadoop

Gateway installation path>/conf/hgos-

spark.properties .

2. Check i f the HDFS service is running and NameNode is accessiblefrom the MicroStrategy Hadoop Gateway host machine.

3. Check i f an appropriate connection string is configured and the valuesare correct. Al l the connection string attributes are case sensi tive.

Connection string template:

hadoopName=<Active Hadoop NameNode>;hdfsPort=<NameNode

port>;BDEIP=<MicroStrategy Hadoop Gateway host

machine>;BDEPORT=<MicroStrategy Hadoop Gateway port>;

If Hadoop NameNode High Availability Is Configured

1. Ask your cluster administrators about the HDFS nameservice.

2. Replace the attribute hadoopName with hadoopNameService in theconnection string, and remove the attribute hdfsPort .

hadoopNameService=<HDFS nameservice>;BDEIP=<MicroStrategy Hadoop Gateway

host machine>;BDEPORT=<MicroStrategy Hadoop Gateway port>;


1. Make sure the principal ticket is val id. You can refresh the ticket byrunning the fol lowing command:

kinit -k -t <Principal keytab file path> <Principal> -c <Cache name>



2. Make sure that the present principal has sufficient permissions tobrowse HDFS. You can do so by running the fol lowing command:hadoop fs -ls /

The expected resul t is l ike the output below:

[root@ash-109-32r sbin]# hadoop fs -ls /

Found 11 items

-rw-r--r-- 3 hdfs supergroup 1996573 2017-01-10 03:09 /0_0_0_

parquet

drwxr-xr-x - hdfs supergroup 0 2017-05-23 08:43 /Blitz

-rw-r--r-- 3 root supergroup 21 2017-06-26 03:26

/DE65820.txt

drwxrwxrwx - root supergroup 0 2017-02-09 06:16 /DataSets

-rw-r--r-- 3 root supergroup 189 2017-11-13 06:49 /Date_

Format.csv


Format_b.csv


Format_c.csv

drwxr-xr-x - root supergroup 0 2017-08-31 12:53 /Demo_Files

drwxrwxrwx - root supergroup 0 2017-07-13 14:56 /EPA

drwxr-xr-x - root supergroup 0 2017-09-07 02:55 /EPA_3C

drwxr-xr-x - root supergroup 0 2017-09-07 03:36 /EPA_3C_

Part

In-memory cubes cannot be publ ished or generate dossiers in the LiveConnect mode. By using the MicroStrategy Hadoop Gateway log, youcan determine i f data is transmitted back to Intel l igence Serversuccessful ly from the Hadoop cluster.

Make sure that the port number used to receive data fromMicroStrategy Hadoop Gateway is open on the Intel l igence Server. Bydefaul t, the port number is 30241, and i t is configurable in the registry.

If the intel l igence Server and Hadoop cluster are instal led on separatenetworks, the Intel l igence Server communicates with the cluster via a



gateway. You need to speci fy the Intel l igence Server host name andIP. Otherwise, the MicroStrategy Hadoop Gateway wi l l submit data tothe gateway machine instead, because the MicroStrategy HadoopGateway detects the source automatical ly from the network request.

To speci fy the Intel l igence Server host name and IP, you need tomodi fy the registry key and manual ly set DSHostName with theIntel l igence Server host name and IP.

The ability to specify the Intelligence Server hostname and IP is onlyavailable for MicroStrategy 10.10 and later.

Registry key:

HKEY_LOCAL_MACHINE/SOFTWARE/Wow6432Node/MicroStrategy/DSS

Server/Castor/DSHostName

Registry fi le on the Intel l igence Server:

MSIReg.reg

3. Restart the Intel l igence Server and the MicroStrategy HadoopGateway.

Related Topics






Known Issues




Known Issues

SymptomIn MicroStrategy Web, users have an expansion in the variety of datasources to which they can connect. These new options are under AddExternal Data. A user wi th Web Reporter, Web Analyst, and WebProfessional privi leges wi l l receive a "You do not have enough privi leges toperform this operation" error when trying to import a table from a datasource. This is due to the fact that the user privi lege "Access data fromDatabases, Google BigQuery, BigData, OLAP, BI tools" is not the onlyprivi lege needed. Creating a data source object to import Tables isconsidered an Administrator Privi lege.

Workaround

Give the user the privi lege from the Administration group "Create and edi tdatabase and instances and connections".

The "Create and edit database and instances and connections" is a Serverlevel only priv ilege and can only be granted only at the project source level, soit needs to be given at a user or user group level.



SymptomThere are persisting tables in the Hive Metastore when the MicroStrategyHadoop Gateway service starts. In the log fi le you can see that theMicroStrategy Hadoop Gateway service is trying to modi fy the structure ofsome Metastore tables (such as DBS tables). When i t tries to commit thetransaction, an error is produced and a rol lback operation is generated.

Workaround

MicroStrategy Hadoop Gateway requires a Hive component to load ORCfi les, and basic metadata needs to be created to establ ish the Hivecomponent. Modi fying the structure of Metastore tables is not permitted bydefaul t.

To enable Metastore modi fication, add the fol lowing section to/etc/hive/conf/hive-site.xml .

<property>

<name>datanucleus.autoCreateSchema</name>

<value>true</value>

</property>

Alternatively, the Hive component can be disabled i f you are not going toimport ORC fi les. Set the property hgos.spark.enable value to false

in the MicroStrategy Hadoop Gateway configuration fi le<MicroStrategyHadoop Gateway installation path>/conf/hgos-

spark.properties .

SymptomText columns in the parquet fi le created by Impala are loaded as binaries.

Workaround

The Impala Parquet wri ter always creates an unannotated binary field forstring columns. It is possible to speci fy that the field include the UTF-8annotation to indicate UTF-8 string data. It was resolved in Impala 2.6 andCDH 5.11 has 2.8.



If al l these columns need to be converted to UTF-8 strings, addspark.sql.parquet.binaryAsString=true into configuration fi le<MicroStrategy Hadoop Gateway installation

path>/conf/hgos-spark.properties .

Related Topics






Troubleshooting



What are the recommended settings for hgos-spark.properties?

The table below helps calculate the recommended settings based on thenumber of working nodes, RAM and virtual cores in each node, and thenumber of executors to be al located on each worker node.

ID Item ParameterFormula

Value

Description

C1

Numberof Node

2Available in yourhardware

C2

RAM perNode


Recommended performance parameters for YARN cl ient mode




Value

Description

(GB)

C3

VCoresperNode


C4

TotalnumberofVCores

C1 × C3 80

S1

Allocatedexecutors

S1 = S2× C1

48

S2

Executors perNode

spark.executor.cores 6Number of executors tobe allocated on eachworker node

S3

Maxmemoryperexecutor(GB)

S3 = C2/ S2

63

H1

Overhead (GB)

H1 = S3× 0.07

4

Overhead memory usedby the OS.

I t defaults to 0.07 ×spark.executor.mem

ory

H2

Numberofexecutor

spark.executor.insta

nce

H2 = S1- 1

47

Total number ofexecutors created in thecluster.

One node needs tooccupy an executor for




Value

Description

AM.

H3

Memoryperexecutor(GB)

spark.executor.memoryH3 = S3- H1

59

Running executors withtoo much memory of tenresults in excessivegarbage collect ion delays.

64 GB is a rough guess ata good upper l imit for asingle executor.

H4

Coresperexecutor

H4 =(C3 /S2) - 1

6Leave 1 core for systemprocesses

Can MicroStrategy Hadoop Gateway release cluster resources during idletime?

Yes, MicroStrategy Hadoop Gateway supports releasing cluster resourceswhi le the service is idle. You wi l l have to configure the MicroStrategyHadoop Gateway executors and cores as dynamical ly al located to enablethis behavior. Modi fy the MicroStrategy Hadoop Gateway configuration fi le<MicroStrategy Hadoop Gateway installation

path>/conf/hgos-spark.properties , and uncomment the dynamical location section.

Does MicroStrategy Hadoop Gateway support Live Connect?

Yes, MicroStrategy Hadoop Gateway supports Live Connect Cube sinceMicroStrategy 10.9. There is no extra configuration required to enable i t.

What is the minimum memory and hard drive space to instal l MicroStrategyHadoop Gateway on the host machine?

The minimum requirement for the MicroStrategy Hadoop Gateway is 256 MBof disk space and 2 GB of memory.



What is the memory and hard drive space necessary in other nodes(NameNode, DataNode) whi le MicroStrategy Hadoop Gateway is running?

MicroStrategy Hadoop Gateway wi l l not start any extra processes on aNameNode or a DataNode. MicroStrategy Hadoop Gateway just submits jobto Spark.

DataNode memory usage depends on the number set by the customer toattribute fi le spark.executor.memory in the configuration fi le (bydefaul t, i t is 1 GB). Meanwhi le, NameNode memory usage wi l l not besigni ficantly affected.

Wi l l MicroStrategy Hadoop Gateway create any metadata on HDFS?

When MicroStrategy Hadoop Gateway starts, some JAR fi les wi l l beuploaded to HDFS to hdfs://HDFSNameNode:8020/user/${user_

name_start_hgos}/.sparkStaging . By defaul t, the fi les insparkStaging wil l be deleted automatical ly once MicroStrategy HadoopGateway service is shut down.

Total size of JAR fi les wi l l be no larger than 256 MB.

Can MicroStrategy Hadoop Gateway refresh Kerberos principal ticketautomatical ly?

No, MicroStrategy Hadoop Gateway wi l l not refresh Kerberos principalticket automatical ly. You wi l l have to refresh i t by running the kinit

command or creating a cron job to refresh the ticket on schedule.

A template for kinit_cron.sh :

function setup_kerberos() {

echo "klist:"

klist

echo "KRB5CCNAME env:"

export KRB5CCNAME="$HGOS_HOME/conf/krb5cc_hgos"

echo $KRB5CCNAME



echo "kinit"

kinit -kt $keytab_path $principal_name -l 1d5h -r 2d -f

echo "klist"

klist

}

setup_kerberos

To schedule a cron job, run:

root@HOST # crontab -l 0 */2 * * * <path to file>/kinit_cron.sh

Does MicroStrategy Hadoop Gateway support Apache Sentry?

Yes, MicroStrategy Hadoop Gateway supports HDFS ACL by ApacheSentry, and no extra configuration is required. See the video below for howMicroStrategy Hadoop Gateway works with Apache Sentry.

Does MicroStrategy Hadoop Gateway support Apache Spark 2 and later?

No. MicroStrategy Hadoop Gateway is bui l t on Spark 1.6 and only el igibleto be deployed in a Spark 1.6 environment. We are working to releaseMicroStrategy Hadoop Gateway on Spark 2.



Related Topics






Troubleshooting

Known Issues



Instal l ing and ConfiguringTopology

The new MicroStrategy Workstation Topology feature provides users wi th agraphical interface that presents the enti re topology of every node withintheir environment, in addi tion to related services for avai lable nodes.Through the Topology menu in Workstation, administrators can moni tor thecurrent state of every service on each node, as wel l as start or stopindividual services.

This section describes how to instal l and configure topology.

Introduction to Topology










l Monitoring Agents




On environments where three or more machines host MicroStrategyServices, i t is recommended that you choose at least threecommunication agents to provide redundancy and improved rel iabi l i ty, incase one communication agent becomes unavai lable. The machineschosen to act as communication agents must be machines that hostMicroStrategy Services, such as Intel l igence Server or MicroStrategyLibrary. If you decide to use only one communication agent, i t isrecommended that you choose the machine that houses MicroStrategy




Library (i f deployed through the MicroStrategy instal lation), since Librarycommunicates directly wi th Workstation.






Installing Topology

This section describes how to instal l topology using the TopologyConfiguration dialog of the Instal lation wizard.


2. If your environment contains multiple machines, determine which



machines in your environment you want to act as communicationagents. Among al l the machines in your environment that wi l l hostMicroStrategy Services, select at least one of them (three arerecommended for mul tiple machine environments) to act as acommunication agent. Enter each machine in the text field, separatedby semicolons. You must input the exact same l ist on al l machines,using the Topology Configuration dialog of the Instal lation wizard,including the moni toring and communication agent machines.











Examples:












Deploying MicroStrategy Library through a WAR File

If you do not want to deploy MicroStrategy Library through the instal ler,which uses Tomcat by defaul t, you can deploy MicroStrategy Library to aWeb container.



To deploy Library and configure the registration service:

1. Deploy MicroStrategy Library to the desired web servers.

2. Once Library is deployed, the service registration agent that runs inthis deployment becomes a moni toring agent by defaul t. Itautomatical ly connects to the agent on the iServer machine that isconnected to Library.

3. Make sure the Intel l igence server, connected to Library, hosts thecommunication agent.

4. Keep in mind that restarting the appl ication also restarts the serviceregistration agent.

5. If the fi rewal l is turned on for this machine, refer to Enabl ing TopologyCommunication Through a Firewal l to make sure the proper ports areopen to support service registration agent communications.

To create redundancy for the communication agents:

In this configuration, one machine hosts MicroStrategy Library and the othertwo machines host Intelligent servers (and/or more machines hostingservices). Redundancy is recommended, with a total of three communicationagents.

1. Create a l ist of the three machines separated by semicolons.

librarymachine.domain.com;intelligenceserver1.domain.com;intelligenceserver2.domain.com

2. During the instal lation, enter the l ist of three machines, as notedabove, on both Intel l igent servers and/or any other machines where theMicroStrategy instal lation runs.

3. After deploying Library, manual ly change i ts configuration to run as acommunication agent.



a. Navigate to the deployed folder of MicroStrategy Library and thesubfolder, \ServicesRegistration\yaml.

b. Modi fy the configuration fi le.

c. Restart al l consul nodes.

Enabling Topology Communication Through aFirewall

MicroStrategy supports machines with registration services instal led in thesame subset as a MicroStrategy environment. If there is a fi rewal l betweenMicroStrategy Services, make sure the speci fied ports (shown below) areal lowed to send and receive TCP/UDP requests through the fi rewal l , so theServices Registration agents can communicate properly. Consul uses bothTCP and UDP, so make sure to al low both protocols.

l Server RPC (Defaul t 8300)This port is used by the communication agents to handle incomingrequests from other agents. TCP only.

l Serf LAN (Defaul t 8301)This port is used by al l moni toring and communication agents tocommunicate with each other on the LAN. TCP and UDP.

l Serf WAN (Defaul t 8302). Use this port for machine communication over aWAN. This port is used by servers to gossip over the WAN to otherservers. TCP and UDP.

If you are performing a Windows instal lation and the fi rewal l is on, theinstal ler adds rules to open 8300 and 8301 for TCP and 8301 for UDP.

On machines with publ ic IP addresses exposed to the internet, make surefi rewal l ports for Server RPC (defaul t 8300), Serf LAN (defaul t 8301), andSerf WAN (defaul t 8302) are only for nodes within the Workstation topologycluster.



See the Consul documentation for more information on port requirements.

See Using Firewal ls for more information about using fi rewal ls wi thMicroStrategy.

Removing a Service from the Topology Monitor

The administrator may choose to instal l MicroStrategy products on amachine, but not plan to configure them at the moment. To el iminateconfusion, the administrator can remove them from the topology moni tor.

1. Navigate to /MicroStrategy/Services Registration/config in yourinstal lation directory.

2. Delete the .json fi le that corresponds with the name of the service youwant to remove.

3. Navigate to the instal lation directory and delete the ServicesRegistration/data folder.

4. Restart the consul .

5. In Workstation, navigate to the Topology view and cl ick the Refreshbutton.


https://www.consul.io/docs/agent/options.html#ports


6. Veri fy that the services you removed are no longer visible.

Restarting the Consul

1. If you are using Windows, use the Service Manager to start and stopMicroStrategy Services Registration.

2. If you are using Linux, enter the fol lowing commands to start and stopthe consul :

-> cd /Installationpath/MicroStrategy/install/ServicesRegistration/jar

-> java -jar svcsreg-admin.jar control consul start

-> java -jar svcsreg-admin.jar control consul stop

-> java -jar svcsreg-admin.jar control consul status

-> java -jar svcsreg-admin.jar control consul restart



Specifying the Topology Communication Agent

After instal lation, you can see al l configuration fi les for the service'sregistration in the consul .json fi le, located in MicroStrategy/ServicesRegistration/config, in your instal lation directory.

If you have a single machine environment or a multiple machineenvironment wi th two machines, consul .json appears as fol lows:

{

"enable_debug": true,

"datacenter": "dc1",

"enable_script_checks": true,

"check_update_interval": "0s",

"log_level": "WARN",

"data_dir": "../data",

"watches": [

{

"type": "key",

"key": "envInfoTime",

"handler_type": "script",

"args": [

"C:\\Program Files (x86)\\Common Files\\MicroStrategy\\JRE\\180_

77\\Win64\\bin\\java",

"-jar",

"../jar/envinfo-collector.jar",

"collect"

]

}

],

"server": true,

"bootstrap_expect": 1

}

If you have a multiple machine environment wi th three or more machines,consul .json appears as fol lows:

{









"watches": [

{

"type": "key",



"args": [



"-jar",


"collect"

]

}

],

"retry_join": [

"was-jinli.corp.microstrategy.com",

"wezhong-win1019.corp.microstrategy.com",

"was-pcheng.corp.microstrategy.com"

],

"server": true,


}

In consul .json fi le, bootstrap_expect , refers to the number of machinesthat act as communication agents in the environment. This is set on eachmachine where you speci fy the communication agent only. Speci fy themachines that act as communication agents in retry_join . This field isspeci fied on every machine where the MicroStrategy Services are instal ledso that they can find the communication agents in the network.

To support machines with dynamic and multiple IP addresses, theconsul .json fi le is regenerated each time the service registration agentrestarts.



Changing the Monitoring Agent to a CommunicationAgent

You can change a moni toring agent to a communication agent by manual lymodi fying the instal lation_l ist.yaml fi le.

Manual ly modi fying the instal lation_l ist.yaml fi le to change the agent from amoni toring to a communication agent (or vice versa) is not recommended.Only a MicroStrategy administrator should manual ly modi fy instal lation_l ist.yaml to correct input mistakes during instal lation or reconfigure theservice registration agents in a cluster wi th manual ly deployed webappl ications.

During the instal lation, when selecting a multiple machine environment, theuser must provide a l ist of communication agents. If the current machinewhere instal lation is running is not in the l ist, i t is not configured as acommunication agent. Instead, i t is set as a moni toring agent only. If thel ibrary server is manual ly deployed on a machine, the embedded serviceregistration agent is configured as a moni toring agent by defaul t.

To manually change the monitoring agent to a communicationagent:

1. After instal lation, navigate to the directory MicroStrategy/ServicesRegistration/yaml.

2. Open instal lation_l ist.yaml and locate the consul section.

---

consul:

install_path: "C:\\Program Files (x86)\\MicroStrategy\\Services

Registration"

java_install_path: "C:\\Program Files (x86)\\Common

Files\\MicroStrategy\\JRE\\180_192\\Win64\\bin"

retry_join:



- Wei2016.labs.microstrategy.com

- pcheng-W10-PRO.labs.microstrategy.com

- pcheng-RHEL-6-8.labs.microstrategy.com

server: false

---

3. Change the server value to true.

4. Add "bootstrap_expect": 3 to the end of the fi le. If this is a twomachine environment and both machines are started as moni toringagents, add "bootstrap_expect":1 instead.

5. Make sure the machine name is added in the retry_join l ist and onlythree machine names are in the l ist. If this is a two machineenvironment, make sure only one machine name is in the l ist. Save thefi le.

6. Modi fy instal lation_l ist.yaml on al l machines in the same consulcluster by including the name of this machine in the retry_join l ist andmake sure only three machines are in the l ist. The l ist should beidentical for al l machines in the same consul cluster.

7. Stop the consul on al l machines in the same consul cluster. Thesemachines have the same retry_join l ist running as ei ther acommunication or moni toring agent.

8. Navigate to the instal lation directory and deleteMicroStrategy/Services Registration/data.

9. Restart the consuls on al l machines in the same consul cluster.

To switch one machine from a moni toring agent to a communication agent,another machine previously running as a communication agent in the samecluster should be switched to a moni toring agent. Do this by modi fying theinstal lation_l ist.yaml fi le. Change the server value to false and remove"bootstrap_expect" .



Starting and Stopping Services

The topology view uses SSH authentication to start and stop servicesremotely. If you are using Windows, the defaul t Windows SSHconfiguration, TCP port 22, is used. The credentials are typical ly themachine administrator's credentials. See Configuring SSH on Windows toconfigure SSH on Windows. See Configuring SSH on Linux to configureSSH on Linux.

Configuring SSH on WindowsIf SSH is not running or instal led during your MicroStrategy instal lation, theinstal ler does not enable the feature to start and stop services inWorkstation. You must enable SSH server in Services Registration to startand stop services in Workstation.

To configure SSH on Windows:

1. Instal l or enable SSH server on your Windows machine. If yourWindows machine has Windows 10 Fal l Creators Update, WindowsService 1809, or Windows Server 2019, you can fol low the steps fromthe fol lowing Microsoft websi tes:

Open SSH in Windows 10!

Windows Server 2019 Includes OpenSSH

Using the OpenSSH Beta in Windows 10 Fal l Creators Update andWindows Server 1709

2. To enable the bui l t-in SSH server for older Windows versions, seeInstal l Win32 OpenSSH.

3. Configure and start your SSH server.

4. If you have fi rewal l , open the SSH port in your fi rewal l . For example,port 22.


https://blogs.msdn.microsoft.com/commandline/2018/01/22/openssh-in-windows-10/

https://blogs.windows.com/buildingapps/2018/12/11/windows-server-2019-includes-openssh/

https://github.com/PowerShell/Win32-OpenSSH/wiki/Install-Win32-OpenSSH


5. Navigate to C:\Program Fi les (x86)\MicroStrategy\ServicesRegistration\yaml and edi t the installation_list.yaml fi le.

6. Make the fol lowing modi fications:

l Modify "CommonPath" to the MicroStrategy Common Fi lesinstal lation directory. By defaul t, this path is C:\Program Fi les(x86)\Common Fi les\MicroStrategy.

l Modify "InstallType" to 1 .

l Modify "Port" to use your SSH server's port number.

l Modify "version" to use your MicroStrategy version number.

---

service:

Name: "SSH-Server"

ID: "SSH-Server"

CommonPath: "C:\\Program Files (x86)\\Common Files\\MicroStrategy"

InstallType: 1

Port: 22

Tags:

version: "11.2.0000.0123"

7. Navigate to C:\Program Fi les (x86)\MicroStrategy\ServicesRegistration\jar and run the fol lowing command to generate a newJSON fi le for the SSH Server.

java -jar svcsreg-admin.jar parse SSH-Server

Your newly generated JSON file is located in C:\Program Files(x86)\MicroStrategy\Services Registration\config.

8. Restart MicroStrategy Services Registration from Windows ServiceManager.

9. Open the Topology view in Workstation. Now you can start and stopservices.



Configuring SSH on LinuxMicroStrategy uses the SSH included with your Linux OS by defaul t. If SSHis not running at the time of your MicroStrategy instal lation, the instal lerdoes not enable the feature to start and stop services in the WorkstationTopology view.

To configure SSH on Linux:

1. Instal l OpenSSH by opening a terminal and running the fol lowingcommands with super user permissions.

On Ubuntu/Debian/Linux Mint:

# apt-get install openssh-server openssh-clientopenssh

On RHEL/Centos/Fedora:

# yum -y install openssh-server openssh-clientsopenssh

2. Start the service by typing the fol lowing commands in terminal :

# chkconfig sshd on

# service sshd start

3. If you have fi rewal l , open the SSH port in your fi rewal l . For example,port 22.

4. Navigate to /opt/MicroStrategy/ServicesRegistration/yaml/ and openthe installation_list.yaml fi le.

5. Make the fol lowing modi fications:

l Modify "CommonPath" to the MicroStrategy Common Fi lesinstal lation directory. By defaul t, this is /var/opt/MicroStrategy.

l Modify "InstallType" to 1 .



l Modify "Port" to use your SSH server's port number.

l Modify "version" to use your MicroStrategy version number.

---

service:

Name: "SSH-Server"

ID: "SSH-Server"

CommonPath: /var/opt/MicroStrategy

InstallType: 1

Port: 22

Tags:

"version": "11.2.0000.0123"

6. Navigate to /opt/MicroStrategy/ServicesRegistration/jar and run thefol lowing command to generate a new JSON fi le for the SSH Server.

# java -jar svcsreg-admin.jar parse SSH-Server

Your newly generated JSON file is located in/opt/MicroStrategy/ServicesRegistration/config.

7. Restart MicroStrategy Services Registration using the fol lowingcommand:

# java -jar <MSTR_INSTALL_PATH>/ServicesRegistration/jar/svcsreg-admin.jarcontrol consul restart

8. Open the Topology view in Workstation. Now you can start and stopservices.



Supported MicroStrategy Platform Services

OldServiceDisplayName

NewServiceDisplayName

ServiceDescription

DefaultPort

Executable

WorkstationStart/StopSupported

Dependency

Intell igenceServer

Intell igence

Executesthe query,report ingandanalysisserver forMicroStrategysof tware.Controlssecurity,caching,clustering,queueingandpriorit izat ion.

34952 MSTRSv2_64.exe Yes

PDF ExportEngine

Export

Used byIntell igence to createPDF f ilesf romdocuments, reports,anddashboards

20100MSTRPDFExportSe

rvice.exeYes





ServiceDescription

DefaultPort

Executable


Dependency

LibraryServer

Library

Apersonalized portalfor everyend userto accessall theirdossiersand reportservicesdocuments(documents). BIauthorscan easilyshare linksto dossiersordocuments, whichare hostedinMicroStrategyLibrary.End userscan logintoMicroStrategy

Tomcat : 8080

ht tps:8443

MicroStrategyLibrary.war

No





ServiceDescription

DefaultPort

Executable


Dependency

Library tof ind a listof alldossiersanddocumentsthat theyhaveaccess to.

Collaborat ionServer

Collaborat ion

Allowsteams,departments, andorganizat ions toboostanalyt icsadopt ionviainteract ivediscussionthreadsand anintuit ivecommentspanel.With real-t imealerts,

3000 server. js YesCollaborat ion Store





ServiceDescription

DefaultPort

Executable


Dependency

not if icat ions, andeasilysharedpersonalized views,users havea holist icview oftheirbusinessandbenef itf romenhancedteamwork.

Collaborat ionRepository

Collaborat ionStore

27017 mongod.exe Yes

MobileServer

Mobile

Aninteract iveinterfaceof theMicroStrategy BIplat formthat letsmobile

ht tp: 80ht tps:443

Admin.aspx Yes





ServiceDescription

DefaultPort

Executable


Dependency

businessusersharnesstheanalyt icalpower ofMicroStrategythroughthe use oftheiriPhone®,iPad®,andAndroid™devices.

Tomcat :8080ht tps:8443

MicroStrategyMobile.war

No

WebServer

Web

A browser-basedclientinterfacethatenables ITto sat isfythe diverseanalyt icsneeds ofeveryenterpriseuser—

http: 80ht tps:443

main.aspx Yes





ServiceDescription

DefaultPort

Executable


Dependency

consumers,analysts,datascient ists,developers, andadminist rators—without theburden ofdist ribut ing andmaintaining mult iplesof twarepackages.

8080 MicroStrategy.war No

MessagingServer

Telemetry

Adist ributedstreamingplat formthat storesrecordsstreams ofdata intopics.Kafkaproducersallow an

9092 kafka.exe YesTelemetr

yManager





ServiceDescription

DefaultPort

Executable


Dependency

applicat ion, such asIdent ityandIntell igence, topublishrecords toone ormoretopics. TheKafkaconsumersallowsapplicat ions tosubscribeto topics.

MessagingManager

Telemetry

Manager

TheMicroStrategyplat formmessagingservicethatcoordinates theKafkaCluster

2181 zookeeper.exe Yes





ServiceDescription

DefaultPort

Executable


Dependency

UsherDatabaseProducer

Ident ityTelemetr

y

Sends thedatageneratedby Ident ityManagerto theTelemetryManager.

N/AUsherMetadataProd

ucer.exeYes

Plat formAnalyt icsConsumer

Telemetry Store

Reads thedata thatIntell igence andIdent itysend toTelemetry,t ransformsthe data,and loadsit into thePlat formAnalyt icswarehouse.

N/AUsherAnalyt icsCons

umer.exeYes

Telemetry Server

In-memoryCache

Telemetry Cache

An in-memorycache usedto opt imizeperformance for thePlat form

6379 redis-server.exe Yes





ServiceDescription

DefaultPort

Executable


Dependency

Analyt icsConsumer.

Repository

3306 mysqld.exe Yes

SecurityServer

Ident ity

A highlyscalable,f lexible,and easytomaintainsystembuilt onindustrystandardssuch asSecurityAssert ionMarkupLanguage(SAML),OpenAuthorizat ion (OAuth)2.0 andOpenIDConnect .The serversynchroniz

ssl: 1443two-wayssl: 2443

ROOT.war Yes





ServiceDescription

DefaultPort

Executable


Dependency

esident it ieswithenterpriseident itymanagement (IDM)systems ofrecord,andpresentsthoseident it iesto Badgeclients forauthent icat ion. TheIdent ityserver canbeinstalledonpremisesor in theMicroStrategy Cloudenvironment assingle-tenant . I tcan host





ServiceDescription

DefaultPort

Executable


Dependency

GatewayServer

Ident ityGateway

Amechanism (alsoknown asaconnector)thatpermitscommunicat ionbetweenIdent ityserver anda securedasset . I trepresentsa bi-direct ionalsecurecommunicat ionconnect ionused bytheIdent ityserver tocommunicate with

two-wayssl: 9501

gateway.war Yes





ServiceDescription

DefaultPort

Executable


Dependency

userrepositories hosted inIDMsystemsandPACS,and forlogicalresources.Eachgateway isdeployedas a webservicewhichensuressecurecommunicat ionbetweentheIdent ityserver,IDMsystems,PACsystems,and logicalresources.





ServiceDescription

DefaultPort

Executable


Dependency

NetworkManager

Ident ityManager

The groupof users inyourorganizat ion who canuse theBadge appon theirsmartphone tovalidatetheirident ity,log on toapplicat ions, gainaccess tosecurephysicalresources,and so on.Ident ityManager istheadminist rat iveconsolethat allowsyou tomanage an

Windows: 443

networkmgrht tpd.exe

No





ServiceDescription

DefaultPort

Executable


Dependency

organizat ion’snetwork ofusers,conf igureaccess toBadge-enabledsystemsandresources,anddist ributedigitalbadgesand keys.

Cert if icateManager

Cert if icate Store

HighlightsserviceslackingSSLsupport ,t rackscurrentandpendingcert if icateexpirat ions.Presentsvisual

5050Cert if icateManager.

exeYes





ServiceDescription

DefaultPort

Executable


Dependency

cues aboutexpiring oralreadyexpiredcert if icates acrossthe ent ireMicroStrategydeployment.

Starting in version 2019, some of the service names have been changed tobetter explain their behavior. See the onl ine readme corresponding to yoursoftware version for a l ist of the changes.

MicroStrategy Logging Consumer, MicroStrategy Listener, SSH, andMicroStrategy Registration Service are not monitored.

If using clusters, make sure that all machines in the Web server cluster cancommunicate with all machines in the Intelligence Server cluster.

Modification of the port the agents use to communicate is currently notsupported.

Troubleshooting Topology

This section covers issues that may occur in Workstation and how to correctthem.


https://microstrategyhelp.atlassian.net/wiki

https://microstrategyhelp.atlassian.net/wiki


How to enable debug logging

Debug logging records errors and other useful information for why an issueoccurred. For steps to enable debug logging, see KB483668: How toEnable Debug Logging for Topology.

How to update service ports for the service registration/topologymonitor

1. Navigate to the service configuration folder at/MicroStrategy/ServicesRegistration/config. Edi t the fi le for the servicerunning with a non-defaul t port number by updating the run-time portnumber being used.

{

"service": {

"Name": "MySQL",

"ID": "MySQL",

"Port": 3306,

"Tags": [

"{\n \"consulInstallPath\": \"C:\\\\Program Files

(x86)\\\\MicroStrategy\\\\Services Registration\",\n \"typeId\": 13,\n

\"version\": \"11.1.0000.0112\",\n \"start\": \"net start MySQL /y\",\n

\"stop\": \"net stop MySQL /y\"\n}"

],

"Check": {

"ID": "MySQL Health Check",

"Name": "MySQL Health Check",

"tcp": "localhost:3306",

"Interval": "10s",

"timeout": "5s"

}

}

}

2. Save the fi le and restart the service registration agent.


https://community.microstrategy.com/s/article/How-to-Enable-Debug-Logging-for-Topology?language=en_US

https://community.microstrategy.com/s/article/How-to-Enable-Debug-Logging-for-Topology?language=en_US


Service registration does not work when there is no networkconnection

If there is no network connection after instal lation, the service registrationsti l l works for al l local services. If not, make sure the user logging into themachine is a local administrator. A user wi th adequate privi leges for serviceregistration, when connected to the network, might not have ful ladministrator privi leges local ly when there is no network connection.

The service registration agent cannot start and No private IPV4address found is found in the log file

1. If the machine has more than one IP address, see ConfiguringEnvironments wi th Multiple IP Addresses

2. If the machine has only one IP address, check the network settingusing the fol lowing command, i f the IPv4 is not in the l ist of acceptableprivate (RFC1918) addresses provided in the table below.

On Windows:

ipconfig/all

On Linux:

ifconfig -a

RFC1918Name

IP AddressRange

NumberofAddresses

LargestCIDR Block(SubnetMask)

HostID Size

MaskBits

ClassfulDescription

24-bitblock

10.0.0.0 -10.255.255.25

5

16,777,216

10.0.0.0/8(255.0.0.0)

24 bits8bits

Singleclass Anetwork



RFC1918Name

IP AddressRange

NumberofAddresses

LargestCIDR Block(SubnetMask)

HostID Size

MaskBits

ClassfulDescription

20-bitblock

172.16.0.0 -172.31.255.25

51,048,576

172.16.0.0/12

(255.240.0.0)

20 bits12bits

16cont iguousclass Bnetworks

16-bitblock

192.168.0.0 -192.168.255.2

5565,536

192.168.0.0/16

(255.255.0.0)

16 bits16bits

256cont iguousclass Cnetworks

3. Check whether the network configuration is intended. If so and youwant to use service registration, complete steps 4 and 5 for aworkaround to bind the service registration agent to the non-acceptable IPv4 address.

4. Navigate to the Services Registration\yaml folder.

5. Edi t the instal lation_l ist.yaml fi le by adding bind_addr: x.x.x.x to theconsul section. Make sure to include a space between the colon andthe IP address.

consul:

install_path: "C:\\Program Files (x86)\\MicroStrategy\\Services

Registration"

java_install_path: "C:\\Program Files (x86)\\Common

Files\\MicroStrategy\\JRE\\180_192\\Win64\\bin"

server: false

retry_join:

- sap-win2016.labs.microstrategy.com

- pcheng-W10-PRO.labs.microstrategy.com

- pcheng-RHEL-6-8.labs.microstrategy.com

bind_addr: 10.21.20.222



6. Stop the service registration agent, delete the ServicesRegistration\data folder, and restart the service registration agent.

How to check the service registration cluster status

1. Open a command window and go to your MicroStrategy instal l path at\Service Registation\bin.

2. Execute the fol lowing command.

On Windows:

consul members

On Linux:

./consul members

3. Veri fy the returned l ist to see whether i t is consistent wi th the clusterconfiguration. Look at machine names and number of machines withcommunication agents running, machine names and number ofmachines with moni tor agents running, status of these agents. etc.

"MicroStrategy Services Registration is NOT available, pleasecheck the service status."

While using Workstation Topology to moni tor services, an empty pageappears wi th the message, "MicroStrategy Services Registration is NOTavai lable, please check the service status." Fol low the steps below totroubleshoot this issue.

Is the service registration agent running on the Library machine to whichWorkstation is connecting?

Log into the machine where Library is instal led and check whetherMicroStrategy Services Registration is running. On Windows, use theWindows Service Manager. On Linux, use ps -ef | grep consul .



If the agent is running, check whether the cluster agent is formingsuccessful ly. See How to update service ports.

1. If there is a fi rewal l on the machine in which Library is instal led, makesure the 8300(TCP) and 8301(TCP/UDP) ports are open.

2. Try to ping the machines l isted in ServicesRegistration/config/consul .json for "retry_join" to ensure the machinescan be accessed.

3. Make sure the leader election is complete. Check theServicesRegistration log fi le wi th the latest time stamp in the ServicesRegistration/log folder. If you see the message, "fai led to sync remotestate: No cluster leader" fol low steps 4 and 5. Otherwise, skip to step6.

4. The correct cluster configuration should be veri fied on every machinewith a service registration agent. Check the configuration of thecluster. There should be one or three communication agents defined inthe cluster as speci fied in the "retry_join" l ist of the instal lation_l ist.yaml fi le. This l ist should be consistent on al l nodes.

5. Make sure there is no dirty data in the Services Registration/datafolder. After unsuccessful cluster forming or modi fication of clustermembers, there may be inval id data left in the data fi les. Stop al lagents, delete the Services Registration/data folder on every clusternode and restart al l agents to form the cluster.

6. If MicroStrategy Library is deployed on a machine where MicroStrategyServices are not instal led, go to the Appl ication Server managing theconsul and restart the MicroStrategy Library deployment. If the agent isnot running, check the ServicesRegistration log fi le wi th the latest timestamp in the Services Registration/log folder to see why the agent didnot start. If the message, "No private IPv4 address found" appears, seeThe service registration agent cannot start.



If the agent is not running, check the ServicesRegistration log fi le wi th thelatest time stamp in the Services Registration\log folder to see why theagent cannot start.

Does the machine have multiple IP addresses? Were al l IPs avai lable wheninstal l ing the product?

Does the machine have an unacceptable IP address? If the agent hi t "Noprivate IPv4 address found," see The service registration agent cannotstart.

How was the MicroStrategy Library WAR fi le deployed on the server?

There may be issues i f the Linux server was not upgraded properly. Forexample, i f you upgraded to 11.0 from 10.10 on a Linux server, did not runthe MicroStrategy instal ler, but downloaded and copied the WAR fi le. In thissi tuation, see Instal l MicroStrategy in the In-Place Upgrade on a LinuxDeployment section of the Upgrade Guide and Deployment Scenarios in theInstal l ing MicroStrategy Library on Linux section of the Upgrade Guide.

Are the nodes communicating with each other through network addresstranslation (NAT)?

NAT is currently not supported by the service registration feature.

A service displays a red icon

1. In Workstation, hover over the stop icon to view addi tionalinformation in the tool tip.

2. Review the possible causes provided in the tool tip.

3. Veri fy the service is running. Log into the machine where the service isinstal led. Veri fy i t is running in Windows Service Manager.

4. Veri fy the required port is avai lable. If the service fai ls to start, checkto see whether the required port is avai lable. See SupportedMicroStrategy Platform Services to view the defaul t ports.





5. Veri fy the proper port is in the configuration fi le. If the service isrunning, but Workstation shows the service is down, check theconfiguration fi le (such as MicroStrategy Mobi le Server JSP.json) forthis service. The configuration fi le is located in the instal lationdirectory at MicroStrategy/Services Registration/config. Check to see i fthe port number, http port number, and https port number are consistentwi th the port used for the service.

6. If the ports are correctly defined in the service.json fi le, butWorkstation sti l l shows the service is down, copy the URL for theheal th check from the service.json fi le. Paste the URL in your browserto see i f i t is a val id l ink. If the l ink does not work, replace "localhost"wi th the IP address of the machine from which you are accessing theURL and try again.

7. Check the log fi le at /MicroStrategy/Services Registration/log in yourinstal lation directory.

If a service is configured to use a non-default port number after the installation,the new port number is not recorded in the JSON configuration file. You mustmanually update the JSON file with the post-install configured port number andrestart the MicroStrategy Service Registry. Please refer to How to UpdateServices Ports.

Unable to start or stop a service

1. Connect to an environment, making sure the corresponding user loginhas adequate privi leges. In Workstation, log into an environment as aMicroStrategy user wi th administrator privi leges or as an administratoruser of the web container for the Library. In maintenance mode, go tothe topology view and veri fy that start/stop capabi l i ty is supported for aservice, by right-cl icking on the service. If the Start and Stop optionsin the pop-up menu are grayed out, the start/stop capabi l i ty is notsupported for that service.



2. Veri fy SSH is avai lable and running on the machine with the service. Ifnot, see Configuring SSH on Windows or Configuring SSH on Linux.

3. Veri fy the fi rewal l is enabled and port 22 is open on the fi rewal l .

4. Veri fy the service status in a refreshed view. If a user has sent the startor stop request in Workstation, before another request is sent out,refresh the topology view to get the latest service status.

A service is not reachable

1. Veri fy that the machine where the service is hosted is reachable fromthe MicroStrategy Library machine.

2. If there are fi rewal ls in the environment, veri fy that the ports (8300 and8301) are open to support sending and receiving TCP/UDP requestsbetween the machines hosting the services.

3. Veri fy that the agent is running. On Windows, use the WindowsService Manager to check whether MicroStrategy ServicesRegistration is running. On Linux, use ps -ef | grep -i consul .

Consul does not start after installing M2019 Update 2 Hotfix on aLinux machine

The nslookup tool is missing i f Redhat Enterprise Linux 7 is instal led usingthe minimal option. Consul depends on the nslookup command to resolve amachine's IP address from the ful ly-qual i fied domain name (FQDN). Toensure that Consul can be started successful ly, instal l the missing tool byexecuting the fol lowing command in a terminal :

# yum install bind-utils

Customized Deployments

Case 1: When instal l ing topology in a two machine environment,MicroStrategy services are instal led without the multiple machines option.



As a resul t, you wi l l need to manual ly configure the consul cluster after theinstal lation. In this case, Library was deployed through the instal ler andboth the Library and Web servers are on the same machine. iServer isinstal led on another machine. First, make sure the required ports are open.

On the Library server machine:

1. Navigate to the MicroStrategy/Services Registration/yaml directory.


3. Veri fy the server parameter is set to true.

4. On Windows, use the Service Manager (Run > services.msc) to openservices. Veri fy that MicroStrategy Services Registration is running.

On the Intelligence server machine:

1. Navigate to the MicroStrategy/Services Registration/yaml directory.


3. Add the retry_join parameter wi th the FQDN of the Library server, sothe Intel l igence server can point to i t.

4. Make sure the format for retry_join matches that shown in Changingthe Moni toring Agent to a Communication Agent.

5. Remove the enti re bootstrap_expect l ine, including the parametername, and change server: true to server: false.

6. Save the fi le.

On both machines:

1. Stop the consul on al l machines. In this case, there are two machines.

2. On Windows, use Service Manager (Run > services.msc) to stopMicroStrategy Services Registration.



3. On Linux, refer to Restarting the Consul to stop MicroStrategy ServicesRegistration.

4. Navigate the instal lation directory and delete MicroStrategy/ServicesRegistration/data.

5. Restart the consuls on al l machines in the same consul cluster.

Case 2: JBoss is running on the same machine as the Intel l igence server.Both Web and Library are instal led, but deployed in JBoss.

1. Since Web and Library are on the same machine, both MicroStrategyWeb Server JSP.json and MicroStrategy Library REST Server.json areavai lable in the ServicesRegistration/config instal l folder. Update bothfi les wi th the port number used for the Web and Library JBossdeployment, i f necessary.

2. Perform a heal th check by going tohttp://localhost:8080/MicroStrategyLibrary/heal th andhttp://10.248.128.29:8080/MicroStrategy/heal th. Replace 8080 with theport number running Web and Library. If this does not work, tryreplacing the localhost wi th the IP address of the machine.

3. Stop the consul and delete the ServicesRegistration/data folder.

4. Restart the consul .

Unable to monitor or control MicroStrategy Services fromWorkstation

In certain si tuations, the instal ler may fai l to generate the JSON fi les forMicroStrategy Services, such as the Intel l igence Server, Platform Web,Library, Col laboration Server, and others. As a resul t, the config sub-foldermay not be generated inside the Services Registration instal lationdirectory, or the config folder may only contain a single JSON fi le. Whenei ther of these si tuations occur, several or al l services cannot be moni toredor control led via Workstation.



To resolve this issue, go to the problematic node and execute the fol lowingsteps.

1. Navigate to the jar folder in the Services Registration instal lationdirectory.

Windows:

C:\Program Fi les (x86)\MicroStrategy\Services Registration\jar

Linux:

/opt/MicroStrategy/ServicesRegistration/jar

2. Run the fol lowing command:

# java -jar svcsreg-admin.jar parse

3. Veri fy that the JSON fi les are generated under the config folder.

4. Restart MicroStrategy Services Registration.

In Windows, perform the restart through Windows Service Manager.

In Linux, execute the fol lowing command:

# java -jar svcsreg-admin.jar control consul restart

5. Open the Topology tab in Workstation. Now you should be able tomoni tor the status of services and also issue start and stop commandsto MicroStrategy services.

How to update service ports for the Service Registration/Topologymonitor

1. Navigate to the yaml folder in the Services Registration instal lationdirectory.

Windows:



C:\Program Fi les (x86)\MicroStrategy\Services Registration\yaml

Linux:

/opt/MicroStrategy/ServicesRegistration/yaml

2. Edi t the installation_list.yaml fi le wi th the port corresponding to thedesired MicroStrategy service.

For example:

---

service:

Name: "MySQL"

ID: "MySQL"

InstallPath: "C:\\Program Files (x86)\\Common

Files\\MicroStrategy\\MySQL"

CommonPath: "C:\\Program Files (x86)\\Common Files\\MicroStrategy"

InstallType: 1

Port: 3306

Tags:

version: "11.1.0000.0123"

3. Save the fi le.

4. Manual ly run parser using the fol lowing command:

Replace <serviceName> with the name of your service. In the aboveexample, this would be MySQL .

java -jar svcsreg-admin.jar parse <serviceName>

Configuring Environments with Dynamic or MultipleIP Addresses

Automatic configuration of agent clustering is l imi ted for machines withdynamic or mul tiple IP addresses. In some cases, manual configuration isrequired. See Configuring Environments wi th Nodes Using Dynamic IP



Addresses and Configuring Environments wi th Multiple IP Addresses formore information.

Configuring Environments with Nodes Using Dynamic IPAddressesIf you are using a single machine environment wi th a dynamic IP addressand connecting Workstation to Library, you may encounter errors whenaccessing the Topology screen in Workstation.

After instal lation is finished and the machine is restarted, thecommunication agent may start before the network IP is ful ly resolved andready on the machine. Therefore, the communication agent may obtain atemporary IP during the startup and consider i t as the ful ly resolved one .Using the wrong IP on the machine affects the communication agent'sfunction. If this problem continues to occur, a manual restart of the consul isrequired. See Restarting the Consul for more information.

We do not recommend using machines with dynamic IP addresses ascommunication agents in a cluster. If your environment includes more thanone machine and machines with dynamic IP addresses are used ascommunication agents, use FQDN (such as machine1.domain.com) in thecommunication agent machine l ist during instal lation.

If FQDN is not used, you should manual ly update the "retry_join" section inconsul .json on al l machines with communication and moni toring agentswhen al l machines with dynamic IP addresses are ful ly resolved, every timethose machines get new IPs.

{







"watches": [

{



"type": "key",



"args": [



"-jar",


"collect"

]

}

],

"retry_join": [

"10.27.16.239",

"localhost",

"10.27.17.238"

],

"server": true,


}

Configuring Environments with Multiple IP AddressesWe do not recommend using machines with more than one IP address as acommunication agent. If your environment includes one or more machinesand machines with more than one IP address are used as communicationagents, make sure al l IPs are avai lable when instal l ing. The IP mapping tothe FQDN of the machine is included in the consul .json fi le, as shownbelow.

{







"watches": [

{



"type": "key",



"args": [



"-jar",


"collect"

]

}

],

"retry_join": [

"SAP-W10-ent",

"localhost",

"10.27.17.238"

],

"server": true,

"bind_addr": "10.21.20.188",


}

If a machine has two avai lable IP addresses, the consul may bind i tsel f toone IP mapping for FQDN, whi le other machines use FQDN mapping toanother IP. In this si tuation, you should manual ly modi fy consul .json. TheIP used for "bind_addr" should be consistent wi th the IP the other machinefinds using the FQDN; the IP for "bind_addr" and the IP (i f not using FQDN )in "retry_join" l ist representing this machine should be consistent. After al lmanual modi fications of consul .json are complete on al l machines withconsul instal led, stop the consul on al l machines, delete the data folder inpath/MicroStrategy/Services Registration on every machine, and restart al lconsuls.

If MicroStrategy is instal led when only one IP is avai lable and runs laterwhen multiple IPs are avai lable, the consul wi l l not start. TheServiceRegistration.log displays the error, "Mul tiple private IPv4 addressesfound. Please configure one."



Using FQDN for the communication agent machine l ist during theinstal lation is recommended. If the IP address l ist is used duringinstal lation, make sure to use the IP mapping to the FQDN for the machinewith multiple IPs.

Machines with more than one IP address, as well as dynamic IPs, are notsupported for automatic clustering.

Certified Operating Systems for Topology

The fol lowing operating systems are certi fied for topology:

l Windows Server 2008 R2 SP1

l Windows Server 2012 R2

l Windows Server 2016

l Windows 7

l Windows 10 October Update 2018

l Red Hat Enterprise Linux 6.x

l Red Hat Enterprise Linux 7.x (including SE Linux)

l SUSE Linux 12.x

l SUSE Linux 15.x

l Amazon Linux 2

Certified Web Containers for Topology

The fol lowing web containers are certi fied for topology:

l Apache Tomcat 8.5.30

l Apache Tomcat 9.0.12



l WebLogic 12cR2 (12.2.1.3.0)

l WebSphere Appl ication Server 9.0

l Wildfly 13

l Wildfly 14

l JBoss EAP 7.1

l Jetty 9.4

See How to Set Up Appl ication Servers for more information about settingup appl ication servers.



Instal l ing and Configuring theIdentity Messaging Service

Identi ty Messaging is included with the MicroStrategy platform when theMicroStrategy Badge component is selected for instal lation. The Identi tyMessaging service acts as a scalable messaging gateway between theIdenti ty server and emai l , SMS, and push noti fication providers.

The Identi ty Messaging Service is currently certi fied for MicroStrategy 2020Linux deployments.

Identity Messaging Service Dependencies

The Identi ty Messaging service makes use of the fol lowing 3rd partycomponents. Those components wi l l need to be instal led prior to instal l ingthe Identi ty Messaging service:

3rd Party Component Version Notes

Apache Tomcat 8.0 or laterApache Tomcat 8.5 isrecommended

Oracle Java Runt ime Environment(JRE)

1.8 or later IBM JDK is not supported

MongoDB3.6.2 orlater

MongoDB 3.6.5 is recommended

Installing the Identity Messaging Service on Linux

The Identi ty Messaging service components wi l l be instal led with yourinstal lation of MicroStrategy Badge.



After completing the MicroStrategy 2020 instal ler process, theMicroStrategy Identi ty Messaging service WAR fi le can be found in:

<installation path>/MicroStrategy/install/mercury.war

Preparing the Push Notification Credentials FolderTo be able to send push noti fications to mobi le devices, the Identi tyMessaging service needs access to the Apple and Google push noti ficationcredentials.

1. Create a the fol lowing folder structure under the/opt/usher/usherserver/db_configs/identitymessaging/

directory:

/apns

/gcm

/fcm

2. Place the two Apple push noti fication fi les in the /apns folder.

3. Place the Google GCM fi le in the /gcm folder.

4. Place the Google FCM fi le in the /fcm folder.

Preparing the Service Folder StructureThe MicroStrategy Identi ty Messaging micro service leverages ApacheTomcat as the service container.

New Installations

The fol lowing folder structure wi l l be created during instal lation:

/bin

/conf

/logs

/run



/temp

/webapps

/work

Existing MicroStrategy Identity Deployments

To set up the right folder structure from your existing Linux-basedMicroStrategy Identi ty Instal lation (assumed to be in /opt/usher ):

1. Dupl icate the existing MicroStrategy Identi ty Server appl ication folder:

cd /opt/usher/usherserver/usherApps/

cp -pr shardIDM shardIdentityMessaging

cd shardIdentityMessaging

rm -rf webapps/*

rm -f logs/*

2. Modi fy the conf/server.xml fi le:

l Change remote shutdown port to a port not in use. Make sure there isno port confl ict. For example :

<Server port="7501" shutdown="SHUTDOWN">

l Change the connector to l isten on a di fferent HTTP port, e.g. 5443.Modi fy the one with certificateVerification="none" , deletethe other connector. e.g. <Connector port="5443"

protocol="org.apache.coyote.http11.Http11NioProtoc

ol"

3. Copy the mercury.war fi le to the /webapps folder.



Configuring the Identity Messaging Service

The configuration settings described below should be made to theappl ication-prod.yml fi le. This fi le is located in the /opt/user/ There is noneed to modi fy the appl ication.yml fi le found in the same location.

MongoDB Configuration

spring: data: mongodb: # uri:

mongodb://mstr:<password>@127.0.0.1:27017/mercuryDb?authSource=admin

host:127.0.0.1 port:27017 username: mstr password: <password> database:

mercuryDb

Update JWT Secret

jhipster: security: authentication: jwt: secret:<secret> token-validity-in-

seconds: 86400 token-validity-in-seconds-for-remember-me: 31536000

For security measures we suggest use the following script to generate thesecret:

#!/bin/bash

token_size=66

openssl rand -base64 ${token_size} | tr -d '\n'; echo;

Copy the output, not including "(stdin)=" if it exists, and paste it in the secretsection in application-prod.yml as shown below. If you have one than moremercury nodes, please copy the SAME value to other nodes.

Third-party Service Credential RegistrationFor thi rd-party services to access and leverage the service, credentialsneed to be registered. Append the credentials to the application-

prod.yml fi le in the application/credential section with thefol lowing format:

application: credential: <username>: <userpassword>



The username and user password fields are case sensitive. If your passwordincludes any of the characters ":-{}[]!#|>&%@", make sure you enclose thepassword string in single or double quotes. If you need to use single or doublequotes in the password, escape them as well (a single quote in a single-quote-enclosed string is escaped by doubling it, a double quote in a double-quote-enclosed string is escaped by being prefixed by a backslash). You should alsoquote your string if the password can be mistaken for a number or a literalboolean (true, false, yes, no, etc.).

Email Gateway ConfigurationFor the service to start, the emai l gateway needs to be setup. Include thefol lowing parameters based on your configuration:

simplejavamail: transportstrategy: SMTP opportunistic: #Optional tls: true

smtp: host: <ip or dns name for SMTP server> port: <SMTP Server port number;

usually 25> username: <username for SMTP server is an authentication is

required> password: <user password for SMTP server is an authentication is

required> # proxy: # Optional: Sock 5 proxy configuration # host: <Sock5

proxy server ip or name> # port: <Sock5 proxy server port # username:

<Optional: Sock5 username name> # password: <Optional: Sock5 user password> #

socks5bridge: # Optional: This section is only relevant if using an

authenticated Sock 5 proxy # port: 1081 # an unused port needs to be

specified. If not specified, this will default to 1081

Add emai l whi tel ist for the messaging service:

application: ... emailWhiteList: - <email1> - <email2>

Mobile App Push Notification Gateway ConfigurationIn the application-prod.yml , include the fol lowing entries:

application: apns: keypath: <path to APNS certificate file> password: <path

to text file that contains the password for the APNS certificate file>

fcmkeypath: <path to FCM token file> gcmkeypath: <path to GCM token file>



SMS Gateway ConfigurationSMS configuration can be inserted on-the-fly after Identi ty Messagingservice is running. See Identi ty Server Configuration to Work With Identi tyMessaging Service for detai ls.

Proxy ConfigurationIf requests are routed through a proxy, both the appl ication proxy settingand JVM proxy setting need to be configured. Appl ication proxy setting isset by adding the fol lowing in application-prod.yml:

application: proxy: enabled: false host: port: username: password:

Modify Startup Script tomcat.shThe /bin folder contains the service startup script for Linux.

1. Edi t the shardIdentityMessaging/bin/tomcat.sh fi le toreplace both instances of shardIDM withshardIdentityMessaging .

2. Change the jmxremote port to a port other than 5500 to make surethere is no port confl ict.

3. Make sure your startup script includes -

Dspring.profiles.active=prod and -

Dspring.config.location=file:<path_to_config_

files>/application.yml,file:<path_to_config_

files>/application-prod.yml, as parameters to ei ther java_ops or catalina_opts environment variable.

4. To setup JVM proxy, include "-Dhttps.proxyHost=<ip> -

Dhttps.proxyPort=8080" in CATALINA_OPTS

CATALINA_OPTS="-server -Xms1024m -Xmx1024m -XX:PermSize=356m -

XX:MaxPermSize=484m -Dbuild.compiler.emacs=true -

Djava.library.path=$CATALINA_HOME/lib -Dcom.sun.management.jmxremote -

Dcom.sun.management.jmxremote.port=5502 -

Dcom.sun.management.jmxremote.ssl=false -



Dcom.sun.management.jmxremote.authenticate=true -

Dcom.sun.management.jmxremote.password.file=$CATALINA_

BASE/conf/jmxremote.password -

Dcom.sun.management.jmxremote.access.file=$CATALINA_

BASE/conf/jmxremote.access -Duser.language=en -Dfile.encoding=UTF-8 -

Duser.timezone=UTC" CATALINA_

PID="/opt/usher/usherserver/usherApps/shardIdentityMessaging/run/tomcat.pid"

CATALINA_OPTS="$CATALINA_OPTS -

Dspring.config.location=file:/opt/usher/usherserver/db_

configs/identitymessaging/application.yml,file:/opt/usher/usherserver/db_

configs/identitymessaging/application-prod.yml" CATALINA_OPTS="$CATALINA_OPTS

-Dspring.profiles.active=prod" # JVM proxy setting CATALINA_OPTS="${CATALINA_

OPTS} -Dhttps.proxyHost=<ip> -Dhttps.proxyPort=<port>"

Managing the servicel Start the service:

/opt/usher/usherserver/usherApps/shardIdentityMessagin

g/tomcat.sh start

l Stop the service:

/opt/usher/usherserver/usherApps/shardIdentityMessagin

g/tomcat.sh stop

How to Monitor the Identity Messaging ServiceDeployment

The Identi ty Messaging Service can be moni tored by making an API cal land confi rming that the output matches the expected one. In a multi -nodedeployment, i t is recommended to moni tor each node individual ly as wel l asthe load balancer that si ts in front of them.

The API is a REST API that can be cal led from monitoring tools orcommand l ine uti l i ties l ike curl and wget.



curl

https://<hostname>:<hostport>/mercury/management/health

The expected response is

{"status":"UP"}

Troubleshooting the Identity Messaging ServiceInstallation

The Tomcat log fi le catalina.out wil l contain most of the webappl ication container level errors.

Identity Server Configuration to Work With IdentityMessaging Service

Add URL and API Information of the Identity MessagingServiceUpdate the MicroStrategy Identi ty Server serverdb.conf, located at <usherinstal lation directory>/usherserver/db_configs/usher/password/serverdb.conf, to include an entry for "mercury.urls"(replace the three placeholders wi th the values appropriate for yourenvironment; refer to the "3rd party service credential registration" sectionabove to setup or retrieve the user credentials)

mercury.urls = "{\"baseUrl\": \"https://env-

XXX.customer.cloud.microstrategy.com:5443/mercury\",\"healthCheck\":

\"/management/health\",\"ios\": \"/api/notifications/ios\",\"android\":

\"/api/notifications/android\",

\"fcm\":\"/api/notifications/fcm\",\"authenticate\":\"/api/authenticate\",

\"sms\":\"/api/sms\", \"sendhtml\":\"/api/sendhtml\", \"username\":

\"MyServiceAcct\", \"password\": \"MyServiceAcctPASSWORD\" ,

\"checkAlivePeriod\": \"1800\"}"



Settings for Account based notificationThe fol lowing settings should be included in serverdb.conf. In the accountbased instal lation, Identi ty Server requires them to work with Identi tyMessaging service.

email.fromAddr.default = "<the sender email addresses appears in email>"

email.sendOtp.subject.default = "<The subject of email contains an OTP code

for a user to input in a verification process>"

email.sendOtpLink.subject.default = "<The subject of email contains a link

for a user to click to verify their email address>" email.iot.subject.default

= "<The subject of email to invite user>" mobile.sms.identifier = "<The

identifier of SMS sender in Mercury which should be configured in mercury

first>" mercury.template.logout.asNewLogin.iOS="<the template id of iOS push

notification about logout old session>"

mercury.template.logout.asNewLogin.Android="<the template id of Android

notification about logout old session>"

mail.fromAddr.default should be added to the white lis t of emails inapplication-prod.yml

l The mobile.sms.identifier needs to be configured in Identi tyMessaging Service fi rst. The fol lowing example is for Twi l io setup:

curl --request POST \ --url https://<identity_messaging_

host>:<port>/mercury/api/user/<the identifier you want to use for

mobile.sms.identifier>/smsconfig/twilio \ --header 'authorization: Bearer

<token obtained from authenticate API>' \ --header 'content-type:

application/json' \ --data '{"twilio_accountSid": "<twilio account

sid>","twilio_authToken":"<twilio account token>","twilio_number":<twilio

number>}'

l The mercury.template.logout.asNewLogin.iOS andmercury.template.logout.asNewLogin.Android need to beconfigured in Identi ty Messaging Service fi rst. For example:


host>:<port>/mercury/api/templateString/<the identifier you want to use for



mercury.template.logout.asNewLogin.iOS/Android>/en \ --header

'authorization: Bearer <token obtained from authenticate API>' \ --header

'content-type: application/json' \ --data '{"title":"Multiple devices

detected","body":"Our records indicate that your MyMazda account is being

accessed across multiple devices.\n\nYou have been logged out due to

security reasons.","a":"020"}

l Authenticate API to obtain identi ty messaging service jwt token. refer toThird-party Service Credential Registration to setup or retrieve the usercredentials.


host>:<port>/mercury/api/authenticate \ -H 'Content-Type: application/json'

\ -d '{ "username": "<service name>", "password": "<service password>",

"rememberMe": true }'



M ICROSTRATEGYIDENTITYADMINISTRATION



This section describes processes that enable administrators to manageMicroStrategy Identi ty.

Managing MicroStrategy Identity Administrators

Using MicroStrategy Identi ty Manager you can add or remove Identi tyAdmins. Al l admins have the abi l i ty to log into MicroStrategy Identi tyManager to access the MicroStrategy Identi ty Configuration, create newMicroStrategy Identi ty Networks, and manage other Identi ty Admins.

How to add an Identity Administrator

1. Log into MicroStrategy Identi ty Manager:

1. In a web browser, navigate to your organization's Identi tyManager home page. The MicroStrategy Identi ty Manager pageopens.

2. Open the Scanner tab on your MicroStrategy Badge app.

3. Scan the QR code displayed on the MicroStrategy Identi tyManager page to log into your network.

2. Cl ick the Administrator button in the upper-right. The Administratorspage opens.

3. Cl ick the + Add Administrator(s) button in the upper-right.

4. In the pop-up, enter the new administrator's emai l address and cl ickAdd .

5. In the next pop-up, enter the administrator's fi rst and last name andcl ick Add .

The new Identi ty Admin is added to the l ist of administrators and wi l lreceive instructions for acquiring the admin badge.



How to delete an Identity Administrator

1. Log into MicroStrategy Identi ty Manager:

1. In a web browser, navigate to your organization's Identi tyManager home page. The MicroStrategy Identi ty Manager pageopens.

2. Open the Scanner tab on your MicroStrategy Badge app.

3. Scan the QR code displayed on the MicroStrategy Identi tyManager page to log into your network.

2. Cl ick the Administrator button in the upper-right.

3. Cl ick the check box next to the admin(s) that you want to delete.

4. Cl ick - Delete Administrator(s) in the upper-right.

5. In the pop-up, cl ick Delete.

Managing the Signing Certificate Authority

The MicroStrategy Identi ty Server uses a sel f-signed SSL certi ficate as aCerti ficate Authori ty (CA) to sign cl ient certi ficates used by otherMicroStrategy Identi ty components. This includes the MicroStrategy Identi tyAgent, and custom appl ications implementing MicroStrategy Identi ty APIs.

l For Windows implementations, the MicroStrategy Instal lation Wizardautomatical ly generates a Signing CA certi ficate that is val id for 1 year,and propagates i t to the required system locations so that Tomcat wi l ltrust this CA.

l For Linux implementations, you must generate and propagate the SigningCA certi ficate manual ly.



l Regardless of the host when the Signing CA certi ficate expires, or isabout to expire, you must manual ly regenerate and propagate a newcerti ficate.

You can create the Signing CA using OpenSSL®.

If you copy and paste the OpenSSL commands shown below, please ensurethat the option flags are marked with a hyphen/minus sign instead of an endash or em dash. If any hyphens are autoformatted into different characters,then they will be parsed incorrectly on the command line and you will get"unrecognized option" errors.

l For Windows, an OpenSSL uti l i ty is instal led along with MicroStrategyIdenti ty.

The defaul t fi le locations are as fol lows:

n Signing CA certi ficate: C:\Program Files (x86)\Common

Files\MicroStrategy\certificates\ushersigningca.crt

n Signing CA private key: C:\Program Files (x86)\Common

Files\MicroStrategy\keys\ushersigningca.key

n 64-bi t Java CA store: C:\Program Files (x86)\Common

Files\MicroStrategy\JRE\180_

77\Win64\lib\security\cacerts

n OpenSSL executable: C:\Program Files (x86)\Common

Files\MicroStrategy\OpenSSL\openssl-

1.0.2e\openssl.exe

l For Linux, an OpenSSL uti l i ty is included with many distributions.

Generate a new Signing Certif icate Authority

Fol low these steps i f you do not already have a Signing CA private key andcerti ficate (for example, i f you are setting up MicroStrategy Identi ty for thefi rst time on Linux).



Use OpenSSL to generate a private key (.key) and certificate (.crt).

l For Windows:

1. Run Command Prompt as administrator.

2. Navigate to the folder where the OpenSSL executable is located.

cd C:\Program Files (x86)\Common

Files\MicroStrategy\OpenSSL\openssl-1.0.2e

3. Run the OpenSSL executable.

openssl.exe

4. Create the request for a new private key and certi ficate. Fol lowing isa sample command that creates a 3072-bi t key and a certi ficate val idfor 365 days. If you want a larger key size or a longer certi ficatel i fetime, update the command appropriately.

req -newkey rsa:3072 -nodes -new –x509 -days 365 -

subj '/C=US/O=MicroStrategy Identity

Server/CN=MicroStrategy Identity Server ROOT

Signing CA' -keyout

<PathToCertFolder>/ushersigningca.key -out

<PathToCertFolder>/ushersigningca.crt

l For Linux:

1. Log into the command l ine.

2. Run the OpenSSL uti l i ty to create the request for a new private keyand certi ficate. Fol lowing is a sample command that creates a 3072-bi t key and a certi ficate val id for 365 days. If you want a larger keysize or a longer certi ficate l i fetime, update the commandappropriately:



> openssl req -newkey rsa:3072 -nodes -new –x509 -

days 365 -subj '/C=US/O=MicroStrategy Identity

Server/CN=MicroStrategy Identity Server ROOT

Signing CA' -keyout

<PathToCertFolder>/ushersigningca.key -out


Regenerate a new Signing Certif icate Authority Certif icate

Fol low these steps i f you have a Signing CA private key and need togenerate a new certi ficate (for example, your existing CA certi ficate hasexpired or is about to expire).

Use OpenSSL to generate a new certificate (.crt) based on your existingprivate key (.key).

For Windows:

1. Open a command prompt window as administrator.

2. Navigate to the folder where the OpenSSL executable is located.

> cd C:\Program Files (x86)\Common

Files\MicroStrategy\OpenSSL\openssl-1.0.2e

3. Run the OpenSSL executable.

> openssl.exe

4. Create the request for a new certi ficate. Fol lowing is a samplecommand that generates a certi ficate val id for 365 days. If you want alonger certi ficate l i fetime, update the command appropriately.

> req -new –x509 -days 365 -subj

'/C=US/O=MicroStrategy Identity

Server/CN=MicroStrategy Identity Server ROOT Signing

CA' -key <PathToCertFolder>/ushersigningca.key -out




For Linux:

1. Open a terminal window.

2. Run the OpenSSL uti l i ty to create the request for a new certi ficate. Thefol lowing is a sample command that generates a certi ficate val id for365 days. If you want a longer certi ficate l i fetime, update the commandappropriately.

> openssl req -new –x509 -days 365 -subj

'/C=US/O=MicroStrategy Identity

Server/CN=MicroStrategy Identity Server ROOT Signing

CA' -key <PathToCertFolder>/ushersigningca.key -out


Propagate the Signing Certif icate Authority

1. Append the Signing CA certi ficate to the Certi ficate Authori ty Chain(.pem) fi le used by your MicroStrategy Identi ty environment.

For Windows:

Run the fol lowing command:

> type "<PathToCertFolder>/ushersigningca.crt" >>

"<PathToCertFolder>/UsherCAChain.pem"

For Linux:

Run the fol lowing command:

> cat <PathToCertFolder>/ushersigningca.crt >>

<PathToCertFolder>/UsherCAChain.pem

2. To ensure that Tomcat wi l l trust the Signing CA, you must add i t to theCA store of the Java Runtime Environment (JRE) used by Tomcat.

For Windows:



1. Run Command Prompt as administrator.


"C:\Program Files (x86)\CommonFiles\MicroStrategy\JRE\180_77\Win64\bin\keytool.exe" -import alias<NewAlias> -file<"PathToCertFolder>\ushersigningca.crt" -keystore "C:\Program Files (x86)\CommonFiles\MicroStrategy\JRE\180_77\Win64\lib\security\cacerts"

3. Enter the passphrase when prompted (the defaul t is "changei t").

4. Confi rm you want to add the certi ficate to the store whenprompted.

For Linux:

1. Log into the command l ine.


keytool -import -alias <NewAlias> -file<PathToCertFolder>/ushersigningca.crt -keystore<PathToJavaRoot>/lib/security/cacerts

3. Enter the passphrase when prompted (the defaul t is "changei t").

4. Confi rm you want to add the certi ficate to the store whenprompted.

Update the MicroStrategy Identity Configuration

1. If you previously completed the MicroStrategy Identi ty post-instal lationconfiguration, and the new Signing CA certi ficate, or private key, doesnot have the same fi le name or path as the old ones you must updatethose fields during configuration.



2. In a web browser, navigate to MicroStrategy Identi ty Manager.

3. Use your admin badge to scan the QR code and log in.

4. From the drop-down menu in the upper-right corner, cl ickMicroStrategy Identity Configuration .

5. Update the SSL Certificate Authority Certificate and SSL CertificateAuthority Key fields to the new paths.

6. Cl ick Next.

7. If the MicroStrategy Identi ty Server or MicroStrategy Identi ty Gatewayweb services are running, restart them.

8. If you have any apps using MicroStrategy Identi ty cl ient certi ficates,you must regenerate those cl ient certi ficates so they are signed by thenew Signing CA and replace them in the apps.



How to Instal l the KerberosAuthentication Service

1. Instal l Kerberos KDC server and cl ient.

a. Download and instal l the krb5 server package.

rpm -ivh krb5-server-1.10.3-10.el6_4.6.x86_64.rpm

Veri fy that the fol lowing rpm packages are instal led beforeconfiguring KDC:

$ rpm -qa | grep -i krb5

pam_krb5-2.3.11-9.el6.x86_64

krb5-server-1.10.3-10.el6_4.6.x86_64

krb5-workstation-1.10.3-10.el6_4.6.x86_64

krb5-libs-1.10.3-10.el6_4.6.x86_64

b. Instal l via yum.

On the KDC server:

yum install krb5-server krb5-libs krb5-auth-dialog

On the Kerberos cl ient:

yum install krb5-workstation krb5-libs krb5-auth-dialog

2. Modi fy the /etc/krb5.conf fi le.

Modi fy /etc/krb5.conf to look l ike the code below with theappropriate REALM and DOMAIN_REALM mappings. krb5.conf canbe found in /etc by defaul t.



[logging]

default = FILE:/var/log/krb5libs.log

kdc = FILE:/var/log/krb5kdc.log

admin_server = FILE:/var/log/kadmind.log

[libdefaults]

default_realm = MYREALM.COM

dns_lookup_realm = false

dns_lookup_kdc = false

ticket_lifetime = 24h

renew_lifetime = 7d

forwardable = true

[realms]

MYREALM.COM = {

kdc = elserver1.example.com

admin_server = elserver1.example.com

}

[domain_realm]

.myrealm.com =CTCCDH1.COM

myrealm.com =CTCCDH1.COM

3. Modi fy the KDC.conf fi le.

Log in to the KDC server and modi fy/var/kerberos/krb5kdc/kdc.conf as fol lows:

[kdcdefaults]

kdc_ports = 88

kdc_tcp_ports = 88

[realms]

MYREALM.COM = {

#master_key_type = aes256-cts

acl_file = /var/kerberos/krb5kdc/kadm5.acl

dict_file = /usr/share/dict/words

admin_keytab = /var/kerberos/krb5kdc/kadm5.keytab



supported_enctypes = aes256-cts:normal aes128-cts:normal des3-hmac-

sha1:normal arcfour-hmac:normal des-hmac-sha1:normal des-cbc-md5:normal

des-cbc-crc:normal

}

4. Assign administrator privi leges.

The users can be granted administrator privi leges to the databaseusing the fi le /var/kerberos/krb5kdc/kadm5.acl .

*/[email protected] *

In the above example, any principal in the MYREALM with an admininstance has al l administrator privi leges.

5. Create a principal .

Create the principal using the command addprinc . For example,create a principal wi th the user name “root”.

$ kadmin.local -q "addprinc root/admin"

Authenticating as principal root/[email protected] with password.

WARNING: no policy specified for root/[email protected]; defaulting to

no policy

Enter password for principal "root/[email protected]":

Re-enter password for principal "root/[email protected]":

Principal "root/[email protected]" created.

6. Create the database.

The fol lowing command creates the principal database in/var/kerberos/krb5kdc .

kdb5_util create -r $realm -s

If the database already exists, i t wi l l remove al l the related fi les in/var/kerberos/krb5kdc . By defaul t, the database name is"principal ." You can add the -d flag to rename the database.



7. Start the Kerberos Service.

Start the KDC and kadmin daemons as shown below.

# service krb5kdc start

Starting Kerberos 5 KDC: [ OK ]

# service kadmin start

Starting Kerberos 5 Admin Server: [ OK ]



TroubleshootingThis appendix provides information on common problems that you mightencounter whi le instal l ing and configuring MicroStrategy on Linux andWindows operating systems.

Reviewing General Installation Errors

Any errors in your MicroStrategy instal lation are wri tten to theinstall.log fi le.

Review errors found in install.log

1. Browse to INSTALL_PATHwhere INSTALL_PATH is the directory youspeci fied as the Instal l Directory during instal lation

2. Open the install.log fi le. (For Unix, use an edi tor wi th a commandl ike dtpad install.log . For Windows, use Notepad or some othertext edi tor to open the fi le.)

3. Review the error messages. A common error is to run out of space.

Graph and Document Support of Non-WesternEuropean Fonts

If your Linux system uses non-Western European fonts, you may seeindiscernible values returned in place of text on your graphs whenaccessed through MicroStrategy Web. This also occurs for Report Servicesdocuments when accessed through MicroStrategy Web or any otherMicroStrategy cl ient appl ication (such as Developer) that connects to anIntel l igence Server connected (three-tier) project source.



To support non-Western European fonts, copy True Type fonts into theIntel l igence Server instal lation directory. Copy these fonts, which have a.ttc or .ttf extension, to INTELLIGENCE_SERVER_INSTALL_

PATH\PDFGeneratorFiles . The defaul t instal lation path for theIntel l igence Server in Linux ishome\MicroStrategy\PDFGeneratorFiles . For the change to takeeffect, you must restart Intel l igence Server.

Server Port Number Errors

I Forgot the Server Port Number1. Open MicroStrategy Service Manager.

l Windows: From the Start menu, go to Programs > MicroStrategyTools > Service Manager.

l Linux: In a Linux console window, browse to HOME_PATH whereHOME_PATH is the speci fied home directory duringinstal lation.Browse to the folder bin and type ./mstrsvcmgr , thencl ick Enter. MicroStrategy Service Manager opens.

2. Cl ick Options.

3. Cl ick Intelligence Server Options tab to view the port number.

Port Number is in UseIn a Linux environment, you can find a port avai lable for use with thefol lowing procedure:

1. Browse to your target di rectory. This is the path indicated duringinstal lation as the Directory Name.

2. Browse to the folder bin and type mstrctl –s

IntelligenceServer di FindingPortNumber , then cl ick Enter.



3. Type mstrctl –s IntelligenceServer ci

FindingPortNumber , then cl ick Enter.

4. Type mstrctl –s IntelligenceServer gs

FindingPortNumber, then cl ick Enter.

5. An XML fi le is returned. Search for the tag <tcp_port_number> ,which contains a port number you can use. Record this number.

DSN Connection Errors

This section provides troubleshooting information on DSN connectionerrors.

Testing the DSN connection failed in DSN Creator1. In MicroStrategy Connectivi ty Wizard, go to the Driver Detai ls page

and review al l the information.

2. Cl ick each of the boxes and read the comments at the bottom of thewindow.

3. Enter the information required for each box and cl ick Test.

Metadata and Other Repository Creation Errors

This section provides troubleshooting information on metadata, History List,and statistics reposi tory creation errors.

The errors l isted below do not cover errors that can occur because a userdoes not have the correct database permissions to create a metadata,History List, or statistics reposi tory. For information on providing the properdatabase permissions to create these reposi tories, see Required databasepermissions to create metadata, History List, and statistics reposi tories,page 388.



Creating a Metadata Fails Due to Insufficient Page SizeWhen creating a metadata within a IBM DB2 database, the fol lowing errorand resul ting error message can be encountered:

Invalid Page Size for DB2 UDB Metadata

This can occur when an IBM DB2 database user has access to a tablespacethat does not have the space requirements necessary for the metadatareposi tory. The MicroStrategy metadata reposi tory requires a page size ofat least 8 KB.

To avoid this error, i t is recommended to revoke access to any tablespacesthat are lower than 8 KB in page size for the user account that is creatingthe metadata. The user must also have access to a tablespace with a pagesize of at least 8 KB. Contact your database administrator to perform thisuser configuration.

Creating a History List Repository Fails Due to InsufficientPage SizeWhen creating a History List reposi tory wi thin a Sybase database, thefol lowing error and resul ting error message can be encountered.

Creating table TableName failed because the minimum row

size would be PageSizeRequirement bytes. This exceeds

the maximum allowable size of a row for this table,

PageSizeLimit bytes.

This can occur when a Sybase database does not have the page sizerequirements necessary for the History List Reposi tory. To solve this error,contact your database administrator to increase the current avai lable space(PageSizeLimit in the error message above) for the table space to belarge enough to store the History List reposi tory (PageSizeRequirementin the error message above). As a general rule, the page size for the HistoryList reposi tory should be at least 4 KB.



Permission Errors

This section provides troubleshooting information on permission errors in aLinux environment.

Missing JVM FileThe instal lation fai ls just before i t starts transferring fi les, and the fol lowingerror is displayed:

JVM not found

Clear the set group ID on execution(s) bi t on the permissions of thedirectory where the Instal lPath for the Intel l igence Server is to be placed.

1. #chmod g-s directory

where directory is the Instal lPath for Intel l igence Server.

2. cl ick Enter.


Installation and Configuration Guide - MicroStrategyLinkingMicroStrategyLibrarytoMicroStrategyWeb...

Documents

Transcript of Installation and Configuration Guide - MicroStrategyLinkingMicroStrategyLibrarytoMicroStrategyWeb...